> ## Documentation Index
> Fetch the complete documentation index at: https://apidocs.returnhelper.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get all warehouses accessible to user

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.

## Related

* [Get warehouses by origin country](/api-reference/warehouse/get-warehouses-by-origin-country) — same data filtered to a specific origin country.
* [Get warehouse details by ID](/api-reference/warehouse/get-warehouse-details-by-id-1) — fetch a single warehouse record by `warehouseId`.


## OpenAPI

````yaml get /api/Warehouse/GetAllWarehouse
openapi: 3.1.0
info:
  title: Return Helper API
  description: API documentation for Return Helper — covering User and Public endpoints.
  version: 1.0.0
servers:
  - url: https://api.returnshelper.com/uat/user
    description: Sandbox — User API
  - url: https://api.returnshelper.com/uat/public
    description: Sandbox — Public API
  - url: https://api.returnhelpercentre.com/v1/user
    description: Production — User API
  - url: https://api.returnhelpercentre.com/v1/public
    description: Production — Public API
  - url: https://api.returnhelperchina.com/user
    description: Production — User API (China)
security:
  - ApiKey: []
    ApiToken: []
paths:
  /api/Warehouse/GetAllWarehouse:
    get:
      tags:
        - Warehouse
      summary: Get all warehouses accessible to user
      operationId: ReturnUserApi_GetAllWarehouse
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralList_WarehouseResponse'
        '401':
          description: >-
            Authentication failed. Returned when the `x-rr-apikey` or
            `x-rr-apitoken` header is missing or invalid. The body uses the
            standard `ApiResponse` envelope with `meta.error.message` describing
            the auth failure.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      security:
        - ApiKey: []
          ApiToken: []
      servers:
        - url: https://api.returnshelper.com/uat/user
          description: Sandbox — User API
components:
  schemas:
    GeneralList_WarehouseResponse:
      type: object
      properties:
        warehouses:
          type: array
          items:
            $ref: '#/components/schemas/WarehouseResponse'
          description: List of warehouses
    ApiResponse:
      type: object
      description: >-
        Universal response envelope. Successful responses include the business
        payload as additional top-level fields alongside `correlationId` and
        `meta`. Failed responses (auth errors, validation errors) only populate
        `correlationId` and `meta`, with `meta.errorCode` and `meta.error`
        describing the failure.
      properties:
        correlationId:
          type:
            - string
            - 'null'
          description: >-
            Unique correlation ID for tracing the request through Return Helper
            systems.
        meta:
          $ref: '#/components/schemas/ApiResponseMeta'
    WarehouseResponse:
      type: object
      properties:
        warehouseId:
          type: integer
          format: int32
          description: Warehouse unique identifier
        countryCode:
          type:
            - string
            - 'null'
          description: Lowercase ISO3 country code (e.g. "usa")
        contactName:
          type:
            - string
            - 'null'
          description: Contact name
        companyName:
          type:
            - string
            - 'null'
          description: Company name
        phone:
          type:
            - string
            - 'null'
          description: Phone number
        email:
          type:
            - string
            - 'null'
          description: Email address
        fax:
          type:
            - string
            - 'null'
          description: Fax number
        street1:
          type:
            - string
            - 'null'
          description: Address line 1
        street2:
          type:
            - string
            - 'null'
          description: Address line 2
        street3:
          type:
            - string
            - 'null'
          description: Address line 3
        state:
          type:
            - string
            - 'null'
          description: State / province
        city:
          type:
            - string
            - 'null'
          description: City
        postalCode:
          type:
            - string
            - 'null'
          description: Postal code
        addressType:
          type:
            - string
            - 'null'
          description: Address type
        description:
          type:
            - string
            - 'null'
          description: >-
            Free-text warehouse description. There is no separate warehouseName
            field — use warehouseId as the stable reference key.
        warehouseRmaPrefix:
          type:
            - string
            - 'null'
          description: Warehouse RMA prefix used in inbound parcel identifiers
    ApiResponseMeta:
      type: object
      description: >-
        Application-level metadata for every API response. Inspect `status` and
        `errorCode` to detect soft-error responses (validation failures arrive
        as HTTP 200 with `meta.status: 400`).
      properties:
        status:
          type: integer
          description: >-
            Application-level status code. For successful operations this
            mirrors the HTTP status (e.g. 200). For validation failures it
            reports the logical status (e.g. 400) even though the wire HTTP
            status is 200.
        data:
          type: object
          additionalProperties:
            type: string
          description: Reserved free-form metadata key/value pairs. Usually empty.
        errorCode:
          type:
            - string
            - 'null'
          description: >-
            Machine-readable error code (e.g. `VALIDATION_FAILED`). Non-null
            only when the operation failed.
        error:
          type: object
          additionalProperties: true
          description: >-
            Field-level or message-level error detail keyed by request property
            name. Empty object on success.
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: x-rr-apikey
      description: Your API key
    ApiToken:
      type: apiKey
      in: header
      name: x-rr-apitoken
      description: Your API token — keep this private

````