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.
application/json- body
How files are named.
preset*stringstandard: {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.
"standard""gs1""amazon""custom"pattern?stringWith preset custom: a pattern from the tokens {articleId}, {externalId}, {gtin}, {variant}, {type}, {view}, {n}, {n:2}, {width}, {height}, {date}, {attr:key} and {ext}.
length <= 200OK
application/json- response
preset*stringstandard: {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.
"standard""gs1""amazon""custom"pattern?stringWith preset custom: a pattern from the tokens {articleId}, {externalId}, {gtin}, {variant}, {type}, {view}, {n}, {n:2}, {width}, {height}, {date}, {attr:key} and {ext}.
length <= 200example*stringWhat a front packshot of CH-1001 would be called.
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}" }'{ "preset": "custom", "pattern": "{articleId}-{variant}-{n:2}.{ext}", "example": "CH-1001-BLUE-01.png"}Your naming template GET
How files are named for your account, with an example.
Subscribe to events POST
Subscribe your https URL to signed events. Up to 3 active subscriptions. The answer carries the signing secret once: store it next to your API key. Leave events out to receive every type, including ones added later.