v54

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

Freight values

List freight values

Lists freight values appointed to your store's carriers, searching by carrier ID and postal code (cep). The information is retrieved from your shipping rate template configurations.

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 viewer
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 viewer
Logistics - Read only	Logistics viewer
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.

get/api/logistics/pvt/configuration/freights/{carrierId}/{postalcode}/values

Path parameters

carrierIdstring required

Example:carrier-123

Carrier ID.

postalcodestring required

Example:12345000

Postal code of the area in which you wish to retrieve freight values for a given carrier, according to your shipping rate template configurations.

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.

Response

zipCodeStartstring required

Postal code interval starting point.

zipCodeEndstring required

Postal code interval ending point.

weightStartnumber required

Minimum weight allowed.

weightEndnumber required

Maximum weight allowed.

absoluteMoneyCostnumber required

Fixed shipping cost to be charged, in a decimal number.

pricePercentnumber 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.

pricePercentByWeightnumber required

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

maxVolumenumber required

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

timeCoststring required

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

countrystring required

Three letter ISO code for the country for the given postal code.

operationTypeinteger required

Indicates the operation type, which can be 1 (Insert), 2 (Update) or 3(Delete).

restrictedFreightsstring[] nullable required

List of postal codes where the delivery is restricted for the given carrier.

polygonstring required

Polygon ID, according to the geolocation feature.

minimumValueInsurancenumber required

Insurance minimum value.