定期購入親注文一括解約API

定期購入の申し込みを一括で解約する機能を提供します。
※解約対象の親注文が多い場合、処理完了までに30秒ほどかかる可能性があります。

利用申請について

本番環境について

定期購入APIを利用する場合は別途利用申請が必要です。下記フォームから申請をお願いします。
ショッピング定期購入API利用申請フォーム
※既に注文APIをご利用中のお客様に関しては、追加で申請をしていただく必要はありません。

テスト環境について

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

リクエストとレスポンスで共通する事項について

• 最大長の単位は文字数で、半角も全角もそれぞれ1文字で扱います。

リクエストURL

リクエストパラメータ

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

リクエストURL

パラメータ	必須	型	最大長	説明
（なし）

リクエストボディ（JSON）

パラメータ	必須	型	説明
sellerId	〇	string	ストアアカウント
cancelReason	〇	string	解約理由 （一覧はこちら）
cancelReasonDetail		string	解約理由詳細
targets	〇	array	指定できる定期購入番号は200件以下
subscriptionId	〇	string	定期購入番号

サンプルリクエストURL

https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/subscription/order/origins/cancel

サンプルリクエスト

PATCH /ShoppingWebService/V1/subscription/order/origins/cancel HTTP/1.1
Host: circus.shopping.yahooapis.jp
Authorization: Bearer <アクセストークン>

{
"sellerId"："teststore",
"cancelReason": 230,
"cancelReasonDetail": "間違って購入したため",
"targets": [
 {
   "subscriptionId": "teiki-20220823-teststore-abc12345"
 },
 {
   "subscriptionId": "teiki-20220823-teststore-abc12346"
 }
]
}

レスポンスフィールド

• 全件OK：200
• 1件でもNG（全件NGも含む）：207

要素	キー名	必須	型	最大長	名称
results		○	array
	subscriptionId	○	string	70	定期購入番号
	result	○	string	2	解約結果 OK: 解約成功 NG: 解約対象の定期購入番号が存在せず

サンプルレスポンス

レスポンス（JSON）

{
"results": [
 {"subscriptionId": "teiki-XXXX-0001", result: "OK"},
 {"subscriptionId": "teiki-XXXX-0002", result: "OK"},
 {"subscriptionId": "teiki-XXXX-0003", result: "OK"}
]
}

エラー

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

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

定期購入APIで固有に返すエラーコードは以下をご覧ください。

• 定期購入APIで共通に利用する定義 - エラーコード

利用制限

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

利用約款

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