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

Entity Properties

Stock Movement

`stock_movement.list`

stock_movement.list (null|object $filters, null|object $options) Retrieve list of stock movements.

Parameters

filters

object | null

Filters to apply to the request. Allowed properties for filtering: “id”, “entity_type”, “entity_action”, “entity_id”, “product_id”, “sku”, “created_at”, “warehouse_id”, “location”, “adjustment_reason_code”

options

object | null

Options to apply to the request.

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"
    ]
}

Get all stock movements for warehouse “2”:

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_backordered": null,
                "created_at": "2022-09-12T19:47:50+00:00",
                "sku": "12-345-6789",
                "comment": null,
                "warehouse_id": "2",
                "entity_id": "100000001",
                "location": "",
                "adjustment_reason_code": null
            }
        ],
        "totalCount": 1,
        "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

string

The internal stock movement ID.

entity_type

string

The “Type” property. Allowed values: “delivery”, “order”, “work_order”, “stock”, “relocation”.

entity_action

string

The “Action” property. Allowed values: “create”, “edit”, “cancel”, “void”, “adjust”, “process”, “unprocess”, “putaway”, “commit”, “transfer”, “ship”, “unship”, “pick”, “unpick”, “relocate”, “pull”, “push”, “convert”, “allocate”, “deallocate”, “correction”, “assemble”.

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 expected qty.

qty_backordered

string

The “Backordered” qty.

created_at

string

The “Timestamp” property.

comment

string

The “Comment” property.

location

string

The “Location” property.

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”.

Get Started

Common Features

Shipping

Receiving

Inventory

System

Methods

Entity Properties

`stock_movement.list`

Parameters

Return Value

Example Request

Example Response

Error Codes

Entity Properties

Stock Movement Properties

​Methods

​Entity Properties

​stock_movement.list

​Parameters

​Return Value

​Example Request

​Example Response

​Error Codes

​Entity Properties

​Stock Movement Properties

Methods

Entity Properties

`stock_movement.list`

Parameters

Return Value

Example Request

Example Response

Error Codes

Entity Properties

Stock Movement Properties