Skip to main content
GET
Retrieve a Build-A-Box bundle by ID

Headers

X-API-Key
string

Path Parameters

id
integer<int64>
required

Query Parameters

api_key
string

API Key (Deprecated - Use Header X-API-Key instead)

Response

The box. Every field is in the response, with null where the box has no value. The example shows only some of them.

shop
string
required
allowOneTimePurchase
boolean
appliesOn
enum<string>
Available options:
PRODUCT,
COLLECTION,
BOTH,
ONE_TIME,
SUBSCRIPTION
buildABoxType
enum<string>
Available options:
CLASSIC,
SINGLE_PRODUCT,
MIX_AND_MATCH,
INFINITE,
CUSTOMIZE_BUNDLE,
CLASSIC_BUILD_A_BOX,
SINGLE_PRODUCT_BUILD_A_BOX,
VOLUME_DISCOUNT,
DISCOUNTED_PRICING,
SHIPPING_DISCOUNT,
BUY_X_GET_Y,
SECTIONED_BUNDLE
bundleBottomHtml
string
bundleRedirect
enum<string>
Available options:
CART,
CART_DRAWER,
CHECKOUT,
CUSTOM,
NONE
bundleTopHtml
string
chooseProductsText
string
collectionData
string
customRedirectURL
string
discount
number<double>
discountedVariants
string
groupName
string
id
integer<int64>
inventoryTrackingMode
enum<string>
Available options:
ADD_CHILD_PRODUCT_ON_ORDER,
ADD_CHILD_PRODUCT_ON_CHECKOUT
maxProductCount
integer<int32>
minOrderAmount
number<double>
minProductCount
integer<int32>
minUniqueProductCheck
boolean
name
string
proceedToCheckoutButtonText
string
productDiscountType
enum<string>
Available options:
SELECTED_PRODUCT,
EACH_PRODUCT
productSelectionType
enum<string>
Available options:
PRODUCT,
COLLECTION
productViewStyle
enum<string>
Available options:
QUICK_ADD,
VIEW_DETAILS
sections
string
selectionType
enum<string>
Available options:
FIXED,
FLEXIBLE
sellingPlanIds
string
singleProductSettings
string
subscriptionBundlingEnabled
boolean
subscriptionGroup
string
subscriptionId
integer<int64>
thirdPartyRule
boolean
tieredDiscount
string
trackInventory
boolean
uniqueRef
string
variants
string