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

Object

Nested in API

order_item

A line item on an order.

Nested under order.items on order detail responses.

Exposure

Appears nested inside Merchant API responses (not a top-level route).

What

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

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

id

string

Line item id.

Type
id: string

quantity

number

Quantity ordered.

Type
quantity: number

returnedQuantity

number

Quantity already returned against this line.

Type
returnedQuantity: number

price

number

Unit price at time of sale.

Type
price: number

total

number

Line total.

Type
total: number

product

object

Snapshot reference `{ id, title }` for the product.

Type
product: object

variant

object

Snapshot reference `{ id, title, sku }` for the variant.

Type
variant: object

Related