BOX情報取得

1.基本情報

 

指定されたBOX情報を取得する。
 
項目名内容
アクション名getBox
リクエストメソッドPOST

2.リクエストに必要な内容


項目名内容必須入力例備考
subscriptionContractId定期購買IDはいgid://shopify/SubscriptionContract/1234567890
boxIdBOXIDはいaaa0a123-1234-5678-a5a3-96aaaa0aaaaa
pageページ数いいえ00以上の値を指定してください。
 

3.レスポンス内容


指定された定期購読のBOX情報が返却されます。
 
■正常時レスポンス
プロパティ説明
titlestringBOXタイトル
descriptionstringBOX説明
parentVariantsarray親商品の一覧 全件を取得します。
L variantIdstring商品バリエーションID
L quantitynumber数量
L displayNamestring商品名
L selectedboolean現在の親商品か
childVariantsarray子商品の一覧 10件ずつ取得します。page パラメータを指定して取得します。
L productIdstring商品ID
L variantIdstring商品バリエーションID
L displayNamestring商品名
L onlineStorePreviewUrlstring商品URL
L quantitynumber数量
L descriptionstring説明
canChoiceVariantsbooleanバリエーション選択を有効としているか
variantQuantitiesarray各バリエーションごとの数量
L variantIdstring商品バリエーションID
L quantitynumber数量
totalQuantitynumber合計数量
prevPageboolean子商品一覧の前ページがあるか
nextPageboolean子商品一覧の次ページがあるか