入金ステータス変更API

注文の支払状況を管理するための「入金ステータス」の更新機能を提供します。

変更履歴

利用申請について

本番環境について

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

テスト環境について

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

リクエストURL

【入金ステータス遷移表】

	変更後
変更前	0 : 入金待ち	1 : 入金済み
0 : 入金待ち	×	◯
1 : 入金済み	×	×

• 入金ステータスを「入金済み」に変更すると、出荷ステータスが「出荷不可」の場合は、自動的に「出荷可」に更新されます。

リクエストパラメータ

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

パラメータ	型	説明
/Req		リクエストパラメータ
/Req/Target		更新対象指定情報
/Req/Target/OrderId （必須）	string	注文ID
/Req/Target/OperationUser	string	更新者名（ビジネスID登録氏名） セラー更新のみです。
/Req/Order		更新情報
/Req/Order/Pay		支払情報
/Req/Order/Pay/PayStatus （必須）	integer	入金ステータス 0 : 入金待ち 1 : 入金済み
/Req/Order/Pay/PayDate	string	入金日（YYYYMMDD）
/Req/SellerId （必須）	string	ストアアカウント

サンプルリクエストURL

https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/orderPayStatusChange

サンプルリクエスト

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

<Req>
 <Target>
  <OrderId>testseller-10000001</OrderId>
  <OperationUser>家風太郎</OperationUser>
 </Target>
 <Order>
  <Pay>
   <PayStatus>1</PayStatus>
   <PayDate>20130522</PayDate>
  </Pay>
 </Order>
 <SellerId>testseller</SellerId>
</Req>

レスポンスフィールド

フィールド	説明
/ResultSet	クエリーレスポンスのすべてを含み、次の属性を持ちます。 totalResultsAvailable : 該当件数の総個数です。 totalResultsReturned : 返された値の個数です。 ok : 更新OKになった要素数です。（常に1です。） ng : 更新NGになった要素数です。（常に0です。）
/ResultSet/Result	各個別レスポンスを含みます。
/ResultSet/Result/Status	処理成否（OKのみ）

サンプルレスポンス

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

エラー

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

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

入金ステータス変更APIで固有に返すエラーコードは以下をご覧ください。

フィールド	値	説明
/Error	-	エラーレスポンスのすべてを含みます。
/Error/Code	string	エラーコード
/Error/Message	string	エラーメッセージ
/Error/Detail	-	エラー詳細

エラーコード

コード	HTTPステータスコード	説明
od90101	400	リクエストパラメータエラーです。
od90103	400	リクエストと注文の整合性エラーです。
od90104	400	決済方法未選択です。
od90105	400	処理できないステータスです。
od90166	400	不正注文に対する変更不可エラーです。
od90901	403	更新許可がありません。
od91801	404	該当注文がありません。
od91008	500	システムエラーです。連続して発生する場合はお問い合わせください。
od91009	500	システムエラーです。連続して発生する場合はお問い合わせください。
od91132	500	システムエラーです。連続して発生する場合はお問い合わせください。
od91149	500	キャンセル受付中のため注文の更新不可のエラーです。
od91902	404	メンテナンスエラー
od90178	400	LINE注文で変更不可な操作をした場合のエラー

利用制限

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

利用約款

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