Retrieve Images


When to Use

  • To retrieve images for all products in all profiles the access token is authorized.
  • Optional: to retrieve products (or a specific product), and $expand the Images collection.
  • Conditionally 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.

Resource URL / Endpoint

GET https://api.channeladvisor.com/v1/Images
GET https://api.channeladvisor.com/v1/Products(ProductID)/Images
GET https://api.channeladvisor.com/v1/Products(ProductID)/Images('PlacementName')

Important and/or Required Parameters

PropertyType (Max Length)RequiredNote
ProductIDinteger (32 bit)ConditionalRequired when retrieving specific product images.
Include 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.
PlacementNamestring (50)ConditionalRequired when retrieving specific placement name for a specific product.
Include in URL. Name that corresponds with placement of the image.
Example Request
GET https://api.channeladvisor.com/v1/Images
Example Response (Success)
200 OK
  "@odata.context": "https://api.channeladvisor.com/v1/$metadata#Images",
  "value": [
    {
      "ProductID": 22120969,
      "ProfileID": 12345678,
      "PlacementName": "14",
      "Abbreviation": "14",
      "Url": "http://d3d71ba2asa5oz.cloudfront.net/12015201/images/sample%20application.jpg"
    },
    {
      "ProductID": 22120969,
      "ProfileID": 12345678,
      "PlacementName": "18",
      "Abbreviation": "18",
      "Url": "http://d3d71ba2asa5oz.cloudfront.net/12015201/images/sample%20application.jpg"
    },
    {
      "ProductID": 22120969,
      "ProfileID": 12345678,
      "PlacementName": "ITEMIMAGEURL1",
      "Abbreviation": "1",
      "Url": "http://d3d71ba2asa5oz.cloudfront.net/12015201/images/sample%20application.jpg"
    },
    {
      "ProductID": 25021184,
      "ProfileID": 12345678,
      "PlacementName": "ITEMIMAGEURL1",
      "Abbreviation": "1",
      "Url": "http://images.channeladvisor.com/Sell/images/MerchantDefaults/sony_IP7.jpg"
    },
    {
      "ProductID": 25021552,
      "ProfileID": 12345678,
      "PlacementName": "ITEMIMAGEURL1",
      "Abbreviation": "1",
      "Url": "http://images.channeladvisor.com/Sell/images/MerchantDefaults/sony_IP7.jpg"
    },
    {
      "ProductID": 25021556,
      "ProfileID": 12345678,
      "PlacementName": "ITEMIMAGEURL1",
      "Abbreviation": "1",
      "Url": "http://images.channeladvisor.com/Sell/images/MerchantDefaults/sony_IP7.jpg"
    },
    {
      "ProductID": 22120969,
      "ProfileID": 12345678,
      "PlacementName": "ITEMIMAGEURL14",
      "Abbreviation": "ITEMIMAGEURL14",
      "Url": "http://d3d71ba2asa5oz.cloudfront.net/12015201/images/sample%20application.jpg"
    },
    {
      "ProductID": 22120969,
      "ProfileID": 12345678,
      "PlacementName": "ITEMIMAGEURL2",
      "Abbreviation": "2",
      "Url": "http://d3d71ba2asa5oz.cloudfront.net/12015201/images/sample%20application.jpg"
    }
  ]
}