定期購入情報変更API

定期購入の申し込み情報を変更する機能を提供します。

利用申請について

本番環境について

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

テスト環境について

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

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

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

リクエストURL

本番環境

https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/subscription/order/origin/{subscription_id}/change
※subscription_id：定期購入番号

テスト環境

https://test.circus.shopping.yahooapis.jp/ShoppingWebService/V1/subscription/order/origin/{subscription_id}/change
※subscription_id：定期購入番号

リクエストパラメータ

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

キー名	必須	型	最大長	名称	説明
sellerId	〇	string			ストアアカウント
subscriptionReplicaId	〇	string	80	変更対象子注文ID	定期購入子注文ID 定期購入子注文一覧取得APIで取得したphase=0〜1の定期購入子注文IDを指定
changes	〇	object		変更する項目を指定

-　変更する項目（changes）：

キー名		必須	型	最大長	名称	説明
shipMethod			string	9	配送方法	postage1~14またはpostage16
shipCharge			number	8	送料	0以上99999999以下
payMethod			string	11	支払方法	payment_a1：クレジットカード決済 payment_a19：PayPayあと払い payment_d1：商品代引き
payCharge			number	8	手数料	0以上99999999以下
shipAddressFrom			string	2	お届け先
shipFirstName			string	全角50 ※1	お届け先氏名(名)
shipFirstNameKana			string	全角50 ※1	お届け先氏名(名)カナ
shipLastName			string	全角50 ※1	お届け先氏名(姓)
shipLastNameKana			string	全角50 ※1	お届け先氏名(姓)カナ
shipZipCode			string	8	お届け先郵便番号
shipPrefecture			string	全角4 ※1	お届け先都道府県
shipCity			string	全角25 ※1	お届け先市区町村
shipAddress1			string	全角50 ※1	お届け先住所1
shipAddress2			string	全角50 ※1	お届け先住所2
billMailAddress			string	99	ご請求先メールアドレス
storeNotes			string	全角500 ※1	ストア内メモ
cycle			object		配送サイクル
	type	〇 ※2	string	1	配送サイクルタイプ（日or月）	0：日 1：月
	day		number	2	日周期	10~90 30日ごとの場合「30」
	month		number	1	月周期	1~6 例）2ヶ月ごとの場合「2」

※1 半角英数字記号の場合2文字で1カウント
※1 1byte文字の場合2文字で1カウント
※2 cycleありの場合のみ必須

サンプルリクエストURL

https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/subscription/order/origin/teiki-20220915-teststore-abc12345/change

サンプルリクエスト

PATCH /ShoppingWebService/V1/subscription/order/origin/teiki-20220915-teststore-abc12345/change HTTP/1.1
Host: circus.shopping.yahooapis.jp
Authorization: Bearer <アクセストークン>
  
{
  "sellerId"："teststore",
  "subscriptionReplicaId": "teiki-20220915-teststore-abc12345-0002",
  "changes": {
    "shipMethod": "postage1",
    "shipCharge": 100,
    "payMethod": "payment_a1",
    "payCharge": 0,
    "shipAddressFrom": "P",
    "shipFirstName": "矢風",
    "shipFirstNameKana": "ヤフウ",
    "shipLastName": "太郎",
    "shipLastNameKana": "タロウ",
    "shipZipCode": "111-1111",
    "shipPrefecture": "東京都",
    "shipCity": "千代田区",
    "shipAddress1": "紀尾井町1-3",
    "shipAddress2": "東京ガーデンテラス紀尾井町 紀尾井タワー",
    "storeNotes": "ストアのコメント",
    "billMailAddress": "sample@yahoo-corp.jp"
  }
}

サンプルレスポンス

レスポンス（JSON）

{
  "result": "OK"
}

エラー

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

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

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

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

利用制限

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

利用約款

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

テスト環境申請時のYIDとは異なるYIDでログインされているため、エラーが発生しております。テスト環境申請時のYIDとは異なるYIDでログインされているため、エラーが発生しております。

アプリケーションの管理