ショッピング

注文検索API

リクエストURL
XML
https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/orderList


本番環境用APIを利用したい場合は、こちらをご確認ください。

テスト用APIはどなたでもご利用いただけます。URLは以下の通りです。
https://test.circus.shopping.yahooapis.jp/ShoppingWebService/V1/orderList
テスト用APIを利用したい場合は、こちらから利用申請をお願いします。

注文情報を検索し、該当する複数注文情報を取得する機能を提供します。

リクエストパラメータ

RESTリクエストの構築(POST)」をご参照ください。

パラメータ 説明
/Req リクエストパラメータ
/Req/Search 検索条件指定情報
/Req/Search/Result
(デフォルト : 10)
integer 最大取得件数(上限値はありません)
/Req/Search/Start
(デフォルト : 1)
integer 取得開始件数
/Req/Search/Sort string ・注文時間で昇順ソート:+order_time(デフォルト)
・注文時間で降順ソート:-order_time
/Req/Search/Condition 検索条件
/Req/Search/Condition/
(検索条件キー)
検索条件
/Req/Search/Field
(必須)
string 取得情報
/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)
(YYYYMMDDHH24MISS) 14byte(固定) 注文日時 注文確定ボタン押下した日時です。
OrderTimeFrom
(必須※2)
(YYYYMMDDHH24MISS) 14byte(固定) 注文日時(From) 注文日時のレンジ検索時に指定します。
OrderTimeTo
(必須※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:ドコモケータイ払い
payment_a10:auかんたん決済
payment_a11:ソフトバンクまとめて支払い
payment_a15:ペイジー
payment_a16:Yahoo!マネー/預金払い
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(固定) 配送希望日無し 配送希望日無しの条件を指定します。
ShipInvoiceNumber (文字列) 30byte(最大) 配送伝票番号 配送伝票番号1/2の両方に対して検索を行います。
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(最大) お届け先電話番号 お届け先電話番号
UsePointFixDateFrom (YYYYMMDD) 8byte(固定) 利用ポイント確定日(From) 利用ポイント確定日の期間開始日。特定の日付のみ指定する場合は期間終了日と同じ日を指定します。
期間開始日のみ指定時は指定日以降全てが対象となります。

※現在この項目は利用できません
UsePointFixDateTo (YYYYMMDD) 8byte(固定) 利用ポイント確定日(To) 利用ポイント確定日の期間終了日。特定の日付のみ指定する場合は開始日と同じ日を指定します。
期間終了日のみ指定時は指定日以前全てが対象となります。

※現在この項目は利用できません
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(最大) 複数発売日あり

※1 OrderID、 OrderTime いずれか必須です。
※2 OrderIDを指定しない場合、OrderTime、OrderTimeFrom、OrderTimeTo いずれか必須です。
※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」

- 取得情報(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
DeviceType 1 : PC
2 : ガラケー
3 : スマートフォン
4 : タブレット
1byte固定 デバイス情報 1=PC,2=ガラケー,・・スマフォ,アプリ 等、固定はどのカートから入ってきたかで定義します。
IsActive false : 無効注文
true : 有効注文
5byte(最大) 注文有効フラグ 有効な注文として扱うか判定するフラグです。
※現在この項目は利用できません
IsSeen false : 未閲覧
true : 閲覧済
5byte(最大) 閲覧済みフラグ
IsSplit false : 未分割
true : 分割済
5byte(最大) 分割フラグ
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+09:00)
(例)2012-04-19T16:10:40+09:00
25byte(固定) 注文日時 注文確定ボタン押下時
落札時(=操作日時)
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:ドコモケータイ払い
payment_a10:auかんたん決済
payment_a11:ソフトバンクまとめて支払い
payment_a15:ペイジー
payment_a16:Yahoo!マネー/預金払い
payment_b[1-6]:銀行振込(名称はストアの自由設定)
payment_c1:ゆうちょ銀行(前払い)
payment_c2:ゆうちょ銀行(後払い)
payment_c3:現金書留
payment_d1:商品代引
payment_e[1-15]:ストアの自由なお支払い方法名
payment_z1:ポイント全額払い
PayMethodName (文字列)
支払方法
150byte最大) 支払い方法名称 お支払方法と別に名称を持ちます。Yahoo!決済名称、銀行振込の銀行名、ゆうちょなど。
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の配送設定順。
ShipRequestDate (YYYY-MM-DD) 10byte(固定) 配送希望日 配送希望日です。
ShipRequestTime (文字列) 13byte(最大) 配送希望時間 12:00~14:00など
ShipNotes (文字列) 500byte(最大) 配送メモ 注文管理ツールで入力された出荷の配送希望メモ入力内容です。
ShipInvoiceNumber1 (文字列) 30byte(最大) 配送伝票番号1 注文管理ツールでセラーが入力、アップロードした配送会社の配送伝票番号。注文管理ツールの画面上は1と2があります。
ShipInvoiceNumber2 (文字列) 30byte(最大) 配送伝票番号2 注文管理ツールでセラーが入力、アップロードした配送会社の配送伝票番号。注文管理ツールの画面上は1と2があります。
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(最大) 値引き 値引き
UsePoint (数値) 10byte(最大) 利用ポイント数
TotalPrice (数値) 15byte(最大) 合計金額 小計 - 利用ポイント + ギフト包装料 + 手数料 - 値引き + 送料
RefundTotalPrice (数値) 15byte(最大) 返金合計金額 注文キャンセル後取得可能
UsePointType Y : Yahoo!ポイント
T : Tポイント
1byte(固定) 利用ポイント種別 利用ポイントの種別です。
(Yahoo!ポイント/Tポイント)
UsePointFixDate (YYYY-MM-DD) 10byte(固定) 利用ポイント確定日 利用確定予定日
※現在この項目は利用できません
IsUsePointFix false : 未確定
true : 確定済
5byte(最大) 利用ポイント確定有無 利用ポイントが確定処理を完了したかどうかを示します。
※現在この項目は利用できません
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(最大) 代金支払い管理注文
ExistMultiReleaseDate false : 発売日1つ以下
true : 2つ以上
5byte(最大) 複数発売日あり
ShipUrl (文字列) 100byte(最大) 配送会社URL
ShipMethodName (文字列) 150byte(最大) 配送方法名
ArrivalDate (YYYY-MM-DD) 10byte(固定) 着荷日
TotalMallCouponDiscount (数値) 15byte(固定) モールクーポン値引き額

※こちらのAPIはYahoo! ID連携に対応したAPIです。
Yahoo! ID連携によるAPIアクセス方法の詳細は、以下のページをご確認ください。
Yahoo! ID連携
Yahoo! ID連携によるAPIアクセス実装方法

※こちらの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週間延長することができます。詳しくはこちらをご確認ください。


サンプルリクエスト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>
   <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>
  </Condition>
  <Field>OrderId,Version</Field>
 </Search>
 <SellerId>testseller</SellerId>
</Req>



レスポンスフィールド

フィールド 説明
/Result -
/Result/Status 処理結果
OK : 成功
NG : 失敗
/Result/Search 検索結果
/Result/Search/TotalCount 全件数
/Result/Search/OrderInfo 注文情報
/Result/Search/OrderInfo/Index 行番号
/Result/Search/OrderInfo/(取得情報キー) 取得情報値
/Result/Search/OrderInfo/Item (取得情報に商品情報が指定された時のみです。)
/Result/Search/OrderInfo/Item(取得情報キー) 取得情報値(商品情報)
/Result/Error エラー情報(エラー時のみ)
/Result/Error/Code エラーコード
/Result/Error/Message エラーメッセージ

取得情報で取得される情報はリクエストパラメータの取得情報(Field)に指定した情報です。




サンプルレスポンス

<!--・サンプル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>
        </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>



エラー

注文検索APIはYahoo! JAPAN Web APIに共通のエラーメッセージおよびコードを返します。

・エラーコード

コード HTTPステータスコード 説明
od90101 400 リクエストパラメータエラーです。
od91801 404 注文ID FromTo検索において、存在しない注文IDが指定された場合です。
備考 Detailへ存在しない注文IDを,区切りで返します。
od91001 500 サーバトラブル等です。
od91902 404 メンテナンスエラー




利用制限

※システムに負荷がかかっている場合、リアルタイムに注文情報を取得できないことがございます
※短い時間の間に同一URLに大量にアクセスを行った場合、一定時間利用できなくなることもございます。(1クエリー/秒)
※大規模なサイト構築やアプリ開発等にご利用いただけるデベロッパー様や、法人様向けに、クエリー数制限/秒を解除させていただきます。(無料)
まずはヘルプページのお問い合わせフォームからご相談ください。

利用約款

このAPIに関する利用約款はこちら