ショッピング

注文ステータス別件数参照

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


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

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

新規注文、新規予約注文の件数を取得する機能を提供します。

リクエストパラメータ

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

パラメータ 説明
sellerId
(必須)
string ストアアカウントを指定します。

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


サンプルリクエストURL

http://circus.shopping.yahooapis.jp/ShoppingWebService/V1/orderCount?sellerId=teststore

サンプルリクエスト

GET /ShoppingWebService/V1/orderCount?sellerId=teststore HTTP/1.1
Host: circus.shopping.yahooapis.jp
Authorization: Bearer <アクセストークン>



レスポンスフィールド

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

  • totalResultsAvailable : 該当件数の総個数です。
  • totalResultsReturned : 返却され、かつマッチした件数です。
  • firstResultPosition : データの取得開始位置です。

/ResultSet/Result 各個別レスポンスを含みます。
/ResultSet/Result/Status 取得成否(OK/NG)
/ResultSet/Result/Count
/ResultSet/Result/Count/NewOrder 新規注文件数(注文詳細未読件数)
/ResultSet/Result/Count/NewReserve 新規予約件数
/ResultSet/Result/Count/WaitPayment 入金待ち件数
/ResultSet/Result/Count/WaitShipping 出荷待ち件数
/ResultSet/Result/Count/Shipping 出荷処理中件数
/ResultSet/Result/Count/Reserve 予約中件数
/ResultSet/Result/Count/Holding 保留件数
/ResultSet/Result/Count/WaitDone 注文完了待ち件数
/ResultSet/Result/Count/Suspect いたずら注文件数
/ResultSet/Result/Count/SettleError 決済エラー件数
/ResultSet/Result/Count/Refund 返金対象件数
/ResultSet/Result/Count/AutoDone 注文自動完了件数
/ResultSet/Result/Count/AutoWorking 注文自動保留解除件数
/ResultSet/Result/Count/Release 発売予定注文件数
/ResultSet/Result/Count/NoPayNumber 支払い番号未発行件数
/ResultSet/Result/Count/StoreStatus1 ストアステータス1件数
/ResultSet/Result/Count/StoreStatus2 ストアステータス2件数
/ResultSet/Result/Count/StoreStatus3 ストアステータス3件数
/ResultSet/Result/Count/StoreStatus4 ストアステータス4件数
/ResultSet/Result/Count/StoreStatus5 ストアステータス5件数
/ResultSet/Result/Count/StoreStatus6 ストアステータス6件数
/ResultSet/Result/Count/StoreStatus7 ストアステータス7件数
/ResultSet/Result/Count/StoreStatus8 ストアステータス8件数
/ResultSet/Result/Count/StoreStatus9 ストアステータス9件数
/ResultSet/Result/Count/StoreStatus10 ストアステータス10件数



サンプルレスポンス

<ResultSet totalResultsAvailable="1" totalResultsReturned="1" firstResultPosition="1">
      <Result>
        <Status>OK</Status>
        <Count>
          <NewOrder>27</NewOrder>
          <NewReserve>4</NewReserve>
          <WaitPayment>12</WaitPayment>
          <WaitShipping>14</WaitShipping>
          <Shipping>3</Shipping>
          <Reserve>5</Reserve>
          <Holding>10</Holdingr>
          <WaitDone>1</WaitDone>
          <Suspect>0</Suspect>
          <SettleError>0</SettleError>
          <Refund>2</Refund>
          <AutoDone>4</AutoDone>
          <AutoWorking>7</AutoWorking>
          <Release>4</Release>
          <NoPayNumber>1</NoPayNumber>
          <StoreStatus1>3</StoreStatus1>
          <StoreStatus2>7</StoreStatus2>
          <StoreStatus3>8</StoreStatus3>
          <StoreStatus4>10</StoreStatus4>
          <StoreStatus5>1</StoreStatus5>
          <StoreStatus6>0</StoreStatus6>
          <StoreStatus7>2</StoreStatus7>
          <StoreStatus8>11</StoreStatus8>
          <StoreStatus9>9</StoreStatus9>
          <StoreStatus10>11</StoreStatus10>
        </Count>
      </Result>
    </ResultSet> 
   



エラー

注文ステータス別件数参照はYahoo! JAPAN Web APIに共通のエラーメッセージおよびコードを返します。

・エラーコード

コード HTTPステータスコード 説明
od90101 400 リクエストパラメータエラー
od91003 500 サーバトラブル等
od91902 404 メンテナンスエラー




利用制限

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

利用約款

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