Listar as Lojas do Usuário

Consulte todas as lojas que o usuário está autorizado a gerenciar.

Endpoint

GET /dealer
GET /dealer/{id}

Método

GET

Autenticação

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

Authorization: Bearer {access_token}

Exemplo de Resposta

Lista de Lojas

Status Code: 200 OK

{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 10,
      "corporate_name": "LOJA TESTE LTDA",
      "name": "LOJA TESTE",
      "cnpj": "12.345.678/0001-90",
      "email": "contato@lojatest.com.br",
      "site": "https://www.lojatest.com.br",
      "logo": "https://media.integradordeanuncios.com.br/media/logo/logo-loja-conectada1.webp",
      "xml_folder": "loja-teste",
      "replication": false,
      "status": {
        "id": 1,
        "name": "Ativo"
      },
      "users": [
        {
          "id": 1,
          "name": "João Silva",
          "email": "joao@example.com"
        }
      ],
      "is_site_from_lc": true,
      "partner_id": null,
      "white_label": {
        "id": 1,
        "name": "Padrão"
      }
    },
    {
      "id": 11,
      "corporate_name": "OUTRA LOJA LTDA",
      "name": "OUTRA LOJA",
      "cnpj": "98.765.432/0001-10",
      "email": "contato@outraloja.com.br",
      "site": "https://www.outraloja.com.br",
      "logo": "https://media.integradordeanuncios.com.br/media/logo/logo-outra-loja.webp",
      "xml_folder": "outra-loja",
      "replication": false,
      "status": {
        "id": 1,
        "name": "Ativo"
      },
      "users": [],
      "is_site_from_lc": false,
      "partner_id": 5,
      "white_label": null
    }
  ]
}

Detalhe de uma Loja

Status Code: 200 OK

{
  "id": 10,
  "corporate_name": "LOJA TESTE LTDA",
  "name": "LOJA TESTE",
  "cnpj": "12.345.678/0001-90",
  "email": "contato@lojatest.com.br",
  "site": "https://www.lojatest.com.br",
  "logo": "https://media.integradordeanuncios.com.br/media/logo/logo-loja-conectada1.webp",
  "xml_folder": "loja-teste",
  "replication": false,
  "status": {
    "id": 1,
    "name": "Ativo"
  },
  "users": [
    {
      "id": 1,
      "name": "João Silva",
      "email": "joao@example.com"
    }
  ],
  "is_site_from_lc": true,
  "partner_id": null,
  "white_label": {
    "id": 1,
    "name": "Padrão"
  }
}

Estrutura de Dados

Estrutura da Resposta Paginada

Campo	Tipo	Descrição
`count`	integer	Total de lojas encontradas
`next`	string	URL da próxima página (null se não houver)
`previous`	string	URL da página anterior (null se não houver)
`results`	array	Array com os resultados da página atual

Estrutura de um Item de Loja

Campo	Tipo	Descrição
`id`	integer	Identificador único da loja
`corporate_name`	string	Razão social da loja
`name`	string	Nome fantasia da loja
`cnpj`	string	CNPJ da loja
`email`	string	Email de contato da loja
`site`	string	URL do site da loja
`logo`	string	URL do logo da loja
`xml_folder`	string	Nome da pasta XML da loja
`replication`	boolean	Indica se a loja possui replicação
`status`	object	Objeto com informações do status (id, name)
`users`	array	Array de objetos com usuários da loja
`is_site_from_lc`	boolean	Indica se o site é da Loja Conectada
`partner_id`	integer	ID do parceiro (pode ser null)
`white_label`	object	Objeto com informações do white label (pode ser null)

Estrutura do Objeto `status`

Campo	Tipo	Descrição
`id`	integer	Identificador único do status
`name`	string	Nome do status

Estrutura de um Item em `users`

Campo	Tipo	Descrição
`id`	integer	Identificador único do usuário
`name`	string	Nome do usuário
`email`	string	Email do usuário

Filtros

Este endpoint suporta os seguintes filtros através de query parameters:

Parâmetro	Tipo	Descrição
`id`	integer	Filtra por ID da loja
`cnpj`	string	Busca parcial por CNPJ (case-insensitive)
`name`	string	Busca parcial por nome fantasia (case-insensitive)
`status`	integer	Filtra por ID do status

Exemplos de Uso de Filtros

Filtrar por nome:

GET /dealer?name=teste

Filtrar por CNPJ:

GET /dealer?cnpj=12345678

Filtrar por status:

GET /dealer?status=1

Filtrar por ID:

GET /dealer?id=10

Query Parameters de Paginação

Parâmetro	Tipo	Descrição
`page`	integer	Número da página
`pageSize`	integer	Quantidade de itens por página (padrão: definido nas configurações, máximo: 100)

Endpoints Relacionados

Endereços da Loja

Para obter os endereços de uma loja específica:

GET /dealer/{id}/addresses

Parâmetros do Portal

Para obter os parâmetros do portal de uma loja:

GET /dealer/{id}/portal-param

Lojas Relacionadas

Para obter as lojas relacionadas a uma loja específica:

GET /dealer/{id}/related

Observações

Usuários não administradores só visualizam as lojas às quais estão associados e que estão com status ativo
Administradores visualizam todas as lojas
O campo users retorna apenas os usuários ativos da loja
O campo logo retorna a URL completa da imagem do logo

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."
}

{
  "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 uma loja específica não é encontrada (ao acessar /dealer/{id}).

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

Endpoint​

Método​

Autenticação​

Exemplo de Resposta​

Lista de Lojas​

Detalhe de uma Loja​

Estrutura de Dados​

Estrutura da Resposta Paginada​

Estrutura de um Item de Loja​

Estrutura do Objeto status​

Estrutura de um Item em users​

Filtros​

Exemplos de Uso de Filtros​

Query Parameters de Paginação​

Endpoints Relacionados​

Endereços da Loja​

Parâmetros do Portal​

Lojas Relacionadas​

Observações​

Possíveis Retornos de Erro​

401 Unauthorized​

403 Forbidden​

404 Not Found​