【3/12追記あり】【Yahoo!ショッピング】弊社システム更新に伴う注文APIレスポンス変更のお知らせ

【3/12追記】注文検索API・注文詳細APIにつきましては、スケジュールの見直しによりテスト環境（SandBox）の提供開始日および変更日時が一度未定となりましたので、再度訂正いたします。
【2/28追記】テスト環境（SandBox）への注文検索APIおよび注文詳細APIの提供時期が決まりましたので追記いたしました。
【2/19追記】対象のAPIと変更日時および内容について
先日、今回の対応はすべての注文APIに影響があり、またその変更を2/25週で一斉に行うとご連絡いたしましたが、内容に誤りがありましたので下記の通り訂正いたします。
皆様にはお手数をおかけし申し訳ございませんが、再度ご確認のほどよろしくお願いいたします。

いつもYahoo! JAPANをご利用いただきありがとうございます。

弊社システム更新に伴い注文APIのレスポンスが一部変更になります。
影響がある可能性がございますので、ご確認おねがいします。

変更内容につきましてもAPIによって異なりますので、下記の変更１.～３.をご確認いただくようお願いいたします。

変更対象API

すべての注文API
注文ステータス別件数参照API
注文操作履歴一覧API
注文検索API
注文詳細API

変更日時

2025年2月25日週　※確定次第、本ページを更新します。
APIによって変更のタイミングが異なります。下記をご確認ください。
※日付が確定次第、更新します。

API	変更日時
注文ステータス別件数参照API	2025年3月3日週 2025年3月4日
注文操作履歴一覧API	2025年3月10日週 2025年3月11日
注文検索API	2025年3月17日週 2025年3月下旬
注文詳細API	2025年3月24日週 未定

【3/12追記】テスト環境（SandBox）の提供について

今回の変更に向け、事前にテスト環境（SandBox）を提供いたします。適宜動作確認などにご利用ください。

対象API

注文ステータス別件数参照API
注文操作履歴一覧API
注文検索API
注文詳細API

提供開始日

API	提供開始日
注文ステータス別件数参照API	2025年2月20日（木）
注文操作履歴一覧API	2025年2月20日（木）
注文検索API	2025年3月10日（月） 2025年3月中旬から下旬
注文詳細API	2025年3月17日（月） 未定

1. 注文APIの必須リクエストパラメータを設定していない場合のエラーレスポンス

対象API

注文ステータス別件数参照API
注文操作履歴一覧API
注文検索API
注文詳細API

変更内容

すべての注文APIで、必須であるリクエストパラメータが複数未設定でリクエストを行った際に、エラーとなった場合のレスポンスが変更になります。
対象の注文APIで、必須であるリクエストパラメータが複数未設定でリクエストを行った際に、エラーとなった場合のレスポンスが変更になります。

	レスポンス
現在の応答	不足しているパラメータ「全て」がMessageキーに含まれる
変更後の応答	不足しているパラメータの内「1つ」がMessageキーに含まれる

例：注文詳細APIでOrderId、Feildのリクエストパラメータが不足していた場合のレスポンス

	レスポンス	補足
現在の応答	<Error> <Code>od90101</Code> <Message>Request Parameter Error : OrderId,Field</Message> <Detail></Detail> </Error>	OrderIdとFieldがMessageキーに含まれる
変更後の応答	<Error> <Code>od90101</Code> <Message>Request Parameter Error : OrderId</Message> <Detail></Detail> </Error>	OrderIdのみがMessageキーに含まれる ※不足しているリクエストパラメータに対し、1件ずつエラーが返却されるようになります。 　レスポンスされるキーは順不同です。

2. 注文検索APIのConditionに未想定の検索条件キーがある場合のエラーレスポンス

変更対象API

注文検索API

変更内容

注文検索APIで、Conditionに複数の未想定の検索条件キーのリクエストを行った際に、エラーとなった場合のレスポンスが変更になります。

	レスポンス
現在の応答	未想定のキー「全て」がMessageキーに含まれる
変更後の応答	未想定のキーの内「1つ」がMessageキーに含まれる

例：複数の未想定の検索条件キー（NotDefinedOne、NotDefinedTwo）をリクエストした場合のレスポンス

	レスポンス	補足
現在の応答	<Error> <Code>od90101</Code> <Message>Request Parameter Error : Condition [NotDefinedOne][NotDefinedTwo]</Message> <Detail/> </Error>	NotDefinedOneとNotDefinedTwoがMessageキーに含まれる
変更後の応答	<Error> <Code>od90101</Code> <Message>Request Parameter Error : Condition [NotDefinedOne]</Message> <Detail/> </Error>	NotDefinedOneのみがMessageキーに含まれる ※未想定の検索条件キーに対し、1件ずつエラーが返却されるようになります。 　レスポンスされるキーは順不同です。

3.一部注文APIのレスポンスBodyのキーの順序

変更対象API

注文ステータス別件数参照API
注文操作履歴一覧API
注文検索API
注文詳細API

変更内容

対象の注文APIでレスポンスBodyのキーは、リクエストで指定した項目順に関係なく、Yahoo!ショッピングが定めた順序で返されます。


例：注文番号、分割フラグ、キャンセル理由の順番で指定した場合のレスポンス

リクエスト	レスポンス		補足
<Req> <Target> <OrderId>example-seller-10042668</OrderId> <Field>OrderId,IsSplit,CancelReason</Field> </Target> <SellerId>example-seller</SellerId> </Req>	現在の応答	<OrderId>example-seller-10042668</OrderId> <IsSplit>true</IsSplit> <CancelReason>300</CancelReason>	Fieldのリクエスト順でレスポンス 1.注文番号 2.分割フラグ 3.キャンセル理由
	変更後の応答	<IsSplit>true</IsSplit> <OrderId>example-seller-10042668</OrderId> <CancelReason>300</CancelReason>	Fieldのリクエスト順に関わらず、 Yahoo!ショッピングが定めた順序でレスポンス 1.分割フラグ 2.注文番号 3.キャンセル理由 ※レスポンス順の開示は致しかねますので、XML構造をparseして各フィールドの値を参照いただくようお願いいたします。

本件についてご不明な点やご要望などございましたら、
別途お送りするメールに記載の問い合わせ先をご確認の上、返答期限までにご連絡ください。

【ご返答期限】
※APIごとに返答期限が異なりますのでご注意ください。

注文ステータス別件数参照APIについて：2025年2月26日（水）17:00
注文操作履歴一覧APIについて　　　　：2025年3月3日（月）17:00
注文検索APIについて　　　　　　　　：テスト環境（SandBox）提供開始日から1週間後の17:00
※注文詳細APIにつきましてはスケジュールが決まり次第改めてご連絡いたします。


今後とも、Yahoo!ショッピングをどうぞよろしくお願いいたします。