Address Overview

An Address represents a customer’s physical address information used for billing, shipping, or company registration purposes.

Address Schema

FieldDescriptionType
idUnique identifier (UUID)String
zipcodePostal code (CEP in Brazil)String
neighborhoodNeighborhood or district nameString
streetStreet nameString
numberStreet numberString
complementAdditional address information (apartment number, building name, etc.)String
cityCity object containing city and state informationObject