受注一覧取得

GET

/orders

const url = 'https://api.smaregi.dev/TARGET-CONTRACT-ID/ec-oms/orders?limit=100&page=1&fields=orderId%2CorderStatus%2CorderAt&order_id=1001%2C1002&order_id_from=1&order_id_to=100&ec_order_id=EC-00001&customer_id=1&order_at_from=2024-01-01&order_at_to=2024-12-31&hasso_at_from=2024-01-01&hasso_at_to=2024-12-31&commit_at_from=2024-01-01&commit_at_to=2024-12-31&cancel_at_from=2024-01-01&cancel_at_to=2024-12-31&update_at_from=2024-01-01&update_at_to=2024-12-31&shipping_at_from=2024-01-01&shipping_at_to=2024-12-31&order_statuses=%E6%96%B0%E8%A6%8F%E5%8F%97%E4%BB%98%2C%E7%99%BA%E9%80%81%E6%B8%88%E3%81%BF&shop_id=1%2C2&api_order_option1=1&group_type=0%2C1&sort=orderId%3Adesc';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

curl --request GET \
  --url 'https://api.smaregi.dev/TARGET-CONTRACT-ID/ec-oms/orders?limit=100&page=1&fields=orderId%2CorderStatus%2CorderAt&order_id=1001%2C1002&order_id_from=1&order_id_to=100&ec_order_id=EC-00001&customer_id=1&order_at_from=2024-01-01&order_at_to=2024-12-31&hasso_at_from=2024-01-01&hasso_at_to=2024-12-31&commit_at_from=2024-01-01&commit_at_to=2024-12-31&cancel_at_from=2024-01-01&cancel_at_to=2024-12-31&update_at_from=2024-01-01&update_at_to=2024-12-31&shipping_at_from=2024-01-01&shipping_at_to=2024-12-31&order_statuses=%E6%96%B0%E8%A6%8F%E5%8F%97%E4%BB%98%2C%E7%99%BA%E9%80%81%E6%B8%88%E3%81%BF&shop_id=1%2C2&api_order_option1=1&group_type=0%2C1&sort=orderId%3Adesc' \
  --header 'Authorization: Bearer <token>'

受注の一覧を取得します。レスポンスは受注単位でネストされた構造（order, shipping, orderGroup, orderDetail）で返却されます。

Authorizations

AppAccessToken
ec-oms.orders:read

Parameters

Query Parameters

limit

integer

default: 100 >= 1 <= 800

取得件数
※受注一覧では取得データ量が大きくなりやすいため、サーバー負荷を考慮し最大800件までとしています。

page

integer

default: 1 >= 1

ページ

fields

Array<string>

>= 1 items unique items

Allowed values: orderId customerId orderName01 orderName02 orderEmail orderTel subtotal total delivFee charge usePoint paymentTotal tax ecType ecOrderId orderStatus orderStatusName paymentId paymentMethod orderAt hassoAt cancelAt createAt updateAt shippingName01 shippingName02 shippingTel shippingZip shippingPref shippingAddr01 shippingAddr02 shippingAt shippingTime hassoDenpyoCode productNo productCode productName productPrice productQuantity productTotal taxRate

取得するフィールドをカンマ区切りで指定します。
指定がない場合すべてのフィールドを取得します。
フィールドはレスポンスのセクション（order, shipping, orderGroup, orderDetail）に自動で振り分けられます。

Example

?fields=orderId,orderStatus,orderAt

order_id

Array<string>

>= 1 items unique items

受注IDで絞り込みを行います。

完全一致で判定します。
カンマ区切りで複数指定した場合はOR条件として扱います（例: 1,2 は受注IDが1または2に一致するレコードを返却します）。
空文字を指定した場合や、カンマ区切り内に空要素を含む場合（例: 1,,2）は400エラーを返却します。
パラメータを省略した場合は絞り込みを行いません。

Example

?order_id=1001,1002

order_id_from

integer

受注IDの範囲指定（以上）で絞り込みを行います。

指定値以上の受注IDを持つレコードを返却します。
空文字を指定した場合は400エラーを返却します。
パラメータを省略した場合は絞り込みを行いません。

Example

order_id_to

integer

受注IDの範囲指定（以下）で絞り込みを行います。

指定値以下の受注IDを持つレコードを返却します。
空文字を指定した場合は400エラーを返却します。
パラメータを省略した場合は絞り込みを行いません。

Example

ec_order_id

string

EC受注番号で絞り込みを行います。

完全一致で判定します（部分一致は不可）。
空文字を指定した場合は400エラーを返却します。
パラメータを省略した場合は絞り込みを行いません。

Example

EC-00001

customer_id

integer

顧客IDで絞り込みを行います。

完全一致で判定します（部分一致は不可）。
空文字を指定した場合は400エラーを返却します。
パラメータを省略した場合は絞り込みを行いません。

Example

order_at_from

string format: date

受注日の範囲指定（以上）で絞り込みを行います。YYYY-MM-DD形式で指定します。

指定値以降の受注日を持つレコードを返却します。
空文字を指定した場合は400エラーを返却します。
パラメータを省略した場合は絞り込みを行いません。

Example

2024-01-01

order_at_to

string format: date

受注日の範囲指定（以下）で絞り込みを行います。YYYY-MM-DD形式で指定します。日付のみ指定の場合、23:59:59まで含みます。

指定値以前の受注日を持つレコードを返却します。
空文字を指定した場合は400エラーを返却します。
パラメータを省略した場合は絞り込みを行いません。

Example

2024-12-31

hasso_at_from

string format: date

出荷予定日の範囲指定（以上）で絞り込みを行います。YYYY-MM-DD形式で指定します。

指定値以降の出荷予定日を持つレコードを返却します。
空文字を指定した場合は400エラーを返却します。
パラメータを省略した場合は絞り込みを行いません。

Example

2024-01-01

hasso_at_to

string format: date

出荷予定日の範囲指定（以下）で絞り込みを行います。YYYY-MM-DD形式で指定します。

指定値以前の出荷予定日を持つレコードを返却します。
空文字を指定した場合は400エラーを返却します。
パラメータを省略した場合は絞り込みを行いません。

Example

2024-12-31

commit_at_from

string format: date

出荷日の範囲指定（以上）で絞り込みを行います。YYYY-MM-DD形式で指定します。

指定値以降の出荷日を持つレコードを返却します。
空文字を指定した場合は400エラーを返却します。
パラメータを省略した場合は絞り込みを行いません。

Example

2024-01-01

commit_at_to

string format: date

出荷日の範囲指定（以下）で絞り込みを行います。YYYY-MM-DD形式で指定します。

指定値以前の出荷日を持つレコードを返却します。
空文字を指定した場合は400エラーを返却します。
パラメータを省略した場合は絞り込みを行いません。

Example

2024-12-31

cancel_at_from

string format: date

キャンセル日の範囲指定（以上）で絞り込みを行います。YYYY-MM-DD形式で指定します。

指定値以降のキャンセル日を持つレコードを返却します。
空文字を指定した場合は400エラーを返却します。
パラメータを省略した場合は絞り込みを行いません。

Example

2024-01-01

cancel_at_to

string format: date

キャンセル日の範囲指定（以下）で絞り込みを行います。YYYY-MM-DD形式で指定します。

指定値以前のキャンセル日を持つレコードを返却します。
空文字を指定した場合は400エラーを返却します。
パラメータを省略した場合は絞り込みを行いません。

Example

2024-12-31

update_at_from

string format: date

更新日の範囲指定（以上）で絞り込みを行います。YYYY-MM-DD形式で指定します。

指定値以降の更新日を持つレコードを返却します。
空文字を指定した場合は400エラーを返却します。
パラメータを省略した場合は絞り込みを行いません。

Example

2024-01-01

update_at_to

string format: date

更新日の範囲指定（以下）で絞り込みを行います。YYYY-MM-DD形式で指定します。

指定値以前の更新日を持つレコードを返却します。
空文字を指定した場合は400エラーを返却します。
パラメータを省略した場合は絞り込みを行いません。

Example

2024-12-31

shipping_at_from

string format: date

お届け予定日の範囲指定（以上）で絞り込みを行います。YYYY-MM-DD形式で指定します。

指定値以降のお届け予定日を持つレコードを返却します。
空文字を指定した場合は400エラーを返却します。
パラメータを省略した場合は絞り込みを行いません。

Example

2024-01-01

shipping_at_to

string format: date

お届け予定日の範囲指定（以下）で絞り込みを行います。YYYY-MM-DD形式で指定します。

指定値以前のお届け予定日を持つレコードを返却します。
空文字を指定した場合は400エラーを返却します。
パラメータを省略した場合は絞り込みを行いません。

Example

2024-12-31

order_statuses

Array<string>

>= 1 items unique items

受注ステータスで絞り込みを行います。

完全一致で判定します（部分一致は不可）。
カンマ区切りで複数指定した場合はOR条件として扱います（例: A,B はAまたはBに一致するレコードを返却します）。
ステータス名またはステータスIDを指定できます。
空文字を指定した場合や、カンマ区切り内に空要素を含む場合（例: A,,B）は400エラーを返却します。
パラメータを省略した場合は絞り込みを行いません。

Example

?order_statuses=%E6%96%B0%E8%A6%8F%E5%8F%97%E4%BB%98,%E7%99%BA%E9%80%81%E6%B8%88%E3%81%BF

shop_id

Array<string>

>= 1 items unique items

店舗IDで絞り込みを行います。

完全一致で判定します（部分一致は不可）。
カンマ区切りで複数指定した場合はOR条件として扱います（例: A,B はAまたはBに一致するレコードを返却します）。
空文字を指定した場合や、カンマ区切り内に空要素を含む場合（例: A,,B）は400エラーを返却します。
パラメータを省略した場合は絞り込みを行いません。

Example

?shop_id=1,2

api_order_option1

integer

Allowed values: 1

封入物の出力制御を行います。

1 のみ指定可能。1 を指定すると封入物を含む全明細区分を出力します。
パラメータを省略した場合は封入物を orderDetail から除外します。

Example

group_type

Array<string>

>= 1 items unique items

同梱状況で絞り込みを行います。

完全一致で判定します（部分一致は不可）。
カンマ区切りで複数指定した場合はOR条件として扱います（例: A,B はAまたはBに一致するレコードを返却します）。
空文字を指定した場合や、カンマ区切り内に空要素を含む場合（例: A,,B）は400エラーを返却します。
パラメータを省略した場合は絞り込みを行いません。

Example

?group_type=0,1

sort

string

default: orderId:desc

Allowed values: orderId orderId:desc orderAt orderAt:desc updateAt updateAt:desc

ソート

orderId: 受注ID
orderAt: 受注日
updateAt: 更新日

Example

orderId:desc

Responses

200

取得成功

application/json

Array<object>

Order

受注一覧取得（GET）のレスポンス。受注単位でネストされた構造で返却されます。

object

order

OrderSectionResponse

object

orderId

受注ID

string

>= 1 characters <= 9 characters

customerId

顧客ID -1:取込処理で顧客新規作成、非会員の場合は0を指定

string

>= 1 characters <= 9 characters

message

要望等

string

nullable <= 3000 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

orderEmail

注文者メールアドレス

string format: email

nullable <= 50 characters

orderCompanyDepartment

注文者部署名

string

nullable <= 50 characters

orderEmailType

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

string

>= 1 characters <= 1 characters

orderTel

注文者電話番号

string

>= 1 characters <= 15 characters

orderFax

注文者FAX

string

nullable <= 15 characters

orderCountryId

注文者国

string

nullable <= 50 characters

orderZip

注文者郵便番号

string

>= 1 characters <= 10 characters

orderPref

注文者都道府県

string

>= 1 characters <= 50 characters

orderAddr01

注文者住所1

string

>= 1 characters <= 200 characters

orderAddr02

注文者住所2

string

nullable <= 200 characters

orderSex

注文者性別ID

string

>= 1 characters <= 1 characters

orderSexName

注文者性別

string

>= 1 characters <= 50 characters

orderBirth

注文者生年月日

string format: date

nullable <= 10 characters

orderJob

注文者職種ID

string

nullable <= 3 characters

orderJobName

注文者職種 ※未使用

string

nullable <= 50 characters

subtotal

商品合計

string

>= 1 characters <= 9 characters

discount

調整額

string

>= 1 characters <= 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

>= 1 characters <= 9 characters

usePoint

ポイント利用

string

>= 1 characters <= 9 characters

paymentTotal

請求額

string

>= 1 characters <= 9 characters

tax

消費税額

string

>= 1 characters <= 9 characters

addPoint

加算ポイント

string

>= 1 characters <= 9 characters

paymentAmountTotal

入金額

string

>= 1 characters <= 9 characters

ecType

EC種類

string

>= 1 characters <= 3 characters

orderEcTypeName

EC種類名

string

>= 1 characters <= 50 characters

ecOrderId

EC注文番号

string

>= 1 characters <= 100 characters

ecOrderIdBranch

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

string

nullable <= 9 characters

ecShopId

EC店舗ID

string

>= 1 characters <= 4 characters

orderShopName

EC店舗名

string

>= 1 characters <= 50 characters

orderRoot

販売ルートID

string

>= 1 characters <= 3 characters

orderRootName

販売ルート

string

>= 1 characters <= 50 characters

orderCnt

購入回数

string

>= 1 characters <= 9 characters

orderStatus

受注ステータス

string

>= 1 characters <= 9 characters

orderStatusName

受注ステータス名

string

>= 1 characters <= 50 characters

orderCancelReason

キャンセル理由

string

nullable <= 3 characters

orderCancelReasonName

キャンセル理由名

string

nullable <= 50 characters

orderStatus2

受注分類

string

nullable <= 9 characters

orderStatus2Name

受注分類名

string

nullable <= 50 characters

paymentId

支払方法ID

string

>= 1 characters <= 9 characters

paymentMethod

支払方法

string

>= 1 characters <= 50 characters

paymentStatus

決済ステータス

string

nullable <= 3 characters

hassoDelivId

運送業者ID

string

>= 1 characters <= 9 characters

delivTransName

運送業者名

string

>= 1 characters <= 50 characters

delivId

配送方法ID

string

>= 1 characters <= 9 characters

delivMethod

配送方法名

string

>= 1 characters <= 9 characters

hassoDelivKbn

配送区分

string

nullable <= 3 characters

delivKbnMethod

配送区分名

string

nullable <= 50 characters

reserveType

申込番号種類

string

>= 1 characters <= 9 characters

reserveTypeName

申込番号種類名

string

nullable <= 50 characters

reserveOrderId

申込番号

string

nullable <= 100 characters

reserveStatus

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

string

nullable <= 1 characters

orderAt

注文日時

string format: date-time

>= 1 characters <= 25 characters

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 <= 3000 characters

deviceName

デバイス

string

nullable <= 50 characters

cancelAt

キャンセル日

string format: date-time

nullable <= 25 characters

cancelMemo

キャンセルメモ

string

nullable <= 3000 characters

advertisingGroupCode

広告コード

string

nullable <= 50 characters

firstAdvertisingGroupCode

初回広告コード

string

nullable <= 50 characters

asurakuFlag

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

string

nullable <= 1 characters

taxCalcType

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

string

>= 1 characters <= 10 characters

totalNotax

合計額（税別）

string

>= 1 characters <= 9 characters

totalTax

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

string

>= 1 characters <= 9 characters

delivFeeNotax

送料（税別）

string

>= 1 characters <= 9 characters

chargeNotax

手数料（税別）

string

>= 1 characters <= 9 characters

orderCustomerRank

顧客ランク ※B2Bの場合は加盟店ランク

string

>= 1 characters <= 3 characters

otherDiscount

うちその他調整額

string

nullable >= 1 characters <= 9 characters

totalQuantity

商品点数

string

>= 1 characters <= 9 characters

giftFlag

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

string

nullable <= 1 characters

noshiText

のし区分

string

nullable <= 50 characters

noshiName

のし名入

string

nullable <= 50 characters

mark1

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

string

>= 1 characters <= 1 characters

mark2

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

string

>= 1 characters <= 1 characters

mark3

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

string

>= 1 characters <= 1 characters

printType1

出力フラグ(受注伝票) 0:出力なし、1:出力あり

string

>= 1 characters <= 1 characters

printType5

出力フラグ(お手紙) 0:出力なし、1:出力あり

string

>= 1 characters <= 1 characters

printType2

出力フラグ(納品書) 0:出力なし、1:出力あり、2:出力あり（金額なし）

string

>= 1 characters <= 1 characters

printType3

出力フラグ(領収書) 0:出力なし、1:出力あり、2:出力あり（納品書式）

string

>= 1 characters <= 1 characters

printType3Name

領収書宛名

string

nullable <= 50 characters

printType3Biko

領収書但し書き

string

nullable <= 50 characters

printType4

出力フラグ(請求書) 0:出力なし、1:出力あり

string

>= 1 characters <= 1 characters

printType4Biko

請求書備考

string

nullable <= 50 characters

printType13

出力フラグ(EMS) 0:出力なし、1:出力あり

string

>= 1 characters <= 1 characters

printType6

出力フラグ(送り状) 0:出力なし、1:依頼主に店舗名を出力、2:依頼主に注文者を出力

string

>= 1 characters <= 1 characters

printDate1

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

string

>= 1 characters <= 1 characters

printDate5

出力済(お手紙) 0:出力なし、1:出力済

string

>= 1 characters <= 1 characters

printDate2

出力済(納品書) 0:出力なし、1:出力済

string

>= 1 characters <= 1 characters

printDate3

出力済(領収書) 0:出力なし、1:出力済

string

>= 1 characters <= 1 characters

printDate4

出力済(請求書) 0:出力なし、1:出力済

string

>= 1 characters <= 1 characters

printDate13

出力済(EMS) 0:出力なし、1:出力済

string

>= 1 characters <= 1 characters

printDate6

出力済(送り状) 0:出力なし、1:出力済

string

>= 1 characters <= 1 characters

printDate7

出力済(後払い取引登録) 0:出力なし、1:出力済

string

>= 1 characters <= 1 characters

printDate8

出力済(後払い出荷登録) 0:出力なし、1:出力済

string

>= 1 characters <= 1 characters

printDate9

出力済(配送指示伝票) 0:出力なし、1:出力済

string

>= 1 characters <= 1 characters

printDate10

出力済(モール連携出荷) 0:出力なし、1:出力済

string

>= 1 characters <= 1 characters

printDate11

出力済(モール連携処理済) 0:出力なし、1:出力済

string

>= 1 characters <= 1 characters

mailDate1

メール送信済(サンクス) 0:出力なし、1:出力済

string

>= 1 characters <= 1 characters

mailDate2

メール送信済(入金確認) 0:出力なし、1:出力済

string

>= 1 characters <= 1 characters

mailDate3

メール送信済(発送完了) 0:出力なし、1:出力済

string

>= 1 characters <= 1 characters

mailDate4

メール送信済(フォロー) 0:出力なし、1:出力済

string

>= 1 characters <= 1 characters

mailDate7

メール送信済(その他１) 0:出力なし、1:出力済

string

>= 1 characters <= 1 characters

mailDate8

メール送信済(その他２) 0:出力なし、1:出力済

string

>= 1 characters <= 1 characters

letterId

お手紙ID

string

nullable <= 9 characters

letterName

お手紙名

string

nullable <= 50 characters

letterMessage

お手紙差込

string

nullable <= 3000 characters

printMessage

納品書差込

string

nullable <= 3000 characters

mailMessage1

サンクスメール差込

string

nullable <= 3000 characters

mailMessage2

発送完了メール差込

string

nullable <= 3000 characters

mailMessage3

入金確認メール差込

string

nullable <= 3000 characters

mailMessage4

フォローメール差込

string

nullable <= 3000 characters

mailMessage7

その他１メール差込

string

nullable <= 3000 characters

mailMessage8

その他２メール差込

string

nullable <= 3000 characters

jponOrderId

他システム受注番号

string

nullable <= 3000 characters

exchangeUsePoint

交換利用ポイント

string

>= 1 characters <= 9 characters

paymentDiscountMemo

決済値引きメモ

string

nullable <= 50 characters

paymentDiscount

決済値引き

string

nullable <= 9 characters

createAt

登録日時

string format: date-time

>= 1 characters <= 25 characters

couponSerialCode

クーポンシリアルコード

string

nullable <= 50 characters

updateAt

更新日時

string format: date-time

>= 1 characters <= 25 characters

frontCodAmount

請求用代引金額

string

>= 1 characters <= 9 characters

customerStatus

会員ステータス

string

>= 1 characters <= 50 characters

friendCampaignCode

紹介キャンペーンコード

string

nullable <= 50 characters

bbcMemberGroupCode

BBC加盟店グループコード

string

nullable <= 50 characters

bbcMemberGroupName

BBC加盟店グループ名

string

nullable <= 50 characters

bbcMemberCode

BBC加盟店コード

string

nullable <= 9 characters

bbcCompanyName

BBC加盟店名

string

nullable <= 50 characters

memberStaffId

BBC加盟店スタッフID

string

nullable <= 9 characters

memberStaffName

BBC加盟店スタッフ名

string

nullable <= 50 characters

b2bMemberCode

B2B加盟店コード

string

nullable <= 50 characters

b2bCompanyName

B2B加盟店名

string

nullable <= 50 characters

memberSalesChargeId

営業担当者ID

string

nullable <= 9 characters

memberSalesChargeName

営業担当者

string

nullable <= 50 characters

customerCharge

カスタマー担当者ID

string

nullable <= 9 characters

customerChargeName

カスタマー担当者

string

nullable <= 50 characters

customerChargeDeliv

出荷担当者ID

string

nullable <= 9 characters

customerChargeDelivName

出荷担当者

string

nullable <= 50 characters

senderCustomerFlg

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

string

nullable <= 1 characters

senderEcOrderId

送り主注文番号

string

nullable <= 50 characters

orderTradeCode

送り主コード

string

nullable <= 50 characters

paymentInvoiceType

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

string

>= 1 characters <= 1 characters

paymentTorihikiId

後払い加盟店取引ID

string

nullable <= 50 characters

paymentOrderAskId

後払い審査結果ID

string

>= 1 characters <= 3 characters

paymentOrderAskName

後払い審査結果名

string

0 <= 50 characters

paymentOrderId

後払い決済会社取引ID

string

nullable <= 50 characters

paymentOrderBillId

後払い請求先ID

string

nullable <= 50 characters

paymentOrderAskMemo

後払い決済会社結果詳細

string

nullable <= 200 characters

combinedPaymentId

併用支払方法ID

string

nullable <= 9 characters

combinedPaymentMethod

併用支払方法

string

nullable <= 50 characters

combinedPaymentPrice

併用支払金額

string

nullable <= 9 characters

customerPaymentAt

顧客入金日

string format: date-time

nullable <= 25 characters

returnAt

返品処理日

string format: date-time

nullable <= 25 characters

ecCustomerId

EC顧客ID

string

nullable <= 9 characters

subtotalNotax

商品代金合計（税別）

string

>= 1 characters <= 9 characters

estimateId

見積ID

string

nullable <= 9 characters

shipping

配送先情報。

ShippingSectionResponse

配送先情報

object

shippingTradeCode

送付先コード

string

nullable <= 50 characters

shippingName01

送付先　お名前(姓)

string

>= 1 characters <= 50 characters

shippingName02

送付先　お名前(名)

string

>= 1 characters <= 50 characters

shippingKana01

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

string

>= 1 characters <= 50 characters

shippingKana02

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

string

>= 1 characters <= 50 characters

shippingCompanyName

送付先会社名

string

nullable <= 50 characters

shippingCompanyDepartment

送付先部署名

string

nullable <= 50 characters

shippingTel

送付先電話番号

string

>= 1 characters <= 15 characters

shippingFax

送付先FAX

string

nullable >= 1 characters <= 15 characters

shippingCountryId

送付先国

string

nullable <= 50 characters

shippingZip

送付先郵便番号

string

>= 1 characters <= 10 characters

shippingPref

送付先都道府県

string

>= 1 characters <= 50 characters

shippingAddr01

送付先住所1

string

>= 1 characters <= 200 characters

shippingAddr02

送付先住所2

string

>= 1 characters <= 200 characters

hassoDenpyoCode

送り状伝票番号

string

nullable <= 30 characters

hassoEigyoFlg

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

string

nullable <= 1 characters

hassoChakuFlg

着払いフラグ 1:着払い

string

nullable <= 1 characters

hassoEigyoCode

営業所コード

string

nullable <= 50 characters

hassoMemo

送り状記事

string

nullable <= 50 characters

hassoKoguchi

小口

string

nullable <= 9 characters

shippingKeishoName

敬称

string

nullable <= 50 characters

shippingAt

お届け日

string format: date-time

nullable <= 25 characters

shippingTime

お届け時間

string

nullable <= 50 characters

extraDelivfeeKbn

送料計算区分

string

nullable <= 10 characters

shippingEmail

送付先メールアドレス

string format: email

nullable <= 50 characters

oneDayOperationFlg

注文当日出荷フラグ

string

nullable <= 1 characters

placementFlag

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

string

nullable <= 1 characters

placementCode

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

string

nullable <= 1 characters

socialGiftFlag

ソーシャルギフトフラグ shippingInfoが“1”,“2”,“3”,“5”の場合は“1”、それ以外は“0”

string

>= 1 characters <= 1 characters

socialGiftInput

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

string

nullable <= 1 characters

orderGroup

OrderGroupSectionResponse

同梱受注情報

object

groupOrderId

同梱ID

string

nullable <= 9 characters

groupSubtotal

同梱商品代金合計

string

nullable <= 9 characters

groupDiscount

同梱調整額

string

nullable <= 9 characters

groupDelivFee

同梱送料

string

nullable <= 9 characters

groupCharge

同梱手数料

string

nullable <= 9 characters

groupUsePoint

同梱利用ポイント

string

nullable <= 9 characters

groupCouponTotal

同梱利用クーポン

string

nullable <= 9 characters

groupPaymentTotal

同梱利用請求額

string

nullable <= 9 characters

groupTax

同梱うち消費税

string

nullable <= 9 characters

groupPaymentAmountTotal

同梱入金額

string

nullable <= 9 characters

groupTaxCalcType

同梱消費税計算区分伝票単位、伝票単位(B)、明細単位

string

nullable <= 10 characters

groupTotalTax

同梱合計額消費税合計額の消費税

string

nullable <= 9 characters

groupDelivFeeNotax

同梱送料（税別）

string

nullable <= 9 characters

groupChargeNotax

同梱手数料（税別）

string

nullable <= 9 characters

orderDetail

Array<object>

OrderDetailSectionResponse

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

object

productNo

ご購入明細番号

string

>= 1 characters <= 11 characters

detailKbn

ご購入明細区分

string

>= 1 characters <= 50 characters

orderProductCode

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

string

>= 1 characters <= 200 characters

productCode

ご購入明細商品コード

string

>= 1 characters <= 200 characters

productName

ご購入明細商品名

string

>= 1 characters <= 255 characters

classcategoryName1

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

string

nullable <= 50 characters

classcategoryName2

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

string

nullable <= 50 characters

productOptionName

ご購入明細選択肢名

string

nullable <= 3000 characters

productNoshiSelect

ご購入明細のし区分

string

nullable <= 50 characters

productNoshiName

ご購入明細のし名入

string

nullable <= 50 characters

productTaxFlag

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

string

>= 1 characters <= 2 characters

taxRule

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

string

>= 1 characters <= 1 characters

productPostageFlag

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

string

>= 1 characters <= 2 characters

productDaibikiFlag

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

string

>= 1 characters <= 2 characters

productPriceNotax

ご購入明細税抜単価ご購入明細消費税区分が「別」の場合必須

string

>= 1 characters <= 9 characters

productPrice

ご購入明細税込単価ご購入明細消費税区分が「込」の場合必須

string

>= 1 characters <= 9 characters

productTax

ご購入明細消費税

string

>= 1 characters <= 9 characters

taxRate

ご購入明細消費税率

string

>= 1 characters <= 9 characters

productQuantity

ご購入明細数量

string

>= 1 characters <= 9 characters

productTotal

ご購入明細金額

string

>= 1 characters <= 9 characters

point

ご購入明細付与ポイント

string

>= 1 characters <= 9 characters

pointRate

ご購入明細ポイント率

string

>= 1 characters <= 9 characters

pointRatePower

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

string

nullable <= 9 characters

weight

ご購入明細重量

string

nullable <= 9 characters

productRegFlag

ご購入明細商品種別

string

>= 1 characters <= 50 characters

orderJanCd

ご購入明細JANコード

string

nullable <= 50 characters

orderLotNo

ご購入明細ロットNO

string

nullable <= 50 characters

basePrice02

ご購入明細標準販売価格

string

nullable >= 1 characters <= 9 characters

enclosuresFlag

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

string

>= 1 characters <= 1 characters

b2bPrice04NotaxSaron

ご購入明細B2Bサロン価格（税抜）

string

nullable <= 1 characters

b2bPrice04

ご購入明細B2B価格（税込）

string

nullable <= 1 characters

b2bPrice04Notax

ご購入明細B2B価格（税抜）

string

nullable <= 1 characters

price01

ご購入明細表示価格

string

nullable >= 1 characters <= 9 characters

backorderFlag

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

string

nullable <= 9 characters

orderDetailParts

受注明細パーツ情報（商品SKU単位）

Array<object>

OrderDetailPartsSectionResponse

受注明細パーツ情報（商品SKU単位）

object

productSkuCode

商品SKUコード

string

nullable

productSkuName

商品SKU名

string

nullable

productSkuName2

商品SKU名（お客様用）

string

nullable

quantity

数量

string

nullable

stockReserveFlag

在庫引当区分

string

nullable

supplierId

仕入先

string

nullable

shipmentQuantity

出荷数量購入数×商品SKU数量

string

nullable

preInventoryQuantity

仮引当済数量

string

nullable

inventoryQuantity

引当済数量

string

nullable

commitQuantity

出庫済数量

string

nullable

Examples

default

[
  {
    "order": {
      "orderId": "1001",
      "customerId": "500",
      "message": "",
      "orderName01": "山田",
      "orderName02": "太郎",
      "orderKana01": "ヤマダ",
      "orderKana02": "タロウ",
      "orderCompanyName": null,
      "orderCompanyDepartment": null,
      "orderEmail": "test@example.com",
      "orderEmailType": "1",
      "orderTel": "0312345678",
      "orderFax": null,
      "orderCountryId": "日本",
      "orderZip": "100-0001",
      "orderPref": "東京都",
      "orderAddr01": "千代田区千代田1-1",
      "orderAddr02": "テストビル101",
      "orderSex": "1",
      "orderSexName": "男性",
      "orderBirth": null,
      "orderJob": null,
      "orderJobName": null,
      "subtotal": "1500",
      "discount": "0",
      "discountMemo": "",
      "total": "2530",
      "delivFee": "700",
      "charge": "330",
      "couponCode": null,
      "couponName": null,
      "couponTotal": "0",
      "usePoint": "0",
      "paymentTotal": "2530",
      "tax": "136",
      "addPoint": "0",
      "paymentAmountTotal": "0",
      "ecType": "1",
      "orderEcTypeName": "テストモール",
      "ecOrderId": "354274-20260225-0308609454",
      "ecOrderIdBranch": "0",
      "ecShopId": "31",
      "orderShopName": "TESTショップ",
      "orderRoot": "1",
      "orderRootName": "ネット注文",
      "orderCnt": "3",
      "orderStatus": "200",
      "orderStatusName": "入金確認待ち",
      "orderCancelReason": "0",
      "orderCancelReasonName": null,
      "orderStatus2": "0",
      "orderStatus2Name": null,
      "paymentId": "4",
      "paymentMethod": "代金引換",
      "paymentStatus": "1",
      "hassoDelivId": "1003",
      "delivTransName": "日本郵便",
      "delivId": "1",
      "delivMethod": "宅配便",
      "hassoDelivKbn": null,
      "delivKbnMethod": null,
      "reserveType": "0",
      "reserveTypeName": "通常",
      "reserveOrderId": null,
      "reserveStatus": "0",
      "orderAt": "2026-02-25T17:09:31+09:00",
      "paymentLimitAt": null,
      "paymentAt": null,
      "hassoAt": null,
      "commitAt": null,
      "salesAt": null,
      "note": "",
      "noteAttention": null,
      "noteHistory": null,
      "deviceName": "PC",
      "cancelAt": null,
      "cancelMemo": null,
      "advertisingGroupCode": null,
      "firstAdvertisingGroupCode": null,
      "asurakuFlag": "0",
      "taxCalcType": "明細単位",
      "totalNotax": "2301",
      "totalTax": "229",
      "delivFeeNotax": "637",
      "chargeNotax": "300",
      "orderCustomerRank": "0",
      "otherDiscount": null,
      "totalQuantity": "1",
      "giftFlag": "0",
      "noshiText": null,
      "noshiName": null,
      "mark1": "0",
      "mark2": "0",
      "mark3": "0",
      "printType1": "1",
      "printType5": "0",
      "printType2": "1",
      "printType3": "0",
      "printType3Name": null,
      "printType3Biko": null,
      "printType4": "0",
      "printType4Biko": null,
      "printType13": "0",
      "printType6": "1",
      "printDate1": "0",
      "printDate5": "0",
      "printDate2": "0",
      "printDate3": "0",
      "printDate4": "0",
      "printDate13": "0",
      "printDate6": "0",
      "printDate7": "0",
      "printDate8": "0",
      "printDate9": "0",
      "printDate10": "0",
      "printDate11": "0",
      "mailDate1": "0",
      "mailDate2": "0",
      "mailDate3": "0",
      "mailDate4": "0",
      "mailDate7": "0",
      "mailDate8": "0",
      "letterId": null,
      "letterName": null,
      "letterMessage": null,
      "printMessage": null,
      "mailMessage1": null,
      "mailMessage2": null,
      "mailMessage3": null,
      "mailMessage4": null,
      "mailMessage7": null,
      "mailMessage8": null,
      "jponOrderId": null,
      "exchangeUsePoint": "0",
      "paymentDiscountMemo": null,
      "paymentDiscount": null,
      "createAt": "2026-03-02T15:23:36+09:00",
      "couponSerialCode": null,
      "updateAt": "2026-04-01T09:45:10+09:00",
      "frontCodAmount": "0",
      "customerStatus": "仮会員",
      "friendCampaignCode": null,
      "bbcMemberGroupCode": null,
      "bbcMemberGroupName": null,
      "bbcMemberCode": null,
      "bbcCompanyName": null,
      "memberStaffId": null,
      "memberStaffName": null,
      "b2bMemberCode": null,
      "b2bCompanyName": null,
      "memberSalesChargeId": null,
      "memberSalesChargeName": null,
      "customerCharge": null,
      "customerChargeName": null,
      "customerChargeDeliv": null,
      "customerChargeDelivName": null,
      "senderCustomerFlg": "0",
      "senderEcOrderId": null,
      "orderTradeCode": null,
      "paymentInvoiceType": "0",
      "paymentTorihikiId": null,
      "paymentOrderAskId": "0",
      "paymentOrderAskName": "",
      "paymentOrderId": null,
      "paymentOrderBillId": null,
      "paymentOrderAskMemo": null,
      "combinedPaymentId": null,
      "combinedPaymentMethod": null,
      "combinedPaymentPrice": null,
      "customerPaymentAt": null,
      "returnAt": null,
      "ecCustomerId": null,
      "subtotalNotax": "1819",
      "estimateId": null
    },
    "shipping": {
      "shippingTradeCode": null,
      "shippingName01": "山田",
      "shippingName02": "太郎",
      "shippingKana01": "ヤマダ",
      "shippingKana02": "タロウ",
      "shippingCompanyName": null,
      "shippingCompanyDepartment": null,
      "shippingTel": "0312345678",
      "shippingFax": null,
      "shippingCountryId": null,
      "shippingZip": "100-0001",
      "shippingPref": "東京都",
      "shippingAddr01": "千代田区千代田1-1",
      "shippingAddr02": "テストビル101",
      "hassoDenpyoCode": null,
      "hassoEigyoFlg": "0",
      "hassoChakuFlg": "0",
      "hassoEigyoCode": null,
      "hassoMemo": null,
      "hassoKoguchi": "1",
      "shippingKeishoName": "様",
      "shippingAt": null,
      "shippingTime": null,
      "extraDelivfeeKbn": null,
      "shippingEmail": null,
      "oneDayOperationFlg": "0",
      "placementFlag": "1",
      "placementCode": "1",
      "socialGiftFlag": "0",
      "socialGiftInput": "0"
    },
    "orderGroup": {
      "groupOrderId": null,
      "groupSubtotal": null,
      "groupDiscount": null,
      "groupDelivFee": null,
      "groupCharge": null,
      "groupUsePoint": null,
      "groupCouponTotal": null,
      "groupPaymentTotal": null,
      "groupTax": null,
      "groupPaymentAmountTotal": null,
      "groupTaxCalcType": null,
      "groupTotalTax": null,
      "groupDelivFeeNotax": null,
      "groupChargeNotax": null
    },
    "orderDetail": [
      {
        "productNo": "1",
        "detailKbn": "商品",
        "orderProductCode": "PROD-001",
        "productCode": "PROD-001",
        "productName": "テスト商品A",
        "classcategoryName1": null,
        "classcategoryName2": null,
        "productOptionName": null,
        "productNoshiSelect": null,
        "productNoshiName": null,
        "productTaxFlag": "込",
        "taxRule": "2",
        "productPostageFlag": "別",
        "productDaibikiFlag": "別",
        "productPriceNotax": "1364",
        "productPrice": "1500",
        "productTax": "136",
        "taxRate": "10",
        "productQuantity": "1",
        "productTotal": "1500",
        "point": "0",
        "pointRate": "0",
        "pointRatePower": null,
        "weight": null,
        "productRegFlag": "商品",
        "orderJanCd": null,
        "orderLotNo": null,
        "basePrice02": null,
        "enclosuresFlag": "0",
        "b2bPrice04NotaxSaron": null,
        "b2bPrice04": null,
        "b2bPrice04Notax": null,
        "price01": null,
        "backorderFlag": "0",
        "orderDetailParts": [
          {
            "productSkuCode": "pf_api_test_product",
            "productSkuName": "PFAPIテスト商品",
            "productSkuName2": "プラットフォームAPIテスト商品",
            "quantity": "1",
            "stockReserveFlag": "1",
            "supplierId": "1",
            "shipmentQuantity": "1",
            "preInventoryQuantity": "0",
            "inventoryQuantity": "1",
            "commitQuantity": "0"
          }
        ]
      }
    ]
  }
]

Headers

Link

string

<前ページURI>; rel="prev", <次ページURI>; rel="next"

400

limitが範囲外の場合
pageが範囲外の場合

application/json

object

type

required

string

title

required

string

detail

One of:

string
Array<string>

string

status

integer

Examples

{
  "type": "about:blank",
  "title": "BadRequest",
  "detail": "limitは1〜800の範囲で入力してください",
  "status": 400
}

{
  "type": "about:blank",
  "title": "BadRequest",
  "detail": "pageは1以上で入力してください",
  "status": 400
}

500

サーバー内部エラー

application/json

object

type

required

string

title

required

string

detail

One of:

string
Array<string>

string

status

integer

Examples

default

{
  "type": "about:blank",
  "title": "InternalServerError",
  "status": 500
}