定期購買契約詳細取得

1.基本情報


指定された定期購買IDの詳細情報を取得する。
 
項目名内容
アクション名getSubscription
リクエストメソッドPOST

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


項目名内容必須入力例備考
subscriptionId定期購買IDはいgid://shopify/SubscriptionContract/123456789

3.レスポンス内容


指定された定期購買IDの詳細情報を返却されます。
 
■正常時レスポンス
プロパティ説明
originOrderIdstring | null初回注文のShopify管理ID
originOrderTokenstring | null初回注文のShopify管理トークン
originOrderNamestring | null初回注文のShopify注文名
customerDisplayNamestring | null顧客表示名
customerPaymentMethodIdnumber | null定期購買アプリ内の顧客決済ID
subscriptionContractIdstring契約情報のShopify管理ID
billingPolicyIntervalstring契約情報の決済周期(単位)
billingPolicyIntervalCountnumber契約情報の決済周期
billingPolicyMinCyclesnumber | null契約情報の最低購入回数
billingPolicyMaxCyclesnumber | null契約情報の最大購入回数
statusstring契約情報のステータス(ACTIVE、PAUSED、CANNCELLED)
deliveryPriceAmountnumber | null契約情報の決済時配送料金
deliveryPriceCurrencyCodestring契約情報の決済時配送料金通貨
deliveryAddress1string | null契約情報の配送先住所(住所)
deliveryAddress2string | null契約情報の配送先住所(建物名、部屋番号)
deliveryCitystring | null契約情報の配送先住所(市区町村)
deliveryCompanystring | null契約情報の配送先住所(会社名)
deliveryCountrystring | null契約情報の配送先住所(国)
deliveryCountryCodestring | null契約情報の配送先住所(国コード)
deliveryFirstNamestring | null契約情報の配送先住所(名)
deliveryLastNamestring | null契約情報の配送先住所(姓)
deliveryNamestring | null契約情報の配送先住所(名+姓)
deliveryPhonestring | null契約情報の配送先住所(電話番号)
deliveryProvincestring | null契約情報の配送先住所(都道府県)
deliveryProvinceCodestring | null契約情報の配送先住所(都道府県コード)
deliveryZipstring | null契約情報の配送先住所(郵便番号)
deliveryDaysnumber契約情報のお届けまでに必要な日数
deliveryTimestring | null契約情報のお届け時間帯
subscriptionDiscountsarray()割引情報
L subscriptionManualDiscountIdstring割引情報のShopify管理ID
L titlestring割引タイトル
L percentagenumber | nullパーセント割引の場合の値
L amountnumber | null固定額割引の場合の値
L rankbooleantrue:ランク機能による割引
L deliveryDiscountbooleantrue:一般設定>決済設定>指定金額を超えた場合の割引
L couponbooleantrue:一般設定>クーポン設定>マイページでのクーポン適用機能による割引
contractTypestring | nullSTANDARD:通常定期、BULK_PAY:一括払い定期
totalOrderCountnumber | null一括払い定期用の累計注文回数
bulkPayCountnumber | null一括払い定期用のサイクル内注文回数
bulkPayMinCycleCountnumber | null一括払い定期用の最小購入サイクル数
bulkPayNextBillingDatetimestamp一括払い定期用の次回支払い発生日
bulkPayCancellableBeginDatetimestamp一括払い定期用の解約可能期間開始日
bulkPayCancellableEndDatetimestamp一括払い定期用の解約可能期間終了日
subscriptionLinesarray()
L applicationIdnumber定期購買アプリ内での定期購買契約管理ID
L productIdstring | null商品のShopify管理ID
L variantIdstring | null商品バリエーションのShopify管理ID
L variantImagestring | null商品画像 or バリエーション画像URLバリエーションがないとき、商品が削除された時はnull
L titlestringタイトル
L variantTitlestring | nullバリエーションタイトルバリエーションがないときはnull
L skustring | nullSKU
L quantitynumber数量
L currentPriceAmountfloat商品価格
L currentPriceCurrencyCodestring商品価格の通貨単位
L lineDiscountedPriceAmountfloat商品価格(廃止)
L lineDiscountedPriceCurrencyCodestring商品価格の通貨単位
L lineIdstring契約商品のShopify管理ID
L sellingPlanIdstring契約商品に紐付ける定期購買プランのShopify管理ID
subscriptionHistoriesarray()スキップ履歴
L statusstring固定:SKIPPED
L skipCountnumber一度にスキップした回数
L canceledAttimestampスキップ取消日
L createdAttimestampスキップ日
customercustomer顧客情報
L customerIdstring顧客情報のShopify管理ID
L rankrankランク情報
L namestringランク名
L discountPercentagenumberランク割引率
shopshopストア情報
L showSkipboolean一般設定>スキップの表示
L showPauseboolean一般設定>一時停止/再開を表示
L showCancelboolean一般設定>一時停止/解約の表示
L showChangeAddressboolean一般設定>お届け先住所の変更
L mypageRemarksstring | null一般設定>
L showDeliveryboolean一般設定>
L deliveryDaysnumber一般設定>
L mypageChangeDeliveryDaysboolean一般設定>
L enableApplyCouponboolean一般設定>
L applyCouponDaysnumber一般設定>
L enableDeliveryTimesAMboolean廃止
L enableDeliveryTimes12boolean廃止
L enableDeliveryTimes14boolean廃止
L enableDeliveryTimes16boolean廃止
L enableDeliveryTimes18boolean廃止
L enableDeliveryTimes19boolean廃止
L enableDeliveryTimes20boolean廃止
L calcBasestring運用起点設定(billingDate:決済日起点、deliveryDate:お届け日起点)
L deliveryConveniencebooleanお届けできない曜日設定(warehouse:倉庫都合、deliverer:配送業者都合)
L disableDeliveryDaysMonbooleanお届けできない曜日設定(月曜日)
L disableDeliveryDaysTuebooleanお届けできない曜日設定(火曜日)
L disableDeliveryDaysWedお届けできない曜日設定(水曜日)
L disableDeliveryDaysThrbooleanお届けできない曜日設定(木曜日)
L disableDeliveryDaysFribooleanお届けできない曜日設定(金曜日)
L disableDeliveryDaysSatbooleanお届けできない曜日設定(土曜日)
L disableDeliveryDaysSunbooleanお届けできない曜日設定(日曜日)
L disableDeliveryDaysHolidaybooleanお届けできない曜日設定(祝曜日)
L showChangeProductboolean一般設定>商品の変更
L showNewAddProductboolean一般設定>他の商品追加
L showChangePaymentboolean一般設定>支払い方法の変更
L showRemoveProductboolean一般設定>定期購買商品の削除
L showNewOrderboolean一般設定>定期購買商品の追加注文
L enableDeliveryTimesAMstring | null廃止
L enableDeliveryTimes12string | null廃止
L enableDeliveryTimes14string | null廃止
L enableDeliveryTimes16string | null廃止
L enableDeliveryTimes18string | null廃止
L enableDeliveryTimes19string | null廃止
L enableDeliveryTimes20string | null廃止
L deliveryTimesarray()一般設定>お届け時間設定
L tagstring | nullタグ名
L titlestring | nullタイトル
L enableSkipGiftboolean一般設定>ギフトアプリが利用可能か
L skipGiftModalBodystring | null一般設定>スキップ時ギフト機能を使用した場合の表示内容
L isSkipGiftEnabledboolean一般設定>スキップ時ギフトを有効にする
customerIdnumber | null定期購買アプリ内の顧客ID
billingAttemptsarray()決済履歴
L orderIdstring | null注文情報のShopify管理ID
L orderTokenstring | null注文情報のShopify管理トークン
L orderNamestring | null注文情報のShopify注文名
L readybooleantrue:決済済み、false:決済中
L errorCodestring | nullShopify決済エラーコード
L errorMessagestring | nullShopify決済エラーメッセージ
L createdAttimestamp決済日
L isSkipGiftbooleantrue:ギフト注文による決済
L giftReceiverPageUrlstring | nullギフト用URL
L giftExpiredAttimestampギフト有効期限
createdAttimestamp契約作成日
nextBillingDatetimestamp次回決済日時
paymentTypestring | nullクレジットカード or 不明
rankrank契約情報のランク情報
L namestringランク名
L discountPercentagenumberランク割引率
deliveryTimeTextstring | nullお届け日時間帯
nextDeliveryDatetimestamp次回お届け日
canSkipCancelbooleantrue:スキップ取消可能
 
■異常時レスポンス
ステータスコード説明
404-ストアが存在しません
404-定期購買が存在しません