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,
            "address": {
                "street1": "4616 Crossroads Park Dr",
                "street2": "",
                "city": "Liverpool",
                "country": "US",
                "region": "NY",
                "postcode": "13088"
            }
        },
        {
            "warehouse_id" : 2,
            "name" : "Warehouse 2",
            "is_active": 1,
            "address": {
                "street1": "3900 Produce Rd",
                "street2": "",
                "city": "Louisville",
                "country": "US",
                "region": "KY",
                "postcode": "40218"
            }
        }
    ]
}

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.
address 
{ "address" : { "street1": "3900 Produce Rd", "street2": "", "city": "Louisville", "country": "US", "region": "KY", "postcode": "40218" }}
The address of the warehouse. Details.

Warehouse Address Properties

street1 
{ "street1" : "3900 Produce Rd" }
The street address. First Line
street2 
{ "street2" : "# 61157" }
The street address. Second Line
city 
{ "city" : "Liverpool" }
The city.
country 
{ "country" : "GB" }
The country code ISO 3166-1.
region 
{ "region" : "KY" }
The region code ISO 3166-2.
postcode 
{ "postcode" : "40218" }
The "Postal Code" property. Pass as a string to prevent leading 0s from being dropped.