Endereços

Consulte os endereços de uma loja específica.

Endpoint

GET /dealer/{dealer_id}/addresses

Método

GET

Parâmetros de URL

Parâmetro	Tipo	Descrição
dealer_id	integer	ID da loja

Autenticação

Este endpoint requer autenticação via JWT. Inclua o token no header:

Authorization: Bearer {access_token}

Exemplo de Resposta

Status Code: 200 OK

[
  {
    "id": 1,
    "dealer": 10,
    "address": "Rua das Flores",
    "number": "123",
    "complement": "Sala 45",
    "neighborhood": "Centro",
    "city": {
      "id": 1,
      "name": "São Paulo",
      "capital": true,
      "state": {
        "id": 1,
        "name": "São Paulo",
        "initials": "SP"
      }
    },
    "zip_code": "01310-100",
    "order": 1,
    "map_url": "https://maps.google.com/?q=Rua+das+Flores,+123",
    "dealer_name": "LOJA TESTE - MATRIZ",
    "landmark": "Próximo ao metrô"
  },
  {
    "id": 2,
    "dealer": 10,
    "address": "Avenida Paulista",
    "number": "1000",
    "complement": null,
    "neighborhood": "Bela Vista",
    "city": {
      "id": 1,
      "name": "São Paulo",
      "capital": true,
      "state": {
        "id": 1,
        "name": "São Paulo",
        "initials": "SP"
      }
    },
    "zip_code": "01310-100",
    "order": 2,
    "map_url": "https://maps.google.com/?q=Avenida+Paulista,+1000",
    "dealer_name": "LOJA TESTE - FILIAL",
    "landmark": null
  }
]

Estrutura de Dados

A resposta é um array de objetos, onde cada objeto contém:

Campo	Tipo	Descrição
id	integer	Identificador único do endereço
dealer	integer	ID da loja
address	string	Logradouro (rua, avenida, etc.)
number	string	Número do endereço
complement	string	Complemento do endereço (pode ser null)
neighborhood	string	Bairro
city	object	Objeto com informações da cidade (ver abaixo)
zip_code	string	CEP
order	integer	Ordem de exibição do endereço
map_url	string	URL do mapa (Google Maps)
dealer_name	string	Nome da loja neste endereço
landmark	string	Ponto de referência (pode ser null)

Estrutura do Objeto city

Campo	Tipo	Descrição
id	integer	Identificador único da cidade
name	string	Nome da cidade
capital	boolean	Indica se é capital do estado
state	object	Objeto com informações do estado (ver abaixo)

Estrutura do Objeto state (dentro de city)

Campo	Tipo	Descrição
id	integer	Identificador único do estado
name	string	Nome completo do estado
initials	string	Sigla do estado (UF)

Observações

• Apenas endereços ativos (ativo=True) são retornados
• Os endereços são ordenados pelo campo order (ordem de exibição)
• O campo complement e landmark podem ser null

Possíveis Retornos de Erro

401 Unauthorized

Retornado quando o token de autenticação não foi fornecido ou é inválido.

{
  "detail": "As credenciais de autenticação não foram fornecidas."
}

ou

{
  "detail": "Token inválido ou expirado."
}

403 Forbidden

Retornado quando o usuário autenticado não tem permissão para acessar este recurso.

{
  "detail": "Você não tem permissão para executar essa ação."
}

404 Not Found

Retornado quando a loja especificada não é encontrada.

{
  "detail": "Não encontrado."
}