注文操作履歴一覧API

単一の注文に対しての更新履歴情報を提供します。

【使い方】
変更履歴情報は受注以降の注文情報への更新情報を保持しています。
更新内容は差分の発生する内容のみ保持しています。
そのため、取得した注文情報を履歴IDの順番に上書きしていくことで特定の時点での注文内容を確認することができるようになります。

変更履歴

利用申請について

本番環境について

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

テスト環境について

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

リクエストURL

リクエストパラメータ

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

パラメータ	値	説明
orderId （必須）	string	注文ID
sellerId （必須）	string	ストアアカウント

サンプルリクエストURL

https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/orderChangeHistory?orderId=tanarkystore-10000001&sellerId=tanarkystore

サンプルリクエスト

GET /ShoppingWebService/V1/orderChangeHistory?orderId=tanarkystore-10000001&sellerId=tanarkystore HTTP/1.1
Host: circus.shopping.yahooapis.jp
Authorization: Bearer <アクセストークン>

レスポンスフィールド

フィールド	説明
/ResultSet	クエリーレスポンスのすべてを含み、次の属性を持ちます。 totalResultsAvailable : 該当件数の総個数です。 totalResultsReturned : 返却され、かつマッチした件数です。 firstResultPosition : データの取得開始位置です。
/ResultSet/Result	各個別レスポンスを含みます。
/ResultSet/Result/Status	取得成否（OK/NG）
/ResultSet/Result/History
/ResultSet/Result/History/HistoryId	履歴ID
/ResultSet/Result/History/UpdateTime	更新日時
/ResultSet/Result/History/UpdatePerson	更新者（以下のいずれかが入ります） Yahoo! JAPAN ビジネスIDに紐づく作業者氏名 Yahoo! JAPAN ビジネスID Yahoo! JAPAN ID system ※システム更新については自動連動などによる更新内容なども含みます。
/ResultSet/Result/History/Change
/ResultSet/Result/History/Change/Field	変更フィールド
/ResultSet/Result/History/Change/Value	変更内容 ※個人情報に関してのValueは空です。
/ResultSet/Result/History/Change/Item
/ResultSet/Result/History/Change/Item/LineId	ラインID
/ResultSet/Result/History/Change/Item/Field	変更フィールド
/ResultSet/Result/History/Change/Item/Value	変更内容

サンプルレスポンス

※HistoryId１について、新規注文登録や落札情報登録に関しても変更履歴として保存されるため、
　登録された情報全てのフィールド名と値が返却されます。

<ResultSet totalResultsAvailable="2" totalResultsReturned="2" firstResultPosition="1">
  <Result>
    <Status>OK</Status>
    <History>
      <HistoryId>1</HistoryId>
      <UpdateTime>2011-08-19T21:12:33+09:00</UpdateTime>
      <UpdatePerson><![CDATA[system]]></UpdatePerson>
      <Change>
        <Field>Note</Field>
        <Value>処理中とマーク</Value>
      </Change>
    </History>
    <History>
      <HistoryId>2</HistoryId>
      <UpdateTime>2022-04-02T11:10:30+09:00</UpdateTime>
      <UpdatePerson><![CDATA[矢風　太郎]]></UpdatePerson>
      <Change>
        <Field>ShippingCharge</Field>
        <Value>50</Value>
      </Change>
      <Change>
        <Field>TotalPrice</Field>
        <Value>27950</Value>
      </Change>
      <Change>
        <Item>
          <LineId>1</LineId>
          <Field>Quantity</Field>
          <Value>2</Value>
        </Item>
      </Change>
      <Change>
        <Item>
          <LineId>1</LineId>
          <Field>UnitPrice</Field>
          <Value>1000</Value>
        </Item>
      </Change>
      <Change>
        <Item>
          <LineId>2</LineId>
          <Field>Quantity</Field>
          <Value>3</Value>
        </Item>
      </Change>
    </History>
    <History>
      <HistoryId>3</HistoryId>
      <UpdateTime>2022-04-2T12:30:33+09:00<</UpdateTime>
      <UpdatePerson><![CDATA[line_system]]></UpdatePerson>
      <Change>
        <Field>OperationUser</Field>
        <Value><![CDATA[line_system]]></Value>
      </Change>
      <Change>
        <Field>LineGiftPayMethodName</Field>
        <Value><![CDATA[PayPay決済]]></Value>
      </Change>
      <Change>
        <Field>ShippingDeadline</Field>
        <Value>2022-03-15T17:11:50+09:00</Value>
      </Change>
      <Change>
        <Field>IsLineGiftShippable</Field>
        <Value>true</Value>
      </Change>
    </History>
  </Result>
</ResultSet>

エラー

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

• Yahoo! ショッピングAPI共通エラーコード一覧

注文操作履歴一覧APIで固有に返すエラーコードは以下をご覧ください。

エラーコード

コード	HTTPステータスコード	説明
od90166	400	不正注文に対する変更不可エラーです。
od91801	404	指定されたorderIDが存在しません。（権限違反なども含みます。）
od91005	500	サーバトラブル等
od91902	404	メンテナンスエラー

利用制限

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

利用約款

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