定期購入お届け予定日変更API

定期購入のお届け予定日を変更する機能を提供します。

利用申請について

本番環境について

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

テスト環境について

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

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

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

リクエストURL

リクエストパラメータ

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

リクエストURL

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

リクエストボディ（JSON）

パラメータ	必須	型	説明
subscriptionReplicaId	〇	string	定期購入子注文ID (キャンセルする子注文IDを指定）
nextShipDate	〇	string	変更後の次回配送予定日 yyyy-MM-dd 形式

サンプルリクエストURL

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

サンプルリクエスト

PATCH /ShoppingWebService/V1/subscription/order/origin/teiki-20220915-teststore-abc12345/shipdate HTTP/1.1
Host: circus.shopping.yahooapis.jp
Authorization: Bearer <アクセストークン>
  
{
  "subscriptionReplicaId": "teiki-20220915-teststore-abc12345-0002",
  "nextShipDate": "2022-10-15"
}

サンプルレスポンス

レスポンス（JSON）

{
  "result": "OK"
}

エラー

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

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

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

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

利用制限

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

利用約款

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