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

ポイント利用
この項目を指定する場合、支払方法リスト最大数は2件になります。

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
Deprecated

スマレジの支払方法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

入金額

payments
Array of objects (Payments) [ 1 .. 3 ] items

支払情報リスト
ポイント利用を指定する場合、このリストの最大数は2になります。
この項目と支払方法IDの併用はできません。

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が存在しない場合
  • 指定された支払方法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": "2024-04-05T11:15:17Z",
  • "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": "deprecated",
  • "payType": "unset",
  • "paymentDate": null,
  • "payment": null,
  • "payments":
    [
    ],
  • "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": "2024-04-05T11:15:17Z",
  • "cancelDateTime": "2024-04-05T11:15:17Z",
  • "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": "deprecated",
  • "payType": "unset",
  • "paymentDate": null,
  • "payment": null,
  • "payments":
    [
    ],
  • "shippingDate": "2024-04-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
string non-empty
Deprecated

スマレジの支払方法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

入金額

payments
Array of objects (Payments) [ 1 .. 3 ] items

支払情報リスト
ポイント利用を指定する場合、このリストの最大数は2になります。
スマレジの支払方法または支払情報リストはどちらか一つは入力必須です。
この項目と支払方法IDの併用はできません。

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
object

出荷情報

Responses

200

更新成功

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

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "orderCode": "string",
  • "orderDateTime": "2024-04-05T11:15:18Z",
  • "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": "deprecated",
  • "payType": "unset",
  • "paymentDate": null,
  • "payment": null,
  • "payments":
    [
    ],
  • "shippingDate": "2024-04-05",
  • "deliveryNumber": "string",
  • "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": "2024-04-05T11:15:18Z",
  • "cancelDateTime": "2024-04-05T11:15:18Z",
  • "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": "deprecated",
  • "payType": "unset",
  • "paymentDate": null,
  • "payment": null,
  • "payments":
    [
    ],
  • "shippingDate": "2024-04-05",
  • "deliveryNumber": "string",
  • "orderMemo": "string",
  • "deliveryMemo": "string",
  • "paymentMemo": "string",
  • "memo": "string",
  • "items":
    [
    ],
  • "storeId": "string",
  • "customer":
    {
    },
  • "shippingAddress":
    {
    },
  • "deliveryInfo":
    {
    },
  • "shippingInfo":
    {
    }
}

受注取得

受注を取得します。

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

契約ID

id
required
string

受注ID

Responses

200

取得成功

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "orderHeadId": "string",
  • "orderCode": "string",
  • "orderDateTime": "2024-04-05T11:15:18Z",
  • "cancelDateTime": "2024-04-05T11:15:18Z",
  • "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": "deprecated",
  • "payType": "unset",
  • "paymentDate": null,
  • "payment": null,
  • "payments":
    [
    ],
  • "shippingDate": "2024-04-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

id
required
string

受注ID

Responses

200

更新成功

400
  • 指定された受注の受注ステータスが「出荷済」「返品済」「返品待ち」の場合
  • 指定された受注が休止店舗のものである場合
  • 指定された受注の明細引当時の在庫参照店舗が削除済の場合
  • 指定された受注の明細引当時の在庫参照店舗が休止中の場合
patch/{contract_id}/order-shipment/orders/{id}/cancel
https://api.smaregi.dev/{contract_id}/order-shipment/orders/{id}/cancel

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "orderHeadId": "string",
  • "orderCode": "string",
  • "orderDateTime": "2024-04-05T11:15:18Z",
  • "cancelDateTime": "2024-04-05T11:15:18Z",
  • "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": "deprecated",
  • "payType": "unset",
  • "paymentDate": null,
  • "payment": null,
  • "payments":
    [
    ],
  • "shippingDate": "2024-04-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

id
required
string

受注ID

Request Body schema: application/json
paymentMethodId
string non-empty
Deprecated

スマレジの支払方法ID
この項目は非推奨です。支払情報リストを使用してください
この項目と支払情報リストの併用はできません。

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

前払/後払

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

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

payment
integer [ 0 .. 999999999 ] Nullable

入金額

payments
Array of objects (Payments) [ 1 .. 3 ] items

支払情報リスト
この項目と支払方法IDの併用はできません。

Responses

200

更新成功

400
  • 指定された受注の受注ステータスが「キャンセル済」「返品済」「返品待ち」の場合
  • 指定された受注が休止店舗のものである場合
  • 指定されたスマレジの支払方法が存在しない場合
  • 指定された支払方法IDが存在しない場合
patch/{contract_id}/order-shipment/orders/{id}/payment
https://api.smaregi.dev/{contract_id}/order-shipment/orders/{id}/payment

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "paymentMethodId": "deprecated",
  • "payType": "before",
  • "paymentDate": "2024-04-05",
  • "payment": 0,
  • "payments":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "orderHeadId": "string",
  • "orderCode": "string",
  • "orderDateTime": "2024-04-05T11:15:18Z",
  • "cancelDateTime": "2024-04-05T11:15:18Z",
  • "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": "deprecated",
  • "payType": "unset",
  • "paymentDate": null,
  • "payment": null,
  • "payments":
    [
    ],
  • "shippingDate": "2024-04-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

id
required
string

受注ID

Responses

200

更新成功

400
  • 指定された受注の受注ステータスが「キャンセル済」「返品済」「返品待ち」の場合
  • 指定された受注が休止店舗のものである場合
patch/{contract_id}/order-shipment/orders/{id}/payment_cancel
https://api.smaregi.dev/{contract_id}/order-shipment/orders/{id}/payment_cancel

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "orderHeadId": "string",
  • "orderCode": "string",
  • "orderDateTime": "2024-04-05T11:15:18Z",
  • "cancelDateTime": "2024-04-05T11:15:18Z",
  • "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": "deprecated",
  • "payType": "unset",
  • "paymentDate": null,
  • "payment": null,
  • "payments":
    [
    ],
  • "shippingDate": "2024-04-05",
  • "deliveryNumber": "string",
  • "orderMemo": "string",
  • "deliveryMemo": "string",
  • "paymentMemo": "string",
  • "memo": "string",
  • "items":
    [
    ],
  • "storeId": "string",
  • "customer":
    {
    },
  • "shippingAddress":
    {
    },
  • "deliveryInfo":
    {
    },
  • "shippingInfo":
    {
    }
}

受注店舗

受注店舗登録

受注店舗を登録します。

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

契約ID

Request Body schema: application/json
storeCode
required
string <= 20 characters ^[ -~]+$

店舗コード
※契約ID内でユニークでなければエラーになります。

storeName
required
string [ 1 .. 85 ] characters

店舗名

storeAbbr
string <= 85 characters

店舗名略称

sellDivision
string
Default: "included"
Enum: "included" "excluded"

販売区分：受注店舗での販売時の消費税の扱いを指定できます。

  • included: 内税販売
  • excluded: 外税販売
sumDateChangeTime
string ^(2[0-3]|[01][0-9]):([0-5][0-9])$
Default: "00:00"

指定した時刻を起点として締めを行なう日付が切り替わります。

displaySequence
integer [ 1 .. 999999999 ] Nullable
Default: null

店舗の並び順。

pointPaymentMethodId
string non-empty

ポイント支払方法
スマレジで取引を作成する際に、ポイント支払に割り当てるスマレジの支払方法IDを設定してください。
※管理画面では必須項目です。未設定の場合、受注店舗登録後に受注店舗詳細画面より設定してください。

Responses

200

更新成功

400
  • 店舗コードが重複している場合
  • 受注店舗件数が上限に達している場合
  • 指定されたスマレジの支払方法（ポイント支払方法）が存在しない場合
post/{contract_id}/order-shipment/stores
https://api.smaregi.dev/{contract_id}/order-shipment/stores

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "storeCode": "string",
  • "storeName": "string",
  • "storeAbbr": "string",
  • "sellDivision": "included",
  • "sumDateChangeTime": "23:59",
  • "displaySequence": null,
  • "pointPaymentMethodId": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "storeId": "string",
  • "storeCode": "string",
  • "storeName": "string",
  • "storeAbbr": "string",
  • "sellDivision": "included",
  • "sumDateChangeTime": "23:59",
  • "displaySequence": null,
  • "pauseFlag": true,
  • "pointPaymentMethodId": "string"
}

受注店舗取得

受注店舗を取得します。

Authorizations:
OAuth2 (order-shipment.stores:read)
path Parameters
contract_id
required
string

契約ID

store_id
required
string

受注店舗ID
※通常店舗及び倉庫の店舗IDは指定できません。

Responses

200

取得成功

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "storeId": "string",
  • "storeCode": "string",
  • "storeName": "string",
  • "storeAbbr": "string",
  • "sellDivision": "included",
  • "sumDateChangeTime": "23:59",
  • "displaySequence": null,
  • "pauseFlag": true,
  • "pointPaymentMethodId": "string"
}

受注店舗削除

受注店舗を削除します。

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

契約ID

store_id
required
string

受注店舗ID
※通常店舗及び倉庫の店舗IDは指定できません。

Responses

200

削除成功

400
  • 指定された受注店舗が他店の在庫参照店舗に設定されている場合
  • 指定された受注店舗に引当中の受注が存在する場合
delete/{contract_id}/order-shipment/stores/{store_id}
https://api.smaregi.dev/{contract_id}/order-shipment/stores/{store_id}

Response samples

Content type
application/json
Example
指定された受注店舗が他店の在庫参照店舗に設定されている場合
Copy
 Expand all Collapse all
{
  • "type": "about:blank",
  • "title": "BadRequest",
  • "detail": "指定された受注店舗は他店の在庫参照店舗に設定されているため、削除できません。",
  • "status": 400
}

在庫

在庫一覧取得

受注店舗の在庫参照店舗の在庫情報一覧を取得します。

Authorizations:
OAuth2 (order-shipment.stock:read)
path Parameters
contract_id
required
string

契約ID

store_id
required
string

受注店舗ID
※通常店舗及び倉庫の店舗IDは指定できません。

query Parameters
limit
integer [ 1 .. 1000 ]
Default: 100

取得件数

page
integer >= 1
Default: 1

ページ

sort
string
Default: "updatedAt:desc"
Enum: "updatedAt" "updatedAt:desc" "reserveUpdatedAt" "reserveUpdatedAt:desc"

ソート

  • updatedAt: 在庫数の最終更新日時
  • reserveUpdatedAt: 引当数の最終更新日時
product_ids
string non-empty

スマレジの商品ID
商品IDで指定された商品在庫を取得します。
（1以上の整数値をカンマ区切りで複数指定可、最大100件）

updated_at_from
string <date-time>

在庫数の最終更新日時(From)[YYYY-MM-DDThh:mm:ssTZD]
在庫数の最終更新日時が指定された日時以降の商品在庫を取得します。

updated_at_to
string <date-time>

在庫数の最終更新日時(To)[YYYY-MM-DDThh:mm:ssTZD]
在庫数の最終更新日時が指定された日時以前の商品在庫を取得します。

reserve_updated_at_from
string <date-time>

引当数の最終更新日時(From)[YYYY-MM-DDThh:mm:ssTZD]
引当数の最終更新日時が指定された日時以降の商品在庫を取得します。

reserve_updated_at_to
string <date-time>

引当数の最終更新日時(To)[YYYY-MM-DDThh:mm:ssTZD]
引当数の最終更新日時が指定された日時以前の商品在庫を取得します。

Responses

200

取得成功

400
  • 指定された商品IDの件数が100件を超える場合
  • 指定された商品IDに1以上の整数値でない値が含まれる場合
get/{contract_id}/order-shipment/stores/{store_id}/stock_list
https://api.smaregi.dev/{contract_id}/order-shipment/stores/{store_id}/stock_list

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Webhook

受注

header Parameters
Smaregi-Event
string

イベント名 order-shipment:orders

Request Body schema: application/json
contractId
string (契約ID)
event
string (イベント)
action
string (アクション)
  • shipped: 出荷済
  • canceled: キャンセル済

※actionは今後追加される場合があります。

storeId
string (受注店舗ID)
orderHeadIds
Array of strings (受注IDリスト)

Responses

200

受信成功

post/webhook-orders
https://api.smaregi.dev/webhook-orders

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "contractId": "smaregi",
  • "event": "order-shipment:orders",
  • "action": "shipped",
  • "storeId": "1",
  • "orderHeadIds":
    [
    ]
}