This feature is in beta, which means that we are working to improve it. If you have any questions, please contact our Support.
In VTEX Admin, you can manage the import and export of image information using a spreadsheet, as detailed in the following sections:
- Importing product and SKU images using a spreadsheet
- Exporting product and SKU images using a spreadsheet
- Product and SKU image spreadsheet fields
Importing product and SKU images using a spreadsheet
To import product and SKU images using a spreadsheet, follow these steps:
- In the VTEX Admin, go to Catalog > Product and SKUs, or type Product and SKUs in the search bar at the top of the page.
- At the top of the page, click
Import. - Click
Images. - In the window that opens, click Download template to get the file.
- Complete the spreadsheet details as described in the section Product and SKU image spreadsheet fields.
- Add the spreadsheet with an
.xlsor.xlsxextension. You can drag and drop the file onto the designated area, or click the window to select the file locally. - Click
Import.
While the import is in progress, a message will be displayed indicating that the file is being processed. Leaving the page won't interrupt the operation. After the operation is complete, you will receive a confirmation email.
Products with images successfully imported are automatically queued for indexing. If this doesn't happen, see the article Why is the product not visible on the website?.
Exporting product and SKU images using a spreadsheet
To export a .xlsx file with the images from your catalog, follow these steps:
The exported information corresponds to the fields detailed in the section Product and SKU image spreadsheet fields.
- In the VTEX Admin, go to Catalog > Product and SKUs, or type Product and SKUs in the search bar at the top of the page.
- (Optional) If you want to export the images of certain products and SKUs, search or a filter the desired items. This step isn't required when exporting the images of all the items in your catalog.
- At the top of the page, click
Export. - Click
Images.
While the export is in progress, a message will be displayed indicating that the file is being processed. Leaving the page won't interrupt the operation. You can track the export progress in the window displayed on the page.
After the export of product and SKU images is completed, you will receive an email with a link to download the file. The download link is valid for 24 hours. After that, the link expires. You can also download the file from the window that opens on the page.
Product and SKU image spreadsheet fields
The following table describes and includes an example of each field in the import spreadsheet for images in your catalog. Required fields are marked with an asterisk (*).
To import a new image, the only required fields are SKU ID and Image import URL. Learn more in Best practices for using images in the Catalog.
| Field | Description | Example |
|---|---|---|
| Product ID | Unique numeric code identifying the product. | 310117603 |
| Product name | Product name shown to customers during the browsing experience. | Cotton t-shirt |
| SKU ID* | Unique numeric code that identifies the SKU. | 310119261 |
| SKU name | SKU name that identifies the product variation. | M |
| SKU reference code | Unique SKU reference code, for internal store use only. Use a unique combination of letters and/or numbers. | summer26shirt |
| Image ID | Numeric code that identifies the SKU image. To import a new image, leave the field blank; keep the value to update an existing image. | 167002 |
| Image name | Image name, for internal store use only. This field doesn't allow special characters, diacritical marks, or spaces. | side_blue_tshirt |
| Image position | Number indicating the display position of the image on the website, where 0 corresponds to the first position, 1 to the second, and so on. | 0 |
| Image label | Image label name, for internal merchant use to reference values common to images. | Side view |
| Image text | Text that will be associated with the image, for internal store use. Don't use special characters or diacritical marks, and don't repeat values from the Image name and Image label fields. | side summer26 tshirt |
| Image path | Name that is part of the image URL hosted on the VTEX platform. It displays after the last slash /, including the file extension. If the field isn't completed, leave it blank. | blue_tshirt_round_collar.jpg |
| Image import URL | Image that will be associated with the SKU. To import a new image, this field must be completed with the URL of the hosted file. It must start with the HTTP protocol identifier (http://) and end with one of the following extensions:
| http://files.com/ids/image/blue_tshirt_round_collar.jpg |