ショッピング

注文操作履歴一覧API

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


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

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

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

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

リクエストパラメータ

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

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

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


サンプルリクエスト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 変更内容



    サンプルレスポンス

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

    <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>システム</UpdatePerson>
          <Change>
            <Field>Note</Field>
            <Value>処理中とマーク</Value>
          </Change>
        </History>
        <History>
          <HistoryId>2</HistoryId>
          <UpdateTime>2011-08-20T11:10:30+09:00</UpdateTime>
          <UpdatePerson>矢風 太郎</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>
      </Result>
    </ResultSet>



    エラー

    注文操作履歴一覧APIはYahoo! JAPAN Web APIに共通のエラーメッセージおよびコードを返します。

    ・エラーコード

    コード HTTPステータスコード 説明
    od91801 404 指定されたorderIDが存在しません。(権限違反なども含みます。)
    od91005 500 サーバトラブル等
    od91902 404 メンテナンスエラー




    利用制限

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

    利用約款

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