Skip to content

List the stock movements report

GET
/v1/organizations/{organizationId}/reports/stock-movements

API key scope: reports:read.

X-Request-Id
string

Optional client request id returned in structured errors.

createdFrom
string format: date-time
createdTo
string format: date-time
productId
string
locationId
string
ownerId
string
channelId
string
status
string

Status filter. Supported values depend on report type.

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
limit
number
default: 50 >= 1 <= 500
cursor
string

Opaque id cursor returned by the previous report page.

Stock movements report page.

Media typeapplication/json
object
items
required
Array<object>
object
id
required
string format: uuid
createdAt
required
string format: date-time
productId
required
string format: uuid
productName
required
string
productSku
required
string
locationId
required
string format: uuid
locationName
required
string
locationCode
required
string
ownerId
required
string format: uuid
ownerName
required
string
ownerCode
required
string
channelId
required
string format: uuid
channelName
required
string
channelCode
required
string
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
referenceType
object
referenceId
object
reason
object
source
object
actorType
string
nullable
Allowed values: user api_key system
actorId
object
actorLabel
object
nextCursor
object
Example
{
"items": [
{
"id": "88888888-8888-4888-8888-888888888888",
"createdAt": "2026-06-29T10:00:00.000Z",
"productId": "22222222-2222-4222-8222-222222222222",
"productName": "Black T-Shirt - Medium",
"productSku": "TSHIRT-BLACK-M",
"locationId": "33333333-3333-4333-8333-333333333333",
"locationName": "Main Warehouse",
"locationCode": "MAIN-WH",
"ownerId": "dddddddd-dddd-4ddd-8ddd-dddddddddddd",
"ownerName": "Consignment Partner",
"ownerCode": "PARTNER",
"channelId": "eeeeeeee-eeee-4eee-8eee-eeeeeeeeeeee",
"channelName": "Marketplace",
"channelCode": "MARKETPLACE",
"operation": "receive",
"inventoryState": "onHand",
"quantity": 10,
"unitCode": "CASE",
"unitQuantity": 1,
"baseUnitCode": "EA",
"balanceBefore": 0,
"balanceAfter": 10,
"referenceType": "purchase_order",
"referenceId": "po_01JABC",
"reason": "Initial receipt",
"source": "api_key",
"actorType": "api_key",
"actorId": "api-key-1",
"actorLabel": "Public test integration"
}
],
"nextCursor": null
}

The organization has exhausted its monthly public API request quota.

The organization plan does not allow the requested action.

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