Warehouse

Methods

Entity Properties

ShipStream supports multiple warehouses. Use this API endpoint to retrieve your list of warehouses.

warehouse.list ()

Retrieve warehouses list.

Parameters

The method is used without parameters.

Return Value

An array of objects with warehouse information.

Example Request

Retrieve warehouses information:

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "method" : "call",
    "params" : [
        "be1c13ed4e03f0ed7f1e4053dfff9658",
        "warehouse.list",
        []
    ]
}

Example Response

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "error" : null,
    "result" : [
        {
            "warehouse_id" : 1,
            "name" : "Warehouse 1",
            "is_active" : 1
        },
        {
            "warehouse_id" : 2,
            "name" : "Warehouse 2",
            "is_active" : 1
        }
    ]
}

Warehouse Properties

warehouse_id 
{ "warehouse_id" : 1 }
The internal warehouse ID.
name 
{ "name" : "Warehouse 1" }
The "Name" property.
is_active 
{ "is_active" : 1 }
Flag whether warehouse is active.