List Warehouses

Use the list warehouses request to retrieve your warehouse_id and the related properties at any point after you have created your warehouses in ShipEngine.

List Warehouses Request & Response

GET /v1/warehouses

1
2
3
GET /v1/warehouses HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
{
  "warehouses": [
  {
      "warehouse_id": "se-277331",
      "name": "Example Corp. East Warehouse",
      "created_at": "2017-03-15T17:20:19.353Z",
      "origin_address": {
        "company_name": "Example Corp.",
        "name": "John Doe",
        "phone": "111-111-1111",
        "email": "[email protected]",
        "address_line1": "4009 Marathon Blvd",
        "address_line2": "Suite 300",
        "city_locality": "Austin",
        "state_province": "TX",
        "postal_code": "78756",
        "country_code": "US",
        "address_residential_indicator": "no"
      },
      "return_address": {
        "company_name": "Example Corp.",
        "name": "John Doe",
        "phone": "111-111-1111",
        "email": "[email protected]",
        "address_line1": "4009 Marathon Blvd",
        "address_line2": "Suite 300",
        "city_locality": "Austin",
        "state_province": "TX",
        "postal_code": "78756",
        "country_code": "US",
        "address_residential_indicator": "no"
      }
    }
  ]
}

Get Warehouse by ID

If you need the properties of a specific warehouse, you can add the warehouse_id as a parameter to the warehouses endpoint.

Requirements

You will need the warehouse_id for the warehouse details you wish to retrieve.

Example Request & Response

GET /v1/warehouses/:warehouse_id

1
2
3
GET /v1/warehouses/se-277331 HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
{
  "warehouse_id": "se-277331",
  "name": "Example Corp. East Warehouse",
  "created_at": "2018-02-12T23:48:15.387Z",
  "origin_address": {
    "company_name": "Example Corp.",
    "name": "John Doe",
    "phone": "111-111-1111",
    "email": "[email protected]",
    "address_line1": "4009 Marathon Blvd",
    "address_line2": "Suite 300",
    "city_locality": "Austin",
    "state_province": "TX",
    "postal_code": "78756",
    "country_code": "US",
    "address_residential_indicator": "no"
  },
  "return_address": {
    "company_name": "Example Corp.",
    "name": "John Doe",
    "phone": "111-111-1111",
    "email": "[email protected]",
    "address_line1": "4009 Marathon Blvd",
    "address_line2": "Suite 300",
    "city_locality": "Austin",
    "state_province": "TX",
    "postal_code": "78756",
    "country_code": "US",
    "address_residential_indicator": "no"
  }
}