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.
ShipStream supports multiple warehouses. Use this API endpoint to retrieve your list of warehouses.
Methods
Entity Properties
warehouse.list
warehouse.list()
Retrieve warehouses list.
Parameters
The method is used without parameters.
Return Value
An array of objects with warehouse information.
Example Request
{
"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"
}
}
]
}
Entity Properties
Warehouse Properties
Show Warehouse Properties
The internal warehouse ID.
Flag whether warehouse is active.
The address of the warehouse. Details. Warehouse Address Properties
Show Warehouse Address Properties
The street address. First Line
The street address. Second Line
The country code ISO 3166-1.
The region code ISO 3166-2.
The “Postal Code” property. Pass as a string to prevent leading 0s from being dropped.
