注文内容変更API

指定注文の注文情報を変更します。

変更履歴

2023年10月30日

サービス名称変更に伴い下記文言を修正しました。
ヤフオク!、ヤフオク　→　Yahoo!オークション

2023年10月26日

佐川急便配送情報の自動連携サービス提供開始にともない、下記エラーコードを追加しました。
・od90175
・od90176

2023年08月09日

下記エラーコードを追加しました。
・od90193

2023年04月19日

更新情報キーに下記項目を追加しました。
・GiftCardDiscount（商品券利用額）

2023年04月05日

更新情報キーに下記項目を追加しました。
・SlowlyShipPoint（おトク指定便付与ポイント数）

2023年04月03日

・リクエストパラメータ「/Req/Order/Ship/ShipInvoiceNumber1　配送伝票番号1」「/Req/Order/Ship/ShipInvoiceNumber2　配送伝票番号2」「/Req/Order/Ship/ShipInvoiceNumberEmptyReason　伝票番号なし理由」の内容に(※5)を追記しました。
　(※5)伝票番号（ShipInvoiceNumber1 または ShipInvoiceNumber2）と伝票番号なし理由（ShipInvoiceNumberEmpryReason）は排他関係です。同時更新、他コードが存在している状況での更新はエラーとなります。
・リクエストパラメータ「/Req/Order/Ship/ShipMethod　配送方法」「/Req/Order/Ship/ShipCompanyCode　配送会社コード」の内容に(※6)を追記しました。
　(※6)「配送会社」変更の注意
　　「配送方法」、「配送会社」を同時に変更すると、「配送方法」に紐づいた「配送会社」が優先されます。詳細はこちらをご確認ください。

2023年03月02日

更新情報キー「Adjustments」の内容に下記文言を追記しました。
「プラスの値は+50000までが最大となります。」

2022年11月07日

更新情報キー「ShipInvoiceNumber1」の内容に下記文言を追記しました。
配送会社が「ヤマト運輸」となっている場合は配送伝票番号は半角数字と「-」記号のみ、最大14byteまで登録可能です。

2022年10月17日

・更新情報キーの「内容」を修正しました。
　詳細はこちらをご確認ください。
・下記エラーコードを追加しました。
　od90178、od90180、od90181

2022年09月09日

エラーコード「od90174」を追加しました。

2022年09月07日

下記エラーコードを追加しました。
・od91013
・od90185
・od90186
・od90187

2022年06月08日

Notes（社内メモ）の最大長を更新しました。
未定 → 1500byte（最大）

2022年03月10日

エラーコード「od90150」を追加しました。

2022年02月17日

PayMethodに「payment_a19：PayPayあと払い」を追加しました。
追加予定日：2022年02月28日（月）

2022年01月21日

エラーコード「od91131」を追加しました。

利用申請について

本番環境について

注文APIを利用する場合は別途利用申請が必要です。下記フォームから申請をお願いします。
ショッピング注文API利用申請フォーム

テスト環境について

テスト用APIを利用する場合は、下記フォームから「テスト環境用」を指定して申請をお願いします。
新しいアプリケーションを開発
※テスト環境に関しては別途注文APIの利用申請をしていただく必要はありません。

リクエストURL

本番環境
https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/orderChange
テスト環境
https://test.circus.shopping.yahooapis.jp/ShoppingWebService/V1/orderChange

リクエストパラメータ

「Web APIの使い方#POSTとは」をご参照ください。

パラメータ 型 説明
/Req リクエストパラメータ
/Req/SellerId
（必須）		 string ストアアカウント
/Req/Target 更新対象指定情報
/Req/Target/OrderId
（必須）		 string 注文ID
/Req/Target/IsPointFix
※現在、このパラメータは利用できません。		 boolean ポイント確定要否
true : ポイント確定します。
false : ポイント確定しません。
/Req/Target/OperationUser string 更新者名（ビジネスID登録氏名）
セラー更新のみ
/Req/Order 更新情報
/Req/Order/（更新情報キー） 更新情報（注文情報）（※2）
/Req/Order/Pay 請求情報
/Req/Order/Pay/（更新情報キー） 更新情報（請求情報）（※2）
/Req/Order/Ship 配送情報
/Req/Order/Ship/（更新情報キー） 更新情報（配送情報）（※2）
/Req/Order/Detail 明細情報
/Req/Order/Detail/（更新情報キー） 更新情報（明細情報）（※2）
/Req/Order/Item 商品情報
/Req/Order/Item/LineId
（必須※1）		 商品LineID
/Req/Order/Item/（更新情報キー） 更新情報（商品情報）（※2）

（※1） 商品情報を更新する際は必須です。
（※2） 更新情報に指定可能なキーの詳細は以下を参照ください。

－ 更新情報キー :

分類 キー名 項目 型 最大長 内容
注文 IsSeen 閲覧済みフラグ false : 未閲覧
true : 閲覧済み		 5byte（最大） 注文情報を更新した場合、自動で閲覧済みになります。
また、未閲覧から閲覧済みにのみ更新できます。
閲覧済み→未閲覧：更新できません
未閲覧→閲覧済み：更新できます。
Suspect 悪戯フラグ 0 : 非悪戯注文
1 : 悪戯注文
2 : 悪戯解除済注文		 1byte（固定） ※ほかの項目と同時に更新できません。更新する場合は、この項目のみで更新してください。
※LINEギフト注文は更新不可です。
PayType 支払い分類 0 : 後払い
1 : 前払い		 1byte（固定） ※LINEギフト注文は更新不可です。
PayKind 支払い種別 変更可能な支払い方法は以下の通りです。
0 : カード
1 : ネットバンキング
2 : キャリア決済
3 : 振込
4 : 代引
5 : コンビニ
6 : 電子マネー
7 : その他		 1byte（固定） ※LINEギフト注文は更新不可です。
PayMethod 支払い方法 （文字列）
payment_決済ID
payment_a1：カード決済
payment_a6：コンビニ決済（セブンイレブン）
payment_a7：コンビニ決済（その他）
payment_a8：モバイルSuica決済
payment_a9：d払い
payment_a10：auかんたん決済
payment_a11：ソフトバンクまとめて支払い
payment_a15：ペイジー
payment_a16：Yahoo!マネー/預金払い
payment_a17：PayPay残高払い
payment_a19：PayPayあと払い
payment_b[1-6]：銀行振込（名称はストアの自由設定）
payment_c1：ゆうちょ銀行（前払い）
payment_c2：ゆうちょ銀行（後払い）
payment_c3：現金書留
payment_d1：商品代引
payment_e[1-15]：ストアの自由なお支払い方法名
payment_z1：ポイント全額払い		 11byte（最大） お支払方法番号。
変更可能なステータスは以下の通りです。
カード決済：支払い完了 or 決済完了 or オーソリーエラー
コンビニ、ペイジー、モバイルSuica決済：支払い待ち or 有効期限切れ or Suicaアドレスエラー
キャリア決済：支払い待ち（+他のステータスの状態次第）
※ PayMethodを変えるだけではストアクリエイターProの決済方法の表示は変更できません。PayMethodNameも同時に変更してください。
※LINEギフト注文は更新不可です。
PayMethodName 支払い方法名称 （文字列）
支払方法		 150byte最大） ※LINEギフト注文は更新不可です。
StoreStatus ストアステータス 数値 2byte（最大） ストアが独自に設定可能なステータスです。
PrintSlipTime 注文伝票出力時刻 （YYYYMMDDHH24MISS） 14byte（固定） 注文伝票を出力した日時です。
※LINEギフト注文は更新不可です。
PrintDeliveryTime 納品書出力時刻 （YYYYMMDDHH24MISS） 14byte（固定） 納品書を出力した日時です。
※LINEギフト注文は更新不可です。
PrintBillTime 請求書出力時刻 （YYYYMMDDHH24MISS） 14byte（固定） 請求書を出力した日時です。
※LINEギフト注文は更新不可です。
BuyerComments バイヤーコメント （文字列）
（お届け情報入力フォームのメッセージフィールドを参考）		 750byte（最大） ご要望欄入力内容です。
SellerComments セラーコメント （文字列） 750byte（最大） セラーがカートに表示しているコメント文字列です。
Notes 社内メモ （文字列） 1500byte（最大） ビジネス注文管理ツールでセラーが入力した社内メモです。
RefundStatus 返金ステータス （文字列） 1byte（固定） 返金の要不要や返金の状態を表す区分です。
0：不要
1：必要
2：返金済み
APIで更新できるのは1：必要から2：返金済みへの更新のみ。
※LINEギフト注文は更新不可です。
IsFirstClassDrugAgreement 第1類医薬品承諾フラグ false：未承諾
true：承諾済み		 5byte(最大) 第1類医薬品を含む注文の承諾状況を判定します。
※LINEギフト注文は更新不可です。
SlowlyShipPoint おトク指定便付与ポイント数 (数値) 10byte おトク指定便によって付与されるポイント付与数
請求 PayDate 入金日 （YYYYMMDD） 8byte（固定） 入金日
※LINEギフト注文は更新不可です。
PayNotes 入金処理備考 （文字列） 1000byte（最大） 入金処理備考
※LINEギフト注文は更新不可です。
PayManageLimitDate 代金支払い管理注文期限日時 （YYYYMMDD） 8byte（固定） 代金支払い管理注文期限日時
※LINEギフト注文は更新不可です。
NeedBillSlip 請求書有無 キーなし : カートに設定なし
false : 請求書不要
true : 請求書必要		 （数値） 請求書有無
※LINEギフト注文は更新不可です。
NeedDetailedSlip 明細書有無 キーなし : カートに設定なし
false : 明細書不要
true : 明細書必要		 （数値） 明細書有無
伝票画面上では、「納品書」表記です。
帳票出力でも「納品書」出力で、「明細書」が出力可能です。
※LINEギフト注文は更新不可です。
NeedReceipt 領収書有無 キーなし : カートに設定なし
false : 領袖書不要
true : 領袖書必要		 （数値） 領収書有無
BillFirstName ご請求先名前 （文字列） 297byte（最大） ご請求先名前
※LINEギフト注文は更新不可です。
BillFirstnameKana ご請求先名前カナ （文字列） 297byte（最大） ご請求先名前（フリガナ）
※LINEギフト注文は更新不可です。
BillLastName ご請求先名字 （文字列） 297byte（最大） ご請求先名字
※LINEギフト注文は更新不可です。
BillLastNameKana ご請求先名字カナ （文字列） 297byte（最大） ご請求先名字（フリガナ）
※LINEギフト注文は更新不可です。
BillZipCode ご請求先郵便番号 （文字列） 10byte（最大） ご請求先郵便番号
※LINEギフト注文は更新不可です。
BillPrefecture ご請求先都道府県 （文字列） 12byte（最大） ご請求先都道府県
海外の場合「その他」が入ります。
※LINEギフト注文は更新不可です。
BillPrefectureKana ご請求先都道府県フリガナ （文字列） 18byte（最大） ご請求先都道府県フリガナ
※LINEギフト注文は更新不可です。
BillCity ご請求先市区郡 （文字列） 297byte（最大） ご請求先市区郡
※LINEギフト注文は更新不可です。
BillCityKana ご請求先市区郡フリガナ （文字列） 297byte（最大） ご請求先市区郡フリガナ
※LINEギフト注文は更新不可です。
BillAddressFrom ご請求先住所引用元 P : ご登録自宅住所
B : ご登録勤務先住所
ship : お届け先と同じ
O1 : その他1
O2 : その他2
O3 : その他3
O4 : その他4
O : その他で入力		 4byte（最大） ご請求先住所引用元
※LINEギフト注文は更新不可です。
BillAddress1 ご請求先住所1 （文字列） 297byte（最大） ご請求先住所1
※LINEギフト注文は更新不可です。
BillAddress1Kana ご請求先住所1フリガナ （文字列） 297byte（最大） ご請求先住所1フリガナ
※LINEギフト注文は更新不可です。
BillAddress2 ご請求先住所2 （文字列） 297byte（最大） ご請求先住所2
※LINEギフト注文は更新不可です。
BillAddress2Kana ご請求先住所2フリガナ （文字列） 297byte（最大） ご請求先住所2フリガナ
※LINEギフト注文は更新不可です。
BillPhoneNumber ご請求先電話番号 （文字列） 14byte（最大） ご請求先電話番号
※LINEギフト注文は更新不可です。
BillEmgPhoneNumber ご請求先電話番号（緊急） （文字列） 14byte（最大） ご請求先電話番号（緊急）
※LINEギフト注文は更新不可です。
BillMailAddress ご請求先メールアドレス （文字列） 99文字（最大） バイヤーの入力したメールアドレスです。Wallet利用の場合でかつ追加メールアドレス欄に入力がある場合は追加メールアドレスを入れます。
※LINEギフト注文は更新不可です。
BillSection1Field ご請求先所属1フィールド名 （文字列） 297byte（最大） ご請求先所属1フィールド名
※LINEギフト注文は更新不可です。
BillSection1Value ご請求先所属1入力情報 （文字列） 297byte（最大） ご請求先所属1入力情報
※LINEギフト注文は更新不可です。
BillSection2Field ご請求先所属2フィールド名 （文字列） 297byte（最大） ご請求先所属2フィールド名
※LINEギフト注文は更新不可です。
BillSection2Value ご請求先所属2入力情報 （文字列） 297byte（最大） ご請求先所属2入力情報
※LINEギフト注文は更新不可です。
配送 ShipMethod 配送方法 （文字列）
postageN		 9byte（最大） お届け方法番号：postage1-14,16のどれか1つ（postage15は欠番）
ストアクリエイターProの配送設定順。
(※6）
ShipMethodName 配送方法名称 （文字列） 150byte最大） ヤマト運輸など、お届け方法名称です。
Keyと名称のセットはセラー登録次第なのでセラー毎に違います。
ShipRequestDate 配送希望日 （YYYYMMDD） 8byte（固定） 配送希望日。注文管理で利用します（検索など）。
ＦＥツールでは、Ｎｕｌｌ＝お届け希望日なし、あすつくＦＬＧあったらあすつく希望などです。
ShipRequestTime 配送希望時間 （文字列） 13byte（最大） 12:00～14:00などです。
ShipNotes 配送メモ （文字列） 500byte（最大） 注文管理ツールで入力された出荷の配送希望メモ入力内容です。
ShipCompanyCode 配送会社 （数値） 3byte（最大） 配送会社コード
1000：その他
1001：ヤマト運輸
1002：佐川急便
1003：日本郵便
1004：西濃運輸
（一覧はこちら）
(※6）
ShipInvoiceNumber1 配送伝票番号１ （文字列） 30byte（最大） 注文管理ツールでセラーが入力、アップロードした配送会社の配送伝票番号です。注文管理ツールの画面上は1と2があります。
配送伝票番号は半角英数字と「-」記号のみ登録可能です。
配送会社が「ヤマト運輸」となっている場合は配送伝票番号は半角数字と「-」記号のみ、最大14byteまで登録可能です。
(※5）
ShipInvoiceNumber2 配送伝票番号2 （文字列） 30byte（最大） 注文管理ツールでセラーが入力、アップロードした配送会社の配送伝票番号です。注文管理ツールの画面上は1と2があります。
配送伝票番号は半角英数字と「-」記号のみ登録可能です。
配送会社が「ヤマト運輸」となっている場合は配送伝票番号は半角数字と「-」記号のみ、最大14byteまで登録可能です。
(※5）
ShipInvoiceNumberEmptyReason 伝票番号なし理由 （文字列） 3byte（最大 NULL：（未登録の状態）
101：メーカ等の在庫元からの直送品のため
102：発送不要の商品のため
103：店頭受け取り商品のため
104：配送会社から直接ご連絡のため
105：伝票番号が発行されない（追跡できない）配送方法のため
(※5）
ShipUrl 配送会社URL （文字列） 100byte（最大） 注文管理ツールでセラーが入力、アップロードした配送会社の追跡URLです。
ArriveType きょうつく、あすつく 0 : 通常
1 : きょうつく注文
2 : あすつく注文		 1byte（固定） きょうつく注文、あすつく注文の場合設定
※LINEギフト注文は更新不可です。
ShipDate 出荷日 （YYYYMMDD） 8byte（固定） 注文管理ツールで入力された出荷日です。
ArrivalDate 着荷日 （YYYYMMDD） 8byte（固定） 注文管理ツールで入力された着荷日です。
NeedGiftWrap ギフト包装有無 キーなし : カートに設定なし
false : ギフト包装無し
true : ギフト包装有り		 5byte（最大） ギフト包装の有無
※モバイル支払いの場合、ギフト包装の変更はできません。
※LINEギフト注文は更新不可です。
GiftWrapType ギフト包装種類 （文字列） 30byte（最大） ギフト包装の種類
※LINEギフト注文は更新不可です。
GiftWrapMessage ギフトメッセージ （文字列） 297byte（最大） ※LINEギフト注文は更新不可です。
NeedGiftWrapPaper のし有無 キーなし : カートに設定なし
false : のし無し
true : のし有り		 （数値） のしの有無
※LINEギフト注文は更新不可です。
GiftWrapPaperType のし種類 （文字列） 30byte（最大） のし（種類）
※LINEギフト注文は更新不可です。
GiftWrapName 名入れ （文字列） 297byte（最大） 名入れ（メッセージ）
※LINEギフト注文は更新不可です。
Option1Field オプションフィールド1キー情報（フィールド名） （文字列） 150byte（最大） ※現在この項目は利用できません
Option1Type オプションフィールド1キー情報（設定） キー無し
0 : テキストボックス（全角10文字まで）
1 : テキストボックス（全角50文字まで）
2 : テキストボックス（全角250文字まで）
3 : プルダウン
4 : ラジオボタン
5 : チェックボックス		 1byte（最大） ※現在この項目は利用できません
Option1Value オプションフィールド1入力内容 （文字列） 1500byte（最大） ※現在この項目は利用できません
Option2Field オプションフィールド2キー情報（フィールド名） （文字列） 150byte（最大） ※現在この項目は利用できません
Option2Type オプションフィールド2キー情報（設定） キー無し
0 : テキストボックス（全角10文字まで）
1 : テキストボックス（全角50文字まで）
2 : テキストボックス（全角250文字まで）
3 : プルダウン
4 : ラジオボタン
5 : チェックボックス		 1byte（最大） ※現在この項目は利用できません
Option2Value オプションフィールド2入力内容 （文字列） 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
※LINEギフト注文は更新不可です。
ShipAddress2Kana お届け先住所2フリガナ （文字列） 297byte（最大） お届け先住所2フリガナ
※LINEギフト注文は更新不可です。
ShipPhoneNumber お届け先電話番号 （文字列） 14byte（最大） お届け先電話番号
ShipEmgPhoneNumber お届け先緊急連絡先 （文字列） 14byte（最大） お届け先電話番号（緊急）
ShipSection1Field お届け先所属1フィールド名 （文字列） 297byte（最大） お届け先所属1フィールド名
※LINEギフト注文は更新不可です。
ShipSection1Value お届け先所属1値 （文字列） 297byte（最大） お届け先所属1入力情報
※LINEギフト注文は更新不可です。
ShipSection2Field お届け先所属2フィールド名 （文字列） 297byte（最大） お届け先所属2フィールド名
※LINEギフト注文は更新不可です。
ShipSection2Value お届け先所属2 （文字列） 297byte（最大） お届け先所属2入力情報
※LINEギフト注文は更新不可です。
CashOnDeliveryTax 代引き用消費税額 （数値） 15byte(最大) ※ヤマトピック&デリバリー専用項目
税額無しの場合は0を指定
税額未入力の場合は、出荷指示ステータス=出荷指示済み変更時に10%で自動計算された値が入ります。
※LINEギフト注文は更新不可です。
ReceiveShopCode 配送元店頭コード （文字列） 50byte(最大) ※LINEギフト注文は更新不可です。
ReceiveShopName 配送元店頭名 （文字列） 200byte(最大) ※LINEギフト注文は更新不可です。
IsEazy EAZY注文フラグ （文字列） 5byte(最大) EAZY注文フラグ
※ShipMethodを指定している場合、IsEazyは無効パラメータ扱いとなる。
※EazyDeliveryCode、EazyDeliveryNameを変更する場合、IsEazy=trueもセット（同値更新）すること。
※LINEギフト注文は更新不可です。
EazyDeliveryCode EAZYコード （数値） 2byte(最大) EAZYコード
※ShipMethodを指定している場合、EazyDeliveryCodeは無効パラメータ扱いとなる。
※LINEギフト注文は更新不可です。
EazyDeliveryName EAZY受け取り場所名 （文字列） 50byte(最大) EAZY受け取り場所名
※ShipMethodを指定している場合、EazyDeliveryNameは無効パラメータ扱いとなる。
※LINEギフト注文は更新不可です。
明細 PayCharge（※3） 手数料 （数値） 10byte（最大） セラーが設定した手数料（代引き手数料など）、Yahoo!決済の決済手数料は別です。
※LINEギフト注文は更新不可です。
ShipCharge（※3） 送料 （数値） 10byte（最大） 送料
※LINEギフト注文は更新不可です。
GiftWrapCharge（※3） ギフト包装料 （数値） 10byte（最大） ギフト包装料
※LINEギフト注文は更新不可です。
Discount（※3） 値引き （数値） 10byte（最大） 値引き
※LINEギフト注文は更新不可です。
Adjustments（※3)(※4） 調整額 （数値） 10byte（最大） 調整額
プラスの値は+50000までが最大となります。
マイナスの値も許容、その場合は -(10byte) が許容最大
※LINEギフト注文は更新不可です。
GiftCardDiscount 商品券利用額 （数値） 10byte（最大） 商品券利用額
※商品券の利用をキャンセルするには「0」で更新します。
※「0」以外を指定して利用額の変更はできません。
商品 Quantity（※3） 数量 （数値） 3byte（最大） 商品ごとの数量
※LINEギフト注文は更新不可です。
ReleaseDate 発売日 （YYYYMMDD） 8byte（固定） 発売日の入力がある場合です。
発売日＞注文日の場合、予約注文として扱います。
※LINEギフト注文は更新不可です。
（※3）注文金額が変更になる場合、システムが自動で注文金額変更連絡メールを購入者に送信されます。

（※4）注文ステータスが「完了」となった注文について、その後、お客様との対応で返金が発生する場合にお使いいただく項目となります。
Adjustments（調整額）を使われる場合は、以下のように注文ステータスの変更をおこなった後Adjustments（調整額）の指定をお願いいたします。
　1.注文ステータスが完了となっている
　2.注文ステータスを処理中に変更
　3.Adjustments（調整額）

（※5）伝票番号（ShipInvoiceNumber1 または ShipInvoiceNumber2）と伝票番号なし理由（ShipInvoiceNumberEmpryReason）は排他関係です。同時更新、他コードが存在している状況での更新はエラーとなります。

（※6）「配送会社」変更の注意
「配送方法」、「配送会社」を同時に変更すると、「配送方法」に紐づいた「配送会社」が優先されます。詳細はこちらをご確認ください。

配送会社コード（ShipCompanyCode） :

配送会社コード配送会社名
1000その他
1001ヤマト運輸
1002佐川急便
1003日本郵便
1004西濃運輸
1005西武運輸
1006福山通運
1007名鉄運輸
1008トナミ運輸
1009第一貨物
1010新潟運輸
1011中越運送
1012岡山県貨物運送
1013久留米運送
1014山陽自動車運送
1015日本トラック
1016エコ配
1017EMS
1018DHL
1019FedEx
1020UPS
1021日通通運
1022TNT
1023OCS
1024USPS
1025SFエクスプレス
1026Aramex
1027SGHグローバル・ジャパン

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

※こちらのAPIでは初回にユーザ認可リクエストをしてアクセストークン新規取得から最大１２時間たつと下記のエラーとなります。再度、こちらの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/orderChange

サンプルリクエスト

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

<Req>
 <SellerId>testseller</SellerId>
 <Target>
  <OrderId>testseller-10000001</OrderId>
 </Target>
 <Order>
  <PrintSlipTime>20110308123456</PrintSlipTime>
  <PrintDeliveryTime>20110308123456</PrintDeliveryTime>
  <PrintBillTime>20110308123456</PrintBillTime>
  <Notes>めもめも</Notes>
  <Pay>
   <BillFirstName>蛍</BillFirstName>
   <BillLastName>海</BillLastName>
   <BillFirstnameKana>ホタル</BillFirstnameKana>
   <BillLastNameKana>ウミ</BillLastNameKana>
   <BillZipCode>222-3333</BillZipCode>
   <BillPrefecture>千葉県</BillPrefecture>
   <BillPrefectureKana>チバケン</BillPrefectureKana>
   <BillCity>木更津市</BillCity>
   <BillCityKana>キサラヅシ</BillCityKana>
   <BillAddress1>中島地先</BillAddress1>
   <BillAddress2>海ほたる</BillAddress2>
   <BillAddress1Kana>ナカジマチサキ</BillAddress1Kana>
   <BillAddress2Kana>ウミホタル</BillAddress2Kana>
   <BillPhoneNumber>123-4567-8900</BillPhoneNumber>
   <BillMailAddress>hogehuga@yahoo.co.jp</BillMailAddress>
   <BillEmgPhoneNumber>234-5678-9012</BillEmgPhoneNumber>
   <BillSection1Value>会社</BillSection1Value>
   <BillSection2Value>部署</BillSection2Value>
  </Pay>
  <Ship>
   <ShipCompanyCode>1001</ShipCompanyCode>
   <ShipInvoiceNumber1>123-456789-012345</ShipInvoiceNumber1>
   <ShipFirstName>蛍</ShipFirstName>
   <ShipLastName>海</ShipLastName>
   <ShipFirstNameKana>ホタル</ShipFirstNameKana>
   <ShipLastNameKana>ウミ</ShipLastNameKana>
   <ShipZipCode>222-3333</ShipZipCode>
   <ShipPrefecture>千葉県</ShipPrefecture>
   <ShipPrefectureKana>チバケン</ShipPrefectureKana>
   <ShipCity>木更津市</ShipCity>
   <ShipCityKana>キサラヅシ</ShipCityKana>
   <ShipAddress1>中島地先</ShipAddress1>
   <ShipAddress2>海ほたる</ShipAddress2>
   <ShipAddress1Kana>ナカジマチサキ</ShipAddress1Kana>
   <ShipAddress2Kana>ウミホタル</ShipAddress2Kana>
   <ShipPhoneNumber>123-4567-8900</ShipPhoneNumber>
   <ShipEmgPhoneNumber>234-5678-9012</ShipEmgPhoneNumber>
   <ShipSection1Value>会社</ShipSection1Value>
   <ShipSection2Value>部署</ShipSection2Value>
  </Ship>
  <Detail>
   <PayCharge>500</PayCharge>
   <GiftwrapCharge>800</GiftwrapCharge>
   <Discount>2600</Discount>
  </Detail>
  <Item>
   <LineId>1</LineId>
   <Quantity>1</Quantity>
  </Item>
  <Seller>
  </Seller>
 </Order>
</Req>

レスポンスフィールド

レスポンスデータ「ArriveType」について（2019/06/20 更新）

お届け希望日の商品個別設定機能のリリースに伴い
お客様が選択した「お届け希望日」に応じたデータが連携されます。

▼リリース前
　注文された商品に紐づくデータを連携
　 例）注文商品「きょうつく」お届け希望日「指定なし」を選択　→　「1: きょうつく注文」が返却されます。
▼リリース後
　 お客様が選択したお届け希望日に応じたデータを連携
　 例）注文商品「(設定なし)」お届け希望日「(注文日翌日)」を選択　→　「2: あすつく注文」が返却されます。

リリース予定日：2019年6月中
※詳細はストアクリエイタProの「機能情報」をご確認ください。

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

  • totalResultsAvailable : 該当件数の総個数です。（1固定）
  • totalResultsReturned : 返された値の個数です。（1固定）
  • ok : 更新OKになった要素数です。（常に0か1です。）
  • ng : 更新NGになった要素数です。（常に0か1です。）
/ResultSet/Result 各個別レスポンスを含みます。
/ResultSet/Result/Status 処理成否（OK/NG）
/ResultSet/Result/Warning 警告情報（ある場合）
/ResultSet/Result/Warning/Code 警告コード（エラーコードと同じ体系です。）
/ResultSet/Result/Warning/Message 警告メッセージ
/ResultSet/Result/Warning/Detail 警告詳細（ある場合）

※なお、以下の条件で正常終了レスポンスに「警告」コードが付加される場合があります。
　警告が発生した場合でも、注文情報変更は完了します。

警告コード

コード 説明 発生条件
od91703 決済がキャンセル済みの為、金額連動が行われませんでした。 クレジットカード注文の金額変更の場合のみ発生します。
od91058 決済との連携エラー（対応不要です） 注文情報の更新を行った場合
od91059 決済との連携エラー（対応不要です） 金額変更を行った場合

サンプルレスポンス

<!--・サンプルXML-->

<ResultSet totalResultsAvailable="1" totalResultsReturned="1" ok="1" ng="0">
    <Result>
        <Status>OK</Status>
    </Result>
</ResultSet>

<!--・警告ありのサンプルXML-->

<ResultSet totalResultsAvailable="1" totalResultsReturned="1" ok="1" ng="0">
    <Result>
        <Status>OK</Status>
        <Warning>
            <Code>od91130</Code>
            <Message></Message>
            <Detail></Detail>
        </Warning>
    </Result>
</ResultSet>

エラー

Yahoo!ショッピングで提供している全てのAPIには、共通で利用するエラーコードがあります。エラーの際には、まず始めに以下をご確認ください。

注文内容変更APIで固有に返すエラーコードは以下をご覧ください。

フィールド 値 説明
/Error - エラーレスポンスのすべてを含みます。
/Error/Code string エラーコード
/Error/Message string エラーメッセージ
/Error/Detail - エラー詳細（ある場合）
/Error/Detail/SettleCode string 決済システムのエラーコード（APIエラーコードが「od91112」の場合）

エラーコード

コード HTTPステータスコード 説明
od90101 400 リクエストパラメータエラーです。
od91801 404 該当注文がありません。
od90103 400 リクエストと注文の整合性エラーです。
od90114 400 商品情報変更で、指定したラインIDが存在しません。
od90133 400 ポイント利用なしの決済の減額において、合計金額以上の減額をしようとしたエラーです。
od90135 400 決済上限金額を超えたエラーです。
od90146 400 第1類医薬品商品の追加はできません。
od90166 400 不正注文に対する変更不可エラーです。
od91008 500 内部エラーです。（DB参照）
od91009 500 内部エラーです。（DB更新）
od91011 500 内部エラーです。（データ変換）
od91012 500 内部エラーです。（データ更新）
od91101 500 内部エラーです。（ポイント突合）
od91110 500 決済エラーです。（メンテナンス）
od91112 500 決済エラーです。（システムエラー）
※このエラー発生時のリトライ処理は行わなわず決済方法を変更してください。
od91115 500 決済エラーです。（有効期限切れ）
※このエラー発生時のリトライ処理は行わなわず決済方法を変更してください。
od91116 500 決済エラーです。（疎通エラー）
od91118 500 決済エラーです。（一時的に操作不可）
※このエラー発生時のリトライ処理は行わなわず決済方法を変更してください。
od91119 500 決済エラーです。（決済操作不可）
※このエラー発生時のリトライ処理は行わなわず決済方法を変更してください。
od91121 500 決済エラーです。（決済処理エラー）
※このエラー発生時のリトライ処理は行わなわず決済方法を変更してください。
od91125 500 決済エラーです。（売上確定済み）
od91132 500 内部エラーです。
od91014 500 "更新情報キー"以外の項目指定エラーです。
od90901 400 更新許可がありません。
od90105 400 処理できないステータスです。
od91113 500 決済連携エラーです。（売上確定済み）
od90117 400 金額変更による決済キャンセル不可です。
od91127 500 お客様のPayPay残高が不足している際に発生するエラーです。
od91111 500 タイムアウトエラーです。連続して発生する場合はお問い合わせください。
od91120 500 システムエラーです。連続して発生する場合はお問い合わせください。
od91128 500 PayPay残高決済におけるシステムエラーです。連続して発生する場合はお問い合わせください。
od91139 500 エラー回数の上限に達したため、本日中は注文情報の操作が行えません。この注文者のクレジットカードは、現在使用できない状態です。
od91142 500 支払番号発行待ちによるエラーです。支払番号が更新されるまでお待ち下さい。
od91154 500 ポイント処理中による更新不可エラーです。しばらく（最大約60分）してから、再度お試しください。
od91902 404 メンテナンスエラー
od91201 500 決済エラーです。連続して発生する場合はお問い合わせください。
od90137 500 決済・ポイント処理を行っているため注文操作ができません。
od91102 500 ポイント残高不足により金額、ステータスの完了に変更をすることが出来ません
od91149 500 キャンセル受付中のため注文の更新不可のエラーです。
od90103 400 リクエストと注文の整合性エラーです。
od90152 400 出荷指示済み後の注文操作不可エラーです。
od90154 400 出荷キャンセル済み注文の注文操作不可エラーです。
od90155 400 ヤマトシステムへの連携処理中注文の注文操作不可エラーです。
od90158 400 該当キー更新時の注文操作不可エラーです。
od90160 400 ヤマト配送注文かつ支払方法が商品代引ではない場合に、代引き用消費税額の更新操作はできません。
od91166 500 決済におけるシステムエラーです。連続して発生する場合はお問い合わせください。
od00167 400 EAZY注文に関するリクエストパラメータ不正、または許可されていない変更を行おうとした場合のエラー
od91131 500 システムエラーです。連続して発生する場合はお問い合わせください。
od90150 400 Yahoo!オークション注文で受注から14日を超えると変更不可
od91013 500 システムエラーです。連続して発生する場合はお問い合わせください。
od90185 400 ヤマトフルフィルギフト注文で、必要な情報が未設定や不正な値が設定されている場合のエラー
od90186 400 商品情報の設定によりヤマトフルフィル注文にできない場合のエラー
od90187 400 セラーの設定によりヤマトフルフィル注文にできない場合のエラー
od90174 400 Yahoo Auction Order can not change (OrderSplit) : {注文ID}
Yahoo!オークション注文では変更できません。
od90175 400 配送伝票番号の不整合エラーです。
od90176 400 配送伝票番号不整合エラーによるお届け方法変更エラーです。
od90178 400 LINEギフト注文で変更不可な操作をした場合のエラー
od90180 400 LINEギフト注文でまだ操作不可な状態で変更操作が行われた場合のエラー
od90181 400 文字数制限となった場合のエラー
od90193 400 お支払い方法の変更ができません。

利用制限

※短い時間の間に同一URLに大量にアクセスを行った場合、一定時間利用できなくなることもございます。（1クエリー/秒）

利用約款

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

アプリケーションの管理

目次

利用のルール

開発のヒント