Get an order by ID (includes line items)

GET

/orders/:id

GET

/functions/v1/platform-api/orders/:id

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

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

Authentication

AuthorizationBearer

API key prefixed with uk_live_

Path parameters

idstringRequiredformat: "uuid"

Response

Order found

dataobjectOptional

Errors

404

Not Found Error