🎉ShipEngine is becoming ShipStation API🎉

Over the next few months you'll notice the ShipEngine website, documentation portal, and dashboard being rebranded as ShipStation API. For our ShipEngine customers, you don't need to take any action or change any of your integrations in any way. All endpoints will remain the same and continue to function as they always have.

To learn more about what's coming, review our New ShipStation API page.

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 ShipStation API.

List Warehouses Request & Response

GET /v1/warehouses

1
2
3

GET /v1/warehouses HTTP/1.1

Response

{
  "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": "recipient@example.com",\
        "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": "sender@example.com",\
        "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

Response

{
  "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": "recipient@example.com",
    "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": "sender@example.com",
    "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"
  }
}