v54

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

Docks

List all docks

Retrieves information about all loading docks of 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:

Product	Category	Resource
Logistics	Logistics access	Logistics full access
Logistics	Logistics access	Logistics viewer

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

Role	Resource
Logistics - Full access	Logistics full access
OMS - Full access	Logistics full access
Logistics - Full access	Logistics viewer
Logistics - Read only	Logistics 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/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.

Response

storeIdstring nullable

Store ID.

shippingRatesProvidersstring[] nullable

Shipping rates providers information.

deliveryAgreementsIdsstring[] nullable

Delivery agreements IDs information.

idstring

Loading dock ID.

namestring

Loading dock name.

priorityinteger

Value from 0 to 10 used as a tie-breaking rule for loading dock selecting. The greater the priority, the greater the possibility of the loading dock being chosen in shipping calculation. When no priority was set, it corresponds to 0.

dockTimeFakestring

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

timeFakeOverheadstring

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[]

Sales channels (trade policies) associated with the loading dock.

salesChannelstring

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

freightTableIdsstring[]

List with freight table IDs associated with the loading dock.

wmsEndPointstring nullable

Endpoint for integrating an external Warehouse Management System (WMS).

isActiveboolean

Defines if the loading dock is active (true) or inactive (false).