注文詳細API
注文情報の詳細を取得します。
(一回で取得できるのは1注文のみです)
変更履歴
2022年04月04日
リクエストパラメータから下記項目を削除しました。・CouponUseNum
2022年02月17日
PayMethodに「payment_a19:PayPayあと払い」を追加しました。
追加予定日:2022年02月28日(月)
2022年02月14日
「取得可能項目」から下記項目を削除しました。
・YahooAuctionRatingStatus(ヤフオク!評価の完了/未完了)
2021年12月24日
「取得可能項目」に下記項目を追加しました。
・ExcellentDelivery(優良配送フラグ)
2021年11月18日
「取得可能項目」に下記項目を追加しました。
・IsYahooAuctionDeferred(ヤフオク!購入後決済フラグ)
・YahooAuctionCategoryType(ヤフオク!カテゴリ種別)
・YahooAuctionBidType(ヤフオク!落札種別)
2021年09月01日
「取得可能項目」に下記項目を追加しました。
・IsYahooAuctionOrder(ヤフオク!併売フラグ)
・YahooAuctionMerchantId(ヤフオク!管理番号)
・YahooAuctionId(オークションID)
・YahooAuctionRatingStatus(ヤフオク!評価の完了/未完了)
2021年08月19日
サンプルレスポンスに下記2項目を追記しました。
・ShipInstructType(出荷指示区分)
・ShipInstructStatus(出荷指示ステータス)
2021年08月12日
取得可能項目に下記項目を追加します。・FraudHoldStatus(不正保留ステータス)
・PublicationTime(orderList公開日時)
追加予定日:2021年08月27日(金)
2021年05月07日
取得可能項目に下記項目を追加します。
・IsEazy(EAZY注文フラグ)
追加予定日:2021年05月18日(火)
利用申請について
本番環境について
注文APIを利用する場合は別途利用申請が必要です。下記フォームから申請をお願いします。
ショッピング注文API利用申請フォーム
テスト環境について
テスト用APIを利用する場合は、下記フォームから「テスト環境用」を指定して申請をお願いします。
アプリケーションID取得フォーム
※テスト環境に関しては別途注文APIの利用申請をしていただく必要はありません。
リクエストURL
リクエストパラメータ
「Web APIの使い方#POSTとは」をご参照ください。
パラメータ | 型 | 説明 | |||
---|---|---|---|---|---|
/Req | |||||
/Req/Target | |||||
/Req/Target/OrderId (必須) |
string | orderID 文字列 | |||
/Req/Target/Field (必須) |
string | レスポンスに含めるfiledをカンマ区切りにします。 | |||
/Req/SellerId (必須) |
string | ストアアカウントを指定します。 |
分類 | キー名 | 項目 | 型 | 最大長 | 内容 |
---|---|---|---|---|---|
注文 | 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(最大) | 携帯キャリアの種別です。 | |
true : 有効注文 |
※現在この項目は利用できません |
||||
IsSeen | 閲覧済みフラグ | false : 未閲覧 true : 閲覧済 |
5byte(最大) | ||
IsSplit | 分割フラグ | false : 未分割 true : 分割済 |
5byte(最大) | ||
CancelReason | キャンセル理由 | (数値) | 3byte(最大) |
■注文者都合 100:キャンセル 110:返品 120:未入金 130:住所不明 140:受け取り拒否 150:連絡不通 160:重複注文 170:決済審査不可 180:その他 300:間違えて注文した 310:ポイントを利用し忘れた 320:クーポンを利用し忘れた 330:他で安い価格をみつけた 340:送料が高かった 350:お届け先を変更したい 360:配送方法を変更したい 370:お支払い方法を変更したい 380:クレジットカードが利用できなかった ■ストア都合 200:決済方法都合 210:欠品 220:販売中止 230:その他 ■その他 0:キャンセル理由該当なしシステムキャンセル 空欄:キャンセルではない注文 |
|
CancelReasonDetail | キャンセル理由詳細 | (文字列) | 200文字(最大) | キャンセル理由がストア都合キャンセル「その他(230)」の場合、 ストアが入力した理由が表記されます。キャンセル理由230以外は空欄となります。 |
|
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(日本標準時) | 25byte(固定) | 注文が行われた日時(ショッピングカートにて注文確定ボタンを押下した日時)です。 (例)2012-04-19T16:10:40 |
|
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です。 | |
※現在この項目は利用できません |
|||||
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を分割する際は、\A,\Bを利用して分割する必要があります。 ※クーポン種別(値引きタイプ):1: 定額, 2: 定率, 3: 送料無料 |
|
TotalCouponDiscount | クーポン合計値引き額 | (数値) | 15byte(最大) | 1つの注文に紐づくすべての商品のストアクーポンで値引きされる金額の内、送料以外の値引き合計値となります。 ※Item.CouponDiscountの合計値と一致します。 ※TotalCouponDiscountはストアクーポン利用の場合注文時に計算された値が入るのに対してDetail.Discountは注文後にストアクリエイターPro上で値引き欄に入力した値が入ります。 |
|
ShippingCouponFlg | 送料無料クーポン利用有無 | (数値) | 1byte(固定) | 送料無料クーポン利用有無です。 0 : なし 1 : あり |
|
ShippingCouponDiscount | 送料無料クーポンを適用したときの送料の値引き額 | (数値) | 10byte(最大) | 送料無料クーポンを適用したときの送料の値引き額です。ストアクーポンで値引きされる金額の内、送料のみの値引き合計値となります。 | |
CampaignPoints | 後付与ポイント内訳 | {'V1' : {'yjcard':2, 'newapp3':'4;2'} | 200Byte | キャンペーン毎に管理ID、倍率、付与数の内容が並びます。 | |
IsMultiShip | 複数配送注文フラグ | false : 複数配送注文でない true : 複数配送注文) |
5Byte | ※2017/10/18より利用可能 ※本フィールドは、一部ストア限定機能です |
|
MultiShipId | 複数配送注文ID | (文字列) | 42Byte(固定) | 複数配送注文を識別するID ※2017/10/18より利用可能 ※本フィールドは、一部ストア限定機能です |
|
IsReadOnly | 読み取り専用 | (数値型) | 1Byte(固定) | 1:読み取り専用(キャンセル可能な10分間の場合) 0:読み書き可能(注文者からキャンセルができない状態) |
|
IsFirstClassDrugIncludes | 第1類医薬品フラグ | false、null:第1類医薬品を含まない注文 true:第1類医薬品を含む注文 |
5Byte(最大) | 第1類医薬品を含む注文か判定します。 | |
IsFirstClassDrugAgreement | 第1類医薬品承諾フラグ | false、null:未承諾 true:承諾済み |
5Byte(最大) | 第1類医薬品を含む注文の承諾状況を判定します。 | |
IsWelcomeGiftIncludes | 無料プレゼント(ウェルカムギフト)含有フラグ | false / true | 5Byte(最大) | false、null:無料プレゼント(ウェルカムギフト)を含まない注文 true:無料プレゼント(ウェルカムギフト)を含む注文 |
|
YamatoCoopStatus | ヤマト連携ステータス | null or 0 :対象外、未連携 1:連携受付 2:連携処理中 3:連携済 4:連携キャンセル |
1Byte | ※ヤマトピック&デリバリー専用項目 ヤマト運輸への連携がいまどのような状態かを示すステータスです。 「3:連携済」のみが連携が済んでいるステータスとなります。 |
|
FraudHoldStatus | 不正保留ステータス | 数値 | 1Byte | 0 or null:不正リスク低 1:ルール保留審査中 2:ルール保留解除 3:ルール悪用確定 |
|
PublicationTime | orderList公開日時 | YYYY-MM-DDTHH24:MI:SS(日本標準時) | 25byte(固定) | 不正保留解除時など、orderListから取得できるようになった時間がセットされます。 | |
IsYahooAuctionOrder | ヤフオク!併売フラグ | true:ヤフオク注文 false:ヤフオク注文以外 |
5byte(固定) | ヤフオク注文であるかの判定フラグ | |
YahooAuctionMerchantId | ヤフオク!管理番号 | (文字列)1234567890 ※下記の記号は使用可能 # & ( ) - < > . / _ |
20byte(固定) | ||
YahooAuctionId | オークションID | (文字列) y123456789 |
16byte(固定) | ||
IsYahooAuctionDeferred | ヤフオク!購入後決済フラグ | true:購入後決済(※入札・落札後、購入手続きする形式) false or null:購入後決済以外 |
5byte | ||
YahooAuctionCategoryType | ヤフオク!カテゴリ種別 | 0 or null:通常 1:自動車車体 2:バイク車体 |
1byte | ||
YahooAuctionBidType | ヤフオク!落札種別 | 0 or null:定額 1:競り(即決価格) 2:競り(通常) |
1byte | ||
請求 | 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_a17:PayPay残高払い payment_a19:PayPayあと払い 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! JAPAN JCBカード利用有無 | false : Yahoo! JAPAN JCBカード利用無し true : Yahoo! JAPAN JCBカード利用有り |
5byte(最大) | 支払にYahoo! JAPAN JCBカードを利用した注文フラグです。 ※「Yahoo! JAPANカード」を判定するフラグではありません。 また、「Yahoo! JAPANカード」を判定するフラグを返すAPIの提供はありません。 |
|
UseWallet | ウォレット利用有無 | false : Wallet利用無し true : Wallet利用有り |
5byte(最大) | 支払にYahoo!ウォレット登録のクレジットカードを利用した注文フラグです。 | |
NeedBillSlip | 請求書有無 | キーなし : カートに設定なし false : 請求書不要 true : 請求書必要 |
(数値) | 購入者が入力した注文時の請求書希望の有無です。 | |
NeedDetailedSlip | 明細書有無 | キーなし : カートに設定なし false : 明細書不要 true : 明細書必要 |
(数値) | 購入者が入力した注文時の希望明細書の有無です。 伝票画面上では、「納品書」表記します。 帳票出力でも「納品書」出力で、「明細書」が出力可能です。 |
|
NeedReceipt | 領収書有無 | キーなし : カートに設定なし false : 領袖書不要 true : 領袖書必要 |
(数値) | 購入者が入力した注文時の領収書の有無です。 | |
AgeConfirmField | 年齢確認フィールド名 | (文字列) (お届け情報入力フォーム設定のチェックボックスの名前欄を参考) |
30byte(最大) | 年齢確認フィールドにストアが設定したフィールド名です。 | |
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決済、ペイジー決済での支払い期限です。 | |
IsApplePay | ApplePay利用有無 | false:ApplePay利用無し true:ApplePay利用有り |
5byte(最大) | 支払にApplePayを利用した注文フラグです。 ※ ApplePay導入リリースで追加予定 |
|
配送 | 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(最大) | 注文管理ツールで入力された出荷の配送希望メモの入力内容です。 | |
ShipCompanyCode | 配送会社 | (数値) | 4byte(最大) | 配送会社コード 1000:その他 1001:ヤマト運輸 1002:佐川急便 1003:日本郵便 1004:西濃運輸 5001:店頭受け取り ※2018年10月以降の注文に関しては「4桁」、2018年9月までの注文は「3桁」で返却されます。 (一覧はこちら) |
|
ReceiveShopCode | 受取店舗コード | (文字列) | 50byte(最大) | ||
ShipInvoiceNumber1 | 配送伝票番号1 | (文字列) | 30byte(最大) | ストアがツールやAPIで設定した、配送会社の配送伝票番号情報です。 | |
ShipInvoiceNumber2 | 配送伝票番号2 | (文字列) | 30byte(最大) | ストアがツールやAPIで設定した、配送会社の配送伝票番号情報です。 | |
ShipInvoiceNumberEmptyReason | 伝票番号なし理由 | (文字列) | 3byte(最大) | NULL:(未登録の状態) 101:メーカ等の在庫元からの直送品のため 102:発送不要の商品のため 103:店頭受け取り商品のため 104:配送会社から直接ご連絡のため 105:伝票番号が発行されない(追跡できない)配送方法のため |
|
ShipUrl | 配送会社URL | (文字列) | 100byte(最大) | ストアがツールやAPIで設定した、配送会社の追跡URLです。 | |
ArriveType | きょうつく、あすつく | 0 : 通常 1 : きょうつく注文 2 : あすつく注文 |
1byte(固定) | きょうつく注文、あすつく注文の場合設定します。 | |
ShipDate | 出荷日 | (YYYY-MM-DD) | 10byte(固定) | ツールやAPIで入力された出荷日です。 | |
ArrivalDate | 着荷日 | (YYYY-MM-DD) | 10byte(固定) | ツールやAPIで入力された着荷日です。 | |
true : 送料着払い |
※現在この項目は利用できません |
||||
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入力情報 | |
ReceiveSatelliteType | 自宅外配送受取種別 | (数値) | 2byte(最大) | 自宅外配送の種別を判定します。 0,Null:通常配送 1:日本郵便自宅外配送 |
|
ReceiveSatelliteSettleMethod | 自宅外配送受取決済手段 | (数値) | 2byte(最大) | 受取時の決済手段を判別する種別 0,Null:通常配送、 2:コンビニ受取(店頭決済なし) 4:郵便局受取(店頭決済なし) |
|
ReceiveSatelliteMethod | 自宅外配送受取手段 | (数値) | 30byte(最大) | 受取店舗システムを判別するコード 0001:Loppi 0003:Fami port 1001:郵便局 1100:はこぽす |
|
ReceiveSatelliteCompanyName | 自宅外配送受取会社名 | (文字列) | 200byte(最大) | コンビニ種別名を表します。 | |
ReceiveSatelliteShopCode | 自宅外配送受取店舗コード | (数値) | 100byte(最大) | コンビニ店舗コードを表します。 | |
ReceiveSatelliteShopName | 自宅外配送受取店舗名 | (文字列) | 200byte(最大) | コンビニ店舗名、郵便局局名を表します。 コンビニ店舗名、郵便局局名、「はこぽす」の設置場所名など |
|
ReceiveSatelliteShipKind | 自宅外配送指定配送種類 | (文字列) | 200byte(最大) | 自宅外配送受取手段で判別される配送種類を表します。 「コンビニ」「郵便局」それ以外は「0」 |
|
ReceiveSatelliteYahooCode | 自宅外配送通販業者コード | (数値) | 100byte(最大) | Yahooのコード:610001 | |
ReceiveSatelliteCertificationNumber | 自宅外配送受取認証番号 | (数値) | 100byte(最大) | 受取認証用の番号(7桁) | |
CollectionDate | 集荷日 | YYYYMMDD | 8byte | ※ヤマトピック&デリバリー、ヤマトフルフィル専用項目 ヤマト運輸に集荷してもらう日 出店者様側で設定 ヤマトフルフィルの場合はヤマト運輸側から自動連携 |
|
CashOnDeliveryTax | 代引き用消費税額 | (数値) | 15byte(最大) | ※ヤマトピック&デリバリー、ヤマトフルフィル専用項目 代引き支払い専用項目で、代引き支払いの総合計金額の内消費税額 |
|
NumberUnitsShipped | 出荷個口数 | (数値) | 5byte(最大) | ※ヤマトピック&デリバリー、ヤマトフルフィル専用項目 ヤマト運輸側から更新 ピック&デリバリーで送られた荷物が何個口で送られたか |
|
ShipRequestTimeZoneCode | 配送希望時間帯番号 | 指定無しの場合は空白 101:午前中(8時~12時) 102:14時~16時 103:16時~18時 104:18時~20時 105:19時~21時 |
3byte(最大) | ※ヤマトピック&デリバリー、ヤマトフルフィル専用項目 配送希望時間帯番号 |
|
ShipInstructType | 出荷指示区分 | 0:対象外 1:直接連携 2:荷主経由 101:ヤマト運輸株式会社 ピック&デリバリー 102:ヤマト運輸株式会社 フルフィルメント(API連携) 103:ヤマト運輸株式会社 ピック&デリバリー(連携外ストア) 104:ヤマト運輸株式会社 フルフィルメント(マルチチャネル) |
3byte(最大) | ※ヤマトピック&デリバリー、ヤマトフルフィル専用項目 どの配送サービスを使用しているか |
|
ShipInstructStatus | 出荷指示ステータス | 0:対象外 100:出荷指示受付前 101:出荷指示待ち 102:出荷キャンセル 103:出荷指示済み 104:出荷完了 105:着荷完了 106:配送不可 |
3byte(最大) | ※ヤマトピック&デリバリー、ヤマトフルフィル専用項目 ヤマトピック&デリバリー、ヤマトフルフィルにおける注文のステータスを表示 0:対象外 →配送サービス対象外 100:出荷指示受付前 →バイヤーキャンセル受付中(受注後10分間)の状態。更新不可 101:出荷指示待ち →バイヤーキャンセル受付終了(受注後10分以上経過)の状態。「103:出荷指示済み」への更新可 102:出荷キャンセル →ヤマトピック&デリバリーキャンセル状態 注文自体のキャンセル、配送方法を変更した際に遷移します。 103:出荷指示済み →トータルピック完了を示す状態。変更契機はストアの更新 104:出荷完了 →倉庫から荷物が出た状態。変更契機はヤマト運輸からの更新 105:着荷完了 →着荷が完了した状態。変更契機はヤマト運輸からの更新 106:配送不可 →何らかの理由で倉庫からの出荷ができなかった状態。「YamatoUndeliverableReason」と必ずセットとなる。変更契機はヤマト運輸からの更新 |
|
ReceiveShopType | 店頭注文種別 | (数値) | 1byte |
店頭在庫の種別を表す種別 null or 0 :通常注文 1:店頭受取 2:店頭在庫受取 3:店頭在庫発送 |
|
ReceiveShopName | 配送元店頭名 | (文字列) | 200byte(最大) | ||
ExcellentDelivery | 優良配送フラグ | 0 : 優良配送でない、1 : 優良配送 | 1byte(固定) | 優良配送注文であるかどうかを判定する項目 | |
IsEazy | EAZY注文フラグ | null:リリース前注文 false:EAZY外注文 true:EAZY注文 |
5byte(最大) | EAZY注文フラグ | |
明細 | PayCharge | 手数料 | (数値) | 10byte(最大) | ストアが設定した手数料(代引き手数料など)、Yahoo!決済の決済手数料は別です。 |
ShipCharge | 送料 | (数値) | 10byte(最大) | 送料(送料無料クーポン値引き後の金額) | |
GiftWrapCharge | ギフト包装料 | (数値) | 10byte(最大) | ギフト包装料 | |
Discount | 値引き | (数値) | 10byte(最大) | 値引き ※クーポンの値引きではありません、ストア側が注文後にストアクリエイターPro上で値引き欄に入力した値が入ります。 |
|
Adjustments | 調整額 | (数値) | 10byte(最大) | 調整額 ※マイナスの値も許容、その場合は -(10byte) が許容最大 |
|
SettleAmount | 決済金額 | (数値) | 15byte(最大) | 合計金額 ※合計金額(TotalPrice)と同じ値になります。 |
|
UsePoint | 利用ポイント数 | (数値) | 10byte(最大) | 利用ポイント数 | |
TotalPrice | 合計金額 | (数値) | 15byte(最大) | 小計 - 利用ポイント + ギフト包装料 + 手数料 - 値引き + 送料+ 調整額 - モールクーポン値引き額 | |
SettlePayAmount | 入金金額 | (数値) | 15byte(最大) | 分割後注文には引き継ぎません。 元注文で確認させます。 |
|
※2019/10/01(火)廃止予定です。 |
|||||
※現在この項目は利用できません |
|||||
true : 確定済 |
※現在この項目は利用できません |
||||
IsGetPointFixAll | 全付与ポイント確定有無 | false : 未確定 true : 確定済 |
5byte(最大) | 全ライン(商品)の付与ポイントの確定処理が完了したかどうかを示します。 | |
TotalMallCouponDiscount | モールクーポン値引き額 | (数値) | 15byte(最大) | モールクーポンで値引きされる額の合計値を示します。 | |
IsGetStoreBonusFixAll | 全付与ストアPayPayボーナス確定フラグ | false:未確定 true:確定済 |
5 byte(最大) | 付与ストアPayPayボーナスの課金請求が確定したか否かを示します。 | |
商品 | 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> <Price>オプション価格</Price> </ItemOption> ※Priceは2018年10月17日追加予定 |
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(最大) | 課税対象フラグ | |
ItemTaxRatio | 消費税率 | (数値) | 3byte(最大) | 商品の消費税率 8:8% 10:10% |
|
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~ |
梱包後の重量です。 ※現在この項目は利用できません |
||||
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~ |
梱包後の縦、横、高さの合計です。 ※現在この項目は利用できません |
||||
Jan | JANコード | (文字列) | 14byte(最大) | JANコード | |
ProductId | 製品コード | (文字列) | 50byte(最大) | 製品コード(品番/型番) <ProductId><![CDATA[123456789]]></ProductId> |
|
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(固定) | 発売日の入力がある場合のみです。 発売日>注文日の場合、予約注文として扱います。 |
|
※現在この項目は利用できません |
|||||
true : 返品可 |
※現在この項目は利用できません |
||||
※現在この項目は利用できません |
|||||
※現在この項目は利用できません |
|||||
true : レビュー有り |
※現在この項目は利用できません | ||||
true : キャンペーン対象 |
※現在この項目は利用できません |
||||
PointFspCode | 商品別ポイントコード | (数値) | 5byte(固定) | 10001~10015、20001~20010 | |
PointRatioY | 付与ポイント倍率(Yahoo!JAPAN負担) | (数値) | 2byte(最大) | 付与ポイントのYahoo!JAPAN負担倍率。 Yahoo!JAPANの負担が10倍であれば10が入ります。 |
|
PointRatioSeller | 付与ポイント倍率(ストア負担) | (数値) | 2byte(最大) | 付与ポイントのストア負担倍率です。 ストアが5倍負担であれば5が入ります。 |
|
UnitGetPoint | 単位付与ポイント数 | (数値) | 10byte(最大) | 商品単価に対しての付与ポイント数 | |
IsGetPointFix | 付与ポイント確定フラグ | false : 未確定 true : 確定済 |
5byte(最大) | ||
GetPointFixDate | 付与ポイント確定日 | (YYYY-MM-DD) | 10byte(固定) | 注文日14日後、予約注文は発売日の14日後をセットします。 | |
CouponData | ストアクーポン | クーポンID\Aクーポン名\Aクーポン種別\Aクーポンカテゴリ\A利用枚数\BクーポンID\Aクーポン名\Aクーポン種別\Aクーポンカテゴリ\A利用枚数 | 800byte(最大) | ストアクーポンは全ラインに適用されます。 ※\A、\Bは文字列です。 ※クーポン種別(クーポンタイプ):1: 単体商品指定,2: 複数商品指定,3: ストア対象 |
|
CouponDiscount | クーポンの値引き額 | (数値) | 10byte(最大) | クーポンの値引き額です。 |
|
※商品クーポンのみ |
|||||
OriginalPrice | 値引き前の単価 | (数値) | 10byte(最大) | 値引き前の単価です。 | |
OriginalNum | ライン分割前の数量 | (数値) | 3byte(最大) | ライン分割前の数量です。 | |
LeadTimeText | 発送日テキスト | (文字列) | 50byte(最大) | 発送日情報設定とストア休業日出荷設定に基づく発送目安文言 ※2017/8/9より利用可能 |
|
LeadTimeStart | 発送日スタート | (YYYY-MM-DD) | 10byte(固定) | 発送日情報設定とストア休業日出荷設定に基づく発送日スタート日時 ※2017/8/9より利用可能 |
|
LeadTimeEnd | 発送日エンド | (YYYY-MM-DD) | 10byte(固定) | 発送日情報設定とストア休業日出荷設定に基づく発送日エンド日時 ※2017/8/9より利用可能 |
|
PriceType | 価格種別 | int | 1byte(固定) | 1:通常販売価格 2:セール価格 3:プレミアム会員価格 |
|
PickAndDeliveryCode | 梱包バーコード情報 | (文字列) | 20byte(最大) | ※ヤマトピック&デリバリー専用項目 納品に必要なバーコード情報です。 商品で編集したものがそのまま連携される |
|
PickAndDeliveryTransportRuleType | 荷扱い情報 | 0:なし 1:ナマモノ 2:ワレモノ 3:精密機械 4:下積厳禁 5:天地無用 |
2byte(最大) | ※ヤマトピック&デリバリー専用項目 荷扱いに関する情報です。 商品で編集したものがそのまま連携される |
|
YamatoUndeliverableReason | 配送不可理由 | (文字列) | 80byte(最大) | ※ヤマトピック&デリバリー、ヤマトフルフィル専用項目 ヤマトから連携される配送不可理由です。 ・商品不足:商品が足りなかった場合 ・商品不良:商品が破損、汚損等で不良だった場合 ・規格外商品:160サイズ以上、冷蔵・冷凍、こわれもの・びんもの、コンパクト・ネコポスに入りきらない商品だった場合 ・お客様指示:ストア様からのキャンセル依頼があった場合 ・注文者都合:受け取り拒否、保管期限切れ等ユーザー側での都合での返品 |
|
StoreBonusRatioSeller | 付与ストアPayPayボーナス倍率(Seller負担) | (数値) | 2 byte(最大) | 付与ストアPayPayボーナスのSeller負担倍率がはいります。 | |
UnitGetStoreBonus | 単位付与ストアPayPayボーナス数 | (数値) | 10 byte(最大) | 商品1数量の付与ストアPayPayボーナス数 | |
IsGetStoreBonusFix | 付与ストアPayPayボーナス確定フラグ | false:未確定 true:確定済 |
5 byte(最大) | 付与ストアPayPayボーナスの課金請求が確定したか否かを示す。 | |
GetStoreBonusFixDate | 付与ストアPayPayボーナス確定日 | (YYYY-MM-DD) | 10 byte(固定) | 付与ストアPayPayボーナスの確定日 | |
セラー | 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(最大) | スタークラブについての詳細は下記ページをご覧ください。 ※2020年10月1日以降の注文は一律「2000」が返却されます。 |
|
FspLicenseName | FSPライセンス名 | ※2020年10月1日以降の注文は一律「なし」が返却されます。 | 15byte(最大) | スタークラブについての詳細は下記ページをご覧ください。 |
|
GuestAuthId | ゲストユニークキー(vwoidc) | (文字列) | 20byte(固定) | ゲスト注文の場合のみです。 |
配送会社コード(ShipCompanyCode)
※2018年10月以降の注文に関しては「4桁」、2018年9月までの注文は「3桁」で返却されます。
(下記一覧のカッコ内の数値)
配送会社コード | 配送会社名 |
---|---|
1000(999) | その他 |
1001(103) | ヤマト運輸 |
1002(104) | 佐川急便 |
1003(100) | 日本郵便 |
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グローバル・ジャパン |
5001 | 受取店舗コード |
※こちらの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/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>
レスポンスフィールド
レスポンスデータ「ArriveType」について(2019/06/20 更新)
お届け希望日の商品個別設定機能のリリースに伴い
お客様が選択した「お届け希望日」に応じたデータが連携されます。
▼リリース前
注文された商品に紐づくデータを連携
例)注文商品「きょうつく」お届け希望日「指定なし」を選択 → 「1: きょうつく注文」が返却されます。
▼リリース後
お客様が選択したお届け希望日に応じたデータを連携
例)注文商品「(設定なし)」お届け希望日「(注文日翌日)」を選択 → 「2: あすつく注文」が返却されます。
リリース予定日:2019年6月中
※詳細はストアクリエイタProの「機能情報」をご確認ください。
フィールド | 説明 |
---|---|
/ResultSet | クエリーレスポンスのすべてを含み、次の属性を持ちます。
|
/ResultSet/Result | 各個別レスポンスを含みます。 |
/ResultSet/Result/Status | 取得成否(OK/NG) |
/ResultSet/Result/OrderInfo | 注文情報。次の属性を持ちます。
|
/ResultSet/Result/OrderInfo/Pay | 支払情報。次の属性を持ちます。
|
/ResultSet/Result/OrderInfo/Ship | お届情報。次の属性を持ちます。
|
/ResultSet/Result/OrderInfo/Detail | 明細情報。次の属性を持ちます。
|
/ResultSet/Result/OrderInfo/Item | 商品ライン情報。次の属性を持ちます。
|
/ResultSet/Result/OrderInfo/Seller | セラー情報。次の属性を持ちます。
|
/ResultSet/Result/OrderInfo/Buyer | バイヤー情報。次の属性を持ちます。
|
お支払い方法「PayPay」追加に伴い追加されるレスポンスです。
キー名 | 項目 | 型 | 最大長 | 内容 |
---|---|---|---|---|
CombinedPayType | 併用支払い分類 | 0 : 後払い 1 : 前払い |
1byte(固定) | |
CombinedPayKind | 併用お支払い方法種別 | 0 : カード 1 : ネットバンキング 2 : キャリア決済 3 : 振込 4 : 代引 5 : コンビニ 6 : 電子マネー 7 : その他 |
1byte(固定) | |
CombinedPayMethod | 併用お支払い方法 | (文字列) | 11byte(最大) | 例:payment_a1 ※PayMethodで利用している"payment_"で始まる文字列がセットされます。 |
PayMethodAmount | 支払い金額 | (数値) | 15byte(最大) | |
CombinedPayMethodName | 併用お支払い方法名称 | (文字列) | 150byte(最大) | 例:クレジットカード決済 |
CombinedPayMethodAmount | 併用支払い金額 | (数値) | 15byte(最大) |
サンプルレスポンス
<ResultSet totalResultsAvailable="1" totalResultsReturned="1" firstResultPosition="1">
<Result>
<Status>OK</Status>
<OrderInfo>
<OrderId>testseller-10000001</OrderId>
<ParentOrderId>testseller-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>XXXXXXXXXXX</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>postage15</ShipMethod>
<ShipMethodName><![CDATA[ヤフー運送]]></ShipMethodName>
<ShipRequestDate></ShipRequestDate>
<ShipRequestTime></ShipRequestTime>
<ShipNotes></ShipNotes>
<ShipInvoiceNumber1></ShipInvoiceNumber1>
<ShipInvoiceNumber2></ShipInvoiceNumber2>
<ShipInvoiceNumEmptyReason></ShipInvoiceNumEmptyReason>
<ShipCompanyCode></ShipCompanyCode>
<ShipUrl></ShipUrl>
<ArriveType>0</ArriveType>
<ShipDate></ShipDate>
<ArrivalDate></ArrivalDate>
<NeedGiftWrap>false</NeedGiftWrap>
<GiftWrapType></GiftWrapType>
<GiftWrapMessage></GiftWrapMessage>
<NeedGiftWrapPaper>false</NeedGiftWrapPaper>
<GiftWrapPaperType></GiftWrapPaperType>
<GiftWrapName></GiftWrapName>
<Option1Field></Option1Field>
<Option1Type>0</Option1Type>
<Option1Value></Option1Value>
<Option2Field></Option2Field>
<Option2Type>0</Option2Type>
<Option2Value></Option2Value>
<ShipFirstName><![CDATA[完了]]></ShipFirstName>
<ShipFirstNameKana><![CDATA[カンリョウ]]></ShipFirstNameKana>
<ShipLastName><![CDATA[注文]]></ShipLastName>
<ShipLastNameKana><![CDATA[チュウモン]]></ShipLastNameKana>
<ShipZipCode><![CDATA[9999999]]></ShipZipCode>
<ShipPrefecture><![CDATA[東京都]]></ShipPrefecture>
<ShipPrefectureKana><![CDATA[トウキョウト]]></ShipPrefectureKana>
<ShipCity><![CDATA[港区]]></ShipCity>
<ShipCityKana><![CDATA[ミナトク]]></ShipCityKana>
<ShipAddress1><![CDATA[赤坂9-7-1]]></ShipAddress1>
<ShipAddress1Kana><![CDATA[アカサカ9-7-1]]></ShipAddress1Kana>
<ShipAddress2><![CDATA[ミッドタウン・タワー]]></ShipAddress2>
<ShipAddress2Kana><![CDATA[ミッドタウン・タワー]]></ShipAddress2Kana>
<ShipPhoneNumber><![CDATA[99-8888-7777]]></ShipPhoneNumber>
<ShipEmgPhoneNumber><![CDATA[99-8888-7777]]></ShipEmgPhoneNumber>
<ShipSection1Field></ShipSection1Field>
<ShipSection1Value></ShipSection1Value>
<ShipSection2Field></ShipSection2Field>
<ShipSection2Value></ShipSection2Value>
<ShipInstructType>103</ShipInstructType>
<ShipInstructStatus>103</ShipInstructStatus>
</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>
「PayPay」のみの場合
<?xml version="1.0" encoding="UTF-8"?>
<ResultSet firstResultPosition="1" totalResultsAvailable="1" totalResultsReturned="1">
<Result>
<Status>OK</Status>
<OrderInfo>
<OrderId>testseller-10005001</OrderId>
<Version>1</Version>
<ParentOrderId></ParentOrderId>
<ChildOrderId></ChildOrderId>
<DeviceType>1</DeviceType>
<MobileCarrierName></MobileCarrierName>
<IsSeen>false</IsSeen>
<IsSplit>false</IsSplit>
<IsRoyalty>true</IsRoyalty>
<IsRoyaltyFix>false</IsRoyaltyFix>
<IsSeller>false</IsSeller>
<IsAffiliate>false</IsAffiliate>
<IsRatingB2s>false</IsRatingB2s>
<NeedSnl>false</NeedSnl>
<OrderTime>2018-12-07T01:27:04+09:00</OrderTime>
<LastUpdateTime>2019-01-18T17:45:23+09:00</LastUpdateTime>
<Suspect>0</Suspect>
<SuspectMessage></SuspectMessage>
<OrderStatus>2</OrderStatus>
<CancelReason></CancelReason>
<CancelReasonDetail></CancelReasonDetail>
<StoreStatus></StoreStatus>
<RoyaltyFixTime>2019-01-21T00:00:00+09:00</RoyaltyFixTime>
<SendConfirmTime>2019-01-18T17:45:22+09:00</SendConfirmTime>
<SendPayTime></SendPayTime>
<PrintSlipTime></PrintSlipTime>
<PrintDeliveryTime></PrintDeliveryTime>
<PrintBillTime></PrintBillTime>
<BuyerComments></BuyerComments>
<SellerComments></SellerComments>
<Notes></Notes>
<OperationUser><![CDATA[system]]></OperationUser>
<Referer><![CDATA[http://www.yahoo.co.jp/]]></Referer>
<EntryPoint><![CDATA[http://www.yahoo.co.jp/]]></EntryPoint>
<HistoryId>7</HistoryId>
<ShippingCouponDiscount></ShippingCouponDiscount>
<ShippingCouponFlg></ShippingCouponFlg>
<TotalCouponDiscount></TotalCouponDiscount>
<UseCouponData></UseCouponData>
<UsageId></UsageId>
<CampaignPoints></CampaignPoints>
<IsMultiShip>false</IsMultiShip>
<MultiShipId></MultiShipId>
<Pay>
<PayStatus>1</PayStatus>
<SettleStatus>3</SettleStatus>
<PayType>0</PayType>
<PayKind>6</PayKind>
<PayMethod>payment_a17</PayMethod>
<PayMethodName><![CDATA[PayPay残高払い]]></PayMethodName>
<PayActionTime></PayActionTime>
<PayDate></PayDate>
<PayNotes></PayNotes>
<CombinedPayMethod></CombinedPayMethod>
<CombinedPayType></CombinedPayType>
<CombinedPayKind></CombinedPayKind>
<CombinedPayMethodName></CombinedPayMethodName>
<SettleId>XXXXXXXXXXXXX</SettleId>
<CardBrand><![CDATA[MASTER]]></CardBrand>
<CardNumber></CardNumber>
<CardNumberLast4>7890</CardNumberLast4>
<CardExpireYear></CardExpireYear>
<CardExpireMonth></CardExpireMonth>
<CardPayType>1</CardPayType>
<CardPayCount>1</CardPayCount>
<CardHolderName></CardHolderName>
<CardBirthDay></CardBirthDay>
<UseYahooCard>false</UseYahooCard>
<UseWallet>false</UseWallet>
<NeedBillSlip>false</NeedBillSlip>
<NeedDetailedSlip>false</NeedDetailedSlip>
<NeedReceipt>false</NeedReceipt>
<AgeConfirmField></AgeConfirmField>
<AgeConfirmValue>0</AgeConfirmValue>
<AgeConfirmCheck>false</AgeConfirmCheck>
<SellerHandlingCharge></SellerHandlingCharge>
<PayNo></PayNo>
<PayNoIssueDate></PayNoIssueDate>
<ConfirmNumber></ConfirmNumber>
<PaymentTerm></PaymentTerm>
<IsApplePay>false</IsApplePay>
<BillAddressFrom>W</BillAddressFrom>
<BillFirstName><![CDATA[完了]]></BillFirstName>
<BillFirstNameKana><![CDATA[カンリョウ]]></BillFirstNameKana>
<BillLastName><![CDATA[注文]]></BillLastName>
<BillLastNameKana><![CDATA[チュウモン]]></BillLastNameKana>
<BillZipCode><![CDATA[9999999]]></BillZipCode>
<BillPrefecture><![CDATA[東京都]]></BillPrefecture>
<BillPrefectureKana><![CDATA[トウキョウト]]></BillPrefectureKana>
<BillCity><![CDATA[港区]]></BillCity>
<BillCityKana><![CDATA[ミナトク]]></BillCityKana>
<BillAddress1><![CDATA[赤坂9-7-1]]></BillAddress1>
<BillAddress1Kana><![CDATA[アカサカ9-7-1]]></BillAddress1Kana>
<BillAddress2><![CDATA[ミッドタウン・タワー]]></BillAddress2>
<BillAddress2Kana><![CDATA[ミッドタウン・タワー]]></BillAddress2Kana>
<BillPhoneNumber><![CDATA[99-8888-7777]]></BillPhoneNumber>
<BillMailAddress><![CDATA[test@test.co.jp]]></BillMailAddress>
<BillEmgPhoneNumber><![CDATA[99-8888-7777]]></BillEmgPhoneNumber>
<BillSection1Field><![CDATA[testBillSection1Field]]></BillSection1Field>
<BillSection1Value><![CDATA[セクション1フィールド]]></BillSection1Value>
<BillSection2Field><![CDATA[testBillSection2Field]]></BillSection2Field>
<BillSection2Value><![CDATA[セクション2フィールド]]></BillSection2Value>
</Pay>
<Ship>
<ShipStatus>1</ShipStatus>
<ShipMethod>postage15</ShipMethod>
<ShipMethodName><![CDATA[ヤフー運送]]></ShipMethodName>
<ShipRequestDate></ShipRequestDate>
<ShipRequestTime></ShipRequestTime>
<ShipNotes></ShipNotes>
<ShipInvoiceNumber1></ShipInvoiceNumber1>
<ShipInvoiceNumber2></ShipInvoiceNumber2>
<ShipInvoiceNumEmptyReason></ShipInvoiceNumEmptyReason>
<ShipCompanyCode></ShipCompanyCode>
<ShipUrl></ShipUrl>
<ArriveType>0</ArriveType>
<ShipDate></ShipDate>
<ArrivalDate></ArrivalDate>
<NeedGiftWrap>false</NeedGiftWrap>
<GiftWrapType></GiftWrapType>
<GiftWrapMessage></GiftWrapMessage>
<NeedGiftWrapPaper>false</NeedGiftWrapPaper>
<GiftWrapPaperType></GiftWrapPaperType>
<GiftWrapName></GiftWrapName>
<Option1Field></Option1Field>
<Option1Type>0</Option1Type>
<Option1Value></Option1Value>
<Option2Field></Option2Field>
<Option2Type>0</Option2Type>
<Option2Value></Option2Value>
<ShipFirstName><![CDATA[完了]]></ShipFirstName>
<ShipFirstNameKana><![CDATA[カンリョウ]]></ShipFirstNameKana>
<ShipLastName><![CDATA[注文]]></ShipLastName>
<ShipLastNameKana><![CDATA[チュウモン]]></ShipLastNameKana>
<ShipZipCode><![CDATA[9999999]]></ShipZipCode>
<ShipPrefecture><![CDATA[東京都]]></ShipPrefecture>
<ShipPrefectureKana><![CDATA[トウキョウト]]></ShipPrefectureKana>
<ShipCity><![CDATA[港区]]></ShipCity>
<ShipCityKana><![CDATA[ミナトク]]></ShipCityKana>
<ShipAddress1><![CDATA[赤坂9-7-1]]></ShipAddress1>
<ShipAddress1Kana><![CDATA[アカサカ9-7-1]]></ShipAddress1Kana>
<ShipAddress2><![CDATA[ミッドタウン・タワー]]></ShipAddress2>
<ShipAddress2Kana><![CDATA[ミッドタウン・タワー]]></ShipAddress2Kana>
<ShipPhoneNumber><![CDATA[99-8888-7777]]></ShipPhoneNumber>
<ShipEmgPhoneNumber><![CDATA[99-8888-7777]]></ShipEmgPhoneNumber>
<ShipSection1Field></ShipSection1Field>
<ShipSection1Value></ShipSection1Value>
<ShipSection2Field></ShipSection2Field>
<ShipSection2Value></ShipSection2Value>
</Ship>
<Seller>
<SellerId>testseller</SellerId>
</Seller>
<Buyer>
<IsLogin>true</IsLogin>
<FspLicenseCode></FspLicenseCode>
<FspLicenseName></FspLicenseName>
<GuestAuthId></GuestAuthId>
</Buyer>
<Item>
<LineId>1</LineId>
<ItemId><![CDATA[cc]]></ItemId>
<Title><![CDATA[テスト商品1001]]></Title>
<SubCode></SubCode>
<SubCodeOption></SubCodeOption>
<ItemOption>
<Index>1</Index>
<Name><![CDATA[商品オプション名]]></Name>
<Value><![CDATA[商品オプション値]]></Value>
</ItemOption>
<Inscription>
<Index>1</Index>
<Name></Name>
<Value><![CDATA[インスクリプション値]]></Value>
</Inscription>
<IsUsed>false</IsUsed>
<ImageId></ImageId>
<IsTaxable>true</IsTaxable>
<Jan></Jan>
<ProductId></ProductId>
<CategoryId>1</CategoryId>
<AffiliateRatio>0.0_0.0</AffiliateRatio>
<UnitPrice>100</UnitPrice>
<Quantity>1</Quantity>
<PointAvailQuantity>10</PointAvailQuantity>
<ReleaseDate></ReleaseDate>
<PointFspCode></PointFspCode>
<PointRatioY>0</PointRatioY>
<PointRatioSeller>1</PointRatioSeller>
<UnitGetPoint>10</UnitGetPoint>
<IsGetPointFix>false</IsGetPointFix>
<GetPointFixDate>2019-02-01</GetPointFixDate>
<CouponData></CouponData>
<CouponDiscount></CouponDiscount>
<OriginalPrice></OriginalPrice>
<OriginalNum></OriginalNum>
<LeadTimeStart></LeadTimeStart>
<LeadTimeEnd></LeadTimeEnd>
<LeadTimeText></LeadTimeText>
<PriceType>0</PriceType>
</Item>
<Detail>
<PayCharge>0</PayCharge>
<ShipCharge>0</ShipCharge>
<GiftWrapCharge>0</GiftWrapCharge>
<Discount>0</Discount>
<UsePoint>100</UsePoint>
<SettleAmount>300</SettleAmount>
<TotalPrice>300</TotalPrice>
<SettlePayAmount></SettlePayAmount>
<TaxRatio>8</TaxRatio>
<IsGetPointFixAll>false</IsGetPointFixAll>
<Adjustments></Adjustments>
<TotalMallCouponDiscount></TotalMallCouponDiscount>
<PayMethodAmount></PayMethodAmount>
<CombinedPayMethodAmount></CombinedPayMethodAmount>
</Detail>
<IsReadOnly>0</IsReadOnly>
</OrderInfo>
</Result>
</ResultSet>
「PayPay」+「クレジットカード決済」併用の場合
<?xml version="1.0" encoding="UTF-8"?>
<ResultSet firstResultPosition="1" totalResultsAvailable="1" totalResultsReturned="1">
<Result>
<Status>OK</Status>
<OrderInfo>
<OrderId>testseller-10005002</OrderId>
<Version>1</Version>
<ParentOrderId></ParentOrderId>
<ChildOrderId></ChildOrderId>
<DeviceType>1</DeviceType>
<MobileCarrierName></MobileCarrierName>
<IsSeen>false</IsSeen>
<IsSplit>false</IsSplit>
<IsRoyalty>true</IsRoyalty>
<IsRoyaltyFix>false</IsRoyaltyFix>
<IsSeller>false</IsSeller>
<IsAffiliate>false</IsAffiliate>
<IsRatingB2s>false</IsRatingB2s>
<NeedSnl>false</NeedSnl>
<OrderTime>2018-12-11T20:14:00+09:00</OrderTime>
<LastUpdateTime>2019-01-18T17:54:16+09:00</LastUpdateTime>
<Suspect>0</Suspect>
<SuspectMessage></SuspectMessage>
<OrderStatus>2</OrderStatus>
<CancelReason></CancelReason>
<CancelReasonDetail></CancelReasonDetail>
<StoreStatus></StoreStatus>
<RoyaltyFixTime>2019-01-25T00:00:00+09:00</RoyaltyFixTime>
<SendConfirmTime>2019-01-18T17:54:16+09:00</SendConfirmTime>
<SendPayTime></SendPayTime>
<PrintSlipTime></PrintSlipTime>
<PrintDeliveryTime></PrintDeliveryTime>
<PrintBillTime></PrintBillTime>
<BuyerComments></BuyerComments>
<SellerComments></SellerComments>
<Notes></Notes>
<OperationUser><![CDATA[system]]></OperationUser>
<Referer><![CDATA[http://www.yahoo.co.jp/]]></Referer>
<EntryPoint><![CDATA[http://www.yahoo.co.jp/]]></EntryPoint>
<HistoryId>6</HistoryId>
<ShippingCouponDiscount></ShippingCouponDiscount>
<ShippingCouponFlg></ShippingCouponFlg>
<TotalCouponDiscount></TotalCouponDiscount>
<UseCouponData></UseCouponData>
<UsageId></UsageId>
<CampaignPoints></CampaignPoints>
<IsMultiShip>false</IsMultiShip>
<MultiShipId></MultiShipId>
<Pay>
<PayStatus>1</PayStatus>
<SettleStatus>3</SettleStatus>
<PayType>0</PayType>
<PayKind>6</PayKind>
<PayMethod>payment_a17</PayMethod>
<PayMethodName><![CDATA[PayPay残高払い]]></PayMethodName>
<PayActionTime>2019-01-18T17:54:12+09:00</PayActionTime>
<PayDate></PayDate>
<PayNotes></PayNotes>
<CombinedPayMethod>payment_a1</CombinedPayMethod>
<CombinedPayType>1</CombinedPayType>
<CombinedPayKind>0</CombinedPayKind>
<CombinedPayMethodName><![CDATA[クレジットカード決済]]></CombinedPayMethodName>
<SettleId>XXXXXXXXXXXXXXXXX</SettleId>
<CardBrand><![CDATA[MASTER]]></CardBrand>
<CardNumber></CardNumber>
<CardNumberLast4>7890</CardNumberLast4>
<CardExpireYear></CardExpireYear>
<CardExpireMonth></CardExpireMonth>
<CardPayType>1</CardPayType>
<CardPayCount>1</CardPayCount>
<CardHolderName></CardHolderName>
<CardBirthDay></CardBirthDay>
<UseYahooCard>false</UseYahooCard>
<UseWallet>false</UseWallet>
<NeedBillSlip>false</NeedBillSlip>
<NeedDetailedSlip>false</NeedDetailedSlip>
<NeedReceipt>false</NeedReceipt>
<AgeConfirmField></AgeConfirmField>
<AgeConfirmValue>0</AgeConfirmValue>
<AgeConfirmCheck>false</AgeConfirmCheck>
<SellerHandlingCharge></SellerHandlingCharge>
<PayNo></PayNo>
<PayNoIssueDate></PayNoIssueDate>
<ConfirmNumber></ConfirmNumber>
<PaymentTerm></PaymentTerm>
<IsApplePay>false</IsApplePay>
<BillAddressFrom>W</BillAddressFrom>
<BillFirstName><![CDATA[完了]]></BillFirstName>
<BillFirstNameKana><![CDATA[カンリョウ]]></BillFirstNameKana>
<BillLastName><![CDATA[注文]]></BillLastName>
<BillLastNameKana><![CDATA[チュウモン]]></BillLastNameKana>
<BillZipCode><![CDATA[9999999]]></BillZipCode>
<BillPrefecture><![CDATA[東京都]]></BillPrefecture>
<BillPrefectureKana><![CDATA[トウキョウト]]></BillPrefectureKana>
<BillCity><![CDATA[港区]]></BillCity>
<BillCityKana><![CDATA[ミナトク]]></BillCityKana>
<BillAddress1><![CDATA[赤坂9-7-1]]></BillAddress1>
<BillAddress1Kana><![CDATA[アカサカ9-7-1]]></BillAddress1Kana>
<BillAddress2><![CDATA[ミッドタウン・タワー]]></BillAddress2>
<BillAddress2Kana><![CDATA[ミッドタウン・タワー]]></BillAddress2Kana>
<BillPhoneNumber><![CDATA[99-8888-7777]]></BillPhoneNumber>
<BillMailAddress><![CDATA[ordercreatetest@test.yahoo.co.jp]]></BillMailAddress>
<BillEmgPhoneNumber><![CDATA[99-8888-7777]]></BillEmgPhoneNumber>
<BillSection1Field><![CDATA[testBillSection1Field]]></BillSection1Field>
<BillSection1Value><![CDATA[セクション1フィールド]]></BillSection1Value>
<BillSection2Field><![CDATA[testBillSection2Field]]></BillSection2Field>
<BillSection2Value><![CDATA[セクション2フィールド]]></BillSection2Value>
</Pay>
<Ship>
<ShipStatus>1</ShipStatus>
<ShipMethod>postage15</ShipMethod>
<ShipMethodName><![CDATA[ヤフー運送]]></ShipMethodName>
<ShipRequestDate></ShipRequestDate>
<ShipRequestTime></ShipRequestTime>
<ShipNotes></ShipNotes>
<ShipInvoiceNumber1></ShipInvoiceNumber1>
<ShipInvoiceNumber2></ShipInvoiceNumber2>
<ShipInvoiceNumEmptyReason></ShipInvoiceNumEmptyReason>
<ShipCompanyCode></ShipCompanyCode>
<ShipUrl></ShipUrl>
<ArriveType>0</ArriveType>
<ShipDate></ShipDate>
<ArrivalDate></ArrivalDate>
<NeedGiftWrap>false</NeedGiftWrap>
<GiftWrapType></GiftWrapType>
<GiftWrapMessage></GiftWrapMessage>
<NeedGiftWrapPaper>false</NeedGiftWrapPaper>
<GiftWrapPaperType></GiftWrapPaperType>
<GiftWrapName></GiftWrapName>
<Option1Field></Option1Field>
<Option1Type>0</Option1Type>
<Option1Value></Option1Value>
<Option2Field></Option2Field>
<Option2Type>0</Option2Type>
<Option2Value></Option2Value>
<ShipFirstName><![CDATA[完了]]></ShipFirstName>
<ShipFirstNameKana><![CDATA[カンリョウ]]></ShipFirstNameKana>
<ShipLastName><![CDATA[注文]]></ShipLastName>
<ShipLastNameKana><![CDATA[チュウモン]]></ShipLastNameKana>
<ShipZipCode><![CDATA[9999999]]></ShipZipCode>
<ShipPrefecture><![CDATA[東京都]]></ShipPrefecture>
<ShipPrefectureKana><![CDATA[トウキョウト]]></ShipPrefectureKana>
<ShipCity><![CDATA[港区]]></ShipCity>
<ShipCityKana><![CDATA[ミナトク]]></ShipCityKana>
<ShipAddress1><![CDATA[赤坂9-7-1]]></ShipAddress1>
<ShipAddress1Kana><![CDATA[アカサカ9-7-1]]></ShipAddress1Kana>
<ShipAddress2><![CDATA[ミッドタウン・タワー]]></ShipAddress2>
<ShipAddress2Kana><![CDATA[ミッドタウン・タワー]]></ShipAddress2Kana>
<ShipPhoneNumber><![CDATA[99-8888-7777]]></ShipPhoneNumber>
<ShipEmgPhoneNumber><![CDATA[99-8888-7777]]></ShipEmgPhoneNumber>
<ShipSection1Field></ShipSection1Field>
<ShipSection1Value></ShipSection1Value>
<ShipSection2Field></ShipSection2Field>
<ShipSection2Value></ShipSection2Value>
</Ship>
<Seller>
<SellerId>testseller</SellerId>
</Seller>
<Buyer>
<IsLogin>true</IsLogin>
<FspLicenseCode></FspLicenseCode>
<FspLicenseName></FspLicenseName>
<GuestAuthId></GuestAuthId>
</Buyer>
<Item>
<LineId>1</LineId>
<ItemId><![CDATA[cc]]></ItemId>
<Title><![CDATA[テスト商品1001]]></Title>
<SubCode></SubCode>
<SubCodeOption></SubCodeOption>
<ItemOption>
<Index>1</Index>
<Name><![CDATA[商品オプション名]]></Name>
<Value><![CDATA[商品オプション値]]></Value>
</ItemOption>
<Inscription>
<Index>1</Index>
<Name></Name>
<Value><![CDATA[インスクリプション値]]></Value>
</Inscription>
<IsUsed>false</IsUsed>
<ImageId></ImageId>
<IsTaxable>true</IsTaxable>
<Jan></Jan>
<ProductId></ProductId>
<CategoryId>1</CategoryId>
<AffiliateRatio>0.0_0.0</AffiliateRatio>
<UnitPrice>100</UnitPrice>
<Quantity>1</Quantity>
<PointAvailQuantity>10</PointAvailQuantity>
<ReleaseDate></ReleaseDate>
<PointFspCode></PointFspCode>
<PointRatioY>0</PointRatioY>
<PointRatioSeller>1</PointRatioSeller>
<UnitGetPoint>10</UnitGetPoint>
<IsGetPointFix>false</IsGetPointFix>
<GetPointFixDate>2019-02-01</GetPointFixDate>
<CouponData></CouponData>
<CouponDiscount></CouponDiscount>
<OriginalPrice></OriginalPrice>
<OriginalNum></OriginalNum>
<LeadTimeStart></LeadTimeStart>
<LeadTimeEnd></LeadTimeEnd>
<LeadTimeText></LeadTimeText>
<PriceType>0</PriceType>
</Item>
<Detail>
<PayCharge>0</PayCharge>
<ShipCharge>0</ShipCharge>
<GiftWrapCharge>0</GiftWrapCharge>
<Discount>0</Discount>
<UsePoint>100</UsePoint>
<SettleAmount>500</SettleAmount>
<TotalPrice>500</TotalPrice>
<SettlePayAmount></SettlePayAmount>
<TaxRatio>8</TaxRatio>
<IsGetPointFixAll>false</IsGetPointFixAll>
<Adjustments></Adjustments>
<TotalMallCouponDiscount></TotalMallCouponDiscount>
<PayMethodAmount>300</PayMethodAmount>
<CombinedPayMethodAmount>200</CombinedPayMethodAmount>
</Detail>
<IsReadOnly>0</IsReadOnly>
</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 | メンテナンスエラー |
od90103 | 400 | リクエストと注文の整合性エラーです。 |
od90152 | 400 | 出荷指示済み後の注文操作不可エラーです。 |
od90154 | 400 | 出荷キャンセル済み注文の注文操作不可エラーです。 |
od90155 | 400 | ヤマトシステムへの連携処理中注文の注文操作不可エラーです。 |
od90158 | 400 | 該当キー更新時の注文操作不可エラーです。 |
od90160 | 400 | ヤマト配送注文かつ支払方法が商品代引ではない場合に、代引き用消費税額の更新操作はできません。 |
サンプルワーニングレスポンス
<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クエリー/秒)
1日50,000リクエストを超える場合は、アプリケーションIDを追加してご対応ください。
利用約款
このAPIに関する利用約款はこちら。
目次
- 商品検索
- カテゴリランキング
- カテゴリID取得
- 商品コード検索(商品詳細)
- キーワードランキング
- おすすめ情報モジュール
- ポイントキャンペーン情報取得
- 販促イベント検索
- 商品レビュー検索
- 出品管理に関連するAPI
- 商品に関連するAPI
- 問い合わせ管理に関連するAPI
- 製品/SHPカテゴリ/ブランドに関連するAPI
- 在庫に関連するAPI
- ストアカテゴリに関連するAPI
- 画像に関連するAPI
- デザインに関連するAPI
- 注文に関するAPI
- ヘルプ