受注登録

POST

/orders

const url = 'https://api.smaregi.dev/TARGET-CONTRACT-ID/order-shipment/orders';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"orderCode":"123456-789xxxxx-xxxxxxxxxx-1234567890","orderDateTime":"2025-06-05T17:00:00+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-07","payment":10000,"payments":[{"paymentMethodId":"1","payment":21200}],"shippingPrepareStartDate":"2025-06-10","expectedShippingDate":"2025-06-10","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,"isSocialGift":false,"printedInvoiceDivision":false,"deliverySlipNotice":"このたびは大切な贈り物に当店の鮭とばをお選びいただき、誠にありがとうございます。"},"tags":[{"tagId":"1"}]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.smaregi.dev/TARGET-CONTRACT-ID/order-shipment/orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "orderCode": "123456-789xxxxx-xxxxxxxxxx-1234567890", "orderDateTime": "2025-06-05T17:00:00+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-07", "payment": 10000, "payments": [ { "paymentMethodId": "1", "payment": 21200 } ], "shippingPrepareStartDate": "2025-06-10", "expectedShippingDate": "2025-06-10", "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, "isSocialGift": false, "printedInvoiceDivision": false, "deliverySlipNotice": "このたびは大切な贈り物に当店の鮭とばをお選びいただき、誠にありがとうございます。" }, "tags": [ { "tagId": "1" } ] }'

受注を登録します。

Authorizations

AppAccessToken
order-shipment.orders:write

Request Body

application/json

Order

object

orderHeadId

受注ID

string

orderCode

required

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

string format: string

>= 1 characters <= 50 characters /^[ -~]+$/

orderStatus

受注ステータス

10: 受注確認
20: 入金確認
30: 在庫確認
40: 出荷日待ち
50: 納品書印刷
60: 出荷準備中
65: 出荷待ち
70: 出荷済
80: 返品待ち
90: 返品済
98: キャンセル済

string

Allowed values: 10 20 30 40 50 60 65 70 80 90 98

orderDateTime

required

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

string format: date-time

cancelDateTime

キャンセル日時[YYYY-MM-DDThh:mm:ssTZD]
※キャンセル済でない場合はnullを返します。

string format: date-time

nullable

subtotal

小計

integer

0 <= 999999999

carriage

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

integer

0 <= 999999999

commission

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

integer

0 <= 999999999

giftWrapPrice

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

integer

0 <= 999999999

totalPointDiscount

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

integer

0 <= 999999999

totalCouponDiscount

クーポン値引き

integer

0 <= 999999999

subtotalCouponDiscount

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

integer

0 <= 999999999

totalPromotionDiscount

プロモーション値引き

integer

0 <= 999999999

taxExclude

外税受領額

integer

0 <= 999999999

total

required

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

integer

<= 999999999

tax

内消費税

integer

0 <= 999999999

taxRate

required

消費税率（ヘッダ）

integer

<= 100

taxRounding

required

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

string

Allowed values: 0 1 2

paymentMethodId

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

string

>= 1 characters

payType

前払/後払

before: 前払
after: 後払
unset: 未設定

string

default: unset

Allowed values: before after unset

paymentDate

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

string format: date

nullable

payment

入金額

入金額

integer

nullable <= 999999999

payments

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

Array<object>

>= 1 items <= 3 items

Payments

受注支払情報

object

paymentMethodId

required

スマレジの支払方法ID

string

>= 1 characters

payment

支払金額

支払金額

integer

nullable <= 999999999

shippingPrepareStartDate

出荷準備開始予定日[YYYY-MM-DD]

この項目を指定しない場合、指定した配達希望日によって以下のルールで適用されます。

配達希望日がnull、またはリクエスト日時より7日以内の場合
- リクエスト日時が「当日出荷締め時間」未満であれば当日
- リクエスト日時が「当日出荷締め時間」以降であれば翌日
配達希望日がリクエスト日時から8日以上先の場合
- 配達希望日7日前

string format: date

nullable

expectedShippingDate

出荷予定日[YYYY-MM-DD]

この項目を指定しない場合、指定した配達希望日によって以下のルールで適用されます。

配達希望日がnull、またはリクエスト日時より7日以内の場合
- リクエスト日時が「当日出荷締め時間」未満であれば当日
- リクエスト日時が「当日出荷締め時間」以降であれば翌日
配達希望日がリクエスト日時から8日以上先の場合
- 配達希望日7日前

string format: date

nullable

shippingDate

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

string format: date

nullable

deliveryNumber

送り状番号

string

<= 20 characters

orderMemo

受注メモ

string

<= 5000 characters

deliveryMemo

発送メモ

string

<= 5000 characters

paymentMemo

入金メモ

string

<= 5000 characters

reserveDivision

引当区分

受注明細のすべてが引当済になると、この引当区分が引当済になります。

0: 引当未実行
1: 引当済
2: 引当失敗

string

Allowed values: 0 1 2

memo

管理メモ

string

<= 5000 characters

items

required

明細リスト

Array<object>

>= 1 items <= 99 items

OrderItem

受注明細

object

orderDetailId

受注明細ID

string

>= 1 characters

parentOrderDetailId

親の受注明細ID

受注明細がセット商品以外またはセット商品の親商品の場合、NULLが設定されます。受注明細がセット商品の子商品の場合、セット商品の親商品の受注明細IDが設定されます。

string

nullable

productId

スマレジの商品ID

string

>= 1 characters

productName

商品名
※商品IDが未設定の場合、商品名は必須です。

string

>= 1 characters <= 85 characters

connectedProductCode

連携先商品コード

string

>= 1 characters <= 99 characters

taxDivision

required

税区分：(0:税込、1:税抜、2:非課税)
※受注店舗の販売区分が内税販売の場合は税抜で登録できません

string

Allowed values: 0 1 2

price

商品単価

integer

0 <= 999999999

salesPrice

required

販売単価

integer

<= 999999999

total

明細の合計金額

integer

<= 999999999

quantity

required

数量

integer

>= 1 <= 999999

taxRate

消費税率（明細）

integer

<= 100

reduceTaxId

軽減税率ID
軽減:10000001 (特定商品の軽減税率適用）
上記以外の場合、カスタム軽減税率で登録されている軽減税率ID

※軽減税率販売時のみ設定。
※軽減税率は日本国における軽減税率(8%)です。
※存在しない軽減税率IDを指定した場合エラー。
※レスポンスでは、標準税率の場合nullとなります。

string

>= 1 characters

reduceTaxName

軽減税率名

string

nullable

isParent

親フラグ

true: セット商品の親商品
false: セット商品以外またはセット商品の子商品

受注明細がセット商品の親商品の場合、trueが設定されます。受注明細がセット商品以外またはセット商品の子商品の場合、falseが設定されます。

boolean

options

受注明細オプション

Array<object>

default: 0 <= 30 items

object

attribute

required

属性：例:サイズ、カラーなど

string

>= 1 characters <= 64 characters

value

required

値：例:S、M、L、黄色、赤、青など

string

>= 1 characters <= 64 characters

storeId

required

受注店舗ID

string

>= 1 characters

customer

required

Customer

購入者

object

fullName

required

購入者名

string

>= 1 characters <= 256 characters

email

required

購入者メールアドレス

string

>= 1 characters <= 256 characters

fullNameKana

購入者名カナ

string

<= 256 characters

zip

購入者郵便番号

string

<= 8 characters

prefectures

購入者都道府県

string

<= 20 characters

address1

購入者住所1

string

<= 256 characters

address2

購入者住所2

string

<= 256 characters

phone

購入者電話番号

string

<= 20 characters

shippingAddress

required

ShippingAddress

発送先

object

fullName

required

送り先名

string

>= 1 characters <= 256 characters

email

メールアドレス

string

<= 256 characters

fullNameKana

フリガナ

string

<= 256 characters

zip

required

郵便番号

string

>= 1 characters <= 8 characters

prefectures

都道府県

string

<= 20 characters

address1

住所1

string

<= 256 characters

address2

住所2

string

<= 256 characters

phone

電話番号

string

<= 20 characters

deliveryInfo

配送情報

object

deliveryCompany

配送会社：配送会社を指定できます。

sagawa：佐川急便
yamato：ヤマト運輸
yupack：日本郵便
others：上記以外の配送会社
unset：未設定

string

default: unset

Allowed values: sagawa yamato yupack others unset

deliveryMethodName

配送方法名

string

<= 256 characters

desiredDeliveryDate

配達希望日

string format: date

nullable

desiredDeliveryTime

配達希望時間帯

string

<= 100 characters

shippingInfo

出荷情報

object

giftDivision

true:ギフトあり
false:ギフトなし

boolean

isSocialGift

true:ソーシャルギフト受注
false:通常受注

ソーシャルギフト受注の場合、受取人の情報は注文者に公開されず、注文者の情報は受取人に公開されません。

boolean

printedInvoiceDivision

true:納品書希望あり
false:納品書希望なし

boolean

deliverySlipNotice

納品書特記事項

string

<= 5000 characters

tags

受注分類タグリスト

Array<object>

0 <= 5 items unique items

OrderTag

受注分類タグリスト

object

tagId

required

受注分類タグID

string

>= 1 characters

tagName

required

受注分類タグ名

受注分類タグ名

string

>= 1 characters <= 20 characters

createdAt

作成日時：登録時の日時。[YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

updatedAt

更新日時：登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

Example

{
  "orderCode": "123456-789xxxxx-xxxxxxxxxx-1234567890",
  "orderDateTime": "2025-06-05T17:00:00+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-07",
  "payment": 10000,
  "payments": [
    {
      "paymentMethodId": "1",
      "payment": 21200
    }
  ],
  "shippingPrepareStartDate": "2025-06-10",
  "expectedShippingDate": "2025-06-10",
  "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,
    "isSocialGift": false,
    "printedInvoiceDivision": false,
    "deliverySlipNotice": "このたびは大切な贈り物に当店の鮭とばをお選びいただき、誠にありがとうございます。"
  },
  "tags": [
    {
      "tagId": "1"
    }
  ]
}

Responses

200

更新成功

application/json

Order

object

orderHeadId

受注ID

string

orderCode

required

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

string format: string

>= 1 characters <= 50 characters /^[ -~]+$/

orderStatus

受注ステータス

10: 受注確認
20: 入金確認
30: 在庫確認
40: 出荷日待ち
50: 納品書印刷
60: 出荷準備中
65: 出荷待ち
70: 出荷済
80: 返品待ち
90: 返品済
98: キャンセル済

string

Allowed values: 10 20 30 40 50 60 65 70 80 90 98

orderDateTime

required

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

string format: date-time

cancelDateTime

キャンセル日時[YYYY-MM-DDThh:mm:ssTZD]
※キャンセル済でない場合はnullを返します。

string format: date-time

nullable

subtotal

小計

integer

0 <= 999999999

carriage

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

integer

0 <= 999999999

commission

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

integer

0 <= 999999999

giftWrapPrice

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

integer

0 <= 999999999

totalPointDiscount

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

integer

0 <= 999999999

totalCouponDiscount

クーポン値引き

integer

0 <= 999999999

subtotalCouponDiscount

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

integer

0 <= 999999999

totalPromotionDiscount

プロモーション値引き

integer

0 <= 999999999

taxExclude

外税受領額

integer

0 <= 999999999

total

required

integer

<= 999999999

tax

内消費税

integer

0 <= 999999999

taxRate

required

消費税率（ヘッダ）

integer

<= 100

taxRounding

required

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

string

Allowed values: 0 1 2

paymentMethodId

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

string

>= 1 characters

payType

前払/後払

before: 前払
after: 後払
unset: 未設定

string

default: unset

Allowed values: before after unset

paymentDate

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

string format: date

nullable

payment

入金額

入金額

integer

nullable <= 999999999

payments

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

Array<object>

>= 1 items <= 3 items

Payments

受注支払情報

object

paymentMethodId

required

スマレジの支払方法ID

string

>= 1 characters

payment

支払金額

支払金額

integer

nullable <= 999999999

shippingPrepareStartDate

出荷準備開始予定日[YYYY-MM-DD]

この項目を指定しない場合、指定した配達希望日によって以下のルールで適用されます。

配達希望日がnull、またはリクエスト日時より7日以内の場合
- リクエスト日時が「当日出荷締め時間」未満であれば当日
- リクエスト日時が「当日出荷締め時間」以降であれば翌日
配達希望日がリクエスト日時から8日以上先の場合
- 配達希望日7日前

string format: date

nullable

expectedShippingDate

出荷予定日[YYYY-MM-DD]

この項目を指定しない場合、指定した配達希望日によって以下のルールで適用されます。

配達希望日がnull、またはリクエスト日時より7日以内の場合
- リクエスト日時が「当日出荷締め時間」未満であれば当日
- リクエスト日時が「当日出荷締め時間」以降であれば翌日
配達希望日がリクエスト日時から8日以上先の場合
- 配達希望日7日前

string format: date

nullable

shippingDate

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

string format: date

nullable

deliveryNumber

送り状番号

string

<= 20 characters

orderMemo

受注メモ

string

<= 5000 characters

deliveryMemo

発送メモ

string

<= 5000 characters

paymentMemo

入金メモ

string

<= 5000 characters

reserveDivision

引当区分

受注明細のすべてが引当済になると、この引当区分が引当済になります。

0: 引当未実行
1: 引当済
2: 引当失敗

string

Allowed values: 0 1 2

memo

管理メモ

string

<= 5000 characters

items

required

明細リスト

Array<object>

>= 1 items <= 99 items

OrderItem

受注明細

object

orderDetailId

受注明細ID

string

>= 1 characters

parentOrderDetailId

親の受注明細ID

string

nullable

productId

スマレジの商品ID

string

>= 1 characters

productName

商品名
※商品IDが未設定の場合、商品名は必須です。

string

>= 1 characters <= 85 characters

connectedProductCode

連携先商品コード

string

>= 1 characters <= 99 characters

taxDivision

required

税区分：(0:税込、1:税抜、2:非課税)
※受注店舗の販売区分が内税販売の場合は税抜で登録できません

string

Allowed values: 0 1 2

price

商品単価

integer

0 <= 999999999

salesPrice

required

販売単価

integer

<= 999999999

total

明細の合計金額

integer

<= 999999999

quantity

required

数量

integer

>= 1 <= 999999

taxRate

消費税率（明細）

integer

<= 100

reduceTaxId

string

>= 1 characters

reduceTaxName

軽減税率名

string

nullable

isParent

親フラグ

true: セット商品の親商品
false: セット商品以外またはセット商品の子商品

受注明細がセット商品の親商品の場合、trueが設定されます。受注明細がセット商品以外またはセット商品の子商品の場合、falseが設定されます。

boolean

options

受注明細オプション

Array<object>

default: 0 <= 30 items

object

attribute

required

属性：例:サイズ、カラーなど

string

>= 1 characters <= 64 characters

value

required

値：例:S、M、L、黄色、赤、青など

string

>= 1 characters <= 64 characters

storeId

required

受注店舗ID

string

>= 1 characters

customer

required

Customer

購入者

object

fullName

required

購入者名

string

>= 1 characters <= 256 characters

email

required

購入者メールアドレス

string

>= 1 characters <= 256 characters

fullNameKana

購入者名カナ

string

<= 256 characters

zip

購入者郵便番号

string

<= 8 characters

prefectures

購入者都道府県

string

<= 20 characters

address1

購入者住所1

string

<= 256 characters

address2

購入者住所2

string

<= 256 characters

phone

購入者電話番号

string

<= 20 characters

shippingAddress

required

ShippingAddress

発送先

object

fullName

required

送り先名

string

>= 1 characters <= 256 characters

email

メールアドレス

string

<= 256 characters

fullNameKana

フリガナ

string

<= 256 characters

zip

required

郵便番号

string

>= 1 characters <= 8 characters

prefectures

都道府県

string

<= 20 characters

address1

住所1

string

<= 256 characters

address2

住所2

string

<= 256 characters

phone

電話番号

string

<= 20 characters

deliveryInfo

配送情報

object

deliveryCompany

配送会社：配送会社を指定できます。

sagawa：佐川急便
yamato：ヤマト運輸
yupack：日本郵便
others：上記以外の配送会社
unset：未設定

string

default: unset

Allowed values: sagawa yamato yupack others unset

deliveryMethodName

配送方法名

string

<= 256 characters

desiredDeliveryDate

配達希望日

string format: date

nullable

desiredDeliveryTime

配達希望時間帯

string

<= 100 characters

shippingInfo

出荷情報

object

giftDivision

true:ギフトあり
false:ギフトなし

boolean

isSocialGift

true:ソーシャルギフト受注
false:通常受注

ソーシャルギフト受注の場合、受取人の情報は注文者に公開されず、注文者の情報は受取人に公開されません。

boolean

printedInvoiceDivision

true:納品書希望あり
false:納品書希望なし

boolean

deliverySlipNotice

納品書特記事項

string

<= 5000 characters

tags

受注分類タグリスト

Array<object>

0 <= 5 items unique items

OrderTag

受注分類タグリスト

object

tagId

required

受注分類タグID

string

>= 1 characters

tagName

required

受注分類タグ名

受注分類タグ名

string

>= 1 characters <= 20 characters

createdAt

作成日時：登録時の日時。[YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

updatedAt

更新日時：登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

Example

{
  "orderHeadId": "774",
  "orderCode": "123456-789xxxxx-xxxxxxxxxx-1234567890",
  "orderStatus": "10",
  "orderDateTime": "2025-06-05T17:00:00+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-07",
  "payment": 10000,
  "payments": [
    {
      "paymentMethodId": "1",
      "payment": 21200
    }
  ],
  "shippingPrepareStartDate": "2025-06-10",
  "expectedShippingDate": "2025-06-10",
  "shippingDate": null,
  "deliveryNumber": "1213-4412-3310",
  "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,
    "isSocialGift": false,
    "printedInvoiceDivision": false,
    "deliverySlipNotice": "このたびは大切な贈り物に当店の鮭とばをお選びいただき、誠にありがとうございます。"
  },
  "tags": [
    {
      "tagId": "1",
      "tagName": "北海道フェア"
    }
  ],
  "createdAt": "2025-06-09T14:15:40+09:00",
  "updatedAt": "2025-06-09T14:15:40+09:00"
}

400

指定された受注番号がユニークでない場合
指定された受注店舗が存在しない場合
指定された受注店舗が休止中の場合
指定されたスマレジの支払方法が存在しない場合
合計金額が計算式の結果と一致しない場合
指定された商品が存在しない場合
商品IDが未設定、かつ商品名が入力されていない場合
受注店舗の販売区分が内税販売で税区分が税抜の受注明細を含む場合
指定された軽減税率IDが存在しない場合
指定された支払方法IDが存在しない場合
指定された受注分類タグIDが存在しない場合

application/json

object

type

required

string

title

required

string

detail

string

status

integer

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": "N番目の明細で指定された軽減税率IDは存在しません。",
  "status": 400
}

{
  "type": "about:blank",
  "title": "BadRequest",
  "detail": "N番目に指定されたスマレジの支払方法IDは存在しません。",
  "status": 400
}

{
  "type": "about:blank",
  "title": "BadRequest",
  "detail": "N番目に指定されたスマレジの受注分類タグIDは存在しません。",
  "status": 400
}