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>"

{
  "data": {
    "id": "string",
    "tenant_id": "string",
    "customer_name": "string",
    "customer_email": "string",
    "customer_phone": "string",
    "status": "draft",
    "currency_code": "string",
    "subtotal": 1.1,
    "tax_total": 1.1,
    "grand_total": 1.1,
    "source": "string",
    "sales_order_lines": [
      {
        "id": "string",
        "sales_order_id": "string",
        "line_no": 1,
        "inventory_item_id": "string",
        "description": "string",
        "quantity": 1.1,
        "unit_price": 1.1,
        "discount_pct": 1.1,
        "tax_pct": 1.1,
        "total": 1.1
      }
    ],
    "created_at": "2024-01-15T09:30:00Z",
    "updated_at": "2024-01-15T09:30:00Z"
  }
}

Authentication

AuthorizationBearer

API key prefixed with uk_live_

Path parameters

idstringRequiredformat: "uuid"

Response

Order found

dataobjectOptional

Errors

404

Not Found Error