注文ステータス変更API

注文の「注文ステータス」を変更します。

変更履歴

2023年10月30日

サービス名称変更に伴い下記文言を修正しました。
ヤフオク!、ヤフオク → Yahoo!オークション

2023年08月09日

下記エラーコードを追加しました。
・od90191
・od90192

2023年04月21日

警告コードとエラーコードを稼働している機能に即した説明に改版いたしました。

  • 「od91150、od91152、od91153、od91154、od91181」を警告コードからエラーコードへ移動
  • 警告コード「od91704」の説明を修正
  • 警告コード「od91705」の説明と発生条件を修正
  • 警告コードからエラーコードへ移した「od91153」の説明を修正

2023年04月06日

ページ上部に「FraudHoldStatus(不正保留ステータス)について」を追加しました。

2022年10月17日

下記エラーコードを追加しました。
od90180、od90183、od91060、od91061、od91062、od91063、od91183

2022年06月27日

下記エラーコードを追加しました。
・od91180

2022年03月10日

エラーコード「od90150」を追加しました。

2021年06月18日

エラーコード「od90166」を追加します。

利用申請について

本番環境について

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

テスト環境について

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

リクエストURL

本番環境
https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/orderStatusChange
テスト環境
https://test.circus.shopping.yahooapis.jp/ShoppingWebService/V1/orderStatusChange

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

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

※注文ステータスに「新規注文」、「新規予約」はありません。注文情報の閲覧済みフラグと組み合わせて表現されるものです。

  • 「新規注文」:注文ステータス「処理中」かつ閲覧済みフラグ「false」
  • 「新規予約」:注文ステータス「予約中」かつ閲覧済みフラグ「false」

※1:発売日が現在より未来の場合は変更可能
※2:いたずら注文の場合は変更不可
※3:「クレジットカード決済」と自社での決済(銀行振り込み、商品代引き、など)については「処理中」に戻すことで、調整額による注文金額の変更がおこなえます(数量変更や商品金額の変更はできません)。 また、一度注文「完了」した後「処理中」に戻した注文は最初の注文完了日から180日を経過すると自動的に「完了」となります。
※4:一度注文「完了」した後「処理中」に戻した注文は、「保留」に変更不可
※5 配送伝票番号もしくは配送伝票番号なし理由の入力がない場合、注文を完了にはできません。
  また出荷ステータスが「出荷済み」「着荷済み」ではない場合も同様に、注文を完了にはできません。

FraudHoldStatus(不正保留ステータス)について

FraudHoldStatus(不正保留ステータス)の状態によっては、意図した注文ステータスの更新ができない場合があります。
値ごとの注文ステータスの変更可否は下記の通りです。

FraudHoldStatus注文ステータス変更可否
0 or null:不正リスク低〇(変更可能)
1:ルール保留審査中△(キャンセルへの変更のみ可能)
2:ルール保留解除〇(変更可能)
3:ルール悪用確定△(キャンセルへの変更のみ可能)
FraudHoldStatus(不正保留ステータス)は「注文詳細API」で取得が可能です。

キャンセル理由詳細カラム追加について

キャンセル理由「ストア都合:その他」が選択されている場合、その理由を出店者様が
自由に記載できる「キャンセル理由詳細」項目を追加いたします。

当項目は、キャンセル理由「ストア都合:その他」が選択された状態のみ入力可能かつ必須項目です。
未入力時はエラーとなりますので、ご注意ください。

また、当項目に記載された内容ついて、キャンセルメールにてお客様に自動送信されます。
お客様が閲覧する内容となりますので、記載内容については十分にご注意ください。
あわせて、お客様の個人情報は入力しないよう、よろしくお願いします。

リクエストパラメータ

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

パラメータ 説明
/Req リクエストパラメータ
/Req/Target 更新対象指定情報
/Req/Target/OrderId
(必須)
string 注文ID
/Req/Target/IsPointFix
(必須)
boolean ポイント確定要否(ポイントについてはこちら
true : ポイント確定します。
false : ポイント確定しません。
※注文ステータスを「完了」に変更する際は、必ずポイント確定要否をtrueに指定してください。
/Req/Target/OperationUser string 更新者名(ビジネスID登録氏名)
※120文字まで入力可
/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や指定がない場合は「210」が選択されます
 7/20以降
※こちらのパラメーターは2015/10/14よりご利用いただけます
/Req/Oeder/CancelReasonDetail string キャンセル理由詳細
10文字以上、200文字以内で入力
「/Req/Order/CancelReason」にて230(ストア都合:その他)を送信した際、この値がnullの場合、エラーとなります。
※2017年7月20日(木) 本番環境反映予定

※1)注文ステータスを「キャンセル」にするとシステムが自動で注文キャンセルメールを購入者に送信します。

※こちらのAPIはYahoo! ID連携に対応したAPIです。
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がカンマ区切りで入ります。
od91150 アフィリエイト料率確定中のため、注文ステータスを完了に更新できません。 アフィリエイト料率確定中のため、注文ステータスを完了に更新できません。
しばらくしてから再度お試し頂き、解消しない場合はお問い合わせください。
od91152 配送伝票番号が入力されていないため、注文ステータスを完了にできません。 配送伝票番号を入力してから、注文ステータスの変更をお願いします。
od91153 配送伝票番号が入力されていないため、注文ステータスを完了にできません。 配送伝票番号を入力してから、注文ステータスの変更をお願いします。
od91154 ポイント処理中による更新不可エラーです。 しばらく(最大約60分)してから、再度お試しください。
od91705 出荷ステータスが「出荷済み」または「着荷済み」ではないため、注文ステータスを完了にできません。
更新前と更新後で注文ステータスが変更されていません。
出荷ステータスを「出荷済み」または「着荷済み」にしてから、注文ステータスの変更をお願いします。
注文情報の注文ステータスと同じステータスで更新がリクエストされました。 更新する注文ステータスをご確認ください。
od91704 注文キャンセルの保存に失敗しました。
注文キャンセルの更新を受け付けました。時間差で順次更新処理を行います。
※しばらくしても注文ステータスにならない場合は、再度お試しください。
注文キャンセル保存失敗時に発生します。
od91181 アフィリエイト料率計算中です。
しばらく(最大約10分)してから、再度お試しください。
解消しない場合は、エラーコード、注文番号、操作日時などの情報を添えて、お問い合わせください。

エラーコードの一覧はこちらをご確認ください。

サンプルレスポンス

<!--・サンプル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>

エラー

よくある質問:エラーコード「od91008」が返ってくる。

出荷ステータス更新API(orderShipStatusChange)を実行した直後に注文ステータス変更API(orderStatusChange)にリクエストすると、こちらのエラーが発生する可能性があります。
出荷ステータス更新APIを実行した場合は、実行後しばらく時間をおいてから注文ステータス変更APIを実行してください。

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

注文ステータス変更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(ポイント確定する)を指定してください。
od90166 400 不正注文に対する変更不可エラーです。
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 システムエラーです。連続して発生する場合はお問い合わせください。
od91150 500 アフィリエイト料率確定中のため、注文ステータスを完了に更新できません。
od91152 500 配送伝票番号が入力されていないため、注文ステータスを完了にできません。
od91153 500 配送伝票番号が入力されていないため、注文ステータスを完了にできません。
出荷ステータスが「出荷済み」または「着荷済み」ではないため、注文ステータスを完了にできません。
od91154 500 ポイント処理中による更新不可エラーです。
od91201 500 決済エラーです。連続して発生する場合はお問い合わせください。
od91149 500 キャンセル受付中のため注文の更新不可のエラーです。
od91902 404 メンテナンスエラー
od90152 400 出荷指示済み後の注文操作不可エラーです。
od90155 400 ヤマトシステムへの連携処理中注文の注文操作不可エラーです。
od91165 500 出荷指示ステータスが「着荷完了」ではないため、注文ステータスを完了にできません
od90150 400 Yahoo!オークション注文で受注から14日を超えると変更不可
od91180 500 システムエラーです。連続して発生する場合はお問い合わせください。
od91181 500 アフィリエイト料率計算中です。
しばらく(最大約10分)してから、再度お試しください。
od90180 400 LINEギフト注文でまだ操作不可な状態で変更操作が行われた場合のエラー
od90183 400 LINEギフト注文で注文ステータスを保留にしようとした場合のエラー
od91060 500 LINEギフト注文の注文キャンセル時にLINE側都合(キャンセル可能期間が過ぎているなど)で失敗した場合のエラー
od91061 500 LINEギフト注文のAPIと連携エラーした場合のエラー
od91062 500 LINEギフト注文のAPIでタイムアウトが発生した場合のエラー
od91063 500 LINEギフト注文のAPIで他のエラーに分類できないエラーが発生した場合のエラー
od91183 500 LINEギフト注文で出荷ステータスが「出荷済み」または「着荷済み」以外で注文ステータスを完了にしようとした場合のエラー
od90191 400 注文ステータスを「完了」に変更できません。「完了」以外への変更は可能です。
od90192 400 注文者都合のキャンセル理由は選択できません。ストア都合のキャンセル理由のみ選択可能です。

利用制限

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

利用約款

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

アプリケーションの管理

目次

利用のルール

開発のヒント