Skip to main content
Proposta — ainda não implementada no XMART_BACKOFFICE. Esta aba documenta um design, não um contrato ao vivo. Não construa contra isto até que seja lançado. Hoje, menu.updated é a única forma pela qual o Fire publica menus, e leva o catálogo completo em cada evento.

​
Objetivo

O menu.updated envia o menu completo — cada categoria, produto e grupo de modificadores — em cada publicação. Isso é simples de consumir, mas significa que uma loja com um catálogo grande paga o mesmo tamanho de payload por uma mudança de preço de uma linha que por uma republicação completa, e cada assinante recebe dados que pode não ter pedido. A entrega híbrida divide a mesma informação em duas etapas:
  1. Um webhook de notificação — menu.list_ready — avisa seu sistema que um menu está pronto para ser lido, com apenas os ids necessários para identificá-lo. Sem dados de catálogo.
  2. Uma busca sob demanda — GET /v1/menus/{syncId} — seu sistema a chama quando realmente precisa do menu, usando o syncId do evento de notificação.

​
Escopo

Este padrão é restrito a menus apenas. menu.updated continua funcionando exatamente como hoje, para sempre — isto é uma alternativa, não uma substituição. Escolha o que melhor se encaixa na sua integração:

​
Catálogo de métodos

​
Entrega

menu.list_ready é entregue exatamente como qualquer outro webhook do Fire — mesmo mecanismo, só um body mais leve. O Fire o envia como application/json para o endpoint que você configura por integração no dashboard (Agregadores → Ferramentas de desenvolvedor → Integrações de agregadores), por exemplo https://suaapp.com/webhooks/menu-list-ready. Não há um canal de entrega novo aqui, apenas um tipo de evento novo.

​
Headers da requisição

GET /v1/menus/{syncId} se autentica de forma diferente — seu sistema chama o Fire, então precisa de uma credencial de API em vez de uma assinatura. Veja Autenticação nessa página.