Sign in

v54

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

Create or update warehouse

Creates or updates a warehouse.

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

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

❗ 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.

post/api/logistics/pvt/configuration/warehouses

Headers

Acceptstring required

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

Content-Typestring required

Type of the content being sent.

Request body

idstring required

Warehouse ID.

namestring required

Warehouse name.

priorityinteger

Optional configuration of the warehouse priority. When no priority was set, it corresponds to 0.

isActiveboolean

Defines if the warehous is active (true) or not (false).

Example request

{
  "id": "15bfc76",
  "name": "Main warehouse",
  "warehouseDocks": [
    {
      "dockId": "1a8bce3",
      "name": "Central dock",
      "time": "3.00:00:00",
      "cost": "5.00",
      "translateDays": "days",
      "costToDisplay": "5,00"
    }
  ],
  "isActive": true
}

Response

OK