ショッピング

注文詳細API

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


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

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

注文情報を単体で取得する機能を提供します。

リクエストパラメータ

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

パラメータ 説明
/Req
/Req/Target
/Req/Target/OrderId
(必須)
string orderID 文字列
/Req/Target/Field
(必須)
string レスポンスに含めるfiledをカンマ区切りにします。
/Req/SellerId
(必須)
string ストアアカウントを指定します。


- 取得可能項目 : (文字列)、10000byte(最大)
分類 キー名 項目 最大長 内容
注文 OrderId 注文ID (^[a-zA-Z0-9-]+$) 50byte(最大) 注文ID
Version バージョン (数値) 2byte(最大) ショッピングカートや、注文APIのIF仕様のバージョンです。
ParentOrderId 分割元注文ID (^[a-zA-Z0-9-]+$) 50byte(最大) 注文分割した際の分割元注文IDです。
(一番元となる受注時注文IDとは違う場合があります)
ex)注文Aを注文B、注文Cに分割
  注文Cを注文D、注文Eに分割
  注文B、Cの分割元注文IDはA
  注文D、Eの分割元注文IDはC
ChildOrderId 分割後注文ID ^[a-zA-Z0-9-]+$形式の注文ID2つを半角カンマ「,」で結合 101byte(最大) 分割後の注文ID(2つ)です。注文分割済みの注文のみに存在します。
DeviceType デバイス種別 1 : PC
2 : MB
3 : スマートフォン
4 : タブレット
1byte固定 1=PC,2=MB,3=スマフォ,4=タブレット
MobileCarrierName 携帯キャリア名 docomo
au
softbank
other
8byte(最大) 携帯キャリアの種別です。
IsActive 注文有効フラグ false : 無効注文
true : 有効注文
5byte(最大) 有効な注文として扱うか判定するフラグです。
※現在この項目は利用できません
IsSeen 閲覧済みフラグ false : 未閲覧
true : 閲覧済
5byte(最大)
IsSplit 分割フラグ false : 未分割
true : 分割済
5byte(最大)
CancelReason キャンセル理由 (数値) 3byte(最大) ■注文者都合
100:キャンセル
110:返品
120:未入金
130:住所不明
140:受け取り拒否
150連絡不通
160重複注文
170決済審査不可
180その他

■ストア都合
200:決済方法都合
210:欠品
220:販売中止
230:その他

■その他
0:キャンセル理由該当なしシステムキャンセル

空欄:10/14日より前の注文、キャンセルではない
IsRoyalty ロイヤルティフラグ false : ロイヤルティ対象外
true : ロイヤルティ対象
5byte(最大) 課金していいかどうかの判定です。 (テスト注文かどうかの判定となります。)
IsRoyaltyFix ロイヤルティ確定フラグ false : ロイヤルティ未確定
true : ロイヤルティ確定済
5byte(最大) 課金が確定しているかどうかの判定です。
IsSeller 管理者注文フラグ false : 非管理者注文
true : 管理者注文
5byte(最大) ストア自身が自分の店舗で購入テストをおこなう際に設定されます。
IsAffiliate アフィリエイトフラグ false : 非アフィリエイト経由注文
true : アフィリエイト経由注文
5byte(最大) アフィリエイト経由の注文かどうかの判定です。
IsRatingB2s 評価フラグ(Buyer⇒Seller) false : 未評価
true : 評価済
5byte(最大) 購入者がストア評価を実施済みかどうかの判定です。
NeedSnl SNLオプトイン false:ストアニュースレター不要
true:ストアニュースレター必要
5byte(最大) ストアニュースレターのオプトインフラグです。
OrderTime 注文日時 (YYYY-MM-DDTHH24:MI:SS+09:00)
(例)2012-04-19T16:10:40+09:00
25byte(固定) 注文が行われた日時(ショッピングカートにて注文確定ボタンを押下した日時)です。
LastUpdateTime 最終更新日時 (YYYY-MM-DDTHH24:MI:SS+09:00)
(例)2012-04-19T16:10:40+09:00
25byte(固定) 注文情報の最終更新日時です。
Suspect いたずらフラグ 0 : 非いたずら注文
1 : いたずら注文
2 : いたずら解除済注文
1byte(固定) いたずら注文の疑いがある注文を判定する情報です。
SuspectMessage いたずらメッセージ (文字列) 99byte(最大) いたずら注文として判定された際のメッセージです。
OrderStatus 注文ステータス 1 : 予約中
2 : 処理中
3 : 保留
4 : キャンセル
5 : 完了
1byte(固定) 1 : 予約中
2 : 処理中
3 : 保留
4 : キャンセル
5 :  完了

※閲覧済みフラグとセットで閲覧していない予約中を「新規予約」、閲覧していない処理中を「新規注文」として扱います。
StoreStatus ストアステータス 数値 2byte(最大) ストアが独自に注文情報に設定可能なステータスです。
RoyaltyFixTime ロイヤルティ確定日時 (YYYY-MM-DDTHH24:MI:SS+09:00)
(例)2012-04-19T16:10:40+09:00
25byte(固定) 課金確定した日時です。
SendConfirmTime 注文確認メール送信時刻 (YYYY-MM-DDTHH24:MI:SS+09:00)
(例)2012-04-19T16:10:40+09:00
25byte(固定) 受注が新規に入った際に送られる注文確認メールの送信日時です。
SendPayTime 支払完了メール送信時刻 (YYYY-MM-DDTHH24:MI:SS+09:00)
(例)2012-04-19T16:10:40+09:00
25byte(固定) 決済時に送られるメール送信日時です。
PrintSlipTime 注文伝票出力時刻 (YYYY-MM-DDTHH24:MI:SS+09:00)
(例)2012-04-19T16:10:40+09:00
25byte(固定) 注文伝票を出力した日時です。
PrintDeliveryTime 納品書出力時刻 (YYYY-MM-DDTHH24:MI:SS+09:00)
(例)2012-04-19T16:10:40+09:00
25byte(固定) 納品書を出力した日時です。
PrintBillTime 請求書出力時刻 (YYYY-MM-DDTHH24:MI:SS+09:00)
(例)2012-04-19T16:10:40+09:00
25byte(固定) 請求書を出力した日時です。
BuyerComments バイヤーコメント (文字列)
(お届け情報入力フォームのメッセージフィールドを参考)
750byte(最大) ご要望欄入力内容です。
SellerComments セラーコメント (文字列) 750byte(最大) ストアがカートに表示しているコメント文字列です。
Notes ストア内メモ (文字列) 40000byte(最大) 注文管理ツールでストアが入力した時のストア内メモです。
OperationUser 更新者 (文字列) 60byte(最大) 更新作業を行ったYahoo!JAPANビジネスIDの登録氏名です。
バッチ等ユーザ操作以外の更新時は“system”となります。
Referer 参照元URL(リファラー) (文字列) 500byte(最大) ドメイン、検索キーワード等を網羅したリファラー情報です。
EntryPoint 入力ポイント (文字列) 1000byte(最大) 購入者が対象ストアにどこから入ったか、入ったストアページのURLです。
Clink 調査用リンク (文字列) 500byte(最大) ストアがヤフーの業務ツールにて設定したアクセス集計用の調査用リンクです。
※現在この項目は利用できません
HistoryId 履歴ID (数値) 3byte(最大) 注文の更新履歴を管理するIDです。
UsageId クーポン利用ID (数値) 10byte(最大) クーポン利用ID
※「UsageId」は1注文につき1つ必ず発行されるユニークのIDで、その注文で利用したクーポン情報と紐付いています。ただしクーポンIDを扱っているものではありません。
UseCouponData 使用したクーポン情報 クーポンID\Aクーポン名\Aクーポン種別\Aクーポンカテゴリ\A利用枚数\BクーポンID\Aクーポン名\Aクーポン種別\Aクーポンカテゴリ\A利用枚数 10000byte(最大) その注文で利用したクーポンIDを扱っておりクーポン情報の詳細情報を取得します。
※クーポン種別によらずクーポンを利用した注文であれば常にデータが入ります。
※\A、\Bは文字列です。
※UseCouponDataやUseCouponDataを分割する際は、\A,\Bを利用して分割する必要があります。
TotalCouponDiscount クーポン合計値引き額 (数値) 15byte(最大) 1つの注文に紐づくすべての商品のストアクーポンで値引きされる金額の内、送料以外の値引き合計値となります。
※Item.CouponDiscountの合計値と一致します。
※TotalCouponDiscountはストアクーポン利用の場合注文時に計算された値が入るのに対してDetail.Discountは注文後にストアクリエイターPro上で値引き欄に入力した値が入ります。
ShippingCouponFlg 送料無料クーポン利用有無 (数値) 1byte(固定) 送料無料クーポン利用有無です。
0 : なし
1 : あり 
ShippingCouponDiscount 送料無料クーポンを適用したときの送料の値引き額 (数値) 10byte(最大) 送料無料クーポンを適用したときの送料の値引き額です。ストアクーポンで値引きされる金額の内、送料のみの値引き合計値となります。
CampaignPoints 後付与ポイント内訳 100,200,300,400 100Byte カンマ区切りで後付与ポイント内訳が並びます※20151118より利用可能
請求 PayStatus 入金ステータス 0 : 未入金
1 : 入金済
1byte(固定) 受注、支払時に支払方法毎に設定されます。
0 : 入金待ち
1 : 入金済み
SettleStatus 決済ステータス 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 支払い分類 0 : 後払い
1 : 前払い
1byte(固定) お支払方法分類です。
前払い、後払いを判定します。
PayKind 支払い種別 0 : カード
1 : ネットバンキング
2 : キャリア決済
3 : 振込
4 : 代引
5 : コンビニ
6 : 電子マネー
7 : その他
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!決済名称、銀行振込の銀行名、ゆうちょ、などの名称を持ちます。
SellerHandlingCharge ストア負担決済手数料 (数値) 6byte(最大) ストア負担の決済手数料です。
PayActionTime 支払い日時 (YYYY-MM-DDTHH24:MI:SS+09:00)
(例)2012-04-19T16:10:40+09:00
25byte(固定) 購入履歴詳細画面 支払更新日時です。
PayDate 入金日 (YYYY-MM-DD) 10byte(固定) 注文管理ツールで入力された入金日です。
PayNotes 入金処理備考 (文字列) 1000byte(最大) 注文管理ツールで入力された入金の備考欄の内容です。
SettleId 決済ID (英数字ASCII文字)
英数字ASCII文字
英文字は小文字
38byte(最大) 決済IDです。
CardBrand カード種別 (文字列) 297byte(最大) クレジットカードの場合のカードブランド名(VISA等)です。
※Yahoo!ウォレット登録のクレジットカード決済時のみ表示します。
CardNumber クレジットカード番号 (文字列) 496byte(最大) 独自加盟店契約のストアのみ利用可能です。暗号化された文字列情報が取得できます。
CardNumberLast4 カード番号下4けた (\d{4}) 4byte(固定) クレジットカード下4けたです。
CardExpireYear カード有効期限(年) (YYYY) 4byte(固定) 独自加盟店契約のストアのみ利用可能です。暗号化された文字列情報が取得できます。
CardExpireMonth カード有効期限(月) (MM) 2byte(固定) 独自加盟店契約のストアのみ利用可能です。暗号化された文字列情報が取得できます。
CardPayType カード支払い区分 1 : 一括払い
2 : ボーナス一括払い
3 : リボ払い
4 : 分割払い
1byte(固定) 1 : 一括払い
2 : ボーナス一括払い
3 : リボ払い
4 : 分割払い
※注文完了段階ではありません。
CardHolderName カード名義人姓名(独自カード用) (文字列) 594byte(最大) 独自加盟店契約のストアのみ利用可能です。暗号化された文字列情報が取得できます。
CardPayCount カード支払回数 (数値) 3byte(最大) CardPayTypeが分割払いの際の支払い回数です。
CardBirthDay カード生年月日 8byte(固定) 独自加盟店契約のストアのみ利用可能です。暗号化された文字列情報が取得できます。
UseYahooCard Yahoo!カード利用有無 false : Yahoo!カード利用無し
true : Yahoo!カード利用有り
5byte(最大) 支払にYahoo!カードを利用した注文フラグです。
UseWallet ウォレット利用有無 false : Wallet利用無し
true : Wallet利用有り
5byte(最大) 支払にYahoo!ウォレット登録のクレジットカードを利用した注文フラグです。
NeedBillSlip 請求書有無 キーなし : カートに設定なし
false : 請求書不要
true : 請求書必要
(数値) 購入者が入力した注文時の請求書希望の有無です。
NeedDetailedSlip 明細書有無 キーなし : カートに設定なし
false : 明細書不要
true : 明細書必要
(数値) 購入者が入力した注文時の希望明細書の有無です。
伝票画面上では、「納品書」表記します。
帳票出力でも「納品書」出力で、「明細書」が出力可能です。
NeedReceipt 領収書有無 キーなし : カートに設定なし
false : 領袖書不要
true : 領袖書必要
(数値) 購入者が入力した注文時の領収書の有無です。
AgeConfirmField 年齢確認フィールド名 (文字列)
(お届け情報入力フォーム設定のチェックボックスの名前欄を参考)
20byte(最大) 年齢確認フィールドにストアが設定したフィールド名です。
AgeConfirmValue 年齢確認入力値 (数値)
(カートの年齢確認入力欄を参考)
3byte(最大) 年齢確認フィールド数値入力がある場合です。
AgeConfirmCheck 年齢確認チェック有無 false : チェック無し
true : チェック有り
5byte(最大) 年齢確認チェックボックスがある場合です。
BillAddressFrom ご請求先住所引用元 P : UDB自宅住所 
B : UDB勤務先住所
ship : お届け先と同じ
O1:その他1
O2:その他2
O3:その他3
O4:その他4
O : その他で入力 
4byte(最大) ラジオボタンチェック値です。
UPS自宅
勤務先
その他
お届け先と同じ
BillFirstName ご請求先名前 (文字列) 297byte(最大) ご請求先名前
BillFirstNameKana ご請求先名前カナ (文字列) 297byte(最大) ご請求先名前(フリガナ)
BillLastName ご請求先名字 (文字列) 297byte(最大) ご請求先名字
BillLastNameKana ご請求先名字カナ (文字列) 297byte(最大) ご請求先名字(フリガナ)
BillZipCode ご請求先郵便番号 (文字列) 10byte(最大) ご請求先郵便番号
BillPrefecture ご請求先都道府県 (文字列) 12byte(最大) ご請求先都道府県
海外の場合「その他」が入ります。
BillPrefectureKana ご請求先都道府県フリガナ (文字列) 18byte(最大) ご請求先都道府県フリガナ
BillCity ご請求先市区郡 (文字列) 297byte(最大) ご請求先市区郡
BillCityKana ご請求先市区郡フリガナ (文字列) 297byte(最大) ご請求先市区郡フリガナ
BillAddress1 ご請求先住所1 (文字列) 297byte(最大) ご請求先住所1
BillAddress1Kana ご請求先住所1フリガナ (文字列) 297byte(最大) ご請求先住所1フリガナ
BillAddress2 ご請求先住所2 (文字列) 297byte(最大) ご請求先住所2
BillAddress2Kana ご請求先住所2フリガナ (文字列) 297byte(最大) ご請求先住所2フリガナ
BillPhoneNumber ご請求先電話番号 (文字列) 14byte(最大) ご請求先電話番号
BillEmgPhoneNumber ご請求先電話番号(緊急) (文字列) 14byte(最大) ご請求先電話番号(緊急)
BillMailAddress ご請求先メールアドレス (文字列) 99文字(最大) 購入者の入力したメールアドレスです。Wallet利用の場合でかつ追加メールアドレス欄に入力がある場合は追加メールアドレスを入れます。
BillSection1Field ご請求先所属1フィールド名 (文字列) 297byte(最大) ご請求先所属1フィールド名
BillSection1Value ご請求先所属1入力情報 (文字列) 297byte(最大) ご請求先所属1入力情報
BillSection2Field ご請求先所属2フィールド名 (文字列) 297byte(最大) ご請求先所属2フィールド名
BillSection2Value ご請求先所属2入力情報 (文字列) 297byte(最大) ご請求先所属2入力情報
PayNo 支払番号 (文字列) 20byte(最大) 支払番号
PayNoIssueDate 支払番号発行日時 (YYYY-MM-DDTHH24:MI:SS+09:00)
(例)2012-04-19T16:10:40+09:00
25byte(固定) 支払番号発行日時
ConfirmNumber 確認番号 (文字列) 20byte(最大) 確認番号
PaymentTerm 支払期限日時 (YYYY-MM-DDTHH24:MI:SS+09:00)
(例)2012-04-19T16:10:40+09:00
25byte(固定) コンビニ決済、モバイルSuica決済、ペイジー決済での支払い期限です。
配送 ShipStatus 出荷ステータス 0 : 出荷不可
1 : 出荷可
2 : 出荷処理中
3 : 出荷完了
4 : 着荷完了
1byte(固定) 支払方法によって「出荷不可」か「出荷可」とし、注文受付時に判定します。
ShipMethod 配送方法 (文字列)
postageN
9byte(最大) お届け方法番号:postage1-14,16のどれか1つ(postage15は欠番)
ストアクリエイターProの配送設定順。
ShipMethodName 配送方法名称 (文字列) 150byte(最大) ヤマト運輸など、お届け方法名称です。
Keyと名称のセットはストア登録内容になります。
ShipRequestDate 配送希望日 (YYYY-MM-DD)  10byte(固定) 配送希望日です。
ShipRequestTime 配送希望時間 (文字列) 13byte(最大) 12:00~14:00など
ShipNotes 配送メモ (文字列) 500byte(最大) 注文管理ツールで入力された出荷の配送希望メモの入力内容です。
ShipInvoiceNumber1 配送伝票番号1 (文字列) 30byte(最大) ストアがツールやAPIで設定した、配送会社の配送伝票番号情報です。
ShipInvoiceNumber2 配送伝票番号2 (文字列) 30byte(最大) ストアがツールやAPIで設定した、配送会社の配送伝票番号情報です。
ShipUrl 配送会社URL (文字列) 100byte(最大) ストアがツールやAPIで設定した、配送会社の追跡URLです。
ArriveType きょうつく、あすつく 0 : 通常 
1 : きょうつく注文
2 : あすつく注文
1byte(固定) きょうつく注文、あすつく注文の場合設定します。
ShipDate 出荷日 (YYYY-MM-DD) 10byte(固定) ツールやAPIで入力された出荷日です。
ArrivalDate 着荷日 (YYYY-MM-DD) 10byte(固定) ツールやAPIで入力された着荷日です。
IsCashOnDelivery 送料着払いフラグ false : 送料着払いではない
true : 送料着払い
5byte(最大) 送料着払いの場合たつフラグです。
※現在この項目は利用できません
NeedGiftWrap ギフト包装有無 キーなし : カートに設定なし
false : ギフト包装無し
true : ギフト包装有り
5byte(最大) ギフト包装の有無
GiftWrapType ギフト包装種類 (文字列) 30byte(最大) ギフト包装の種類
GiftWrapMessage ギフトメッセージ (文字列) 297byte(最大)
NeedGiftWrapPaper のし有無 false : のし無し
true : のし有り
キーなし : カートに設定なし
(数値) のしの有無
GiftWrapPaperType のし種類 (文字列) 30byte(最大) のし(種類)
GiftWrapName 名入れ (文字列) 297byte(最大) 名入れ(メッセージ)
Option1Field オプションフィールドキー情報(フィールド名) (文字列) 150byte(最大) オプションフィールドフィールド名
Option1Type オプションフィールドキー情報(設定) キー無し
0 : テキストボックス(全角10文字まで)
1 : テキストボックス(全角50文字まで)
2 : テキストボックス(全角250文字まで)
3 : プルダウン
4 : ラジオボタン
5 : チェックボックス
1byte(最大) オプションフィールドフィールドデータ
テキストボックス1、2
テキストボックス3
プルダウン
ラジオボタン
チェックボックス
Option1Value オプションフィールド入力内容 (文字列) 1500byte(最大) オプションフィールド入力内容
Option2Field オプションフィールドキー情報(フィールド名) (文字列) 150byte(最大) オプションフィールドフィールド名
Option2Type オプションフィールドキー情報(設定) キー無し
0 : テキストボックス(全角10文字まで)
1 : テキストボックス(全角50文字まで)
2 : テキストボックス(全角250文字まで)
3 : プルダウン
4 : ラジオボタン
5 : チェックボックス
1byte(最大) オプションフィールドフィールドデータ
テキストボックス1、2
テキストボックス3
プルダウン
ラジオボタン
チェックボックス
Option2Value オプションフィールド入力内容 (文字列) 1500byte(最大) オプションフィールド入力内容
ShipFirstName お届け先名前 (文字列) 297byte(最大) お届け先名前
ShipFirstNameKana お届け先名前カナ (文字列) 297byte(最大) お届け先名前(フリガナ)
ShipLastName お届け先名字 (文字列) 297byte(最大) お届け先名字
ShipLastNameKana お届け先名字カナ (文字列) 297byte(最大) お届け先名字(フリガナ)
ShipZipCode お届け先郵便番号 (文字列) 10byte(最大) お届け先郵便番号
ShipPrefecture お届け先都道府県 (文字列) 12byte(最大) お届け先都道府県
海外の場合「その他」が入ります。
ShipPrefectureKana お届け先都道府県カナ (文字列) 18byte(最大) お届け先都道府県フリガナ
ShipCity お届け先市区郡 (文字列) 297byte(最大) お届け先市区郡
ShipCityKana お届け先市区郡フリガナ (文字列) 297byte(最大) お届け先市区郡フリガナ
ShipAddress1 お届け先住所1 (文字列) 297byte(最大) お届け先住所1
ShipAddress1Kana お届け先住所1フリガナ (文字列) 297byte(最大) お届け先住所1フリガナ
ShipAddress2 お届け先住所2 (文字列) 297byte(最大) お届け先住所2
ShipAddress2Kana お届け先住所2フリガナ (文字列) 297byte(最大) お届け先住所2フリガナ
ShipPhoneNumber お届け先電話番号 (文字列) 14byte(最大) お届け先電話番号
ShipEmgPhoneNumber お届け先緊急連絡先 (文字列) 14byte(最大) お届け先電話番号(緊急)
ShipSection1Field お届け先所属1フィールド名 (文字列) 297byte(最大) お届け先所属1フィールド名
ShipSection1Value お届け先所属1値 (文字列) 297byte(最大) お届け先所属1入力情報
ShipSection2Field お届け先所属2フィールド名 (文字列) 297byte(最大) お届け先所属2フィールド名
ShipSection2Value お届け先所属2値 (文字列) 297byte(最大) お届け先所属2入力情報
明細 PayCharge 手数料 (数値) 10byte(最大) ストアが設定した手数料(代引き手数料など)、Yahoo!決済の決済手数料は別です。
ShipCharge 送料 (数値) 10byte(最大) 送料(送料無料クーポン値引き後の金額)
GiftWrapCharge ギフト包装料 (数値) 10byte(最大) ギフト包装料
Discount 値引き (数値) 10byte(最大) 値引き
※クーポンの値引きではありません、ストア側が注文後にストアクリエイターPro上で値引き欄に入力した値が入ります。
Adjustments 調整額 (数値) 10byte(最大) 調整額
※マイナスの値も許容、その場合は -(10byte) が許容最大
SettleAmount 決済金額 (数値) 15byte(最大) 合計金額
※合計金額(TotalPrice)と同じ値になります。
UsePoint 利用ポイント数 (数値) 10byte(最大) 利用ポイント数
TotalPrice 合計金額 (数値) 15byte(最大) 小計 - 利用ポイント + ギフト包装料 + 手数料 - 値引き + 送料+ 調整額 - モールクーポン値引き額
SettlePayAmount 入金金額 (数値) 15byte(最大) 分割後注文には引き継ぎません。
元注文で確認させます。
TaxRatio 消費税率 (数値) 3byte(最大) 注文ごとの消費税率です。
UsePointFixDate 利用ポイント確定日 (YYYY-MM-DD) 10byte(固定) 付与確定予定日
※現在この項目は利用できません
IsUsePointFix 利用ポイント確定有無 false : 未確定
true : 確定済
5byte(最大) 利用ポイントの確定処理が完了したどうかを示します。
※現在この項目は利用できません
IsGetPointFixAll 全付与ポイント確定有無 false : 未確定
true : 確定済
5byte(最大) 全ライン(商品)の付与ポイントの確定処理が完了したかどうかを示します。
TotalMallCouponDiscount モールクーポン値引き額 (数値) 15byte(最大) モールクーポンで値引きされる額の合計値を示します。
商品 LineId 商品ラインID (数値) 2byte(最大) 商品ラインID
ItemId 商品ID (文字列) 228byte(最大) 商品ID
Title 商品名 (文字列) 225byte(最大) 商品タイトル
SubCode 商品サブコード (文字列) 99byte(最大) 商品サブコードが設定されている場合のみです。
SubCodeOption 商品サブコードオプション (文字列) 150byte最大) 商品サブコードオプションが設定されている場合のみです。
key&value両方
ItemOption 商品オプション <ItemOption>
 <Index>1</Index>
 <Name>オプション項目名1</Name>
 <Value>オプション値1</Value>
</ItemOption>
Index : 2byte(最大)
Name : 84byte(最大)
Value : 84byte(最大)
商品オプションが設定されている場合のみです。

※ItemOptionはInscriptionとあわせて20個までです。
Inscription インスクリプション <Inscription>
 <Index>1</Index>
 <Name>インスク1</Name>
 <Value>値1</Value>
</Inscription>
Index : 2byte(最大)
Name : 90byte(最大)
Value : 180byte(最大)
商品にインスクリプションが設定されている場合のみです。

※InscriptionはItemOptionとあわせて20個までです。
IsUsed 中古フラグ false : 中古ではない
true : 中古
5byte(最大) 中古商品かどうかを判定します。
ImageId 商品画像ID (文字列) 最大160byte 商品画像IDです。
IsTaxable 課税対象 false : 課税非対象
true : 課税対象
5byte(最大) 課税対象フラグ
Weight 重量 (数値)
0 : ~2 kg
4 : ~4 kg
5 : ~5 kg
6 : ~6 kg
8 : ~8 kg
10 : ~10 kg
11 : ~11 kg
12 : ~12 kg
14 : ~14 kg
15 : ~15 kg
16 : ~16 kg
18 : ~18 kg
20 : ~20 kg
21 : ~21 kg
25 : ~25 kg
30 : ~30 kg
99 : 30kg~ 
5byte(最大) 商品に重量が設定されている場合のみです。
梱包後の重量です。

※現在この項目は利用できません
Size サイズ 0 : ~60cm同梱可能(小物)
60 : ~60 cm
70 : ~70 cm
80 : ~80 cm
100 : ~100 cm
120 : ~120 cm
130 : ~130 cm
140 : ~140 cm
160 : ~160 cm
170 : ~170 cm
999 : 170cm~ 
3byte(最大) 商品にサイズが設定されている場合のみです。
梱包後の縦、横、高さの合計です。

※現在この項目は利用できません
Jan JANコード (文字列) 14byte(最大) JANコード
ProductId 製品コード (数値) 9byte(最大) 製品コード(品番/型番)
CategoryId プロダクトカテゴリID (数値) 12byte(最大) カテゴリコード
AffiliateRatio アフィリエイト料率 (数値)_(数値)
ストア負担料率_Yahoo!JAPAN負担料率
2つの数値をアンダースコアつなぎ
数値部分は 0.0~70.0
9byte(最大) ストア負担料率 5.5%、Yahoo!JAPAN負担料率 1%とした場合、5.5_1.0となります。
UnitPrice 商品単価 (数値) 10byte(最大) 商品ごとの単価(ストアクーポン値引き後の金額)
※値引き後の値となります
Quantity 数量 (数値) 3byte(最大) 商品ごとの数量です。
PointAvailQuantity ポイント対象数量 (数値) 3byte(最大) ポイント付与対象数量
ReleaseDate 発売日 (YYYY-MM-DD) 10byte(固定) 発売日の入力がある場合のみです。
発売日>注文日の場合、予約注文として扱います。
IsShippingFree 送料無料フラグ false : 送料有料
true : 送料無料
5byte(最大) 送料無料フラグ
IsReturnAccept 返品可否フラグ false : 返品不可
true : 返品可
5byte(最大) 返品可否フラグ
※現在この項目は利用できません
LocationPrefecture 商品発送元都道府県 (文字列) 99byte(最大) 商品発送元都道府県
※現在この項目は利用できません
LocationCity 商品発送元市区町村 (文字列) 99byte(最大) 商品発送元市区町村
※現在この項目は利用できません
HaveReview 商品レビュー有無フラグ false : レビュー無し
true : レビュー有り
5byte(最大)
IsCampaign キャンペーン対象フラグ false : キャンペーン対象外
true : キャンペーン対象
5byte(固定) 何らかのポイントキャンペーン対象となっている注文です。
※現在この項目は利用できません
PointFspCode 商品別ポイントコード (数値) 5byte(固定) 10001~10015、20001~20010
PointRatioY 付与ポイント倍率(Yahoo!JAPAN負担) (数値) 2byte(最大) 付与ポイントのYahoo!JAPAN負担倍率。
Yahoo!JAPANの負担が10倍であれば10が入ります。
PointRatioSeller 付与ポイント倍率(ストア負担) (数値) 2byte(最大) 付与ポイントのストア負担倍率です。
ストアが5倍負担であれば5が入ります。
UnitGetPoint 単位付与ポイント数 (数値) 10byte(最大) 商品1数量の付与ポイント数×数量でLine毎のポイント数
ポイント倍率をかけた値が入ります。
IsGetPointFix 付与ポイント確定フラグ false : 未確定
true : 確定済
5byte(最大)
GetPointFixDate 付与ポイント確定日 (YYYY-MM-DD) 10byte(固定) 注文日14日後、予約注文は発売日の14日後をセットします。
CouponData ストアクーポン クーポンID\Aクーポン名\Aクーポンカテゴリ\A利用枚数\BクーポンID\Aクーポン名\Aクーポンカテゴリ\A利用枚数 800byte(最大) ストアクーポンは全ラインに適用されます。
※\A、\Bは文字列
CouponDiscount クーポンの値引き額 (数値) 10byte(最大) クーポンの値引き額です。
CouponUseNum クーポン適用枚数 (数値) 3byte(最大) クーポン適用枚数です。
※商品クーポンのみ
OriginalPrice 値引き前の単価 (数値) 10byte(最大) 値引き前の単価です。
OriginalNum ライン分割前の数量 (数値) 3byte(最大) ライン分割前の数量です。
セラー SellerId セラーID (文字列) 128byte(最大) セラーID
バイヤー IsLogin Yahoo! JAPAN IDログイン有無 false : ゲスト
true : ログイン
5byte(最大) ログイン注文
FspLicenseCode FSPライセンスコード ■スタークラブの項目
「?」 : ゲスト
「ERR」 : 取得エラー
「1000」 : ランク外
「1100」 : レギュラー
「1200」 : ブロンズ
「1300」 : シルバー
「1400」 : ゴールド
「1500」 : プラチナ
■ストアスタンプラリー項目
項目なし : ゲスト
「ERR」 : 取得エラー
「2000」 : なし
「2100」 : ブロンズ
「2200」 : シルバー
「2300」 : ゴールド
「2400」 : プラチナ
「2500」 : ダイヤモンド
4byte(最大) スタークラブについての詳細は下記ページをご覧ください。
http://starclub.yahoo.co.jp/
FspLicenseName FSPライセンス名 ■スタークラブの項目
「?」 : ゲスト
「ERR」 : 取得エラー
「ランク外」 : ランク外
「レギュラー」 : レギュラー
「ブロンズ」 : ブロンズ
「シルバー」 : シルバー
「ゴールド」 : ゴールド
「プラチナ」 : プラチナ
■ストアスタンプラリー項目
項目なし : ゲスト
「ERR」 : 取得エラー
「なし」 : なし
「ブロンズ」 : ブロンズ
「シルバー」 : シルバー
「ゴールド」 : ゴールド
「プラチナ」 : プラチナ
「ダイヤモン」 : ダイヤモンド
15byte(最大) スタークラブについての詳細は下記ページをご覧ください。
http://starclub.yahoo.co.jp/
GuestAuthId ゲストユニークキー(vwoidc) (文字列) 20byte(固定) ゲスト注文の場合のみです。

※こちらの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/orderInfo

サンプルリクエスト

POST /ShoppingWebService/V1/orderInfo HTTP/1.1
Host: circus.shopping.yahooapis.jp
Authorization: Bearer <アクセストークン>

<Req>
 <Target>
  <OrderId>testseller-10000001</OrderId>
  <Field>PayStatus,SettleStatus</Field>
 </Target>
 <SellerId>testseller</SellerId>
</Req>



レスポンスフィールド

フィールド 説明
/ResultSet クエリーレスポンスのすべてを含み、次の属性を持ちます。

  • totalResultsAvailable : 該当件数の総個数です。(常に0か1です。)
  • totalResultsReturned : 返却され、かつマッチした件数です。(常に0か1です。)
  • firstResultPosition : データの取得開始位置です。(常に0か1です。)

/ResultSet/Result 各個別レスポンスを含みます。
/ResultSet/Result/Status 取得成否(OK/NG)
/ResultSet/Result/OrderInfo 注文情報。次の属性を持ちます。

  • key : ※注文情報

/ResultSet/Result/OrderInfo/Pay 支払情報。次の属性を持ちます。

  • key : ※請求情報

/ResultSet/Result/OrderInfo/Ship お届情報。次の属性を持ちます。

  • key : ※配送情報

/ResultSet/Result/OrderInfo/Detail 明細情報。次の属性を持ちます。

  • key : ※配送情報

/ResultSet/Result/OrderInfo/Item 商品ライン情報。次の属性を持ちます。

  • key : ※商品情報

/ResultSet/Result/OrderInfo/Seller セラー情報。次の属性を持ちます。

  • key : ※セラー情報

/ResultSet/Result/OrderInfo/Buyer バイヤー情報。次の属性を持ちます。

  • key : ※バイヤー情報




サンプルレスポンス

<ResultSet totalResultsAvailable="1" totalResultsReturned="1" firstResultPosition="1">
  <Result>
    <Status>OK</Status>
    <OrderInfo>
      <OrderId>storename-10000001</OrderId>
      <ParentOrderId>storename-10000001</ParentOrderId>
      <DeviceType>3</DeviceType>
      <IsRoyaltyFix>true</IsRoyaltyFix>
      <IsAffiliate>false</IsAffiliate>
      <Referer><![CDATA[http://xxx.yyy.zzz/index.html]]></Referer>
      <Clink><![CDATA[バナー広告101111]]></Clink>
      <NeedSnl>true</NeedSnl>
      <NeedSnc>false</NeedSnc>
      <OrderTime>20121221231350</OrderTime>
      <IsActive>true</IsActive>
      <IsRoyaltyFix>false</IsRoyaltyFix>
      <RoyaltyFixTime></RoyaltyFixTime>
      <OrderStatus>2</OrderStatus>
      <StoreStatus>出荷待ち</StoreStatus>
      <SendConfirmTime>20121221231357</SendConfirmTime>
      <SendInputTime></SendInputTime>
      <SendPayTime></SendPayTime>
      <IsRatingB2S>false</IsRatingB2S>
      <Pay>
        <PayStatus>1</PayStatus>
        <SettleStatus>0000</SettleStatus>
        <PayMethod>card</PayMethod>
        <PayMethodName><![CDATA[クレジットカード決済]]></PayMethodName>
        <PayDate>20121222</PayDate>
        <PayNotes><![CDATA[確認済み]]></PayNotes>
        <SettleId>c01112255289</SettleId>
        <CardBrand><![CDATA[VISA]]></CardBrand>
        <CardNumberLast4>0003</CardNumberLast4>
        <CardPayType>4</CardPayType>
        <BankName></BankName>
        <BankBranchName></BankBranchName>
        <BankAccountNumber></BankAccountNumber>
        <BankAccountName></BankAccountName>
        <NeedBillSlip>true</NeedBillSlip>
		<NeedBillSlip>true</NeedBillSlip>
        <NeedDetailedSlip>true</NeedDetailedSlip>
        <NeedReceipt>true</NeedReceipt>
        <AgeConfirmField><![CDATA[私は20歳以上です]]></AgeConfirmField>
        <AgeConfirmValue></AgeConfirmValue>
        <AgeConfirmCheck>true</AgeConfirmCheck>
        <BillFirstName><![CDATA[太郎]]></BillFirstName>
        <BillFirstNameKana><![CDATA[タロウ]]></BillFirstNameKana>
        <BillLastName><![CDATA[矢風]]></BillLastName>
        <BillLastNameKana><![CDATA[ヤフー]]></BillLastNameKana>
        <BillZipCode><![CDATA[111-2222]]></BillZipCode>
        <BillPrefecture><![CDATA[東京都]]></BillPrefecture>
        <BillPrefectureKana><![CDATA[トウキョウト]]></BillPrefectureKana>
        <BillCity><![CDATA[墨田区]]></BillCity>
        <BillCityKana><![CDATA[スミダク]]></BillCityKana>
        <BillAddress1><![CDATA[石原9-99-999]]></BillAddress1>
        <BillAddress1Kana><![CDATA[イシワラ9-99-999]]></BillAddress1Kana>
        <BillAddress2><![CDATA[矢風マンション]]></BillAddress2>
        <BillAddress2Kana><![CDATA[ヤフーマンション]]></BillAddress2Kana>
        <BillPhoneNumber><![CDATA[012-3456-7890]]></BillPhoneNumber>
        <BillEmgPhoneNumber><![CDATA[123-4567-8901]]></BillEmgPhoneNumber>
        <BillMailAddress><![CDATA[testbuyer@yahoo.co.jp]]></BillMailAddress>
      </Pay>
      <Ship>
        <ShipStatus>1</ShipStatus>
        <ShipMethod>宅急便</ShipMethod>
        <ShipMethodName><![CDATA[ヤマト運輸]]></ShipMethodName>
        <ShipRequestDate>20121225</ShipRequestDate>
        <ShipRequestTime><![CDATA[11:00~12:00]]></ShipRequestTime>
        <ShipNotes></ShipNotes>
        <ShipInvoiceNumber1></ShipInvoiceNumber1>
        <ShipInvoiceNumber2></ShipInvoiceNumber2>
        <ShipUrl></ShipUrl>
        <ShipDate></ShipDate>
        <NeedGiftWrap>true</NeedGiftWrap>
        <GiftWrapType><![CDATA[リボン]]></GiftWrapType>
        <GiftWrapMessage><![CDATA[おめでとう]]></GiftWrapMessage>
		       <NeedGiftWrapPaper>false</NeedGiftWrapPaper>
        <GiftWrapPaperType></GiftWrapPaperType>
        <GiftWrapName></GiftWrapName>
        <Option1Type>text</Option1Type>
        <Option1Field><![CDATA[お届け先の階数]]></Option1Field>
        <Option1Value><![CDATA[4階]]></Option1Value>
        <Option2Type>radio</Option2Type>
        <Option2Field><![CDATA[エレベーターの有無]]></Option2Field>
        <Option2Value><![CDATA[あり]]></Option2Value>
        <ShipFirstName><![CDATA[太郎]]></ShipFirstName>
        <ShipFirstNameKana><![CDATA[タロウ]]></ShipFirstNameKana>
        <ShipLastName><![CDATA[矢風]]></ShipLastName>
        <ShipLastNameKana><![CDATA[ヤフー]]></ShipLastNameKana>
        <ShipZipCode><![CDATA[111-2222]]></ShipZipCode>
        <ShipPrefecture><![CDATA[東京都]]></ShipPrefecture>
        <ShipPrefectureKana><![CDATA[トウキョウト]]></ShipPrefectureKana>
        <ShipCity><![CDATA[墨田区]]></ShipCity>
        <ShipCityKana><![CDATA[スミダク]]></ShipCityKana>
        <ShipAddress1><![CDATA[石原9-99-999]]></ShipAddress1>
        <ShipAddress1Kana><![CDATA[イシワラ9-99-999]]></ShipAddress1Kana>
        <ShipAddress2><![CDATA[矢風コーポ]]></ShipAddress2>
        <ShipAddress2Kana><![CDATA[ヤフーコーポ]]></ShipAddress2Kana>
        <ShipPhoneNumber><![CDATA[098-7654-3210]]></ShipPhoneNumber>
        <ShipEmgPhoneNumber><![CDATA[987-6543-2109]]></ShipEmgPhoneNumber>
      </Ship>
      <Detail>
        <PayCharge>320</PayCharge>
        <ShipCharge>525</ShipCharge>
        <GiftWrapCharge>100</GiftWrapCharge>
        <Discount>500</Discount>
        <TotalPrice>10500</TotalPrice>
        <SettleAmount>10500</SettleAmount>
        <UsePoint>0</UsePoint>
        <TotalMallCouponDiscount>100</TotalMallCouponDiscount>
      </Detail>
	  <Item>
        <LineId>1</LineId>
        <ItemId><![CDATA[item-n77]]></ItemId>
        <Title><![CDATA[商品名1]]></Title>
        <SubCode><![CDATA[4201]]></SubCode>
        <ItemOption></ItemOption>
        <UnitPrice>2700</UnitPrice>
        <Quantity>2</Quantity>
        <ReleaseDate></ReleaseDate>
        <HaveReview>false</HaveReview>
        <PointFspCode>1</PointFspCode>
        <UnitGetPoint>25</UnitGetPoint>
      </Item>
      <Item>
        <LineId>2</LineId>
        <ItemId><![CDATA[item-p09]]></ItemId>
        <Title><![CDATA[商品名2]]></Title>
        <ItemOption></ItemOption>
        <UnitPrice>100</UnitPrice>
        <Quantity>1</Quantity>
        <ReleaseDate></ReleaseDate>
        <HaveReview>false</HaveReview>
        <PointFspCode>1</PointFspCode>
        <UnitGetPoint>0</UnitGetPoint>
      </Item>
      <Seller>
        <SellerId>testseller</SellerId>
      </Seller>
      <Buyer>
        <FspLicenseName>ランク外</FspLicenseName>
      </Buyer>
    </OrderInfo>
  </Result>
</ResultSet>



エラー

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

・エラーコード

コード HTTPステータスコード 説明
od90101 400 リクエストパラメータエラーです。
od90802 401 GuestAuthId不一致エラーです。
od91008 500 注文DB読み込みエラーです。
od91801 404 指定されたorderIDが存在しません。
od91011 500 データ変換エラーです。
od91014 500 "取得可能項目"以外の項目指定エラーです。
od91050 - 【警告】個人情報取得エラーです。
※サンプルレスポンスは下記記載
od91902 404 メンテナンスエラー



サンプルワーニングレスポンス

<ResultSet totalResultsAvailable="1" totalResultsReturned="1" firstResultPosition="1">
 <ResultSet totalResultsAvailable="1" totalResultsReturned="1" firstResultPosition="1">
  <Result>
    <Warning>
      <Code>od91050</Code>
      <Message>OrderPersonalInfo Load Error</Message>
      <Detail />
    </Warning>
    <Status>OK</Status>
    <OrderInfo>
----------(略)----------
    </OrderInfo>
  </Result>
</ResultSet>



利用制限

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

利用約款

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