VTEX · Schema

CarrierResponse

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
username	string
firstName	string
lastName	string
cpf	string
email	string
cnpjtransportCompany	string
mobileAreaCode	string
mobile	string
phoneAreaCode	string
phone	string
created	string
idExternalCarrier	string
isCarrierAppOnline	boolean
shippingCompany	object
rg	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CarrierResponse",
  "title": "CarrierResponse",
  "type": "object",
  "properties": {
    "username": {
      "maxLength": 100,
      "minLength": 0,
      "type": "string"
    },
    "firstName": {
      "maxLength": 100,
      "minLength": 0,
      "type": "string"
    },
    "lastName": {
      "maxLength": 100,
      "minLength": 0,
      "type": "string"
    },
    "cpf": {
      "maxLength": 14,
      "minLength": 0,
      "type": "string"
    },
    "email": {
      "maxLength": 254,
      "minLength": 0,
      "type": "string"
    },
    "cnpjtransportCompany": {
      "type": "string"
    },
    "mobileAreaCode": {
      "maxLength": 10,
      "minLength": 0,
      "type": "string"
    },
    "mobile": {
      "maxLength": 10,
      "minLength": 0,
      "type": "string"
    },
    "phoneAreaCode": {
      "maxLength": 3,
      "minLength": 0,
      "type": "string"
    },
    "phone": {
      "maxLength": 10,
      "minLength": 0,
      "type": "string"
    },
    "created": {
      "type": "string",
      "format": "date-time"
    },
    "idExternalCarrier": {
      "maxLength": 30,
      "minLength": 0,
      "type": "string"
    },
    "isCarrierAppOnline": {
      "type": "boolean"
    },
    "shippingCompany": {
      "$ref": "#/components/schemas/ShippingCompanyResponse"
    },
    "rg": {
      "maxLength": 12,
      "minLength": 0,
      "type": "string"
    }
  }
}