Name files your way
Choose how every image and file we make for you is named, and read or change your naming template.
Every image and file we make is named by your naming choice, given as fileName on images and job outputs. A job's pictures are saved under their name from the start and keep it; other images follow your choice as it is now.
| Preset | Pattern | Example |
|---|---|---|
standard | {articleId}_{type}_{view}_{n}.{ext} | CH-1001_packshot_front_1.png |
gs1 | GS1 Product Image Standard, release 5.0 | 09521234567806_A1C0.png |
amazon | {articleId}.MAIN.{ext}, then .PT01, .PT02 | CH-1001.MAIN.png |
custom | Your own pattern from the tokens | CH-1001-BLUE-01.png |
- Tokens:
{articleId},{externalId},{gtin}(14 digits),{variant},{type},{view},{n}and{n:2}(a number per article, type and view),{width},{height},{date}(YYYYMMDD),{attr:key}and{ext}. A pattern holds one of the first three, so two products never share a name. - GS1: the 14-digit GTIN, then the image type (
Aup to 2400 px,Cabove), the side facing the camera, the angle and the state. A second image with the same codes gets_s02, and packshots come first; scenes are typeR, spinsE1and 3D files3DR. The product needs itsgtin, and a job uses a white or transparent background, 900 to 4800 px and PNG or JPG, as GS1 requires. - Amazon: the main image is
MAIN, the restPT01onwards in the order they were first made. Videos and 3D files keep the standard names. - Accented letters are converted (é becomes e, ü becomes u); other characters become
-. Names are unique within a product, an image's whatever its file type: a name already taken gets-2,-3before the extension. - The same output keeps its name: a new render of a view takes over the number of the picture it replaces.
File names use letters A to Z, digits, -, _ and ., up to 200 characters. You can override your naming for a single job with the job's naming.
Read your naming
GET/api/v1/namingsettings:writeThe answer is how files are named for your account, with an example.
Set your naming
PUT/api/v1/namingsettings:writeThis sets the naming template for every file we produce for you: the standard pattern, the GS1 Product Image Standard, Amazon's MAIN and PT01 scheme, or your own pattern from the tokens. The reference page lists every field.