Create an order

Opens an order at an outlet, owned by the signed-in staff member.

Each line names a Cloudbeds catalog item_id (validated against the catalog), its quantity and modifiers, and base_unit_price: the list price the item sold at, before modifiers and offers. That price is kept as sent, so a later catalog change never rewrites an existing order. Do not send a price with an offer already taken off: offers are applied by the server, and claimed_offer_amount / claimed_offer_total let it refuse a cart whose offers do not match what the guest was shown. Taxes, fees and totals are computed server-side.

Seat the order by passing a table_id, or attach a guest with reservation_id.

Clients that work offline set offline_id so a replayed create returns the order it already made.

Requires a staff token.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Payload for creating a new order.

length ≤ 100
≥ 0
1 to 99
length ≤ 255
items
array of objects
required

Empty only for a dine-in order targeting a table.

Items*
length ≤ 1000
OrderType | null
uuid
required
length ≤ 50
Headers
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json