定期購入に関するAPIとは

目次

• 定期購入検索に関するAPI
• 定期購入情報変更に関するAPI
• 定期購入の親注文、子注文、お届け回毎の注文情報生成の流れ
• 利用パターン
• 子注文の詳細情報を取得する。
• 次回注文の内容を変更する。
• 次回注文をスキップする。
• 親注文を解約する。（1件）
• 親注文を解約する。（複数件）
• 申し込まれた定期購入商品の価格変更や、廃番や欠品の場合に代替商品の登録をする。

定期購入検索に関するAPI

API名	機能概要
定期購入親注文一覧取得API	定期購入の検索条件に一致する定期購入申し込み情報をレスポンスします。
定期購入子注文一覧取得API	指定した定期購入申し込みの各お届け回の子注文情報をレスポンスします。
定期購入親注文詳細取得API	指定した定期購入申し込みの詳細情報をレスポンスします。

定期購入情報変更に関するAPI

API名	機能概要
定期購入次回注文スキップAPI	定期購入の次回お届けをスキップします。
定期購入親注文一括解約API	定期購入の申し込みを一括で解約します。
定期購入親注文解約API	定期購入の申し込みを解約します。
定期購入お届け予定日変更API	定期購入のお届け予定日を変更します。
定期購入情報変更API	定期購入の申し込み情報を変更します。
定期購入情報変更履歴一覧API	定期購入情報を変更した履歴一覧を取得します。
定期購入情報変更履歴詳細API	定期購入情報を変更した履歴の詳細を取得します。
定期購入変更要求登録API	定期購入で申し込まれている商品の価格を更新したり、廃番や欠品の場合に代替商品への変更要求を登録をします。
定期購入変更要求キャンセルAPI	登録された定期購入の変更要求をキャンセルします。
定期購入変更要求一括登録API	指定した商品コードを含む定期購入親注文に対し、一括で商品の価格を更新したり、廃番や欠品の場合に代替商品への変更要求を登録します。
定期購入変更要求一括キャンセルAPI	登録された定期購入の変更要求を一括でキャンセルします。
定期購入変更要求一覧取得API	登録された定期購入の変更要求の一覧情報を取得します。
定期購入変更要求詳細一覧取得API	登録された定期購入の変更要求の詳細情報を取得します。

定期購入の親注文、子注文、お届け回毎の注文情報生成の流れ

利用パターン

▼子注文の詳細情報を取得する。

　１．親注文一覧を取得する。
　　利用するAPI：定期購入親注文一覧取得API

　２．１で取得した親注文IDをキーに子注文の情報を取得する。
　　利用するAPI：定期購入子注文一覧取得API

　３．２で取得した子注文に紐づく注文IDをキーに「注文詳細API」にリクエストする。
　　利用するAPI：注文詳細API

▼次回注文の内容を変更する。

　１．親注文一覧を取得する。
　　利用するAPI：定期購入親注文一覧取得API

　２．１で取得した定期購入番号をキーに親注文の詳細情報を取得する。
　　利用するAPI：定期購入親注文詳細取得API

　※現在の親注文の詳細を取得したい場合のみ１，２を実施してください。

　３．親注文の情報を変更する。 ※1
　　利用するAPI：定期購入情報変更API

※1 次回配送予定の子注文の子注文フェーズ（phase）が0または1以外の場合はエラーを返します。 （エラーコード：SUBSCRIPTION-ORDER-API-0201）
　　 　　

▼次回注文をスキップする。

　１．親注文一覧を取得する。
　　利用するAPI：定期購入親注文一覧取得API

　２．１で取得した親注文IDをキーにスキップ対象の「子注文ID」を取得する。
　　利用するAPI：定期購入子注文一覧取得API

　３．２で取得した子注文IDをキーに「定期購入次回注文スキップAPI」にリクエストする。 ※1
　　利用するAPI：定期購入次回注文スキップAPI
※1 次回配送予定の子注文の子注文フェーズ（phase）が0または1以外の場合はエラーを返します。 （エラーコード：SUBSCRIPTION-ORDER-API-0201）

▼親注文を解約する。（1件）

　１．親注文一覧を取得する。
　　利用するAPI：定期購入親注文一覧取得API

　２．１で取得した親注文IDをキーに次回配送予定の「子注文ID」を取得する。
　　利用するAPI：定期購入子注文一覧取得API

　３．２で取得した子注文IDをキーに「定期購入親注文解約API」にリクエストする。 ※1
　　利用するAPI：定期購入親注文解約API

※1 すでに次回配送予定の子注文に紐づく注文情報が生成されていた場合はエラーを返します。 （エラーコード：SUBSCRIPTION-ORDER-API-0201）

▼親注文を解約する。（複数件）

　１．親注文一覧を取得する。
　　利用するAPI：定期購入親注文一覧取得API

　２．1で取得した親注文IDをキーに「定期購入親注文一括解約API」にリクエストする。 ※1
　　利用するAPI：定期購入親注文一括解約API

※1 子注文に紐づく注文情報の生成状況に関わらず親注文の解約を実施することが可能です。
※1 次回配送予定の子注文に紐づく注文情報が生成された後にリクエストをして成功した場合でも、子注文情報自体は解約されません。

▼申し込まれた定期購入商品の価格変更や、廃番や欠品の場合に代替商品の登録をする。

　１．親注文一覧を取得する。
　　利用するAPI：定期購入親注文一覧取得API

　２．１で取得した定期購入番号をキーに親注文の詳細情報を取得する。
　　利用するAPI：定期購入親注文詳細取得API
　　※現在の親注文の詳細を取得したい場合のみ１，２を実施してください。

　３．定期購入番号、変更前・後の商品などを指定し、変更を要求する。
　 　　利用するAPI：
　　　1親注文ずつ変更する場合：定期購入変更要求登録API
　　　指定した商品コードや条件を満たす定期購入親注文を一括で変更する場合：定期購入変更要求一括登録API

　４．注文生成日の5日前（次回お届け日の15日前）を迎えると親注文が解約され、
　　　お客様に、変更後の定期購入商品で再申し込みを依頼する通知を行います。
　　　定期購入履歴に変更後の商品が表示され、お客様ご自身で最新の商品の情報や価格を元に
　　　定期購入の申し込み手続きを行って頂きます。
　３の後、変更要求のキャンセルを行う場合　※お届け予定日の16日前までキャンセル可能です。

　５．変更要求をキャンセルする。
　　利用するAPI：
　　　1親注文ずつ変更要求をキャンセルする場合：定期購入変更要求キャンセルAPI
　　　指定した商品コードや条件を満たす定期購入親注文を一括で変更要求をキャンセルする場合：定期購入変更要求一括キャンセルAPI