Sign in

v54

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

Create shipping policy

Configure a new shipping policy 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 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
LogisticsLogistics accessLogistics shipping 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
Logistics - Full accessLogistics shipping full access
OMS - Full accessLogistics shipping 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/shipping-policies

Headers

Acceptstring required

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Content-Typestring required

Type of the content being sent.

Request body

idstring required

ID of the shipping policy.

namestring required

Name of the shipping policy.

shippingMethodstring required

Type of shipping available for this shipping policy (carrier). Options shown on freight simulation.

numberOfItemsPerShipmentinteger required

Capacity of your store's logistics of shipment, determines number of items permitted per shipment.

minimumValueAceptablenumber required

Minimum value accepted by the carrier, to realize the shipping.

maximumValueAceptablenumber required

Maximum value accepted by the carrier, to realize the shipping.

isActiveboolean required

Defines if the shipping policy is active (true) or not (false).

Example request

{
  "id": "123",
  "name": "Normal",
  "shippingMethod": "Normal",
  "weekendAndHolidays": {
    "saturday": false,
    "sunday": false,
    "holiday": false
  },
  "maxDimension": {
    "largestMeasure": 15,
    "maxMeasureSum": 25
  },
  "numberOfItemsPerShipment": 5,
  "deliveryScheduleSettings": {
    "useDeliverySchedule": true,
    "dayOfWeekForDelivery": [
      {
        "dayOfWeek": 2,
        "deliveryRanges": [
          {
            "startTime": "11:00:00",
            "endTime": "12:30:00",
            "deliveryCapacity": [
              {
                "capacityType": "ORDERS_QUANTITY",
                "maxValue": 55
              }
            ]
          }
        ]
      }
    ]
  },
  "carrierSchedule": [
    {
      "timeLimit": "time_limit"
    }
  ],
  "cubicWeightSettings": {
    "volumetricFactor": 3,
    "minimunAcceptableVolumetricWeight": 5
  },
  "modalSettings": {
    "modals": [
      "ELECTRONICS"
    ]
  },
  "businessHourSettings": {
    "carrierBusinessHours": [
      {
        "openingTime": "00:00:00",
        "closingTime": "23:59:59",
        "dayOfWeek": 1
      }
    ],
    "isOpenOutsideBusinessHours": true
  },
  "pickupPointsSettings": {
    "pickupPointIds": [
      "Id1"
    ],
    "pickupPointTags": [
      "Tag1",
      "Tag2"
    ],
    "sellers": [
      "Seller1"
    ]
  }
}

Response

OK