概要
APIリファレンス
指定された契約情報の契約内の商品を変更する。
本APIは通常のマイページからリクエストされることはなく、ENTERPRISEプラン向けのストア様で
個別にマイページをカスタムされる場合に利用可能なものとなります。
項目名 | 内容 |
---|---|
アクション名 | updateSubscriptionV2 |
リクエストメソッド | POST |
項目名 | 内容 | 入力例 | 備考 |
---|---|---|---|
subscriptionContractId | 定期購買ID | gid://shopify/SubscriptionContract/111111111 | |
addLines | 追加商品(配列) | [ | |
{ |
variantId : gid://shopify/ProductVariant/38165164523671
quantity : 1
sellingPlanId : gid://shopify/SellingPlan/8135704870
}, { variantId : gid://shopify/ProductVariant/38165164523671 quantity : 1 sellingPlanId : gid://shopify/SellingPlan/8135704870 }, ] | variantId : 追加する商品バリエーションのShopify管理ID quantity : 追加する数量 sellingPlanId : 追加する商品に紐付ける定期購買プランのShopify管理ID | | changeLines | 変更商品(配列) | [ { // 数量のみ変更する場合 lineId :gid://shopify/SubscriptionLine/0b36c12e-8431-41b5-bf32-7d59044aa824 quantity : 1 }, { // 商品のみ変更する場合 lineId :gid://shopify/SubscriptionLine/0b36c12e-8431-41b5-bf32-7d59044aa824 variantId : gid://shopify/ProductVariant/38165164523671 }, { // プランのみ変更する場合 lineId :gid://shopify/SubscriptionLine/0b36c12e-8431-41b5-bf32-7d59044aa824 sellingPlanId : gid://shopify/SellingPlan/8135704870 }, ] | lineId : 変更対象契約商品のShopify管理ID variantId : 変更後商品バリエーションのShopify管理ID ※ 商品を変更する場合のみ指定 quantity : 変更後数量 ※ 変更する場合のみ指定 sellingPlanId : 変更後契約商品に紐付ける定期購買プランのShopify管理ID ※ 変更する場合のみ指定 | | removeLines | 削除商品(配列) | [ { lineId :gid://shopify/SubscriptionLine/0b36c12e-8431-41b5-bf32-7d59044aa824 }, { lineId :gid://shopify/SubscriptionLine/0b36c12e-8431-41b5-bf32-7d59044aa824 }, { lineId :gid://shopify/SubscriptionLine/0b36c12e-8431-41b5-bf32-7d59044aa824 }, ] | lineId : 削除する契約商品一覧 | | | | | |
変更後の契約内の商品情報がJSONデータで返却されます。
■正常時レスポンス
プロパティ | 型 | 説明 |
---|---|---|
updatedSubscriptionLines | <UpdatedSubscriptionLine>[] | 更新後の契約商品一覧 |
L lineId | string | 契約商品のShopify管理ID |
L productId | string | null |
L variantId | string | null |
L title | string | タイトル |
L variantTitle | string | null |
L onlineStorePreviewUrl | string | 商品URL |
L variantImage | string | null |
L sku | string | null |
L quantity | number | 数量 |
L currentPriceAmount | float | 商品価格 |
L currentPriceCurrencyCode | string | 商品価格の通貨単位 |
L sellingPlanId | string | null |
L sellingPlanName | string | null |
■異常時レスポンス
ステータスコード | 型 | 説明 |
---|---|---|
500 | string | 定期購買契約の更新に失敗しました。時間を置いて再度お試しください。 |
(Shopifyエラー時) | ||
500 | string | 定期購買契約の更新に失敗しました。管理者に問い合わせをしてください。 |
(アプリエラー時) |