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

Object

Admin / POS

purchase_order

A purchase order to a vendor.

Goods ordered from a vendor into a shop_location; receiving updates inventory.

Exposure

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

What

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

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

id

string

PO id.

Type
id: string

poNumber

string

Shop-scoped PO number (e.g. PO-00001).

Type
poNumber: string

barcode

string

Scannable barcode payload.

Type
barcode: string

status

PurchaseOrderStatus

Lifecycle status.

Type
status: DRAFT | SENT | PARTIALLY_RECEIVED | RECEIVED | CANCELLED

vendorId

string

Vendor id.

Type
vendorId: string

locationId

string | null

Destination shop_location for receiving.

Type
locationId: string | null

orderDate

string

When the PO was created / ordered.

Type
orderDate: string

expectedDeliveryDate

string | null

Expected delivery date.

Type
expectedDeliveryDate: string | null

subtotal

number

Lines subtotal.

Type
subtotal: number

taxAmount

number

Tax total.

Type
taxAmount: number

totalAmount

number

PO total.

Type
totalAmount: number

currency

string

ISO currency code.

Type
currency: string

notes

string | null

Staff notes.

Type
notes: string | null

createdAt

string

ISO-8601 created timestamp.

Type
createdAt: string

updatedAt

string

ISO-8601 updated timestamp.

Type
updatedAt: string

Related