Supported image types

Understand the supported image types.

Defining a file

To define a file to import, the attribute file must start with file: and end with the file ID. For example:

• With JSON, "productImage1": "file:00fb210-12345678", Global Commerce imports file 00fb210-12345678 and place it into a default folder of product detail images for the given company.

Creating subfolders

To create a subfolder, add the file: prefix to the subfolder path and the fileID. For example:

• With JSON, "thumbnailImage2": "file:folderA/folderB/00fb210-12345678", Global Commerce creates the subfolders 'folderA' and 'folderB' in the product thumbnail image folder for the given company. File 00fb210-12345678 is imported into the folders.

• Subfolders can start with a / or not. For example, file:abc is the equivalent to file:/abc.

• More than one / will be treated the same as one. For example, file:////abc////def is equivalent to file:abc/def.

Error codes related to file types have the prefix 'attribute_external_file'. Refer to Admin API error codes for more details.

Image type attributes

• Product details images

• Product thumbnail images

• Custom attributes with image types

Global Commerce requires images to be of certain image types. The only supported image types are:

• JPG, JPEG, GIF, BMP, and WEBP.

  • The file extension must match the image type.

  • The file content must match the file extension.

The file name (excluding the file extension) and folder do not support special characters. The special characters are:

• ! \ < > / | ? * : ' " . ( ) & ^ ~ # % { } , @ + = ` ; [ ], as well as spaces, tab \t, breakline \r \n \f.

File type attributes

• The padFile of the software family

• Custom attributes with file types

• Cannot have subfolders at the product level

• Any file type is supported

• If the file type is .zip, Global Commerce checks all the files zipped within.

• File names do not support special characters. The special characters are:

  • | ; , ! @ $ ( ) < > " ' ` ~ { } [ ] = + & ^ % and spaces.