Bundle
Properties
- Name
sections- Type
- list of [Section](/section) instances
- Description
Multiple for multi-section bundle, one for single section bundle.
- Name
current_section- Type
- [Section](/section) instance
- Description
Currently selected section
- Name
has_next_section- Type
- boolean
- Description
True if there is some section after current one, false otherwise. Usually used to determine if the 'Next' button should be displayed.
- Name
has_prev_section- Type
- boolean
- Description
True if there is some section before current one, false otherwise. Usually used to determine if the 'Previous' button should be displayed.
- Name
adding_to_cart- Type
- boolean
- Description
True if the bundle is currently being added to cart, false otherwise. 'Add to cart' button should be disabled or hidden when bundle is being added to cart.
- Name
can_add_to_cart- Type
- boolean
- Description
True if bundle configuration is valid and bundle can be added to cart, false otherwise. Hide or disable the button to add to cart if this property is false.
- Name
components- Type
- [BundleContent](/bundleContent) instance
- Description
Current bundle configuration. Contains list of products added to the bundle, price, etc.
- Name
errors- Type
- list of strings
- Description
List of configuration problems that will prevent bundle creation.
- Name
external_name- Type
- string
- Description
External name of the bundle.
- Name
description- Type
- string(html)
- Description
Bundle description.
- Name
bundle_image_url- Type
- string(url)
- Description
Link to bundle image.
- Name
header_image_url- Type
- string(url)
- Description
Link to bundle header image.
- Name
product_url- Type
- string(url)
- Description
Link to product representing the bundle (it will redirect to the bundle configuration page).
- Name
url- Type
- string(url)
- Description
Link to the bundle configuration page (current page).
- Name
products_per_row- Type
- number
- Description
Number of products in one row.
- Name
discount_minimum- Type
- number
- Description
Minimum price a bundle must reach to apply discount.
- Name
discount_type- Type
- string
- Description
Type of a bundle discount - one of fixed (e.g. discounted by $20), percentage (e.g. 10 percent discount), or price (fixed bundle price).
- Name
discount_value- Type
- number
- Description
Value of the discount.
- Name
limit_rules- Type
- array of [LimitRule](/limitRules) instances
- Description
Limits for the bundle.
- Name
taxable- Type
- boolean
- Description
True if bundle is marked as taxable, otherwise false.
- Name
requires_shipping- Type
- boolean
- Description
True if bundle requires shipping, otherwise false.
- Name
sku- Type
- string
- Description
SKU of the bundle.
- Name
vendor- Type
- string
- Description
Vendor of the bundle.
- Name
variant_prefix- Type
- string
- Description
Prefix of unique bundle identification.
- Name
published- Type
- boolean
- Description
Shows/hides based on if the bundle is live/draft.