概要
APIリファレンス
定期購買契約に対して顧客の保有ポイントを利用してディスカウントを適用するAPIです。
| 項目名 | 内容 |
|---|---|
| アクション名 | getOneTimePurchaseVariants |
| リクエストメソッド | POST |
| 項目名 | 内容 | 必須 | フォーマット | 入力例 | 備考 |
|---|---|---|---|---|---|
| subscriptionContractId | 定期購買契約ID | はい | string(gid) | gid://shopify/SubscriptionContract/123456 | |
| page | ページ番号 | いいえ | number(0以上) | 0 | 0以上の値を指定してください。 |
一度だけ購入商品として定期購買契約に追加可能な商品の一覧を返します。
| プロパティ | 型 | 説明 |
|---|---|---|
| products | array | 商品情報 |
| L variants | array | バリエーション情報 |
| L id | string | 商品バリエーションのShopify管理ID |
| L title | string | バリエーションタイトル |
| L displayName | string | 商品名 |
| L sku | string | null |
| L price | number | 価格 |
| L taxable | boolean | true:税込み、false:税別 |
| L requiresShipping | boolean | true:配送商品、false:配送不要商品 |
| L availableForSale | boolean | true:販売可能、false:販売不可能 |
| L image | object | 画像情報 |
| L id | string | null |
| L url | string | 商品画像URL |
| L width | number | null |
| L height | number | null |
| L selectedOptions | array | undefined |
| L name | string | バリエーションタイトル |
| L value | string | バリエーション値 |
| page | number | ページ番号 |
| perPage | number | 表示件数 |
| hasNextPage | boolean | true:次のページあり、false:次のページなし |
| hasPreviousPage | boolean | true:前のページあり、false:前のページなし |
契約・設定関連
| --- | --- |
一度だけ購入商品を追加時の入力値
{
...,
planId: null,
isOneTimePurchase: true
}
定期商品を追加時の入力値
{
...,
planId: 'gid://shopify/SellingPlan/xxx',
isOneTimePurchase: false
}