受注登録

POST

/orders

const url = 'https://api.smaregi.dev/TARGET-CONTRACT-ID/ec-oms/orders';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"order":{"customerId":-1,"orderName01":"山田","orderName02":"太郎","orderKana01":"ヤマダ","orderKana02":"タロウ","orderEmail":"test@example.com","orderEmailType":1,"orderTel01":"03","orderTel02":"1234","orderTel03":"5678","orderZip01":"100","orderZip02":"0001","orderPref":13,"orderAddr01":"千代田区千代田1-1","orderAddr02":"テストビル101","subtotal":1500,"discount":0,"total":2530,"delivFee":700,"charge":330,"tax":230,"paymentTotal":2530,"paymentAmountTotal":0,"ecOrderId":"EC-00001","ecType":1,"customerMemberFlg":1,"orderStatus":100,"paymentStatus":1,"paymentId":4,"delivId":1,"orderRoot":1,"reserveType":0,"orderAt":"2024-01-15 14:30:00"},"shipping":{"shippingName01":"田中","shippingName02":"花子","shippingTel01":"03","shippingTel02":"9876","shippingTel03":"5432","shippingZip01":"150","shippingZip02":"0001","shippingPref":13,"shippingAddr01":"渋谷区神宮前1-1","shippingAddr02":"","placementFlag":1,"placementCode":1,"socialGiftInput":0},"orderDetail":[{"productCode":"PROD001","productName":"テスト商品","price":1500,"quantity":1,"taxRate":10}]}'
};

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/ec-oms/orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "order": { "customerId": -1, "orderName01": "山田", "orderName02": "太郎", "orderKana01": "ヤマダ", "orderKana02": "タロウ", "orderEmail": "test@example.com", "orderEmailType": 1, "orderTel01": "03", "orderTel02": "1234", "orderTel03": "5678", "orderZip01": "100", "orderZip02": "0001", "orderPref": 13, "orderAddr01": "千代田区千代田1-1", "orderAddr02": "テストビル101", "subtotal": 1500, "discount": 0, "total": 2530, "delivFee": 700, "charge": 330, "tax": 230, "paymentTotal": 2530, "paymentAmountTotal": 0, "ecOrderId": "EC-00001", "ecType": 1, "customerMemberFlg": 1, "orderStatus": 100, "paymentStatus": 1, "paymentId": 4, "delivId": 1, "orderRoot": 1, "reserveType": 0, "orderAt": "2024-01-15 14:30:00" }, "shipping": { "shippingName01": "田中", "shippingName02": "花子", "shippingTel01": "03", "shippingTel02": "9876", "shippingTel03": "5432", "shippingZip01": "150", "shippingZip02": "0001", "shippingPref": 13, "shippingAddr01": "渋谷区神宮前1-1", "shippingAddr02": "", "placementFlag": 1, "placementCode": 1, "socialGiftInput": 0 }, "orderDetail": [ { "productCode": "PROD001", "productName": "テスト商品", "price": 1500, "quantity": 1, "taxRate": 10 } ] }'

受注を登録します。リクエストボディはorder（受注ヘッダー）、shipping（配送先）、orderDetail（受注明細）の3つの必須セクションと、orderGroup（同梱情報）のオプションセクションで構成されます。

Authorizations

AppAccessToken
ec-oms.orders:write

Request Body^required

application/json

Order

object

order

required

受注ヘッダー情報

object

customerId

顧客ID -1：名寄せ（注文者情報から既存顧客を検索し、該当があれば紐づけ・なければ新規作成） 0：非会員未指定：新規顧客として登録 1以上：指定された顧客IDの既存顧客に紐づけ

integer

>= -1

message

要望等

string

orderName01

required

注文者　お名前(姓)

string

<= 50 characters

orderName02

注文者　お名前(名)

string

<= 50 characters

orderKana01

注文者　お名前(ﾌﾘｶﾞﾅ・姓)

string

<= 50 characters

orderKana02

注文者　お名前(ﾌﾘｶﾞﾅ名)

string

<= 50 characters

orderCompanyName

注文者会社名

string

<= 50 characters

orderCompanyDepartment

注文者部署名

string

<= 50 characters

orderEmail

注文者メールアドレス

string

orderEmailType

required

注文者メールアドレスタイプ 1：PC、2：ｽﾏｰﾄﾌｫﾝ、3：携帯

integer

orderTel01

required

注文者電話番号1

string

<= 15 characters

orderTel02

注文者電話番号2

string

<= 6 characters

orderTel03

注文者電話番号3

string

<= 6 characters

orderFax01

注文者FAX1

string

<= 15 characters

orderFax02

注文者FAX2

string

<= 6 characters

orderFax03

注文者FAX3

string

<= 6 characters

orderCountryId

注文者国

integer

orderZip01

required

注文者郵便番号1

string

<= 10 characters

orderZip02

注文者郵便番号2

string

<= 4 characters

orderPref

required

注文者都道府県

integer

orderAddr01

required

注文者住所1

string

<= 200 characters

orderAddr02

注文者住所2

string

<= 200 characters

orderSex

注文者性別ID

integer

orderBirth

注文者生年月日（YYYY-MM-DD）

string

<= 10 characters

subtotal

required

商品合計

integer

discount

調整額（マイナス値指定可）

integer

discountMemo

調整額備考

string

<= 300 characters

total

required

合計額

integer

delivFee

required

送料

integer

charge

required

手数料

integer

couponCode

クーポンコード

string

<= 50 characters

couponName

クーポン名

string

<= 300 characters

couponTotal

クーポン利用

integer

usePoint

ポイント利用

integer

paymentTotal

required

請求額

integer

tax

required

消費税額

integer

addPoint

加算ポイント

integer

paymentAmountTotal

required

入金額

integer

totalNotax

合計額（税別）

integer

totalTax

合計額消費税合計額の消費税

integer

delivFeeNotax

送料（税別）

integer

chargeNotax

手数料（税別）

integer

ecOrderId

required

EC注文番号

string

<= 50 characters

ecOrderIdBranch

EC注文番号枝番指定しない場合は0

integer

ecType

required

EC種類

integer

ecShopId

EC店舗ID

integer

orderRoot

required

販売ルートID

integer

orderCnt

購入回数

integer

orderStatus

required

受注ステータス

integer

orderCancelReason

キャンセル理由

integer

orderStatus2

受注分類

integer

paymentId

required

支払方法ID

integer

paymentStatus

required

決済ステータス

integer

delivId

required

配送方法ID

integer

reserveType

required

申込番号種類

integer

reserveOrderId

申込番号

string

<= 50 characters

reserveStatus

申込状況 1:継続、2:休止、3:解約

integer

orderAt

required

注文日時（YYYY-MM-DD HH:MM:SS）

string

<= 19 characters

paymentLimitDate

支払期日（YYYY-MM-DD）

string

<= 10 characters

paymentDate

入金日（YYYY-MM-DD）

string

<= 10 characters

hassoDate

出荷予定日（YYYY-MM-DD）

string

<= 10 characters

commitDate

出荷日（YYYY-MM-DD）

string

<= 10 characters

cancelDate

キャンセル日（YYYY-MM-DD）

string

<= 10 characters

salesDate

売上日（YYYY-MM-DD）

string

<= 10 characters

note

ひとこと備考

string

<= 3000 characters

noteAttention

伝達事項

string

<= 50 characters

noteHistory

対応履歴

string

cancelMemo

キャンセルメモ

string

<= 3000 characters

giftFlag

ギフトフラグ 1:ギフト指定

integer

noshiName

のし名入

string

<= 50 characters

asurakuFlag

あす楽フラグ 0:指定なし、1:あすつく、2:きょうつく、3:翌日

integer

mark1

マーク１ 0:なし、1:あり

integer

mark2

マーク２ 0:なし、1:あり

integer

mark3

マーク３ 0:なし、1:あり

integer

taxCalcType

消費税計算区分 0:明細単位、1:伝票単位、3:伝票単位(B)

integer

letterId

お手紙ID

integer

letterMessage

お手紙差込

string

printMessage

納品書差込

string

mailMessage1

サンクスメール差込

string

mailMessage2

発送完了メール差込

string

mailMessage3

入金確認メール差込

string

mailMessage4

フォローメール差込

string

mailMessage7

その他１メール差込

string

mailMessage8

その他２メール差込

string

jponOrderId

他システム受注番号

string

exchangeUsePoint

交換利用ポイント

integer

paymentDiscountMemo

決済値引きメモ

string

paymentDiscount

決済値引き

integer

frontCodAmount

請求用代引金額

integer

otherDiscount

うちその他調整額

integer

noshiText

のし区分

string

customerMemberFlg

会員区分
注文店舗が楽天以外の場合は1固定
楽天の場合は 0:非会員、1:会員を指定
楽天の場合に必須

integer

senderCustomerFlg

送り主フラグ 0:注文者と同じ、1:送り主を指定する

integer

senderEcOrderId

送り主注文番号

string

orderTradeCode

送り主コード

string

estimateId

見積ID

integer

memberSalesChargeId

営業担当者ID

integer

customerCharge

カスタマー担当者ID

integer

customerChargeDeliv

出荷担当者ID

integer

combinedPaymentId

併用支払方法ID

integer

combinedPaymentPrice

併用支払金額

integer

customerPaymentDate

顧客入金日（YYYY-MM-DD）

string

<= 10 characters

returnDate

返品処理日（YYYY-MM-DD）

string

<= 10 characters

ecCustomerId

EC顧客ID

string

paymentInvoiceType

後払い請求書同梱タイプ 0:設定なし、2:別送、3:同梱

integer

paymentTorihikiId

後払い加盟店取引ID

string

paymentOrderAsk

後払い審査結果ID

integer

paymentOrderId

後払い決済会社取引ID

string

paymentOrderBillId

後払い請求先ID

string

paymentOrderAskMemo

後払い決済会社結果詳細

string

recalcFlg

再計算フラグ
1を指定時再計算

integer

shipping

required

配送先情報

object

shippingTradeCode

送付先コード

string

<= 50 characters

shippingName01

required

送付先　お名前(姓)

string

<= 50 characters

shippingName02

送付先　お名前(名)

string

<= 50 characters

shippingKana01

送付先　お名前(ﾌﾘｶﾞﾅ・姓)

string

<= 50 characters

shippingKana02

送付先　お名前(ﾌﾘｶﾞﾅ名)

string

<= 50 characters

shippingCompanyName

送付先会社名

string

<= 50 characters

shippingCompanyDepartment

送付先部署名

string

<= 50 characters

shippingTel01

required

送付先電話番号1

string

<= 15 characters

shippingTel02

送付先電話番号2

string

<= 6 characters

shippingTel03

送付先電話番号3

string

<= 6 characters

shippingFax01

送付先FAX1

string

<= 15 characters

shippingFax02

送付先FAX2

string

<= 6 characters

shippingFax03

送付先FAX3

string

<= 6 characters

shippingCountryId

送付先国

integer

shippingZip01

required

送付先郵便番号1

string

<= 10 characters

shippingZip02

送付先郵便番号2

string

<= 4 characters

shippingPref

required

送付先都道府県

integer

shippingAddr01

required

送付先住所1

string

<= 200 characters

shippingAddr02

送付先住所2

string

<= 200 characters

shippingEmail

送付先メールアドレス

string

shippingAt

お届け日（YYYY-MM-DD）

string

<= 10 characters

hassoDenpyoCode

送り状伝票番号

string

<= 30 characters

hassoEigyoFlg

営業所止め 1:営業所止め

integer

hassoChakuFlg

着払いフラグ 1:着払い

integer

hassoEigyoCode

営業所コード

string

<= 50 characters

hassoMemo

送り状記事

string

<= 50 characters

hassoKoguchi

小口

integer

hassoDelivId

運送業者ID

integer

hassoDelivKbn

配送区分

integer

hassoDelivKeisho

敬称

integer

extraDelivfeeKbn

送料計算区分

integer

oneDayOperationFlg

注文当日出荷フラグ

integer

placementFlag

置き配フラグ 0:置き配対象外注文、1:置き配注文

integer

placementCode

置き配場所コード 0:対面受取、1:玄関ドア前、2:自宅宅配BOX、3:ガスメーターBOX、4:物置、5:車庫、6:自転車かご、7:建物内受付／管理人預け

integer

socialGiftInput

ソーシャルギフト受取情報入力済みフラグ 0:未入力、1:入力済み

integer

orderDetail

required

受注明細情報（商品単位）

Array<object>

object

detailKbn

ご購入明細区分

integer

orderProductCode

ご購入明細購入時商品コード

string

<= 200 characters

productCode

required

ご購入明細商品コード

string

<= 200 characters

productName

required

ご購入明細商品名

string

<= 50 characters

classcategoryName1

ご購入明細規格名(横軸選択肢)

string

<= 50 characters

classcategoryName2

ご購入明細規格名(縦軸選択肢)

string

<= 50 characters

productOptionName

ご購入明細選択肢名

string

<= 3000 characters

productNoshiSelect

ご購入明細のし区分

string

productNoshiName

ご購入明細のし名入

string

taxFlag

ご購入明細消費税区分 0:税別、1:税込

integer

taxRule

ご購入明細消費税課税規則 1:四捨五入、2:切り捨て、3:切り上げ

integer

postageFlag

ご購入明細送料区分 0:送料別、1:送料込

integer

daibikiFlag

ご購入明細手数料区分 0:手数料別、1:手数料込

integer

price

required

ご購入明細税抜単価

integer

price02

ご購入明細税込単価

integer

price02Tax

ご購入明細消費税

integer

taxRate

required

ご購入明細消費税率

integer

quantity

required

ご購入明細数量

integer

point

ご購入明細付与ポイント

integer

pointRate

ご購入明細ポイント率

integer

pointRatePower

ご購入明細ポイント変倍率

integer

weight

ご購入明細重量

integer

orderJanCd

ご購入明細JANコード

string

<= 50 characters

orderLotNo

ご購入明細ロットNO

string

<= 50 characters

basePrice02

ご購入明細標準販売価格

integer

enclosuresFlag

ご購入明細封入物区分 0:通常商品、1:封入物

integer

backorderFlag

ご購入明細在庫切れ時注文フラグ 1:在庫切れ時注文

integer

price01

ご購入明細表示価格

integer

Example

{
  "order": {
    "customerId": -1,
    "orderName01": "山田",
    "orderName02": "太郎",
    "orderKana01": "ヤマダ",
    "orderKana02": "タロウ",
    "orderEmail": "test@example.com",
    "orderEmailType": 1,
    "orderTel01": "03",
    "orderTel02": "1234",
    "orderTel03": "5678",
    "orderZip01": "100",
    "orderZip02": "0001",
    "orderPref": 13,
    "orderAddr01": "千代田区千代田1-1",
    "orderAddr02": "テストビル101",
    "subtotal": 1500,
    "discount": 0,
    "total": 2530,
    "delivFee": 700,
    "charge": 330,
    "tax": 230,
    "paymentTotal": 2530,
    "paymentAmountTotal": 0,
    "ecOrderId": "EC-00001",
    "ecType": 1,
    "customerMemberFlg": 1,
    "orderStatus": 100,
    "paymentStatus": 1,
    "paymentId": 4,
    "delivId": 1,
    "orderRoot": 1,
    "reserveType": 0,
    "orderAt": "2024-01-15 14:30:00"
  },
  "shipping": {
    "shippingName01": "田中",
    "shippingName02": "花子",
    "shippingTel01": "03",
    "shippingTel02": "9876",
    "shippingTel03": "5432",
    "shippingZip01": "150",
    "shippingZip02": "0001",
    "shippingPref": 13,
    "shippingAddr01": "渋谷区神宮前1-1",
    "shippingAddr02": "",
    "placementFlag": 1,
    "placementCode": 1,
    "socialGiftInput": 0
  },
  "orderDetail": [
    {
      "productCode": "PROD001",
      "productName": "テスト商品",
      "price": 1500,
      "quantity": 1,
      "taxRate": 10
    }
  ]
}

Responses

201

登録成功

application/json

Order

受注登録レスポンス。order（受注ヘッダー）、shipping（配送先：配列）、orderDetail（受注明細：配列）の3セクションで構成されます。

object

order

受注ヘッダー情報

object

orderId

受注ID

string

>= 1 characters <= 9 characters

customerId

顧客ID

string

>= 1 characters <= 9 characters

message

要望等

string

nullable <= 65000 characters

orderName01

注文者お名前(姓)

string

>= 1 characters <= 50 characters

orderName02

注文者お名前(名)

string

>= 1 characters <= 50 characters

orderKana01

注文者お名前(フリガナ・姓)

string

>= 1 characters <= 50 characters

orderKana02

注文者お名前(フリガナ・名)

string

>= 1 characters <= 50 characters

orderCompanyName

注文者会社名

string

nullable <= 50 characters

orderCompanyDepartment

注文者部署名

string

nullable <= 50 characters

orderEmail

注文者メールアドレス

string format: email

nullable <= 50 characters

orderEmailType

注文者メールアドレスタイプ

string

>= 1 characters <= 1 characters

orderTel01

注文者電話番号1

string

>= 1 characters <= 15 characters

orderTel02

注文者電話番号2

string

nullable <= 6 characters

orderTel03

注文者電話番号3

string

nullable <= 6 characters

orderFax01

注文者FAX1

string

nullable <= 15 characters

orderFax02

注文者FAX2

string

nullable <= 6 characters

orderFax03

注文者FAX3

string

nullable <= 6 characters

orderCountryId

注文者国ID

string

nullable <= 3 characters

orderZip01

注文者郵便番号1

string

>= 1 characters <= 10 characters

orderZip02

注文者郵便番号2

string

nullable <= 4 characters

orderPref

注文者都道府県ID（数値文字列）

string

>= 1 characters <= 2 characters

orderAddr01

注文者住所1

string

>= 1 characters <= 200 characters

orderAddr02

注文者住所2

string

nullable <= 200 characters

orderSex

注文者性別

string

nullable <= 1 characters

subtotal

商品合計

string

>= 1 characters <= 9 characters

discount

調整額

string

nullable <= 9 characters

discountMemo

調整額備考

string

nullable <= 200 characters

total

合計額

string

>= 1 characters <= 9 characters

delivFee

送料

string

>= 1 characters <= 9 characters

charge

手数料

string

>= 1 characters <= 9 characters

couponCode

クーポンコード

string

nullable <= 50 characters

couponName

クーポン名

string

nullable <= 200 characters

couponTotal

クーポン利用

string

nullable <= 9 characters

usePoint

ポイント利用

string

nullable <= 9 characters

paymentTotal

請求額

string

>= 1 characters <= 9 characters

tax

消費税額

string

>= 1 characters <= 9 characters

addPoint

加算ポイント

string

nullable <= 9 characters

paymentAmountTotal

入金額

string

>= 1 characters <= 9 characters

ecType

EC種類

string

>= 1 characters <= 3 characters

ecOrderId

EC注文番号

string

>= 1 characters <= 100 characters

ecOrderIdBranch

EC注文番号枝番

string

nullable <= 9 characters

ecShopId

EC店舗ID

string

nullable <= 4 characters

orderRoot

販売ルートID

string

>= 1 characters <= 3 characters

orderCnt

購入回数

string

nullable <= 9 characters

orderStatus

受注ステータスID

string

>= 1 characters <= 9 characters

orderCancelReason

キャンセル理由

string

nullable <= 3 characters

orderStatus2

受注分類

string

nullable <= 9 characters

paymentId

支払方法ID

string

>= 1 characters <= 9 characters

paymentStatus

決済ステータス

string

>= 1 characters <= 3 characters

delivId

配送方法ID

string

>= 1 characters <= 9 characters

reserveType

申込番号種類

string

>= 1 characters <= 9 characters

periodicalOrderId

定期注文ID

string

nullable <= 9 characters

reserveOrderId

申込番号

string

nullable <= 100 characters

reserveStatus

申込状況

string

nullable <= 1 characters

orderAt

注文日時（YYYY-MM-DD HH:MM:SS）

string

>= 1 characters <= 19 characters /^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/

paymentLimitAt

支払期日

string format: date-time

nullable <= 25 characters

paymentAt

入金日

string format: date

nullable <= 10 characters

hassoAt

出荷予定日

string format: date-time

nullable <= 25 characters

commitAt

出荷日

string format: date-time

nullable <= 25 characters

salesAt

売上日

string format: date-time

nullable <= 25 characters

note

ひとこと備考

string

nullable <= 3000 characters

noteAttention

伝達事項

string

nullable <= 100 characters

noteHistory

対応履歴

string

nullable <= 65000 characters

deviceTypeId

デバイス種別ID

string

nullable <= 9 characters

cancelAt

キャンセル日

string format: date-time

nullable <= 25 characters

cancelMemo

キャンセルメモ

string

nullable <= 3000 characters

advertisingGroupId

広告グループID

string

nullable <= 50 characters

firstAdvertisingGroupId

初回広告グループID

string

nullable <= 50 characters

asurakuFlag

あす楽フラグ

string

nullable <= 1 characters

taxCalcType

消費税計算区分

string

nullable <= 1 characters

totalTax

合計額消費税

string

nullable <= 9 characters

delivFeeNotax

送料（税別）

string

nullable <= 9 characters

chargeNotax

手数料（税別）

string

nullable <= 9 characters

orderCustomerRank

顧客ランク

string

nullable <= 3 characters

giftFlag

ギフトフラグ

string

nullable <= 1 characters

noshiText

のし区分

string

nullable <= 50 characters

noshiName

のし名入

string

nullable <= 50 characters

mark1

マーク1

string

nullable <= 1 characters

mark2

マーク2

string

nullable <= 1 characters

mark3

マーク3

string

nullable <= 1 characters

printType1

出力フラグ(受注伝票)

string

nullable <= 1 characters

printType5

出力フラグ(お手紙)

string

nullable <= 1 characters

printType2

出力フラグ(納品書)

string

nullable <= 1 characters

printType3

出力フラグ(領収書)

string

nullable <= 1 characters

printType3Name

領収書宛名

string

nullable <= 50 characters

printType3Biko

領収書但し書き

string

nullable <= 50 characters

printType4

出力フラグ(請求書)

string

nullable <= 1 characters

printType4Biko

請求書備考

string

nullable <= 50 characters

printType13

出力フラグ(EMS)

string

nullable <= 1 characters

printType6

出力フラグ(送り状)

string

nullable <= 1 characters

printDate1

出力済(受注伝票) 0:出力なし、1:出力済

string