Merchant API: product bundles

This article describes how you can create, update, and retrieve product bundles via ChannelEngine's Merchant API.

Table of contents

Introduction

Available API endpoints

• Create bundles in bulk
• Update the percentage split
• Retrieve existing bundles

FAQs

Introduction

Bundling products is a popular way to generate sales, maximize profits, promote differentiated products, sell unpopular products, optimize advertising costs, and reduce decision-making pressure.

You can manage product bundles on ChannelEngine via the web interface, CSV upload, and the Merchant API. This article describes how to manage product bundles via the Merchant API.

Available API endpoints

Create bundles in bulk

• Create bundles: POST /v2/productbundles

Use this endpoint to create product bundles in bulk. Bundles on ChannelEngine are created by grouping existing products into a new product, i.e.: bundle. 

In your payload, include unique identifiers (the EAN and the Merchant product number) as well as the name and the total price of the bundle.

In addition, add the products that make up the bundle by defining them as parts in the Parts array of the endpoint. For each bundle part, specify:

• Merchant product number
• Quantity (i.e.: how many items of the same product should be included)
• Percentage split

If the products you want to use in the bundle as parts do not yet exist on ChannelEngine, create those first. To create products, either upload them via a product feed or send a request via the POST /v2/products endpoint. For guidance on how to create products via the Merchant API, check out the Products section of the article Merchant API: main resources.

Percentage split

Parts of a bundle do not have a price of their own; instead, you specify how much of the final selling price is allocated to each part, i.e.: percentage split. E.g.: if the bundle price is 100%, Product A might account for 30%, and Product B for 70%.

Specify the percentage split for each bundle part, and ChannelEngine automatically calculates the price for each part based on the provided percentages.

To learn more about the percentage split, check out the article ChannelEngine: product bundles.

Copy attributes to bundle

Copy attributes from existing products to add to your new bundle product. To reuse existing custom attributes, apply the CopyAttributesFrom and CopyCustomFields parameters. Set the CopyAttributesFrom to the Merchant product number of the product to copy the attributes from, and set CopyCustomFields to True.

Update the percentage split

• Update bundles: PUT /v2/productbundles

Use this endpoint to update the percentage split of each bundle part. You cannot change any other attribute on an existing bundle. Provide the unique Merchant product number of the bundle and its constituent parts. If you update one percentage value, you must update all percentages to ensure their total equals 100%. 

ChannelEngine automatically recalculates the price for each part based on the updated percentages.

Update product information on a bundle

Product bundles are products like any other. If you need to update other data, such as the bundle’s description, title, or custom attributes, use the PATCH /V2/product endpoint. To learn more about the PATCH /v2/products endpoint, check out the Incremental updates section in the article Merchant API: best practices.

Retrieve existing bundles

• Retrieve bundles: GET /v2/productbundles

Use this endpoint to retrieve existing product bundles. The response includes the unique identifiers (the EAN and Merchant product number), the name, and the price of a bundle and its constituent parts. You can also retrieve the percentage split – a price percentage assigned to the specific bundle part.

Note that the GET /v2/productbundles endpoint returns all bundles in your tenant. To avoid timeouts and reduce payload size, apply pagination and available filters. Pagination provides the total number of items and the number of items per page, which helps you navigate through pages and retrieve required bundles quickly.

FAQs

Can I delete a product bundle via the Merchant API?
No, you can only delete a bundle from the web interface. To learn more about deleting a bundle, check out the article ChannelEngine: product bundles.