受注キャンセル
PATCH /orders/{order_id}/cancel
受注をキャンセルします。
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”受注ID
Example
774Responses
Section titled “ Responses ”更新成功
object
受注ID
774受注番号
受注を識別するための値を設定してください。
※任意受注店舗内でユニークでなければエラーになります。
123456-789xxxxx-xxxxxxxxxx-1234567890受注ステータス
10: 受注確認20: 入金確認30: 在庫確認40: 出荷日待ち50: 納品書印刷60: 出荷準備中65: 出荷待ち70: 出荷済80: 返品待ち90: 返品済98: キャンセル済
10受注日時[YYYY-MM-DDThh:mm:ssTZD]
2025-06-05T17:00:00+09:00キャンセル日時[YYYY-MM-DDThh:mm:ssTZD]
※キャンセル済でない場合はnullを返します。
2025-06-09T17:00:00+09:00小計
22000送料
税込価格を設定してください。
100手数料
税込価格を設定してください。
200ギフトラッピング料
税込価格を設定してください。
300ポイント利用
この項目を指定する場合、支払方法リスト最大数は2件になります。
400クーポン値引き
500クーポン値引き（モール）
600プロモーション値引き
700外税受領額
800合計金額 下記計算式と一致する必要があります。 合計 ＝ 小計（明細リストの販売単価 * 数量の総和） + 外税受領額 + (送料 + 手数料 + ギフトラッピング料) - (ポイント利用 + クーポン値引き + クーポン値引き（モール） + プロモーション値引き)
21200内消費税
1629消費税率（ヘッダ）
8税の丸め方式：(0:四捨五入、1:切り捨て、2:切り上げ)
0スマレジの支払方法ID
この項目は非推奨です。支払情報リストを使用してください
この項目と支払情報リストの併用はできません。
2前払/後払
before: 前払after: 後払unset: 未設定
before入金日：支払いされた日付
2025-06-07入金額
10000支払情報リスト
ポイント利用を指定する場合、このリストの最大数は2になります。
この項目と支払方法IDの併用はできません。
受注支払情報
object
スマレジの支払方法ID
1支払金額
21200出荷準備開始予定日[YYYY-MM-DD]
この項目を指定しない場合、指定した配達希望日によって以下のルールで適用されます。
- 配達希望日がnull、またはリクエスト日時より7日以内の場合
- リクエスト日時が「当日出荷締め時間」未満であれば当日
- リクエスト日時が「当日出荷締め時間」以降であれば翌日
- 配達希望日がリクエスト日時から8日以上先の場合
- 配達希望日7日前
2025-06-10出荷予定日[YYYY-MM-DD]
この項目を指定しない場合、指定した配達希望日によって以下のルールで適用されます。
- 配達希望日がnull、またはリクエスト日時より7日以内の場合
- リクエスト日時が「当日出荷締め時間」未満であれば当日
- リクエスト日時が「当日出荷締め時間」以降であれば翌日
- 配達希望日がリクエスト日時から8日以上先の場合
- 配達希望日7日前
2025-06-10出荷日[YYYY-MM-DD]
※出荷済の場合、出荷日が設定されます。
2025-06-10送り状番号
1213-4412-3310受注メモ
ギフトラッピングご希望発送メモ
冷凍での配送ご希望入金メモ
2025-06-10 10:00 未確認引当区分
受注明細のすべてが引当済になると、この引当区分が引当済になります。
0: 引当未実行1: 引当済2: 引当失敗
0管理メモ
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-09T14:15:40+09:00更新日時：登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]
2025-06-09T14:15:40+09:00Example
{ "orderHeadId": "774", "orderCode": "123456-789xxxxx-xxxxxxxxxx-1234567890", "orderStatus": "98", "orderDateTime": "2025-06-05T17:00:00+09:00", "cancelDateTime": "2025-06-09T17:00:00+09:00", "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": null, "payment": null, "payments": [], "shippingPrepareStartDate": "2025-06-10", "expectedShippingDate": "2025-06-10", "shippingDate": null, "deliveryNumber": null, "orderMemo": "ギフトラッピングご希望", "deliveryMemo": "冷凍での配送ご希望", "paymentMemo": "2025-06-10 10:00 未確認", "reserveDivision": "0", "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-09T14:15:40+09:00", "updatedAt": "2025-06-09T14:15:40+09:00"}- 指定された受注の受注ステータスが「出荷済」「返品済」「返品待ち」の場合
- 指定された受注が休止店舗のものである場合
- 指定された受注の明細引当時の在庫参照店舗が削除済の場合
- 指定された受注の明細引当時の在庫参照店舗が休止中の場合
object
Examples
{ "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": "指定された受注は明細引当時の在庫参照店舗が休止中のため、キャンセルできません。", "status": 400}