Add Labels


When to Use

  • How to add a label to an existing product.
  • Requires the Product ID (not the Sku - the ChannelAdvisor unique ID representing the product).
    • Place a GET Products request and $filter=Sku eq 'PRODUCT SKU VALUE'&$select=ID to return the ID to use in this request.
  • Adding labels to a product during product creation is not possible at this time.
  • Encode any characters that may be interpreted as operators in the URI.

Resource URL / Endpoint

PATCH or PUT https://api.channeladvisor.com/v1/Products(ProductID)/Labels('Name')

($batch request format) PATCH or PUT https://api.channeladvisor.com/v1/ProductLabels(ProductID=ProductID, Name='Name')

Required Parameters

PropertyType (Max Length)RequiredNote
ProductIDinteger (32 bit)RequiredInclude in URL. The ChannelAdvisor defined unique ID (not the Sku value) of the product.
See note above under "When to Use" about retrieving the Product ID.
Namestring (32)RequiredInclude in the URL. The name of the attribute.
Example Request
PATCH or PUT https://api.channeladvisor.com/v1/Products(12345678)/Labels('Amazon Seller Central - US')?access_token=xxxxxxxxxx
Example Response (Success)
204 No Content