プラングループ取得(商品別)
1.基本情報
指定された商品ID、プランIDに関連付けされた商品情報(契約に追加可能な商品)を返却する。
項目名 | 内容 |
---|---|
アクション名 | getProductVariantV2 |
リクエストメソッド | POST |
2.リクエストに必要な内容
項目名 | 内容 | 必須 | 入力例 | 備考 |
---|---|---|---|---|
productId | バリエーションを取得したい商品の商品ID | はい | gid://shopify/Product/6182307954839 | |
sellingPlanId | プランID | はい | gid://shopify/SellingPlan/3937337576 |
3.レスポンス内容
指定された商品IDに関連付けされたプラン情報が返却されます。
■正常時レスポンス
プロパティ | 型 | 説明 |
---|---|---|
planGroup | array() | プラングループの一覧 |
L merchantCode | strin | プラングループタイトル |
L name | string | 公開タイトル |
L planGroupId | string | プラングループのShopify管理ID |
L plans | array() | プラン情報 |
L billingPolicyInterval | string | 決済周期(DAY:日、WEEK:週、MONTH:月、YEAR:年) |
L billingPolicyIntervalCount | number | null | 決済周期(数値) |
L billingPolicyMaxCycles | number | null | 最大購入回数 |
L billingPolicyMinCycles | number | null | 最低購入回数 |
L firstPricingPolicyAdjustmentType | string | 初回割引(FIXED_AMOUNT : 固定額、PERCENTAGE:パーセント割引) |
L firstPricingPolicyAdjustmentValue | number | null | 初回割引(割引額/パーセント) |
L name | string | プラン名 |
L planId | string | プランのShopify管理ID |
L products | array() | |
L productId | string | 商品のShopify管理ID |
L title | string | 商品タイトル |
L onlineStorePreviewUrl | string | 商品URL |
L images | string | 商品画像 |
L id | string | 商品画像のShopify管理ID |
L width | number | 画像幅 |
L height | number | 画像高さ |
L originalSrc | string | 商品画像URL |
L transformedSrc | string | 商品画像URL |
L variants | array() | 商品バリエーション |
L id | string | 商品バリエーションのShopify管理ID |
L displayName | string | 商品タイトル(バリエーション名含む) |
L title | string | バリエーション名 |
L sku | string | SKU |
L price | number | 価格 |
L image | string | バリエーション画像URL |
L requiresShipping | boolean | true:配送必要商品、false:配送不要商品 |
L availableForSale | boolean | true:販売可能、false:販売不可 |