Add Bundle Component to Existing Bundle


When to Use

  • After a bundle product and its components are created, this is how to add a new bundle component item to the bundle.
  • Requires the Product ID (these values are not the Sku value for their respective products - they are the ChannelAdvisor unique ID representing the product).
    • Place a GET Products request and $filter=Sku eq 'BUNDLE SKU VALUE'&$select=ID to return the ID of the bundle SKU to be used in the "ProductID" property.
  • Requires the Component ID (not the Component Sku) - which is the ChannelAdvisor Product ID of this product.
    • See examples of Bundle retrievals to get this value OR
    • Place a GET Products request and $filter=Sku eq 'COMPONENT SKU VALUE'&$select=ID to return the ID of the bundle SKU to be used in the "ComponentID" property

Resource URL / Endpoint

POST https://api.channeladvisor.com/v1/ProductBundleComponents

Important and/or Required Parameters

PropertyType (Max Length)RequiredNote
ProductIDinteger (32 bit)RequiredInclude in . The ChannelAdvisor defined unique ID (not the Sku value) of the bundle product.
See note above under "When to Use" about retrieving the Product ID.
ProfileIDinteger (32 bit)RequiredInclude in body. The ChannelAdvisor defined unique ID of the Profile this product exists in.
ComponentIDinteger (32 bit)RequiredInclude in URL. The ChannelAdvisor defined Product ID (not the Sku value) of the component item in this bundle.
See note above under "When to Use" about retrieving the Component ID.
ComponentSkustring (50)OptionalInclude in body. The Seller defined Sku value of the component item in this bundle.
Quantityinteger (32 bit)RequiredInclude in body. Quantity of this component that is purchased with the bundle.
Example Request
POST https://api.channeladvisor.com/v1/ProductBundleComponents?access_token=xxxxxxxxxx
{
    "ProfileID": 12345678,
    "ProductID": 25399103,
    "ComponentID": 25485220,
    "ComponentSku": "SKU0000004",
    "Quantity": 4
}
Example Response (Success)
201 Created
{
  "@odata.context": "https://api.channeladvisor.com/v1/$metadata#ProductBundleComponents/$entity",
  "ProductID": 25399103,
  "ComponentID": 25485220,
  "ProfileID": 12015201,
  "ComponentSku": "This is a Test SKU",
  "Quantity": 4
}