Skip to main content
POST
Create order

Authorizations

x-token
string
header
required

JWT access token obtained from /v2/auth endpoint

Body

application/json

Order details

sale_type_id
integer
required

Sale type to use

Example:

2

venue_id
integer
required

Venue where the order belongs

Example:

1

customer
object
required

Customer information for the order

products
object[]
required

List of products in the order

Minimum array length: 1
auto_accept_terminal
integer

Terminal ID that auto-accepts the order

Example:

1

auto_order_accept
boolean
default:false

Auto-accept the order

auto_order_sent_to_station
boolean
default:false

Auto-send to stations after acceptance

delivery_fee
number

Delivery charge to apply

Example:

2.5

comment
string

Free text note for the order

Example:

"Leave at the door"

discount
object

Order-level discount

service_charge
object

Service charge settings

Response

Order created successfully

success
boolean
message
string
data
object