Skip to Content

Set your naming template

Needs the scope settings:write

Set 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.

  • Override it per job with the job's naming.
  • File names use letters A to Z, digits, '-', '_' and '.', up to 200 characters; accented letters are converted.
  • The same output always gets the same name, so an updated image replaces the earlier file.

Request Body

application/json
  1. body

How files are named.

preset*string

standard: {articleId}{type}{view}_{n}.{ext}, and {articleId}.{ext} for 3D files. gs1: the GS1 Product Image Standard release 5.0, from the product's GTIN (a second image with the same codes gets _s02, scenes and spins are always numbered); the images of a product without a GTIN are named as standard, and a job with gs1 names for it is refused. amazon: {articleId}.MAIN for the main image and PT01, PT02 and so on for the rest; videos and 3D files as standard. custom: your own pattern.

Value in"standard""gs1""amazon""custom"
pattern?string

With preset custom: a pattern from the tokens {articleId}, {externalId}, {gtin}, {variant}, {type}, {view}, {n}, {n:2}, {width}, {height}, {date}, {attr:key} and {ext}.

Lengthlength <= 200

Response Body

OK

application/json
  1. response
preset*string

standard: {articleId}{type}{view}_{n}.{ext}, and {articleId}.{ext} for 3D files. gs1: the GS1 Product Image Standard release 5.0, from the product's GTIN (a second image with the same codes gets _s02, scenes and spins are always numbered); the images of a product without a GTIN are named as standard, and a job with gs1 names for it is refused. amazon: {articleId}.MAIN for the main image and PT01, PT02 and so on for the rest; videos and 3D files as standard. custom: your own pattern.

Value in"standard""gs1""amazon""custom"
pattern?string

With preset custom: a pattern from the tokens {articleId}, {externalId}, {gtin}, {variant}, {type}, {view}, {n}, {n:2}, {width}, {height}, {date}, {attr:key} and {ext}.

Lengthlength <= 200
example*string

What a front packshot of CH-1001 would be called.

Example Request
curl -sS -X PUT https://platform.charpstar.co/api/v1/naming \  -H "Authorization: Bearer $CHARPSTAR_API_KEY" \  -H "Content-Type: application/json" \  -d '{ "preset": "custom", "pattern": "{articleId}-{variant}-{n:2}.{ext}" }'
Example Response
{  "preset": "custom",  "pattern": "{articleId}-{variant}-{n:2}.{ext}",  "example": "CH-1001-BLUE-01.png"}