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

Object

Admin / POS

suspended_sale

A parked POS basket (suspend / recall).

Cashier parks a till basket with a shop-scoped referenceNo and JSON snapshots.

Exposure

Used in Admin, POS, or Storefront. Not exposed on Merchant API v1 routes yet.

What

The suspended_sale 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

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

id

string

Suspended sale id.

Type
id: string

referenceNo

number

Shop-scoped display reference (e.g. 147).

Type
referenceNo: number

status

string

SuspendedSaleStatus (SUSPENDED, RECALLED, CANCELLED, …).

Type
status: string

cashierId

string

Cashier user id.

Type
cashierId: string

cashierName

string | null

Cashier display name.

Type
cashierName: string | null

tillId

string | null

Till / terminal id.

Type
tillId: string | null

locationId

string | null

Shop location id.

Type
locationId: string | null

customerId

string | null

Attached customer when set.

Type
customerId: string | null

notes

string | null

Suspend notes.

Type
notes: string | null

basketSnapshot

object

Full cart lines (prices, VAT, discounts, qty) as JSON.

Type
basketSnapshot: object

itemCount

number

Number of lines / items.

Type
itemCount: number

subtotal

number

Basket subtotal.

Type
subtotal: number

taxAmount

number

Tax total.

Type
taxAmount: number

total

number

Basket total.

Type
total: number

suspendedAt

string

When the sale was parked.

Type
suspendedAt: string

expiresAt

string | null

Optional expiry.

Type
expiresAt: string | null

Related