--- title: "List dock by ID" method: GET path: "/api/logistics/pvt/configuration/docks/{dockId}" tags: ["Docks"] --- # List dock by ID `GET /api/logistics/pvt/configuration/docks/{dockId}` Retrieves information about a [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) of your store's [shipping strategy](https://help.vtex.com/en/tutorial/shipping-strategy--58vLBDbjYVQzJ6rRc5QNz3), searching by dock ID. ## Permissions Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy): | **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](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). 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](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication). ## Path parameters - `dockId` string, required ## Headers - `Content-Type` string, required - `Accept` string, required ## Response `200` OK - ListDocksById — Loading dock information. - `pickupStoreInfo` object — Information about a loading dock that was transformed into a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R). - `isPickupStore` boolean, nullable — Defines if the shipping type was pickup (`true`) or not (`false`). - `storeId` string, nullable — Store ID for stores that acted as pickup points. - `friendlyName` string, nullable — Name of the pickup point displayed at checkout. - `address` object, nullable — Pickup point address information. - `postalCode` string — Pickup point address postal code. - `country` object — Information about the pickup point address country. - `acronym` string — Three-digit country code of the pickup point address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format. - `name` string — Country name of the pickup point address. - `city` string — Pickup point address city. - `state` string — Pickup point address state. - `neighborhood` string — Pickup point address neighborhood. - `street` string — Pickup point address street. - `number` string — Pickup point address number. - `complement` string, nullable — Pickup point address complement. - `reference` string, nullable — Pickup point address reference point. - `location` object — Pickup point address geolocation coordinates. - `latitude` number — Latitude coordinate. - `longitude` number — Longitude coordinate. - `additionalInfo` string, nullable — Additional information about the delivery or the pickup point. - `dockId` string, nullable — ID of the [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj related to the delivery or the pickup point ID. - `distance` number, nullable — Distance in kilometers between the pickup point and the customer's address, measured as a straight line. - `businessHours` string, nullable — Pickup point business hours configurations. - `pickupHolidays` string, nullable — Holiday's configurations applicable to the pickup point. - `sellerId` string, nullable — Seller ID. - `isThirdPartyPickup` boolean — Defines if the pickup was third party (`true`) or not (`false`). - `storeId` string, nullable — Store ID. - `pickupInStoreInfo` object — Information about the physical store as a pickup point. - `isActice` boolean — Defines if the physical store is a pickup point (`true`) or not (`false`). - `additionalInfo` string, nullable — Additional information of the store as a pickup point. - `deliveryFromStoreInfo` object — Settings for delivery from a physical store. - `isActice` boolean — Defines if the settings for delivery from physical stores are active (`true`) or inactive (`false`). - `deliveryRadius` number — Delivery radius. - `deliveryFee` number — Delivery fee. - `deliveryTime` string — Delivery time in the format `DD.HH:MM:SS`. - `maximumWeight` number — Delivery maximum weight. - `address` object — Loading dock address. - `postalCode` string — Loading dock address postal code. - `country` object — Information about the loading dock address country. - `acronym` string — Three-digit country code of the loading dock address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format. - `name` string — Country name of the loading dock address. - `city` string — Loading dock address city. - `state` string — Loading dock address state. - `neighborhood` string — Loading dock address neighborhood. - `street` string — Loading dock address street. - `number` string — Loading dock address number. - `complement` string, nullable — Loading dock address complement. - `reference` string, nullable — Loading dock address reference point. - `location` object — Loading dock address geolocation coordinates. - `latitude` number — Latitude coordinate. - `longitude` number — Longitude coordinate. - `location` object, nullable — Loading dock location details. - `zipCode` string — Loading dock address postal code. - `country` string — Three-digit country code of the loading dock address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format. - `inStore` object — Information related to orders made via [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc). - `IsCheckedIn` boolean — Defines if orders can be placed via [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc) (`true`) or not (`false`). - `StoreId` string, nullable — ID of purchases made in the GoCommerce context. - `shippingRatesProviders` string[], nullable — Shipping rates providers information. - `deliveryAgreementsIds` string[], nullable — Delivery agreements IDs information. - `id` string — [Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID. - `name` string — Loading dock name. - `priority` integer — 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](https://help.vtex.com/en/tutorial/how-shipping-calculation-works--tutorials_116). When no priority was set, it corresponds to `0`. - `dockTimeFake` string — [Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) processing time in the format `D.HH:MM:SS`. When not configured, it returns `00:00:00`. - `timeFakeOverhead` string — 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. - `salesChannels` string[] — Sales channels ([trade policies](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) associated with the loading dock. - `salesChannel` string — Main sales channel ([trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) associated with the loading dock. - `freightTableIds` string[] — List with freight table IDs associated with the loading dock. - `wmsEndPoint` string, nullable — Endpoint for integrating an external Warehouse Management System (WMS). - `isActive` boolean — Defines if the loading dock is active (`true`) or inactive (`false`). --- [API](https://skmtc.net/vtex/apis/logistics-api.md) · [All operations](https://skmtc.net/vtex/apis/logistics-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vtex/logistics-api/revisions/c08af805d8b3/schema)