目次

１．基本情報

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

※ 契約内の商品は0個以下にすることは不可となります。（Shopify仕様により）

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

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

項目名 内容 入力例 備考
subscriptionId 定期購買ID 1111111111
subscriptionLine 削除する商品のLineId {
lineId : Shopify上の契約商品管理ID
} lineId : gid://shopify/SubscriptionLine/406f1e04-cc0d-46d7-ba8e-85cbb76312cc

３．レスポンス内容

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

■正常時レスポンス

プロパティ 型 説明
subscriptionLines array 更新後の契約商品一覧
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 currentPriceAmount float 商品価格
L currentPriceCurrencyCode string 商品価格の通貨単位
L lineDiscountedPriceAmount float 商品価格（廃止）
L lineDiscountedPriceCurrencyCode string 商品価格の通貨単位
L lineId string 契約商品のShopify管理ID
L sellingPlanId string null
subscriptionDiscounts array 契約に対する割引情報
L subscriptionManualDiscountId string 契約に対する割引のShopify管理ID
L title string 割引タイトル
L percentage number パーセント割引の場合の割引率
L amount number 固定割引の場合の割引額
L currencyCode string 割引の通貨単位

■異常時レスポンス

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