Skip to main content
POST
Create an order
Creates an order. Your API key needs the orders:create scope.

Headers

string
required
Your API key. You can use Authorization: Api-Key your_key instead.
string
required
Use application/json.

Request body

string
required
Customer name. Cannot be blank.
string
required
Customer phone number.
string
Order note.
object[]
required
One or more order items.
object
Delivery address.
The delivery phone, or customerPhone when no delivery phone is supplied, must be valid.

Request example

Response

A successful request returns 201 Created. The Location header contains the new order URL.
UUID
required
Order ID.
string
required
Order number.
string
required
Current order status.
number
required
Order subtotal.
number
required
Final order total.
integer
required
Total item quantity.
string
required
Order date and time in ISO 8601 format.
string
required
Customer name.
string | null
Customer phone.
string | null
Order note.

Errors