Read one order with its items
Needs the scope products:read
One order with every item: article, status, delivery date and pending changes.
orderId*stringThe order id, from POST /api/v1/products or GET /api/v1/orders.
uuidOK
application/json- response
id*stringuuidstatus*stringWorked out from the items: delivered when every item is delivered or cancelled; in_review when any item waits for you; in_production when any item is being made; else received.
"received""in_production""in_review""delivered""cancelled"source*stringWhere the order was placed: through the API, in the CharpstAR account, or by an import.
"api""platform""import"createdAt*stringdate-timecounts*How many items are in each status.
items?array<>In GET /orders/{orderId} only.
curl -sS https://platform.charpstar.co/api/v1/orders/$ORDER_ID \ -H "Authorization: Bearer $CHARPSTAR_API_KEY"{ "id": "4d3c2b1a-0000-4000-8000-000000000011", "status": "in_production", "source": "api", "createdAt": "2026-10-20T09:31:00.000Z", "counts": { "received": 0, "in_production": 3, "in_review": 1, "approved": 0, "delivered": 2, "cancelled": 0 }, "items": [ { "articleId": "CH-1001", "status": "in_production", "deliveryDate": "2026-11-20", "pendingChanges": null }, { "articleId": "CH-1002", "status": "delivered", "deliveryDate": "2026-11-01", "pendingChanges": null } ]}List your orders GET
Your orders, newest first. An order is the batch of products that arrived together, through the API, an import, or your CharpstAR account.
Load many products from a file POST
Load many products from one file, for a first catalogue load or a full refresh. - The file is NDJSON (one product per line in the POST /api/v1/products format) or CSV with the same field names in the header row, up to 100,000 products, fetched from an https link. - The import runs in the background and applies the same rules as POST /api/v1/products. import.completed is sent when it has finished. - With dryRun the whole file is checked and nothing is written.