Sign in

v1

latestSwagger 2.02026-07-17148179252.3 KB
Catalog

Creates an image on a product. Publicly accessible URLs and files (form post) are valid parameters.

post/catalog/products/{product_id}/images

Request body

is_thumbnailboolean

Flag for identifying whether the image is used as the product's thumbnail.

sort_orderinteger

The order in which the image will be displayed on the product page. Higher integers give the image a lower priority. When updating, if the image is given a lower priority, all images with a sort_order the same as or greater than the image's new sort_order value will have their sort_orders reordered.

descriptionstring

The description for the image.

image_urlstring

Must be a fully qualified URL path, including protocol.

image_filestring

Must be sent as a multipart/form-data field in the request body.

Response

A product image.

metaMeta

Empty meta object; may be used later.