Consulta um endereço
/v1/addresses/{addressId}Autentique com o header SelectKey: a chave sk_test_ opera no sandbox, a sk_live_ em produção. Como autenticar.
Parâmetros do caminho
addressIdstringobrigatórioIdentificador público (addr_/cad_/cadm_/add_…)
Respostas
200Sucesso
idstringobrigatórioIdentificador público (addr_/cad_/cadm_/add_…)
citystringobrigatóriopode ser nuloCidade.
linestringobrigatóriopode ser nuloO endereço inteiro numa linha.
line1stringobrigatóriopode ser nuloPrimeira linha: logradouro e número.
line2stringobrigatóriopode ser nuloSegunda linha: bairro.
line3stringobrigatóriopode ser nuloTerceira linha: cidade, estado e CEP.
statestringobrigatóriopode ser nuloEstado (sigla de duas letras).
_linksobjectLinks para operações relacionadas, por ação (
self,create,update,delete,list…).numberstringobrigatóriopode ser nuloNúmero.
streetstringobrigatóriopode ser nuloLogradouro.
countrystringobrigatóriopode ser nuloCódigo do país (ISO 3166-1).
ownerIdstringobrigatórioId público do dono.
primarybooleanobrigatórioSe é o endereço principal do dono.
districtstringobrigatóriopode ser nuloBairro.
latitudestringobrigatóriopode ser nuloLatitude, em graus decimais como texto;
nullquando desconhecida.merchantobjectA conta dona do recurso (o vendedor de registro).
+3 campos de
merchantnamestringobrigatóriopode ser nuloNome fantasia da conta dona do recurso.
merchantIdstringobrigatóriopode ser nuloId público da conta dona do recurso (
bus_…).isSubAccountbooleanobrigatóriotruequando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace.
metadataobjectobrigatóriopode ser nuloOs seus metadados chave-valor;
nullquando não há.postcodestringobrigatórioCEP, só dígitos.
createdAtstringobrigatórioQuando o recurso foi criado (ISO 8601, UTC).
longitudestringobrigatóriopode ser nuloLongitude, em graus decimais como texto;
nullquando desconhecida.ownerTypestringobrigatórioQuem é dono do endereço: um
customer, a própriacompany, umuserou umvendor.Valores:vendorcustomercompanyuserupdatedAtstringobrigatórioQuando o recurso foi atualizado pela última vez (ISO 8601, UTC).
complementstringobrigatóriopode ser nuloComplemento (apartamento, sala, bloco…).
401Não autenticado (credencial ausente ou inválida)
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
403Sem permissão
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
404Não encontrado
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
500Erro interno do servidor
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório