The Catalog Images app provides REST and GraphQL APIs for users to save or delete catalog images on File Manager without overriding images with the same name.

This app is available only to sellers who were invited through the Seller Portal and have the Seller Portal Edition app enabled by default.

If your store operates under a standard VTEX account, you can upload images via the Admin, spreadsheet, or the Catalog APIs.

Using VTEX IO CLI, log in to your account and run the following command to install the Catalog Images app:

First, you must have an appKey and appToken to use as authentication headers in this application’s requests. See Authentication for more information on how to obtain these credentials.

Using your appKey and appToken, make the following API request to obtain a local token, which is required by the app. Replace {{accountName}} with your VTEX account name and {{my_appkey}} and {{my_apptoken}} with their respective values.

Request local token:

Response:

The local_token value you will receive as a response is required for authentication in the app's API calls, explained in the following sections.

Once the app is installed and the local token is created, you can use the Catalog Images app's resources through REST API or GraphQL API.

There are two REST API endpoints available to manage images using the Catalog Images app:

• POST Save image
• DELETE Delete image

To save an image in File Manager, use the request below. Make sure to send one image at a time and set the request body format to multipart/form-data.

Make sure to replace the following values in your request:

Property	Location	Type	Description	Example
accountName	Path	String	Name of the VTEX account.	mystore
workspace	Path	String	Name of the workspace where you want to upload the image. You can only upload images in the master workspace.	master
fileName	Path	String	Name and extension of the image file.	product.png
token	Header	-	Local token required for authentication.	-
filePath	Request body	String	Full path of the file.	/C:/Images/product.png

If an image with the same fileName already exists, the response will be a Conflict (409), and the response body will include the URL of the conflicting image.

Otherwise, the response will be OK (200) with the id, slug, and fullUrl in the response body, as follows:

Response body example (200 OK):

The following REST API route allows you to delete a Catalog image in File Manager:

Replace the values as explained below:

Property	Location	Type	Description	Example
accountName	Path	String	Name of the VTEX account.	mystore
workspace	Path	String	Name of the workspace where you want to delete the image. You can only delete images in the master workspace.	master
fileName	Path	String	Name and extension of the image file.	product.png
token	Header	-	Local token required for authentication.	-
filePath	Request body	String	Full path of the file.	/C:/Images/product.png

If an image with the same fileName is already given, the response will be Conflict (409), with the conflicted image URL in the response body.

If the image exists and is successfully deleted, the response will be an empty body with the status code OK (200). If the image doesn’t exist, the response will be Not Found (404).

The following mutations are available for Catalog images using the app’s GraphQL API:

• saveImage
• deleteImage

Use the following mutation to save an image on File Manager using GraphQL:

Mutation:

Response body example (200 OK):

If an image with the same name is already added to File Manager, the response will contain an array of errors, including CONFLICT_FILE_ERROR.

Response body example (409 Conflict):

Use the following mutation to delete an image on File Manager using GraphQL:

Mutation:

Response body example (200 OK):

If the image doesn’t exist, the statusCode value in the response will be NotFound.