List sales orders with line items

GET

/orders

GET

/functions/v1/platform-api/orders

$ curl https://krjtnboxzkrhejhqtwgm.supabase.co/functions/v1/platform-api/orders \
>      -H "Authorization: Bearer <token>"

200Retrieved

1 {
2   "data": [
3     {
4       "id": "string",
5       "tenant_id": "string",
6       "customer_name": "string",
7       "customer_email": "string",
8       "customer_phone": "string",
9       "status": "draft",
10       "currency_code": "string",
11       "subtotal": 1.1,
12       "tax_total": 1.1,
13       "grand_total": 1.1,
14       "source": "string",
15       "sales_order_lines": [
16         {
17           "id": "string",
18           "sales_order_id": "string",
19           "line_no": 1,
20           "inventory_item_id": "string",
21           "description": "string",
22           "quantity": 1.1,
23           "unit_price": 1.1,
24           "discount_pct": 1.1,
25           "tax_pct": 1.1,
26           "total": 1.1
27         }
28       ],
29       "created_at": "2024-01-15T09:30:00Z",
30       "updated_at": "2024-01-15T09:30:00Z"
31     }
32   ],
33   "pagination": {
34     "next_cursor": "string",
35     "has_more": true
36   }
37 }

Authentication

AuthorizationBearer

API key prefixed with uk_live_

Query parameters

limitintegerOptional1-100Defaults to 25

cursorstringOptional

sortstringOptionalDefaults to created_at

orderenumOptionalDefaults to desc

Allowed values:

statusenumOptional

Allowed values:

Response

Paginated order list

datalist of objectsOptional

paginationobjectOptional