定期購買契約詳細取得
１．基本情報
指定された定期購買IDの詳細情報を取得する。
| 項目名 | 内容 |
|---|---|
| アクション名 | getSubscription |
| リクエストメソッド | POST |
２．リクエストに必要な内容
| 項目名 | 内容 | 入力例 | 備考 |
|---|---|---|---|
| subscriptionId | 定期購買ID | 1111111111 |
３．レスポンス内容
指定された定期購買IDの詳細情報を返却されます。
■正常時レスポンス
| プロパティ | 型 | 説明 |
|---|---|---|
| originOrderId | string | null | 初回注文のShopify管理ID |
| originOrderToken | string | null | 初回注文のShopify管理トークン |
| originOrderName | string | null | 初回注文のShopify注文名 |
| customerDisplayName | string | null | 顧客表示名 |
| customerPaymentMethodId | number | null | 定期購買アプリ内の顧客決済ID |
| subscriptionContractId | string | 契約情報のShopify管理ID |
| billingPolicyInterval | string | 契約情報の決済周期（単位） |
| billingPolicyIntervalCount | number | 契約情報の決済周期 |
| billingPolicyMinCycles | number | null | 契約情報の最低購入回数 |
| billingPolicyMaxCycles | number | null | 契約情報の最大購入回数 |
| status | string | 契約情報のステータス（ACTIVE、PAUSED、CANNCELLED） |
| deliveryPriceAmount | number | null | 契約情報の決済時配送料金 |
| deliveryPriceCurrencyCode | string | 契約情報の決済時配送料金通貨 |
| deliveryAddress1 | string | null | 契約情報の配送先住所（住所） |
| deliveryAddress2 | string | null | 契約情報の配送先住所（建物名、部屋番号） |
| deliveryCity | string | null | 契約情報の配送先住所（市区町村） |
| deliveryCompany | string | null | 契約情報の配送先住所（会社名） |
| deliveryCountry | string | null | 契約情報の配送先住所（国） |
| deliveryCountryCode | string | null | 契約情報の配送先住所（国コード） |
| deliveryFirstName | string | null | 契約情報の配送先住所（名） |
| deliveryLastName | string | null | 契約情報の配送先住所（姓） |
| deliveryName | string | null | 契約情報の配送先住所（名＋姓） |
| deliveryPhone | string | null | 契約情報の配送先住所（電話番号） |
| deliveryProvince | string | null | 契約情報の配送先住所（都道府県） |
| deliveryProvinceCode | string | null | 契約情報の配送先住所（都道府県コード） |
| deliveryZip | string | null | 契約情報の配送先住所（郵便番号） |
| deliveryDays | number | 契約情報のお届けまでに必要な日数 |
| deliveryTime | string | null | 契約情報のお届け時間帯 |
| subscriptionDiscounts | array() | 割引情報 |
| L subscriptionManualDiscountId | string | 割引情報のShopify管理ID |
| L title | string | 割引タイトル |
| L percentage | number | null | パーセント割引の場合の値 |
| L amount | number | null | 固定額割引の場合の値 |
| L rank | boolean | true：ランク機能による割引 |
| L deliveryDiscount | boolean | true：一般設定＞決済設定＞指定金額を超えた場合の割引 |
| L coupon | boolean | true：一般設定＞クーポン設定＞マイページでのクーポン適用機能による割引 |
| contractType | string | null | STANDARD：通常定期、BULK_PAY：一括払い定期 |
| totalOrderCount | number | null | 一括払い定期用の累計注文回数 |
| bulkPayCount | number | null | 一括払い定期用のサイクル内注文回数 |
| bulkPayMinCycleCount | number | null | 一括払い定期用の最小購入サイクル数 |
| bulkPayNextBillingDate | timestamp | 一括払い定期用の次回支払い発生日 |
| bulkPayCancellableBeginDate | timestamp | 一括払い定期用の解約可能期間開始日 |
| bulkPayCancellableEndDate | timestamp | 一括払い定期用の解約可能期間終了日 |
| subscriptionLines | array() | |
| L applicationId | number | 定期購買アプリ内での定期購買契約管理ID |
| L productId | string | null | 商品のShopify管理ID |
| L variantId | string | null | 商品バリエーションのShopify管理ID |
| L variantImage | string | null | 商品画像 or バリエーション画像URLバリエーションがないとき、商品が削除された時はnull |
| L title | string | タイトル |
| L variantTitle | string | null | バリエーションタイトルバリエーションがないときはnull |
| L sku | string | null | SKU |
| L quantity | number | 数量 |
| L currentPriceAmount | float | 商品価格 |
| L currentPriceCurrencyCode | string | 商品価格の通貨単位 |
| L lineId | string | 契約商品のShopify管理ID |
| L sellingPlanId | string | 契約商品に紐付ける定期購買プランのShopify管理ID |
| subscriptionHistories | array() | スキップ履歴 |
| L status | string | 固定：SKIPPED |
| L skipCount | number | 一度にスキップした回数 |
| L canceledAt | timestamp | スキップ取消日 |
| L createdAt | timestamp | スキップ日 |
| customer | customer | 顧客情報 |
| L customerId | string | 顧客情報のShopify管理ID |
| L rank | rank | ランク情報 |
| L name | string | ランク名 |
| L discountPercentage | number | ランク割引率 |
| 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：配送業者都合） |
| L disableDeliveryDaysMon | boolean | お届けできない曜日設定（月曜日） |
| L disableDeliveryDaysTue | boolean | お届けできない曜日設定（火曜日） |
| L disableDeliveryDaysWed | お届けできない曜日設定（水曜日） | |
| L disableDeliveryDaysThr | boolean | お届けできない曜日設定（木曜日） |
| L disableDeliveryDaysFri | boolean | お届けできない曜日設定（金曜日） |
| L disableDeliveryDaysSat | boolean | お届けできない曜日設定（土曜日） |
| L disableDeliveryDaysSun | boolean | お届けできない曜日設定（日曜日） |
| L disableDeliveryDaysHoliday | boolean | お届けできない曜日設定（祝曜日） |
| L showChangeProduct | boolean | 一般設定＞商品の変更 |
| L showNewAddProduct | boolean | 一般設定＞他の商品追加 |
| L showChangePayment | boolean | 一般設定＞支払い方法の変更 |
| L showRemoveProduct | boolean | 一般設定＞定期購買商品の削除 |
| L showNewOrder | boolean | 一般設定＞定期購買商品の追加注文 |
| L deliveryTimes | array() | 一般設定＞お届け時間設定 |
| L tag | string | null | タグ名 |
| L title | string | null | タイトル |
| L enableSkipGift | boolean | 一般設定＞ギフトアプリが利用可能か |
| L skipGiftModalBody | string | null | 一般設定＞スキップ時ギフト機能を使用した場合の表示内容 |
| L isSkipGiftEnabled | boolean | 一般設定＞スキップ時ギフトを有効にする |
| customerId | number | null | 定期購買アプリ内の顧客ID |
| billingAttempts | array() | 決済履歴 |
| L orderId | string | null | 注文情報のShopify管理ID |
| L orderToken | string | null | 注文情報のShopify管理トークン |
| L orderName | string | null | 注文情報のShopify注文名 |
| L ready | boolean | true：決済済み、false：決済中 |
| L errorCode | string | null | Shopify決済エラーコード |
| L errorMessage | string | null | Shopify決済エラーメッセージ |
| L createdAt | timestamp | 決済日 |
| L isSkipGift | boolean | true：ギフト注文による決済 |
| L giftReceiverPageUrl | string | null | ギフト用URL |
| L giftExpiredAt | timestamp | ギフト有効期限 |
| createdAt | timestamp | 契約作成日 |
| nextBillingDate | timestamp | 次回決済日時 |
| rank | rank | 契約情報のランク情報 |
| L name | string | ランク名 |
| L discountPercentage | number | ランク割引率 |
| deliveryTimeText | string | null | お届け日時間帯 |
| nextDeliveryDate | timestamp | 次回お届け日 |
| canSkipCancel | boolean | true：スキップ取消可能 |
| paymentType | string | null | クレジットカード or 不明 ※customerPaymentMethodが追加される以前に利用していたプロパティ |
| customerPaymentMethod | customerPaymentMethod | null | 顧客支払い情報 |
| L instrumentType | string | null | 支払い方法種別 下記のいずれか ・CustomerCreaditCard ・CustomerPaypalBillingAgreement ・CustomerShopPayAgreement |
| L instrumentBrand | string | null | クレカブランド名 |
| L instrumentLastDigits | string | null | クレカ番号の末尾4桁 |
| L instrumentName | string | null | クレカ名義 |
| L instrumentExpiryMonth | number | null | 有効期限(月) |
| L instrumentExpiryYear | number | null | 有効期限(年) |
| L instrumentInactive | boolean | null | 無効フラグ |
| L instrumentPaypalAccountEmail | string | null | Paypalメールアドレス |
■異常時レスポンス
| ステータスコード | 型 | 説明 |
|---|---|---|
| 404 | - | ストアが存在しません |
| 404 | - | 定期購買が存在しません |