跳轉到主要內容
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