跳转到主要内容
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>"
    }
  ]
}
此页面由 AI 自动翻译。API 技术规格以英文呈现为标准。如有任何疑问,请参阅英文版本
列出您账户可访问的所有仓库,包含地址、联系方式与能力元数据。多数集成在初始化时调用一次,以将仓库映射到显示名称,并取得 API 中其他位置所需的 warehouseId 请注意:生产环境与沙盒环境的 warehouseId 并不相同

何时调用

  • 集成初始化时,用于在卖家界面填充仓库选择器。
  • 当您账户被授权访问新仓库时(例如开通新区域),用于刷新本地缓存。

响应说明

  • countryCode小写 ISO3 形式返回(例如 usagbrchn)。请使用这些值填充 shipFromCountryfromCountryCode 等字段。
  • 完整地址(street1street2street3citystatepostalCode)会一并返回,可用于在退件单或客户面单上预填收件信息。
  • description 是可读名称,可能会变更。请将 warehouseId(整数)作为本地数据库的稳定主键。

相关

授权

x-rr-apikey
string
header
必填

Your API key

x-rr-apitoken
string
header
必填

Your API token — keep this private

响应

Success

data
object[]

List of visible warehouses