受注登録(出荷済)
POST /orders/shipped
受注を登録します。
※登録に成功した場合の受注ステータスは「出荷済」になります。
Authorizations
Section titled “Authorizations ”Request Body
Section titled “Request Body ”object
受注ID
774
受注番号
受注を識別するための値を設定してください。
※任意受注店舗内でユニークでなければエラーになります。
123456-789xxxxx-xxxxxxxxxx-1234567890
受注ステータス
10
: 受注確認20
: 入金確認30
: 在庫確認40
: 出荷日待ち50
: 納品書印刷60
: 出荷準備中65
: 出荷待ち70
: 出荷済80
: 返品待ち90
: 返品済98
: キャンセル済
70
受注日時[YYYY-MM-DDThh:mm:ssTZD]
2025-06-02T03:03:33+09:00
キャンセル日時[YYYY-MM-DDThh:mm:ssTZD]
※キャンセル済でない場合はnullを返します。
2025-06-10T03:03:33+09:00
小計
22000
送料
税込価格を設定してください。
100
手数料
税込価格を設定してください。
200
ギフトラッピング料
税込価格を設定してください。
300
ポイント利用
400
クーポン値引き
500
クーポン値引き(モール)
600
プロモーション値引き
700
外税受領額
800
合計金額 下記計算式と一致する必要があります。 合計 = 小計(明細リストの販売単価 * 数量の総和) + 外税受領額 + (送料 + 手数料 + ギフトラッピング料) - (ポイント利用 + クーポン値引き + クーポン値引き(モール) + プロモーション値引き)
21200
内消費税
1629
消費税率(ヘッダ)
8
税の丸め方式:(0:四捨五入、1:切り捨て、2:切り上げ)
0
スマレジの支払方法ID
この項目は非推奨です。支払情報リストを使用してください
この項目と支払情報リストの併用はできません。
スマレジの支払方法または支払情報リストはどちらか一つは入力必須です。
2
前払/後払
before
: 前払after
: 後払unset
: 未設定
before
入金日:支払いされた日付
2025-06-02
入金額
21200
支払情報リスト
ポイント利用を指定する場合、このリストの最大数は2になります。
スマレジの支払方法または支払情報リストはどちらか一つは入力必須です。
この項目と支払方法IDの併用はできません。
受注支払情報
object
スマレジの支払方法ID
1
支払金額
21200
出荷日[YYYY-MM-DD]
※出荷済の場合、出荷日が設定されます。
2025-06-01
送り状番号
1234567890
受注メモ
ギフトラッピングご希望
発送メモ
冷凍での配送ご希望
入金メモ
2025-06-10 10:00 未確認
引当区分
受注明細のすべてが引当済になると、この引当区分が引当済になります。
0
: 引当未実行1
: 引当済2
: 引当失敗
1
管理メモ
2025-06-10 11:00に入金のお願いを電話で行いました。
明細リスト
受注明細
object
受注明細ID
2
親の受注明細ID
受注明細がセット商品以外またはセット商品の親商品の場合、NULLが設定されます。 受注明細がセット商品の子商品の場合、セット商品の親商品の受注明細IDが設定されます。
1
スマレジの商品ID
8005735
商品名
※商品IDが未設定の場合、商品名は必須です。
北海道産鮭とば 1kg
連携先商品コード
B001-03001C
税区分:(0:税込、1:税抜、2:非課税)
※受注店舗の販売区分が内税販売の場合は税抜で登録できません
0
商品単価
22000
販売単価
22000
明細の合計金額
22000
数量
1
消費税率(明細)
8
軽減税率ID
軽減:10000001 (特定商品の軽減税率適用)
上記以外の場合、カスタム軽減税率で登録されている軽減税率ID
※軽減税率販売時のみ設定。
※軽減税率は日本国における軽減税率(8%)です。
※存在しない軽減税率IDを指定した場合エラー。
※レスポンスでは、標準税率の場合nullとなります。
10000001
軽減税率名
軽減税率
親フラグ
true
: セット商品の親商品false
: セット商品以外またはセット商品の子商品
受注明細がセット商品の親商品の場合、true
が設定されます。
受注明細がセット商品以外またはセット商品の子商品の場合、false
が設定されます。
受注明細オプション
object
属性:例:サイズ、カラーなど
サイズ
値:例:S、M、L、黄色、赤、青など
1kg
受注店舗ID
21
購入者
object
購入者名
スマレジ 太郎
購入者メールアドレス
sample@example.com
購入者名カナ
スマレジ タロウ
購入者郵便番号
555-5555
購入者都道府県
大阪府
購入者住所1
大阪市中央区
購入者住所2
大繁盛物産ビル 65F
購入者電話番号
000-0000-0000
発送先
object
送り先名
スマレジ 太郎
メールアドレス
sammple@example.com
フリガナ
スマレジ タロウ
郵便番号
555-5555
都道府県
大阪府
住所1
大阪市中央区
住所2
大繁盛物産ビル 65F
電話番号
000-0000-0000
配送情報
object
配送会社:配送会社を指定できます。
sagawa
:佐川急便yamato
:ヤマト運輸yupack
:日本郵便others
:上記以外の配送会社unset
:未設定
sagawa
配送方法名
宅配便(佐川急便)
配達希望日
2025-06-10
配達希望時間帯
10:00-12:00
出荷情報
object
- true:ギフトあり
- false:ギフトなし
- true:納品書希望あり
- false:納品書希望なし
納品書特記事項
このたびは大切な贈り物に当店の鮭とばをお選びいただき、誠にありがとうございます。
受注分類タグリスト
受注分類タグリスト
object
受注分類タグID
1
受注分類タグ名
北海道フェア
作成日時:登録時の日時。[YYYY-MM-DDThh:mm:ssTZD]
2025-06-10T08:47:23+09:00
更新日時:登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]
2025-06-10T08:47:49+09:00
Example
{ "orderCode": "123456-789xxxxx-xxxxxxxxxx-1234567890", "orderDateTime": "2025-06-02T03:03:33+09:00", "carriage": 100, "commission": 200, "giftWrapPrice": 300, "totalPointDiscount": 400, "totalCouponDiscount": 500, "subtotalCouponDiscount": 600, "totalPromotionDiscount": 700, "taxExclude": 800, "total": 21200, "tax": 1629, "taxRate": 8, "taxRounding": "0", "payType": "before", "paymentDate": "2025-06-02", "payment": 21200, "payments": [ { "paymentMethodId": "1", "payment": 21200 } ], "shippingDate": "2025-06-01", "deliveryNumber": "1234567890", "orderMemo": "ギフトラッピングご希望", "deliveryMemo": "冷凍での配送ご希望", "paymentMemo": "2025-06-10 10:00 未確認", "memo": "2025-06-10 11:00に入金のお願いを電話で行いました。", "items": [ { "productId": "8005735", "productName": "北海道産鮭とば 1kg", "connectedProductCode": "B001-03001C", "taxDivision": "0", "price": 22000, "salesPrice": 22000, "quantity": 1, "reduceTaxId": "10000001", "options": [ { "attribute": "サイズ", "value": "1kg" } ] } ], "storeId": "21", "customer": { "fullName": "スマレジ 太郎", "email": "sample@example.com", "fullNameKana": "スマレジ タロウ", "zip": "555-5555", "prefectures": "大阪府", "address1": "大阪市中央区", "address2": "大繁盛物産ビル 65F", "phone": "000-0000-0000" }, "shippingAddress": { "fullName": "スマレジ 太郎", "email": "sammple@example.com", "fullNameKana": "スマレジ タロウ", "zip": "555-5555", "prefectures": "大阪府", "address1": "大阪市中央区", "address2": "大繁盛物産ビル 65F", "phone": "000-0000-0000" }, "deliveryInfo": { "deliveryCompany": "sagawa", "deliveryMethodName": "宅配便(佐川急便)", "desiredDeliveryDate": "2025-06-10", "desiredDeliveryTime": "10:00-12:00" }, "shippingInfo": { "giftDivision": false, "printedInvoiceDivision": false, "deliverySlipNotice": "このたびは大切な贈り物に当店の鮭とばをお選びいただき、誠にありがとうございます。" }, "tags": [ { "tagId": "1" } ]}
Responses
Section titled “ Responses ”更新成功
object
受注ID
774
受注番号
受注を識別するための値を設定してください。
※任意受注店舗内でユニークでなければエラーになります。
123456-789xxxxx-xxxxxxxxxx-1234567890
受注ステータス
10
: 受注確認20
: 入金確認30
: 在庫確認40
: 出荷日待ち50
: 納品書印刷60
: 出荷準備中65
: 出荷待ち70
: 出荷済80
: 返品待ち90
: 返品済98
: キャンセル済
70
受注日時[YYYY-MM-DDThh:mm:ssTZD]
2025-06-02T03:03:33+09:00
キャンセル日時[YYYY-MM-DDThh:mm:ssTZD]
※キャンセル済でない場合はnullを返します。
2025-06-10T03:03:33+09:00
小計
22000
送料
税込価格を設定してください。
100
手数料
税込価格を設定してください。
200
ギフトラッピング料
税込価格を設定してください。
300
ポイント利用
400
クーポン値引き
500
クーポン値引き(モール)
600
プロモーション値引き
700
外税受領額
800
合計金額 下記計算式と一致する必要があります。 合計 = 小計(明細リストの販売単価 * 数量の総和) + 外税受領額 + (送料 + 手数料 + ギフトラッピング料) - (ポイント利用 + クーポン値引き + クーポン値引き(モール) + プロモーション値引き)
21200
内消費税
1629
消費税率(ヘッダ)
8
税の丸め方式:(0:四捨五入、1:切り捨て、2:切り上げ)
0
スマレジの支払方法ID
この項目は非推奨です。支払情報リストを使用してください
この項目と支払情報リストの併用はできません。
スマレジの支払方法または支払情報リストはどちらか一つは入力必須です。
2
前払/後払
before
: 前払after
: 後払unset
: 未設定
before
入金日:支払いされた日付
2025-06-02
入金額
21200
支払情報リスト
ポイント利用を指定する場合、このリストの最大数は2になります。
スマレジの支払方法または支払情報リストはどちらか一つは入力必須です。
この項目と支払方法IDの併用はできません。
受注支払情報
object
スマレジの支払方法ID
1
支払金額
21200
出荷日[YYYY-MM-DD]
※出荷済の場合、出荷日が設定されます。
2025-06-01
送り状番号
1234567890
受注メモ
ギフトラッピングご希望
発送メモ
冷凍での配送ご希望
入金メモ
2025-06-10 10:00 未確認
引当区分
受注明細のすべてが引当済になると、この引当区分が引当済になります。
0
: 引当未実行1
: 引当済2
: 引当失敗
1
管理メモ
2025-06-10 11:00に入金のお願いを電話で行いました。
明細リスト
受注明細
object
受注明細ID
2
親の受注明細ID
受注明細がセット商品以外またはセット商品の親商品の場合、NULLが設定されます。 受注明細がセット商品の子商品の場合、セット商品の親商品の受注明細IDが設定されます。
1
スマレジの商品ID
8005735
商品名
※商品IDが未設定の場合、商品名は必須です。
北海道産鮭とば 1kg
連携先商品コード
B001-03001C
税区分:(0:税込、1:税抜、2:非課税)
※受注店舗の販売区分が内税販売の場合は税抜で登録できません
0
商品単価
22000
販売単価
22000
明細の合計金額
22000
数量
1
消費税率(明細)
8
軽減税率ID
軽減:10000001 (特定商品の軽減税率適用)
上記以外の場合、カスタム軽減税率で登録されている軽減税率ID
※軽減税率販売時のみ設定。
※軽減税率は日本国における軽減税率(8%)です。
※存在しない軽減税率IDを指定した場合エラー。
※レスポンスでは、標準税率の場合nullとなります。
10000001
軽減税率名
軽減税率
親フラグ
true
: セット商品の親商品false
: セット商品以外またはセット商品の子商品
受注明細がセット商品の親商品の場合、true
が設定されます。
受注明細がセット商品以外またはセット商品の子商品の場合、false
が設定されます。
受注明細オプション
object
属性:例:サイズ、カラーなど
サイズ
値:例:S、M、L、黄色、赤、青など
1kg
受注店舗ID
21
購入者
object
購入者名
スマレジ 太郎
購入者メールアドレス
sample@example.com
購入者名カナ
スマレジ タロウ
購入者郵便番号
555-5555
購入者都道府県
大阪府
購入者住所1
大阪市中央区
購入者住所2
大繁盛物産ビル 65F
購入者電話番号
000-0000-0000
発送先
object
送り先名
スマレジ 太郎
メールアドレス
sammple@example.com
フリガナ
スマレジ タロウ
郵便番号
555-5555
都道府県
大阪府
住所1
大阪市中央区
住所2
大繁盛物産ビル 65F
電話番号
000-0000-0000
配送情報
object
配送会社:配送会社を指定できます。
sagawa
:佐川急便yamato
:ヤマト運輸yupack
:日本郵便others
:上記以外の配送会社unset
:未設定
sagawa
配送方法名
宅配便(佐川急便)
配達希望日
2025-06-10
配達希望時間帯
10:00-12:00
出荷情報
object
- true:ギフトあり
- false:ギフトなし
- true:納品書希望あり
- false:納品書希望なし
納品書特記事項
このたびは大切な贈り物に当店の鮭とばをお選びいただき、誠にありがとうございます。
受注分類タグリスト
受注分類タグリスト
object
受注分類タグID
1
受注分類タグ名
北海道フェア
作成日時:登録時の日時。[YYYY-MM-DDThh:mm:ssTZD]
2025-06-10T08:47:23+09:00
更新日時:登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]
2025-06-10T08:47:49+09:00
Example
{ "orderHeadId": "774", "orderCode": "123456-789xxxxx-xxxxxxxxxx-1234567890", "orderStatus": "70", "orderDateTime": "2025-06-02T03:03:33+09:00", "cancelDateTime": null, "subtotal": 22000, "carriage": 100, "commission": 200, "giftWrapPrice": 300, "totalPointDiscount": 400, "totalCouponDiscount": 500, "subtotalCouponDiscount": 600, "totalPromotionDiscount": 700, "taxExclude": 800, "total": 21200, "tax": 1629, "taxRate": 8, "taxRounding": "0", "paymentMethodId": "2", "payType": "before", "paymentDate": "2025-06-02", "payment": 21200, "payments": [ { "paymentMethodId": "1", "payment": 21200 } ], "shippingDate": "2025-06-01", "deliveryNumber": "1234567890", "orderMemo": "ギフトラッピングご希望", "deliveryMemo": "冷凍での配送ご希望", "paymentMemo": "2025-06-10 10:00 未確認", "reserveDivision": "1", "memo": "2025-06-10 11:00に入金のお願いを電話で行いました。", "items": [ { "orderDetailId": "2", "parentOrderDetailId": null, "productId": "8005735", "productName": "北海道産鮭とば 1kg", "connectedProductCode": "B001-03001C", "taxDivision": "0", "price": 22000, "salesPrice": 22000, "total": 22000, "quantity": 1, "taxRate": 8, "reduceTaxId": "10000001", "reduceTaxName": "軽減税率", "isParent": false, "options": [ { "attribute": "サイズ", "value": "1kg" } ] } ], "storeId": "21", "customer": { "fullName": "スマレジ 太郎", "email": "sample@example.com", "fullNameKana": "スマレジ タロウ", "zip": "555-5555", "prefectures": "大阪府", "address1": "大阪市中央区", "address2": "大繁盛物産ビル 65F", "phone": "000-0000-0000" }, "shippingAddress": { "fullName": "スマレジ 太郎", "email": "sammple@example.com", "fullNameKana": "スマレジ タロウ", "zip": "555-5555", "prefectures": "大阪府", "address1": "大阪市中央区", "address2": "大繁盛物産ビル 65F", "phone": "000-0000-0000" }, "deliveryInfo": { "deliveryCompany": "sagawa", "deliveryMethodName": "宅配便(佐川急便)", "desiredDeliveryDate": "2025-06-10", "desiredDeliveryTime": "10:00-12:00" }, "shippingInfo": { "giftDivision": false, "printedInvoiceDivision": false, "deliverySlipNotice": "このたびは大切な贈り物に当店の鮭とばをお選びいただき、誠にありがとうございます。" }, "tags": [ { "tagId": "1", "tagName": "北海道フェア" } ], "createdAt": "2025-06-10T08:47:23+09:00", "updatedAt": "2025-06-10T08:47:49+09:00"}
- 指定された受注番号がユニークでない場合
- 指定された受注店舗が存在しない場合
- 指定された受注店舗が休止中の場合
- 指定されたスマレジの支払方法が存在しない場合
- 合計金額が計算式の結果と一致しない場合
- 指定された商品が存在しない場合
- 商品IDが未設定、かつ商品名が入力されていない場合
- 受注店舗の販売区分が内税販売で税区分が税抜の受注明細を含む場合
- 前払/後払が「前払」で、入金日が未設定の場合
- 受注店舗のポイント支払方法が未設定の場合
- 受注店舗のポイント支払方法に設定されている支払方法が存在しない場合
- 指定された軽減税率IDが存在しない場合
- 指定された支払方法IDが存在しない場合
- 指定された受注分類タグIDが存在しない場合
object
Examples
{ "type": "about:blank", "title": "BadRequest", "detail": "指定された受注番号の受注は既に登録されています。", "status": 400}
{ "type": "about:blank", "title": "BadRequest", "detail": "指定された受注店舗は存在しません。", "status": 400}
{ "type": "about:blank", "title": "BadRequest", "detail": "受注店舗IDに休止状態の店舗が指定されています。", "status": 400}
{ "type": "about:blank", "title": "BadRequest", "detail": "合計金額が計算式の結果と一致しません。リクエスト値:{リクエスト値}、計算結果:{計算結果}", "status": 400}
{ "type": "about:blank", "title": "BadRequest", "detail": "指定されたスマレジの支払方法IDは存在しません。", "status": 400}
{ "type": "about:blank", "title": "BadRequest", "detail": "N番目の明細で指定された商品は存在しません。", "status": 400}
{ "type": "about:blank", "title": "BadRequest", "detail": "N番目の明細は商品IDが未設定のため、商品名は必須です。", "status": 400}
{ "type": "about:blank", "title": "BadRequest", "detail": "受注店舗の販売区分が内税販売のためN番目の受注明細について税区分を税抜で登録できません。", "status": 400}
{ "type": "about:blank", "title": "BadRequest", "detail": "前払/後払が「前払」の場合、入金日は必須です。", "status": 400}
{ "type": "about:blank", "title": "BadRequest", "detail": "受注店舗のポイント支払方法が未設定です。", "status": 400}
{ "type": "about:blank", "title": "BadRequest", "detail": "受注店舗のポイント支払方法に設定されている支払方法は存在しません。", "status": 400}
{ "type": "about:blank", "title": "BadRequest", "detail": "N番目の明細で指定された軽減税率IDは存在しません。", "status": 400}
{ "type": "about:blank", "title": "BadRequest", "detail": "N番目に指定されたスマレジの支払方法IDは存在しません。", "status": 400}
{ "type": "about:blank", "title": "BadRequest", "detail": "N番目に指定されたスマレジの受注分類タグIDは存在しません。", "status": 400}