Methods
Entity Properties
stock_movement.list
stock_movement.list (null|object $filters, null|object $options)
Retrieve list of stock movements.
Quantity fields describe the change recorded by the row, not current inventory balances. A quantity that did not change is returned as null.
Parameters
object | null
Filters to apply to the request. Allowed properties for filtering: “id”, “entity_type”, “entity_action”, “entity_id”, “sku”, “created_at”, “warehouse_id”, “location”, “adjustment_reason_code”, “hold_reason_code”.
hold_reason_code filters by the rolled-up parent reason code on movements attributed to a governing hold and accepts the standard filter operators. Movements without a governing hold have a null hold reason, so a null condition also matches those movements. This field is filter-only and cannot be used as a sort_field.Return Value
An array of Stock Movements or an empty array.Example Request
Get all stock movements:Request
{
"jsonrpc" : 2.0,
"id" : 1234,
"method" : "call",
"params" : [
"be1c13ed4e03f0ed7f1e4053dfff9658",
"stock_movement.list"
]
}
Request
{
"jsonrpc" : 2.0,
"id" : 1234,
"method" : "call",
"params" : [
"be1c13ed4e03f0ed7f1e4053dfff9658",
"stock_movement.list",
[
{
"warehouse_id": {
"eq": "2"
}
}
]
]
}
Example Response
Response
{
"result": {
"results": [
{
"id": "12",
"entity_type": "order",
"entity_action": "create",
"product_id": "4",
"qty_expected": null,
"qty_processed": null,
"qty_putaway": null,
"qty_available": "-1.0000",
"qty_allocated": "1.0000",
"qty_reserved": null,
"qty_picked": null,
"qty_packed": null,
"qty_shipped": null,
"qty_backordered": null,
"qty_held": null,
"created_at": "2022-09-12T19:47:50+00:00",
"sku": "12-345-6789",
"comment": null,
"warehouse_id": "2",
"entity_id": "100000001",
"location": "",
"parent_type": null,
"parent_id": null,
"adjustment_reason_code": null,
"hold_reason_code": null,
"hold": null
},
{
"id": "13",
"entity_type": "hold",
"entity_action": "hold",
"product_id": "4",
"qty_expected": null,
"qty_processed": null,
"qty_putaway": null,
"qty_available": "-2.0000",
"qty_allocated": null,
"qty_reserved": null,
"qty_picked": null,
"qty_packed": null,
"qty_shipped": null,
"qty_backordered": null,
"qty_held": "2.0000",
"created_at": "2026-07-13T10:15:00+00:00",
"sku": "12-345-6789",
"comment": null,
"warehouse_id": "2",
"entity_id": "A-01-02",
"location": "A-01-02",
"parent_type": null,
"parent_id": null,
"adjustment_reason_code": null,
"hold_reason_code": "qc_inspection",
"hold": {
"scope_type": "location",
"lot_id": 42,
"parent_hold_id": 731,
"reason": {
"code": "merchant_review",
"label": "Merchant Review",
"display_group": "Review"
}
}
},
{
"id": "14",
"entity_type": "order",
"entity_action": "pack",
"product_id": "4",
"qty_expected": null,
"qty_processed": null,
"qty_putaway": null,
"qty_available": null,
"qty_allocated": null,
"qty_reserved": null,
"qty_picked": "-1.0000",
"qty_packed": "1.0000",
"qty_shipped": null,
"qty_backordered": null,
"qty_held": null,
"created_at": "2026-10-08T14:02:11+00:00",
"sku": "12-345-6789",
"comment": null,
"warehouse_id": "2",
"entity_id": "100000001",
"location": "Packing Station 3",
"parent_type": "batch",
"parent_id": "512",
"adjustment_reason_code": null,
"hold_reason_code": null,
"hold": null
}
],
"totalCount": 3,
"numPages": 1
},
"id": "1",
"jsonrpc": "2.0"
}
Error Codes
| code | message |
|---|---|
| 101 | Invalid filters given. Details in error message. |
Entity Properties
Stock Movement Properties
Show Stock Movement Properties
Show Stock Movement Properties
string
The internal stock movement ID.
string
The “Type” property. Allowed values: “delivery”, “order”, “work_order”, “stock”, “relocation”, “hold”.
string
The “Action” property. Allowed values: “create”, “edit”, “cancel”, “void”, “adjust”, “process”, “unprocess”, “putaway”, “commit”, “transfer”, “pack”, “unpack”, “ship”, “unship”, “pick”, “unpick”, “relocate”, “pull”, “push”, “convert”, “allocate”, “deallocate”, “correction”, “assemble”, “disassemble”, “revert”, “hold”, “release”.
pack and unpack record packing and its reversal; packed inventory stays on hand. ship and unship record a shipment leaving the warehouse (all of its packages shipped, for example by a loaded manifest, carrier tracking, a user or API request, or automatically when the shipment is still packed a configured number of days after packing) and its return to Packed; on hand decreases or increases accordingly.string
The “Entity ID” property.
string
The internal product ID.
string
The “Product SKU” property.
string
The internal warehouse ID.
string
The “Expected” qty.
string
The “Processed” qty.
string
The “Put-Away” qty.
string
The “Available” qty.
string
The “Allocated” qty.
string
The “Reserved” qty.
string
The “Picked” qty.
string | null
The change in the “Packed” qty: packed in the warehouse and still on hand, waiting to ship. Positive on
pack and unship rows, negative on unpack and ship rows, and also set on cancel, revert and void rows for packed shipments. Null on rows that do not change packed inventory.string | null
The change in the “Shipped” qty: inventory that has left the warehouse. Positive on
ship rows and negative on unship rows, and also set on cancel, revert and void rows for shipments that have already shipped. Null on rows that do not change shipped inventory.string
The “Backordered” qty.
string | null
The “Held” qty. Populated on movements that affect held quantity; otherwise null.
string
The “Timestamp” property.
string
The “Comment” property.
string
The “Location” property. On
pack and unpack rows, this is the Packing Station name. On ship and unship rows, it is the Load Location of the manifest of the shipment’s most recently shipped manifested package. These names are truncated to 45 characters, are empty when no Packing Station or manifest applies, and do not refer to shelf Locations.string | null
The type of the parent record the movement belongs to:
batch (Picking Batch), fulfill (Bulk Fulfill Order) or putaway (Put-Away, for example on cancellation movements). Null when there is no parent.string | null
The internal ID of the parent record identified by
parent_type, or null.string | null
The code of the structured Adjustment Reason recorded when an inventory adjustment was made (for example, a cycle count or manual correction). Allowed values: “cycle_count”, “found”, “shrinkage”, “damaged”, “defective”, “expired”, “destroyed”, “receiving_error”, “shipping_error”, “customer_return”, “sample”, “other”.
string | null
The rolled-up parent reason code for the movement’s governing hold. User-defined reasons roll up to their parent system code (for example, a custom “Merchant Review” reason reports its parent “qc_inspection”). Null when the movement has no governing hold. Filterable through the
hold_reason_code filter using the standard filter operators.object | null
Hold detail for the movement’s governing hold; null when the movement has no governing hold.
Show hold
Show hold
string | null
The scope recorded on the movement’s hold. Movement-producing holds currently use
location; lot-scope sentinel holds do not create movement rows.integer | null
The internal lot ID recorded on the hold, or null when the held location is not associated with a lot.
integer | null
The internal parent hold ID, or null for a direct location hold. This can reference a lot-scope sentinel that has no stock movement row, so it provides partial relationship metadata and does not guarantee that the complete hold tree can be reconstructed from this endpoint.
object | null
The specific hold reason applied to the movement. Null if the reason could not be resolved.
Show reason
Show reason
string | null
The exact hold reason code applied. This is the child reason and can differ from the top-level
hold_reason_code, which rolls up to the parent system code.string | null
The human-readable name of the hold reason.
string
The hold group the reason belongs to — one of the canonical English tokens (“Hold”, “Review”, “Expired”, “Unsellable”) or a custom group.