Skip to main content
GET
/
v1
/
orders
List Orders
curl --request GET \
  --url https://api.example.com/v1/orders \
  --header 'Authorization: <authorization>'
{
  "id": "<string>",
  "type": "<string>",
  "status": "<string>",
  "customerId": "<string>",
  "locationId": "<string>",
  "scheduledAt": "<string>",
  "duration": 123,
  "services": [
    {}
  ],
  "subtotal": 123,
  "tax": 123,
  "total": 123,
  "paymentStatus": "<string>"
}

​
List Orders

Retrieve a paginated list of orders and bookings.

​
Endpoint

GET /v1/orders

​
Authentication

​
Authorization
string
required
Bearer token with orders:read scope

​
Query Parameters

​
limit
integer
default:"25"
Number of orders to return (1-100)
​
cursor
string
Pagination cursor from previous response
​
status
string
Filter by status: pending, confirmed, completed, cancelled
​
type
string
Filter by type: booking, sale, enquiry
​
customerId
string
Filter by customer ID
​
locationId
string
Filter by location ID
​
startDate
string
Orders scheduled after this date (ISO 8601)
​
endDate
string
Orders scheduled before this date (ISO 8601)
​
createdAfter
string
Orders created after this date (ISO 8601)

​
Request Example

curl -X GET "https://api.tiquo.co/v1/orders?status=confirmed&limit=10" \
  -H "Authorization: Bearer sk_live_xxxxx"

​
Response Example

{
  "success": true,
  "data": [
    {
      "id": "ord_abc123",
      "type": "booking",
      "status": "confirmed",
      "customerId": "cust_xyz789",
      "customerName": "John Doe",
      "customerEmail": "[email protected]",
      "locationId": "loc_def456",
      "scheduledAt": "2024-01-25T10:00:00Z",
      "duration": 60,
      "services": [
        {
          "id": "svc_123",
          "name": "Consultation",
          "price": 75.00,
          "quantity": 1
        }
      ],
      "subtotal": 75.00,
      "tax": 6.56,
      "total": 81.56,
      "paymentStatus": "paid",
      "notes": "First-time customer",
      "createdAt": "2024-01-20T14:30:00Z",
      "updatedAt": "2024-01-20T15:00:00Z"
    }
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "ord_abc123"
  }
}

​
Order Object

​
id
string
Unique order identifier
​
type
string
Order type: booking, sale, enquiry
​
status
string
Order status: pending, confirmed, in_progress, completed, cancelled
​
customerId
string
Associated customer ID
​
locationId
string
Location ID where service occurs
​
scheduledAt
string
Scheduled date/time (ISO 8601)
​
duration
integer
Duration in minutes
​
services
array
Array of services/products in order
​
subtotal
number
Subtotal before tax
​
tax
number
Tax amount
​
total
number
Total amount
​
paymentStatus
string
Payment status: pending, paid, refunded, failed

​
Filtering Examples

​
By Status

GET /v1/orders?status=pending

​
By Date Range

GET /v1/orders?startDate=2024-01-01&endDate=2024-01-31

​
By Customer

GET /v1/orders?customerId=cust_xyz789

​
Code Examples

const params = new URLSearchParams({
  status: 'confirmed',
  limit: '10'
});

const response = await fetch(`https://api.tiquo.co/v1/orders?${params}`, {
  headers: {
    'Authorization': `Bearer ${apiKey}`
  }
});

const { data: orders } = await response.json();

Get Order

Retrieve single order

Create Order

Create new order