Skip to main content
PATCH
cURL

Authorizations

Authorization
string
header
required

Merchant API V2 token. Pass as Authorization: Bearer <token>.

Path Parameters

order_id
string
required

Body

application/json
order_status
enum<string>
Available options:
draft,
pending,
confirmed,
completed,
cancelled
payment_status
enum<string>

Sets the status only: no payment is recorded and amount_paid does not change. To record money received, use POST /orders/{order_id}/payments instead.

Available options:
pending,
confirming,
partial,
paid,
refunded,
voided
payment_method
string
fulfillment_status
enum<string>
Available options:
unfulfilled,
ready,
in_transit,
out_for_delivery,
fulfilled,
partially_fulfilled
remark
string | null
internal_note
string | null

Response

Order

id
string
required
object
enum<string>
required
Available options:
order
number
string
required
name
string
required
store
object
required
order_status
enum<string>
required
Available options:
draft,
pending,
confirmed,
completed,
cancelled
payment_status
enum<string>
required

Set by the merchant or by PATCH /orders/{order_id}, and can be changed without recording a payment, so it can read paid while amount_paid is 0. For reconciliation, use amount_paid and amount_due. Recording a payment with POST /orders/{order_id}/payments sets this from the balance.

Available options:
pending,
confirming,
partial,
paid,
refunded,
voided
payment_method
string | null
required
fulfillment_status
enum<string>
required
Available options:
unfulfilled,
ready,
in_transit,
out_for_delivery,
fulfilled,
partially_fulfilled
remark
string | null
required
internal_note
string | null
required
attribution
object | null
required
customer
object | null
required
line_items
object[]
required
answers
object[]
required
discounts
object[]
required
service
object | null
required
schedule
object | null
required
table
object | null
required

The dine-in table the order was placed at. name is the table's current name. Becomes null if the table is deleted.

items_quantity
integer
required
items_amount
integer
required

Integer amount in the smallest unit of the store currency (e.g. cents).

answers_amount
integer
required

Integer amount in the smallest unit of the store currency (e.g. cents).

discounts_amount
integer
required

Integer amount in the smallest unit of the store currency (e.g. cents).

service_amount
integer
required

Integer amount in the smallest unit of the store currency (e.g. cents).

service_charge_amount
integer
required

Integer amount in the smallest unit of the store currency (e.g. cents).

tip_amount
integer
required

Integer amount in the smallest unit of the store currency (e.g. cents).

adjustment_amount
integer
required

Integer amount in the smallest unit of the store currency (e.g. cents).

total_before_tax
integer
required

Integer amount in the smallest unit of the store currency (e.g. cents).

tax_amount
integer
required

Integer amount in the smallest unit of the store currency (e.g. cents).

total_amount
integer
required

Integer amount in the smallest unit of the store currency (e.g. cents).

amount_paid
integer
required

Sum of paid payments, net of processing fees. List them with GET /orders/{order_id}/payments.

amount_due
integer
required

total_amount minus amount_paid. Only recorded payments count, whatever payment_status says.

currency
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required