API legada/Referência completa/Vendedores

GETConsultar um vendedor

Retorna os detalhes de um vendedor pelo ID da empresa.

Este endpoint retorna informações detalhadas sobre um vendedor específico, pelo ID único da empresa. Ele responde 200 OK com o vendedor em JSON, ou 404 Not Found quando o vendedor não existe.

GET/api/vendors/{company_id}Admin

Retorna um vendedor específico

Parâmetros de caminho

company_idintegerobrigatório

O ID único da empresa do vendedor.

Exemplo de requisição

bash

curl "$BASE_URL/api/vendors/1" \
  -u "$EMAIL:$API_KEY"

Resposta

200Vendedor encontrado

json

{
  "company_id": "1",
  "lang_code": "en",
  "email": "simtech@example.com",
  "company": "Simtech",
  "timestamp": "1269610461",
  "status": "A",
  "seo_name": "simtech",
  "seo_path": "",
  "average_rating": null,
  "company_thread_ids": "1_0"
}

404Vendedor não encontrado

Quando o vendedor não existe, você recebe HTTP/1.1 404 Not Found.

Campos da resposta

Campo	Tipo	Descrição
`company_id`	string	O identificador único do vendedor.
`lang_code`	string	O código de idioma ISO (por exemplo, `"en"` para inglês).
`email`	string	O endereço de e-mail do vendedor.
`company`	string	O nome 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 da microloja do vendedor (adicionado pelo add-on de SEO).
`seo_path`	string	Caminho de SEO da microloja do vendedor (adicionado pelo add-on de SEO).
`average_rating`	float/null	Avaliação média do vendedor dada pelos clientes (adicionada pelo add-on de Comentários e Avaliações).
`company_thread_ids`	string	ID da conversa de avaliações do vendedor, no formato `"company_id_thread_id"` (adicionado pelo add-on de Comentários e Avaliações).

Veja também