サンドボックス
https://api.smaregi.dev/{契約ID}/order-shipment
本番
https://api.smaregi.jp/{契約ID}/order-shipment
一覧を取得するAPIでは1回で取得できる件数に上限があり、より多くの件数が必要となる場合はページを指定する必要があります。
page
に1から始まるページ番号を指定してください。
スマレジ・プラットフォームAPI 受注管理で定義しているscope一覧です。
Security Scheme Type | OAuth2 |
---|---|
clientCredentials OAuth Flow | Token URL: https://id.smaregi.dev/app/{contractId}/token Scopes:
|
受注を登録します。
指定した配達希望日によって出荷予定日、出荷準備開始予定日が以下のルールで適用されます。
order-shipment.orders:write
) contract_id required | string 契約ID |
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" 前払/後払
|
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 出荷情報 |
更新成功
{- "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": [
- {
- "productId": "string",
- "productName": "string",
- "connectedProductCode": "string",
- "taxDivision": "0",
- "price": 0,
- "salesPrice": 0,
- "quantity": 1,
- "reduceTaxId": "string",
- "options": [
- {
- "attribute": "string",
- "value": "string"
}
]
}
], - "storeId": "string",
- "customer": {
- "fullName": "string",
- "email": "string",
- "fullNameKana": "string",
- "zip": "string",
- "prefectures": "string",
- "address1": "string",
- "address2": "string",
- "phone": "string"
}, - "shippingAddress": {
- "fullName": "string",
- "email": "string",
- "fullNameKana": "string",
- "zip": "string",
- "prefectures": "string",
- "address1": "string",
- "address2": "string",
- "phone": "string"
}, - "deliveryInfo": {
- "deliveryCompany": "unset",
- "deliveryMethodName": "string",
- "desiredDeliveryDate": null,
- "desiredDeliveryTime": "string"
}, - "shippingInfo": {
- "giftDivision": false,
- "printedInvoiceDivision": false,
- "deliverySlipNotice": "string"
}
}
{- "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": [
- {
- "orderDetailId": "string",
- "productName": "string",
- "connectedProductCode": "string",
- "taxDivision": "0",
- "price": 0,
- "salesPrice": 0,
- "total": 0,
- "quantity": 1,
- "taxRate": 0,
- "reduceTaxId": "string",
- "reduceTaxName": "string",
- "options": [
- {
- "attribute": "string",
- "value": "string"
}
]
}
], - "storeId": "string",
- "customer": {
- "fullName": "string",
- "email": "string",
- "fullNameKana": "string",
- "zip": "string",
- "prefectures": "string",
- "address1": "string",
- "address2": "string",
- "phone": "string"
}, - "shippingAddress": {
- "fullName": "string",
- "email": "string",
- "fullNameKana": "string",
- "zip": "string",
- "prefectures": "string",
- "address1": "string",
- "address2": "string",
- "phone": "string"
}, - "deliveryInfo": {
- "deliveryCompany": "unset",
- "deliveryMethodName": "string",
- "desiredDeliveryDate": null,
- "desiredDeliveryTime": "string"
}, - "shippingInfo": {
- "giftDivision": false,
- "printedInvoiceDivision": false,
- "deliverySlipNotice": "string"
}
}
受注を登録します。
※登録に成功した場合の受注ステータスは「出荷済」になります。
order-shipment.orders:write
) contract_id required | string 契約ID |
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" 前払/後払
|
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 |