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

Object

Admin / POS

inventory_movement

A stock movement audit row.

Receive, adjust, sale, or return delta against a variant.

Exposure

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

What

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

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

id

string

Movement id.

Type
id: string

shopId

string

Shop that owns the movement.

Type
shopId: string

variantId

string

Affected variant id.

Type
variantId: string

quantityDelta

number

Signed change (positive = stock in, negative = stock out).

const after = before + movement.quantityDelta;

quantityAfter

number

Variant quantity after applying this movement (audit).

Type
quantityAfter: number

type

InventoryMovementType

Movement kind.

Type
type: RECEIVE | ADJUST | SALE | RETURN

reason

string | null

Human reason / note.

Type
reason: string | null

reference

string | null

External reference (PO number, delivery note, …).

Type
reference: string | null

createdAt

string

ISO-8601 created timestamp.

Type
createdAt: string

Related