List all orders

get

https://sandbox.xola.com/api/orders

This will return a paginated response that will contain all the orders.

Query Params

string

Performs a fuzzy search across customer name, email, phone, and tags. Using this filter will cause all other filters (except seller) to be ignored.

seller

string

Find orders owned by this seller.

balance

float

Find orders with this amount of balance due.

tags._id

string

Find orders with this tag.

customerName

string

Find orders for this customer/organizer name.

customerEmail

string

Find orders for this customer/organizer email.

traveler

string

Find orders for which this user is a traveler or organizer.

items.experience

string

Find orders with this experience.

items.arrival

date

Find orders with this arrival date.

items.arrivalTime

int32

Find orders with this arrival time (in military format).

items.status

string

Find orders with this order status.

items.guestStatus

string

Find orders with this guest status. Must be one of pending, arrived, noshow.

items.quantity

int32

Find orders with this quantity of guests.

items.event

string

Find orders linked to this event.

source

string

Find orders with this source of origin.

createdBy

string

Find orders created by this user.

createdAt

date-time

Find orders created at this time.

updatedAt

date-time

Find orders updated at this time.

sort

string

Defaults to -id

Field to sort on. Prefix with a minus sign to sort descending

limit

string

Defaults to 20

Number of results to include in one page of data

skip

string

Defaults to 0

Number of results to skip

Responses

Language

Credentials

Header

Request

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400

404404