目次

１．基本情報

指定された契約情報の契約に商品を追加する。

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

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

項目名 内容 必須 フォーマット 入力例 備考
subscriptionId 定期購買ID はい gid://shopify/SubscriptionContract/*** gid://shopify/SubscriptionContract/1111111111
planId 適用するプランID はい gid://shopify/SellingPlan/*** gid://shopify/SellingPlan/7771652390 プランIDはプラン情報取得APIから取得可能となります。
ここで指定されたプランの割引が適用される仕組みとなります。
planName プラン名 廃止 - - planIdで指定したプラン名を利用するため廃止となりました。
リクエストパラメーターに含めていてもエラーにはなりませんが、利用はされません。
subscriptionLine 追加商品 はい Object {
productId : gid://shopify/Product/6182307954839
variantId : gid://shopify/ProductVariant/38165164523671
title : “タイトル”
variantTitle: “バリエーションタイトル”
quantity : 1
currentPriceAmount : 1000
lineDiscountedPriceCurrencyCode: “JPY”
lineId : null
}
L productId 商品ID はい gid://shopify/Product/*** gid://shopify/Product/6182307954839
L variantId shopify上の商品バリエーションID はい gid://shopify/ProductVariant/*** gid://shopify/ProductVariant/38165164523671
L lineId 契約商品のShopify管理ID はい gid://shopify/SubscriptionLine/***
またはnull gid://shopify/SubscriptionLine/123456789 指定した場合、商品の変更時の Flow トリガーが実行されます。
商品変更処理を「商品追加API→商品削除API」の組み合わせで実現する場合に限り、指定してください。

※上記商品変更処理は現在非推奨となっており、商品を変更したい場合は 商品変更API をご利用ください。 | | L title | 契約商品として設定したい商品名 | はい | 文字列 | タイトル | | | L variantTitle | バリエーションタイトル | はい | 文字列 | バリエーションタイトル | | | L quantity | 数量 | はい | 1以上の数値 | 1 | | | L onlineStorePreviewUrl | 商品画像URL | いいえ | URL | https://*** | | | L variantImage | バリエーション画像URL | いいえ | URL | null | https://*** | | | L currentPriceAmount | 商品価格 | はい | 0以上の数値 | 1000 | | | L currentPriceCurrencyCode | 通貨 | はい | CurrencyCode | JPY | | | L lineDiscountedPriceAmount | ディスカウントを反映した商品小計 | はい | 0以上の数値 | 1000 | | | L lineDiscountedPriceCurrencyCode | 通貨 | はい | CurrencyCode | JPY | | | L sku | SKU | いいえ | 文字列 | | 商品のSKUを入力してください |

３．レスポンス内容

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

■正常時レスポンス

プロパティ 型 説明
array() array 更新後の契約商品一覧
L id number 定期購買アプリ内の契約商品管理ID
L applicationId number 定期購買アプリ内での定期購買契約管理ID
L productId string null
L variantId string null
L variantImage string null
L title string タイトル
L variantTitle string null
L sku string null
L quantity number 数量
L lineDiscountedPriceAmount number 商品価格
L lineDiscountedPriceCurrencyCode string 商品価格の通貨単位
L createdAt timestamp 登録日時
L updatedAt timestamp 更新日時
L onlineStorePreviewUrl string 商品URL
L currentPriceAmount number 商品価格
L currentPriceCurrencyCode string 商品価格の通貨単位
L lineId string 契約商品のShopify管理ID
L sellingPlanId string null
L sellingPlanName string null

■異常時レスポンス

ステータスコード 型 エラーメッセージ
400 string 定期購買はすでに解約されています
400 string この定期購買の契約種別では許可されていない操作です
404 string 定期購買が存在しません
404 string ストアが存在しません
500 string 内部エラーが発生しています