VTEX · Schema

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
zipCodeStart string
zipCodeEnd string
weightStart number
weightEnd number
absoluteMoneyCost number
pricePercent number
pricePercentByWeight number
maxVolume number
timeCost string
country string
operationType integer
restrictedFreights array
polygon string
minimumValueInsurance number
View JSON Schema on GitHub

JSON Schema

vtex-listfreightvalues-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ListFreightValues",
  "title": "",
  "required": [
    "zipCodeStart",
    "zipCodeEnd",
    "weightStart",
    "weightEnd",
    "absoluteMoneyCost",
    "pricePercent",
    "pricePercentByWeight",
    "maxVolume",
    "timeCost",
    "country",
    "operationType",
    "restrictedFreights",
    "polygon",
    "minimumValueInsurance"
  ],
  "type": "object",
  "properties": {
    "zipCodeStart": {
      "type": "string"
    },
    "zipCodeEnd": {
      "type": "string"
    },
    "weightStart": {
      "type": "number"
    },
    "weightEnd": {
      "type": "number"
    },
    "absoluteMoneyCost": {
      "type": "number"
    },
    "pricePercent": {
      "type": "number"
    },
    "pricePercentByWeight": {
      "type": "number"
    },
    "maxVolume": {
      "type": "number"
    },
    "timeCost": {
      "type": "string"
    },
    "country": {
      "type": "string"
    },
    "operationType": {
      "type": "integer",
      "format": "int32"
    },
    "restrictedFreights": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": ""
    },
    "polygon": {
      "type": "string"
    },
    "minimumValueInsurance": {
      "type": "number"
    }
  },
  "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
  }
}