定期購入子注文一覧取得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/replica/list?sellerId=teststore

サンプルリクエスト

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

レスポンスフィールド

• 定期購入注文生成回数の降順で返す（新しい子注文が上となる）

要素	フィールド	必須	型	最大長	名称	説明
results		〇	array		検索結果一覧
	subscriptionReplicaId	〇	string	80	定期購入子注文番号	定期購入番号-連番4桁 例：teiki-20220512-teststore-4a94f7e1-1234
	continueCount		number		定期購入継続回数	子注文が生成された際に、親注文でカウントする定期購入継続回数を記録
	orderCreateCount	〇	number		定期購入注文生成回数	何回目の子注文かを表し、定期購入子注文番号末尾の連番と同じ数値
	orderId		string		注文ID
	shipExpectDate	〇	date	10	お届け予定日	例：2020-01-01
	orderExpectDate	〇	date	10	注文予定日
	changeDeadlineDate	〇	date	10	配送変更締切日
	changeableShipDateFrom	〇	date	10	配送選択可能日From
	changeableShipDateTo	〇	date	10	配送選択可能日To
	phase	〇	number		子注文フェーズ	（一覧はこちら）
	phaseUpdateTime	〇	datetime	32	フェーズ更新日時	例：2020-01-01T00:00:00.123456+09:00
	phaseReason		number		フェーズ更新理由	発注結果登録系： 発注結果登録の結果スキップとなった場合や、 リトライを繰り返し結果的にスキップとなった場合 520:決済エラー 530:在庫・配送エラー キャンセル系： 800：ストア操作によるキャンセル 810：解約による注文生成キャンセル 820：バイヤーキャンセル（初回のみ） スキップ系： ユーザーかストアが能動的にスキップした場合 900:ユーザー操作 910:ストア操作

サンプルレスポンス

レスポンス（JSON）

{
results: [
 {subscriptionReplicaId: "teiki-yyyyMMdd-XXXX-YYYY-0001", orderId: ...},
 {subscriptionReplicaId: "teiki-yyyyMMdd-XXXX-YYYY-0002", orderId: ...},
]
}

エラー

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

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

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

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

利用制限

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

利用約款

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