Skip to content

List stock ledger movements in the selected organization

GET
/v1/organizations/{organizationId}/movements

API key scope: inventory:read.

X-Request-Id
string

Optional client request id returned in structured errors.

productId
string

Filter by product id.

locationId
string

Filter by location id.

ownerId
string

Filter by inventory owner id.

channelId
string

Filter by inventory channel id.

operation
string
Allowed values: receive adjust fulfill write_off return_stock move_state reconcile reserve commit release reservation_cancel expire transfer_out transfer_in transfer_cancel transfer_close inbound_expect inbound_receive inbound_close inbound_cancel outbound_allocate outbound_pick outbound_pack outbound_ship outbound_fulfill outbound_cancel composition_assemble_component composition_assemble_output composition_disassemble_input composition_disassemble_component
inventoryState
string
Allowed values: onHand available reserved committed incoming damaged qualityControl safetyStock
referenceType
string
Example
reservation
referenceId
string
Example
res_01JABC
createdFrom
string format: date-time
createdTo
string format: date-time
limit
number
default: 25 >= 1 <= 100
cursor
string

Stock ledger id cursor returned by the previous page.

Stock ledger movements page.

Media typeapplication/json
object
items
required
Array<object>
object
id
required
string format: uuid
organizationId
required
string format: uuid
environment
required
string
Allowed values: live test
productId
required
string format: uuid
locationId
required
string format: uuid
ownerId
required
string format: uuid
channelId
required
string format: uuid
lotId
object
operation
required
string
Allowed values: receive adjust fulfill write_off return_stock move_state reconcile reserve commit release reservation_cancel expire transfer_out transfer_in transfer_cancel transfer_close inbound_expect inbound_receive inbound_close inbound_cancel outbound_allocate outbound_pick outbound_pack outbound_ship outbound_fulfill outbound_cancel composition_assemble_component composition_assemble_output composition_disassemble_input composition_disassemble_component
inventoryState
required
string
Allowed values: onHand available reserved committed incoming damaged qualityControl safetyStock
quantity
required
number
unitCode
object
unitQuantity
object
baseUnitCode
object
balanceBefore
required
number
balanceAfter
required
number
reason
object
referenceType
object
referenceId
object
source
object
idempotencyKey
object
metadata
object
key
additional properties
any
createdBy
object
actor
required
object
type
required
string
Allowed values: user api_key system
id
object
label
required
string
product
object
id
required
string format: uuid
name
required
string
sku
required
string
location
object
id
required
string format: uuid
name
required
string
code
required
string
type
required
string
Allowed values: warehouse store virtual
owner
object
id
required
string format: uuid
name
required
string
code
required
string
type
required
string
channel
object
id
required
string format: uuid
name
required
string
code
required
string
type
required
string
lot
object
id
required
string format: uuid
lotCode
required
string
batchCode
object
expiresAt
object
status
required
string
Allowed values: active archived
serials
required
Array<object>
object
id
required
string format: uuid
serialNumber
required
string
status
required
string
Allowed values: in_stock picked packed consumed written_off archived
productId
required
string format: uuid
locationId
required
string format: uuid
ownerId
required
string format: uuid
channelId
required
string format: uuid
lotId
object
createdAt
required
string format: date-time
nextCursor
object
Example
{
"items": [
{
"id": "88888888-8888-4888-8888-888888888888",
"organizationId": "11111111-1111-4111-8111-111111111111",
"environment": "test",
"productId": "22222222-2222-4222-8222-222222222222",
"locationId": "33333333-3333-4333-8333-333333333333",
"lotId": "12121212-1212-4212-8212-121212121212",
"operation": "receive",
"inventoryState": "onHand",
"quantity": 10,
"unitCode": "CASE",
"unitQuantity": 1,
"baseUnitCode": "EA",
"balanceBefore": 0,
"balanceAfter": 10,
"reason": "Initial receipt",
"referenceType": "purchase_order",
"referenceId": "po_01JABC",
"source": "api_key",
"idempotencyKey": "receive-unique-key",
"metadata": {
"batch": "A1"
},
"actor": {
"type": "api_key",
"id": "api-key-1",
"label": "Public test integration"
},
"product": {
"id": "22222222-2222-4222-8222-222222222222",
"name": "Black T-Shirt - Medium",
"sku": "TSHIRT-BLACK-M"
},
"location": {
"id": "33333333-3333-4333-8333-333333333333",
"name": "Main Warehouse",
"code": "MAIN-WH",
"type": "warehouse"
},
"lot": {
"id": "12121212-1212-4212-8212-121212121212",
"lotCode": "LOT-2026-001",
"batchCode": "BATCH-A",
"expiresAt": "2027-07-01T00:00:00.000Z",
"status": "active"
},
"serials": [
{
"id": "14141414-1414-4414-8414-141414141414",
"serialNumber": "SN-2026-0001",
"status": "in_stock",
"productId": "22222222-2222-4222-8222-222222222222",
"locationId": "33333333-3333-4333-8333-333333333333",
"lotId": "12121212-1212-4212-8212-121212121212"
}
],
"createdAt": "2026-06-29T10:00:00.000Z"
}
],
"nextCursor": null
}

The organization has exhausted its monthly public API request quota.

Media typeapplication/json
Example
{
"error": {
"code": "PLAN_LIMIT_EXCEEDED",
"message": "Plan limit exceeded for api_requests",
"requestId": "req_123",
"details": {
"entitlementKey": "api_requests",
"scope": "environment",
"environment": "live",
"configured": true,
"limit": "50000",
"used": "50000",
"requested": "1",
"currentPlan": {
"code": "free",
"version": 1
},
"requiredPlan": {
"code": "starter",
"version": 1,
"requiresOverride": false
}
}
}
}