Skip to main content
GET
Get warehouse by ID

Authorizations

Authorization
string
header
required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Path Parameters

warehouseId
integer
required

Warehouse ID

Response

Successful response

id
integer

Warehouse ID

status
string | null

Warehouse status (e.g. active, inactive)

name
string

Warehouse name

address
string | null

Street address

street_address_1
string | null

Street address line 1

street_address_2
string | null

Street address line 2

city
string | null

City

state
string | null

State/province

zip
string | null

Postal/ZIP code

country
string | null

Country

is_pick_location
boolean

Whether this warehouse is a pick location

return_name
string | null

Return-address name/company. Optional return address printed on carrier labels (currently ParcelPerform) for orders shipped from this warehouse. The override applies when return_name or return_street_address_1 is set; any blank field falls back to the ship-from address. A warehouse group's return address takes precedence.

return_street_address_1
string | null

Return-address street line 1

return_street_address_2
string | null

Return-address street line 2

return_city
string | null

Return-address city

return_state
string | null

Return-address state/province

return_zip
string | null

Return-address postal/ZIP code

return_country
string | null

Return-address country

return_phone
string | null

Return-address phone

return_email
string<email> | null

Return-address email

created_at
string<date-time>

When the warehouse was created

updated_at
string<date-time>

When the warehouse was last updated