VTEX · Example Payload

Vtex Freightvalues Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Freightvalues Example is an example object payload from VTEX, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

{
  "operationId": "FreightValues",
  "method": "GET",
  "path": "/api/logistics/pvt/configuration/freights/{carrierId}/{cep}/values",
  "summary": "VTex List freight values",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json; charset=utf-8",
      "example": [
        {
          "zipCodeStart": "0",
          "zipCodeEnd": "99999999",
          "weightStart": 1,
          "weightEnd": 1000,
          "absoluteMoneyCost": 1,
          "pricePercent": 0,
          "pricePercentByWeight": 0,
          "maxVolume": 1000000000,
          "timeCost": "2.00:00:00",
          "country": "BRA",
          "operationType": 0,
          "restrictedFreights": [],
          "polygon": "",
          "minimumValueInsurance": 0
        },
        {
          "zipCodeStart": "0",
          "zipCodeEnd": "99999999",
          "weightStart": 1001.001,
          "weightEnd": 10000,
          "absoluteMoneyCost": 15,
          "pricePercent": 0,
          "pricePercentByWeight": 0,
          "maxVolume": 1000000000,
          "timeCost": "2.00:00:00",
          "country": "BRA",
          "operationType": 0,
          "restrictedFreights": [],
          "polygon": "",
          "minimumValueInsurance": 0
        },
        {
          "zipCodeStart": "0",
          "zipCodeEnd": "99999999",
          "weightStart": 10001.001,
          "weightEnd": 100000,
          "absoluteMoneyCost": 20,
          "pricePercent": 0,
          "pricePercentByWeight": 0,
          "maxVolume": 1000000000,
          "timeCost": "2.00:00:00",
          "country": "BRA",
          "operationType": 0,
          "restrictedFreights": [],
          "polygon": "",
          "minimumValueInsurance": 0
        }
      ]
    }
  ]
}