定期購入情報変更履歴詳細API

定期購入情報を変更した履歴の詳細情報を取得する機能を提供します。

利用申請について

本番環境について

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

テスト環境について

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

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

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

リクエストURL

リクエストパラメータ

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

リクエストURL

パラメータ	型	説明
sellerId （必須）	string	ストアアカウントを指定します。

サンプルリクエストURL

https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/subscription/order/origin/teiki-20220915-teststore-abc12345/changehistory/{history_id}?sellerId=teststore

サンプルリクエスト

GET /ShoppingWebService/V1/subscription/order/origin/teiki-20220915-teststore-abc12345/changehistory/1?sellerId=teststore HTTP/1.1
Host: circus.shopping.yahooapis.jp
Authorization: Bearer <アクセストークン>

レスポンスフィールド

要素	キー名	型	最大長	名称	説明
subscriptionId		string	70	定期配送ID	teiki-受注日-sellerId-ランダム英数8桁（16進） 例：teiki-20220512-6hills-4a94f7e1
shipMethod		string	9	配送方法
shipMethodName		string		お届け配送会社コード
shipCompanyCode		string		配送会社
shipInstructType		string		出荷指示区分
shipCharge		number	8	送料
payCharge		number	11	手数料
totalPrice		number		合計金額
payMethod		string		支払方法コード
payMethodName		string		支払方法名
payKind		number		支払方法種別
payType		number		前払い/後払い種別	0: 後払い 1: 前払い
storeNotes		string		ストア内メモ
shipAddressFrom		string	11	お届け先
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	ご請求先メールアドレス
cycle		object		サイクル情報
	type	string	5	サイクル種別
	day	number	2	日周期
	month	number	1	月周期
orderQuantityItems		array		数量情報
	lineId	number	2	ラインID
	quantity	number	3	数量
changes		array		変更情報
	changeId	number	10	変更ID
	lineId	number	2	ラインID
	changeField	string	60	変更箇所名

※1 全角1文字、半角0.5文字として計算

サンプルレスポンス

レスポンス（JSON）

{
  "subscriptionId": "teiki-20220530-6hills-4a94f7e1",
  "shipMethod": "postage1",
  "shipMethodName": "フルフィルメント用 宅急便",
  "shipCompanyCode": 1000,
  "shipInstructType": 0,
  "shipCharge": 100,
  "payCharge": 100,
  "totalPrice": 100,
  "settleAmount": 100,
  "payMethod": "payment_a1",
  "payMethodName": "クレジットカード",
  "payKind": 0,
  "payType": 0,
  "storeNotes": "ストア内メモ",
  "shipAddressFrom": "P",
  "shipFirstName": "矢風",
  "shipFirstNameKana": "ヤフウ",
  "shipLastName": "太郎",
  "shipLastNameKana": "タロウ",
  "shipZipCode": "111-1111",
  "shipPrefecture": "東京都",
  "shipCity": "千代田区",
  "shipAddress1": "紀尾井町1-3",
  "shipAddress2": "東京ガーデンテラス紀尾井町 紀尾井タワー",
  "billMailAddress": "sample@yahoo-corp.jp",
  "cycle": {
    "type": "DAY",
    "day": 10
  },
  "orderQuantityItems": [
    {
      "lineId": 1,
      "quantity": 1
    }
  ],
  "changes": [
    {
      "changeId": 1,
      "changeField": "shipMethod"
    }
  ]
}

エラー

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

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

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

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

利用制限

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

利用約款

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