v54

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-01594762.7 KB
Warehouses

List all warehouses

Lists all warehouses set up in your store.

Permissions

Any user or API key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:

ProductCategoryResource
LogisticsLogistics accessLogistics full access
LogisticsLogistics accessLogistics viewer

You can create a custom role with that resource or use one of the following predefined roles:

RoleResource
Logistics - Full accessLogistics full access
OMS - Full accessLogistics full access
Logistics - Full accessLogistics viewer
Logistics - Read onlyLogistics viewer

❗ Assigning a predefined role to users or application keys usually grants permission to multiple License Manager resources. If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see Best practices for using application keys. To learn more about machine authentication at VTEX, see Authentication overview.

get/api/logistics/pvt/configuration/warehouses

Headers

Content-Typestring required

Type of the content being sent.

Acceptstring required

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Response

OK

idstring

Warehouse ID.

namestring

Warehouse name.

pickupPointIdsstring[]

List of pickup points associated with the warehouse.

priorityinteger

Warehouse priority. When no priority was set, it corresponds to 0.

isActiveboolean

Shows if the warehouse is active (true) or inactive (false).