Orders

List all orders.

get
Authorizations
api-keystringRequired

API Key

Header parameters
organization-idstringRequired

Organization ID

Responses
chevron-right
200Success
application/json
get
/v1/om/orders

Creates a new Order.

post
Authorizations
api-keystringRequired

API Key

Header parameters
organization-idstringRequired

Organization ID

Body
Responses
chevron-right
200Success
application/json
post
/v1/om/orders
200Success

Returns an order.

get
Authorizations
api-keystringRequired

API Key

Path parameters
uidstringRequired
Header parameters
organization-idstringRequired

Organization ID

Responses
chevron-right
200Success
application/json
get
/v1/om/orders/{uid}

Updates an order.

patch
Authorizations
api-keystringRequired

API Key

Path parameters
uidstringRequired
Header parameters
organization-idstringRequired

Organization ID

Body
Responses
chevron-right
200Success
application/json
patch
/v1/om/orders/{uid}

Finalizes and closes the specified order.

patch
Authorizations
api-keystringRequired

API Key

Path parameters
uidstringRequired
Header parameters
organization-idstringRequired

Organization ID

Responses
chevron-right
200Success
application/json
patch
/v1/om/orders/{uid}/close

Cancels an order.

patch
Authorizations
api-keystringRequired

API Key

Path parameters
uidstringRequired
Header parameters
organization-idstringRequired

Organization ID

Responses
chevron-right
200Success
application/json
patch
/v1/om/orders/{uid}/cancel

Voids an order.

patch
Authorizations
api-keystringRequired

API Key

Path parameters
uidstringRequired
Header parameters
organization-idstringRequired

Organization ID

Body
Responses
chevron-right
200Success
application/json
patch
/v1/om/orders/{uid}/void

Exports all orders with support for incremental fetching.

get
Authorizations
api-keystringRequired

API Key

Query parameters
updatedSincestringOptional
offsetstringOptional
Header parameters
organization-idstringRequired

Organization ID

Responses
chevron-right
200Success
application/json
Responseobject
get
/v1/om/orders/export
200Success

Applies a discount at order level.

patch
Authorizations
api-keystringRequired

API Key

Path parameters
uidstringRequired
Header parameters
organization-idstringRequired

Organization ID

Body
Responses
chevron-right
200Success
application/json
patch
/v1/om/orders/{uid}/discount

Updates applied discount at order level.

patch
Authorizations
api-keystringRequired

API Key

Path parameters
uidstringRequired
Header parameters
organization-idstringRequired

Organization ID

Body
Responses
chevron-right
200Success
application/json
patch
/v1/om/orders/{uid}/update-discount

Cancels a discount at order level.

patch
Authorizations
api-keystringRequired

API Key

Path parameters
uidstringRequired
Header parameters
organization-idstringRequired

Organization ID

Body
Responses
chevron-right
200Success
application/json
patch
/v1/om/orders/{uid}/cancel-discount

Applies a custom discount at order level.

patch
Authorizations
api-keystringRequired

API Key

Path parameters
uidstringRequired
Header parameters
organization-idstringRequired

Organization ID

Body
Responses
chevron-right
200Success
application/json
patch
/v1/om/orders/{uid}/custom-discount

Returns an order by external ID.

get
Authorizations
api-keystringRequired

API Key

Path parameters
externalIdstringRequired
Header parameters
organization-idstringRequired

Organization ID

Responses
chevron-right
200Success
application/json
get
/v1/om/orders/by-external/{externalId}

Returns the current open order for the specified table.

get
Authorizations
api-keystringRequired

API Key

Path parameters
tableUidstringRequired
Header parameters
organization-idstringRequired

Organization ID

Responses
chevron-right
200Success
application/json
get
/v1/om/orders/by-table/{tableUid}

Last updated

Was this helpful?