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

# Warehouse

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

## Methods

* [warehouse.list](#warehouse-list)

***

## Entity Properties

* [Warehouse](#warehouse-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

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

### Example Response

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

<Expandable title="Warehouse Properties">
  <ParamField path="warehouse_id" type="integer">
    The internal warehouse ID.
  </ParamField>

  <ParamField path="name" type="string">
    The "Name" property.
  </ParamField>

  <ParamField path="is_active" type="integer">
    Flag whether warehouse is active.
  </ParamField>

  <ParamField path="address" type="object">
    The address of the warehouse. [Details](#warehouse-address-properties).
  </ParamField>
</Expandable>

### Warehouse Address Properties

<Expandable title="Warehouse Address Properties">
  <ParamField path="street1" type="string">
    The street address. First Line
  </ParamField>

  <ParamField path="street2" type="string">
    The street address. Second Line
  </ParamField>

  <ParamField path="city" type="string">
    The city.
  </ParamField>

  <ParamField path="country" type="string">
    The country code ISO 3166-1.
  </ParamField>

  <ParamField path="region" type="string">
    The region code ISO 3166-2.
  </ParamField>

  <ParamField path="postcode" type="string">
    The "Postal Code" property. Pass as a string to prevent leading 0s from being dropped.
  </ParamField>
</Expandable>