Orders

Order object

Get orders

get
/v1/orders

This operation returns a list of orders.

Note: This operation needs Authentication and supports the following JSON:API features:

  • Relationships - invoice, customer, booking, tables, promoCode, outlet, revenueCenter using include query parameter.

  • Sparse fieldsets - supports all fields of order and related resources with fields query parameter.

Authorizations
AuthorizationstringRequired

Bearer HTTP authentication. Allowed headers-- Authorization: Bearer <api_key>

Query parameters
page[size]integer · int32 · min: 1 · max: 1000Optional

The number of resources to return in a single response.

page[before]string · min: 1 · max: 36Optional

Unique identifier.

Pattern: ^[a-zA-Z0-9-]+$
page[after]string · min: 1 · max: 36Optional

Unique identifier.

Pattern: ^[a-zA-Z0-9-]+$
filter[createdAtGt]any ofOptional

Filters the objects that were created after a specified datetime.

string · date-time · max: 25Optional

Timestamp in RFC 3339 format.

Example: 2023-10-16T14:30:00Z
or
string · date · max: 10Optional

Date in RFC 3339 format.

Example: 2023-10-16
filter[createdAtGteq]any ofOptional

Filters the objects that were created after or on a specified datetime.

string · date-time · max: 25Optional

Timestamp in RFC 3339 format.

Example: 2023-10-16T14:30:00Z
or
string · date · max: 10Optional

Date in RFC 3339 format.

Example: 2023-10-16
filter[updatedAtGt]any ofOptional

Filters the objects that were updated after a specified datetime.

string · date-time · max: 25Optional

Timestamp in RFC 3339 format.

Example: 2023-10-16T14:30:00Z
or
string · date · max: 10Optional

Date in RFC 3339 format.

Example: 2023-10-16
filter[updatedAtGteq]any ofOptional

Filters the objects that were updated after or on a specified datetime.

string · date-time · max: 25Optional

Timestamp in RFC 3339 format.

Example: 2023-10-16T14:30:00Z
or
string · date · max: 10Optional

Date in RFC 3339 format.

Example: 2023-10-16
filter[tableIdEq]string · uuid · min: 36 · max: 36Optional

Universally unique ID UUID4.

Example: 5efa8b3c-b930-4b31-918d-95ab0e212e64
filter[revenueCenterIdEq]string · uuid · min: 36 · max: 36Optional

Universally unique ID UUID4.

Example: 5efa8b3c-b930-4b31-918d-95ab0e212e64
Responses
get
/v1/orders

Create order

post
/v1/orders

This operation creates an order.

Note: This operation needs Authentication and supports the following JSON:API features:

  • Relationships - invoice, customer, booking, tables, promoCode, outlet, revenueCenter, taxes, orderItems, payments using include query parameter.

  • Sparse fieldsets - supports all fields of order and related resources with fields query parameter.

Authorizations
AuthorizationstringRequired

Bearer HTTP authentication. Allowed headers-- Authorization: Bearer <api_key>

Query parameters
Body
Responses
post
/v1/orders

Get order

get
/v1/orders/{id}

An order represents a single set of items that was ordered by a customer. Each order is uniquely identified and can be associated with an invoice item.

Note: This operation needs Authentication and supports the following JSON:API features:

  • Relationships - invoice, customer, booking, tables, promoCode, outlet, revenueCenter using include query parameter.

  • Sparse fieldsets - supports all fields of order and related resources with fields query parameter.

Authorizations
AuthorizationstringRequired

Bearer HTTP authentication. Allowed headers-- Authorization: Bearer <api_key>

Path parameters
idstring · uuid · min: 36 · max: 36Required

Universally unique ID UUID4.

Example: 5efa8b3c-b930-4b31-918d-95ab0e212e64
Query parameters
Responses
get
/v1/orders/{id}

Update order

patch
/v1/orders/{id}

This operation updates an existing order. You can update order attributes (covers, notes) and relationships (customer, tables, outlet, revenue center, promo code). You can also add new items to the order or update existing ones.

Item Identifiers:

  • Use tempId for new items being added to the order (items that don't exist in the database yet).

  • Use id (UUID) for existing items that are being updated or kept in the order.

Note: This operation needs Authentication and supports the following JSON:API features:

  • Relationships - customer, tables, outlet, revenueCenter, promoCode using relationships in the request body.

  • Sparse fieldsets - supports all fields of order and related resources with fields query parameter.

Authorizations
AuthorizationstringRequired

Bearer HTTP authentication. Allowed headers-- Authorization: Bearer <api_key>

Path parameters
idstring · uuid · min: 36 · max: 36Required

Universally unique ID UUID4.

Example: 5efa8b3c-b930-4b31-918d-95ab0e212e64
Query parameters
Body
Responses
patch
/v1/orders/{id}

Last updated

Was this helpful?