> ## 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. # 获取所有可访问的 Warehouses 此页面由 AI 自动翻译。API 技术规格以英文呈现为标准。如有任何疑问，请参阅[英文版本](/api-reference/warehouse/get-all-warehouses-accessible-to-user)。 列出您账户可访问的所有仓库，包含地址、联系方式与能力元数据。多数集成在初始化时调用一次，以将仓库映射到显示名称，并取得 API 中其他位置所需的 `warehouseId`。 请注意：生产环境与沙盒环境的 `warehouseId` **并不相同**。 ## 何时调用 * 集成初始化时，用于在卖家界面填充仓库选择器。 * 当您账户被授权访问新仓库时（例如开通新区域），用于刷新本地缓存。 ## 响应说明 * `countryCode` 以**小写 ISO3** 形式返回（例如 `usa`、`gbr`、`chn`）。请使用这些值填充 `shipFromCountry` 或 `fromCountryCode` 等字段。 * 完整地址（`street1`、`street2`、`street3`、`city`、`state`、`postalCode`）会一并返回，可用于在退件单或客户面单上预填收件信息。 * `description` 是可读名称，可能会变更。请将 `warehouseId`（整数）作为本地数据库的稳定主键。 ## 相关 * [按始发国家取得仓库](/zh-Hans/api-reference/warehouse/get-warehouses-by-origin-country) — 同样数据，按指定始发国家筛选。 * [按 ID 取得仓库详情](/zh-Hans/api-reference/warehouse/get-warehouse-details-by-id-1) — 按 `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 ````