ショッピング

クーポンキャンセルAPI

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


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

クーポンキャンセルAPIにはテスト用APIはありません。ご注意ください。


指定した注文情報のクーポン適応をキャンセルする機能を提供します。

リクエストパラメータ

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

パラメータ 説明
/Req リクエストパラメータ
/Req/Target 更新対象指定情報
/Req/Target/OrderId
(必須)
string 注文ID
/Req/Target/OperationUser string 更新者名(ビジネスID登録氏名)
セラー更新のみ
/Req/SellerId
(必須)
string ストアアカウント

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


サンプルリクエストURL

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

サンプルリクエスト

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

<Req>
<Target>
<OrderId>testseller-10000001</OrderId>
<OperationUser>矢風太郎</OperationUser>
</Target>
<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 警告詳細(ある場合)

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

・警告コード

コード 説明 発生条件
od91703 決済がキャンセル済みの為、金額連動が行われませんでした。 クレジットカード注文の金額変更の場合のみ発生します。




サンプルレスポンス

<!--・サンプル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>od91703</Code>
            <Message></Message>
            <Detail></Detail>
        </Warning>
    </Result>
</ResultSet>



エラー

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

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

・エラーコード

コード HTTPステータスコード 説明
od90101 400 リクエストパラメータエラーです。
od91801 404 該当注文がありません。
od90103 400 リクエストと注文の整合性エラーです。
od91008 500 内部エラーです。
od91009 500 内部エラーです。
od91011 500 内部エラーです。
od91012 500 内部エラーです。
od91101 500 内部エラーです。
od91110 500 メンテナンスにおける決済エラーです。
od91112 500 決済におけるシステムエラーです。
od91101 500 システムエラーです。連続して発生する場合はお問い合わせください。
od91115 500 有効期限切れによる決済エラーです。
od91116 500 疎通による決済エラーです。
od91118 500 一時的な操作不可による決済エラーです。
od91119 500 決済が操作不可であったため、決済連動を行えませんでした。
od91132 500 システムエラーです。
od90901 400 更新許可がありませんでした。
od90105 400 クーポンキャンセル不可注文です。
od91113 500 売上確定済みによる決済エラーです。
od90117 400 金額変更による決済キャンセルは不可です。
od91902 404 メンテナンスエラー




サンプルエラーレスポンス

<!--サンプルXML-->
<Error>
    <Code>od90101</Code>
    <Message>Request Parameter Error : OrderId</Message>
    <Detail></Detail>
</Error>

<!--Detail内にデータが存在するサンプルXML-->
<Error>
    <Code>od91112</Code>
    <Message>Internal Server Error</Message>
    <Detail>
        <SettleCode>6000</SettleCode>
    </Detail>
</Error>
   

利用制限

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

利用約款

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