変更可能商品取得
1.基本情報
契約内に追加可能な商品情報を取得する。
この商品情報は指定されたプランIDのプラングループに紐づく商品が候補として返却されます。
商品情報は、10件ずつ返されます。
項目名 | 内容 | |
---|---|---|
アクション名 | getAlternativeProducts | |
リクエストメソッド | POST |
2.リクエストに必要な内容
項目名 | 内容 | 必須 | 入力例 | 備考 |
---|---|---|---|---|
page | ページ番号 | いいえ | 0 | 0以上の値を指定してください。 |
sellingPlanId | プランID | はい | gid://shopify/SellingPlan/7771652390 |
3.レスポンス内容
指定されたプランIDと同じプラングループに紐づく、商品情報が返却されます。
■正常時レスポンス
プロパティ | 型 | 説明 |
---|---|---|
products | array() | 商品情報 |
L productId | number | 商品のShopify管理ID |
L title | number | タイトル |
L onlineStorePreviewUrl | array() | 商品URL |
L images | string() | 商品画像URL |
L variants | array() | 商品に含まれるバリエーション情報 |
L variantId | string | null | 商品バリエーションのShopify管理ID |
L requiresShipping | string | null | true:配送商品、false:配送不要商品 |
hasNextPage | string | null | true:次のページあり |
■異常時レスポンス
ステータスコード | 型 | 説明 |
---|---|---|
404 | - | ・ストアが見つからない場合 ・プランが見つからない場合 |