Endereços

Lista os endereços de entrega e cobrança de um cliente.

Um cliente pode ter vários endereços. Eles são usados no checkout (entrega e cobrança), na emissão da nota fiscal e no cálculo de frete. Um deles é o padrão: o que a vitrine sugere primeiro e o que os filtros por cidade e UF da lista de clientes consultam.

Use esta rota quando você precisa dos endereços de um cliente fora da vitrine: o ERP confere a filial de entrega, o atendimento verifica um CEP, uma migração compara o histórico. A rota só lê endereços.

Cada endereço traz, além dos campos próprios, os apelidos b_* (cobrança) e s_* (entrega), no formato da Venddor 1.0.

GET/api/v1.0/users/{user_id}/addressesAdmin

Listar os endereços de um usuário

Também responde em /api/users/{user_id}/addresses, com o id decimal. Usuário sem endereços devolve "addresses": null.

Parâmetros de caminho

user_idstringobrigatório

Id do usuário (UUID; na rota sem versão, o id decimal).

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" \
  "$BASE_URL/api/v1.0/users/3dc023ca-3746-4b6e-8afd-686a4a9af99f/addresses"

Resposta

200Endereços do usuário

json

{
  "user_id": "3dc023ca-3746-4b6e-8afd-686a4a9af99f",
  "addresses": [
    {
      "id": "d9e1749d-ae6a-4f9a-8943-22d93d90cde0",
      "address_id": "d9e1749d-ae6a-4f9a-8943-22d93d90cde0",
      "user_id": "3dc023ca-3746-4b6e-8afd-686a4a9af99f",
      "label": "Matriz",
      "is_default": true,
      "first_name": "Padaria Pão Doce Ltda",
      "last_name": "",
      "address_line1": "Avenida Paulista, 1000",
      "complement": "Sala 14",
      "district": "Bela Vista",
      "district_id": "e471b959-3334-4bcb-93e4-45609cc40fc0",
      "city": "São Paulo",
      "city_id": "3d899205-1b71-4f09-8bbf-2c62bcefc2e5",
      "state": "SP",
      "postal_code": "01310-100",
      "country": "BR",
      "phone": "1133334444",
      "type": "D",
      "s_firstname": "Padaria Pão Doce Ltda",
      "s_lastname": "",
      "s_address": "Avenida Paulista, 1000",
      "s_city": "São Paulo",
      "s_state": "SP",
      "s_zipcode": "01310-100",
      "s_country": "BR",
      "s_phone": "1133334444",
      "b_firstname": "Padaria Pão Doce Ltda",
      "b_lastname": "",
      "b_address": "Avenida Paulista, 1000",
      "b_city": "São Paulo",
      "b_state": "SP",
      "b_zipcode": "01310-100",
      "b_country": "BR",
      "b_phone": "1133334444",
      "created_at": "2026-10-11T20:56:23.338259Z",
      "updated_at": "2026-10-11T20:57:46.981711Z"
    }
  ],
  "params": { "total_items": 1 }
}

Campos da resposta

user_idstring

Id do usuário.

addressesarray

Endereços (objeto descrito abaixo). null se não há nenhum.

params.total_itemsinteger

Quantidade de endereços. Não há paginação.

Campos do endereço

iduuid

Id do endereço. address_id repete o valor.

user_iduuid

Dono do endereço.

labelstring

Apelido ("Casa", "Matriz"). Pode ser vazio.

is_defaultboolean

Endereço padrão do usuário. Só um por usuário.

first_namestring

Nome do destinatário. Para destinatário PJ, a razão social inteira.

last_namestring

Sobrenome do destinatário. Pode ser vazio.

address_line1string

Logradouro e número (Avenida Paulista, 1000).

address_line2string

Segunda linha, quando existe (a vitrine usa para o número).

complementstring

Complemento (Sala 14, Bloco B). Campo próprio, não se mistura com address_line2.

districtstring

Bairro. district_id é o id no catálogo de bairros, quando o bairro existe lá.

citystring

Cidade. city_id é o id no catálogo de cidades, quando a cidade existe lá (usado para casar áreas de entrega).

statestring

UF (SP).

postal_codestring

CEP, como foi enviado (01310-100 ou 01310100).

countrystringpadrão: BR

País (código de 2 letras).

phonestring

Telefone do destinatário, gravado como veio (sem normalizar).

typestring

Apelido fixo (D).

s_*, b_*string

Apelidos para entrega (s_firstname, s_lastname, s_address, s_city, s_state, s_zipcode, s_country, s_phone) e cobrança (b_*, os mesmos nomes). Sempre iguais aos campos acima.

created_atstring

Criação (RFC 3339). updated_at é a última alteração.

Erros

Status	Quando	Corpo
401	Sem credenciais ou token expirado	`{"message":"Invalid credentials","status":401}`
403	Usuário que não é administrador	`{"message":"Forbidden: admin scope required","status":403}`

Veja também