Skip to main content
GET
/
api
/
Warehouse
/
GetAllWarehouse
Get all warehouses accessible to user
curl --request GET \
  --url https://api.returnshelper.com/uat/user/api/Warehouse/GetAllWarehouse \
  --header 'x-rr-apikey: <api-key>' \
  --header 'x-rr-apitoken: <api-key>'
{
  "data": [
    {
      "warehouseId": 123,
      "warehouseName": "<string>"
    }
  ]
}
Lists every warehouse your account has access to, including address, contact details, and capability metadata. Most integrations call this once during setup to map warehouses to display names and to discover the warehouseId values needed elsewhere in the API. Please be reminded that the warehouseId in production and sandbox environment are NOT the same.

​
When to call

  • During integration setup, to populate a warehouse picker in your seller-facing UI.
  • After your account is granted access to a new warehouse (e.g. during onboarding to a new region), to refresh your local cache.

​
Response notes

  • countryCode is returned in lowercase ISO3 (e.g. usa, gbr, chn). Use these exact values when populating shipFromCountry or fromCountryCode fields elsewhere.
  • The full address (street1, street2, street3, city, state, postalCode) is exposed so you can pre-fill destination details on return slips and customer-facing labels.
  • description is a human-readable name and may change. Treat warehouseId (integer) as the stable reference key in your database.

Authorizations

​
x-rr-apikey
string
header
required

Your API key

​
x-rr-apitoken
string
header
required

Your API token — keep this private

Response

Success

​
data
object[]

List of visible warehouses