Endpoints da API HelpyGo
Lista completa de todos os endpoints disponíveis, organizados por módulo.
Autenticação
Agentes
Pedido
- PUT api/v1/pedidoNovo/ Cria ou atualiza um pedido (upsert)
- GET api/v1/pedido/{filtro}/{valor} Consulta detalhes do pedido por número, chave de NF etc.
- GET api/v1/pedido/lista Lista pedidos com filtros e paginação
- PUT api/v1/pedidoRastreioNovo Registra eventos de rastreio manual em um volume do pedido. Para lojas que não têm link de rastreio da transportadora. Cada evento tem tipo (envio ou reversa), data e hora, descrição e controle de visibilidade ao cliente final. Devolve a URL pública de rastreio do HelpyGo para enviar ao consumidor.
- GET api/v1/pedidoRastreio Consulta os volumes e a timeline completa de rastreio manual de um pedido, incluindo os eventos internos (não visíveis ao cliente final). Filtros aceitos: numeroPedido, pedidoCanal, codigoRastreio e idPedido.
- POST api/v1/pedidoRastreioEvento Altera a visibilidade ao cliente final ou a descrição de um evento de rastreio já registrado, identificado pelo seu hash. Tipo e data e hora não são alteráveis porque compõem o hash — para corrigi-los, registre um evento novo.
Fila de Eventos
CRM
- GET api/v1/crm/contatos CRM: lista contatos (busca, lista, paginação)
- GET api/v1/crm/contato CRM: busca um contato (id/email/telefone)
- POST api/v1/crm/contato CRM: cria ou atualiza contato (upsert)
- GET api/v1/crm/empresas CRM: lista empresas (contas)
- POST api/v1/crm/empresa CRM: cria ou atualiza empresa (upsert)
Faturamento Fiscal
- POST api/v1/faturamento/pedidoCriar.php Faturamento Fiscal: cria ou recupera (idempotente) um pedido de faturamento NFS-e (carga assíncrona). idLoja vem do token.
- GET api/v1/faturamento/pedidoConsultar.php Faturamento Fiscal: consulta o status do pedido por id OU idSistemaOrigem+idExterno — inclusive antes de existir nota.