VTEX · Schema

ShipperCustomer

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
legalType string
email string
firstName string
lastName string
cpf string
addressStreet string
addressNumber string
addressComplement string
addressNeighborhood string
addressCity string
postalCode string
state string
companyName string
cnpj string
idExternalShipperCustomer string
phoneAreaCode string
phoneNumber string
View JSON Schema on GitHub

JSON Schema

vtex-shippercustomer-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ShipperCustomer",
  "title": "ShipperCustomer",
  "required": [
    "legalType",
    "addressStreet",
    "postalCode"
  ],
  "type": "object",
  "properties": {
    "legalType": {
      "maxLength": 2,
      "minLength": 2,
      "type": "string"
    },
    "email": {
      "maxLength": 254,
      "minLength": 0,
      "type": "string"
    },
    "firstName": {
      "maxLength": 100,
      "minLength": 0,
      "type": "string"
    },
    "lastName": {
      "maxLength": 100,
      "minLength": 0,
      "type": "string"
    },
    "cpf": {
      "maxLength": 50,
      "minLength": 0,
      "type": "string"
    },
    "addressStreet": {
      "maxLength": 150,
      "minLength": 0,
      "type": "string"
    },
    "addressNumber": {
      "maxLength": 50,
      "minLength": 0,
      "type": "string"
    },
    "addressComplement": {
      "maxLength": 50,
      "minLength": 0,
      "type": "string"
    },
    "addressNeighborhood": {
      "maxLength": 150,
      "minLength": 0,
      "type": "string"
    },
    "addressCity": {
      "maxLength": 100,
      "minLength": 0,
      "type": "string"
    },
    "postalCode": {
      "maxLength": 9,
      "minLength": 0,
      "type": "string"
    },
    "state": {
      "maxLength": 2,
      "minLength": 2,
      "type": "string"
    },
    "companyName": {
      "maxLength": 150,
      "minLength": 0,
      "type": "string"
    },
    "cnpj": {
      "maxLength": 50,
      "minLength": 0,
      "type": "string"
    },
    "idExternalShipperCustomer": {
      "maxLength": 30,
      "minLength": 0,
      "type": "string"
    },
    "phoneAreaCode": {
      "maxLength": 3,
      "minLength": 0,
      "type": "string"
    },
    "phoneNumber": {
      "maxLength": 12,
      "minLength": 0,
      "type": "string"
    }
  }
}