Overview

スマレジ・プラットフォームAPI 受注管理 仕様書 (ver.1.0.0)

概要

エンドポイント

サンドボックス

https://api.smaregi.dev/{contract_id}/order-shipment

本番

https://api.smaregi.jp/{contract_id}/order-shipment

Path Parameters	説明
contract_id	対象の契約ID

---

ソート

sortに「パラメータ名」で昇順、「パラメータ名:desc」で降順指定できます。
カンマ区切りで複数のパラメータ(昇順・降順)を指定できます。

---

ページネーション

一覧を取得するAPIでは1回で取得できる件数に上限があり、より多くの件数が必要となる場合はページを指定する必要があります。

ページ

page に1から始まるページ番号を指定してください。

---

Plan

APIを利用するユーザーのプランにより、実行できるAPIが異なります。
受注管理機能のAPIを利用する場合、下記のプランにご加入頂く必要があります。

• リテールビジネス

---

• OpenAPI version: 3.0.2

Authentication

AppAccessToken

アプリアクセストークン

{contract_id} には対象の契約IDを指定してください。

Security scheme type: oauth2

Flow type: clientCredentials

Token URL: https://id.smaregi.dev/app/{contract_id}/token

Scopes:

• order-shipment.orders:read - 受注の参照ができます
• order-shipment.orders:write - 受注の更新ができます
• order-shipment.stores:read - 受注店舗の参照ができます
• order-shipment.stores:write - 受注店舗の更新ができます
• order-shipment.stock:read - 商品在庫の参照ができます