Documentation Powered by ReDoc

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

概要

エンドポイント

サンドボックス

https://api.smaregi.dev/{契約ID}/order-shipment

本番

https://api.smaregi.jp/{契約ID}/order-shipment

ソート

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


ページネーション

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

ページ

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


Plan

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

  • リテールビジネス

Authentication

OAuth2

スマレジ・プラットフォームAPI 受注管理で定義しているscope一覧です。

Security Scheme Type OAuth2
clientCredentials OAuth Flow
Token URL: https://id.smaregi.dev/app/{contractId}/token
Scopes:
  • order-shipment.orders:read -

    受注の参照ができます

  • order-shipment.orders:write -

    受注の更新ができます

  • order-shipment.stores:read -

    受注店舗の参照ができます

  • order-shipment.stores:write -

    受注店舗の更新ができます

  • order-shipment.stock:read -

    商品在庫の参照ができます

受注

受注登録

受注を登録します。

出荷予定日、出荷準備開始予定日について

指定した配達希望日によって出荷予定日、出荷準備開始予定日が以下のルールで適用されます。

  • 配達希望日がnull、またはリクエスト日時より7日以内の場合
    • リクエスト日時が「当日出荷締め時間」未満であれば当日
    • リクエスト日時が「当日出荷締め時間」以降であれば翌日
  • 配達希望日がリクエスト日時から8日以上先の場合
    • 配達希望日7日前
Authorizations:
OAuth2 (order-shipment.orders:write)
path Parameters
contract_id
required
string

契約ID

Request Body schema: application/json
orderCode
required
string <string> [ 1 .. 50 ] characters ^[ -~]+$

受注番号
受注を識別するための値を設定してください。
※任意受注店舗内でユニークでなければエラーになります。

orderDateTime
required
string <date-time>

受注日時[YYYY-MM-DDThh:mm:ssTZD]

carriage
integer [ 0 .. 999999999 ]
Default: 0

送料
税込価格を設定してください。

commission
integer [ 0 .. 999999999 ]
Default: 0

手数料
税込価格を設定してください。

giftWrapPrice
integer [ 0 .. 999999999 ]
Default: 0

ギフトラッピング料
税込価格を設定してください。

totalPointDiscount
integer [ 0 .. 999999999 ]
Default: 0

ポイント利用

totalCouponDiscount
integer [ 0 .. 999999999 ]
Default: 0

クーポン値引き

subtotalCouponDiscount
integer [ 0 .. 999999999 ]
Default: 0

クーポン値引き（モール）

totalPromotionDiscount
integer [ 0 .. 999999999 ]
Default: 0

プロモーション値引き

taxExclude
integer [ 0 .. 999999999 ]
Default: 0

外税受領額

total
required
integer [ 0 .. 999999999 ]

合計金額 下記計算式と一致する必要があります。 合計 ＝ 小計（明細リストの販売単価 * 数量の総和） + 外税受領額 + (送料 + 手数料 + ギフトラッピング料) - (ポイント利用 + クーポン値引き + クーポン値引き（モール） + プロモーション値引き)

tax
integer [ 0 .. 999999999 ]
Default: 0

内消費税

taxRate
required
integer [ 0 .. 100 ]

消費税率（ヘッダ）

taxRounding
required
string
Enum: "0" "1" "2"

税の丸め方式：(0:四捨五入、1:切り捨て、2:切り上げ)

paymentMethodId
string non-empty

スマレジの支払方法ID

payType
string
Default: "unset"
Enum: "before" "after" "unset"

前払/後払

  • before: 前払
  • after: 後払
  • unset: 未設定
paymentDate
string <date> Nullable
Default: null

入金日：支払いされた日付

payment
integer (支払金額) [ 0 .. 999999999 ] Nullable
Default: null

支払金額

orderMemo
string <= 5000 characters

受注メモ

deliveryMemo
string <= 5000 characters

発送メモ

paymentMemo
string <= 5000 characters

入金メモ

memo
string <= 5000 characters

管理メモ

items
required
Array of objects (OrderItem) [ 1 .. 99 ] items

明細リスト

storeId
required
string non-empty

受注店舗ID

customer
required
object (Customer)

購入者

shippingAddress
required
object (ShippingAddress)

発送先

deliveryInfo
object

配送情報

shippingInfo
object

出荷情報

Responses

200

更新成功

400
  • 指定された受注番号がユニークでない場合
  • 指定された受注店舗が存在しない場合
  • 指定された受注店舗が休止中の場合
  • 指定されたスマレジの支払方法が存在しない場合
  • 合計金額が計算式の結果と一致しない場合
  • 指定された商品が存在しない場合
  • 商品IDが未設定、かつ商品名が入力されていない場合
  • 受注店舗の販売区分が内税販売で税区分が税抜の受注明細を含む場合
  • 指定された軽減税率IDが存在しない場合
post/{contract_id}/order-shipment/orders
https://api.smaregi.dev/{contract_id}/order-shipment/orders

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "orderCode": "string",
  • "orderDateTime": "2023-09-05T11:52:51Z",
  • "carriage": 0,
  • "commission": 0,
  • "giftWrapPrice": 0,
  • "totalPointDiscount": 0,
  • "totalCouponDiscount": 0,
  • "subtotalCouponDiscount": 0,
  • "totalPromotionDiscount": 0,
  • "taxExclude": 0,
  • "total": 0,
  • "tax": 0,
  • "taxRate": 0,
  • "taxRounding": "0",
  • "paymentMethodId": "string",
  • "payType": "unset",
  • "paymentDate": null,
  • "payment": null,
  • "orderMemo": "string",
  • "deliveryMemo": "string",
  • "paymentMemo": "string",
  • "memo": "string",
  • "items":
    [
    ],
  • "storeId": "string",
  • "customer":
    {
    },
  • "shippingAddress":
    {
    },
  • "deliveryInfo":
    {
    },
  • "shippingInfo":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "orderHeadId": "string",
  • "orderCode": "string",
  • "orderDateTime": "2023-09-05T11:52:51Z",
  • "cancelDateTime": "2023-09-05T11:52:51Z",
  • "subtotal": 0,
  • "carriage": 0,
  • "commission": 0,
  • "giftWrapPrice": 0,
  • "totalPointDiscount": 0,
  • "totalCouponDiscount": 0,
  • "subtotalCouponDiscount": 0,
  • "totalPromotionDiscount": 0,
  • "taxExclude": 0,
  • "total": 0,
  • "tax": 0,
  • "taxRate": 0,
  • "taxRounding": "0",
  • "paymentMethodId": "string",
  • "payType": "unset",
  • "paymentDate": null,
  • "payment": null,
  • "shippingDate": "2023-09-05",
  • "deliveryNumber": "string",
  • "orderMemo": "string",
  • "deliveryMemo": "string",
  • "paymentMemo": "string",
  • "memo": "string",
  • "items":
    [
    ],
  • "storeId": "string",
  • "customer":
    {
    },
  • "shippingAddress":
    {
    },
  • "deliveryInfo":
    {
    },
  • "shippingInfo":
    {
    }
}

受注登録（出荷済）

受注を登録します。
※登録に成功した場合の受注ステータスは「出荷済」になります。

Authorizations:
OAuth2 (order-shipment.orders:write)
path Parameters
contract_id
required
string

契約ID

Request Body schema: application/json
orderCode
required
string <string> [ 1 .. 50 ] characters ^[ -~]+$

受注番号
受注を識別するための値を設定してください。
※任意受注店舗内でユニークでなければエラーになります。

orderDateTime
required
string <date-time>

受注日時[YYYY-MM-DDThh:mm:ssTZD]

carriage
integer [ 0 .. 999999999 ]
Default: 0

送料
税込価格を設定してください。

commission
integer [ 0 .. 999999999 ]
Default: 0

手数料
税込価格を設定してください。

giftWrapPrice
integer [ 0 .. 999999999 ]
Default: 0

ギフトラッピング料
税込価格を設定してください。

totalPointDiscount
integer [ 0 .. 999999999 ]
Default: 0

ポイント利用

totalCouponDiscount
integer [ 0 .. 999999999 ]
Default: 0

クーポン値引き

subtotalCouponDiscount
integer [ 0 .. 999999999 ]
Default: 0

クーポン値引き（モール）

totalPromotionDiscount
integer [ 0 .. 999999999 ]
Default: 0

プロモーション値引き

taxExclude
integer [ 0 .. 999999999 ]
Default: 0

外税受領額

total
required
integer [ 0 .. 999999999 ]

合計金額 下記計算式と一致する必要があります。 合計 ＝ 小計（明細リストの販売単価 * 数量の総和） + 外税受領額 + (送料 + 手数料 + ギフトラッピング料) - (ポイント利用 + クーポン値引き + クーポン値引き（モール） + プロモーション値引き)

tax
integer [ 0 .. 999999999 ]
Default: 0

内消費税

taxRate
required
integer [ 0 .. 100 ]

消費税率(ヘッダ)

taxRounding
required
string
Enum: "0" "1" "2"

税の丸め方式：(0:四捨五入、1:切り捨て、2:切り上げ)

paymentMethodId
required
string non-empty

スマレジの支払方法ID

payType
string
Default: "unset"
Enum: "before" "after" "unset"

前払/後払

  • before: 前払
  • after: 後払
  • unset: 未設定
paymentDate
string <date> Nullable
Default: null

入金日：支払いされた日付

payment
integer (支払金額) [ 0 .. 999999999 ] Nullable
Default: null

支払金額

shippingDate
required
string <date>

出荷日[YYYY-MM-DD]
※出荷済の場合、出荷日が設定されます。

deliveryNumber
string <= 20 characters

送り状番号

orderMemo
string <= 5000 characters

受注メモ

deliveryMemo
string <= 5000 characters

発送メモ

paymentMemo
string <= 5000 characters

入金メモ

memo
string <= 5000 characters

管理メモ

items
required
Array of objects (OrderItem) [ 1 .. 99 ] items

明細リスト

storeId
required
string non-empty

受注店舗ID

customer
required
object (Customer)

購入者

shippingAddress
required
object (ShippingAddress)

発送先

deliveryInfo
object

配送情報

shippingInfo