v54

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

Create or update dock

Creates a new loading dock or updates an existing one for your store's shipping strategy.

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/docks

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.

Request body

idstring required
namestring required

Loading dock name.

priorityinteger required

Value used as a tie-breaking rule when selecting a loading dock.

dockTimeFakestring required

Loading dock processing time in the format D.HH:MM:SS. When not configured, it returns 00:00:00.

timeFakeOverheadstring required

Time frame used to choose a loading dock when there is more than one loading dock with the same processing time. The lower the value entered in this field, the greater the possibility of the loading dock being chosen.

ℹ️ This field is not considered when calculating the delivery time.

salesChannelsstring[] required

Sales channels (trade policies) to associate with the loading dock.

salesChannelstring required

Main sales channel (trade policy) to associate with the loading dock.

freightTableIdsstring[] required

List with freight table IDs.

wmsEndPointstring nullable required

Warehouse Management System (WMS) fulfillment endpoint.

Example request

{
  "id": "1a8bce3",
  "name": "Catete dock_3",
  "dockTimeFake": "00:00:00",
  "timeFakeOverhead": "00:00:00",
  "salesChannels": [
    "3"
  ],
  "salesChannel": "1",
  "freightTableIds": [
    "11cc4b6"
  ],
  "address": {
    "postalCode": "02220070",
    "country": {
      "acronym": "BRA",
      "name": "Brazil"
    },
    "city": "Rio de Janeiro",
    "state": "RJ",
    "neighborhood": "Catete",
    "street": "Artur Bernardes Street",
    "number": "100",
    "complement": "apartment",
    "coordinates": [
      [
        -34.82939147949219,
        -7.115228652954102
      ]
    ]
  }
}

Response

OK

boolean required

Successful requests return the message true.