概要
APIリファレンス
指定された契約情報のお届け日を変更する。
| 項目名 | 内容 |
|---|---|
| アクション名 | updateDeliveryDays |
| リクエストメソッド | POST |
| 項目名 | 内容 | 必須 | フォーマット | 入力例 | 備考 |
|---|---|---|---|---|---|
| subscriptionId | 定期購買ID | はい | gid://shopify/SubscriptionContract/*** | gid://shopify/SubscriptionContract/123456789 | |
| deliveryDays | お届日数 | はい | 数値 | 3 | 決済日より3日後をお届け日として指定したい場合。 |
| -1: 指定なし | |||||
| -1以下: ストア設定のdeliveryDaysが優先されます。 | |||||
| deliveryTime | お届け時間帯 | はい | 1文字以上2文字以下の文字列、またはnull | 10 | アプリの「一般設定 > お届け時間設定」で設定したタグを指定する。 |
| 時間帯を指定しない場合は null を指定する。 | |||||
| nextBilling | 次回決済日 | はい | YYYY-MM-DDTHH:mm:ss:SSSZ | 2024-09-23T08:00:00.000Z | お届け日に合わせて注文日を変更する際に指定したい注文日 |
| deliveryDate | お届け日 | はい | 文字列 | 2025年1月4日 | FlowトリガーのdeliveryDateとして設定したい日付 |
お届け日変更後の契約情報が返却されます。
■正常時レスポンス
| プロパティ | 型 | 説明 |
|---|---|---|
| id | number | 定期購買アプリ内での定期購買契約管理ID |
| shopId | number | 定期購買アプリ内でのストア管理ID |
| createdAt | timestamp | 契約作成日（UTC） |
| updatedAt | timestamp | 契約更新日（UTC） |
| billingPolicyInterval | string | 契約情報の決済周期（単位） |
| billingPolicyIntervalCount | number | 契約情報の決済周期 |
| billingPolicyMinCycles | number | null |
| billingPolicyMaxCycles | number | null |
| currencyCode | string | 契約通貨 |
| deliveryPolicyInterval | string | 契約情報のお届周期（単位）※未使用 |
| deliveryPolicyIntervalCount | number | 契約情報のお届周期 ※未使用 |
| status | string | 契約情報のステータス（ACTIVE、PAUSED、CANNCELLED） |
| customerDisplayName | string | null |
| nextDeliveryDate | timestamp | 次回お届け日 |
| subscriptionContractId | string | 契約情報のShopify管理ID |
| originOrderId | string | null |
| deliveryPriceAmount | number | null |
| deliveryPriceCurrencyCode | string | 契約情報の決済時配送料金通貨 |
| originOrderToken | string | null |
| deliveryAddress1 | string | null |
| deliveryAddress2 | 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 |
| deliveryCity | string | null |
| originOrderName | string | null |
| originOrderTest | boolean | 初回注文がテスト注文か（true：テスト注文） |
| customerId | number | null |
| customerPaymentMethodId | number | null |
| deliveryDays | number | 契約情報のお届けまでに必要な日数 |
| test | boolean | true：テスト契約、false：本契約 |
| cancelledAt | timestamp | 契約解約日（UTC） |
| cancelReason | string | null |
| cancelExtraText | string | null |
| needToAlterSubscriptionLine | boolean | true：次回決済完了時商品差替あり、false：次回決済完了時商品差替なし |
| hide | boolean | true：非表示契約、false：表示契約 |
| resumedAt | timestamp | 契約再開日（UTC） |
| deliveryTimeText | string | null |
| note | string | null |
| failedAttemptCount | number | null |
| originOrderCheckoutToken | string | null |
| updatedBulkNextBillingDate | boolean | 一括決済機能を利用している場合 true |
■異常時レスポンス
| --- | --- | --- |