GET
/api/public/v1/orders/{orderId}

Get an order

Retrieve a single order with its items and (if linked) customer profile.

Required scope

The access token must carry this scope. A token missing it gets 403 Forbidden. Grant them to an API client under Dev Tools → API, to an assistant or CLI sign-in when you approve or edit it under Dev Tools, and to a teammate under Employee → Permissions.

orders:read

Path Parameters

NameTypeRequiredDescription
orderIdstringRequiredOrder ID.
GETExample request
curl
curl -X GET "https://www.pxb.app/api/public/v1/orders/{orderId}" \
  -H "Authorization: Bearer your_access_token"
200Example response
json
{
  "message": "Order retrieved successfully!",
  "content": {
    "order": {
      "id": "ord_1",
      "status": "PAID",
      "totalAmount": 12000
    }
  }
}

In the console

The same thing done by hand, for anyone comparing the API against the screen they already use.

Orders → Storefront
/orders/storefront
  1. Open an order from the table.