Weโre excited to roll out a new enhancement to our Order Import API: Bundle Order Support. This powerful update enables you to import orders that include bundled products โ a key feature for businesses selling kits, multi-item packs, or grouped offerings.
Whatโs New?
Previously, our API supported standard item imports using a predefined JSON format. With this new feature, you can now define Bundle Orders, allowing multiple child items to be associated with a parent bundle item.
To define a bundle, use the new ChildComponents
structure within the parent item. Each entry in ChildComponents
represents a product that is part of the bundle and must include all required fields.
Bundle Component Structure
Below is the required JSON structure for adding ChildComponents
to a bundled item:
"ChildComponents": [ { "ItemID": "", "BundleItemName": "", "ItemSKU": "", "Quantity": "", "Price": "", "IndividualSkuExchange": "", "IndividualSkuReturn": "", "ItemImageUrl": "" }, { "ItemID": "", "BundleItemName": "", "ItemSKU": "", "Quantity": "", "Price": "", "IndividualSkuExchange": "", "IndividualSkuReturn": "", "ItemImageUrl": "" } ]
This array must be included within the JSON object of the parent item you want to designate as a bundle.
Field Definitions
Here is a detailed explanation of each required field in the ChildComponents
array:
- ItemID
A unique identifier for the child item within the bundle. This must be distinct for every child component in the same bundle to ensure accurate tracking and referencing. - BundleItemName
The display name of the child item. - ItemSKU
The Stock Keeping Unit (SKU) that uniquely identifies the child item within your inventory system. - Quantity
The number of units of the child item included in the bundle. This determines how many of the child item are delivered as part of one bundle. - Price
The assigned price of the individual child item, which can be used for internal costing, reporting, or detailed order breakdowns. The price is calculated per unit - IndividualSkuExchange
A boolean flag (true
orfalse
) indicating whether the child item can be exchanged independently of the bundle. If set tofalse
, the item must be exchanged only as part of the full bundle. - IndividualSkuReturn
A boolean flag (true
orfalse
) indicating whether the child item can be returned individually. Iffalse
, the item must be returned with the entire bundle. - ItemImageUrl
A direct URL to an image representing the child item. This image may be displayed on order summaries, invoices, or customer-facing platforms.
Why This Matters
- ๐ฆ Accurate Bundle Tracking โ Clearly define the components within each bundle for inventory and order management.
- ๐ Flexible Returns & Exchanges โ Choose which child items can be handled independently after purchase.
- ๐ผ๏ธ Enhanced Visibility โ Present customers with clear images and details of what's included in each bundle.
Comments
0 comments
Please sign in to leave a comment.