v54

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

Freight values

Create or update freight values

Creates or updates freight values for your store's carriers. Learn more in Shipping rate template.

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 shipping full access

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 shipping full access
OMS - Full access	Logistics 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/configuration/freights/{carrierId}/values/update

Path parameters

carrierIdstring required

Example:carrier123

Carrier ID.

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.

Request body

absoluteMoneyCoststring required

Fixed shipping cost to be charged in a decimal number.

countrystring required

Three letter ISO code for the country where the delivery will take place.

maxVolumeinteger required

Maximum volume that can be transported by the carrier in cm³.

operationTypeinteger required

Indicates desired action for the object. Possible values are 1 (Insert), 2 (Update) or 3(Delete).

pricePercentinteger required

Price-based additional shipping charge, calculated based on the total price of the order, in decimal number. You must fill in this field with a percentage value. For example, for an additional charge of 10%, fill in the table with 10.

pricePercentByWeightinteger required

Weight-based additional shipping charge, calculated based on the total weight of the order.

timeCoststring required

Delivery time frame informed by the carrier, in the format DD.HH:MM:SS.

weightEndinteger required

Maximum weight allowed.

weightStartinteger required

Minimum weight allowed.

zipCodeEndstring required

End of postal code interval.

zipCodeStartstring required

Start of postal code interval.

polygonstring required

Polygon ID, according to the geolocation feature.

Example request

[
  {
    "absoluteMoneyCost": "1.00",
    "country": "BRA",
    "maxVolume": 1000000000,
    "operationType": 1,
    "pricePercent": 10,
    "timeCost": "2.00:00:00",
    "weightEnd": 1000,
    "weightStart": 1,
    "zipCodeEnd": "1234500",
    "zipCodeStart": "1000000",
    "polygon": "polygon2"
  }
]

v54