--- title: "Create shipping policy" method: POST path: "/api/logistics/pvt/shipping-policies" tags: ["Shipping policies"] --- # Create shipping policy `POST /api/logistics/pvt/shipping-policies` Configure a new [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) for 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 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 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). ## Headers - `Accept` string, required - `Content-Type` string, required ## Request body - object - `id` string, required — ID of the shipping policy. - `name` string, required — Name of the shipping policy. - `shippingMethod` string, required — Type of shipping available for this shipping policy (carrier). Options shown on freight simulation. - `weekendAndHolidays` object, required — If the shipping policy includes deliveries on weekends and holidays. - `saturday` boolean, required — Defines if the shipping policy allows deliveries on Saturdays (`true`), or not (`false`). - `sunday` boolean, required — Defines if the shipping policy allows deliveries on Sundays (`true`), or not (`false`). - `holiday` boolean, required — Defines if the shipping policy allows deliveries on holidays (`true`), or not (`false`). - `maxDimension` object, required — Object containing attributes of maximum dimension permitted by the shipping policy (carrier). - `largestMeasure` number, required — Largest measure of the package. - `maxMeasureSum` number, required — Sum of all maximum measures of the package. - `numberOfItemsPerShipment` integer, required — Capacity of your store's logistics of shipment, determines number of items permitted per shipment. - `minimumValueAceptable` number, required — Minimum value accepted by the carrier, to realize the shipping. - `maximumValueAceptable` number, required — Maximum value accepted by the carrier, to realize the shipping. - `deliveryScheduleSettings` object, required — Settings for the Scheduled Delivery feature. - `useDeliverySchedule` boolean, required — Select the Scheduled Delivery configuration. - `maxRangeDelivery` number, required — 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, this shipping policy won't be shown on the checkout. - `dayOfWeekForDelivery` object[], required — Select the chosen days for delivery. Values for each day of the week are: `0` = Sunday, `1` = Monday, `2` = Tuesday, `3` = Wednesday, `4` = Thursday, `5` = Friday, `6` = Saturday. Make sure to add the available hours for the chosen days, following the example. - `dayOfWeek` integer, required — Day of the week, from `0` (sunday) to `6` (saturday). - `deliveryRanges` object[], required — Reservation windows for scheduled delivery. - `startTime` string, required — Start time for day of the week. - `endTime` string, required — End time for day of the week. - `listPrice` number, required — List price for day of the week. - `deliveryCapacity` object[] — Sets maximum delivery capacity for a given reservation window for scheduled delivery. - `capacityType` string, required — Defines how the delivery capacity is measured for this reservation window, by maximum number of orders (`"ORDERS_QUANTITY"`) or SKUs (`"SKUS_QUANTITY"`). - `maxValue` number, required — Maximum number of orders or SKUs that the store is capable of fulfilling. - `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. - `cubicWeightSettings` object, required — Measure including the [package's volume](https://help.vtex.com/en/tutorial/understanding-the-cubic-weight-factor--tutorials_128), and not only weight. - `volumetricFactor` number, required — Factor that will be used on the cubic weight calculation. - `minimunAcceptableVolumetricWeight` number, required — Packages' minimum acceptable [volumetric weight](https://help.vtex.com/en/tutorial/understanding-the-cubic-weight-factor--tutorials_128). - `modalSettings` object, required — 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[], required — Type of special freight. - `useOnlyItemsWithDefinedModal` boolean, required — Defines if the modal's configurations will apply only for items with a defined modal (`true`) or not (`false`). - `businessHourSettings` object, required — Business hours configurations. - `carrierBusinessHours` object[], required — Carrier business hours configurations for the week. - `openingTime` string, required — Opening time. - `closingTime` string, required — Closing time. - `dayOfWeek` integer, required — Day of the week, from `0` (Sunday) to `6` (Saturday). - `isOpenOutsideBusinessHours` boolean, required — Select whether the shipping policy allows deliveries outside business hours (`true`) or not (`false`). - `pickupPointsSettings` object, nullable, required — Configuration for Pickup Points. - `pickupPointIds` string[], required — Insert the IDs for pickup points previously configured in your store. - `pickupPointTags` string[], required — Insert the tags for pickup points previously configured in your store. - `sellers` string[], required — Sellers that will be associated with the [pickup points](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) of the shipping policy being created. - `isActive` boolean, required — Defines if the shipping policy is active (`true`) or not (`false`). ## Response `200` OK --- [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)