メインコンテンツへスキップ
GET
Get all warehouses accessible to user
このページはAIによって自動翻訳されています。API技術仕様は英語が正式です。不明点がある場合は英語版を参照してください。
アカウントがアクセスできるすべての倉庫を、住所・連絡先・対応能力のメタデータと共に一覧表示します。多くの統合では、セットアップ時に一度呼び出して、倉庫を表示名へマッピングし、API 全体で必要となる warehouseId を取得します。 ご注意:本番環境とサンドボックス環境の warehouseId は 同一ではありません。

呼び出すタイミング

  • 統合のセットアップ時に、セラー向け UI の倉庫ピッカーを設定するため。
  • アカウントが新しい倉庫へのアクセス権を付与された後(例:新地域の立ち上げ時)、ローカルキャッシュを更新するため。

レスポンスの注意

  • countryCode は 小文字 ISO3(例:usa、gbr、chn)で返されます。shipFromCountry や fromCountryCode などのフィールドにはこの値を使用してください。
  • 完全な住所(street1、street2、street3、city、state、postalCode)が公開されているため、返品伝票や顧客向けラベルに宛先情報を事前入力できます。
  • description は可読名称で、変更される可能性があります。データベース上の安定参照キーとしては warehouseId(整数)を使用してください。
  • isConsolidateShippingDestination が true の倉庫は、RH_WAREHOUSE の Consolidate Shipping Order の destinationWarehouseId として使用できます。

関連

承認

x-rr-apikey
string
header
必須

Your API key

x-rr-apitoken
string
header
必須

Your API token — keep this private

レスポンス

Success

warehouses
object[]

List of warehouses