Skip to Content

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.

Path Parameters

article*string

Your article number.

Match^[A-Za-z0-9][A-Za-z0-9._\-]{0,63}$

Response Body

OK

application/json
  1. response
articleId*string
externalId*string|null
gtin*string|null
name*string
category*string|null
subcategory*string|null
dimensionsCm*|null
variants*array<>
referenceImages*array<>

The references we hold, as our copies.

source3dUrl*|null
productLink*|null
attributes*
releaseAt*|null
active*boolean
status*string

Where the product is. Build your logic on this value.

Value in"received""in_production""in_review""approved""delivered""cancelled"
statusDetail?string
orderId*|null
pendingChanges*array<>|null
deliveryDate*|null
createdAt*string
Formatdate-time
updatedAt*string
Formatdate-time
Example Request
curl -sS https://platform.charpstar.co/api/v1/products/CH-1001 \  -H "Authorization: Bearer $CHARPSTAR_API_KEY"
Example Response
{  "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"}