Read one product
Needs the scope products:read
The product as we hold it: your fields, its status, the order it belongs to, and any change waiting for our production team.
article*stringYour article number.
^[A-Za-z0-9][A-Za-z0-9._\-]{0,63}$OK
application/json- response
articleId*stringexternalId*string|nullgtin*string|nullname*stringcategory*string|nullsubcategory*string|nulldimensionsCm*|nullvariants*array<>referenceImages*array<>The references we hold, as our copies.
source3dUrl*|nullproductLink*|nullattributes*releaseAt*|nullactive*booleanstatus*stringWhere the product is. Build your logic on this value.
"received""in_production""in_review""approved""delivered""cancelled"statusDetail?stringorderId*|nullpendingChanges*array<>|nulldeliveryDate*|nullcreatedAt*stringdate-timeupdatedAt*stringdate-timecurl -sS https://platform.charpstar.co/api/v1/products/CH-1001 \ -H "Authorization: Bearer $CHARPSTAR_API_KEY"{ "articleId": "CH-1001", "externalId": "100045", "gtin": "09521234567806", "name": "Oslo lounge chair", "category": "Furniture", "subcategory": "Chairs", "dimensionsCm": { "w": 72, "h": 81, "d": 78 }, "variants": [ { "code": "BLUE", "articleId": "CH-1001-BL", "colour": "Blue", "material": null, "name": null } ], "referenceImages": [ { "url": "https://cdn.charpstar.net/YourCompany/Reference/CH-1001-3f9a2c1b.jpg" } ], "source3dUrl": null, "productLink": "https://example.com/products/oslo-lounge-chair", "attributes": { "collection": "Oslo", "season": "AW26" }, "releaseAt": null, "active": true, "status": "in_production", "orderId": "4d3c2b1a-0000-4000-8000-000000000011", "pendingChanges": null, "deliveryDate": "2026-11-20", "createdAt": "2026-10-20T09:31:00.000Z", "updatedAt": "2026-10-21T14:02:00.000Z"}List your products GET
Your products as we hold them, newest first, with their status and order: the products you sent or ordered, and the models we delivered to you by other ways. Filter by status, by whether a model exists, or by changes since a time.
Change some fields of a product PATCH
Change only the fields you send. null clears a field you own. The same ownership rules apply as for POST /api/v1/products: a change to dimensionsCm or source3dUrl after modelling has started becomes a change request.