目次

１．基本情報

指定された契約情報の契約内の商品を変更する。

本APIは通常のマイページからリクエストされることはなく、ENTERPRISEプラン向けのストア様で

個別にマイページをカスタムされる場合に利用可能なものとなります。

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

２．リクエストに必要な内容

項目名 内容 必須 フォーマット 入力例 備考
subscriptionContractId 定期購買ID はい gid://shopify/SubscriptionContract/*** gid://shopify/SubscriptionContract/111111111
addLines 追加商品（配列） いいえ Object[] [
{ 
variantId : gid://shopify/ProductVariant/38165164523671,
quantity : 1,
sellingPlanId : gid://shopify/SellingPlan/8135704870,
customAttributes: [
    {
        key: “specialProduct”,
        value: “true”
    }
]

}, ] | | | L variantId | 追加する商品バリエーションのShopify管理ID | はい | gid://shopify/ProductVariant/*** | gid://shopify/ProductVariant/38165164523671 | | | L quantity | 追加する数量 | はい | 1以上の数値 | 1 | | | L sellingPlanId | 追加する商品に紐付ける定期購買プランのShopify管理ID | はい | gid://shopify/SellingPlan/*** | gid://shopify/SellingPlan/8135704870 | | | L customAttributes | 商品のカスタム属性(配列) | いいえ | Object[] | | | | L key | カスタム属性のキー名 | はい | 1文字以上の文字列 | SpecialProduct | | | L value | カスタム属性の値 | はい | 1文字以上の文字列 | true | | | changeLines | 変更商品（配列） | いいえ | Object[] | [ { // 数量のみ変更する場合 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 }, ] | | | L lineId | 変更対象契約商品のShopify管理ID | はい | gid://shopify/SubscriptionLine/*** | gid://shopify/SubscriptionLine/0b36c12e-8431-41b5-bf32-7d59044aa824 | | | L variantId | 変更後商品バリエーションのShopify管理ID | いいえ | gid://shopify/ProductVariant/*** | gid://shopify/ProductVariant/38165164523671 | 商品を変更する場合のみ指定 | | L quantity | 変更後数量 | いいえ | 1以上の数値 | 1 | 数量を変更する場合のみ指定 | | L sellingPlanId | 変更後契約商品に紐付ける定期購買プランのShopify管理ID | いいえ | gid://shopify/SellingPlan/*** | gid://shopify/SellingPlan/8135704870 | プランを変更する場合のみ指定 | | removeLines | 削除商品（配列） | いいえ | Object[] | [ { lineId :gid://shopify/SubscriptionLine/0b36c12e-8431-41b5-bf32-7d59044aa824 }, { lineId :gid://shopify/SubscriptionLine/0b36c12e-8431-41b5-bf32-7d59044aa824 }, ] | | | L lineId | 削除する契約商品のShopify管理ID | はい | gid://shopify/SubscriptionLine/*** | gid://shopify/SubscriptionLine/0b36c12e-8431-41b5-bf32-7d59044aa824 | |

３．レスポンス内容

変更後の契約内の商品情報がJSONデータで返却されます。

■正常時レスポンス

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

■異常時レスポンス

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