> ## Documentation Index
> Fetch the complete documentation index at: https://docs.shipstream.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Stock Movements

Stock Movements record every change to inventory items such as when an order is received and allocated to a warehouse or a shipment is picked from the shelf.

## Methods

* [stock\_movement.list](#stock-movement-list)

***

## Entity Properties

* [Stock Movement](#stock-movement-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

**filters** `object | null`

[Filters](https://docs.shipstream.io/merchant-api/search-filters.md) 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`.

**options** `object | null`

[Options](https://docs.shipstream.io/merchant-api/search-options.md) to apply to the request.

### Return Value

An array of [Stock Movements](#stock-movement-properties) or an empty array.

### Example Request

Get all stock movements:

```json title="Request" theme={null}
{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "method" : "call",
    "params" : [
        "be1c13ed4e03f0ed7f1e4053dfff9658",
        "stock_movement.list"
    ]
}
```

Get all stock movements for warehouse "2":

```json title="Request" theme={null}
{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "method" : "call",
    "params" : [
        "be1c13ed4e03f0ed7f1e4053dfff9658",
        "stock_movement.list",
        [
            {
                "warehouse_id": {
                    "eq": "2"
                }
            }
        ]
    ]
}
```

### Example Response

```json title="Response" theme={null}
{
    "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

**Stock Movement Properties**

**id** `string`

The internal stock movement ID.

**entity\_type** `string`

The "Type" property. Allowed values: "delivery", "order", "work\_order", "stock", "relocation", "hold".

**entity\_action** `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.

**entity\_id** `string`

The "Entity ID" property.

**product\_id** `string`

The internal product ID.

**sku** `string`

The "Product SKU" property.

**warehouse\_id** `string`

The internal warehouse ID.

**qty\_expected** `string`

The "Expected" qty.

**qty\_processed** `string`

The "Processed" qty.

**qty\_putaway** `string`

The "Put-Away" qty.

**qty\_available** `string`

The "Available" qty.

**qty\_allocated** `string`

The "Allocated" qty.

**qty\_reserved** `string`

The "Reserved" qty.

**qty\_picked** `string`

The "Picked" qty.

**qty\_packed** `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.

**qty\_shipped** `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.

**qty\_backordered** `string`

The "Backordered" qty.

**qty\_held** `string | null`

The "Held" qty. Populated on movements that affect held quantity; otherwise null.

**created\_at** `string`

The "Timestamp" property.

**comment** `string`

The "Comment" property.

**location** `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.

**parent\_type** `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.

**parent\_id** `string | null`

The internal ID of the parent record identified by `parent_type`, or null.

**adjustment\_reason\_code** `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".

**hold\_reason\_code** `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.

**hold** `object | null`

Hold detail for the movement's governing hold; null when the movement has no governing hold.

**hold**

**scope\_type** `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.

**lot\_id** `integer | null`

The internal lot ID recorded on the hold, or null when the held location is not associated with a lot.

**parent\_hold\_id** `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.

**reason** `object | null`

The specific hold reason applied to the movement. Null if the reason could not be resolved.

**reason**

**code** `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.

**label** `string | null`

The human-readable name of the hold reason.

**display\_group** `string`

The hold group the reason belongs to — one of the canonical English tokens ("Hold", "Review", "Expired", "Unsellable") or a custom group.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.