概要
APIリファレンス
ログインユーザーの定期購買一覧の情報を取得する。
| 項目名 | 内容 |
|---|---|
| アクション名 | getSubscriptions |
| リクエストメソッド | POST |
なし
ログインユーザーの定期購買一覧の情報が返却されます。
■正常時レスポンス
| プロパティ | 型 | 説明 | ||
|---|---|---|---|---|
| object[] | object[] | 契約一覧 | ||
| L subscriptionContractId | string | 契約情報のShopify管理ID | ||
| L isSyncingSubscription | boolean | 定期購買契約データ同期中判別フラグ | ||
| L createdAt | timestamp | 契約作成日(UTC) | ||
| L status | string | 契約情報のステータス | ||
| L nextBillingDate | timestamp | 次回決済日時(UTC) | ||
| L nextDeliveryDate | timestamp | 次回お届け日(UTC) | ||
| L deliveryDays | number | 契約情報のお届けまでに必要な日数 | ||
| L deliveryTime | string | null | 契約情報のお届け時間帯 | |
| L billingPolicyInterval | string | 契約情報の決済周期(単位) | ||
| L billingPolicyIntervalCount | number | 契約情報の決済周期 | ||
| L billingPolicyMinCycles | number | null | 契約情報の最低購入回数 | |
| L billingPolicyMaxCycles | number | null | 契約情報の最大購入回数 | |
| L deliveryCountry | string | null | 契約情報の配送先住所(国) | |
| L deliveryCountryCode | string | null | 契約情報の配送先住所(国コード) | |
| L deliveryProvince | string | null | 契約情報の配送先住所(都道府県) | |
| L deliveryProvinceCode | string | null | 契約情報の配送先住所(都道府県コード) | |
| L deliveryZip | string | null | 契約情報の配送先住所(郵便番号) | |
| L deliveryCity | string | null | 契約情報の配送先住所(市区町村) | |
| L deliveryAddress1 | string | null | 契約情報の配送先住所(住所) | |
| L deliveryAddress2 | string | null | 契約情報の配送先住所(建物名、部屋番号) | |
| L deliveryFirstName | string | null | 契約情報の配送先住所(名) | |
| L deliveryLastName | string | null | 契約情報の配送先住所(姓) | |
| L deliveryName | string | null | 契約情報の配送先住所(名+姓) |
■異常時レスポンス
| --- | --- | --- |