目次

1.基本情報


アプリのプラン設定から登録されたプラングループの情報を取得する。

項目名 内容
アクション名 getPlanGroups
リクエストメソッド POST

2.リクエストに必要な内容


なし

3.レスポンス内容


アプリのプラン設定から登録されたプラングループの情報が返却されます。

■正常時レスポンス

プロパティ 説明
planGroup array() プラングループの一覧
L merchantCode strin プラングループタイトル
L name string 公開タイトル
L planGroupId string プラングループのShopify管理ID
L plans array() プラン情報
L planId string プランのShopify管理ID
L name string プラン名
L description string null
L billingPolicyInterval string 決済周期(DAY:日、WEEK:週、MONTH:月、YEAR:年)
L billingPolicyIntervalCount number null
L pricingPolicyAdjustmentType string FIXED_AMOUNT : 固定額、PERCENTAGE:パーセント割引
L pricingPolicyAdjustmentValue number null
L boxSetting object BOX設定
L id number BOX設定ID
L boxId string BOX商品固有のID
L title string タイトル
L pricingType string 支払い方法種別
L description string BOX説明
L canChoiceVariants boolean バリエーションの選択フラグ
L parentProductId string 商品GID
L boxPurchaseOptions array BOX販売設定
L id number BOX販売設定ID
L name string BOX販売設定名
L boxSettingId number BOX設定ID

※ メタフィールドを商品に設定した場合によって、返却されるレスポンスが異なります。

メタフィールド情報

(1)メタフィールドにhuckleberry_subscription.Include_filter(含むフィルター)を商品に設定した場合

(2)メタフィールドにhuckleberry_subscription.exclude_filter(除外フィルター)を商品に設定した場合

(3)メタフィールドにhuckleberry_subscription.category(カテゴリー)を商品に設定した場合


(4)メタフィールドにhuckleberry_subscription.Include_filter_modal_title(含むフィルタータイトル)を商品に設定した場合

(5)メタフィールドにhuckleberry_subscription.exclude_filter_modal_title(除外フィルタータイトル)を商品に設定した場合