Skip to main content
Skip to main content

Images

Extended information on product and variant images.

Overview​

Include the URLs for your product images in the image_urls field. These images appear to potential buyers. Images are displayed to users in order equal to their position in the array. e.g. the first image URL in the array will be used as the first image of the product in search results and the product page.

image_urls is a plain array of URL strings:

JSON
{
  "image_urls": [
    "https://www.example.com/images/13411356.jpg",
    "https://www.example.com/images/13411357.jpg"
  ]
}

When to use​

Optional for each product and variant — validation will not reject a product for having no images. In practice, treat images as required: a product without at least one image shows poorly in search results and on the product page.

Format​

Follow these formatting guidelines to make sure that Axiom understands the data that you're submitting.

Fieldimage_urls
TypeURL (including http or https), ASCII characters only, and RFC 3986 compliant
LimitsNo length limit, but the value must be a well-formed URL
Supported file formatsJPEG (.jpg/.jpeg), WebP (.webp), PNG (.png), GIF (.gif), BMP (.bmp), and TIFF (.tif/.tiff). The image's file extension should correspond to its format.
Repeated fieldYes
Variant inheritsNo. A variant only shows the images sent with it

Note

The file format is not checked when you submit the URL — a URL pointing at an unsupported format is accepted and then fails to render. Check your extensions before uploading.

Guidelines​

Follow these guidelines to make sure that your image URL is formatted so that we can understand it.

Minimum requirements​

These are the requirements that you'll need to meet to show your product. If you don't follow these requirements, we could reject your product.

  • Use a URL that points to an image in a supported file format.
  • Start with http or https and comply with RFC 3986. For example: http://www.example.com/image1.jpg.
  • Replace any symbols or spaces with URL encoded entities. For example, if your URL contains an ampersand ( & ), then replace it with %26. If your URL contains a comma ( , ), then replace it with %2C.
  • Make sure that your URL can be crawled by Axiom. Make sure authentication is not required to view the image.

Best practices​

These best practices can help you go beyond the basic requirements to optimise your product data for performance.

  • Use a stable URL. The URL that you include shouldn't change unless your image moves or is replaced. For example, don't use URLs with timestamps or parts that could change every time you submit your product data.

Managing images through the API​

Images and resources are both stored as product URLs, distinguished by their type (image or document). Sending image_urls in the product payload replaces the images held against that product or variant. To manage them one at a time, use the URL endpoints in the API reference.

PreviousCodesNextResources