Skip to Content

Render packshots for new articles

List your render presets, start a packshot job for each delivered article and find the pictures on the product.

You end up with packshots made for every article that has just been delivered, named the way your systems expect. A job works on a delivered model: a product without one answers 409 not_ready.

List your presets

GET/api/v1/presetsjobs:read

A preset is a set of camera, lighting, background, size and format that our team saved for you. Name one in a packshot job's options.preset.

curl -sS "https://platform.charpstar.co/api/v1/presets?type=packshot" \
  -H "Authorization: Bearer $CHARPSTAR_API_KEY"

Start a job for each delivered article

POST/api/v1/jobsjobs:write

A packshot job for one article:

curl -sS -X POST https://platform.charpstar.co/api/v1/jobs \
  -H "Authorization: Bearer $CHARPSTAR_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: po-88213-ch-1001" \
  -d '{ "type": "packshot", "articleId": "CH-1001", "options": { "views": ["front", "left", "back"], "background": "transparent", "size": 4096 }, "naming": { "preset": "gs1" }, "metadata": { "purchaseOrder": "PO-88213" } }'

The answer is 202 with the job, "status": "queued". To start jobs for several articles in one call, send up to 50 as { "jobs": [...] }. Here articles is your list of delivered article numbers:

const res = await fetch(`https://platform.charpstar.co/api/v1/jobs`, {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.CHARPSTAR_API_KEY}`, "Content-Type": "application/json", "Idempotency-Key": "po-88213" },
  body: JSON.stringify({ jobs: articles.map((articleId) => ({ type: "packshot", articleId, options: { views: ["front", "back"] } })) }),
});
const { results } = await res.json(); // each with httpStatus: 202 started, or its refusal

A batch answers a results array, like a batch of products. Each entry has httpStatus 202 when the job started, or its refusal, for example 409 not_ready for an article without a delivered model.

Every image we make is named by your naming choice. Name files your way shows the presets. With gs1, a job needs the product's GTIN, so send gtin with the product first.

Follow the job

GET/api/v1/jobs/{jobId}jobs:read

The status is queued, running, succeeded, failed or cancelled. Once it has succeeded, outputs lists each picture with its fileName and url.

curl -sS https://platform.charpstar.co/api/v1/jobs/5c0e2f9a-7b14-4d3e-a8c1-93f6e2b7d045 \
  -H "Authorization: Bearer $CHARPSTAR_API_KEY"

Instead of asking, you can wait for the job.succeeded event. It carries the job with its outputs. See Listen for status changes.

Find the pictures on the product

The pictures are added to the product. They appear in images with the job's id in jobId, and asset.images.updated is sent. Read the article again to get them:

GET/api/v1/assets/{article}assets:read
{
  "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
  "type": "asset.images.updated",
  "occurredAt": "2026-10-20T09:31:00.000Z",
  "client": {
    "id": "e2b7c1d4-5a6f-4b8c-9d0e-1f2a3b4c5d6e",
    "name": "Your Company"
  },
  "article": "CH-1001",
  "data": {
    "added": [
      "8d2f4c1a-packshot"
    ],
    "removed": []
  }
}

added and removed hold image ids from the article's images.

On this page