定期購入親注文詳細取得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?sellerId=teststore

サンプルリクエスト

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

レスポンスフィールド

要素	フィールド	必須	型	最大長	名称	説明
subscriptionId		〇	string	70	定期購入番号
orderTime		〇	datetime	32	注文日時	例：2020-01-01T00:00:00.123456+09:00
sellerId		〇	string	31	ストアアカウント
status		〇	number	1	定期配送ステータス	有効/無効のステータス 0:有効 1:無効
statusUpdateTime			datetime	32	ステータス更新日時	例：2020-01-01T00:00:00.123456+09:00
cancelReason			string	3	解約理由	解約理由コード （一覧はこちら）
cancelReasonDetail			string	400	解約理由詳細
continueCount		〇	number	4	定期購入継続回数	・スキップの回数は含めない ・注文生成後に子注文をキャンセルした場合は、減算せず、継続回数にカウントする
shipRequestTime			string	13	お届け希望時間
isEazy			string	1	EAZY注文フラグ	1：EAZY注文 0：EAZY外注文
eazyDeliveryName			string	50	EAZY受け取り場所名
shipCompanyCode		〇	string	4	お届け配送会社コード	配送会社コード （一覧はこちら）
shipCharge		〇	number	10	送料
payCharge		〇	number	10	手数料	代引き手数料
totalLinePrice		〇	number	15	商品合計金額 （quantity * unit_priceの合計）	次回生成される注文の金額
totalPrice		〇	number	15	注文合計金額 （商品合計金額+送料+手数料）	次回生成される注文の金額
cycleType		〇	string	5	配送サイクル種別	DAY: 日 MONTH: 月
cycleDay		〇	number	3	配送サイクル（日）	日、月はどちらか一方のみ返却
cycleMonth		〇	number	2	配送サイクル（月）	日、月はどちらか一方のみ返却
nextCreateOrderShipDate		〇	date	10	次回作成注文配送予定日	次回作成予定の子注文（B）のお届け予定日 定期PF親テーブルの次回作成注文配送予定日を返す 例：2020-01-01
nextOrderDate		〇	date	10	次回注文作成日	次回作成予定の子注文（B）の注文作成予定日 例：2020-01-01
nextCreateOrderChangeDeadlineDate		〇	date	10	次回作成注文情報変更締切日	次回作成予定の子注文（B）の情報変更締切日 例：2020-01-01
nextRemindMailDate		〇	date	10	次回リマインドメール送信予定日	次回お届け予定日の15日前に送信されます。 例：2020-01-01
changeableShipDateFrom		〇	date	10	配送日変更選択可能日From	次回作成予定の子注文（B）の配送日変更可能範囲From nextCreateOrderShipDate＋1日 例：2020-01-01
changeableShipDateTo		〇	date	10	配送日変更選択可能日To	次回作成予定の子注文（B）の配送日変更可能範囲To nextCreateOrderShipDate＋配送サイクル－1日 例：2020-01-01
storeNotes			string	1000	ストア内メモ
buyerComments			string	750	ご要望
items		〇	array		商品
	lineId	〇	number	2	ラインID
	imageId		string	1024	商品画像
	title	〇	string	225	商品名
	itemId	〇	string	99	商品コード
	subCode		string	99	個別商品コード
	categoryId		number	12	カテゴリID
	itemOption		array		オプション
	itemOption/index		string	2	オプション番号
	itemOption/name		string	60	オプション名
	itemOption/value		string	60	オプション値
	itemOption/price		number	10	オプション価格
	unitPrice	〇	number	10	商品単価 定期購入価格（税込）＋オプション価格（税込）	次回生成される注文の金額
	quantity	〇	number	3	数量
	cycleIndex		integer		サイクル番号
	linePrice	〇	number	15	ライン合計金額
pay			object
	payType	〇	number	1	前払い/後払い種別	0: 後払い 1: 前払い
	payKind	〇	number	1	支払方法種別
	payMethod	〇	string	20	支払方法コード
	payMethodName	〇	string	150	支払方法名
	billAddressFrom	〇	string	4	ご請求先住所参照元	P:自宅住所 B:勤務先住所 O:その他で入力 ship:お届け先と同じ W:Yahoo!ウォレットに登録済みの住所 SB:ソフトバンク登録済み住所
	billFirstName	〇	string	297	ご請求先氏名(名)
	billFirstNameKana		string	297	ご請求先氏名(名)カナ
	billLastName	〇	string	297	ご請求先氏名(姓)
	billLastNameKana		string	297	ご請求先氏名(姓)カナ
	billZipCode	〇	string	10	ご請求先郵便番号
	billPrefecture	〇	string	12	ご請求先都道府県
	billCity	〇	string	297	ご請求先市区町村
	billAddress1	〇	string	297	ご請求先住所1
	billAddress2		string	297	ご請求先住所2
	billPhoneNumber	〇	string	64	ご請求先電話番号
	billEmgPhoneNumber		string	64	ご請求先緊急電話番号
	billMailAddress	〇	string	99	ご請求先メールアドレス
	billSection1Field		string	297	ご請求先セクション1名称
	billSection1Value		string	297	ご請求先セクション1値
	billSection2Field		string	297	ご請求先セクション2名称
	billSection2Value		string	297	ご請求先セクション2値
	needBillSlip		boolean	5	請求書フラグ	true: 必要 false: 不要
	needDetailedSlip		boolean	5	納品書フラグ	true: 必要 false: 不要
	needReceipt		boolean	5	領収書フラグ	true: 必要 false: 不要
	ageConfirmCheck		boolean	5	年齢確認フラグ
	ageConfirmField		string	90	年齢確認フィールド名
	ageConfirmValue		number	3	年齢確認フィールド値
ship			object
	shipMethod		string	10	配送方法番号
	shipMethodName	〇	string	150	配送方法名
	option1Field		string	150	オプション1名称
	option1Type		string	1	オプション1種別
	option1Value		string	1500	オプション1値
	option2Field		string	150	オプション2名称
	option2Type		string	1	オプション2種別
	option2Value		string	1500	オプション2値
	shipAddressFrom	〇	string	2	お届け先住所参照元	P:自宅住所 B:勤務先住所 O:その他で入力 W:Yahoo!ウォレットに登録済みの住所 SB:ソフトバンク登録済み住所
	shipFirstName	〇	string	297	お届け先氏名(名)
	shipFirstNameKana		string	297	お届け先氏名(名)カナ
	shipLastName	〇	string	297	お届け先氏名(姓)
	shipLastNameKana		297		お届け先氏名(姓)カナ
	shipZipCode	〇	string	10	お届け先郵便番号
	shipPrefecture	〇	string	12	お届け先都道府県
	shipCity	〇	string	297	お届け先市区町村
	shipAddress1	〇	string	297	お届け先住所1
	shipAddress2		string	297	お届け先住所2
	shipPhoneNumber	〇	string	64	お届け先電話番号
	shipEmgPhoneNumber		string	64	お届け先緊急電話番号
	shipSection1Field		string	297	お届け先セクション1名称
	shipSection1Value		string	297	お届け先セクション1値
	shipSection2Field		string	297	お届け先セクション2名称
	shipSection2Value		string	297	お届け先セクション2値
changeRequests
	lineId	〇	number	2	ラインID	変更対象のラインID
	changeRequestId	〇	number	18	変更要求ID	変更要求ID
	changeRequestStatus	〇	string	2	変更要求ステータス	詳細はこちら
	changeRequestType	〇	string	10	変更要求区分	price_update：価格変更 item_switch：商品切替
	targetItemId	〇	string	99	対象商品ID	変更前の商品ID
	afterItemId	〇	string	99	変更後商品ID
	changeRequestTime	〇	string(timestamp)	11	変更要求日時	変更要求を行った日付
	changeRequestDetailPhase	〇	string	2	変更要求詳細フェーズ	詳細はこちら

サンプルレスポンス

レスポンス（JSON）

{
"subscriptionId": "teiki-20211201-teststore-4a94f7e1",
"orderTime": "2020-01-01T00:00:00.123456+09:00",
"sellerId": "teststore",
"status": 0,
"statusUpdateTime": "2020-01-01T00:00:00.123456+09:00",
"continueCount": 3,
"shipRequestTime": "2021022511000",
"isEazy": 1,
"eazyDeliveryName": "EAZY受け取り場所名",
"shipCompanyCode": 1001,
"shipCharge": 200,
"payCharge": 100,
"totalLinePrice": 1000,
"totalPrice": 1000,
"cycleType": "DAY",
"cycleDay": 10,
"nextCreateOrderShipDate": "2020-01-01",
"nextOrderDate": "2020-01-01",
"nextCreateOrderChangeDeadlineDate": "2020-01-01",
"changeableShipDateFrom": "2020-01-01",
"changeableShipDateTo": "2020-01-01",
"storeNotes": "ストア内メモ",
"buyerComments": "ご要望",
"items": [
 {
   "lineId": 1,
   "imageId": "item-image-001",
   "title": "item_name",
   "itemId": "item",
   "subCode": "item",
   "categoryId": 2,
   "itemOption": [
     {
       "index": 1,
       "name": "サイズ",
       "value": "S",
       "price": 100
     }
   ],
   "unitPrice": 100,
   "quantity": 1,
   "linePrice": 1000
 }
],
"pay": {
 "payType": 0,
 "payKind": 0,
 "payMethod": "payment_a1",
 "payMethodName": "クレジットカード",
 "billAddresFrom": "P",
 "billFirstName": "太郎",
 "billFirstNameKana": "タロウ",
 "billLastName": "矢風",
 "billLastNameKana": "ヤフウ",
 "billZipCode": "102-8282",
 "billPrefecture": "東京都",
 "billCity": "千代田区",
 "billAddress1": "紀尾井町1-3",
 "billAddress2": "東京ガーデンテラス紀尾井町 紀尾井タワー",
 "billPhoneNumber": "090-1234-5678",
 "billEmgPhoneNumber": "03-0000-0000",
 "billMailAddress": "sample@yahoo-corp.jp",
 "billSection1Field": "セクション1名",
 "billSection1Value": "セクション1値",
 "billSection2Field": "セクション2名",
 "billSection2Value": "セクション2値",
 "needBillSlip": true,
 "needDetailedSlip": true,
 "needReceipt": true,
 "ageConfirmCheck": true,
 "ageConfirmField": "年齢確認フィールド名",
 "ageConfirmValue": 25
},
"ship": {
 "shipMethod": "postage_1",
 "shipMethodName": "ヤマト",
 "option1Field": "オプション1名",
 "option1Type": 0,
 "option1Value": "オプション1値",
 "option2Field": "オプション2名",
 "option2Type": 0,
 "option2Value": "オプション2値",
 "shipAddressFrom": "P",
 "shipFirstName": "太郎",
 "shipFirstNameKana": "タロウ",
 "shipLastName": "家風",
 "shipLastNameKana": "ヤフウ",
 "shipZipCode": "102-8282",
 "shipPrefecture": "東京都",
 "shipCity": "千代田区",
 "shipAddress1": "紀尾井町1-3",
 "shipAddress2": "東京ガーデンテラス紀尾井町 紀尾井タワー",
 "shipPhoneNumber": "090-1234-5678",
 "shipEmgPhoneNumber": "03-0000-0000",
 "shipSection1Field": "セクション1名",
 "shipSection1Value": "セクション1値",
 "shipSection2Field": "セクション2名",
 "shipSection2Value": "セクション2値"
}
}

エラー

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

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

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

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

利用制限

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

利用約款

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