Order

Definition

In the POS API, an order is a record of items a customer selected for purchase at a point of sale. It holds the list of items, quantities, prices, and the associated payment information.

“Order” also exists in the E-commerce API (an online purchase) and the PMS API (services consumed during a guest stay).

Purpose

Orders capture what a customer bought in a single transaction at the point of sale.

Relationships

• An order belongs to a location.
• It contains one or more line items referencing products.
• It is linked to one or more payments.

Endpoints

Read

Method	Endpoint	Description
GET	Get orders	Retrieve the list of orders
GET	Get one order	Retrieve a single order by ID

Write

Method	Endpoint	Description
PATCH	Update order	Update an existing order

See also

• Locations
• Customers