目次

１．基本情報

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

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

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

項目名 内容 入力例 備考
subscriptionId 定期購買ID gid://shopify/SubscriptionContract/1111111111
variantId 商品バリエーションID gid://shopify/ProductVariant/38165164523671 shopify上の商品バリエーションID
planId 適用するプランID gid://shopify/SellingPlan/7771652390 プランIDはプラン情報取得APIから取得可能となります。
ここで指定されたプランの割引が適用される仕組みとなります。
lineId Shopify上の契約商品管理ID gid://shopify/SubscriptionLine/406f1e04-cc0d-46d7-ba8e-85cbb7655223
quantity 数量 3

３．レスポンス内容

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

■正常時レスポンス

プロパティ 型 説明
array() array 更新後の契約商品一覧
L productId string null
L variantId string null
L variantImage string null
L title string タイトル
L onlineStorePreviewUrl string 商品URL
L variantTitle string null
L sku string null
L quantity number 数量
L currentPriceAmount float 商品価格
L currentPriceCurrencyCode string 商品価格の通貨単位
L lineDiscountedPriceAmount float 商品価格（廃止）
L lineDiscountedPriceCurrencyCode string 商品価格の通貨単位
L lineId string 契約商品のShopify管理ID

■異常時レスポンス

ステータスコード 型 エラーメッセージ
400 string 定期購買はすでに解約されています
400 string この定期購買の契約種別では許可されていない操作です
404 string 定期購買が存在しません
404 string ストアが存在しません
404 string プランが存在しません
404 string 商品が存在しません（lineIdに紐づく契約商品が存在しない場合）
404 string 商品が存在しません（追加するvariantIdの商品が存在しない場合）
500 string 内部エラーが発生しています