Orders

The Orders endpoints let you create and manage orders within your organization through the Admin API.

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

Endpoints

Method	Endpoint	Description
`GET`	`/orders`	List orders with filtering and pagination
`POST`	`/orders`	Create an order
`GET`	`/orders/{orderId}`	Get a single order by document ID or order number
`PATCH`	`/orders/{orderId}`	Update an order
`DELETE`	`/orders/{orderId}`	Delete an order

Authentication

All requests require a valid Admin API key:

Authorization: Bearer your_api_key_here

Test the API

Enter your Admin API key and any required values, then select Send. Requests are sent directly from your browser to the live Admin API.

The POST, PATCH, and DELETE testers change live organization data. Your API key is stored only in this browser's local storage, so use the tester on a trusted device.

Authorization

BearerAuth

AuthorizationBearer <token>

API key from the Tiquo dashboard (Settings > Developer > Admin API)

In: header

Query Parameters

limit?integer

Default50

Range1 <= value <= 100

cursor?string

search?string

Search by order number, customer name/email

status?string

Comma-separated: draft,pending,processing,completed,cancelled,refunded,open_tab

paymentStatus?string

Comma-separated payment statuses

source?string

channel?string

currency?string

sublocationId?string

customerId?string

customerEmail?string

Formatemail

dateFrom?string

Filter by order createdAt, inclusive

Formatdate

dateTo?string

Formatdate

source?string

serviceId?string

sublocationId?string

customerId?string

attendeeCountMin?integer

Range0 <= value

attendeeCountMax?integer

Filter by order createdAt, inclusive

Range0 <= value

updatedAfter?string

Return orders whose updatedAt is strictly after this instant. Results are ordered by updatedAt ascending so integrations can follow all pagination cursors and then advance their update watermark. Cannot be combined with search.

Formatdate-time

amountMin?number

amountMax?number

Response Body

`application/json`

curl -X GET "https://api.tiquo.app/api/v1/orders"

{
  "success": true,
  "data": [
    {
      "id": "string",
      "orderNumber": "string",
      "status": "draft",
      "paymentStatus": "pending",
      "source": "string",
      "channel": "string",
      "total": 0,
      "subtotal": 0,
      "tax": 0,
      "discount": 0,
      "discountName": "string",
      "serviceChargeAmount": 0,
      "serviceChargePercentage": 0,
      "serviceChargeRemoved": true,
      "payments": [
        {
          "id": "string",
          "method": "string",
          "provider": "stripe",
          "amount": 0,
          "currency": "GBP",
          "paymentIntentId": "string",
          "chargeId": "string",
          "cardBrand": "visa",
          "cardLast4": "4242",
          "walletType": "apple_pay",
          "paidAt": 0
        }
      ],
      "storeCredit": {
        "amount": 0,
        "currency": "string"
      },
      "tipAmount": 0,
      "currency": "string",
      "itemCount": 0,
      "customerId": "string",
      "customerName": "string",
      "customerEmail": "string",
      "staffId": "string",
      "staffName": "string",
      "locationId": "string",
      "locationName": "string",
      "sublocationId": "string",
      "sublocationName": "string",
      "covers": 0,
      "tableNumber": "string",
      "tableName": "string",
      "tables": [
        {
          "id": "string",
          "number": "string",
          "name": "string"
        }
      ],
      "refundAmount": 0,
      "createdAt": 0,
      "updatedAt": 0
    }
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "string",
    "pageSize": 0
  },
  "timestamp": "2019-08-24T14:15:22Z"
}

{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}

{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}

Authorization

BearerAuth

AuthorizationBearer <token>

API key from the Tiquo dashboard (Settings > Developer > Admin API)

In: header

Request Body

application/json

sublocationId*string

customerId?string

companyId?string

parentBookingId?string

enquiryId?string

source?string

Default"admin"

Value in"pos" | "online" | "admin"

channel?string

Default"zapier"

orderType?string

Value in"eat_in" | "take_away"

status?string

Default"draft"

notes?string

idempotencyKey?string

items*array<>

Items1 <= items

Response Body

`application/json`

curl -X POST "https://api.tiquo.app/api/v1/orders" \  -H "Content-Type: application/json" \  -d '{    "sublocationId": "string",    "items": [      {        "name": "string",        "quantity": 0,        "unitPrice": 0      }    ]  }'

{
  "success": true,
  "data": {
    "id": "string",
    "orderNumber": "string",
    "status": "draft",
    "paymentStatus": "pending",
    "source": "string",
    "channel": "string",
    "total": 0,
    "subtotal": 0,
    "tax": 0,
    "discount": 0,
    "discountName": "string",
    "serviceChargeAmount": 0,
    "serviceChargePercentage": 0,
    "serviceChargeRemoved": true,
    "payments": [
      {
        "id": "string",
        "method": "string",
        "provider": "stripe",
        "amount": 0,
        "currency": "GBP",
        "paymentIntentId": "string",
        "chargeId": "string",
        "cardBrand": "visa",
        "cardLast4": "4242",
        "walletType": "apple_pay",
        "paidAt": 0
      }
    ],
    "storeCredit": {
      "amount": 0,
      "currency": "string"
    },
    "tipAmount": 0,
    "currency": "string",
    "itemCount": 0,
    "customerId": "string",
    "customerName": "string",
    "customerEmail": "string",
    "staffId": "string",
    "staffName": "string",
    "locationId": "string",
    "locationName": "string",
    "sublocationId": "string",
    "sublocationName": "string",
    "covers": 0,
    "tableNumber": "string",
    "tableName": "string",
    "tables": [
      {
        "id": "string",
        "number": "string",
        "name": "string"
      }
    ],
    "refundAmount": 0,
    "createdAt": 0,
    "updatedAt": 0,
    "paymentMethod": "string",
    "shipping": 0,
    "items": [
      {
        "id": "string",
        "type": "product",
        "name": "string",
        "quantity": 0,
        "unitPrice": 0,
        "subtotal": 0,
        "tax": 0,
        "taxRate": 0,
        "discount": 0,
        "total": 0,
        "sku": "string",
        "productId": "string",
        "categoryName": "string",
        "reportingCategory": "string",
        "bookingId": "string",
        "productStatus": "string",
        "bookingStatus": "string",
        "specialInstructions": "string",
        "orderStageName": "string"
      }
    ],
    "discountCodes": [
      "string"
    ],
    "customerNotes": "string",
    "refundReason": "string",
    "isLegacy": true,
    "creationMethod": "customer_online",
    "completedAt": 0,
    "cancelledAt": 0
  },
  "timestamp": "2019-08-24T14:15:22Z"
}

{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}

{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}

{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}

{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}

Authorization

BearerAuth

AuthorizationBearer <token>

API key from the Tiquo dashboard (Settings > Developer > Admin API)

In: header

Path Parameters

orderId*string

Order number or document ID

Response Body

`application/json`

curl -X GET "https://api.tiquo.app/api/v1/orders/string"

{
  "success": true,
  "data": {
    "id": "string",
    "orderNumber": "string",
    "status": "draft",
    "paymentStatus": "pending",
    "source": "string",
    "channel": "string",
    "total": 0,
    "subtotal": 0,
    "tax": 0,
    "discount": 0,
    "discountName": "string",
    "serviceChargeAmount": 0,
    "serviceChargePercentage": 0,
    "serviceChargeRemoved": true,
    "payments": [
      {
        "id": "string",
        "method": "string",
        "provider": "stripe",
        "amount": 0,
        "currency": "GBP",
        "paymentIntentId": "string",
        "chargeId": "string",
        "cardBrand": "visa",
        "cardLast4": "4242",
        "walletType": "apple_pay",
        "paidAt": 0
      }
    ],
    "storeCredit": {
      "amount": 0,
      "currency": "string"
    },
    "tipAmount": 0,
    "currency": "string",
    "itemCount": 0,
    "customerId": "string",
    "customerName": "string",
    "customerEmail": "string",
    "staffId": "string",
    "staffName": "string",
    "locationId": "string",
    "locationName": "string",
    "sublocationId": "string",
    "sublocationName": "string",
    "covers": 0,
    "tableNumber": "string",
    "tableName": "string",
    "tables": [
      {
        "id": "string",
        "number": "string",
        "name": "string"
      }
    ],
    "refundAmount": 0,
    "createdAt": 0,
    "updatedAt": 0,
    "paymentMethod": "string",
    "shipping": 0,
    "items": [
      {
        "id": "string",
        "type": "product",
        "name": "string",
        "quantity": 0,
        "unitPrice": 0,
        "subtotal": 0,
        "tax": 0,
        "taxRate": 0,
        "discount": 0,
        "total": 0,
        "sku": "string",
        "productId": "string",
        "categoryName": "string",
        "reportingCategory": "string",
        "bookingId": "string",
        "productStatus": "string",
        "bookingStatus": "string",
        "specialInstructions": "string",
        "orderStageName": "string"
      }
    ],
    "discountCodes": [
      "string"
    ],
    "customerNotes": "string",
    "refundReason": "string",
    "isLegacy": true,
    "creationMethod": "customer_online",
    "completedAt": 0,
    "cancelledAt": 0
  },
  "timestamp": "2019-08-24T14:15:22Z"
}

{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}

{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}

{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}

Authorization

BearerAuth

AuthorizationBearer <token>

API key from the Tiquo dashboard (Settings > Developer > Admin API)

In: header

Path Parameters

orderId*string

Request Body

application/json

status*string

Response Body

`application/json`

curl -X PATCH "https://api.tiquo.app/api/v1/orders/string" \  -H "Content-Type: application/json" \  -d '{    "status": "draft"  }'

{
  "success": true,
  "data": {
    "id": "string",
    "orderNumber": "string",
    "status": "draft",
    "paymentStatus": "pending",
    "source": "string",
    "channel": "string",
    "total": 0,
    "subtotal": 0,
    "tax": 0,
    "discount": 0,
    "discountName": "string",
    "serviceChargeAmount": 0,
    "serviceChargePercentage": 0,
    "serviceChargeRemoved": true,
    "payments": [
      {
        "id": "string",
        "method": "string",
        "provider": "stripe",
        "amount": 0,
        "currency": "GBP",
        "paymentIntentId": "string",
        "chargeId": "string",
        "cardBrand": "visa",
        "cardLast4": "4242",
        "walletType": "apple_pay",
        "paidAt": 0
      }
    ],
    "storeCredit": {
      "amount": 0,
      "currency": "string"
    },
    "tipAmount": 0,
    "currency": "string",
    "itemCount": 0,
    "customerId": "string",
    "customerName": "string",
    "customerEmail": "string",
    "staffId": "string",
    "staffName": "string",
    "locationId": "string",
    "locationName": "string",
    "sublocationId": "string",
    "sublocationName": "string",
    "covers": 0,
    "tableNumber": "string",
    "tableName": "string",
    "tables": [
      {
        "id": "string",
        "number": "string",
        "name": "string"
      }
    ],
    "refundAmount": 0,
    "createdAt": 0,
    "updatedAt": 0,
    "paymentMethod": "string",
    "shipping": 0,
    "items": [
      {
        "id": "string",
        "type": "product",
        "name": "string",
        "quantity": 0,
        "unitPrice": 0,
        "subtotal": 0,
        "tax": 0,
        "taxRate": 0,
        "discount": 0,
        "total": 0,
        "sku": "string",
        "productId": "string",
        "categoryName": "string",
        "reportingCategory": "string",
        "bookingId": "string",
        "productStatus": "string",
        "bookingStatus": "string",
        "specialInstructions": "string",
        "orderStageName": "string"
      }
    ],
    "discountCodes": [
      "string"
    ],
    "customerNotes": "string",
    "refundReason": "string",
    "isLegacy": true,
    "creationMethod": "customer_online",
    "completedAt": 0,
    "cancelledAt": 0
  },
  "timestamp": "2019-08-24T14:15:22Z"
}

{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}

{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}

{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}

{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}

Authorization

BearerAuth

AuthorizationBearer <token>

API key from the Tiquo dashboard (Settings > Developer > Admin API)

In: header

Path Parameters

orderId*string

Response Body

`application/json`

curl -X DELETE "https://api.tiquo.app/api/v1/orders/string"

Empty

{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}

{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}

{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}

{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}

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

200application/json

401application/json

500application/json

201application/json

400application/json

401application/json

403application/json

500application/json

200application/json

401application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

200

400application/json

401application/json

403application/json

404application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`