Retrieve Specific Bundle Component


When to Use

  • To retrieve the Component information of a specific 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

GET https://api.channeladvisor.com/v1/Products(ProductID)/BundleComponents(ComponentID)

Important and/or Required Parameters

PropertyType (Max Length)RequiredNote
ProductIDinteger (32 bit)RequiredInclude in URL. The ChannelAdvisor defined unique ID (not the Sku value).
See note above under "When to Use" about retrieving the Product ID.
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.
Example Request
GET https://api.channeladvisor.com/v1/Products(25399103)/BundleComponents?access_token=xxxxxxxxxx
Example Response (Success)
200 OK
{
  "@odata.context": "https://api.channeladvisor.com/v1/$metadata#ProductBundleComponents/$entity",
  "ProductID": 25399103,
  "ComponentID": 25030239,
  "ProfileID": 12345678,
  "ComponentSku": "TestSKU0000004",
  "Quantity": 1
}