City overview

A city is a Brazilian municipality, identified by its IBGE code. Every address belongs to a city. When you create an order, send the city’s id as city_id, or send its ibge_code as city_ibge_code together with the state.

City schema

FieldDescriptionType
idUnique identifier (UUID)String
nameThe name of the cityString
ibge_codeThe city’s IBGE municipality code, e.g. 4314902String
state_idThe ID of the city’s stateString
stateThe city’s state, as described in the state schemaObject

Table of contents