受注検索API
<目次>
概要
指定した受注情報の取得を行います。
処理件数
受注データを最大100件まで一覧で取得できます。
制限事項
- 「ポイントステータス」や「クーポン割引額」、「ショップメモ」「通信欄」など、受注ごと(1受注ずつ)に詳細データを取得するには、受注取得APIをご利用ください。
【参考】関連API
リリースノート(更新/更新予定)
最新の更新情報は表のとおりです。
更新履歴はAPI更新履歴一覧をご覧ください。
| 更新日/予定日 | 更新内容 | 更新理由 | ||
|---|---|---|---|---|
| 2025.08.28 | リクエストパラメータ | 「updateDateStart」「updateDateEnd」を追加 | 最終更新日時(from/to)をパラメータに指定し、指定期間中に更新されたデータだけを取得可能にするため | 参照 |
| 2025.08.28 | レスポンス | 「orderList」に「dateLastUpdated:更新日時」を追加 | 最終更新日時(from/to)をパラメータに指定し、指定期間中に更新されたデータだけを取得可能にするため | 参照 |
| 2025.08.28 | エラーコード | 「updateDateStart」「updateDateEnd」に関するエラーコードを追加 | 最終更新日時(from/to)をパラメータに指定し、指定期間中に更新されたデータだけを取得可能にするため | 参照 |
※日付が「予定日」のものは、更新内容が変わる可能性がございます。
APIの使用法
リクエストに関する制限
リクエストに関する制限については基本仕様をご覧ください。
認証
アクセストークンの取得については、認証APIをご覧ください。
アクセストークンを用いたAPI利用方法
認証(/oauth/token)以外のAPIでは認証キーとして、/oauth/tokenにて取得したワンタイムパスワードを用います。
エンドポイント
https://{APIドメイン}/admin-api/v1/shipping
HTTPメソッド
GET
リクエストヘッダー
アクセストークンを用います。
詳細は、アクセストークンによる認証を参照してください。
リクエストボディ
なし
リクエストパラメータ
| key | 項目名 | 必須 | 内容 | 備考 |
|---|---|---|---|---|
| orderDateStart | 受注日時(from) | 「yyyy-mm-ddThh:mm:ss」形式 | ||
| orderDateEnd | 受注日時(to) | 「yyyy-mm-ddThh:mm:ss」形式 | ||
| orderNo | 受注番号 | カンマ区切りで複数指定可能 | ||
| shippingStatus | 発送ステータス | notShipped:未発送 shipped:発送済 |
||
| paymentStatus | 入金ステータス | notReceived:未入金 received:入金済 |
||
| cancelDateStart | 受注キャンセル日時(from) | 「yyyy-mm-ddThh:mm:ss」形式 | ||
| cancelDateEnd | 受注キャンセル日時(to) | 「yyyy-mm-ddThh:mm:ss」形式 | ||
| updateDateStart | 最終更新日時(from) | 「yyyy-mm-ddThh:mm:ss」形式 | ・更新対象の項目や更新方法によっては、最終更新日時が更新されない場合がございます。連携開発に関わる場合は、お問い合わせください。 ・最終更新日時(from)から最終更新日時(to)で指定可能な最大日数は、31日までです。 |
|
| updateDateEnd | 最終更新日時(to) | 「yyyy-mm-ddThh:mm:ss」形式 | ・更新対象の項目や更新方法によっては、最終更新日時が更新されない場合がございます。連携開発に関わる場合は、お問い合わせください。 ・最終更新日時(from)から最終更新日時(to)で指定可能な最大日数は、31日までです。 |
|
| cancelRequestDateStart | 受注キャンセルリクエスト日時(from) | 「yyyy-mm-ddThh:mm:ss」形式 | ||
| cancelRequestDateEnd | 受注キャンセルリクエスト日時(to) | 「yyyy-mm-ddThh:mm:ss」形式 | ||
| cursor | カーソル | データの取得位置を指定可能 |
エラー発生時のHTTPコードとレスポンス
API呼び出し時に問題がある場合は、HTTPコード、またはレスポンスにエラー原因を返します。
詳しくは各API使用時におけるエラー発生時のHTTPコードとレスポンスをご覧ください。
レスポンス
※「必須(〇)」項目にデータがない場合は空欄が出力されます。
2024.01.24リリースの配送・送料(upgrade版)に伴い、一部項目が追加、また出力内容が変更となっています。
「KEY」名に(★)が付記されている項目が、変更・追加対象です。
なお、以下の受注(表中では(◆)と表記)に該当するか否かにより、出力内容が異なる項目がございますので、「内容」欄の注釈にご注意ください。
- 「配送・送料機能(upgrade版)」切替え(アップグレード完了)後の受注
- 「配送・送料機能(upgrade版)」切替え(アップグレード完了)後、配送関連のデータを修正した、アップグレード前の受注
- 2024.01.24以降futureshop新規発行店舗様の受注
| key | 項目名 | 必須 | 型 | byte | 内容 | ||||
|---|---|---|---|---|---|---|---|---|---|
| nextUrl | ネクストURL | String | - | 100件を超過する結果の場合、次のデータ取得のURLを返却(※) | |||||
| orderList | 受注リスト | ○ | Array | - | 受注ごとに配列出力。最大100件 | ||||
| orderNo | 受注コード | ○ | String | 12 | |||||
| type | 受注種別 | ○ | String | 12 | REGULAR:通常受注 SUBSCRIPTION:定期受注 HANPUKAI:頒布会受注 PREORDER:予約受注 |
||||
| date | 注文日時 | ○ | String | 19 | 「yyyy-mm-ddThh:mm:ss」形式 | ||||
| dateLastUpdated | 更新日時 | ○ | String | 19 | 「yyyy-mm-ddThh:mm:ss」形式 ※更新対象の項目や更新方法によっては、最終更新日時が更新されない場合がございます。連携開発に関わる場合は、お問い合わせください。 |
||||
| status | 処理状況区分 | ○ | String | 16 |
AWAITING_PAYMENT:通常処理 CANCELLED:注文取消 REFUNDED:返品 AWAITING_SHIPMENT:未回収 COMPLETED:処理済 ON_HOLD:保留 PREORDER:予約 |
||||
| cancelDate | キャンセル日時 | ○ | String | 19 | 「yyyy-mm-ddThh:mm:ss」形式 | ||||
| cancelRequestDate | キャンセルリクエスト日時 | ○ | String | 19 | 「yyyy-mm-ddThh:mm:ss」形式 | ||||
| cancelRequestRevoked | キャンセルリクエスト取消 | ○ | Boolean | - | true:キャンセルリクエスト取消 false: 上記以外 |
||||
| grandTotal | 請求合計金額 | ○ | Number | 9 | 総合計金額 - ポイント利用額 - 値引合計金額(商品)- 値引合計金額(送料) - 割引額 - バンドル販売割引金額 | ||||
| totalCost | 総合計金額 | ○ | Number | 9 | 値引き前の金額(商品合計金額 + 包装手数料 + 送料 + 決済手数料 + クール便手数料) | ||||
| productTotal | 商品合計金額 | ○ | Number | 9 | 税込み 商品本体 + オプション価格 |
||||
| taxTotal | 消費税合計 | ○ | Number | 9 | |||||
| discountTotal | 割引合計金額 | ○ | Number | 9 | 設定>割引>購入金額別割引設定/【CC未利用・移行中】構築>送料・決済設定>割引設定の割引金額 ポイント、クーポンやバンドル値引き額は含まれません。 |
||||
| giftWrappingChargeTotal | 包装手数料 | ○ | Number | 9 | |||||
| postage | 送料 | ○ | Number | 9 | |||||
| coolDeliveryChargeTotal | クール便手数料 | ○ | Number | 9 | |||||
| taxConfigEnabled | 消費税加算フラグ | ○ | Boolean | - | |||||
| taxRate | 消費税率 | ○ | Number | 2 | |||||
| taxRoundingType | 消費税端数計算区分 | ○ | String | 13 | ROUND_DOWN:切り捨て ROUND_HALF_UP:四捨五入 ROUND_UP:切り上げ |
||||
| standardTax | 標準税率 | ○ | Number | 2 | |||||
| reducedTax | 軽減税率 | ○ | Number | 2 | |||||
| usedPointPrice | ポイント利用額 | ○ | Number | 9 | |||||
| paymentType | 決済方法 | ○ | String | 17 |
BANK_TRANSFER:銀行振込 COD:代金引換 POSTAL_TRANSFER:郵便振込 FREGI_CONVENI:コンビニ支払(F-REGI) FREGI_CREDIT_CARD:クレジットカード(F-REGI) IN_STORE:店頭払い RAKUTEN_BANK:楽天銀行(リアルタイム自動引落) ORICO_WEB_CREDIT:オリコWebクレジット NONE:決済不要 NP_POSTPAY:NP後払い(CSV) AMAZON_PAY:Amazon Pay RAKUTEN_PAY:楽天ペイ(オンライン決済) APPLE_PAY:Apple Pay(F-REGI) CUSTOM1:任意決済 CUSTOM2:任意決済2 CUSTOM3:任意決済3 SBPS_CREDIT_CARD:クレジットカード(SBPS) PAYPAY:PayPay(SBPS) DOCOMO:d払い(SBPS) SOFTBANK:キャリア決済 ソフトバンクまとめて支払い(SBPS) AU:キャリア決済 au PAY(auかんたん決済)(SBPS) SBPS_CONVENI:コンビニ支払(SBPS) NP_POSTPAY_RTA:NP後払い(即時与信) PAIDY:あと払い(ペイディ) AU_PAY :au PAY(ネット支払い)(SBPS) RAKUTEN_PAY_V2:楽天ペイ(オンライン決済)V2(SBPS) MERPAY:メルペイ(SBPS) ------------------------------------------------------ ※2023.10.03廃止:MOBILE_EDY:MobileEdy(F-REGI)/CYBER_EDY:CyberEdy(F-REGI) |
||||
| paymentChargeTotal | 決済手数料合計金額 | ○ | Number | 9 | |||||
| receiptDate | 入金確認日 | ○ | String | 10 | 「yyyy-mm-dd」形式 | ||||
| receiptShopName | 支払い店舗 | ○ | String | 200 | 決済方法がIN_STORE:店頭払いの場合に出力 | ||||
| oricoProcedureDate | オリコ手続き日 | ○ | String | 10 | 「yyyy-mm-dd」形式 | ||||
| isMember | 会員フラグ | ○ | Boolean | - | true:会員 false:非会員 |
||||
| usingUpgradedPostage(★) | 配送・送料(upgrade版)使用フラグ | ○ | Boolean | - | true:配送・送料(upgrade版)を使用(切替え済み) false:配送・送料(upgrade版)を不使用 ------------------------------------------------------ |
||||
| buyerInfo | 購入者情報 | ○ | - | - | |||||
| memberId | 会員ID | ○ | String | 20 | ゲストの場合は空欄 | ||||
| lastName | 氏名(姓) | ○ | String | 200 | |||||
| firstName | 氏名(名) | ○ | String | 200 | |||||
| lastNameKana | フリガナ(姓) | ○ | String | 200 | |||||
| firstNameKana | フリガナ(姓) | ○ | String | 200 | |||||
| メールアドレス (メイン) | ○ | String | 200 | ||||||
| mobileMail | メールアドレス (モバイル) | ○ | String | 200 | |||||
| zipCode | 郵便番号 | ○ | String | 7 | 3桁 -(半角) 4桁 | ||||
| prefecture | 都道府県区分 | ○ | String | 9 | ※prefecture出力内容 | ||||
| address1 | 住所1 | ○ | String | 200 | |||||
| address2 | 住所2 | ○ | String | 200 | |||||
| address3 | 住所3 | ○ | String | 200 | |||||
| telNoMain | 電話番号(メイン) | ○ | String | 13 | |||||
| faxNo | FAX番号 | ○ | String | 13 | |||||
| gender | 性別区分 | ○ | String | 11 | UNSPECIFIED:指定なし MALE:男性 FEMALE:女性 |
||||
| birthday | 生年月日 | ○ | String | 8 | 「yyyymmdd」形式 | ||||
| companyName | 会社名 | ○ | String | 200 | |||||
| companyNameKana | 会社名(フリガナ) | ○ | String | 200 | |||||
| departmentName | 部署名 | ○ | String | 200 | |||||
| departmentNameKana | 部署名(フリガナ) | ○ | String | 200 | |||||
| companyTelNo | 電話番号(会社) | ○ | String | 13 | |||||
| companyFaxNo | FAX番号(会社) | ○ | String | 13 | |||||
| shipmentList | お届け先情報 | ○ | Array | - | お届け先ごとに配列出力 | ||||
| shipmentNo | お届け先No | ○ | Number | 3 | |||||
| addressInfo(★) | 住所情報 | ○ | - | - |
「STORE_PICKUP(店舗受取)」の場合、注文時の購入者情報(お客様情報)が出力されます。
------------------------------------------------------ 「STORE_PICKUP(店舗受取)」の判定先は以下になります。 ・(◆)に該当する受注については、「配送種別区分(code)」 ・(◆)に該当しない受注については、「配送サービス区分(deliveryService)」 |
||||
| lastName | お届け先氏名(姓) | ○ | String | 200 | |||||
| firstName | お届け先氏名(名) | ○ | String | 200 | |||||
| lastNameKana | お届け先フリガナ(姓) | ○ | String | 200 | |||||
| firstNameKana | お届け先フリガナ(名) | ○ | String | 200 | |||||
| postalCode | お届け先郵便番号 | ○ | String | 7 | 3桁 -(半角) 4桁 | ||||
| prefecture | お届け先都道府県区分 | ○ | String | 9 | ※prefecture出力内容 | ||||
| address1 | お届け先住所1 | ○ | String | 200 | |||||
| address2 | お届け先住所2 | ○ | String | 200 | |||||
| address3 | お届け先住所3 | ○ | String | 200 | |||||
| phoneNo | お届け先電話番号 | ○ | String | 13 | |||||
| shippingInfo(★) | 配送情報 | ○ | - | - |
一部項目は、配送・送料(upgrade版)ご利用状況により出力が異なります。 |
||||
| deliveryService(★) | 配送サービス区分 | ○ | String | 25 | COURIER:宅配便 KURONEKO_MAIL_BIN:クロネコメール便 KURONEKO_MAIL_BIN_EXPRESS:クロネコメール便速達サービス(廃止済) HIKYAKU_MAIL_EXPRESS:飛脚メール便 MAIL_1:メール便サービス1 MAIL_2:メール便サービス2 MAIL_3:メール便サービス3 NEKOPOS:ネコポス STORE_PICKUP:店舗受取 ------------------------------------------------------ (◆)に該当する受注は「空文字」 |
||||
| deliveryServiceName(★) | 配送サービス名 | ○ | String | 100 |
(◆)に該当する受注は「空文字」 |
||||
| isCoolDelivery(★) | クール便使用フラグ | ○ | Boolean | - |
(◆)に該当する受注は「false」 |
||||
| deliveryServiceInfo(★) | 配送サービス情報 | 〇 | - | - |
本項目内の項目は、(◆)に該当する受注の場合のみ、出力されます。 |
||||
| name(★) | 配送サービス名 | 〇 | String | 50 | 宅配便設定-表示設定メール便設定-表示設定店舗受取設定-表示設定にて設定した名称を出力
------------------------------------------------------ (◆)に該当しない受注は「空文字」 |
||||
| code(★) | 配送種別区分 | 〇 | String | 12 | COURIER:宅配便 MAIL:メール便 STORE_PICKUP:店舗受取 ------------------------------------------------------ (◆)に該当しない受注は「空文字」 |
||||
| companyCode(★) | 運送会社区分 | 〇 | String | 14 | YAMATO_UNYU:ヤマト運輸 SAGAWA_KYUBIN:佐川急便 NIHON_YUBIN:日本郵便 SEINO_UNYU:西濃運輸 FUKUYAMA_TSUUN:福山通運 OTHER:その他 空文字:「メール便」「店舗受取」で受注した場合 ------------------------------------------------------ (◆)に該当しない受注は「空文字」 |
||||
| isCoolDelivery(★) | クール便使用フラグ | 〇 | Boolean | - | true:クール便商品あり false:クール便商品なし ------------------------------------------------------ (◆)に該当しない受注は「false」 |
||||
| isRoomTemperatureDelivery(★) | 常温便使用フラグ | 〇 | Boolean | - | true:常温便商品あり false:常温便商品なし ------------------------------------------------------ (◆)に該当しない受注は「false」 |
||||
| specialArea(★) | 離島など一部地域フラグ | 〇 | Boolean | - | true:「離島など一部地域」で設定された地域に該当する場合 false:「離島など一部地域」で設定された地域 に該当しない場合 ------------------------------------------------------ (◆)に該当しない受注は「false」 |
||||
| postageBoxCount(★) | 個口数 | 〇 | String | 6 | 個口数を出力
------------------------------------------------------ |
||||
| coolDeliveryBoxCount(★) | クール便個口数 | 〇 | String | 6 | 個口数のうち、クール便(冷蔵・冷凍)で配送する(手数料が適用される)個口数を出力
------------------------------------------------------ (◆)に該当しない、または、該当するが2025.03.18より前の受注(管理画面で未修整)である場合は「空白」 |
||||
| invoiceNo | 送り状番号 | ○ | String | 100 | |||||
| expectedArrival | 到着予定日 | ○ | String | 10 | 「yyyy-mm-dd」形式 | ||||
| preferredDeliveryDate | お届け希望日 | ○ | String | 10 | 「yyyy-mm-dd」形式 | ||||
| preferredDeliveryTime | お届け希望時間 | ○ | String | 50 | 「お届け希望時間帯設定」の設定内容を出力
------------------------------------------------------ (◆)に該当しない受注は「お届け希望時間帯設定」の設定内容 |
||||
| shippingDate | 発送処理日 | ○ | String | 10 | 「yyyy-mm-dd」形式 | ||||
| productTotal | お届け先別商品合計 | ○ | Number | 9 | 税込み オプション価格を含む |
||||
| taxTotal | お届け先別消費税 | ○ | Number | 9 | |||||
| postage | お届け先別基本送料 | ○ | Number | 9 | |||||
| coolDeliveryCharge | お届け先別 クール便手数料 | ○ | Number | 9 | |||||
| giftWrappingCharge | お届け先別包装手数料 | ○ | Number | 9 | |||||
| paymentCharge | お届け先別決済手数料 | ○ | Number | 9 | |||||
| storeCode | 店舗コード | ◯ | String | 10 | |||||
| storeName | 店舗名 | ◯ | String | 200 | 「店舗名(正式名称)」 「店舗名(正式名称)」空欄時は「店舗名」を出力 |
||||
| storeZipCode | 店舗郵便番号 | ◯ | String | 8 | |||||
| storePrefecture | 店舗都道府県区分 | ◯ | String | 9 | ※prefecture出力内容 | ||||
| storeAddress1 | 店舗住所1 | ◯ | String | 200 | |||||
| storeAddress2 | 店舗住所2 | ◯ | String | 200 | |||||
| storeAddress3 | 店舗住所3 | ◯ | String | 200 | |||||
| storePhoneNo | 店舗電話番号 | ◯ | String | 13 | |||||
| productList | 購入商品リスト | ○ | Array | - | |||||
| skuNo | 商品番号(sku番号) | ○ | String | 50 | バリエーションの場合:商品番号+枝番(横軸)+枝番(縦軸) | ||||
| name | 商品名 | ○ | String | 300 | |||||
| hanpukaiName | 頒布会商品名 | ○ | String | 100 | |||||
| verticalVariationName | バリエーション名(縦) | ○ | String | 100 | |||||
| horizontalVariationName | バリエーション名(横) | ○ | String | 100 | |||||
| janCode | JANコード | ○ | String | 30 | |||||
| taxRateCode | 消費税率区分(商品) | ○ | String | 8 | STANDARD:標準税率 REDUCED:軽減税率 |
||||
| price | 販売単価 | ○ | Number | 9 | (税込み設定にかかわらず)税込み | ||||
| count | 購入数量 | ○ | Number | 4 | |||||
| taxIncluded | 消費税種類 | ○ | String | 12 | TAX_INCLUDED:税込 TAX_EXCLUDED:税別 ------------------------------------------------------ 商品登録-商品価格「下記すべて税込価格を設定する」 のチェックの有無(ON:TAX_INCLUDED/OFF:TAX_EXCLUDED) |
||||
| tax | 消費税 | ○ | Number | 9 | |||||
| shippingDate | 出荷開始予定日 | ○ | String | 10 | 「yyyy-mm-dd」形式 | ||||
| excludedStorePickup | 店舗受取対象外フラグ | ○ | Boolean | - | true:対象外 false:対象 |
||||
| orderCancelDisabled | キャンセル不可フラグ | ○ | Boolean | - | true:キャンセル不可 false:キャンセル可 |
||||
| temperatureRangeType(★) | 温度帯区分 | ○ | String | 25 | 空文字:「メール便」「店舗受取」 ROOM_TEMPERATURE_DELIVERY:「常温便」 CHILLED_DELIVERY:「クール便(冷蔵)」 FROZEN_DELIVERY:「クール便(冷凍)」 ------------------------------------------------------ |
||||
| weight(★) | 梱包重量 | ○ | String | 6 | |||||
| packingGroupName(★) | 同梱可能グループ | ○ | String | 510 | |||||
| optionList | 項目選択肢 | ○ | Array | - | 項目選択肢ごとに配列出力 | ||||
| name | 項目選択肢名 | String | 100 | ||||||
| selectionItem | 選択項目 | String | 100 | ||||||
| optionPriceList | オプション価格 | ○ | Array | - | オプション価格ごとに配列出力 | ||||
| name | 項目名 | String | 100 | ||||||
| selectionName | 選択肢名 | String | 100 | ||||||
| selectionCode | 選択肢コード | String | 50 | ||||||
| price | 価格 | String | 9 | 税込み | |||||
| tax | 消費税 | String | 9 | ||||||
| taxRateCode | 消費税率区分 | String | 8 | STANDARD:標準税率 REDUCED:軽減税率 |
|||||
nextUrlに関する補足
「/v1/shipping」の後に次のデータを取得するためのパラメータが付与されたURLが返却されます。
(例)「/admin-api/v1/shipping?orderDateStart=2019-10-11T00:00:00&cursor=121」
URLに替えて、nextUrlをGETしていただければ、次の100件のデータを取得できます。
prefecture出力内容
| 出力 | 出力 | 出力 | 出力 | ||||
|---|---|---|---|---|---|---|---|
| HOKKAIDO | 北海道 | AOMORI | 青森県 | AKITA | 秋田県 | IWATE | 岩手県 |
| MIYAGI | 宮城県 | YAMAGATA | 山形県 | FUKUSHIMA | 福島県 | IBARAKI | 茨城県 |
| TOCHIGI | 栃木県 | GUNMA | 群馬県 | SAITAMA | 埼玉県 | CHIBA | 千葉県 |
| KANAGAWA | 神奈川県 | TOKYO | 東京都 | YAMANASHI | 山梨県 | NIIGATA | 新潟県 |
| NAGANO | 長野県 | SHIZUOKA | 静岡県 | AICHI | 愛知県 | MIE | 三重県 |
| GIFU | 岐阜県 | TOYAMA | 富山県 | ISHIKAWA | 石川県 | FUKUI | 福井県 |
| OSAKA | 大阪府 | KYOTO | 京都府 | SHIGA | 滋賀県 | NARA | 奈良県 |
| WAKAYAMA | 和歌山県 | HYOGO | 兵庫県 | OKAYAMA | 岡山県 | HIROSHIMA | 広島県 |
| YAMAGUCHI | 山口県 | TOTTORI | 鳥取県 | SHIMANE | 島根県 | KAGAWA | 香川県 |
| TOKUSHIMA | 徳島県 | EHIME | 愛媛県 | KOCHI | 高知県 | FUKUOKA | 福岡県 |
| SAGA | 佐賀県 | NAGASAKI | 長崎県 | KUMAMOTO | 熊本県 | OITA | 大分県 |
| MIYAZAKI | 宮崎県 | KAGOSHIMA | 鹿児島県 | OKINAWA | 沖縄県 | OTHER | その他 |
エラーレスポンス
エラー発生時に以下のレスポンスが返却されます。
| key | 項目名 | 必須 | 型 | byte | 内容 | |
|---|---|---|---|---|---|---|
| status | ステータス | ○ | String | - | ||
| errors | エラーリスト | ○ | Array | - | エラー時のみ出力 | |
| code | コード | ○ | String | - | ||
| path | パス | ○ | String | - | エラーが発生したパラメータ名が出力されます | |
| message | メッセージ | ○ | String | - | ||
エラーコード
| No | code | path | message | 項目名 | チェック内容 | HTTPコード |
|---|---|---|---|---|---|---|
| 1 | InvalidDateFormat | orderDateStart | orderDateStartの日付フォーマットを正しく指定してください | 受注日時(from) | 「yyyy-mm-ddThh:mm:ss」形式ではない場合に返却されます。 | 422 |
| 2 | InvalidDateRange | orderDateStart | orderDateStartはorderDateEndより前の日時を指定してください | 受注日時(from) | 受注日時の開始日時が終了日時よりも未来日付の場合に返却されます。 | 422 |
| 3 | InvalidDateFormat | orderDateEnd | orderDateEndの日付フォーマットを正しく指定してください | 受注日時(to) | 「yyyy-mm-ddThh:mm:ss」形式ではない場合に返却されます。フォーマットチェック | 422 |
| 4 | TooMany | orderNo | orderNoの指定は100件までです | 受注番号 | 受注コードの指定が100件を超過した場合に返却されます。 | 422 |
| 5 | TooLong | orderNo | orderNoは12文字以内で指定してください | 受注番号 | 1受注の受注コードが12文字を超過した場合に返却されます。 | 422 |
| 6 | InvalidValue | orderNo | orderNoの指定が不正です | 受注番号 | 数値以外を指定した場合に返却されます。 | 422 |
| 7 | InvalidValue | shippingStatus | shippingStatusの指定が不正です | 発送ステータス | notShipped,shipped以外を指定した場合に返却されます。 | 422 |
| 8 | InvalidValue | paymentStatus | paymentStatusの指定が不正です | 入金ステータス | notReceived,received以外を指定した場合に返却されます。 | 422 |
| 9 | InvalidDateFormat | cancelDateStart | cancelDateStartの日付フォーマットを正しく指定してください | キャンセル日時(from) | 「yyyy-mm-ddThh:mm:ss」形式ではない場合、返却されます。 | 422 |
| 10 | InvalidDateRange | cancelDateStart | cancelDateStartはcancelDateEndより前の日時を指定してください | キャンセル日時(from) | 受注キャンセル日時の開始日時が終了日時よりも未来日付の場合に返却されます。 | 422 |
| 11 | InvalidDateFormat | cancelDateEnd | cancelDateEndの日付フォーマットを正しく指定してください | キャンセル日時(to) | 「yyyy-mm-ddThh:mm:ss」形式ではない場合、返却されます。 | 422 |
| 12 | InvalidDateFormat | cancelRequestDateStart | cancelRequestDateStartの日付フォーマットを正しく指定してください | キャンセルリクエスト日時(from) | 「yyyy-mm-ddThh:mm:ss」形式ではない場合、返却されます。 | 422 |
| 13 | InvalidDateRange | cancelRequestDateStart | cancelRequestDateStartはcancelRequestDateEndより前の日時を指定してください | キャンセルリクエスト日時(from) | 受注キャンセルリクエスト日時の開始日時が終了日時よりも未来日付の場合に返却されます。 | 422 |
| 14 | InvalidDateFormat | cancelRequestDateEnd | cancelRequestDateEndの日付フォーマットを正しく指定してください | キャンセルリクエスト日時(to) | 「yyyy-mm-ddThh:mm:ss」形式ではない場合、返却されます。 | 422 |
| 15 | InvalidDateFormat | updateDateStart | updateDateStartの日付フォーマットを正しく指定してください | 最終更新日時(from) | 「yyyy-mm-ddThh:mm:ss」形式ではない場合、返却されます。 | 422 |
| 16 | InvalidDateFormat | updateDateEnd | updateDateEndの日付フォーマットを正しく指定してください | 最終更新日時(to) | 「yyyy-mm-ddThh:mm:ss」形式ではない場合、返却されます。 | 422 |
| 17 | Required | updateDateStart | updateDateStartを指定してください | 最終更新日時(from) | 最終更新日時(from)が未指定の場合、返却されます。 | 422 |
| 18 | Required | updateDateEnd | updateDateEndを指定してください | 最終更新日時(to) | 最終更新日時(to)が未指定の場合、返却されます。 | 422 |
| 19 | InvalidDateRange | updateDateStart | updateDateStartはupdateDateEndより前の日時を指定してください | 最終更新日時(from) | 最終更新日時(from)が最終更新日時(to)より未来日付の場合に返却されます。 | 422 |
| 20 | DateRangeExceeded | updateDateStart | updateDateEndはupdateDateStartから31日以内の日時を指定してください | 最終更新日時(from) | 最終更新日時(from)から最終更新日時(to)で指定された日数が、31日を超えていた場合に返却されます。 | 422 |
| 21 | InvalidValue | cursor | cursorの指定が不正です | カーソル | パラメータが適切に設定されていない場合、返却されます。 | 422 |