VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API legada/Guia rápido/Gerentes de venda

Rotas sem versão

As rotas /api/managers, gêmeas das /api/v1.0/managers, para clientes escritos para a Venddor 1.0.

As rotas de gerentes da API 1.0 existem também sem o prefixo de versão: /api/managers no lugar de /api/v1.0/managers. A lógica, a autenticação (HTTP Basic com e-mail:chave_de_api de um administrador, ou Bearer) e os campos são os mesmos descritos em Gerenciar gerentes.

Ao contrário de clientes e grupos, o manager_id já é um inteiro nas duas formas; não há conversão de ids. O que muda é só o caminho. Use a forma sem versão apenas se o seu cliente já foi escrito para ela.

GET/api/managersAdmin

Listar gerentes de vendas (rota sem versão)

Igual a GET /api/v1.0/managers: Gerenciar gerentes.

GET/api/managers/{id}Admin

Consultar um gerente de vendas (rota sem versão)

Igual a GET /api/v1.0/managers/{id}: Gerenciar gerentes.

Parâmetros de caminho

idstringobrigatório
manager_id, inteiro.
POST/api/managersAdmin

Criar um gerente de vendas (rota sem versão)

Igual a POST /api/v1.0/managers: Gerenciar gerentes.

PUT/api/managers/{id}Admin

Atualizar um gerente de vendas (rota sem versão)

Igual a PUT /api/v1.0/managers/{id}: Gerenciar gerentes.

Parâmetros de caminho

idstringobrigatório
manager_id, inteiro.
DELETE/api/managers/{id}Admin

Excluir um gerente de vendas (não suportado) (rota sem versão)

Igual a DELETE /api/v1.0/managers/{id}: Gerenciar gerentes.

Parâmetros de caminho

idstringobrigatório
manager_id, inteiro.

Exemplo de requisição

bash
curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/managers?status=A&items_per_page=10"

Resposta

200Gerentes (trecho)
json
{
  "managers": [
    { "manager_id": "30", "user_id": "fb345fc1-599a-4b4d-9fb0-93d1e7196cc0", "name": "Ana Paula Ribeiro", "status": "A", "internal_code": "GER-SUL-01" }
  ],
  "search": { "page": 1, "items_per_page": 10, "total_items": 13 },
  "success": true,
  "message": ""
}

Erros

São os de Gerenciar gerentes.

StatusQuandoCorpo
401Sem credenciais ou chave inválida{"message":"Invalid credentials","status":401}
403Usuário que não é administrador{"message":"Forbidden: admin scope required","status":403}
404DELETE (não suportado){"message":"Delete not supported for managers","status":404}
Maiúsculas e barra final

A plataforma ignora diferença de maiúsculas e minúsculas e a barra no final do caminho: /api/Managers/ e /api/managers são a mesma rota.

Veja também

  • Gerenciar gerentes
  • Gerentes de venda
  • Rotas sem versão de clientes
Anterior
Gerenciar gerentes
Próxima
Categorias
Nesta página
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também