概要
APIリファレンス
ログインユーザーの定期購買一覧の情報を取得する。
項目名 | 内容 |
---|---|
アクション名 | getSubscriptions |
リクエストメソッド | POST |
なし
ログインユーザーの定期購買一覧の情報が返却されます。
■正常時レスポンス
プロパティ | 型 | 説明 |
---|---|---|
array() | 契約一覧 | |
L originOrderId | string | null |
L originOrderToken | string | null |
L originOrderName | string | null |
L customerDisplayName | string | null |
L customerPaymentMethodId | number | null |
L subscriptionContractId | string | 契約情報のShopify管理ID |
L billingPolicyInterval | string | 契約情報の決済周期(単位) |
L billingPolicyIntervalCount | number | 契約情報の決済周期 |
L billingPolicyMinCycles | number | null |
L billingPolicyMaxCycles | number | null |
L status | string | 契約情報のステータス(ACTIVE、PAUSED、CANNCELLED) |
L deliveryPriceAmount | number | null |
L deliveryPriceCurrencyCode | string | 契約情報の決済時配送料金通貨 |
L deliveryAddress1 | string | null |
L deliveryAddress2 | string | null |
L deliveryCity | string | null |
L deliveryCompany | string | null |
L deliveryCountry | string | null |
L deliveryCountryCode | string | null |
L deliveryFirstName | string | null |
L deliveryLastName | string | null |
L deliveryName | string | null |
L deliveryPhone | string | null |
L deliveryProvince | string | null |
L deliveryProvinceCode | string | null |
L deliveryZip | string | null |
L deliveryDays | number | 契約情報のお届けまでに必要な日数 |
L deliveryTime | string | null |
L createdAt | timestamp | 契約作成日 |
L nextBillingDate | timestamp | 次回決済日時 |
L paymentType | string | null |
L deliveryTimeText | string | null |
L nextDeliveryDate | timestamp | 次回お届け日 |
L canSkipCancel | boolean | true:スキップ取消可能 |
L subscriptionLines | array() | |
L productId | string | null |
L variantId | string | null |
L variantImage | string | null |
L title | string | タイトル |
L onlineStorePreviewUrl | string | 商品URL |
L variantTitle | string | null |
boolean | boolean | boolean |
L quantity | number | 数量 |
L currentPriceAmount | float | 商品価格 |
L currentPriceCurrencyCode | string | 商品価格の通貨単位 |
L lineId | string | 契約商品のShopify管理ID |
L customer | customer | 顧客情報 |
L customerId | string | 顧客情報のShopify管理ID |
L rank | rank | ランク情報 |
L name | string | ランク名 |
L discountPercentage | number | ランク割引率 |
L shop | shop | ストア情報 |
L showSkip | boolean | 一般設定>スキップの表示 |
L showPause | boolean | 一般設定>一時停止/再開を表示 |
L showCancel | boolean | 一般設定>一時停止/解約の表示 |
L showChangeAddress | boolean | 一般設定>お届け先住所の変更 |
L mypageRemarks | string | null |
L showDelivery | boolean | 一般設定> |
L deliveryDays | number | 一般設定> |
L mypageChangeDeliveryDays | boolean | 一般設定> |
L enableApplyCoupon | boolean | 一般設定> |
L applyCouponDays | number | 一般設定> |
L calcBase | string | 運用起点設定(billingDate:決済日起点、deliveryDate:お届け日起点) |
L deliveryConvenience | boolean | お届けできない曜日設定(warehouse:倉庫都合、deliverer:配送業者都合) |
■異常時レスポンス
| --- | --- | --- |