注文検索API
注文情報を検索し、該当する複数注文情報を取得する機能を提供します。
変更履歴
2024年9月27日
ソーシャルギフト機能に関連する下記「取得情報(Field)」の内容を修正しました。
BillFirstName 、BillFirstNameKana
2024年9月13日
ParentOrderId:分割元注文ID、IsSplit:分割フラグ に注文分割対象の場合の説明を追記しました。
2024年7月31日
検索条件(Condition) 及び 取得情報(Field)のEazyDeliveryCode(EAZYコード)について型の記載を訂正しました。(0-8 → 0-7)
2024年04月17日
取得情報(Field)「PayMethodName」の内容の文言を修正しました。
-----
支払い方法がpayment_a17、payment_a19の場合、2024/5/13(月)リリース後の注文に関して名称が変更されますが、リリース前の注文に関しては変更されませんのでご注意ください。
<現在>
PayPay(残高)
PayPay(クレジット)※旧あと払い
<修正後>
PayPay残高等
PayPayクレジット
-----
2024年3月27日
ソーシャルギフト機能に関連する下記「取得情報(Field)」の内容を修正(追記)しました。
BillFirstName、BillFirstNameKana、BillLastName、BillLastNameKana、BillPrefecture
2023年11月10日
ExcellentDelivery(優良配送フラグ)の説明に「2:翌日優良配送」を追加しました。
2023年11月6日
検索条件(Condition)に下記項目を追加しました。
・SocialGiftType(ソーシャルギフトタイプ)
取得情報(Field)に下記項目を追加しました。
・SocialGiftType(ソーシャルギフトタイプ)
2023年10月30日
サービス名称変更に伴い下記文言を修正しました。
ヤフオク!、ヤフオク → Yahoo!オークション
2023年08月31日
取得情報(Field)に下記項目を追加しました。
・YourTimesaleDiscount(あなただけのタイムセール値引価格)
2023年07月24日
取得情報(Field)「PayMethodName」の内容に下記文言を追記しました。
-----
支払い方法がpayment_a17、payment_a19の場合、2023/8/1(火)リリース後の注文に関して名称が変更されますが、リリース前の注文に関しては変更されませんのでご注意ください。
<変更前>
PayPay残高払い
PayPayあと払い
<修正後>
PayPay(残高)
PayPay(クレジット)※旧あと払い
-----
2023年07月12日
「PayMethod(支払い方法)」の説明を修正しました。
<修正前>
payment_a17:PayPay残高払い
payment_a19:PayPayあと払い
<修正後>
payment_a17:PayPay(残高)
payment_a19:PayPay(クレジット)※旧あと払い
2023年06月22日
検索条件(Condition)の下記項目で補足参照を「※6」から「※2」に修正いたしました。
・PayMethodChangeDeadlineFrom(支払い方法変更期限(From))
・PayMethodChangeDeadlineTo(支払い方法変更期限(To))
2023年06月20日
検索条件(Condition)の「IsPayMethodChangePossible(支払い方法変更可能フラグ)」にて説明を追記
・※「false:支払い方法変更不可」を指定した検索はできません。
2023年04月26日
検索条件に下記項目を追加しました。
・OverlapOrderResult(二重注文判定結果)
2023年04月24日
検索条件(Condition)に下記内容を追加しました。
・PayMethodChangeDeadlineFrom(支払い方法変更期限(From))
・PayMethodChangeDeadlineTo(支払い方法変更期限(To))
・IsPayMethodChangePossible(支払い方法変更可能フラグ)
取得情報(Field)に下記項目を追加しました。
・PayMethodChangeDeadline(支払い方法変更期限)
・IsPayMethodChangePossible(支払い方法変更可能フラグ)
2023年03月09日
取得情報(Field)に下記項目を追加しました。
・TotalImmediateBonusAmount(特典の一部利用合計額)
・TotalImmediateBonusRatio(特典の一部利用合計割合)
2023年02月15日
表記の一部を変更しました。
前)Yahoo!ショッピング ギフト券
後)Yahoo!ショッピング 商品券
2023年01月26日
取得可能項目「SubscriptionId(定期購入親ID)」に、初回定期購入で参照する際の補足を追記いたしました。
2023年01月17日
下記検索条件項目の「内容」を追記しました。
・YahooAuctionID
・YahooAuctionMerchantId
2022年10月17日
検索条件( Condition)に下記内容を追加しました。
・LineGiftDisplayType(LINEギフト表示種別)
・LineGiftShippableType(LINEギフト出荷可能種別)
・ShippingDeadlineFrom(LINEギフト発送期限(From))
・ShippingDeadlineTo(LINEギフト発送期限(To))
取得情報(Field)に下記内容を追加しました。
・LineGiftOrderId(LINEギフト注文ID)
・IsLineGiftOrder(LINEギフト注文)
・IsLineGiftShippable(LINEギフト出荷可能フラグ)
・ShippingDeadline(LINEギフト発送期限)
・LineGiftCharge(LINEギフト手数料)
2022年10月14日
取得可能項目「UsePoint(利用ポイント数)」の日本語項目名を「利用ポイント合計」に修正いたしました。
2022年10月11日
「取得情報(Field)」に下記内容を追加しました。
・IsSubscription(定期購入フラグ)
・SubscriptionId(定期購入親ID)
・SubscriptionContinueCount(定期購入継続回数)
2022年10月04日
「取得情報(Field)」に下記内容を追加しました。
・GoodStoreStatus(優良店判定)
・CurrentGoodStoreBenefitApply(注文時点の優良店特典適応状態)
・CurrentPromoPkgApply(注文時点のプラン適応状況)
2022年09月09日
「検索条件( Condition)」に下記内容を追加しました。
・YahooAuctionBundleType
・ItemYahooAucId
・ItemYahooAucMerchantId
「取得情報(Field)」に下記内容を追加しました。
・YahooAuctionBundleType
・ItemYahooAucId
・ItemYahooAucMerchantId
2022年06月27日
取得情報に下記項目を追加しました。
・GiftCardDiscount(ギフト券利用額)
取得情報の内容を修正しました。
・TotalPrice(合計金額)
前)小計 - 利用ポイント + ギフト包装料 + 手数料 - 値引き + 送料 + 調整額
後)小計 - 利用ポイント + ギフト包装料 + 手数料 - 値引き + 送料 + 調整額 - モールクーポン値引き額- 特典の一部利用額 - 商品券利用額
・UsePoint(利用ポイント数)
前)(空)
後)特典の一部利用もしくはギフト券を利用した注文の場合は、その利用額がそれぞれ加算されます。
2022年02月17日
PayMethodに「payment_a19:PayPayあと払い」を追加しました。
追加予定日:2022年02月28日(月)
2022年02月14日
「検索条件( Condition)」と「取得情報(Field)」から下記項目を削除しました。
・YahooAuctionRatingStatus(Yahoo!オークション評価の完了/未完了)
利用申請について
本番環境について
注文APIを利用する場合は別途利用申請が必要です。下記フォームから申請をお願いします。
ショッピング注文API利用申請フォーム
テスト環境について
テスト用APIを利用する場合は、下記フォームから「テスト環境用」を指定して申請をお願いします。
新しいアプリケーションを開発
※テスト環境に関しては別途注文APIの利用申請をしていただく必要はありません。
リクエストURL
リクエストパラメータ
「Web APIの使い方#POSTとは」をご参照ください。
パラメータ | 型 | 説明 |
---|---|---|
/Req | リクエストパラメータ | |
/Req/Search | 検索条件指定情報 | |
/Req/Search/Result (デフォルト : 10) |
integer | 最大取得件数(上限値:2000) |
/Req/Search/Start (デフォルト : 1) |
integer | 取得開始件数 |
/Req/Search/Sort | string | ・注文時間で昇順ソート:+order_time(デフォルト) ・注文時間で降順ソート:-order_time |
/Req/Search/Condition | 検索条件 | |
/Req/Search/Condition/ (検索条件キー) |
検索条件 | |
/Req/Search/Field (必須) |
string | 取得情報 レスポンスに含めるfiledをカンマ区切りにします。 |
/Req/SellerId (必須) |
string | ストアアカウント |
※検索条件(Condition)に指定可能な条件、取得情報(Field)に指定可能なキー名、及び、その他リクエストパラメータの詳細は、以下を参照してください。
- 検索条件( Condition) :
キー名 | 型 | 最大長 | 項目 | 内容 |
---|---|---|---|---|
OrderId (必須※1) |
(^[a-zA-Z0-9-]+$) | 50byte(最大) | 注文ID | 注文ID |
DeviceType (※3) |
1 : PC 2 : ガラケー 3 : スマートフォン 4 : タブレット |
1byte固定 | デバイス情報 | 1=PC,2=ガラケー,・・スマフォ,アプリ 等、固定はどのカートから入ってきたかで定義します。 |
IsActive | false : 無効注文 true : 有効注文 |
5byte(最大) | 注文有効フラグ | 有効な注文として扱うか判定するフラグです。 フラグが立っていなければ表示もされません。 |
IsSeen(※4) | false : 未閲覧 true : 閲覧済 |
5byte(最大) | 閲覧済みフラグ | |
IsSplit | false : 未分割 true : 分割済 |
5byte(最大) | 分割フラグ | |
IsRoyalty | false : 課金対象外 true : 課金対象 |
5byte(最大) | 課金フラグ | 課金対象かどうかを判定します。例えばテスト注文の場合はfalseを指定します。 |
IsRoyaltyFix | false : 課金未確定 true : 課金確定済 |
5byte(最大) | 課金確定フラグ(旧 : 課金確定フラグ) | 課金が確定しているかどうかの判定です。 |
IsAffiliate | false : 非アフィリエイト経由注文 true : アフィリエイト経由注文 |
5byte(最大) | アフィリエイトフラグ | アフィリエイト経由の注文かどうかの判定です。 |
OrderTime (必須※1,※2) |
(YYYYMMDDHH24MISS) | 14byte(固定) | 注文日時 | 注文確定ボタン押下した日時です。 |
OrderTimeFrom (必須※2) |
(YYYYMMDDHH24MISS) | 14byte(固定) | 注文日時(From) | 注文日時のレンジ検索時に指定します。 |
OrderTimeTo (必須※2) |
(YYYYMMDDHH24MISS) | 14byte(固定) | 注文日時(To) | 注文日時のレンジ検索時に指定します。 |
FraudHoldDisplayType | 0 : 注文保留の注文を表示しない 1 : 注文保留の注文を含む全注文を表示 |
1byte | 不正注文フラグ | 不正保留となった注文を含めるかを判定するフラグです。 |
PublicationTimeFrom (必須※2) |
(YYYYMMDDHH24MISS) | 14byte(固定) | 公開日時(From) | 公開日時のレンジ検索時に指定します。 |
PublicationTimeTo (必須※2) |
(YYYYMMDDHH24MISS) | 14byte(固定) | 公開日時(To) | 公開日時のレンジ検索時に指定します。 |
ReleaseDateFrom | (YYYYMMDD) | 8byte(固定) | 発売日(From) | 発売日の期間開始日。特定の日付のみ指定する場合は期間終了日と同じ日を指定します。 期間開始日のみ指定時は指定日以降全てが対象となります。 |
ReleaseDateTo | (YYYYMMDD) | 8byte(固定) | 発売日(To) | 発売日の期間終了日。特定の日付のみ指定する場合は開始日と同じ日を指定します。 期間終了日のみ指定時は指定日以前全てが対象となります。 |
Suspect (※3) |
0 : 非悪戯注文 1 : 悪戯注文 2 : 悪戯解除済注文 |
1byte(固定) | 悪戯フラグ | いたずら対象、非対象、解除済みを判定するフラグです。 |
OrderStatus (※3,※4) |
1 : 予約中 2 : 処理中 3 : 保留 4 : キャンセル 5 : 完了 |
1byte(固定) | 注文ステータス | 注文情報の状態を表すステータスです。 新規注文は注文ステータス「処理中」かつ閲覧済みフラグ「false」で表現されます。 新規予約は注文ステータス「予約中」かつ閲覧済みフラグ「false」で表現されます。 |
StoreStatus | 数値 | 2byte(最大) | ストアステータス | ストアが独自に設定可能なステータスです。 (ステータス名はストアクリエイターProで管理します。) |
PrintSlipFlag | false : 注文伝票未出力 true : 注文伝票出力済み |
5byte(最大) | 注文伝票出力有無 | 注文伝票出力有無 |
PrintDeliveryFlag | false : 納品書未出力 true : 納品書出力済み |
5byte(最大) | 納品書出力有無 | 納品書出力有無 |
PrintBillFlag | false : 請求書未出力 true : 請求書出力済み |
5byte(最大) | 請求書出力有無 | 請求書出力有無 |
BuyerCommentsFlag | false : バイヤーコメントなし true : バイヤーコメントあり |
5byte(最大) | バイヤーコメント有無 | ご要望欄入力がされている/されていないを表すフラグです。 |
PayStatus | 0 : 未入金 1 : 入金済 |
1byte(固定) | 入金ステータス | 受注、支払時に支払方法毎に注文PFで設定です。 入金待ち 入金済み |
SettleStatus (※3) |
1 : 決済申込 2 : 支払待ち 3 : 支払完了 4 : 入金待ち 5 : 決済完了 6 : キャンセル 7 : 返金 8 : 有効期限切れ 9 : 決済申込中 10 : オーソリエラー 11 : 売上取消 12 : Suicaアドレスエラー |
2byte(最大) | 決済ステータス | 1 : 決済申込 2 : 支払待ち 3 : 支払完了 4 : 入金待ち 5 : 決済完了 6 : キャンセル 7 : 返金 8 : 有効期限切れ 9 : 決済申込中 10 : オーソリエラー 11 : 売上取消 12 : Suicaアドレスエラー |
PayType (※3) |
0 : 後払い 1 : 前払い |
1byte(固定) | 支払い分類 | 支払方法分類 前払い、後払いを判定します。 |
PayMethod | (文字列) payment_決済ID |
11byte(最大) | 支払い方法 | お支払方法番号 payment_a1:クレジットカード決済 payment_a6:コンビニ決済(セブンイレブン) payment_a7:コンビニ決済(その他) payment_a8:モバイルSuica決済 payment_a9:d払い payment_a10:auかんたん決済 payment_a11:ソフトバンクまとめて支払い payment_a15:ペイジー payment_a16:Yahoo!マネー/預金払い payment_a17:PayPay(残高) payment_a19:PayPay(クレジット)※旧あと払い payment_b[1-6]:銀行振込(名称はストアの自由設定) payment_c1:ゆうちょ銀行(前払い) payment_c2:ゆうちょ銀行(後払い) payment_c3:現金書留 payment_d1:商品代引 payment_e[1-15]:ストアの自由なお支払い方法名 payment_z1:ポイント全額払い |
NeedBillSlip | キーなし : カートに設定なし false : 請求書不要 true : 請求書必要 |
5byte(最大) | 請求書有無 | 請求書有無 |
NeedDetailedSlip | キーなし : カートに設定なし false : 明細書不要 true : 明細書必要 |
5byte(最大) | 明細書有無 | 明細書有無 伝票画面上では、「納品書」表記です。 帳票出力でも「納品書」出力で、「明細書」が出力可能です。 |
NeedReceipt | キーなし : カートに設定なし false : 領収書不要 true : 領収書必要 |
5byte(最大) | 領収書有無 | 領収書有無 |
BillFirstName | (文字列) | 297byte(最大) | ご請求先名前 | ご請求先名前 |
BillFirstNameKana | (文字列) | 297byte(最大) | ご請求先名前カナ | ご請求先名前(フリガナ) |
BillLastName | (文字列) | 297byte(最大) | ご請求先名字 | ご請求先名字 |
BillLastNameKana | (文字列) | 297byte(最大) | ご請求先名字カナ | ご請求先名字(フリガナ) |
BillZipCode | (文字列) | 10byte(最大) | ご請求先郵便番号 | ご請求先郵便番号 |
BillPrefecture | (文字列) | 12byte(最大) | ご請求先都道府県 | ご請求先都道府県 海外の場合「その他」が入ります。 |
BillPhoneNumber | (文字列) | 14byte(最大) | ご請求先電話番号 | ご請求先電話番号 |
BillMailAddress | (文字列) | 99文字(最大) | ご請求先メールアドレス | バイヤーの入力したメールアドレスです。Wallet利用の場合でかつ追加メールアドレス欄に入力がある場合は追加メールアドレスを入れます。 |
ShipStatus (必須※3) |
0 : 出荷不可 1 : 出荷可 2 : 出荷処理中 3 : 出荷済み 4 : 着荷済み |
1byte(固定) | 出荷ステータス | 支払方法によって「出荷不可」か「出荷可」とします。注文受付時に判定します。カートからの値はNullです。 |
ShipMethod | (文字列) postageN |
9byte(最大) | 配送方法 | お届け方法番号:postage1-14,16のどれか1つ(postage15は欠番) ストアクリエイターProの配送設定順。 |
ShipRequestDateFrom | (YYYYMMDD) | 8byte(固定) | 配送希望日(From) | 配送希望日の期間開始日。特定の日付のみ指定する場合は期間終了日と同じ日を指定します。 期間開始日のみ指定時は指定日以降全てが対象となります。 |
ShipRequestDateTo | (YYYYMMDD) | 8byte(固定) | 配送希望日(To) | 配送希望日の期間終了日。特定の日付のみ指定する場合は開始日と同じ日を指定します。 期間終了日のみ指定時は指定日以前全てが対象となります。 |
ShipRequestDateNo | 0 : 配送希望日無しを含みます。 1 : 配送希望日無しを含みません。 2 : 配送希望無しのみ |
1byte(固定) | 配送希望日無し | 配送希望日無しの条件を指定します。 |
ShipCompanyCode | (数値) | 4byte(最大) | 配送会社 | 配送会社コード 1000:その他 1001:ヤマト運輸 1002:佐川急便 1003:日本郵便 1004:西濃運輸 5001:店頭受け取り (一覧はこちら) |
ReceiveShopCode | (文字列) | 50byte(最大) | 受取店舗コード | |
ShipInvoiceNumber | (文字列) | 30byte(最大) | 配送伝票番号 | 配送伝票番号1/2の両方に対して検索を行います。 |
ShipInvoiceNumberEmptyReason | (文字列) | 3byte(最大) | 伝票番号なし理由 | NULL:(未登録の状態) 101:メーカ等の在庫元からの直送品のため 102:発送不要の商品のため 103:店頭受け取り商品のため 104:配送会社から直接ご連絡のため 105:伝票番号が発行されない(追跡できない)配送方法のため |
ArriveType (※3) |
0 : 通常 1 : きょうつく注文 2 : あすつく注文 |
1byte(固定) | きょうつく、あすつく | きょうつく注文、あすつく注文の場合設定します。 |
ShipDate | (YYYYMMDD) | 8byte(固定) | 出荷日 | 注文管理ツールで入力された出荷日です。 |
ShipDateFrom | (YYYYMMDD) | 8byte(固定) | 出荷日(From) | 出荷日のレンジ検索時に指定します。 |
ShipDateTo | (YYYYMMDD) | 8byte(固定) | 出荷日(To) | 出荷日のレンジ検索時に指定します。 |
NeedGiftWrap | キーなし : カートに設定なし false : ギフト包装無し true : ギフト包装有り |
5byte(最大) | ギフト包装有無 | ギフト包装 |
NeedGiftWrapMessage | false : ギフトメッセージ無し true : ギフトメッセージ有り |
5byte(最大) | ギフトメッセージ有無 | ギフトメッセージの有無を指定します。 |
NeedGiftWrapPaper | false : のし無し true : のし有り キーなし : カートに設定なし |
(数値) | のし有無 | のしの有無 |
ShipFirstName | (文字列) | 297byte(最大) | お届け先名前 | お届け先名前 |
ShipFirstNameKana | (文字列) | 297byte(最大) | お届け先名前カナ | お届け先名前(フリガナ) |
ShipLastName | (文字列) | 297byte(最大) | お届け先名字 | お届け先名字 |
ShipLastNameKana | (文字列) | 297byte(最大) | お届け先名字カナ | お届け先名字(フリガナ) |
ShipZipCode | (文字列) | 10byte(最大) | お届け先郵便番号 | お届け先郵便番号 |
ShipPrefecture | (文字列) | 12byte(最大) | お届け先都道府県 | お届け先都道府県 海外の場合は「その他」として保存します。 |
ShipPhoneNumber | (文字列) | 14byte(最大) | お届け先電話番号 | お届け先電話番号 |
期間開始日のみ指定時は指定日以降全てが対象となります。 ※現在この項目は利用できません |
||||
期間終了日のみ指定時は指定日以前全てが対象となります。 ※現在この項目は利用できません |
||||
IsGetPointFixAll | false : 未確定 true : 確定済 |
5byte(最大) | 全付与ポイント確定有無 | 全Lineの付与ポイントの確定処理が完了したかどうかを示します。 |
ItemId | (文字列) | 228byte(最大) | 商品コード | 商品コードを指定します。ストアアカウントは含みません。 |
Title | (文字列) | 225byte(最大) | 商品名 | 商品名を指定します。 |
SubCode | (文字列) | 99byte(最大) | 商品サブコード | 商品にサブコードが存在している場合に指定します。 |
GetPointFixDateFrom | (YYYYMMDD) | 8byte(固定) | 付与ポイント確定日(From) | 付与ポイント確定日の期間開始日。特定の日付のみ指定する場合は期間終了日と同じ日を指定します。 期間開始日のみ指定時は指定日以降全てが対象となります。 |
GetPointFixDateTo | (YYYYMMDD) | 8byte(固定) | 付与ポイント確定日(To) | 付与ポイント確定日の期間終了日。特定の日付のみ指定する場合は開始日と同じ日を指定します。 期間終了日のみ指定時は指定日以前全てが対象となります。 |
SellerId (必須) |
(文字列) | 128byte(最大) | ストアアカウント | ストアアカウントを指定します。 |
IsLogin | false : ゲスト true : ログイン |
5byte(最大) | Yahoo! JAPAN IDログイン有無 | Yahoo! JAPAN IDでログインしているかを判定します。 |
SellerType (※3) |
1 : セラー 2 : セラー(個人出店者) |
1byte(固定) | セラー種別 | |
IsPayManagement | false : 非代金支払い管理 true : 代金支払い管理 |
5byte(最大) | 代金支払い管理注文 | |
ExistMultiReleaseDate | false : 発売日1つ以下 true : 2つ以上 |
5byte(最大) | 複数発売日あり | |
ReadOnlyMode | 数値 | 1byte固定 | 読み取り専用 | 0:読み書き可能のみ(注文者からキャンセルができない状態の複数の注文情報を取得) 1:読み取り専用のみ(キャンセル可能な10分間のみの注文を取得) 2:両方含む(上記両方含むリストの取得) ※初期値:0(読み書き可能のみ) |
IsApplePay | false:ApplePay利用無し true:ApplePay利用有り |
5byte(最大) | ApplePay利用有無 | 支払にApplePayを利用した注文フラグです。 ※ ApplePay導入リリースで追加予定 |
IsFirstClassDrugIncludes | false:第1類医薬品を含まない注文 true:第1類医薬品を含む注文 |
5byte(最大) | 第1類医薬品フラグ | 第1類医薬品を含む注文か判定します。 |
IsFirstClassDrugAgreement | false:未承諾 true:承諾済み |
5byte(最大) | 第1類医薬品承諾フラグ | 第1類医薬品を含む注文の承諾状況を判定します。 |
ReceiveSatelliteType | 数値 | 2byte(最大) | 自宅外配送受取種別 | 自宅外配送の種別を判定します。 0,Null:通常配送 1:日本郵便自宅外配送 |
ShipInstructType | 数値 | 3byte | 出荷指示区分 | 0:対象外 1:直接連携 2:荷主経由 101:ヤマト運輸株式会社 ピック&デリバリー 102:ヤマト運輸株式会社 フルフィルメント(API連携) 103:ヤマト運輸株式会社 ピック&デリバリー(連携外ストア) 104:ヤマト運輸株式会社 フルフィルメント(マルチチャネル) |
ShipInstructStatus | 数値 | 3byte | ※ヤマトピック&デリバリー、フルフィルメント専用項目 出荷指示ステータス |
0:対象外 100:出荷指示受付前 101:出荷指示待ち 102:出荷キャンセル 103:出荷指示済み 104:出荷完了 105:着荷完了 106:配送不可 |
YamatoCoopStatus | 数値 | 1byte | ※ヤマトピック&デリバリー、フルフィルメント専用項目 ヤマト連携ステータス |
0 :対象外、未連携 1:連携受付 2:連携処理中 3:連携済 4:連携キャンセル |
IsGetStoreBonusFixAll | false:未確定 true:確定済 |
5 byte(最大) | 全付与ストアPayPayボーナス確定フラグ | 付与ストアPayPayボーナスの課金請求が確定したか否かを示します。 |
GetStoreBonusFixDateFrom | (YYYYMMDD) | 8 byte(固定) | 付与ストアPayPayボーナス確定日(From) | 付与ストアPayPayボーナス確定日の期間開始日 |
GetStoreBonusFixDateTo | (YYYYMMDD) | 8 byte(固定) | 付与ストアPayPayボーナス確定日(To) | 付与ストアPayPayボーナス確定日の期間終了日 |
ReceiveShopType | (数値) | 1 byte | 店頭注文種別 | null or 0 :通常注文 1:店頭受取 2:店頭在庫受取 3:店頭在庫発送 |
IsEazy | true:EAZY注文 false:EAZY外注文 |
5byte(最大) | EAZY注文フラグ | |
EazyDeliveryCode | 0-7 | 2byte(最大) | EAZYコード | |
EazyDeliveryName | (文字列) | 50byte(最大) | EAZY受け取り場所名 | |
IsYahooAuctionOrder | true:Yahoo!オークション注文 false:Yahoo!オークション注文以外 ※falseの場合は過去注文(null)含む |
5byte(最大) | Yahoo!オークション併売フラグ | |
YahooAuctionId | (文字列) | 16byte(最大) | オークションID | こちら項目を検索条件に入れた場合、レスポンスデータが返らないため、 Yahoo!オークション注文を絞り込む場合は下記項目をご利用ください。 ・ItemYahooAucId |
YahooAuctionMerchantId | (文字列) | 20byte(最大) | Yahoo!オークション管理番号 | こちら項目を検索条件に入れた場合、レスポンスデータが返らないため、 Yahoo!オークション注文を絞り込む場合は下記項目をご利用ください。 ・ItemYahooAucMerchantId |
IsYahooAuctionDeferred | true:購入後決済(※入札・落札後、購入手続きする形式) false or null:購入後決済以外 |
5byte | Yahoo!オークション購入後決済フラグ | |
YahooAuctionCategoryType | 0:通常 1:自動車車体 2:バイク車体 |
1byte | Yahoo!オークションカテゴリ種別 | |
YahooAuctionBidType | 0:定額 1:競り(即決価格) 2:競り(通常) |
1byte | Yahoo!オークション落札種別 | |
YahooAuctionBundleType | 未指定: すべての注文 0: 同梱ではないYahoo!オークション注文 または Yahoo!オークションではない注文 1: 同梱注文 |
5byte | Yahoo!オークション同梱タイプ | Yahoo!オークション注文での同梱機能の利用状況 |
ItemYahooAucId | 8桁から11桁の英数字です。 | 16byte | オークションID | Yahoo!ショッピングでは存在しない情報となりますので、検索フィールドに1文字でも文字を入れると強制的にYahoo!オークション注文のみに絞られるようになりますのでご注意ください。 |
ItemYahooAucMerchantId | CDATA | 20byte | Yahoo!オークション管理番号 | Yahoo!ショッピングでは存在しない情報となりますので、検索フィールドに1文字でも文字を入れると強制的にYahoo!オークション注文のみに絞られるようになりますのでご注意ください。 |
PayMethodChangeDeadlineFrom (必須※2) |
(YYYYMMDDHH24MISS) | 14byte(固定) | 支払い方法変更期限(From) | 支払い方法の変更期限のレンジ検索時に指定します。 |
PayMethodChangeDeadlineTo (必須※2) |
(YYYYMMDDHH24MISS) | 14byte(固定) | 支払い方法変更期限(To) | 支払い方法の変更期限のレンジ検索時に指定します。 |
IsPayMethodChangePossible | true:支払い方法変更可 |
5byte(最大) | 支払い方法変更可能フラグ | 支払い方法が変更可能か判定する際に指定します。 ※「false:支払い方法変更不可」を指定した検索はできません。 |
LineGiftDisplayType(※5) | 未指定:LINEギフト含む全注文取得 0 :LINEギフト含む全注文取得 1:LINEギフト注文のみ取得 2:非LINEギフト注文のみ取得 |
1byte(固定) | LINEギフト表示種別 ※LINEギフト専用項目 |
取得情報にLINEギフト注文を含めるかを判定するフラグ |
LineGiftShippableType(※5) | 0 or 未指定:LINEギフト含む全注文取得 1:通常注文+出荷可能なLINEギフト注文取得 2:出荷不可なLINEギフト注文のみ取得 |
1byte(固定) | LINEギフト出荷可能種別 ※LINEギフト専用項目 |
出荷可能なLINEギフト注文を取得するか判定するフラグ |
ShippingDeadlineFrom | YYYYMMDDHH24MISS | 14byte(固定) | LINEギフト発送期限(From) ※LINEギフト専用項目 |
LINEギフト発送期限のレンジ検索時に指定する検索開始日時 |
ShippingDeadlineTo | YYYYMMDDHH24MISS | 14byte(固定) | LINEギフト発送期限(To) ※LINEギフト専用項目 |
LINEギフト発送期限のレンジ検索時に指定する検索終了日時 |
OverlapOrderResult | (数値) | 1byte | 二重注文判定結果 |
0 or null: 未ログインなど二重注文判定対象外の注文 1: システム障害などにより未判定の注文 2: 二重注文判定とならなかった注文 3:二重注文判定されカートでお客様同意済みの注文 |
SocialGiftType (※3) |
未指定:全注文を取得 0:ソーシャルギフト以外の注文を取得 1:URL共有により住所入力されたソーシャルギフト注文を取得 2:購入者により住所入力されたソーシャルギフト注文を取得 |
2byte(最大) | ソーシャルギフトタイプ |
ソーシャルギフト注文でお届け先情報を「URL共有して入力」「購入者が入力」の注文を絞り込むためのフラグです。 ※「0」を指定すると過去注文含めたソーシャルギフト以外の注文の絞り込みになります。 |
※1 OrderID か 「OrderTimeを始めとする日時指定(※2)」 のいずれか必須です。
※2 「OrderTimeを始めとする日時指定」の場合、
OrderTime、OrderTimeFrom、OrderTimeTo、
PublicationTimeFrom、PublicationTimeTo、
PayMethodChangeDeadlineFrom、PayMethodChangeDeadlineTo のいずれか必須です。
※3 複数マッチはカンマ区切りで指定します。
※4 注文ステータスのリクエストは以下の組み合わせとなります。
・『新規予約の検索』 ⇒「IsSeen: false 、かつOrderStatus: 1」
・『新規注文の検索』 ⇒「IsSeen: false 、かつOrderStatus: 2」
・『予約の検索』 ⇒「IsSeen: true 、 かつOrderStatus: 1」
・『処理中の検索』 ⇒「IsSeen: true 、 かつOrderStatus: 2」
・『保留の検索』 ⇒「OrderStatus: 3」
・『キャンセルの検索』⇒「OrderStatus: 4」
・『完了の検索』 ⇒「OrderStatus: 5」
・『処理中と新規注文の検索』 ⇒「OrderStatus: 2」
※5 検索条件に合致しない場合は取得件数が0になります。
例)
「LineGiftDisplayType=2:非LINEギフト注文のみ取得」、
「LineGiftShippableType=2:出荷不可なLINEギフト注文のみ取得」とした場合、
LINEギフト注文ではない注文で出荷不可のLINEギフト注文を取得となり、
それら注文は存在しないため0件になります。
- 取得情報(Field) :
キー名 | 型 | 最大長 | 項目 | 情報区分 | 内容 |
---|---|---|---|---|---|
OrderId | (^[a-zA-Z0-9-]+$) | 50byte(最大) | 注文ID | 注文ID | |
Version | (数値) | 2byte(最大) | バージョン | カートや注文PF、購入データIFが変わったときにバージョンをあげます。 | |
OriginalOrderId | (^[a-zA-Z0-9-]+$) | 50byte(最大) | 受注時注文ID | 受注処理した際の注文IDです。 ex)注文Aを注文B、注文Cに分割 注文Cを注文D、注文Eに分割 注文A、B、C、D、Eすべての受注時注文IDはA |
|
ParentOrderId | (^[a-zA-Z0-9-]+$) | 50byte(最大) | 分割元注文ID | 注文分割した際の分割元注文IDです。 (一番元となる受注時注文IDとは違う場合があります) ex) 注文Aを注文B、注文Cに分割 注文Cを注文D、注文Eに分割 注文B、Cの分割元注文IDはA 注文D、Eの分割元注文IDはC 未分割注文ID(注文A)は未設定 |
|
DeviceType | 1 : PC 2 : ガラケー 3 : スマートフォン 4 : タブレット |
1byte固定 | デバイス情報 | 1=PC,2=ガラケー,・・スマフォ,アプリ 等、固定はどのカートから入ってきたかで定義します。 | |
true : 有効注文 |
※現在この項目は利用できません |
||||
IsSeen | false : 未閲覧 true : 閲覧済 |
5byte(最大) | 閲覧済みフラグ | ||
IsSplit | false : 未分割 true : 分割済 |
5byte(最大) | 分割フラグ | 分割元注文IDの場合は true : 分割済 未分割、分割先注文IDは false : 未分割 ex)注文Aを注文B、注文Cに分割 注文A:true 注文B:false 注文C:false |
|
IsRoyalty | false : 課金対象外 true : 課金対象 |
5byte(最大) | 課金フラグ | 課金対象かどうかを判定します。例えばテスト注文の場合はfalseを指定します。 | |
IsSeller | false : 非管理者注文 true : 管理者注文 |
5byte(最大) | 管理者注文フラグ | セラーが登録Yahoo!IDで行った注文です。注文管理で表示します。 | |
IsAffiliate | false : 非アフィリエイト経由注文 true : アフィリエイト経由注文 |
5byte(最大) | アフィリエイトフラグ | アフィリエイト経由の注文かどうかの判定です。 | |
IsRatingB2s | false : 未評価 true : 評価済 |
5byte(最大) | 評価フラグ(Buyer⇒Seller) | Seller評価済みかどうか判定します。 | |
OrderTime | YYYY-MM-DDTHH24:MI:SS(日本標準時) | 25byte(固定) | 注文日時 | 注文確定ボタン押下時 落札時(=操作日時) (例)2012-04-19T16:10:40 |
|
ExistMultiReleaseDate | false : 発売日1つのみ true : 発売日複数有り |
5byte(最大) | 複数発売日あり | 発売日が1つも設定されていない場合も「0」です。 | |
ReleaseDate | (YYYY-MM-DD) | 10byte(固定) | 注文(最長)発売日 | 商品情報 | 検索APIの取得項目のみで指定可能です。 注文の(最長)発売日がセットされます。 |
LastUpdateTime | (YYYY-MM-DDTHH24:MI:SS+09:00) (例)2012-04-19T16:10:40+09:00 |
25byte(固定) | 最終更新日時 | 注文情報の最終更新日時です。 | |
Suspect | 0 : 非悪戯注文 1 : 悪戯注文 2 : 悪戯解除済注文 |
1byte(固定) | 悪戯フラグ | いたずら対象、非対象、解除済みを判定するフラグです。 3値持ちます。 |
|
OrderStatus | 0 : 未入力 1 : 予約中 2 : 処理中 3 : 保留 4 : キャンセル 5 : 完了 8 : 繰上げ同意待ち |
1byte(固定) | 注文ステータス | 注文情報の状態を表すステータスです。 新規注文は注文ステータス「処理中」かつ閲覧済みフラグ「false」で表現されます。 新規予約は注文ステータス「予約中」かつ閲覧済みフラグ「false」で表現されます。 |
|
StoreStatus | 数値 | 2byte(最大) | ストアステータス | ストアが独自に設定可能なステータスです。 (ステータス名はストアクリエイターProで管理します。) |
|
RoyaltyFixTime | (YYYY-MM-DDTHH24:MI:SS+09:00) (例)2012-04-19T16:10:40+09:00 |
25byte(固定) | 課金確定日時 | 課金確定日時 | |
PrintSlipFlag | false : 注文伝票未出力 true : 注文伝票出力済み |
5byte(最大) | 注文伝票出力有無 | 注文伝票出力有無 | |
PrintDeliveryFlag | false : 納品書未出力 true : 納品書出力済み |
5byte(最大) | 納品書出力有無 | 納品書出力有無 | |
PrintBillFlag | false : 請求書未出力 true : 請求書出力済み |
5byte(最大) | 請求書出力有無 | 請求書出力有無 | |
BuyerCommentsFlag | false : バイヤーコメントなし true : バイヤーコメントあり |
5byte(最大) | バイヤーコメント有無 | ご要望欄入力がされている/されていないを表すフラグです。 | |
PayStatus | 0 : 未入金 1 : 入金済 |
1byte(固定) | 入金ステータス | 受注、支払時に支払方法毎に注文PFで設定します。 入金待ち 入金済み |
|
SettleStatus | 1 : 決済申込 2 : 支払待ち 3 : 支払完了 4 : 入金待ち 5 : 決済完了 6 : キャンセル 7 : 返金 8 : 有効期限切れ 9 : 決済申込中 10 : オーソリエラー 11 : 売上取消 12 : Suicaアドレスエラー |
2byte(最大) | 決済ステータス | 値は検索項目を参照してください。 | |
PayType | 0 : 後払い 1 : 前払い |
1byte(固定) | 支払い分類 | 支払方法分類 前払い、後払いを判定します。 |
|
PayMethod | (文字列) payment_決済ID |
11byte(最大) | 支払い方法 | お支払方法番号 payment_a1:クレジットカード決済 payment_a6:コンビニ決済(セブンイレブン) payment_a7:コンビニ決済(その他) payment_a8:モバイルSuica決済 payment_a9:dケータイ払い payment_a10:auかんたん決済 payment_a11:ソフトバンクまとめて支払い payment_a15:ペイジー payment_a16:Yahoo!マネー/預金払い payment_a17:PayPay(残高) payment_a18:ゆっくり払い payment_a19:PayPay(クレジット)※旧あと払い payment_b[1-6]:銀行振込(名称はストアの自由設定) payment_c1:ゆうちょ銀行(前払い) payment_c2:ゆうちょ銀行(後払い) payment_c3:現金書留 payment_d1:商品代引 payment_e[1-15]:ストアの自由なお支払い方法名 payment_h1:無料商品提供 payment_z4:商品券/Yahoo!ショッピング商品券 payment_z1:ポイント全額払い |
|
PayMethodName | (文字列) 支払方法 |
150byte最大) | 支払い方法名称 |
お支払方法と別に名称を持ちます。Yahoo!決済名称、銀行振込の銀行名、ゆうちょなど。 支払い方法がpayment_a17、payment_a19の場合、2024/5/13(月)リリース後の注文に関して名称が変更されますが、リリース前の注文に関しては変更されませんのでご注意ください。 <現在> PayPay(残高) PayPay(クレジット)※旧あと払い <修正後> PayPay残高等 PayPayクレジット |
|
PayDate | (YYYY-MM-DD) | 10byte(固定) | 入金日 | 注文管理ツールで入力された入金日です。 | |
SettleId | (英数字ASCⅡ文字) 英数字ASCII文字 英文字は小文字 |
38byte(最大) | 決済ID | NT決済ID、クレカ以外も同様です。 | |
UseWallet | false : Wallet利用無し true : Wallet利用有り |
5byte(最大) | ウォレット利用有無 | 支払にWalletを利用した注文フラグです。 ※Wallet利用の範囲を定義する必要があります。 |
|
NeedBillSlip | キーなし : カートに設定なし false : 請求書不要 true : 請求書必要 |
5byte(最大) | 請求書有無 | 請求書有無 | |
NeedDetailedSlip | キーなし : カートに設定なし false : 明細書不要 true : 明細書必要 |
5byte(最大) | 明細書有無 | 明細書有無 伝票画面上では、「納品書」表記します。 帳票出力でも「納品書」出力で、「明細書」が出力可能です。 |
|
NeedReceipt | キーなし : カートに設定なし false : 領収書不要 true : 領収書必要 |
5byte(最大) | 領収書有無 | 領収書有無 | |
BillFirstName | (文字列) | 297byte(最大) | ご請求先名前 | ご請求先名前 ソーシャルギフト注文では"ソーシャルギフト利用者"固定になります。 |
|
BillFirstNameKana | (文字列) | 297byte(最大) | ご請求先名前カナ | ご請求先名前(フリガナ) ソーシャルギフト注文では"ソーシャルギフトリヨウシャ"固定になります。 |
|
BillLastName | (文字列) | 297byte(最大) | ご請求先名字 | ご請求先名字 ソーシャルギフト注文ではストア名になります。 |
|
BillLastNameKana | (文字列) | 297byte(最大) | ご請求先名字カナ | ご請求先名字(フリガナ) ソーシャルギフト注文ではストア名カナになります。 |
|
BillPrefecture | (文字列) | 12byte(最大) | ご請求先都道府県 | ご請求先都道府県 海外の場合「その他」が入ります。 ソーシャルギフト注文ではストアのお問い合わせ住所の都道府県になります。 |
|
ShipStatus | 0 : 出荷不可 1 : 出荷可 2 : 出荷処理中 3 : 出荷済み 4 : 着荷済み |
1byte(固定) | 出荷ステータス | 支払方法によって「出荷不可」か「出荷可」とします。注文受付時に判定します。 | |
ShipMethod | (文字列) postageN |
9byte(最大) | 配送方法 | お届け方法番号:postage1-14,16のどれか1つ(postage15は欠番) ストアクリエイターProの配送設定順。 |
|
ShipMethodName | (文字列) | 150byte(最大) | 配送方法名 | ||
ShipRequestDate | (YYYY-MM-DD) | 10byte(固定) | 配送希望日 | 配送希望日です。 | |
ShipRequestTime | (文字列) | 13byte(最大) | 配送希望時間 | 12:00~14:00など | |
ShipNotes | (文字列) | 500byte(最大) | 配送メモ | 注文管理ツールで入力された出荷の配送希望メモ入力内容です。 | |
ShipCompanyCode | (数値) | 4byte(最大) | 配送会社 | 配送会社コード 1000:その他 1001:ヤマト運輸 1002:佐川急便 1003:日本郵便 1004:西濃運輸 5001:店頭受け取り (一覧はこちら) |
|
ReceiveShopCode | (文字列) | 50byte(最大) | 受取店舗コード | ||
ShipInvoiceNumber1 | (文字列) | 30byte(最大) | 配送伝票番号1 | 注文管理ツールでセラーが入力、アップロードした配送会社の配送伝票番号。注文管理ツールの画面上は1と2があります。 | |
ShipInvoiceNumber2 | (文字列) | 30byte(最大) | 配送伝票番号2 | 注文管理ツールでセラーが入力、アップロードした配送会社の配送伝票番号。注文管理ツールの画面上は1と2があります。 | |
ShipInvoiceNumberEmptyReason | (文字列) | 3byte(最大) | 伝票番号なし理由 | NULL:(未登録の状態) 101:メーカ等の在庫元からの直送品のため 102:発送不要の商品のため 103:店頭受け取り商品のため 104:配送会社から直接ご連絡のため 105:伝票番号が発行されない(追跡できない)配送方法のため |
|
ShipUrl | (文字列) | 100byte(最大) | 配送会社URL | ||
ArriveType | 0 : 通常 1 : きょうつく注文 2 : あすつく注文 |
1byte(固定) | きょうつく、あすつく | きょうつく注文、あすつく注文の場合の設定です。 | |
ShipDate | (YYYY-MM-DD) | 10byte(固定) | 出荷日 | 注文管理ツールで入力された出荷日です。 | |
NeedGiftWrap | キーなし : カートに設定なし false : ギフト包装無し true : ギフト包装有り |
5byte(最大) | ギフト包装有無 | ギフト包装 | |
NeedGiftWrapMessage | false : ギフトメッセージ無し true : ギフトメッセージ有り |
5byte(最大) | ギフトメッセージ有無 | ||
NeedGiftWrapPaper | false : のし無し true : のし有り キーなし : カートに設定なし |
5byte(最大) | のし有無 | のしの有無 | |
ShipFirstName | (文字列) | 297byte(最大) | お届け先名前 | お届け先名前 | |
ShipFirstNameKana | (文字列) | 297byte(最大) | お届け先名前カナ | お届け先名前(フリガナ) | |
ShipLastName | (文字列) | 297byte(最大) | お届け先名字 | お届け先名字 | |
ShipLastNameKana | (文字列) | 297byte(最大) | お届け先名字カナ | お届け先名字(フリガナ) | |
ShipPrefecture | (文字列) | 12byte(最大) | お届け先都道府県 | お届け先都道府県 海外の場合は「その他」として保存します。 |
|
PayCharge | (数値) | 10byte(最大) | 手数料 | セラーが設定した手数料(代引き手数料など)、Yahoo!決済の決済手数料は別です。 | |
ShipCharge | (数値) | 10byte(最大) | 送料 | 送料(送料無料クーポン値引き後の金額) | |
GiftWrapCharge | (数値) | 10byte(最大) | ギフト包装料 | ギフト包装料 | |
Discount | (数値) | 10byte(最大) | 値引き | 値引き | |
GiftCardDiscount | (数値) | 10byte | 商品券利用額 | 利用された商品券の利用額です | |
UsePoint | (数値) | 10byte(最大) | 利用ポイント合計 | 利用ポイント数、特典の一部利用もしくは商品券を利用した注文の場合は、その利用額がそれぞれ加算されます。 | |
TotalPrice | (数値) | 15byte(最大) | 合計金額 | 商品金額合計(税込) + ギフト包装料 + 送料 + 手数料 - 値引き - 利用ポイント数 - モールクーポン値引き額 - 特典の一部利用額 - 商品券利用額 + 調整額 ※ 注文検索APIの「TotalPrice(合計金額)」は、注文情報フィールドの「Total(請求金額合計)」と同じ値を表します。内訳は以下マニュアルも参照ください。 ストアクリエイタProマニュアル:注文フィールド一覧の「Total」と「TotalPrice」の違いはなんですか |
|
RefundTotalPrice | (数値) | 15byte(最大) | 返金合計金額 | 注文キャンセル後取得可能 | |
※現在この項目は利用できません |
|||||
true : 確定済 |
※現在この項目は利用できません |
||||
IsGetPointFixAll | false : 未確定 true : 確定済 |
5byte(最大) | 全付与ポイント確定有無 | 全Lineの付与ポイントが確定処理を完了したかどうかを示します。 | |
SellerId | (文字列) | 128byte(最大) | セラーID | セラーID | |
IsLogin | false : ゲスト true : ログイン |
5byte(最大) | Yahoo! JAPAN IDログイン有無 | Yahoo! JAPAN IDでログインしているかを判定します。 | |
PayNo | (文字列) | 20byte(最大) | 支払番号 | ||
PayNoIssueDate | (YYYY-MM-DDTHH24:MI:SS+09:00) (例)2012-04-19T16:10:40+09:00 |
25byte(固定) | 支払番号発行日時 | ||
SellerType | 1 : セラー 2 : セラー(個人出店者) |
1byte(固定) | セラー種別 | ||
IsPayManagement | false : 非代金支払い管理 true : 代金支払い管理 |
5byte(最大) | 代金支払い管理注文 | ||
ArrivalDate | (YYYY-MM-DD) | 10byte(固定) | 着荷日 | ||
TotalMallCouponDiscount | (数値) | 15byte(固定) | モールクーポン値引き額 | ||
IsReadOnly | (数値) | 1byte(固定) | 読み取り専用 | 1:読み取り専用(キャンセル受付注文) 0:読み書き可能 |
|
IsApplePay | false:ApplePay利用無し true:ApplePay利用有り |
5byte(最大) | ApplePay利用有無 | 支払にApplePayを利用した注文フラグです。 ※ ApplePay導入リリースで追加予定 |
|
IsFirstClassDrugIncludes | false、null:第1類医薬品を含まない注文 true:第1類医薬品を含む注文 |
5byte(最大) | 第1類医薬品フラグ | 第1類医薬品を含む注文か判定します。 | |
IsFirstClassDrugAgreement | false、null:未承諾 true:承諾済み |
5byte(最大) | 第1類医薬品承諾フラグ | 第1類医薬品を含む注文の承諾状況を判定します。 | |
IsWelcomeGiftIncludes | false/true | 5byte(最大) | 無料プレゼント(ウェルカムギフト)含有フラグ | false、null:無料プレゼント(ウェルカムギフト)を含まない注文 true:無料プレゼント(ウェルカムギフト)を含む注文 |
|
ReceiveSatelliteType | 数値 | 2byte(最大) | 自宅外配送受取種別 | 自宅外配送の種別を判定します。 0,Null:通常配送 1:日本郵便自宅外配送 |
|
ShipInstructType | 数値 | 3byte | 出荷指示区分 | 0:対象外 1:直接連携 2:荷主経由 101:ヤマト運輸株式会社 ピック&デリバリー 102:ヤマト運輸株式会社 フルフィルメント(API連携) 103:ヤマト運輸株式会社 ピック&デリバリー(連携外ストア) 104:ヤマト運輸株式会社 フルフィルメント(マルチチャネル) |
|
ShipInstructStatus | 数値 | 3byte | ※ヤマトピック&デリバリー、フルフィルメント専用項目 出荷指示ステータス |
0:対象外 100:出荷指示受付前 101:出荷指示待ち 102:出荷キャンセル 103:出荷指示済み 104:出荷完了 105:着荷完了 106:配送不可 |
|
YamatoCoopStatus | 数値 | 1byte | ※ヤマトピック&デリバリー、フルフィルメント専用項目 ヤマト連携ステータス |
null or 0 :対象外、未連携 1:連携受付 2:連携処理中 3:連携済 4:連携キャンセル |
|
ReceiveShopType | (数値) | 1byte | 店頭注文種別 | null or 0 :通常注文 1:店頭受取 2:店頭在庫受取 3:店頭在庫発送 |
|
ReceiveShopName | 文字列 | 200byte(最大) | 配送元店頭名 | ||
ExcellentDelivery | (数値) | 1byte(固定) | 優良配送フラグ | 0 : 優良配送でない 1 : 優良配送 2:翌日優良配送 |
|
IsEazy | null:リリース前注文 false:EAZY外注文 true:EAZY注文 |
5byte(最大) | EAZY注文フラグ | EAZY注文フラグ | |
EazyDeliveryCode | 0-7 | 2byte(最大) | EAZYコード | EAZYコード | |
EazyDeliveryName | 対面受取(置き配を利用しない) 玄関ドア前 自宅宅配BOX ガスメーターBOX 物置 車庫 自転車かご 建物内受付/管理人預け |
50byte(最大) | EAZY受け取り場所名 | EAZY受け取り場所名 | |
FraudHoldStatus | 数値 | 1byte | 不正保留ステータス | 0 or null:不正リスク低 1:ルール保留審査中 2:ルール保留解除 3:ルール悪用確 |
|
PublicationTime | YYYY-MM-DDTHH24:MI:SS(日本標準時) | 25byte(最大) | orderList公開日時 | 不正保留解除時など、orderListから取得できるようになった時間がセットされます。 | |
IsYahooAuctionOrder | true:Yahoo!オークション注文 false:Yahoo!オークション注文以外 |
5byte(最大) | Yahoo!オークション併売フラグ | Yahoo!オークション注文であるかの判定フラグ | |
YahooAuctionMerchantId | (文字列)1234567890 ※下記の記号は使用可能 # & ( ) - < > . / _ |
20byte(最大) | Yahoo!オークション管理番号 | ||
YahooAuctionId | (文字列) y123456789 |
16byte(最大) | オークションID | ||
IsYahooAuctionDeferred | true:購入後決済(※入札・落札後、購入手続きする形式) false or null:購入後決済以外 |
5byte | Yahoo!オークション購入後決済フラグ | ||
YahooAuctionCategoryType | 0 or null:通常 1:自動車車体 2:バイク車体 |
1byte | Yahoo!オークションカテゴリ種別 | ||
YahooAuctionBidType | 0 or null:定額 1:競り(即決価格) 2:競り(通常) |
1byte | Yahoo!オークション落札種別 | ||
YahooAuctionBundleType | 0 または null: 同梱ではないYahoo!オークション注文 または Yahoo!オークションではない注文 1: 同梱注文 |
1byte (固定) | Yahoo!オークション同梱タイプ | Yahoo!オークション注文での同梱機能の利用状況 | |
ItemYahooAucId | 8桁から11桁の英数字です。 | 16byte | オークションID | レスポンスではLine1の商品のデータしか返却されません。 1つ目(Line1)以外の対象を取得したい場合は注文詳細APIをご利用ください。 |
|
ItemYahooAucMerchantId | CDATA | 20byte | Yahoo!オークション管理番号 | レスポンスではLine1の商品のデータしか返却されません。 1つ目(Line1)以外の対象を取得したい場合は注文詳細APIをご利用ください。 |
|
PayMethodChangeDeadline | YYYY-MM-DDTHH24 : mi : SS(日本標準時) | 25byte(固定) | 支払い方法変更期限 | オーソリエラー発生時点の翌日から7日後の23:59 | |
IsPayMethodChangePossible | false:支払い方法変更不可 true:支払い方法変更可 |
5byte(最大) | 支払い方法変更可能フラグ | 支払い方法が変更可能か判定するフラグです。 ※支払い方法変更が完了、支払い方法変更期限の超過、注文キャンセル状態になるとtrue→falseに更新されます。 |
|
YourTimesaleDiscount | (数値) | 10byte | あなただけのタイムセール値引価格 | あなただけのタイムセール値引価格 | |
GoodStoreStatus | 0 or null:なし 1:優良店 |
1byte | 優良店判定 | 優良店を判別 ※2022/10以降予定 |
|
CurrentGoodStoreBenefitApply | 0 or null:なし 1:適応 |
1byte | 注文時点の優良店特典適応状態 | 注文時点の優良店特典の適応状態を示す ※2022/10以降予定 |
|
CurrentPromoPkgApply | 0 or null:なし 1:適応 |
1byte | 注文時点のプラン適応状況 | 注文時点のプラン適応状況を示す ※2022/10以降予定 |
|
IsSubscription | null:定期購入注文ではない true:定期購入注文である |
5byte(最大) | 定期購入フラグ | 定期購入契約の受注であることを示すフラグ | |
SubscriptionId | teiki-yyyyMMdd-ストアアカウント-ランダム英数8桁 | 70byte(最大) | 定期購入親ID | 定期購入の大本のID このIDに対して定期購入された注文が紐付きます。 初回の定期購入時のみ参照可能になるまで、注文日時から数分程度のタイムラグがありますのでご留意ください。 |
|
SubscriptionContinueCount | (数値) | 4byte | 定期購入継続回数 | 同一の定期購入親IDでの定期購入継続回数 | |
LineGiftOrderId | (文字列) | 20byte | LINEギフト注文ID ※LINEギフト専用項目 |
受注時に連携されたLINEギフト注文ID | |
IsLineGiftOrder | false : LINEギフト注文以外 true : LINEギフト注文 |
5byte | LINEギフト注文 ※LINEギフト専用項目 |
LINEギフト注文かどうかを判定するフラグ | |
IsLineGiftShippable | false : LINEギフト出荷不可 true : LINEギフト出荷可能 |
5byte | LINEギフト出荷可能フラグ ※LINEギフト専用項目 |
LINEギフト注文が出荷可能状態であるかを判定するフラグ | |
ShippingDeadline | YYYY-MM-DDTHH24:mi:SS(日本標準時) | 25byte(固定) | LINEギフト発送期限 ※LINEギフト専用項目 |
LINEギフト注文の発送期限 | |
LineGiftCharge | (数値) | 10byte(固定) | LINEギフト手数料 ※LINEギフト専用項目 |
LINEギフト注文の手数料 | |
TotalImmediateBonusAmount | (数値) | 15 byte | 特典の一部利用合計額 | 特典の一部利用に対してのPayPayポイント利用額 | |
TotalImmediateBonusRatio | (数値) | 4 byte | 特典の一部利用合計割合 | 特典の一部利用に対してのPayPayポイント利用割合 | |
SocialGiftType | 0:ソーシャルギフト以外の注文 1:URL共有により住所入力されたソーシャルギフト注文 2:購入者により住所入力されたソーシャルギフト注文 |
2byte(最大) | ソーシャルギフトタイプ |
ソーシャルギフト注文においてお届け先情報を「URL共有して入力」「購入者が入力」なのかを示すフラグです。 機能リリース前の注文では、空(null)となります。 |
配送会社コード(ShipCompanyCode) :
配送会社コード | 配送会社名 |
---|---|
1000 | その他 |
1001 | ヤマト運輸 |
1002 | 佐川急便 |
1003 | 日本郵便 |
1004 | 西濃運輸 |
1005 | 西武運輸 |
1006 | 福山通運 |
1007 | 名鉄運輸 |
1008 | トナミ運輸 |
1009 | 第一貨物 |
1010 | 新潟運輸 |
1011 | 中越運送 |
1012 | 岡山県貨物運送 |
1013 | 久留米運送 |
1014 | 山陽自動車運送 |
1015 | 日本トラック |
1016 | エコ配 |
1017 | EMS |
1018 | DHL |
1019 | FedEx |
1020 | UPS |
1021 | 日通通運 |
1022 | TNT |
1023 | OCS |
1024 | USPS |
1025 | SFエクスプレス |
1026 | Aramex |
1027 | SGHグローバル・ジャパン |
※こちらのAPIでは初回にユーザ認可リクエストをしてアクセストークン新規取得から最大12時間たつと下記のエラーとなります。再度、こちらのAPIをご利用いただくにはユーザ認可リクエストからやり直して、ユーザーの認可を取り直す必要があります。
<?xml version='1.0' encoding='UTF-8' ?>
<Error>
<Message>AccessToken has been expired. This API session is shorter than another API.</Message>
<Code>px-04102</Code>
</Error>
※こちらのAPIは公開鍵認証を利用することで、Yahoo! JAPAN IDの再認可までの期間を最大4週間延長することができます。詳しくはこちらをご確認ください。
※サンプルコード(PHP)はこちらをご確認ください。
サンプルリクエストURL
https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/orderList
サンプルリクエスト
POST /ShoppingWebService/V1/orderList HTTP/1.1
Host: circus.shopping.yahooapis.jp
Authorization: Bearer <アクセストークン>
<Req>
<Search>
<Result>50</Result>
<Start>1</Start>
<Sort>+order_time</Sort>
<Condition>
<OrderId>testseller-10000001</OrderId>
<DeviceType>1</DeviceType>
<IsRoyalty>true</IsRoyalty>
<IsAffiliate>false</IsAffiliate>
<OrderStatus>2</OrderStatus>
<StoreStatus>入荷未定</StoreStatus>
<IsActive>true</IsActive>
<Seen>true</Seen>
<IsSplit>false</IsSplit>
<Suspect>0</Suspect>
<IsRoyaltyFix>false</IsRoyaltyFix>
<PayStatus>1</PayStatus>
<SettleStatus>1011</SettleStatus>
<PayType>0</PayType>
<PayMethod>payment_a1</PayMethod>
<NeedBillSlip>1</NeedBillSlip>
<NeedDetailedSlip>0</NeedDetailedSlip>
<NeedReceipt>1</NeedReceipt>
<BillPrefecture>千葉県</BillPrefecture>
<BillZipCode>123-4567</BillZipCode>
<BillPhoneNumber>123-4567-8900</BillPhoneNumber>
<BillMailAddress>hoge@yahoo-corp.jp</BillMailAddress>
<ShipStatus>4</ShipStatus>
<ShipMethod>佐川急便</ShipMethod>
<ShipRequestDateNo>true</ShipRequestDateNo>
<ShipCompanyCode>1002</ShipCompanyCode>
<ShipInvoiceNumber>333-666666-4444</ShipInvoiceNumber>
<BuyerCommentsFlag>1</BuyerCommentsFlag>
<ShipPrefecture>千葉県</ShipPrefecture>
<ShipZipCode>223-4444</ShipZipCode>
<ShipPhoneNumber>111-2222-3333</ShipPhoneNumber>
<ItemId>item-a</ItemId>
<ReleaseDateFrom>21501231</ReleaseDateFrom>
<ReleaseDateTo>21501231</ReleaseDateTo>
<GetPointFixDateFrom>20110309</GetPointFixDateFrom>
<GetPointFixDateTo>20110309</GetPointFixDateTo>
<UsePointFixDateFrom>20110309</UsePointFixDateFrom>
<UsePointFixDateTo>20110309</UsePointFixDateTo>
<IsLogin>true</IsLogin>
<LineGiftDisplayType>0</LineGiftDisplayType>
<LineGiftShippableType>1</LineGiftShippableType>
<ShippingDeadlineFrom>20220401010101</ShippingDeadlineFrom>
<ShippingDeadlineTo>20220430010101</ShippingDeadlineTo>
</Condition>
<Field>OrderId,Version,LineGiftOrderId,IsLineGiftOrder,IsLineGiftShippable,ShippingDeadline,LineGiftCharge</Field>
</Search>
<SellerId>testseller</SellerId>
</Req>
レスポンスフィールド
レスポンスデータ「ArriveType」について(2019/06/20 更新)
お届け希望日の商品個別設定機能のリリースに伴い
お客様が選択した「お届け希望日」に応じたデータが連携されます。
▼リリース前
注文された商品に紐づくデータを連携
例)注文商品「きょうつく」お届け希望日「指定なし」を選択 → 「1: きょうつく注文」が返却されます。
▼リリース後
お客様が選択したお届け希望日に応じたデータを連携
例)注文商品「(設定なし)」お届け希望日「(注文日翌日)」を選択 → 「2: あすつく注文」が返却されます。
リリース予定日:2019年6月中
※詳細はストアクリエイタProの「機能情報」をご確認ください。
フィールド | 説明 |
---|---|
/Result | - |
/Result/Status | 処理結果 OK : 成功 NG : 失敗 |
/Result/Search | 検索結果 |
/Result/Search/TotalCount (※a) |
全件数 |
/Result/Search/OrderInfo | 注文情報 |
/Result/Search/OrderInfo/Index | 行番号 |
/Result/Search/OrderInfo/(取得情報キー) (※b) |
取得情報値 |
/Result/Search/OrderInfo/Item | (取得情報に商品情報が指定された時のみです。) |
/Result/Search/OrderInfo/Item(取得情報キー) | 取得情報値(商品情報) |
/Result/Error | エラー情報(エラー時のみ) |
/Result/Error/Code | エラーコード |
/Result/Error/Message | エラーメッセージ |
※a 全件数で取得される情報は、
リクエストパラメータの最大取得件数で指定した件数ではなく、
検索条件に該当した件数です。
例)
検索条件に該当した注文件数:5,000件
最大取得件数(/Req/Search/Result)の指定:1000
→ 全件数(/Result/Search/TotalCount)は「5000」が返ります。
※b 取得情報で取得される情報はリクエストパラメータの取得情報(Field)に指定した情報です。
お支払い方法「PayPay」追加に伴い追加されるレスポンスです。
キー名 | 項目 | 型 | 最大長 | 内容 |
---|---|---|---|---|
CombinedPayType | 併用支払い分類 | 0 : 後払い 1 : 前払い |
1byte(固定) | |
CombinedPayMethod | 併用お支払い方法 | (文字列) | 1byte(固定) | 例:payment_a1 ※PayMethodで利用している"payment_"で始まる文字列がセットされます。 |
CombinedPayMethodName | 併用お支払い方法名称 | (文字列) | 150byte(最大) | 例:クレジットカード決済 |
サンプルレスポンス
<!--・サンプルXML(該当注文1件以上)-->
<Result>
<Status>OK</Status>
<Search>
<TotalCount>10000</TotalCount>
<OrderInfo>
<Index>1</Index>
<SellerId>testseller</SellerId>
<OrderId>storename-10000001</OrderId>
<Version>1</Version>
<TotalMallCouponDiscount>100</TotalMallCouponDiscount>
<LineGiftOrderId>10015140</LineGiftOrderId>
<IsLineGiftOrder>true</IsLineGiftOrder>
<IsLineGiftShippable>true</IsLineGiftShippable>
<ShippingDeadline>2022-04-14T17:11:50+09:00</ShippingDeadline>
<LineGiftCharge>100</LineGiftCharge>
</OrderInfo>
<OrderInfo>
<Index>2</Index>
<SellerId>testseller</SellerId>
<OrderId>storename-10000001</OrderId>
<Version>1</Version>
<TotalMallCouponDiscount>200</TotalMallCouponDiscount>
</OrderInfo>
<・・・>・・・</・・・>
</Search>
</Result>
<!--・サンプルXML(該当注文無し)-->
<Result>
<Status>OK</Status>
<Search>
<TotalCount>0</TotalCount>
</Search>
</Result>
<!--・サンプルXML(該当注文あり、最大取得件数=0、取得開始件数>全件数などページング指定ミスで返却注文データ無し)-->
<Result>
<Status>OK</Status>
<Search>
<TotalCount>10</TotalCount>
<OrderInfo />
</Search>
</Result>
エラー
Yahoo!ショッピングで提供している全てのAPIには、共通で利用するエラーコードがあります。エラーの際には、まず始めに以下をご確認ください。
注文検索APIで固有に返すエラーコードは以下をご覧ください。
エラーコード
コード | HTTPステータスコード | 説明 |
---|---|---|
od90101 | 400 | リクエストパラメータエラーです。 |
od91801 | 404 | 注文ID FromTo検索において、存在しない注文IDが指定された場合です。 備考 Detailへ存在しない注文IDを,区切りで返します。 |
od91001 | 500 | サーバトラブル等です。 |
od91902 | 404 | メンテナンスエラー |
d91151 | 500 | リクエスト件数上限エラー (注文検索APIのみ) |
利用制限
※短い時間の間に同一URLに大量にアクセスを行った場合、一定時間利用できなくなることもございます。(1クエリー/秒)
利用約款
このAPIに関する利用約款はこちら。
目次
- 商品検索
- カテゴリランキング
- カテゴリID取得
- 商品コード検索(商品詳細)
- キーワードランキング
- おすすめ情報モジュール
- ポイントキャンペーン情報取得
- 販促イベント検索
- 商品レビュー検索
- 出品管理に関連するAPI
- 商品に関連するAPI
- 問い合わせ管理に関連するAPI
- 製品/SHPカテゴリ/ブランドに関連するAPI
- 在庫に関連するAPI
- ストアカテゴリに関連するAPI
- 画像に関連するAPI
- デザインに関連するAPI
- 注文に関するAPI
- ヘルプ