Merchant API: product bundles v2

This article describes the product bundles resource that you can access via ChannelEngine's Merchant API.

Table of contents

Introduction

Available API endpoints

• Retrieve bundles
• Create bundles
• Update 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 through both the web interface and the Merchant API.

Available API endpoints

• Retrieve bundles: GET /v2/productbundles

Use this endpoint to retrieve 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. E.g.: if the total price is 100%, product A might account for 30% , and Product B for 70%. To learn more about percentage split, check out the article ChannelEngine: product bundles v2.

• Create bundles: POST /v2/productbundles

Use this endpoint to create product bundles in bulk. In your payload, you must include unique identifiers (the EAN and Merchant product number), the name, the description, and the total price of the bundle itself. Make sure you also specify the bundle's parts – their Merchant product number, quantity (i.e.: how many of the same product should be included), and percentage split. Note that the parts must already exist on ChannelEngine. 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 bundles: PUT /v2/productbundles

Use this endpoint to update existing product bundles. Provide the unique Merchant product number of the bundle and its constituent parts. You can only update the percentage split of each bundle part. 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.

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 this endpoint, check out the article Merchant API: best practices.

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 v2.