Delete Labels


When to Use

  • If a label needs to be removed from a product, this is how to execute the request.
  • 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.
  • Cannot update or remove labels during product updates.
  • Encode any characters that may be interpreted as operators in the URI.

Resource URL / Endpoint

DELETE https://api.channeladvisor.com/v1/Products(ProductID)/Labels('Name')

($batch request format) DELETE 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
DELETE https://api.channeladvisor.com/v1/Products(12345678)/Labels('Rakuten UK')?access_token=xxxxxxxxxx
Example Response (Success)
204 No Content