概要
APIリファレンス
指定されたBOX情報を取得する。
| 項目名 | 内容 |
|---|---|
| アクション名 | getBox |
| リクエストメソッド | POST |
| 項目名 | 内容 | 必須 | 入力例 | 備考 |
|---|---|---|---|---|
| subscriptionContractId | 定期購買ID | はい | gid://shopify/SubscriptionContract/1234567890 | |
| boxId | BOXID | はい | aaa0a123-1234-5678-a5a3-96aaaa0aaaaa | |
| page | ページ数 | いいえ | 0 | 0以上の値を指定してください。 |
指定された定期購読のBOX情報が返却されます。
■正常時レスポンス
| プロパティ | 型 | 説明 |
|---|---|---|
| title | string | BOXタイトル |
| description | string | BOX説明 |
| parentVariants | array | 親商品の一覧 |
| 全件を取得します。 | ||
| L variantId | string | 商品バリエーションID |
| L quantity | number | 数量 |
| L displayName | string | 商品名 |
| L selected | boolean | 現在の親商品か |
| childVariants | array | 子商品の一覧 |
| 10件ずつ取得します。page パラメータを指定して取得します。 | ||
| L productId | string | 商品ID |
| L variantId | string | 商品バリエーションID |
| L displayName | string | 商品名 |
| L onlineStorePreviewUrl | string | 商品URL |
| L quantity | number | 数量 |
| L description | string | 説明 |
| canChoiceVariants | boolean | バリエーション選択を有効としているか |
| variantQuantities | array | 各バリエーションごとの数量 |
| L variantId | string | 商品バリエーションID |
| L quantity | number | 数量 |
| totalQuantity | number | 合計数量 |
| prevPage | boolean | 子商品一覧の前ページがあるか |
| nextPage | boolean | 子商品一覧の次ページがあるか |