API legada/Referência completa/Vendedores

GETListar vendedores

Retorna a lista de vendedores do seu marketplace, com paginação, ordenação e filtros.

Este endpoint retorna a lista de todos os vendedores do seu marketplace Venddor. Use-o para montar um painel de vendedores, alimentar relatórios ou sincronizar os dados dos vendedores com um sistema externo. A resposta traz os vendedores em vendors e as informações de paginação em params.

GET/api/vendorsAdmin

Retorna a lista de todos os vendedores

Parâmetros de consulta

pageintegerpadrão: 1

Número da página a retornar.

items_per_pageintegerpadrão: 10

Quantidade de vendedores por página.

sort_bystringpadrão: name

nametimestampemailstatus

Campo usado na ordenação.

sort_orderstringpadrão: desc

ascdesc

Direção da ordenação: asc (crescente) ou desc (decrescente).

emailstring

Filtra os vendedores pelo endereço de e-mail.

timestampstring

Filtra os vendedores pelo carimbo de data e hora de criação.

statusstring

NAPD

Filtra os vendedores pelo status.

companystring

Filtra os vendedores pelo nome da empresa.

Exemplo de requisição

bash

curl "$BASE_URL/api/vendors?page=2&items_per_page=2" \
  -u "$EMAIL:$API_KEY"

Resposta

200Vendedores retornados

json

{
  "vendors": [
    {
      "company_id": "2",
      "lang_code": "en",
      "email": "acme_corp@example.com",
      "company": "ACME Corp",
      "timestamp": "1712345461",
      "status": "A",
      "seo_name": "acme-corp",
      "seo_path": "",
      "average_rating": null,
      "company_thread_ids": "2_0"
    },
    {
      "company_id": "3",
      "lang_code": "en",
      "email": "techgadgets@example.com",
      "company": "Tech Gadgets Inc",
      "timestamp": "1712349875",
      "status": "A",
      "seo_name": "tech-gadgets",
      "seo_path": "",
      "average_rating": "4.7",
      "company_thread_ids": "3_0"
    }
  ],
  "params": {
    "page": 1,
    "items_per_page": 10,
    "total_items": 2
  }
}

Campos da resposta

Campo	Tipo	Descrição
`vendors`	array	Array de objetos de vendedor.
`company_id`	string	Identificador único do vendedor.
`lang_code`	string	Código de idioma de duas letras usado pelo vendedor (por exemplo, `"en"`).
`email`	string	Endereço de e-mail do vendedor.
`company`	string	Nome da empresa do vendedor.
`timestamp`	string	Timestamp Unix da criação do vendedor.
`status`	string	Status do vendedor: `N` novo, `A` ativo, `P` pendente, `D` desativado.
`seo_name`	string	Nome amigável para SEO usado nas URLs.
`seo_path`	string	Caminho de SEO para categorias aninhadas (se houver).
`average_rating`	string/null	Avaliação média do vendedor (`null` se não houver avaliações).
`company_thread_ids`	string	IDs internos das conversas de discussão relacionadas ao vendedor.

Exemplos

Segunda página com dois vendedores

Este exemplo retorna a segunda página, com 2 vendedores por página.

bash

curl "$BASE_URL/api/vendors?page=2&items_per_page=2" \
  -u "$EMAIL:$API_KEY"

Um vendedor pelo e-mail

Este exemplo retorna o vendedor com o endereço de e-mail informado.

bash

curl "$BASE_URL/api/vendors?email=techgadgets@example.com" \
  -u "$EMAIL:$API_KEY"

Casos de uso comuns

Montar um painel personalizado de gestão de vendedores.
Criar relatórios de análise e de desempenho dos vendedores.
Integrar os dados dos vendedores a sistemas externos.
Implementar processos personalizados de cadastro de vendedores.

Veja também

GETListar vendedores

Retorna a lista de vendedores do seu marketplace, com paginação, ordenação e filtros.

GET/api/vendorsAdmin

Retorna a lista de todos os vendedores

Parâmetros de consulta

pageintegerpadrão: 1

Número da página a retornar.

items_per_pageintegerpadrão: 10

Quantidade de vendedores por página.

sort_bystringpadrão: name

nametimestampemailstatus

Campo usado na ordenação.

sort_orderstringpadrão: desc

ascdesc

Direção da ordenação: asc (crescente) ou desc (decrescente).

emailstring

Filtra os vendedores pelo endereço de e-mail.

timestampstring

Filtra os vendedores pelo carimbo de data e hora de criação.

statusstring

NAPD

Filtra os vendedores pelo status.

companystring

Filtra os vendedores pelo nome da empresa.

Exemplo de requisição

bash

curl "$BASE_URL/api/vendors?page=2&items_per_page=2" \
  -u "$EMAIL:$API_KEY"

Resposta

200Vendedores retornados

json

{
  "vendors": [
    {
      "company_id": "2",
      "lang_code": "en",
      "email": "acme_corp@example.com",
      "company": "ACME Corp",
      "timestamp": "1712345461",
      "status": "A",
      "seo_name": "acme-corp",
      "seo_path": "",
      "average_rating": null,
      "company_thread_ids": "2_0"
    },
    {
      "company_id": "3",
      "lang_code": "en",
      "email": "techgadgets@example.com",
      "company": "Tech Gadgets Inc",
      "timestamp": "1712349875",
      "status": "A",
      "seo_name": "tech-gadgets",
      "seo_path": "",
      "average_rating": "4.7",
      "company_thread_ids": "3_0"
    }
  ],
  "params": {
    "page": 1,
    "items_per_page": 10,
    "total_items": 2
  }
}

Campos da resposta

Campo	Tipo	Descrição
`vendors`	array	Array de objetos de vendedor.
`company_id`	string	Identificador único do vendedor.
`lang_code`	string	Código de idioma de duas letras usado pelo vendedor (por exemplo, `"en"`).
`email`	string	Endereço de e-mail do vendedor.
`company`	string	Nome da empresa do vendedor.
`timestamp`	string	Timestamp Unix da criação do vendedor.
`status`	string	Status do vendedor: `N` novo, `A` ativo, `P` pendente, `D` desativado.
`seo_name`	string	Nome amigável para SEO usado nas URLs.
`seo_path`	string	Caminho de SEO para categorias aninhadas (se houver).
`average_rating`	string/null	Avaliação média do vendedor (`null` se não houver avaliações).
`company_thread_ids`	string	IDs internos das conversas de discussão relacionadas ao vendedor.

Exemplos

Segunda página com dois vendedores

Este exemplo retorna a segunda página, com 2 vendedores por página.

bash

curl "$BASE_URL/api/vendors?page=2&items_per_page=2" \
  -u "$EMAIL:$API_KEY"

Um vendedor pelo e-mail

Este exemplo retorna o vendedor com o endereço de e-mail informado.

bash

curl "$BASE_URL/api/vendors?email=techgadgets@example.com" \
  -u "$EMAIL:$API_KEY"

Casos de uso comuns

Montar um painel personalizado de gestão de vendedores.
Criar relatórios de análise e de desempenho dos vendedores.
Integrar os dados dos vendedores a sistemas externos.
Implementar processos personalizados de cadastro de vendedores.