Information
- OpenAPI version:
3.0.2
Overview
スマレジ・プラットフォームAPI スマレジEC B2B 仕様書 ver.0.9.0
Section titled “スマレジ・プラットフォームAPI スマレジEC B2B 仕様書 ver.0.9.0”概要
注意事項
本APIは ver.0.9.0 の先行公開版です。
正式版リリースまでの間は、破壊的変更を含む仕様変更が発生する場合があります。
仕様変更時は事前に告知します。
また、破壊的変更前の仕様は継続提供しません。
サンドボックス
スマレジEC B2Bのサンドボックス環境は自動生成されません。APIのテスト利用をご希望の場合は、環境作成の申請が必要です。申請方法と申請先は、サンドボックス環境の作成申請についてをご確認ください。
エンドポイント
サンドボックス
https://api.smaregi.dev/{contract_id}/ec-b2b本番
https://api.smaregi.jp/{contract_id}/ec-b2b| Path Parameters | 説明 |
|---|---|
| contract_id | 対象の契約ID |
Plan
APIを利用するユーザーのプランにより、実行できるAPIが異なります。
スマレジEC B2BのAPIを利用する場合、下記のプランにご加入頂く必要があります。
- Try
- Entry
- Growth
ソート
sortに「パラメータ名」で昇順、「パラメータ名:desc」で降順指定できます。\
ページネーション
一覧を取得するAPIでは1回で取得できる件数に上限があり、より多くの件数が必要となる場合はページを指定する必要があります。
ページ
page に1から始まるページ番号を指定してください。
Authentication
Section titled “Authentication”AppAccessToken
Section titled “AppAccessToken”アプリアクセストークン
{contract_id} には対象の契約IDを指定してください。
Security scheme type: oauth2
Flow type: clientCredentials
Token URL: https://id.smaregi.dev/app/{contract_id}/token
Scopes:
- ec-b2b.customers:read - 取引先情報の参照ができます
- ec-b2b.customers:write - 取引先情報の更新ができます
- ec-b2b.order-group-statuses:read - 受注グループステータスの参照ができます
- ec-b2b.order-group-tags:read - 受注グループタグの参照ができます
- ec-b2b.order-group-tags:write - 受注グループタグの更新ができます
- ec-b2b.delivery-methods:read - 配送方法の参照ができます
- ec-b2b.delivery-companies:read - 配送業者の参照ができます
- ec-b2b.payments:read - 支払方法の参照ができます
- ec-b2b.tax-rules:read - 税ルールの参照ができます
- ec-b2b.payment-statuses:read - 支払ステータスの参照ができます
- ec-b2b.shipment-statuses:read - 配送ステータスの参照ができます
- ec-b2b.order-statuses:read - 受注ステータスの参照ができます
- ec-b2b.order-group-payment-statuses:read - 受注グループ支払ステータスの参照ができます
- ec-b2b.order-group-shipment-statuses:read - 受注グループ配送ステータスの参照ができます
- ec-b2b.order-groups:read - 受注グループの参照ができます
- ec-b2b.order-groups:write - 受注グループの更新ができます
- ec-b2b.order-shipments:read - 出荷の参照ができます
- ec-b2b.recipient-addresses:read - 配送先情報の参照ができます
- ec-b2b.recipient-addresses:write - 配送先情報の更新ができます
- ec-b2b.product-groups:read - 商品グループ情報の参照ができます
- ec-b2b.product-groups:write - 商品グループ情報の更新ができます
- ec-b2b.product-tags:read - 商品タグ情報の参照ができます
- ec-b2b.product-tags:write - 商品タグ情報の更新ができます
- ec-b2b.product-images:read - 商品画像情報の参照ができます
- ec-b2b.product-images:write - 商品画像情報の更新ができます
- ec-b2b.delivery-rules:read - 配送ルール情報の参照ができます
- ec-b2b.products:read - 商品情報の参照ができます
- ec-b2b.products:write - 商品情報の更新ができます
- ec-b2b.linked-users:read - ユーザー情報の参照ができます
- ec-b2b.linked-users:write - ユーザー情報の更新ができます