目次

1. 基本情報


BOX定期購買の商品入れ替え(追加・更新・削除)を行うAPIです。BOXの販売設定、プラン、子商品の数量を一括で変更できます。

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

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


項目名 内容 必須 フォーマット 入力例 備考
subscriptionContractId 定期購買契約ID はい string(gid) gid://shopify/SubscriptionContract/123456789 Shopifyの定期購買契約ID
boxSettingId BOX設定ID はい number 1 変更対象のBOX設定のID
boxPurchaseOptionId BOX販売設定ID はい number 10 変更先のBOX販売設定ID
planId プランID はい number 5 変更先のプランID
variantQuantities 子商品のバリエーション数量配列 はい array - 子商品の商品ID、バリエーションID、数量の配列
L productId 商品ID はい string(gid) gid://shopify/Product/123456789 ストアフロントAPI形式の商品ID
L variantId バリエーションID はい string(gid) gid://shopify/ProductVariant/987654321 ストアフロントAPI形式のバリエーションID
L quantity 数量 はい number 2 バリエーションの注文数量

3.レスポンス内容


BOX定期購買の商品入れ替え処理の結果がJSONデータで返却されます。

■正常時レスポンス

| --- | --- | --- |

■異常時レスポンス

バリデーションエラー(400 Bad Request)

契約・設定関連

| --- | --- |

商品・バリエーション関連

| --- | --- |

プラン関連

| --- | --- |

権限・制限エラー(403 Forbidden)

| --- | --- |

リソースエラー(404 Not Found)

| --- | --- |

競合エラー(409 Conflict)