API ReferenceOrders

Fetch Order

Fetch an order

Required OAuth 2.0 scope: business/orders:read

Path parameters

order_idstringRequired>=1 character<=100 characters
The unique identifier of the order.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

Successful Response
amountsobject
A collection of summarized amounts on the order.
closed_atstring or nullformat: "date-time"
The date and time the order was closed in ISO 8601 format.
created_atstringformat: "date-time"
The order creation date and time in ISO 8601 format.
currencystring
The currency code in ISO 4217 format.
display_namestring

A human-friendly label for the order.

idstring
The unique identifier of the order.
namestring or null

A human-friendly identifier (customer name, table number, order number, etc) representing the order.

notestring or null
An optional note attached to the order.
order_numberstring or null

A human-friendly identifier for the order.

statusenum
The current state of the order.
Allowed values:
updated_atstring or nullformat: "date-time"
The date and time the order was last modified in ISO 8601 format.
applied_discountslist of objects or null
The discounts applicable to the order.
line_itemslist of objects or null
A list of line items making up the order.
paymentslist of objects or null
The payments that have been receipted against the order.
refundslist of objects or null
The refunds that have been issued against the order.
returnslist of objects or null
A list of returns associated with this order.
total_taxeslist of objects or null
A list of taxes across all line items aggregated by tax type.

Errors