定期購入親注文一覧取得API

定期購入の検索条件に一致する定期購入親注文情報を取得する機能を提供します。

変更履歴

利用申請について

本番環境について

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

テスト環境について

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

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

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

リクエストURL

リクエストパラメータ

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

リクエストURL

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

リクエストボディ（JSON）

パラメータ	必須	型	最大長	説明
sellerId	〇	string		ストアアカウント
countFrom		number	8	検索対象件数範囲指定 （From） デフォルトは１
countTo		number	8	検索対象件数範囲指定 （To） デフォルトは1000
sort		string	4	ソート順 ・desc：降順（デフォルト） ・asc：昇順
conditions		object		検索条件

－ 検索条件（Condition） :

キー名	型	最大長	項目	一致方式	内容
subscriptionId	string	70	定期購入番号	前方一致
orderId	string	55	注文ID	完全一致
status	number	2	ステータス（利用状況）	完全一致	有効/無効のステータス 0:有効 1:無効
orderTimeFrom	string(date)	10	初回注文日時（From）	範囲指定	yyyy-MM-dd 形式
orderTimeTo	string(date)	10	初回注文日時（To）	範囲指定	yyyy-MM-dd 形式
nextShipDateFrom	date	10	次回配送予定日 （From）	範囲指定	yyyy-MM-dd 形式 次回配送予定日＝次回注文作成日＋10日
nextShipDateTo	date	10	次回配送予定日 （To）	範囲指定	yyyy-MM-dd 形式
nextChangeDeadlineDateFrom	date	10	次回配送変更締切日 （From）	範囲指定	yyyy-MM-dd 形式 次回配送変更締切日＝次回注文作成日－1日
nextChangeDeadlineDateTo	date	10	次回配送変更締切日 （To）	範囲指定	yyyy-MM-dd 形式
payMethod	string	20	お支払い方法	完全一致	payment_a1：クレジットカード決済 payment_a19：PayPayあと払い payment_d1：商品代引き
shipCompanyCode	string	4	お届け配送会社	部分一致	配送会社コード （一覧はこちら）
itemTitle	string	225	商品名	部分一致
itemId	string	99	商品コード	完全一致
changeRequestId	string	18	変更要求ID	完全一致
changeRequestStatusSummary	string	2	変更要求ステータスサマリー	完全一致	変更要求ステータスサマリー 0：変更要求なし 1：通知待ち 2：通知後

サンプルリクエストURL

https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/subscription/order/origin/list

サンプルリクエスト

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

{
"sellerId"："teststore",
"countFrom": 1,
"countTo": 1000,
"sort": "desc",
"conditions": {
 "subscriptionId": "teiki-20211201-teststore-4a94f7e1",
 "orderId": "teststore-00000001",
 "status": 1,
 "nextShipDateFrom": "2020-01-01",
 "nextShipDateTo": "2020-01-01",
 "nextChangeDeadlineDateFrom": "2020-01-01",
 "nextChangeDeadlineDateTo": "2020-01-01",
 "payMethod": "payment_a1",
 "shipCompanyCode": 999,
 "itemTitle": "商品1",
 "itemId": 2
}
}

レスポンスフィールド

要素	フィールド		必須	型	最大長	名称	説明
count			〇	number	4	検索総件数
results			〇	array		検索結果一覧
	subscriptionId		〇	string	70	定期購入番号
	orderId		〇	string	55	注文ID
	orderTime		〇	datetime	25	注文日時	例：2019-12-31T15:00:00+09:00
	sellerId		〇	string	31	ストアアカウント
	status		〇	number	1	定期購入ステータス	有効/無効のステータス 0:有効 1:無効
	continueCount		〇	number	4	定期購入継続回数	受注済み子注文の回数 ・スキップの回数は含めない ・注文生成後に子注文をキャンセルした場合は、減算せず、継続回数にカウントする
	nextOrderDate		〇	date	10	次回注文作成日	例：2020-01-01
	nextCreateOrderShipDate		〇	date	10	次回作成注文配送予定日	例：2020-01-01
	nextCreateOrderChangeDeadlineDate		〇	date	10	次回作成注文配送変更締切日	例：2020-01-01
	changeableShipDateFrom		〇	date	10	配送日変更選択可能日 From	例：2020-01-01
	changeableShipDateTo		〇	date	10	配送日変更選択可能日 To	例：2020-01-01
	cycleType		〇	string	5	配送サイクル種別	DAY: 日 MONTH: 月
	cycleDay		〇	number	3	配送サイクル（日）	日、月はどちらか一方のみ返却
	cycleMonth		〇	number	2	配送サイクル（月）	日、月はどちらか一方のみ返却
	shipRequestTime			string	13	お届け時間帯
	shipMethodName		〇	string	150	配送方法名称
	shipCompanyCode			string	4	お届け配送会社	配送会社コードを返却 （一覧はこちら）
	payMethod		〇	string	20	お支払い方法
	payMethodName		〇	string	150	お支払い方法名称
	changeRequestStatusSummary		〇	string	2	変更要求ステータスサマリー	変更要求ステータスサマリー 0：変更要求なし 1：通知待ち 2：通知後
	items		〇
		lineId	〇	number	2	ラインID
		imageId		string	1024	商品画像
		title	〇	string	225	商品名
		itemId	〇	string	99	商品コード
		categoryId		number	12	カテゴリID
		quantity	〇	number	3	数量
	changeRequests
		lineId	〇	number	2	ラインID	変更対象のラインID lineId昇順でソート
		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）

{
"count": 123,
"results": [
 {
   "subscriptionId": "teiki-20211201-teststore-4a94f7e1",
   "orderId": "teststore-00000001",
   "orderTime": "2020-01-01T00:00:00.123456+09:00",
   ...
   "items": [
     {
       "lineId": 1,
       "imageId": "8d970234cd55",
       "title": "商品1",
       "itemId": "item-1",
       "categoryId": 123456789012,
       "quantity": 1
     },
     {
       "lineId": 2,
       ...
     }
   ]
 },
  {
   "subscriptionId": "teiki-20211201-teststore-4a94f7e2",
   "orderId": "teststore-00000002",
   "orderTime": "2020-01-01T00:00:00.123456+09:00",
   ...
   "items": [
     {
       "lineId": 1,
       ...
     }
   ]
 }
]
}

エラー

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

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

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

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

利用制限

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

利用約款

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