RetailLink
OverviewGetting startedA–Z indexAdmin overviewAdmin pagesAdmin settingsPOS overviewPOS screensStorefrontMerchant APIObjectsAuthenticationWebhooks

Object

Merchant API

order

An omnichannel order (POS or storefront).

Returned by Merchant API order endpoints. Includes customer, line items, and payments on detail fetches. Managed in Admin → Orders.

Exposure

Returned by Merchant API list/detail routes for this resource.

What

The order object is the JSON / domain shape for this resource in RetailLink.

Why

Use these fields when integrating — not scraped Admin HTML — so sync jobs and apps stay stable across UI changes.

How

Read each property below — description first, then that property's Code / Data / Output (or type). Use the sticky example JSON on the right as a full fixture.

Properties

18 fields on order. Types link to related objects when available. Snippets for a property appear under that property.

id

string

Unique order id.

Type
id: string

orderNumber

string | null

Human-facing order number when assigned.

Type
orderNumber: string | null

receiptNumber

string | null

POS receipt number when the order originated on the till.

Type
receiptNumber: string | null

status

string

Order status (e.g. PENDING, CONFIRMED, PROCESSING, COMPLETED, CANCELLED). Cancel rules apply in Admin.

Type
status: string

totalAmount

number

Order total including tax and adjustments.

Type
totalAmount: number

subtotal

number

Line subtotal before tax/shipping.

Type
subtotal: number

taxAmount

number

Tax total.

Type
taxAmount: number

shippingAmount

number

Shipping amount (detail response).

Type
shippingAmount: number

discountAmount

number

Discount total (detail response).

Type
discountAmount: number

cashbackAmount

number

POS cashback paid out on the order when applicable (detail response).

Type
cashbackAmount: number

currency

string

ISO currency code (e.g. GBP).

Type
currency: string

notes

string | null

Staff or customer notes (detail response).

Type
notes: string | null

deliveryMethod

string | null

Fulfillment / delivery method when set (detail response).

Type
deliveryMethod: string | null

createdAt

string

ISO-8601 created timestamp.

Type
createdAt: string

updatedAt

string

ISO-8601 updated timestamp (detail response).

Type
updatedAt: string

customer

customer

Attached customer summary, or null when walk-in.

Type
customer: customer

items

array of order_item

Line items (detail response).

Type
items: order_item[]

payments

array of payment

Tenders applied to the order.

Type
payments: payment[]

Related