HOME設定方法外部アプリ連携活用方法よくあるご質問サポート予約
HOME設定方法外部アプリ連携活用方法よくあるご質問サポート予約
どのようなことでお困りですか？/定期購買マイページAPIリファレンス/定期購買契約一覧取得

定期購買契約一覧取得

１．基本情報

ログインユーザーの定期購買一覧の情報を取得する。
 
項目名内容
アクション名getSubscriptions
リクエストメソッドPOST

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

なし
 

３．レスポンス内容

ログインユーザーの定期購買一覧の情報が返却されます。
 
■正常時レスポンス
プロパティ型説明
array()契約一覧
L originOrderIdstring | null初回注文のShopify管理ID
L originOrderTokenstring | null初回注文のShopify管理トークン
L originOrderNamestring | null初回注文のShopify注文名
L customerDisplayNamestring | null顧客表示名
L customerPaymentMethodIdnumber | null定期購買アプリ内の顧客決済ID
L subscriptionContractIdstring契約情報のShopify管理ID
L billingPolicyIntervalstring契約情報の決済周期（単位）
L billingPolicyIntervalCountnumber契約情報の決済周期
L billingPolicyMinCyclesnumber | null契約情報の最低購入回数
L billingPolicyMaxCyclesnumber | null契約情報の最大購入回数
L statusstring契約情報のステータス（ACTIVE、PAUSED、CANNCELLED）
L deliveryPriceAmountnumber | null契約情報の決済時配送料金
L deliveryPriceCurrencyCodestring契約情報の決済時配送料金通貨
L deliveryAddress1string | null契約情報の配送先住所（住所）
L deliveryAddress2string | null契約情報の配送先住所（建物名、部屋番号）
L deliveryCitystring | null契約情報の配送先住所（市区町村）
L deliveryCompanystring | null契約情報の配送先住所（会社名）
L deliveryCountrystring | null契約情報の配送先住所（国）
L deliveryCountryCodestring | null契約情報の配送先住所（国コード）
L deliveryFirstNamestring | null契約情報の配送先住所（名）
L deliveryLastNamestring | null契約情報の配送先住所（姓）
L deliveryNamestring | null契約情報の配送先住所（名＋姓）
L deliveryPhonestring | null契約情報の配送先住所（電話番号）
L deliveryProvincestring | null契約情報の配送先住所（都道府県）
L deliveryProvinceCodestring | null契約情報の配送先住所（都道府県コード）
L deliveryZipstring | null契約情報の配送先住所（郵便番号）
L deliveryDaysnumber契約情報のお届けまでに必要な日数
L deliveryTimestring | null契約情報のお届け時間帯
L createdAttimestamp契約作成日
L nextBillingDatetimestamp次回決済日時
L paymentTypestring | nullクレジットカード or 不明
L deliveryTimeTextstring | nullお届け日時間帯
L nextDeliveryDatetimestamp次回お届け日
L canSkipCancelbooleantrue：スキップ取消可能
L subscriptionLinesarray()
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
booleanbooleanboolean
L quantitynumber数量
L currentPriceAmountfloat商品価格
L currentPriceCurrencyCodestring商品価格の通貨単位
L lineDiscountedPriceAmountfloat商品価格（廃止）
L lineDiscountedPriceCurrencyCodestring商品価格の通貨単位
L lineIdstring契約商品のShopify管理ID
L customercustomer顧客情報
L customerIdstring顧客情報のShopify管理ID
L rankrankランク情報
L namestringランク名
L discountPercentagenumberランク割引率
L 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 disableDeliveryDaysWedbooleanお届けできない曜日設定（水曜日）
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 rankGroupランク設定
L publicbooleantrue : 公開済み
L bisinessHolidays配送不可設定
L id numberid
L targetDatetimestamp配送不可日
L bisinessHolidaysarray()決済履歴
L orderIdstring | null注文情報のShopify管理ID
L orderTokenstring | null注文情報のShopify管理トークン
L orderNamestring | null注文情報のShopify注文名
L readybooleantrue：決済済み、false：決済中
L createdAttimestamp決済日
L rankrankランク情報
L namestringランク名
L discountPercentagenumberランク割引率
L customerIdstring顧客情報のShopify管理ID
 
■異常時レスポンス
ステータスコード型説明
404-ストアが存在しません
404-定期購買が存在しません