Skip to main content
GET
Get order

Authorizations

Authorization
string
header
required

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

Path Parameters

order
integer<int64>
required
Required range: x >= 1

Response

The requested order.

id
integer
required
reference
string | null
required
Example:

"WEB-10001"

status
enum<string>
required
Available options:
pending,
confirmed,
in_progress,
out_for_delivery,
fulfilled,
cancelled
Example:

"confirmed"

payment_status
enum<string>
required
Available options:
unpaid,
partially_paid,
paid,
refunded,
partially_refunded,
voided
Example:

"paid"

fulfilment_method
enum<string> | null
required
Available options:
delivery,
collection,
relay,
null
Example:

"delivery"

fulfilment_date
string<date> | null
required
Example:

"2026-07-02"

fulfilment_at
string<date-time> | null
required
Example:

"2026-07-02T13:00:00+01:00"

fulfilment_window
string | null
required

Human-readable fulfilment time or window in local shop time, for example "between 13:00-15:00", "before 15:00" or "13:00". Null unless the token also has partner.customers.pii, unless a non-sensitive public label applies.

Example:

"between 13:00-15:00"

assigned_florist
object | null
required

The assigned florist staff name (operational disclosure); null when no florist is assigned.

recipient
Recipient · object | null
required

Recipient identity is present when known; contact fields inside it are null unless the token also has partner.customers.pii.

customer
Customer · object | null
required

Buyer customer. Contact fields inside it are null unless the token also has partner.customers.pii.

Example:
address
object | null
required

Delivery/fulfilment address (operational disclosure); null when the order has no address.

line_items
LineItem · object[]
required
discount_total
number<float>
required

Gross, in the shop currency.

Example:

0

total
number<float>
required

Gross, in the shop currency.

Example:

54.99

tax_total
number<float>
required

Gross VAT amount, in the shop currency. Includes fulfilment and order-level adjustments, so it can exceed the sum of line tax_total values.

Example:

9.17

fulfilment_charge
number<float>
required

Gross, in the shop currency.

Example:

5.99

currency
string
required
Example:

"GBP"

notes
object | null
required

Null unless the token also has partner.customers.pii.

created_at
string<date-time> | null
required
Example:

"2026-06-27T10:15:00+01:00"

updated_at
string<date-time> | null
required
Example:

"2026-06-27T10:20:00+01:00"

Last modified on July 6, 2026