Retrieve Component ID of Known SKU in a Specific Bundle


When to Use

  • To retrieve the Component ID of a product when only the Sku value of the component, and the Product ID of the Bundle SKU are known.
  • Useful for retrieving a Component ID on a product to turn around and update the quantity on, or delete, the Component.
  • 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.

Resource URL / Endpoint

GET https://api.channeladvisor.com/v1/ProductBundleComponents?$filter=ProductID eq ProductID and ComponentSku eq 'SKU VALUE'&$select=ComponentID 

Important and/or Required Parameters

PropertyType (Max Length)RequiredNote
$filter=n/aRequiredInclude in URL. Defines the action to filter on a property.
ProductID eq ProductIDn/aRequiredInclude in URL. Defines the property being filtered must equal the property value entered.
The ChannelAdvisor defined unique ID (not the Sku value) to be filtered by.
See note above under "When to Use" about retrieving the Product ID. 
andn/aRequiredInclude in URL. The operator to require a second filtering/evaluation.
ComponentSku eq 'SKU VALUE'n/aRequiredInclude in URL. Defines the next property to be filtered by must equal the value defined.
The Sku value to filter by. Retain single quotes as this field value is stored as a string.
$select=n/aRequiredInclude in URL. Defines action to limit the response to properties selected.
ComponentIDn/aRequired

Include in URL. Defines the value to be returned in the response.

Example Request
GET https://api.channeladvisor.com/v1/ProductBundleComponents?access_token=xxxxxxxxxx&$filter=ProductID eq 25399103 and ComponentSku eq 'Netgear2550-MNOP78'&$select=ComponentID
Example Response (Success)
200 OK
{
  "@odata.context": "https://api.channeladvisor.com/v1/$metadata#ProductBundleComponents(ComponentID)",
  "value": [
    {
      "ComponentID": 25030556
    }
  ]
}