Skip to Content

Read one order with its items

Needs the scope products:read

One order with every item: article, status, delivery date and pending changes.

Path Parameters

orderId*string

The order id, from POST /api/v1/products or GET /api/v1/orders.

Formatuuid

Response Body

OK

application/json
  1. response
id*string
Formatuuid
status*string

Worked 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.

Value in"received""in_production""in_review""delivered""cancelled"
source*string

Where the order was placed: through the API, in the CharpstAR account, or by an import.

Value in"api""platform""import"
createdAt*string
Formatdate-time
counts*

How many items are in each status.

items?array<>

In GET /orders/{orderId} only.

Example Request
curl -sS https://platform.charpstar.co/api/v1/orders/$ORDER_ID \  -H "Authorization: Bearer $CHARPSTAR_API_KEY"
Example Response
{  "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    }  ]}