Products – Product Previews

This API request allows you to submit an image (or images) that can be used by our system to render it into a product preview.

Asynchronous Previews

Preview generation is asynchronous by default. That means that the result you receive will contain a link to an image that will eventually exist at that URL. Given the amount of previews in our queue, the preview can take anywhere from 100 milliseconds to a few minutes.

Simple Preview API

Our ProductPreviewRequest endpoint takes a single argument which includes a JSON body that needs to contain the following parameters:

  • SKU - the SKU for the product
  • Images - an array of objects, each containing the following:
    • Image object with the following properties:
      • Url - the url of image
  • MaxWidth - optional - max width of the resultant image. Defaults to 500px and the max is 2000px. The value should only include the number and does not require "px".
  • MaxHeight - optional - max height of the resultant image. Defaults to 500px and the max is 2000px. The value should only include the number and does not require "px".

This response for this request will display the following:

{
   "Images": [
       {
           "Url": "https://s3.amazonaws.com/gooten-imgmanip/live/preview/f255af6f-9614-4fe2-aa8b-1b77b936d9d6/e6053790d55f3509d86126819e0355d3.png",
           "SpaceId": "4B120"
       }
   ],
   "HadError": false
}

Pro Preview API

The Pro Preview API features our algorithm used creating the most realistic product previews. If you're interested in using our Pro Preview API, please contact our team or use our Pro Product API document for any additional help.