商品変更

1.基本情報


指定された契約情報の契約内の商品を変更する。
 
項目名内容
アクション名changeSubscriptionLine
リクエストメソッドPOST

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


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

3.レスポンス内容


変更後の契約内の商品情報がJSONデータで返却されます。
 
■正常時レスポンス
プロパティ説明
array()array更新後の契約商品一覧
L productIdstring | null商品のShopify管理ID
L variantIdstring | null商品バリエーションのShopify管理ID
L variantImagestring | null商品画像 or バリエーション画像URLバリエーションがないとき、商品が削除された時はnull
L titlestringタイトル
L onlineStorePreviewUrlstring商品URL
L variantTitlestring | nullバリエーションタイトルバリエーションがないときはnull
L skustring | nullSKU
L quantitynumber数量
L currentPriceAmountfloat商品価格
L currentPriceCurrencyCodestring商品価格の通貨単位
L lineDiscountedPriceAmountfloat商品価格(廃止)
L lineDiscountedPriceCurrencyCodestring商品価格の通貨単位
L lineIdstring契約商品のShopify管理ID
 
■異常時レスポンス
ステータスコードエラーメッセージ
400string定期購買はすでに解約されています
400stringこの定期購買の契約種別では許可されていない操作です
404string定期購買が存在しません
404stringストアが存在しません
404stringプランが存在しません
404string商品が存在しません(lineIdに紐づく契約商品が存在しない場合)
404string商品が存在しません(追加するvariantIdの商品が存在しない場合)
500string内部エラーが発生しています