概要
APIリファレンス
指定された定期購買IDの詳細情報を取得する。
| 項目名 | 内容 |
|---|---|
| アクション名 | getSubscription |
| リクエストメソッド | POST |
| 項目名 | 内容 | 必須 | 入力例 | 備考 |
|---|---|---|---|---|
| subscriptionId | 定期購買ID | はい | gid://shopify/SubscriptionContract/123456789 |
指定された定期購買IDの詳細情報を返却されます。
■正常時レスポンス
| プロパティ | 型 | 説明 |
|---|---|---|
| subscriptionContractId | string | 契約情報のShopify管理ID |
| isSyncingSubscription | boolean | 定期購買契約データ同期中判別フラグ |
| createdAt | timestamp | 契約作成日(UTC) |
| contractType | string | 契約種別 |
| status | string | 契約情報のステータス |
| nextBillingDate | timestamp | 次回決済日時(UTC) |
| nextDeliveryDate | timestamp | 次回お届け日（UTC） |
| deliveryDays | number | 契約情報のお届けまでに必要な日数 |
| deliveryTime | string | null |
| deliveryTimeText | string | お届け日時間帯 |
| billingPolicyInterval | string | 契約情報の決済周期（単位） |
| billingPolicyIntervalCount | number | 契約情報の決済周期 |
| billingPolicyMinCycles | number | null |
| billingPolicyMaxCycles | number | null |
| deliveryCountry | string | null |
| deliveryCountryCode | string | null |
| deliveryProvince | string | null |
| deliveryProvinceCode | string | null |
| deliveryZip | string | null |
| deliveryCity | string | null |
| deliveryAddress1 | string | null |
| deliveryAddress2 | string | null |
| deliveryFirstName | string | null |
| deliveryLastName | string | null |
※ メタフィールドを商品に設定した場合によって、返却されるレスポンスが異なります。
（１）メタフィールドにhuckleberry_subscription.Include_filter（含むフィルター）を商品に設定した場合
（２）メタフィールドにhuckleberry_subscription.exclude_filter（除外フィルター）を商品に設定した場合
（３）メタフィールドにhuckleberry_subscription.category（カテゴリー）を商品に設定した場合
（４）メタフィールドにhuckleberry_subscription.Include_filter_modal_title（含むフィルタータイトル）を商品に設定した場合