Product images are associated with SKUs.

To learn more, see this article about Best practices with catalog images. It may also be helpful to compress the images you use in your store.

Field	Description	Required	Type	Default
Id	ID of SkuImage (SkuFileId). This is the ID that is used to delete/update it.	No	Integer	AutoIncrement
ArchiveId	Unique identifier of the Image file.	No	Integer	-
SkuId	ID of SKU	Yes	Integer	null
Name	Name of SKU’s file	No*	String	null
IsMain	Set the image as the main image for the product.	No	Boolean (true/false)	null
Label	Image label	No	String	false
Url	External image URL	Yes	String	-

To register an image to an SKU, it must be hosted on an external server and with read permission. Then you may use the Create SKU file API endpoint.

Example request

Body:

Response:

To change an existing SKU image that already existed, you can use the Update SKU file endpoint.

In order to update a SKU file the image needs to be uploaded again.

Example request

Body:

Response:

To remove an SKU image use the Delete SKU image by file ID API request. You will need the SkuFileId.

To delete all images of one specific SKU, use the Delete all SKU file API endpoint.