Orders

The Orders endpoints let you list and retrieve orders within your organization through the Admin API.

For customer-scoped order history (returns orders for a single authenticated customer), see the Client API Orders endpoint.

Endpoints

Method	Endpoint	Description
`GET`	`/orders`	List orders with filtering and pagination
`GET`	`/orders/{orderId}`	Get a single order by document ID or order number

Authentication

All requests require a valid Admin API key:

Authorization: Bearer your_api_key_here

List Orders

GET /orders

Query Parameters

Parameter	Type	Required	Description
`limit`	integer	No	Page size (1 to 100, default 50)
`cursor`	string	No	Pagination cursor from a previous response
`search`	string	No	Full-text search across order number and customer name/email
`status`	string	No	Comma-separated list of statuses: `draft`, `pending`, `processing`, `completed`, `cancelled`, `refunded`, `open_tab`, `lost_cart`
`dateFrom`	string	No	ISO date string for the start of a date range
`dateTo`	string	No	ISO date string for the end of a date range
`amountMin`	number	No	Minimum order total
`amountMax`	number	No	Maximum order total

Example Request

curl "https://api.tiquo.app/api/v1/orders?status=completed&limit=25" \
  -H "Authorization: Bearer your_api_key_here"

Response

{
  "success": true,
  "data": [
    {
      "id": "k1234567890abcdef",
      "orderNumber": "ORD-J98UBC",
      "status": "completed",
      "paymentStatus": "paid",
      "source": "pos",
      "channel": "in_person",
      "total": 84.50,
      "subtotal": 70.00,
      "tax": 14.00,
      "discount": 0,
      "tipAmount": 0.50,
      "currency": "GBP",
      "itemCount": 3,
      "customerName": "John Doe",
      "customerEmail": "john@example.com",
      "customerId": "k1234567890abcdef",
      "sublocationName": "Main Bar",
      "refundAmount": 0,
      "createdAt": 1640995200000,
      "updatedAt": 1640995200000
    }
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "abc123...",
    "pageSize": 25
  },
  "timestamp": "2025-01-15T10:30:00.000Z"
}

Get Order

GET /orders/{orderId}

Path Parameters

Parameter	Type	Required	Description
`orderId`	string	Yes	A document ID or order number (e.g. `ORD-J98UBC`)

Example Request

curl "https://api.tiquo.app/api/v1/orders/ORD-J98UBC" \
  -H "Authorization: Bearer your_api_key_here"

Response

{
  "success": true,
  "data": {
    "id": "k1234567890abcdef",
    "orderNumber": "ORD-J98UBC",
    "status": "completed",
    "paymentStatus": "paid",
    "paymentMethod": "card",
    "source": "pos",
    "channel": "in_person",
    "subtotal": 70.00,
    "tax": 14.00,
    "discount": 0,
    "shipping": 0,
    "total": 84.50,
    "tipAmount": 0.50,
    "currency": "GBP",
    "items": [
      {
        "id": "item_1",
        "type": "product",
        "name": "Espresso",
        "quantity": 2,
        "unitPrice": 3.50,
        "subtotal": 7.00,
        "tax": 1.40,
        "discount": 0,
        "total": 8.40,
        "sku": "SKU-001",
        "productId": "k1234567890abcdef",
        "bookingId": null,
        "productStatus": "fulfilled",
        "bookingStatus": null,
        "specialInstructions": null,
        "orderStageName": "Served"
      }
    ],
    "customerId": "k1234567890abcdef",
    "customerName": "John Doe",
    "customerEmail": "john@example.com",
    "sublocationName": "Main Bar",
    "discountCodes": [],
    "customerNotes": null,
    "refundAmount": 0,
    "refundReason": null,
    "isLegacy": false,
    "creationMethod": "pos",
    "createdAt": 1640995200000,
    "updatedAt": 1640995200000,
    "completedAt": 1640995300000,
    "cancelledAt": null
  },
  "timestamp": "2025-01-15T10:30:00.000Z"
}

Order Status Values

Status	Description
`draft`	Created but not yet finalised. Does not count toward reporting.
`pending`	Submitted, awaiting processing.
`processing`	Currently being processed.
`completed`	Fully paid and fulfilled.
`cancelled`	Cancelled before completion.
`refunded`	Refunded after payment was taken.
`open_tab`	Items can still be added; payment taken later.
`lost_cart`	Customer started but did not complete checkout.

Error Responses

404 Not Found

{
  "success": false,
  "error": "Order not found with identifier: ORD-INVALID",
  "timestamp": "2025-01-15T10:30:00.000Z"
}

401 Unauthorized

{
  "success": false,
  "error": "Missing or invalid API key",
  "timestamp": "2025-01-15T10:30:00.000Z"
}

Orders

Sur cette page