--- title: "List shipping policies" method: GET path: "/api/logistics/pvt/shipping-policies" tags: ["Shipping policies"] --- # List shipping policies `GET /api/logistics/pvt/shipping-policies` Lists all [shipping policies](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) from your store. >⚠️ While most endpoints return time fields in UTC format, this endpoint returns **Scheduled Delivery** related time fields adjusted to the time zone configured for the VTEX account. ## 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** | | Logistics | Logistics access | **Logistics shipping full access** | 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 | | Logistics - Full access | Logistics shipping full access | | OMS - Full access | Logistics shipping full access | >❗ 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). ## Query parameters - `page` integer - `perPage` integer ## Headers - `Accept` string, required - `Content-Type` string, required ## Response `200` OK - object — Paged shipping policies list. - `items` ShippingPolicy[] — List of shipping policies related to the account. - `id` string — [Shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) ID. - `name` string — [Shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) name. - `shippingMethod` string — Type of shipping available for this shipping policy (carrier). Options are shown on [shipping simulation](https://help.vtex.com/en/tutorial/shipping-simulation--tutorials_144). - `weekendAndHolidays` object — If the shipping policy includes deliveries on weekends and holidays. - `saturday` boolean — Defines if shipping on Saturdays is valid (`true`) or not (`false`). - `sunday` boolean — Defines if shipping on Sundays is valid (`true`) or not (`false`). - `holiday` boolean — Defines if shipping on holidays is valid (`true`) or not (`false`). - `maxDimension` object — Object containing attributes of maximum dimension permitted by the shipping policy (carrier). - `largestMeasure` number — Largest measure acceptable of the package. - `maxMeasureSum` number — Limit for the sum of all maximum measures of the package. - `numberOfItemsPerShipment` integer — Determines the number of items allowed per shipment. - `minimumValueAceptable` number — Minimum value accepted by the carrier for delivering. - `maximumValueAceptable` number — Maximum value accepted by the carrier for delivering. - `additionalTime` string — Additional time configured in `HH:MM:SS` format. - `additionalPrice` object — Additional price object. - `method` integer — Additional price method. - `value` number — Payment value. - `deliveryScheduleSettings` object — [Scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) settings. - `useDeliverySchedule` boolean — Defines if the scheduled delivery configuration is active (`true`) or not (`false`). - `maxRangeDelivery` number — Range of days available within a delivery window, for the customer to choose the scheduled delivery. For example, if the configured `maxRangeDelivery` is equal `7`, and the customer buys something on a Tuesday, the options for scheduled delivery will be shown until the following Tuesday (7 days from the purchase day). If no options are available within the `maxRangeDelivery` set, the shipping policy will not be shown on the checkout. - `dayOfWeekForDelivery` object[] — Selected days for delivery, from `0` (Sunday) to `6` (Saturday). - `dayOfWeek` integer — Day of the week, from `0` (Sunday) to `6` (Saturday). - `deliveryRanges` object[] — Reservation window for scheduled delivery. - `startTime` string — Start time for day of the week in `hh:mm:ss` format. - `endTime` string — End time for day of the week in `hh:mm:ss` format. - `listPrice` number — List price for day of the week. - `deliveryCapacity` object[], nullable — Sets maximum [delivery capacity](https://help.vtex.com/en/tutorial/managing-delivery-capacity--2y217FQZCjD0I1n62yxVcz) for a given reservation window for scheduled delivery. - `capacityType` string — Defines how the delivery capacity is measured for this reservation window, by maximum number of orders (`ORDERS_QUANTITY`) or items (`SKUS_QUANTITY`). - `maxValue` number — Maximum number of orders or SKUs that the store is capable of fulfilling. - `dayOfWeekBlockeds` string[], nullable — Defines if there are any days of the week that are blocked. - `carrierSchedule` object[] — Schedule sent by the carrier to configure the shipping policy. - `dayOfWeek` integer — Day of the week from `0` (Sunday) to `6` (Saturday). - `timeLimit` string — Time limit in `HH:MM:SS` format. - `cubicWeightSettings` object — Settings for the cubic weight of a package, which accounts for the [package's volume](https://help.vtex.com/en/tutorial/understanding-the-cubic-weight-factor--tutorials_128), and not only weight. - `volumetricFactor` number — Factor that will be used on the cubic weight calculation, usually given by the carrier. - `minimunAcceptableVolumetricWeight` number — Packages' minimum acceptable [volumetric weight](https://help.vtex.com/en/tutorial/understanding-the-cubic-weight-factor--tutorials_128). - `modalSettings` object — Configurations for the [modal](https://help.vtex.com/en/tutorial/how-does-the-modal-work--tutorials_125), which is the attachement of a specific product to a carrier specialized in delivering that type of product. - `modals` string[] — Type of special freight. - `useOnlyItemsWithDefinedModal` boolean — When set as `true`, the modal's configurations will apply only for items with a defined modal, when `false`, the modal configuration will not be set. - `businessHourSettings` object — Business hours configurations. - `carrierBusinessHours` object[] — Business hours configurations array for the days of the week. - `openingTime` string — Opening time in `HH:MM:SS` format. - `closingTime` string — Closing time in `HH:MM:SS` format. - `dayOfWeek` 0 | 1 | 2 | 3 | 4 | 5 | 6 — Day of the week from `0` (Sunday) to `6` (Saturday). - `isOpenOutsideBusinessHours` boolean — Defines if deliveries outside business hours are allowed (`true`) or not (`false`). - `pickupPointsSettings` object — [Pickup points](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) configurations of the shipping policy. - `pickupPointIds` string[] — Pickup point IDs configured for the shipping policy. - `pickupPointTags` string[] — Pickup points tags configured for the shipping policy. - `sellers` string[] — Sellers associated with [pickup points](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) related to the shipping policy. - `processingStatus` object — Shipping policy processing status. - `status` integer — Shipping policy processing status code. - `errorMessage` string, nullable — Error message, when applicable. - `errorsMetadata` string, nullable — Error metadata, when applicable. - `deliveryChannel` string — Defines if the shipping type is `delivery` or `pickup`. - `calculationType` integer — Shipping policy calculation type. - `isActive` boolean — Defines if the shipping policy is active (`true`) or not (`false`). - `lastIndexedAt` string, nullable — Date and time since the last [indexing](https://help.vtex.com/en/tutorial/understanding-how-indexation-works--tutorials_256), in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DD hh:mm:ss[.nnnnnnn]+hh:mm`. - `shippingHoursSettings` object — Shipping hours settings configurations. - `shippingHours` object[] — Shipping hours settings array. - `dayOfWeek` integer — Day of the week from `0` (Sunday) to `6` (Saturday). - `openingTime` string — Opening time in `hh:mm:ss` format. - `closingTime` string — Closing time in `hh:mm:ss` format. - `acceptOrdersOutsideShippingHours` boolean — Defines if the configuration that allows accepting orders outside shipping hours is active (`true`) or not (`false`). - `carrierInfo` object — [Carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) information. - `carrierAccountName` string — VTEX store account name related to the shipping policy. - `deliveryAgreementId` string, nullable — Delivery agreement ID. - `linkedDocks` object[] — Shipping policy [loading docks](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) valid for the carrier. - `id` string — Loading dock ID. - `name` string — Loading dock name. - `readyToUse` boolean — Defines if shipping configurations related to the carrier make them ready for shipping (`true`) or not (`false`). - `paging` object — Pagination information. - `page` integer — Number of the current page of the response. By default, it returns page `1`. - `perPage` integer — Number of shipping policies per page. - `total` integer — Total number of existing shipping policies. - `pages` integer — Total number of pages, considering all shipping policies. --- [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)