Skip to main content
GET
Obter menu
Proposta — ainda não implementada no XMART_BACKOFFICE. Veja Entrega híbrida para contexto. Esta página mostra a forma prevista do endpoint, não um contrato ao vivo.
A metade de busca da entrega híbrida: chame após receber um evento menu.list_ready para buscar o menu completo. A forma da resposta reflete exatamente data.menu em menu.updated — mesmos campos, mesma semântica.
O webhook de notificação e este endpoint de busca se autenticam de forma diferente. O Fire empurra menu.list_ready para o seu servidor, assinado com HMAC — veja Headers da requisição. Seu sistema consulta este endpoint, então precisa de uma credencial de API — veja abaixo.

Autenticação

É um endpoint /v1/* — veja Autenticação: só é necessário x-api-key, sem fluxo de login.
string
obrigatório
Sua API key do Fire.
string
Bearer <token> opcional, aceito como alternativa legacy a x-api-key. Envie um ou outro.

Parâmetros de rota

string
obrigatório
Identificador da atribuição de sync, recebido como data.syncId no evento menu.list_ready. É o id da linha que amarra uma loja, um canal e um fulfillment type a um menu e uma lista de preços — os mesmos três valores que listId resume como string, mas este é o que garante unicidade.

Resposta

object
De qual menu e lista de preços veio esta resposta. Compare com seu último menu.list_ready para detectar uma reatribuição entre o evento de notificação e esta busca.
object
Metadados do menu e associação canal/loja.
object[]
Categorias do menu.
object[]
Catálogo de produtos.
object[]
Grupos de modificadores e opções.

Notas

  • Este endpoint retorna a mesma forma documentada campo por campo em menu.updated — consulte essa página para descrições completas, casos extremos, e as regras de Data de atribuição ao menu.
  • Um syncId que não existe, ou cuja atribuição foi removida, deveria retornar 404.