Skip to Content

List your products

Needs the scope products:read

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.

Query Parameters

status?string

Only products in this status.

Value in"received""in_production""in_review""approved""delivered""cancelled"
has3d?boolean

true: only products with a delivered model; false: only products without one.

since?string

Only products that changed after this time (ISO 8601, with a zone): any field, a cancel or a delivery. The list is then oldest change first, like GET /api/v1/assets?since=, and its cursor is that feed's.

Formatdate-time
category?string

Only products in this category.

limit?integer

Items per page, 1 to 100. Default 100.

Range1 <= value <= 100
cursor?string

The nextCursor of the previous page.

Response Body

OK

application/json
  1. response
products*array<>
nextCursor*|

Pass it as cursor for the next page. null when there is no more.

Example Request
curl -sS "https://platform.charpstar.co/api/v1/products?status=received&limit=50" \  -H "Authorization: Bearer $CHARPSTAR_API_KEY"
Example Response
{  "products": [    {      "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"    }  ],  "nextCursor": null}