VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API legada/Referência completa

Missões de campo

O que são missões e pesquisas de campo, o estado atual das rotas e o mapa das quatro operações.

Uma missão de campo é uma tarefa dada a um promotor de vendas (uma pessoa que visita pontos de venda) para um seller. Uma pesquisa (survey) é o resultado da visita: para cada produto procurado, a quantidade encontrada e até dois preços coletados. Estas rotas seguem o contrato da API 1.0 usado pelo app do promotor e por ERPs.

Estado atual das rotas

Hoje as duas listas (GET) respondem sempre com data vazio, e os dois PUT respondem 501 (não implementado). As rotas existem para que clientes escritos para a API 1.0 não quebrem, mas ainda não guardam nem devolvem missões ou pesquisas.

Pontos-chave
  • Só administradores chamam estas rotas.
  • Usam o mesmo módulo do Conector Magento: com o módulo desligado, toda rota responde 404 endpoint not available.
  • Os nomes das chaves são em camelCase (salesPromoterId, sellerId), diferente do resto da API.
  • mission_surveys e missionsurveys são a mesma rota.

Endpoints

MétodoCaminhoPara que serveAutenticação
GET/api/v1.0/missionsListar missõesAdministrador
PUT/api/v1.0/missions/{id}Atualizar missãoAdministrador
GET/api/v1.0/mission_surveysListar pesquisasAdministrador
PUT/api/v1.0/mission_surveys/{id}Atualizar pesquisaAdministrador

Erros comuns

  • Tratar o 501 como falha temporária. O PUT não grava nada; não repita a chamada esperando que passe.
  • Ler snake_case. As chaves dos itens são salesPromoterId, sellerId, missionid.
  • Chamar com o módulo desligado. Volta 404, não 403.
Anterior
Lojas do Magento
Próxima
Missões
Nesta página
  • Endpoints
  • Erros comuns