Information
- OpenAPI version:
3.0.2
Overview
スマレジ・プラットフォームAPI スマレジEC OMS 仕様書 ver.0.9.0
Section titled “スマレジ・プラットフォームAPI スマレジEC OMS 仕様書 ver.0.9.0”概要
注意事項
本APIはver.0.9.0の先行公開版です。
正式版リリースまでの間は、破壊的変更を含む仕様変更が発生する場合があります。
仕様変更時は事前に告知します。
また、破壊的変更前の仕様は継続提供しません。
エンドポイント
サンドボックス
https://api.smaregi.dev/{contract_id}/ec-oms本番
https://api.smaregi.jp/{contract_id}/ec-oms| Path Parameters | 説明 |
|---|---|
| contract_id | 対象の契約ID |
ソート
sortに「パラメータ名」で昇順、「パラメータ名:desc」で降順指定できます。
カンマ区切りで複数のパラメータ(昇順・降順)を指定できます。
ページネーション
一覧を取得するAPIでは1回で取得できる件数に上限があり、より多くの件数が必要となる場合はページを指定する必要があります。
ページ
page に1から始まるページ番号を指定してください。
Plan
APIを利用するユーザーのプランにより、実行できるAPIが異なります。
スマレジEC OMSのAPIを利用する場合、下記のプランにご加入頂く必要があります。
- 共用サーバプラン
- 専用サーバプラン
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-oms.payments:read - 支払方法の参照ができます
- ec-oms.deliveries:read - 配送方法の参照ができます
- ec-oms.delivery-companies:read - 配送業者の参照ができます
- ec-oms.shops:read - 店舗の参照ができます
- ec-oms.shippers:read - 荷主の参照ができます
- ec-oms.products-sku:read - 商品SKUの参照ができます
- ec-oms.products-sku:write - 商品SKUの更新ができます
- ec-oms.products:read - 商品の参照ができます
- ec-oms.products:write - 商品の更新ができます
- ec-oms.products-sku-sets:read - 商品SKU紐づけの参照ができます
- ec-oms.products-sku-sets:write - 商品SKU紐づけの更新ができます
- ec-oms.orders:read - 受注の参照ができます
- ec-oms.orders:write - 受注の更新ができます
- ec-oms.customers:read - 顧客の参照ができます
- ec-oms.customers:write - 顧客の更新ができます