ショッピング

注文ステータス変更API

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


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

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

指定注文の注文ステータスを変更します。

【注文ステータス遷移表】

変更後
変更前 1 : 予約中 2 : 処理中 3 : 保留 4 : キャンセル 5 : 完了
1 : 予約中 × × × ◯ ※2
2 : 処理中 × × ◯ ※4 ◯ ※2
3 : 保留 × ※1 ◯ ※2 × ◯ ※2
4 : キャンセル × × × × ×
5 : 完了 × ◯ ※3 × ◯ ※2 ×


※注文ステータスに「新規注文」、「新規予約」はありません。注文情報の閲覧済みフラグと組み合わせて表現されるものです。
・「新規注文」:注文ステータス「処理中」かつ閲覧済みフラグ「false」
・「新規予約」:注文ステータス「予約中」かつ閲覧済みフラグ「false」
※1:発売日が現在より未来の場合OK
※2:いたずら注文の場合不可
※3:「クレジットカード決済」と自社での決済(銀行振り込み、商品代引き、など)については「処理中」に戻すことで、調整額による注文金額の変更がおこなえます(数量変更や商品金額の変更はできません)。 また、一度注文「完了」した後「処理中」に戻した注文は最初の注文完了日から180日を経過すると自動的に「完了」となります。
※4:一度注文「完了」した後「処理中」に戻した注文は、「保留」に変更不可

リクエストパラメータ

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

パラメータ 説明
/Req リクエストパラメータ
/Req/Target 更新対象指定情報
/Req/Target/OrderId
(必須)
string 注文ID
/Req/Target/IsPointFix
(必須)
boolean ポイント確定要否(ポイントについてはこちら
true : ポイント確定します。
false : ポイント確定しません。
※注文ステータスを「完了」に変更する際は、必ずポイント確定要否をtrueに指定してください。
/Req/Target/OperationUser string 更新者名(ビジネスID登録氏名)
/Req/Order 更新情報
/Req/Order/OrderStatus
(必須)
integer 注文ステータス
1 : 予約中
2 : 処理中
3 : 保留
4 : キャンセル(※1)
5 : 完了
/Req/SellerId
(必須)
string ストアアカウント
/Req/Order/CancelReason integer ■注文者都合
100:キャンセル
110:返品
120:未入金
130:住所不明
140:受け取り拒否
150連絡不通
160重複注文
170決済審査不可
180その他

■ストア都合
200:決済方法都合
210:欠品
220:販売中止
230:その他

※nullや指定がない場合は「230」が選択されます
※こちらのパラメーターは2015/10/14よりご利用いただけます
(※1)注文ステータスを「キャンセル」にするとシステムが自動で注文キャンセルメールを購入者に送信します。

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


サンプルリクエストURL

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

サンプルリクエスト

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

<Req>
 <Target>
  <OrderId>testseller-10000001</OrderId>
  <IsPointFix>false</IsPointFix>
  <OperationUser>矢風太郎</OperationUser>
 </Target>
 <Order>
  <OrderStatus>4</OrderStatus>
 </Order>
 <SellerId>testseller</SellerId>
</Req>



レスポンスフィールド

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

  • totalResultsAvailable : 該当件数の総個数です。
  • totalResultsReturned : 返された値の個数です。
  • ok : 更新OKになった要素数です。(常に1です。)
  • ng : 更新NGになった要素数です。(常に0です。)

/ResultSet/Result 各個別レスポンスを含みます。
/ResultSet/Result/Status 処理成否(OKのみ)
/ResultSet/Result/Warning 警告情報(ある場合)
/ResultSet/Result/Warning/Code 警告コード(エラーコードと同じ体系です。)
/ResultSet/Result/Warning/Message 警告メッセージ
/ResultSet/Result/Warning/Detail 警告詳細(ある場合)

※なお、以下の条件で正常終了レスポンスに「警告」コードが付加される場合があります。
 警告が発生した場合でも、注文ステータスの更新は完了します。

・警告コード

コード 説明 発生条件
od91113 決済が既に売上確定済みであった為、新たに売上確定は行いませんでした。 クレジットカード決済注文の「注文完了」遷移時のみ発生します。
od91115 決済が有効期限切れであった為、決済連動を行いませんでした。 クレジットカード決済注文の「注文完了」「キャンセル」遷移時のみ発生します。
od91123 返金があります。 キャリア決済、コンビニ決済注文の「キャンセル」変更時のみ発生します。
キャリア決済の場合、/ResultSet/Result/Warning/DetailにResultStatusとSbpsErrorCodeが入ります。
コンビニ決済の場合はDetailはありません。
od91130 在庫連携エラーです。 /ResultSet/Result/Warning/DetailにラインIDがカンマ区切りで入ります。
od91705 更新前と更新後で、ステータスが変更されていませんでした。 更新系APIにて同一ステータスへの更新時に発生します。
od91704 注文キャンセルの保存に失敗しました。 注文キャンセル保存失敗時に発生します。




サンプルレスポンス

<!--・サンプルXML-->

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


<!--・警告ありのサンプルXML-->

<ResultSet totalResultsAvailable="1" totalResultsReturned="1" ok="1" ng="0">
    <Result>
        <Status>OK</Status>
        <Warning>
            <Code>od91130</Code>
            <Message></Message>
            <Detail></Detail>
        </Warning>
    </Result>
</ResultSet>



エラー

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

フィールド 説明
/Error - エラーレスポンスのすべてを含みます。
/Error/Code string エラーコード
/Error/Message string エラーメッセージ
/Error/Detail - エラー詳細(ある場合)
/Error/Detail/SettleCode string 決済システムのエラーコード(APIエラーコードが「od91112」の場合)

・エラーコード

コード HTTPステータスコード 説明
od90101 400 リクエストパラメータエラーです。
od90103 400 リクエストと注文の整合性エラーです。
od90105 400 処理できないステータスです。
od90134 400 注文ステータス「完了」変更時のポイント未確定エラーです。IsPointFix=true(ポイント確定する)を指定してください。
od90901 403 更新許可がありません。
od91801 404 該当注文がありません。
od91008 500 システムエラーです。連続して発生する場合はお問い合わせください。
od91009 500 システムエラーです。連続して発生する場合はお問い合わせください。
od91011 500 システムエラーです。連続して発生する場合はお問い合わせください。
od91012 500 システムエラーです。連続して発生する場合はお問い合わせください。
od91101 500 システムエラーです。連続して発生する場合はお問い合わせください。
od91110 500 決済におけるメンテナンスエラーです。連続して発生する場合はお問い合わせください。
od91112 500 決済におけるシステムエラーです。連続して発生する場合はお問い合わせください。
od91116 500 決済エラーです。連続して発生する場合はお問い合わせください。
od91118 500 決済エラーです。連続して発生する場合はお問い合わせください。
od91119 500 決済が操作不可であったため、決済連動を行えませんでした。連続して発生する場合はお問い合わせください。
od91132 500 システムエラーです。連続して発生する場合はお問い合わせください。
od91902 404 メンテナンスエラー
od91201 500 決済エラーです。連続して発生する場合はお問い合わせください。




利用制限

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

利用約款

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