Skip to Content

Orders

List your orders and read one order with the status of each of its items.

An order is the batch of products that arrived together, through the API, an import, or your CharpstAR account. source tells you which: api, import or platform.

List your orders

GET/api/v1/ordersproducts:read

This returns your orders, newest first. Each order has its id, status, source, createdAt and counts, which is how many items are in each status. You can filter by status.

The status of an order is worked out from its 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;
  • otherwise received.

limit sets the items per page, from 1 to 100; the default is the same. While nextCursor is not null, call again with cursor set to it.

curl -sS "https://platform.charpstar.co/api/v1/orders?status=in_production" \
  -H "Authorization: Bearer $CHARPSTAR_API_KEY"

Read one order with its items

GET/api/v1/orders/{orderId}products:read

This returns one order with every item: article, status, delivery date and pending changes. The list does not carry the items; this call does.

curl -sS https://platform.charpstar.co/api/v1/orders/$ORDER_ID \
  -H "Authorization: Bearer $CHARPSTAR_API_KEY"

On this page