Pular para o conteúdo

API de integração

Conecte o Chamejar ao seu site, aplicativo, ERP, agente de atendimento ou BI. 259 operações documentadas em pt-BR, com exemplos testados no sistema.

O OpenAPI importa no Postman, Insomnia, Bruno, Swagger e geradores de SDK. O arquivo .http roda no VS Code (REST Client) e nas IDEs JetBrains.

Visão geral

A API do Chamejar é uma API REST com JSON que dá acesso ao mesmo sistema que a equipe usa no painel. São 259 operações em cardápio, clientes, pedidos, pagamentos, PDV, mesas, cozinha, impressão, entregas, estoque, financeiro, relatórios, fiscal e marketplaces.

  • Endereço base: https://endereco-do-seu-chamejar/api/v1, o mesmo endereço do painel seguido de /api/v1.
  • Formato: JSON em UTF-8. Envie Accept: application/json e, quando houver corpo, Content-Type: application/json.
  • Valores em dinheiro: campos terminados em _minor estão em centavos de real. 7970 é R$ 79,70.
  • Datas: ISO 8601, por exemplo 2026-11-10T19:30:00-03:00.

Todos os exemplos desta página foram executados contra o sistema real, numa unidade de demonstração com dados fictícios.

Primeiros passos

1. Gere um token

No painel, abra Configurações → APIs e clique em Gerar meu token. Informe:

  • Nome da integração: para identificar onde o token está em uso, como "Site de delivery" ou "ERP".
  • Validade em dias: até 3.650 dias. Vazio, o token não expira.
  • Permissões: marque só o que a integração precisa. Os perfis Agente de atendimento e Agente de impressão marcam de uma vez as permissões típicas desses usos.

Copie o token na hora: por segurança, ele não aparece de novo. Guarde num cofre de segredos, nunca no código. O token só pode receber permissões que o seu usuário tem no painel. A mesma tela lista os seus tokens com o botão Revogar.

2. Descubra o id da unidade

Quase todas as rotas trabalham dentro de uma unidade, informada no cabeçalho X-Location-Id. O id aparece em Configurações → Unidades. Em restaurantes com uma unidade só, normalmente é 1.

3. Faça a primeira chamada

export CHAMEJAR_URL="https://endereco-do-seu-chamejar"
export CHAMEJAR_TOKEN="cole-aqui-o-seu-token"
export CHAMEJAR_UNIDADE=1

curl "$CHAMEJAR_URL/api/v1/store" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"

Resposta real:

{
  "data": {
    "id": 1,
    "name": "Pizzaria Brasa Viva",
    "description": "Pizzaria fictícia usada nas telas de demonstração.",
    "telephone": "(91) 3000-0000",
    "enabled": true,
    "address": {
      "line_1": "Travessa das Mangueiras, 120",
      "line_2": null,
      "city": "Belém",
      "state": "PA",
      "postcode": "66000-000",
      "country_id": 32
    },
    "weekly_hours": [
      {
        "type": "opening",
        "weekday": 0,
        "opens_at": "00:00:00",
        "closes_at": "23:59:00",
        "enabled": true
      },
      {
        "type": "opening",
        "weekday": 1,
        "opens_at": "00:00:00",
        "closes_at": "23:59:00",
        "enabled": true
      },
      {
        "type": "opening",
        "weekday": 2,
        "opens_at": "00:00:00",
        "closes_at": "23:59:00",
        "enabled": true
      },
      {
        "type": "opening",
        "weekday": 3,
        "opens_at": "00:00:00",
        "closes_at": "23:59:00",
        "enabled": true
      },
      {
        "type": "opening",
        "weekday": 4,
        "opens_at": "00:00:00",
        "closes_at": "23:59:00",
        "enabled": true
      },
      {
        "type": "opening",
        "weekday": 5,
        "opens_at": "00:00:00",
        "closes_at": "23:59:00",
        "enabled": true
      },
      {
        "type": "opening",
        "weekday": 6,
        "opens_at": "00:00:00",
        "closes_at": "23:59:00",
        "enabled": true
      },
      {
        "type": "delivery",
        "weekday": 0,
        "opens_at": "00:00:00",
        "closes_at": "23:59:00",
        "enabled": true
      },
      {
        "type": "delivery",
        "weekday": 1,
        "opens_at": "00:00:00",
        "closes_at": "23:59:00",
        "enabled": true
      },
      {
        "type": "delivery",
        "weekday": 2,
        "opens_at": "00:00:00",
        "closes_at": "23:59:00",
        "enabled": true
      },
      {
        "type": "delivery",
        "weekday": 3,
        "opens_at": "00:00:00",
        "closes_at": "23:59:00",
        "enabled": true
      },
      {
        "type": "delivery",
        "weekday": 4,
        "opens_at": "00:00:00",
        "closes_at": "23:59:00",
        "enabled": true
      },
      {
        "type": "delivery",
        "weekday": 5,
        "opens_at": "00:00:00",
        "closes_at": "23:59:00",
  …

Autenticação e permissões

Envie o token em todas as chamadas no cabeçalho Authorization: Bearer <token>. Cada operação exige uma permissão (escopo). Sem o escopo, a resposta é 403. A referência mostra o escopo de cada operação.

EscopoO que permiteOperações
catalog:readConsultar o cardápio8
catalog:writeAlterar o cardápio10
customers:readConsultar clientes3
customers:writeAlterar clientes4
loyalty:readConsultar fidelidade e crédito2
loyalty:writeLançar e reverter fidelidade e crédito2
orders:readConsultar pedidos4
orders:writeCriar e alterar pedidos3
orders:transitionMudar a etapa de pedidos1
orders:cancelCancelar pedidos e itens5
payments:readConsultar pagamentos10
payments:initiateIniciar checkout online1
payments:writeProcessar pagamentos12
payments:refundFazer estornos2
pos:useOperar o PDV10
pos:adjustAplicar descontos e acréscimos no PDV1
cash:readConsultar o caixa3
cash:manageAbrir e movimentar o caixa3
kitchen:readConsultar a cozinha3
kitchen:writeAtualizar a fila da cozinha4
tables:readConsultar mesas e comandas3
tables:writeOperar mesas e comandas9
tables:closeFechar mesas e comandas1
print:readConsultar a fila de impressão4
print:writeReenviar e cancelar impressões3
print:confirmConfirmar impressões (agente local)2
stock:readConsultar estoque e movimentações6
stock:writeRegistrar movimentações de estoque11
finance:readConsultar contas e títulos5
finance:writeGerenciar contas e baixas5
reports:readConsultar relatórios4
reports:exportExportar relatórios2
reports:manageAtualizar DRE e orçamento6
reports:closeFechar e reabrir meses da DRE2
delivery:readConsultar fila e entregas3
delivery:writeGerenciar e despachar entregas8
fiscal:readConsultar documentos fiscais23
fiscal:writeGerenciar perfil e regras fiscais17
fiscal:emitEmitir e cancelar documentos fiscais6
marketplaces:readConsultar integrações de marketplace17
marketplaces:writeGerenciar integrações de marketplace24
audit:readConsultar auditoria1
reasons:manageGerenciar motivos operacionais1
approvals:grantConceder aprovação de supervisor2

Unidade (X-Location-Id)

As operações valem para a unidade informada em X-Location-Id. O token só enxerga as unidades que o usuário dele pode acessar. Um recurso de outra unidade responde 404, igual a um recurso inexistente. A resposta devolve o mesmo cabeçalho X-Location-Id.

Sem o cabeçalho, ou com valor inválido, a resposta é 422:

{
  "error": {
    "code": "validation_error",
    "message": "Os dados enviados são inválidos.",
    "details": {
      "X-Location-Id": [
        "Informe uma unidade válida no cabeçalho X-Location-Id."
      ]
    }
  },
  "meta": {
    "correlation_id": "75074213-e374-4b39-9a7c-112d1951a462"
  }
}

Idempotência

Comandos que criam ou mudam algo importante (criar pedido, mudar etapa, cobrar, fechar caixa, emitir nota) exigem o cabeçalho Idempotency-Key: uma chave única por comando, de até 160 caracteres. Use um UUID.

  • Repetiu a mesma chave com o mesmo conteúdo: o comando não é executado de novo. A API devolve a resposta original com Idempotency-Replayed: true. É assim que se tenta de novo com segurança depois de uma falha de rede.
  • Mesma chave com outro conteúdo: 409 idempotency_conflict.
  • Mesma chave enquanto a primeira ainda está em processamento: 409. Aguarde e repita.

Conflito real, ao reutilizar a chave de um pedido já criado com outros itens:

{
  "error": {
    "code": "idempotency_conflict",
    "message": "A chave já foi usada com outro conteúdo."
  },
  "meta": {
    "correlation_id": "c42b6dca-80cc-424a-a64b-1a8176dbbaec"
  }
}

A referência marca com Idempotency-Key as operações que exigem a chave.

Paginação e listagens

As listagens aceitam per_page (itens por página) e page (número da página). O total vem em meta:

GET /api/v1/orders?per_page=2&page=3

"meta": {
  "correlation_id": "c8500400-904e-4124-90eb-836637c4f138",
  "current_page": 3,
  "per_page": 2,
  "total": 2036,
  "last_page": 1018
}

Erros

Todo erro tem o mesmo formato. details traz as mensagens por campo quando a validação falha.

{
  "error": { "code": "validation_error", "message": "…", "details": { "campo": ["mensagem"] } },
  "meta": { "correlation_id": "uuid" }
}
HTTPcodeQuando aconteceO que fazer
401unauthenticatedToken ausente, inválido, expirado ou revogado.Gere outro token.
403forbiddenO token não tem o escopo da operação.Gere um token com o escopo indicado na referência.
404not_foundRecurso ou endereço inexistente, ou recurso de outra unidade.Confira o id e o X-Location-Id.
405method_not_allowedMétodo HTTP não aceito pelo endereço.Confira o método na referência.
409idempotency_conflictChave de idempotência reutilizada com outro conteúdo, ou ainda em processamento.Use uma chave nova para um comando novo.
422validation_errorDados inválidos ou regra de negócio, como etapa não permitida. As mensagens vêm em pt-BR em details.Corrija os campos indicados.
429too_many_requestsMais de 60 requisições por minuto do mesmo usuário (somando os tokens dele).Espere o tempo de Retry-After e repita.
5xxinternal_errorFalha inesperada.Repita depois. Com Idempotency-Key, repetir é seguro.

Exemplo real de regra de negócio: tentar concluir um pedido que acabou de ser aceito.

{
  "error": {
    "code": "validation_error",
    "message": "Os dados enviados são inválidos.",
    "details": {
      "to_state": [
        "Não é possível mover o pedido para a etapa solicitada a partir da situação atual."
      ]
    }
  },
  "meta": {
    "correlation_id": "69851a89-657b-412c-a47f-83605dcd83d6"
  }
}

Guarde o correlation_id (também no cabeçalho X-Correlation-Id): com ele o suporte encontra a chamada nos registros.

Limites

O limite é de 60 requisições por minuto por usuário do painel: todos os tokens gerados pelo mesmo usuário somam nessa cota. Para integrações de volume alto, gere o token com um usuário próprio da integração. As respostas trazem X-RateLimit-Limit e X-RateLimit-Remaining. Ao passar do limite, a API responde 429 com Retry-After. Para acompanhar pedidos, prefira os webhooks a consultar a API em intervalos curtos.

Guia: criar um pedido de ponta a ponta

O fluxo típico de um site, aplicativo ou agente de atendimento: achar o produto, cotar, criar o pedido e acompanhar as etapas. Escopos usados: catalog:read, orders:write e orders:transition.

1. Encontrar o produto e as opções

GET /catalog/menus?search=Calabresa&per_page=2. Cada produto traz options, com os valores das opções. Use o id do valor (por exemplo, a borda "Catupiry") em option_values.

{
  "data": [
    {
      "id": 2,
      "name": "Pizza Calabresa G",
      "description": "Calabresa fatiada, cebola roxa e azeitonas.",
      "price_minor": 5490,
      "currency": "BRL",
      "available": true,
      "priority": 1,
      "image_url": "http://localhost:8092/storage/media/attachments/public/6af/42b/668/6af42b66831c8537261537.jpg",
      "categories": [
        {
          "id": 1,
          "name": "Pizzas"
        }
      ],
      "location_id": 1,
      "options": [
        {
          "id": 2,
          "option_id": 1,
          "name": "Borda",
          "display_type": "radio",
          "is_required": true,
          "min_selected": 1,
          "max_selected": 1,
          "values": [
            {
              "id": 5,
              "option_value_id": 1,
              "name": "Sem borda",
              "price_minor": 0,
              "currency": "BRL",
              "is_default": true
            },
            {
              "id": 6,
              "option_value_id": 2,
              "name": "Catupiry",
              "price_minor": 990,
              "currency": "BRL",
              "is_default": false
            },
            {
              "id": 7,
              "option_value_id": 3,
              "name": "Cheddar",
              "price_minor": 990,
              "currency": "BRL",
              "is_default": false
            },
            {
              "id": 8,
              "option_value_id": 4,
              "name": "Chocolate",
              "price_minor": 1190,
              "currency": "BRL",
              "is_default": false
            }
          ]
        }
      ]
    }
  ],
  "meta": {
    "correlation_id": "e6462312-aca6-4272-9748-117cd346bb35",
    "current_page": 1,
    "per_page": 2,
    "total": 1,
    "last_page": 1
  }
}

2. Cotar

POST /orders/quote calcula preços, adicionais, cupom e entrega sem criar nada. Guarde o total_minor.

{
  "order_type": "collection",
  "items": [
    {
      "menu_id": 2,
      "quantity": 1,
      "option_values": [
        6
      ],
      "comment": "Bem assada"
    },
    {
      "menu_id": 17,
      "quantity": 1
    }
  ],
  "first_name": "Marina",
  "last_name": "Exemplo",
  "telephone": "(91) 90000-0000",
  "email": "marina@example.com",
  "payment": "cash"
}
{
  "data": {
    "order_total": 79.7,
    "order_menus": [
      {
        "id": 2,
        "name": "Pizza Calabresa G",
        "qty": 1,
        "price": 64.8,
        "subtotalWithoutConditions": 64.8,
        "subtotal": 64.8,
        "hasConditions": false,
        "comment": "Bem assada",
        "options": [
          {
            "id": 2,
            "name": "Borda",
            "values": [
              {
                "id": 6,
                "name": "Catupiry",
                "price": 9.9,
                "qty": 1
              }
            ]
          }
        ]
      },
      {
        "id": 17,
        "name": "Refrigerante Cola 2L",
        "qty": 1,
        "price": 14.9,
        "subtotalWithoutConditions": 14.9,
        "subtotal": 14.9,
        "hasConditions": false,
        "comment": "",
        "options": []
      }
    ],
    "order_totals": [
      {
        "code": "subtotal",
        "title": "Subtotal",
        "value": 79.7,
        "priority": 0,
        "is_summable": false
      },
      {
        "code": "total",
        "title": "Total do pedido",
        "value": 79.7,
        "priority": 999,
        "is_summable": false
      }
    ],
    "total_minor": 7970,
    "currency": "BRL"
  }
}

3. Criar o pedido

POST /orders com o mesmo corpo, o expected_total_minor cotado e uma Idempotency-Key. Se o total mudou entre a cotação e a criação (preço alterado, item esgotado), o pedido é recusado com 422 em vez de cobrar um valor diferente do mostrado ao cliente. O campo payment recebe o código de um meio ativo em GET /payment-methods (por exemplo, cash) ou, para pagamento online, de GET /checkout-methods.

{
  "data": {
    "id": 6830,
    "location_id": 1,
    "customer_id": null,
    "state": "placed",
    "state_version": 1,
    "total_minor": 7970,
    "currency": "BRL",
    "payment": "cash",
    "paid": false,
    "total_items": 2,
    "order_type": "collection",
    "created_at": "2026-11-12T19:29:54.000000Z",
    "items": [
      {
        "id": 4868,
        "menu_id": 2,
        "name": "Pizza Calabresa G",
        "quantity": 1,
        "unit_price_minor": 5490,
        "subtotal_minor": 6480,
        "option_values": [
          6
        ]
      },
      {
        "id": 4869,
        "menu_id": 17,
        "name": "Refrigerante Cola 2L",
        "quantity": 1,
        "unit_price_minor": 1490,
        "subtotal_minor": 1490,
        "option_values": []
      }
    ],
    "totals": [
      {
        "code": "subtotal",
        "title": "Subtotal",
        "amount_minor": 7970
      },
      {
        "code": "total",
        "title": "Total do pedido",
        "amount_minor": 7970
      }
    ]
  }
}

4. Acompanhar e mudar a etapa

Etapas: placed → accepted → preparing → ready → dispatched → completed. O cancelamento (cancelled) é permitido até preparing. De ready, o pedido vai para dispatched (saiu para entrega) ou direto para completed. Mude com POST /orders/{order}/transition:

{ "to_state": "accepted" }
{
  "data": {
    "order_id": 6830,
    "state": "accepted",
    "version": 2
  }
}

Para pagamento online, depois de criar o pedido chame POST /orders/{order}/checkout (Pix ou página do gateway) e acompanhe com GET /orders/{order}/checkout/status. A confirmação vem do gateway; a API não marca pagamento como recebido por conta própria.

Código completo

#!/usr/bin/env bash
# Chamejar API v1 — fluxo completo de um pedido de retirada, com curl e jq.
#
#   export CHAMEJAR_URL="https://endereco-do-seu-chamejar"   # sem /api/v1 no fim
#   export CHAMEJAR_TOKEN="seu-token"                         # Configurações → APIs → Gerar meu token
#   export CHAMEJAR_UNIDADE=1                                 # id da unidade
#   ./fluxo-pedido.sh
#
# Escopos usados: catalog:read, orders:write e orders:transition.
set -euo pipefail
: "${CHAMEJAR_URL:?defina CHAMEJAR_URL}" "${CHAMEJAR_TOKEN:?defina CHAMEJAR_TOKEN}" "${CHAMEJAR_UNIDADE:?defina CHAMEJAR_UNIDADE}"
API="$CHAMEJAR_URL/api/v1"

chamar() { # método caminho [corpo] [chave-de-idempotência]
  # --fail-with-body: para o script em erro HTTP e mostra o JSON de erro da API (curl 7.76+)
  local args=(-sS --fail-with-body -X "$1" "$API$2" -H "Authorization: Bearer $CHAMEJAR_TOKEN" -H "X-Location-Id: $CHAMEJAR_UNIDADE" -H "Accept: application/json")
  [ -n "${3:-}" ] && args+=(-H "Content-Type: application/json" --data "$3")
  [ -n "${4:-}" ] && args+=(-H "Idempotency-Key: $4")
  local saida
  if ! saida=$(curl "${args[@]}"); then
    echo "Erro da API em $1 $2: $saida" >&2   # {"error": {"code", "message", "details"}, ...}
    exit 1
  fi
  printf '%s' "$saida"
}

# 1. Procurar o produto no cardápio
produto=$(chamar GET "/catalog/menus?search=Calabresa&per_page=1" | jq '.data[0]')
[ "$produto" != "null" ] || { echo "Produto não encontrado no cardápio." >&2; exit 1; }
menu_id=$(jq '.id' <<<"$produto")
# id da opção "Catupiry" no grupo "Borda" (se o produto tiver opções)
borda=$(jq '[.options[]?.values[]? | select(.name == "Catupiry") | .id][0] // empty' <<<"$produto")
echo "Produto: $(jq -r '.name' <<<"$produto") (id $menu_id)"

pedido=$(jq -n --argjson menu "$menu_id" --argjson borda "${borda:-null}" '{
  order_type: "collection",
  first_name: "Marina", last_name: "Exemplo", telephone: "(91) 90000-0000", email: "marina@example.com",
  payment: "cash",
  items: [{menu_id: $menu, quantity: 1, option_values: ([$borda] | map(select(. != null))), comment: "Bem assada"}]
}')

# 2. Cotar: o servidor calcula preços, adicionais, cupom e entrega
total=$(chamar POST /orders/quote "$pedido" | jq '.data.total_minor')
echo "Total cotado: $total centavos"

# 3. Criar o pedido. A mesma chave de idempotência pode ser reenviada com segurança após uma falha de rede.
chave=$(cat /proc/sys/kernel/random/uuid 2>/dev/null || uuidgen)
criado=$(chamar POST /orders "$(jq --argjson t "$total" '. + {expected_total_minor: $t}' <<<"$pedido")" "$chave")
pedido_id=$(jq '.data.id' <<<"$criado")
echo "Pedido criado: #$pedido_id ($(jq -r '.data.state' <<<"$criado"))"

# 4. Aceitar o pedido (placed → accepted)
chamar POST "/orders/$pedido_id/transition" '{"to_state":"accepted"}' "$(cat /proc/sys/kernel/random/uuid 2>/dev/null || uuidgen)" | jq -c '.data'

Os três arquivos estão no pacote de exemplos e foram testados contra o sistema.

Webhooks: avisos automáticos para a sua integração

Em vez de consultar a API o tempo todo, o Chamejar pode avisar o seu sistema quando algo muda. Configure em Configurações → Webhooks: informe a URL que vai receber os avisos, escolha os eventos e defina um segredo.

EventoAvisa quando
Pedidospedido criado (created), alterado (updated), pago (placed), mudou de situação (status_added), atribuído (assigned) ou excluído (deleted)
Produtosproduto criado, alterado, estoque atualizado após uma venda ou excluído
Categorias, clientes, reservas e mesascriado, alterado ou excluído

Cada aviso é um POST com JSON. O campo action diz o que aconteceu. No evento de pedidos, o corpo traz order, order_menus, order_totals e, quando a situação muda, status_history.

Conferir a assinatura

Com o segredo configurado, o aviso chega com o cabeçalho Signature: o HMAC-SHA256, em hexadecimal, do corpo da requisição. Calcule sobre o corpo exatamente como chegou, sem decodificar e recodificar o JSON, e compare em tempo constante. Responda 2xx rápido e processe em segundo plano.

"""Recebe webhooks de saída do Chamejar e confere a assinatura (Python 3.9+, só biblioteca padrão).

No painel: Configurações → Webhooks → crie o webhook com a URL deste servidor e um segredo.
O Chamejar envia POST com corpo JSON e o cabeçalho "Signature" = HMAC-SHA256 (hex) do corpo, com o segredo.

    CHAMEJAR_WEBHOOK_SEGREDO=seu-segredo python3 verificar_webhook.py   # escuta na porta 8787
"""
import hashlib
import hmac
import json
import os
from http.server import BaseHTTPRequestHandler, HTTPServer

SEGREDO = os.environ['CHAMEJAR_WEBHOOK_SEGREDO'].encode()


def assinatura_valida(corpo_bruto: bytes, assinatura: str) -> bool:
    # Calcule sobre o corpo exatamente como chegou: não decodifique e recodifique o JSON antes.
    esperada = hmac.new(SEGREDO, corpo_bruto, hashlib.sha256).hexdigest()
    return hmac.compare_digest(esperada, assinatura or '')


class Receptor(BaseHTTPRequestHandler):
    def do_POST(self):
        corpo = self.rfile.read(int(self.headers.get('Content-Length', 0)))
        if not assinatura_valida(corpo, self.headers.get('Signature', '')):
            self.send_response(401); self.end_headers(); return
        evento = json.loads(corpo)
        # "action" indica o que aconteceu: created, updated, placed, status_added, assigned, deleted...
        pedido = evento.get('order') or {}
        print(f"{evento.get('action')}: pedido #{pedido.get('order_id')} situação {pedido.get('status_id')}")
        self.send_response(200); self.end_headers()  # responda 2xx rápido; processe em segundo plano se demorar


if __name__ == '__main__':
    HTTPServer(('0.0.0.0', 8787), Receptor).serve_forever()

Os endereços do grupo "Webhooks de entrada" da referência são outra coisa: são chamados pelo iFood, pelo aiqfome e por outros provedores para avisar o Chamejar. Não chame esses endereços a partir da sua integração.

Boas práticas

  • Um token por integração, com só as permissões necessárias e validade definida.
  • Nunca exponha o token num site ou aplicativo do cliente final. Chame a API a partir do seu servidor.
  • Sempre cote antes de criar o pedido e envie o expected_total_minor.
  • Gere uma Idempotency-Key por comando e reaproveite a mesma chave ao tentar de novo.
  • Ao receber 429 ou 5xx, espere e tente de novo com intervalos crescentes.
  • Registre o X-Correlation-Id das respostas para falar com o suporte.

Referência das operações

Clique numa operação para ver escopo, parâmetros, corpo e um exemplo em curl. Nos exemplos, troque 123 e os valores entre < > pelos ids reais.

Plataforma

Saúde do serviço e dados da unidade.

GET/healthVerificar se o serviço está no ar

Sem autenticação

Liveness da aplicação

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/health" \
  -H "Accept: application/json"

Resposta real 200 · dados fictícios da demonstração

{
  "data": {
    "status": "ok",
    "service": "Chamejar",
    "version": "v1",
    "time": "2026-11-12T16:29:52-03:00"
  },
  "meta": {
    "correlation_id": "a27c133f-0c8e-4818-aaaa-95b642290b2c"
  }
}
GET/readinessVerificar se banco, cache e fila estão prontos

Sem autenticação

Banco, cache e fila prontos para tráfego

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/readiness" \
  -H "Accept: application/json"
GET/storeConsultar dados e horários da unidade

catalog:readX-Location-Id

Perfil e horários semanais da unidade selecionada

Exige catalog:read e X-Location-Id. Os horários são a grade cadastrada; exceções e disponibilidade no instante da consulta devem ser confirmadas antes de prometer entrega.

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/store" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"

Resposta real 200 · dados fictícios da demonstração

{
  "data": {
    "id": 1,
    "name": "Pizzaria Brasa Viva",
    "description": "Pizzaria fictícia usada nas telas de demonstração.",
    "telephone": "(91) 3000-0000",
    "enabled": true,
    "address": {
      "line_1": "Travessa das Mangueiras, 120",
      "line_2": null,
      "city": "Belém",
      "state": "PA",
      "postcode": "66000-000",
      "country_id": 32
    },
    "weekly_hours": [
      {
        "type": "opening",
        "weekday": 0,
        "opens_at": "00:00:00",
        "closes_at": "23:59:00",
        "enabled": true
      },
      {
        "type": "opening",
        "weekday": 1,
        "opens_at": "00:00:00",
        "closes_at": "23:59:00",
        "enabled": true
      },
      {
        "type": "opening",
        "weekday": 2,
        "opens_at": "00:00:00",
        "closes_at": "23:59:00",
        "enabled": true
      },
      {
        "type": "opening",
        "weekday": 3,
        "opens_at": "00:00:00",
        "closes_at": "23:59:00",
        "enabled": true
      },
      {
        "type": "opening",
        "weekday": 4,
        "opens_at": "00:00:00",
        "closes_at": "23:59:00",
        "enabled": true
      },
      {
        "type": "opening",
        "weekday": 5,
        "opens_at": "00:00:00",
        "closes_at": "23:59:00",
        "enabled": true
      },
      {
        "type": "opening",
        "weekday": 6,
        "opens_at": "00:00:00",
        "closes_at": "23:59:00",
        "enabled": true
      },
      {
        "type": "delivery",
        "weekday": 0,
        "opens_at": "00:00:00",
        "closes_at": "23:59:00",
        "enabled": true
      },
      {
        "type": "delivery",
        "weekday": 1,
        "opens_at": "00:00:00",
        "closes_at": "23:59:00",
        "enabled": true
      },
      {
        "type": "delivery",
        "weekday": 2,
        "opens_at": "00:00:00",
        "closes_at": "23:59:00",
        "enabled": true
      },
      {
        "type": "delivery",
        "weekday": 3,
        "opens_at": "00:00:00",
        "closes_at": "23:59:00",
        "enabled": true
      },
      {
        "type": "delivery",
        "weekday": 4,
        "opens_at": "00:00:00",
        "closes_at": "23:59:00",
        "enabled": true
      },
      {
        "type": "delivery",
        "weekday": 5,
        "opens_at": "00:00:00",
        "closes_at": "23:59:00",
        "enabled": true
      },
      {
        "type": "delivery",
        "weekday": 6,
        "opens_at": "00:00:00",
        "closes_at": "23:59:00",
        "enabled": true
      },
      {
        "type": "collection",
        "weekday": 0,
        "opens_at": "00:00:00",
        "closes_at": "23:59:00",
        "enabled": true
      },
      {
        "type": "collection",
        "weekday": 1,
        "opens_at": "00:00:00",
        "closes_at": "23:59:00",
        "enabled": true
      },
      {
        "type": "collection",
        "weekday": 2,
        "opens_at": "00:00:00",
        "closes_at": "23:59:00",
        "enabled": true
      },
      {
        "type": "collection",
        "weekday": 3,
        "opens_at": "00:00:00",
        "closes_at": "23:59:00",
        "enabled": true
      },
      {
        "type": "collection",
        "weekday": 4,
        "opens_at": "00:00:00",
        "closes_at": "23:59:00",
        "enabled": true
      },
      {
        "type": "collection",
        "weekday": 5,
        "opens_at": "00:00:00",
        "closes_at": "23:59:00",
  …

Cardápio

Produtos

GET/catalog/menusListar produtos do cardápio

catalog:readX-Location-Id

Parâmetros

NomeOndeTipoDescrição
per_pageconsultainteger
searchconsultastring
channelconsultastringValores: all, pos, delivery, table, marketplace, kiosk.
atconsultastringInstante ISO-8601 usado para avaliação determinística

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/catalog/menus" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"

Resposta real 200 · dados fictícios da demonstração

{
  "data": [
    {
      "id": 2,
      "name": "Pizza Calabresa G",
      "description": "Calabresa fatiada, cebola roxa e azeitonas.",
      "price_minor": 5490,
      "currency": "BRL",
      "available": true,
      "priority": 1,
      "image_url": "http://localhost:8092/storage/media/attachments/public/6af/42b/668/6af42b66831c8537261537.jpg",
      "categories": [
        {
          "id": 1,
          "name": "Pizzas"
        }
      ],
      "location_id": 1,
      "options": [
        {
          "id": 2,
          "option_id": 1,
          "name": "Borda",
          "display_type": "radio",
          "is_required": true,
          "min_selected": 1,
          "max_selected": 1,
          "values": [
            {
              "id": 5,
              "option_value_id": 1,
              "name": "Sem borda",
              "price_minor": 0,
              "currency": "BRL",
              "is_default": true
            },
            {
              "id": 6,
              "option_value_id": 2,
              "name": "Catupiry",
              "price_minor": 990,
              "currency": "BRL",
              "is_default": false
            },
            {
              "id": 7,
              "option_value_id": 3,
              "name": "Cheddar",
              "price_minor": 990,
              "currency": "BRL",
              "is_default": false
            },
            {
              "id": 8,
              "option_value_id": 4,
              "name": "Chocolate",
              "price_minor": 1190,
              "currency": "BRL",
              "is_default": false
            }
          ]
        }
      ]
    }
  ],
  "meta": {
    "correlation_id": "e6462312-aca6-4272-9748-117cd346bb35",
    "current_page": 1,
    "per_page": 2,
    "total": 1,
    "last_page": 1
  }
}
POST/catalog/menusCriar produto

catalog:writeIdempotency-KeyX-Location-Id

Corpo application/json

CampoTipoDescrição
menu_name obrigatóriostring
menu_descriptionstring
menu_price obrigatórionumber
category_idsarray

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/catalog/menus" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "menu_name": "texto",
  "menu_price": 10.5
}'
GET/catalog/exportExportar o catálogo da unidade

catalog:readX-Location-Id

Parâmetros

NomeOndeTipoDescrição
include_disabledconsultaboolean

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/catalog/export" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/catalog/import/previewSimular importação de catálogo

catalog:readX-Location-Id

Corpo application/json

CampoTipoDescrição
confirmbooleanObrigatório somente na aplicação do preview
items obrigatórioarray
items[].idinteger
items[].menu_name obrigatóriostring
items[].menu_descriptionstring
items[].menu_price obrigatórionumber
items[].menu_statusboolean
items[].menu_priorityinteger
items[].category_idsarray

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/catalog/import/preview" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "items": [
    {
      "menu_name": "texto",
      "menu_price": 10.5
    }
  ]
}'
POST/catalog/importImportar catálogo

catalog:writeIdempotency-KeyX-Location-Id

Corpo application/json

CampoTipoDescrição
confirmbooleanObrigatório somente na aplicação do preview
items obrigatórioarray
items[].idinteger
items[].menu_name obrigatóriostring
items[].menu_descriptionstring
items[].menu_price obrigatórionumber
items[].menu_statusboolean
items[].menu_priorityinteger
items[].category_idsarray

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/catalog/import" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "items": [
    {
      "menu_name": "texto",
      "menu_price": 10.5
    }
  ]
}'
GET/catalog/categoriesListar categorias

catalog:readX-Location-Id

Parâmetros

NomeOndeTipoDescrição
per_pageconsultainteger

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/catalog/categories" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"

Resposta real 200 · dados fictícios da demonstração

{
  "data": [
    {
      "id": 1,
      "name": "Pizzas",
      "description": "",
      "parent_id": null
    },
    {
      "id": 2,
      "name": "Lanches",
      "description": "",
      "parent_id": null
    },
    {
      "id": 3,
      "name": "Pratos",
      "description": "",
      "parent_id": null
    },
    {
      "id": 4,
      "name": "Porções",
      "description": "",
      "parent_id": null
    },
    {
      "id": 5,
      "name": "Bebidas",
      "description": "",
      "parent_id": null
    },
    {
      "id": 6,
      "name": "Sobremesas",
      "description": "",
      "parent_id": null
    }
  ],
  "meta": {
    "correlation_id": "4c8b7898-923c-46bb-9cdf-4dbb7e802a38",
    "current_page": 1,
    "per_page": 25,
    "total": 6,
    "last_page": 1
  }
}
POST/catalog/categoriesCriar categoria

catalog:writeIdempotency-KeyX-Location-Id

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/catalog/categories" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
GET/catalog/optionsListar grupos de opções

catalog:readX-Location-Id

Parâmetros

NomeOndeTipoDescrição
per_pageconsultainteger

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/catalog/options" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/catalog/optionsCriar grupo de opções

catalog:writeIdempotency-KeyX-Location-Id

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/catalog/options" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
GET/catalog/menus/{menu}Consultar produto

catalog:readX-Location-Id

Parâmetros

NomeOndeTipoDescrição
menu obrigatóriocaminhointeger

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/catalog/menus/123" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
PUT/catalog/menus/{menu}Alterar produto

catalog:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
menu obrigatóriocaminhointeger

Exemplo

curl -X PUT "$CHAMEJAR_URL/api/v1/catalog/menus/123" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
DELETE/catalog/menus/{menu}Excluir produto

catalog:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
menu obrigatóriocaminhointeger

Exemplo

curl -X DELETE "$CHAMEJAR_URL/api/v1/catalog/menus/123" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
GET/catalog/menus/{menu}/availabilityConsultar regras de disponibilidade do produto

catalog:readX-Location-Id

Parâmetros

NomeOndeTipoDescrição
menu obrigatóriocaminhointeger

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/catalog/menus/123/availability" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
PUT/catalog/menus/{menu}/availabilitySubstituir regras de disponibilidade do produto

catalog:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
menu obrigatóriocaminhointeger

Corpo application/json

CampoTipoDescrição
rules obrigatórioarray
rules[].channel obrigatóriostringValores: all, pos, delivery, table, marketplace, kiosk.
rules[].weekdayinteger
rules[].starts_atstring
rules[].ends_atstring
rules[].is_available obrigatórioboolean
rules[].priorityinteger
rules[].reasonstring

Exemplo

curl -X PUT "$CHAMEJAR_URL/api/v1/catalog/menus/123/availability" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "rules": [
    {
      "channel": "all",
      "is_available": true
    }
  ]
}'
PUT/catalog/categories/{category}Alterar categoria

catalog:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
category obrigatóriocaminhointeger

Exemplo

curl -X PUT "$CHAMEJAR_URL/api/v1/catalog/categories/123" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
DELETE/catalog/categories/{category}Excluir categoria

catalog:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
category obrigatóriocaminhointeger

Exemplo

curl -X DELETE "$CHAMEJAR_URL/api/v1/catalog/categories/123" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
PUT/catalog/options/{option}Alterar grupo de opções

catalog:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
option obrigatóriocaminhointeger

Exemplo

curl -X PUT "$CHAMEJAR_URL/api/v1/catalog/options/123" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"

Clientes

Cadastro de clientes e endereços de entrega.

GET/customersListar clientes

customers:readX-Location-Id

Parâmetros

NomeOndeTipoDescrição
per_pageconsultainteger

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/customers" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/customersCadastrar cliente

customers:writeIdempotency-KeyX-Location-Id

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/customers" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
GET/customers/lookupBuscar cliente pelo telefone

customers:readX-Location-Id

Busca exata de cliente por telefone com DDD

Aceita números com ou sem código 55 e pontuação. Retorna apenas clientes vinculados à unidade, até 10 correspondências. Não usa busca parcial para identificar o comprador.

Parâmetros

NomeOndeTipoDescrição
telephone obrigatórioconsultastring

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/customers/lookup?telephone=(91) 90000-0000" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
GET/customers/{customer}Consultar cliente

customers:readX-Location-Id

Parâmetros

NomeOndeTipoDescrição
customer obrigatóriocaminhointeger

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/customers/123" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
PUT/customers/{customer}Alterar cliente

customers:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
customer obrigatóriocaminhointeger

Exemplo

curl -X PUT "$CHAMEJAR_URL/api/v1/customers/123" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
POST/customers/{customer}/addressesCadastrar endereço do cliente

customers:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
customer obrigatóriocaminhointeger

Corpo application/json

CampoTipoDescrição
address_1 obrigatóriostringRua e número; inclua o bairro se conhecido
address_2string
citystring
statestring
postcodestring
country_id obrigatóriointegerID do país válido na instalação

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/customers/123/addresses" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "address_1": "texto",
  "country_id": 123
}'
PUT/customers/{customer}/addresses/{address}Alterar endereço do cliente

customers:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
customer obrigatóriocaminhointeger
address obrigatóriocaminhointeger

Corpo application/json

CampoTipoDescrição
address_1string
address_2string
citystring
statestring
postcodestring
country_idinteger

Exemplo

curl -X PUT "$CHAMEJAR_URL/api/v1/customers/123/addresses/123" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "address_1": "texto",
  "address_2": "texto",
  "city": "texto",
  "state": "texto"
}'

Fidelidade e crédito

Saldo de pontos e crédito em reais por cliente.

GET/loyalty/customers/{customer}Consultar saldo de pontos e crédito do cliente

loyalty:readX-Location-Id

Parâmetros

NomeOndeTipoDescrição
customer obrigatóriocaminhointeger

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/loyalty/customers/123" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
GET/loyalty/customers/{customer}/entriesListar lançamentos de fidelidade do cliente

loyalty:readX-Location-Id

Parâmetros

NomeOndeTipoDescrição
per_pageconsultainteger
customer obrigatóriocaminhointeger

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/loyalty/customers/123/entries" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/loyalty/customers/{customer}/entriesLançar pontos ou crédito para o cliente

loyalty:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
customer obrigatóriocaminhointeger

Corpo application/json

CampoTipoDescrição
kind obrigatóriostringValores: credit, debit, earn, redeem, adjustment.
points_deltainteger
credit_delta_minorinteger
reason obrigatóriostring
reference_typestring
reference_idstring
metadataobject

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/loyalty/customers/123/entries" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "kind": "credit",
  "reason": "texto"
}'
POST/loyalty/entries/{entry}/reverseReverter lançamento de fidelidade

loyalty:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
entry obrigatóriocaminhostring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/loyalty/entries/<entry>/reverse" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"

Pedidos

Cotação

GET/ordersListar pedidos

orders:readX-Location-Id

Parâmetros

NomeOndeTipoDescrição
per_pageconsultainteger

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/orders" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"

Resposta real 200 · dados fictícios da demonstração

{
  "data": [
    {
      "id": 6830,
      "location_id": 1,
      "customer_id": null,
      "state": "accepted",
      "state_version": 2,
      "total_minor": 7970,
      "currency": "BRL",
      "payment": "cash",
      "paid": false,
      "total_items": 2,
      "order_type": "collection",
      "created_at": "2026-11-12T19:29:54.000000Z",
      "items": [
        {
          "id": 4868,
          "menu_id": 2,
          "name": "Pizza Calabresa G",
          "quantity": 1,
          "unit_price_minor": 5490,
          "subtotal_minor": 6480,
          "option_values": [
            6
          ]
        },
        {
          "id": 4869,
          "menu_id": 17,
          "name": "Refrigerante Cola 2L",
          "quantity": 1,
          "unit_price_minor": 1490,
          "subtotal_minor": 1490,
          "option_values": []
        }
      ],
      "totals": [
        {
          "code": "subtotal",
          "title": "Subtotal",
          "amount_minor": 7970
        },
        {
          "code": "total",
          "title": "Total do pedido",
          "amount_minor": 7970
        }
      ]
    },
    {
      "id": 6829,
      "location_id": 1,
      "customer_id": null,
      "state": "preparing",
      "state_version": 3,
      "total_minor": 6480,
      "currency": "BRL",
      "payment": "cash",
      "paid": false,
      "total_items": 1,
      "order_type": "collection",
      "created_at": "2026-11-12T19:29:39.000000Z",
      "items": [
        {
          "id": 4867,
          "menu_id": 2,
          "name": "Pizza Calabresa G",
          "quantity": 1,
          "unit_price_minor": 5490,
          "subtotal_minor": 6480,
          "option_values": [
            6
          ]
        }
      ],
      "totals": [
        {
          "code": "subtotal",
          "title": "Subtotal",
          "amount_minor": 6480
        },
        {
          "code": "total",
          "title": "Total do pedido",
          "amount_minor": 6480
        }
      ]
    }
  ],
  "meta": {
    "correlation_id": "1892e56e-52fa-4a18-acfc-7c1da6edbc9c",
    "current_page": 1,
    "per_page": 2,
    "total": 2031,
    "last_page": 1016
  }
}
POST/ordersCriar pedido

orders:writeIdempotency-KeyX-Location-Id

Corpo application/json

CampoTipoDescrição
items obrigatórioarray
items[].menu_id obrigatóriointeger
items[].quantity obrigatóriointeger
items[].option_valuesarrayIDs de adicionais ou objetos; quantidade acumulada por adicional limitada a 99
items[].commentstring
order_typestringValores: collection, delivery.
customer_idinteger
address_idintegerObrigatório para entrega; endereço do cliente na unidade
coupon_codestring
expected_total_minorintegerValor cotado em centavos; usado apenas ao criar o pedido
paymentstringCódigo de meio ativo, por exemplo asaas_pix ou mercadopago

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/orders" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "order_type": "collection",
  "items": [
    {
      "menu_id": 2,
      "quantity": 1,
      "option_values": [
        6
      ],
      "comment": "Bem assada"
    },
    {
      "menu_id": 17,
      "quantity": 1
    }
  ],
  "first_name": "Marina",
  "last_name": "Exemplo",
  "telephone": "(91) 90000-0000",
  "email": "marina@example.com",
  "payment": "cash",
  "expected_total_minor": 7970
}'

Resposta real 201 · dados fictícios da demonstração

{
  "data": {
    "id": 6830,
    "location_id": 1,
    "customer_id": null,
    "state": "placed",
    "state_version": 1,
    "total_minor": 7970,
    "currency": "BRL",
    "payment": "cash",
    "paid": false,
    "total_items": 2,
    "order_type": "collection",
    "created_at": "2026-11-12T19:29:54.000000Z",
    "items": [
      {
        "id": 4868,
        "menu_id": 2,
        "name": "Pizza Calabresa G",
        "quantity": 1,
        "unit_price_minor": 5490,
        "subtotal_minor": 6480,
        "option_values": [
          6
        ]
      },
      {
        "id": 4869,
        "menu_id": 17,
        "name": "Refrigerante Cola 2L",
        "quantity": 1,
        "unit_price_minor": 1490,
        "subtotal_minor": 1490,
        "option_values": []
      }
    ],
    "totals": [
      {
        "code": "subtotal",
        "title": "Subtotal",
        "amount_minor": 7970
      },
      {
        "code": "total",
        "title": "Total do pedido",
        "amount_minor": 7970
      }
    ]
  }
}
POST/orders/quoteCotar pedido (itens, adicionais, cupom e entrega)

orders:readX-Location-Id

Cotação canônica de itens, adicionais, cupom e entrega

Requer orders:read. Para entrega, informe customer_id e address_id de um endereço cadastrado; o servidor geocodifica o endereço e verifica a área da unidade. Use data.total_minor como expected_total_minor ao criar o pedido; a API recalcula o preço e recusa divergências.

Corpo application/json

CampoTipoDescrição
items obrigatórioarray
items[].menu_id obrigatóriointeger
items[].quantity obrigatóriointeger
items[].option_valuesarrayIDs de adicionais ou objetos; quantidade acumulada por adicional limitada a 99
items[].commentstring
order_typestringValores: collection, delivery.
customer_idinteger
address_idintegerObrigatório para entrega; endereço do cliente na unidade
coupon_codestring
expected_total_minorintegerValor cotado em centavos; usado apenas ao criar o pedido
paymentstringCódigo de meio ativo, por exemplo asaas_pix ou mercadopago

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/orders/quote" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "order_type": "collection",
  "items": [
    {
      "menu_id": 2,
      "quantity": 1,
      "option_values": [
        6
      ],
      "comment": "Bem assada"
    },
    {
      "menu_id": 17,
      "quantity": 1
    }
  ],
  "first_name": "Marina",
  "last_name": "Exemplo",
  "telephone": "(91) 90000-0000",
  "email": "marina@example.com",
  "payment": "cash"
}'

Resposta real 200 · dados fictícios da demonstração

{
  "data": {
    "order_total": 79.7,
    "order_menus": [
      {
        "id": 2,
        "name": "Pizza Calabresa G",
        "qty": 1,
        "price": 64.8,
        "subtotalWithoutConditions": 64.8,
        "subtotal": 64.8,
        "hasConditions": false,
        "comment": "Bem assada",
        "options": [
          {
            "id": 2,
            "name": "Borda",
            "values": [
              {
                "id": 6,
                "name": "Catupiry",
                "price": 9.9,
                "qty": 1
              }
            ]
          }
        ]
      },
      {
        "id": 17,
        "name": "Refrigerante Cola 2L",
        "qty": 1,
        "price": 14.9,
        "subtotalWithoutConditions": 14.9,
        "subtotal": 14.9,
        "hasConditions": false,
        "comment": "",
        "options": []
      }
    ],
    "order_totals": [
      {
        "code": "subtotal",
        "title": "Subtotal",
        "value": 79.7,
        "priority": 0,
        "is_summable": false
      },
      {
        "code": "total",
        "title": "Total do pedido",
        "value": 79.7,
        "priority": 999,
        "is_summable": false
      }
    ],
    "total_minor": 7970,
    "currency": "BRL"
  }
}
POST/orders/{order}/transitionMudar a etapa do pedido

orders:transitionIdempotency-KeyX-Location-Id

Etapas: placed → accepted → preparing → ready → dispatched → completed. cancelled é permitido até preparing; de ready o pedido vai para dispatched ou completed. Transição não permitida responde 422 em error.details.to_state.

Parâmetros

NomeOndeTipoDescrição
order obrigatóriocaminhointeger

Corpo application/json

CampoTipoDescrição
to_state obrigatóriostringPróxima etapa do pedido Valores: placed, accepted, preparing, ready, dispatched, completed, cancelled.
reason_codestringMotivo operacional, quando a etapa exigir (ex.: cancelamento)

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/orders/123/transition" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "to_state": "accepted"
}'

Resposta real 200 · dados fictícios da demonstração

{
  "data": {
    "order_id": 6830,
    "state": "accepted",
    "version": 2
  }
}
GET/orders/{order}Consultar pedido

orders:readX-Location-Id

Parâmetros

NomeOndeTipoDescrição
order obrigatóriocaminhointeger

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/orders/123" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"

Resposta real 200 · dados fictícios da demonstração

{
  "data": {
    "id": 6830,
    "location_id": 1,
    "customer_id": null,
    "state": "placed",
    "state_version": 1,
    "total_minor": 7970,
    "currency": "BRL",
    "payment": "cash",
    "paid": false,
    "total_items": 2,
    "order_type": "collection",
    "created_at": "2026-11-12T19:29:54.000000Z",
    "items": [
      {
        "id": 4868,
        "menu_id": 2,
        "name": "Pizza Calabresa G",
        "quantity": 1,
        "unit_price_minor": 5490,
        "subtotal_minor": 6480,
        "option_values": [
          6
        ]
      },
      {
        "id": 4869,
        "menu_id": 17,
        "name": "Refrigerante Cola 2L",
        "quantity": 1,
        "unit_price_minor": 1490,
        "subtotal_minor": 1490,
        "option_values": []
      }
    ],
    "totals": [
      {
        "code": "subtotal",
        "title": "Subtotal",
        "amount_minor": 7970
      },
      {
        "code": "total",
        "title": "Total do pedido",
        "amount_minor": 7970
      }
    ]
  }
}
PUT/orders/{order}/paymentTrocar o meio de pagamento do pedido

orders:writeIdempotency-KeyX-Location-Id

Trocar meio de pagamento de pedido ainda sem checkout e sem pagamento

Parâmetros

NomeOndeTipoDescrição
order obrigatóriocaminhointeger

Corpo application/json

CampoTipoDescrição
payment obrigatóriostring

Exemplo

curl -X PUT "$CHAMEJAR_URL/api/v1/orders/123/payment" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "payment": "texto"
}'
POST/orders/{order}/cancelCancelar pedido

orders:cancelIdempotency-KeyX-Location-Id

No canal próprio cria o cancelamento compensatório. Para pedido iFood, exige cancellation_code disponível no parceiro e retorna 202 com solicitação pendente; o pedido só encerra após CANCELLED. Cancelamentos parciais iFood e cancel-unpaid genérico não são permitidos.

Parâmetros

NomeOndeTipoDescrição
order obrigatóriocaminhointeger

Corpo application/json

CampoTipoDescrição
reason_codestring
cancellation_codestringObrigatório para pedido iFood; consultar motivos no vínculo de marketplace
approval_challengestring?

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/orders/123/cancel" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '"texto"'
POST/orders/{order}/cancel-unpaidCancelar pedido sem pagamento e ainda não iniciado

orders:cancelIdempotency-KeyX-Location-Id

Cancelar somente pedido sem pagamento e ainda não iniciado

Parâmetros

NomeOndeTipoDescrição
order obrigatóriocaminhointeger

Corpo application/json

CampoTipoDescrição
reason_code obrigatóriostringValores: order.cancel.

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/orders/123/cancel-unpaid" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "reason_code": "order.cancel"
}'
POST/orders/{order}/items/{item}/cancelCancelar item do pedido

orders:cancelIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
order obrigatóriocaminhointeger
item obrigatóriocaminhointeger

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/orders/123/items/123/cancel" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"

Pagamentos

Checkout online

GET/checkout-methodsListar meios de checkout online ativos

payments:readX-Location-Id

Gateways online ativos para Pix e checkout hospedado

Requer payments:read. Os códigos retornados podem ser usados em payment ao criar o pedido.

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/checkout-methods" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/orders/{order}/checkoutIniciar checkout online (Pix ou página do gateway)

payments:initiateIdempotency-KeyX-Location-Id

Inicia Pix ou checkout hospedado no gateway escolhido no pedido

Requer payments:initiate. Disponível para asaas_pix, asaas, mercadopago_pix e mercadopago quando o gateway está ativo. Retorna checkout_url para abrir ou enviar ao comprador. Cobranças online somente são confirmadas pelo webhook autenticado do provedor.

Parâmetros

NomeOndeTipoDescrição
order obrigatóriocaminhointeger

Corpo application/json

CampoTipoDescrição
billingobjectDados opcionais do pagador para o checkout Asaas

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/orders/123/checkout" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "billing": {}
}'
GET/orders/{order}/checkout/statusConsultar situação do checkout online

payments:readX-Location-Id

Consulta confirmação local do pagamento e estado operacional

Requer payments:read. paid só passa a verdadeiro após confirmação do provedor.

Parâmetros

NomeOndeTipoDescrição
order obrigatóriocaminhointeger

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/orders/123/checkout/status" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
GET/orders/{order}/payment-intentsConsultar intenção de pagamento do pedido

payments:readX-Location-Id

Parâmetros

NomeOndeTipoDescrição
order obrigatóriocaminhointeger

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/orders/123/payment-intents" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/orders/{order}/payment-intentsCriar intenção de pagamento do pedido

payments:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
order obrigatóriocaminhointeger

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/orders/123/payment-intents" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
POST/payment-intents/{intent}/allocationsAlocar pagamento na intenção

payments:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
intent obrigatóriocaminhostring

Corpo application/json

CampoTipoDescrição
method obrigatóriostringValores: cash, pix, card, asaas, pagbank, mercadopago, pagarme.
amount_minor obrigatóriointeger
tendered_minorintegerObrigatório para dinheiro quando houver troco
cash_session_idinteger
provider_referencestring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/payment-intents/<intent>/allocations" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "method": "cash",
  "amount_minor": 1000
}'
POST/payment-allocations/{allocation}/captureCapturar alocação de pagamento

payments:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
allocation obrigatóriocaminhostring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/payment-allocations/<allocation>/capture" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
POST/payment-allocations/{allocation}/cancelCancelar alocação de pagamento

payments:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
allocation obrigatóriocaminhostring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/payment-allocations/<allocation>/cancel" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
POST/payment-intents/{intent}/completeConcluir intenção de pagamento

payments:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
intent obrigatóriocaminhostring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/payment-intents/<intent>/complete" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
POST/payment-transactions/{transaction}/refundsEstornar transação de pagamento

payments:refundIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
transaction obrigatóriocaminhostring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/payment-transactions/<transaction>/refunds" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
GET/orders/{order}/payment-transactionsListar transações de pagamento do pedido

payments:readX-Location-Id

Parâmetros

NomeOndeTipoDescrição
order obrigatóriocaminhointeger

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/orders/123/payment-transactions" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
GET/payment-intents/{intent}Consultar intenção de pagamento

payments:readX-Location-Id

Parâmetros

NomeOndeTipoDescrição
intent obrigatóriocaminhostring

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/payment-intents/<intent>" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
GET/refunds/{refund}Consultar estorno

payments:readX-Location-Id

Parâmetros

NomeOndeTipoDescrição
refund obrigatóriocaminhostring

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/refunds/<refund>" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
GET/payment-methodsListar meios de pagamento

payments:readX-Location-Id

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/payment-methods" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/payment-methodsCadastrar meio de pagamento

payments:writeIdempotency-KeyX-Location-Id

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/payment-methods" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
PUT/payment-methods/{method}Alterar meio de pagamento

payments:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
method obrigatóriocaminhostring

Exemplo

curl -X PUT "$CHAMEJAR_URL/api/v1/payment-methods/<method>" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
GET/reconciliationsListar conciliações de pagamento

payments:readX-Location-Id

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/reconciliations" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/reconciliations/runExecutar conciliação de pagamentos

payments:writeIdempotency-KeyX-Location-Id

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/reconciliations/run" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
POST/reconciliations/{reconciliation}/resolveResolver divergência de conciliação

payments:refundIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
reconciliation obrigatóriocaminhostring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/reconciliations/<reconciliation>/resolve" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"

Caixa

Abertura

GET/cash-sessionsListar sessões de caixa

cash:readX-Location-Id

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/cash-sessions" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/cash-sessionsAbrir caixa

cash:manageIdempotency-KeyX-Location-Id

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/cash-sessions" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
GET/cash-sessions/currentConsultar o caixa aberto

cash:readX-Location-Id

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/cash-sessions/current" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
GET/cash-sessions/{session}Consultar sessão de caixa

cash:readX-Location-Id

Parâmetros

NomeOndeTipoDescrição
session obrigatóriocaminhointeger

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/cash-sessions/123" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/cash-sessions/{session}/movementsRegistrar sangria ou suprimento

cash:manageIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
session obrigatóriocaminhointeger

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/cash-sessions/123/movements" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
POST/cash-sessions/{session}/closeFechar caixa

cash:manageIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
session obrigatóriocaminhointeger

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/cash-sessions/123/close" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"

PDV

Vendas de balcão com sessões de PDV

POST/pos/sessionsAbrir venda no PDV

pos:useIdempotency-KeyX-Location-Id

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/pos/sessions" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
POST/pos/sessions/{session}/finalizeFinalizar venda do PDV

pos:useIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
session obrigatóriocaminhostring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/pos/sessions/<session>/finalize" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
GET/pos/sessions/{session}Consultar venda do PDV

pos:useX-Location-Id

Parâmetros

NomeOndeTipoDescrição
session obrigatóriocaminhostring

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/pos/sessions/<session>" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/pos/sessions/{session}/itemsAdicionar item à venda

pos:useIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
session obrigatóriocaminhostring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/pos/sessions/<session>/items" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
PUT/pos/sessions/{session}/items/{item}Alterar item da venda

pos:useIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
session obrigatóriocaminhostring
item obrigatóriocaminhostring

Exemplo

curl -X PUT "$CHAMEJAR_URL/api/v1/pos/sessions/<session>/items/<item>" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
DELETE/pos/sessions/{session}/items/{item}Remover item da venda

pos:useIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
session obrigatóriocaminhostring
item obrigatóriocaminhostring

Exemplo

curl -X DELETE "$CHAMEJAR_URL/api/v1/pos/sessions/<session>/items/<item>" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
PUT/pos/sessions/{session}/customerInformar cliente da venda

pos:useIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
session obrigatóriocaminhostring

Exemplo

curl -X PUT "$CHAMEJAR_URL/api/v1/pos/sessions/<session>/customer" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
POST/pos/sessions/{session}/adjustmentsAplicar desconto ou acréscimo na venda

pos:adjustIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
session obrigatóriocaminhostring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/pos/sessions/<session>/adjustments" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
POST/pos/sessions/{session}/holdColocar venda em espera

pos:useIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
session obrigatóriocaminhostring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/pos/sessions/<session>/hold" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
GET/pos/holdsListar vendas em espera

pos:useX-Location-Id

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/pos/holds" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/pos/holds/{session}/resumeRetomar venda em espera

pos:useIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
session obrigatóriocaminhostring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/pos/holds/<session>/resume" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"

Mesas e comandas

Atendimento de salão por mesa ou comanda

GET/table-sessionsListar atendimentos abertos

tables:readX-Location-Id

Parâmetros

NomeOndeTipoDescrição
statusconsultastringValores: open, closed.

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/table-sessions" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/table-sessionsAbrir mesa ou comanda

tables:writeIdempotency-KeyX-Location-Id

Corpo application/json

CampoTipoDescrição
kindstringValores: table, tab.
dining_table_idintegerObrigatório para atendimento de mesa; referência à mesa cadastrada em Áreas do Salão
referencestringObrigatório para comanda; não cria mesa física
customer_idinteger
guestsinteger
commentstring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/table-sessions" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "kind": "table",
  "dining_table_id": 123,
  "reference": "texto",
  "customer_id": 123
}'
GET/table-sessions/{session}Consultar atendimento

tables:readX-Location-Id

Parâmetros

NomeOndeTipoDescrição
session obrigatóriocaminhostring

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/table-sessions/<session>" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/table-sessions/{session}/itemsLançar item no atendimento

tables:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
session obrigatóriocaminhostring

Corpo application/json

CampoTipoDescrição
menu_id obrigatóriointeger
quantity obrigatóriointeger
option_valuesarray
commentstring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/table-sessions/<session>/items" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "menu_id": 123,
  "quantity": 1
}'
PUT/table-sessions/{session}/items/{item}Alterar item pendente

tables:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
session obrigatóriocaminhostring
item obrigatóriocaminhostring

Exemplo

curl -X PUT "$CHAMEJAR_URL/api/v1/table-sessions/<session>/items/<item>" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
DELETE/table-sessions/{session}/items/{item}Remover item pendente

tables:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
session obrigatóriocaminhostring
item obrigatóriocaminhostring

Exemplo

curl -X DELETE "$CHAMEJAR_URL/api/v1/table-sessions/<session>/items/<item>" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
POST/table-sessions/{session}/send-to-kitchenEnviar itens pendentes para a cozinha

tables:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
session obrigatóriocaminhostring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/table-sessions/<session>/send-to-kitchen" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
POST/table-sessions/{session}/transfer-itemsTransferir itens pendentes para outro atendimento

tables:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
session obrigatóriocaminhostring

Corpo application/json

CampoTipoDescrição
target_session_id obrigatóriostring
item_ids obrigatórioarray

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/table-sessions/<session>/transfer-items" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "target_session_id": "3f2b8c1e-5a4d-4c2b-9f1e-2a7d6b8c9e01",
  "item_ids": [
    "3f2b8c1e-5a4d-4c2b-9f1e-2a7d6b8c9e01"
  ]
}'
POST/table-sessions/{session}/transferTransferir atendimento para outra mesa ou comanda

tables:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
session obrigatóriocaminhostring

Corpo application/json

CampoTipoDescrição
kind obrigatóriostringValores: table, tab.
dining_table_idintegerObrigatório quando o destino for mesa
reference obrigatóriostringObrigatório quando o destino for comanda

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/table-sessions/<session>/transfer" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "kind": "table",
  "reference": "texto"
}'
POST/table-sessions/{session}/mergeJuntar atendimentos

tables:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
session obrigatóriocaminhostring

Corpo application/json

CampoTipoDescrição
target_session_id obrigatóriostring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/table-sessions/<session>/merge" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "target_session_id": "3f2b8c1e-5a4d-4c2b-9f1e-2a7d6b8c9e01"
}'
GET/table-sessions/{session}/billConsultar a conta do atendimento

tables:readX-Location-Id

Parâmetros

NomeOndeTipoDescrição
session obrigatóriocaminhostring

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/table-sessions/<session>/bill" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/table-sessions/{session}/splitsDividir a conta

tables:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
session obrigatóriocaminhostring

Corpo application/json

CampoTipoDescrição
splits obrigatórioarray
splits[].label obrigatóriostring
splits[].amount_minor obrigatóriointeger

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/table-sessions/<session>/splits" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "splits": [
    {
      "label": "texto",
      "amount_minor": 1000
    }
  ]
}'
POST/table-sessions/{session}/closeFechar mesa ou comanda

tables:closeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
session obrigatóriocaminhostring

Corpo application/json

CampoTipoDescrição
payments obrigatórioarray

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/table-sessions/<session>/close" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "payments": [
    "texto"
  ]
}'

Cozinha

Estações e tíquetes de produção.

GET/kitchen-stationsListar estações da cozinha

kitchen:readX-Location-Id

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/kitchen-stations" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/kitchen-stationsCriar estação da cozinha

kitchen:writeIdempotency-KeyX-Location-Id

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/kitchen-stations" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
GET/kitchen-ticketsListar tíquetes de produção

kitchen:readX-Location-Id

Parâmetros

NomeOndeTipoDescrição
per_pageconsultainteger

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/kitchen-tickets" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"

Resposta real 200 · dados fictícios da demonstração

{
  "data": [],
  "meta": {
    "total": 0,
    "current_page": 1
  }
}
POST/kitchen-tickets/{ticket}/transitionMudar a etapa do tíquete

kitchen:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
ticket obrigatóriocaminhostring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/kitchen-tickets/<ticket>/transition" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
PUT/kitchen-stations/{station}Alterar estação da cozinha

kitchen:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
station obrigatóriocaminhostring

Exemplo

curl -X PUT "$CHAMEJAR_URL/api/v1/kitchen-stations/<station>" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
GET/kitchen-tickets/{ticket}Consultar tíquete de produção

kitchen:readX-Location-Id

Parâmetros

NomeOndeTipoDescrição
ticket obrigatóriocaminhostring

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/kitchen-tickets/<ticket>" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/kitchen-ticket-items/{item}/transitionMudar a etapa de um item do tíquete

kitchen:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
item obrigatóriocaminhostring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/kitchen-ticket-items/<item>/transition" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"

Impressão

Fila de impressão

GET/orders/{order}/receiptConsultar recibo do pedido

orders:readX-Location-Id

Parâmetros

NomeOndeTipoDescrição
order obrigatóriocaminhointeger

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/orders/123/receipt" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/orders/{order}/reprintReimprimir recibo do pedido

print:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
order obrigatóriocaminhointeger

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/orders/123/reprint" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
GET/print-jobsListar tarefas de impressão

print:readX-Location-Id

Parâmetros

NomeOndeTipoDescrição
per_pageconsultainteger

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/print-jobs" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
GET/print-agent/printersListar impressoras do agente local

print:readX-Location-Id

Lista impressoras disponíveis para vínculo no agente local

Retorna somente impressoras ativas, configuradas para Agente local e pertencentes à unidade informada. É usado pelo assistente instalado no computador para relacionar cada impressora lógica a uma fila do Windows/CUPS ou a um destino TCP direto.

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/print-agent/printers" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
GET/print-jobs/metricsConsultar métricas de impressão

print:readX-Location-Id

Métricas de entrega, dead-letter e confirmação do agente

Parâmetros

NomeOndeTipoDescrição
window_minutesconsultaintegerJanela das métricas de volume e latência (5 a 1440 minutos).

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/print-jobs/metrics" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/print-jobs/claimRetirar tarefas para impressão (agente local)

print:confirmX-Location-Id

Retirada de tarefas pelo agente local de impressão

Caminho sem CloudPrinter: o agente instalado na loja informa obrigatoriamente as impressoras internas às quais está vinculado e retira somente as tarefas delas. O servidor valida que cada impressora está ativa, usa o transporte Agente local e pertence à unidade do cabeçalho. A retirada trava as linhas e marca cada tarefa como accepted, de modo que dois agentes não peguem a mesma tarefa — em impressão isso significaria papel duplicado no balcão. payload só é devolvido aqui; a listagem comum expõe apenas metadado. Cada tarefa inclui um claim_receipt secreto, que precisa ser mantido no spool local e enviado na confirmação. Depois de imprimir, o agente fecha a tarefa em POST /print-jobs/{job}/confirm.

Corpo application/json

CampoTipoDescrição
agent_id obrigatóriostringIdentificação do computador que está retirando.
agent_versionstringVersão do agente para diagnóstico.
platformstringSistema operacional do agente.
printer_ids obrigatórioarrayIDs internos de impressoras ativas, locais e pertencentes à unidade.
maxinteger

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/print-jobs/claim" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "agent_id": "texto",
  "printer_ids": [
    123
  ]
}'
POST/print-jobs/{job}/confirmConfirmar impressão (agente local)

print:confirmIdempotency-KeyX-Location-Id

Confirmação de impressão enviada pelo agente local

O agente informa se o documento saiu no papel. A confirmação exige o mesmo token, agent_reference e claim_receipt recebidos na retirada; o servidor armazena somente o hash do recibo. printed é terminal e idempotente; failed devolve a tarefa à fila com backoff ou, esgotadas as tentativas, ao dead-letter.

Parâmetros

NomeOndeTipoDescrição
job obrigatóriocaminhostring

Corpo application/json

CampoTipoDescrição
status obrigatóriostringValores: printed, failed.
agent_reference obrigatóriostring
claim_receipt obrigatóriostring
messagestring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/print-jobs/<job>/confirm" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "printed",
  "agent_reference": "texto",
  "claim_receipt": "texto"
}'
POST/print-jobs/{job}/retryReenviar tarefa de impressão

print:writeIdempotency-KeyX-Location-Id

Reenfileira tarefa falha, cancelada, em dead-letter ou sem confirmação

Parâmetros

NomeOndeTipoDescrição
job obrigatóriocaminhostring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/print-jobs/<job>/retry" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
GET/print-jobs/{job}Consultar tarefa de impressão

print:readX-Location-Id

Parâmetros

NomeOndeTipoDescrição
job obrigatóriocaminhostring

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/print-jobs/<job>" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/print-jobs/{job}/cancelCancelar tarefa de impressão

print:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
job obrigatóriocaminhostring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/print-jobs/<job>/cancel" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"

Entregas

Entregadores

GET/delivery/driversListar entregadores

delivery:readX-Location-Id

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/delivery/drivers" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/delivery/driversCadastrar ou alterar entregador

delivery:writeIdempotency-KeyX-Location-Id

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/delivery/drivers" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
GET/delivery/queueConsultar fila de entregas

delivery:readX-Location-Id

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/delivery/queue" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/delivery/orders/{order}/assignAtribuir entregador ao pedido

delivery:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
order obrigatóriocaminhointeger

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/delivery/orders/123/assign" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
POST/delivery/assignments/{assignment}/check-inRegistrar retirada do pedido pelo entregador

delivery:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
assignment obrigatóriocaminhostring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/delivery/assignments/<assignment>/check-in" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
POST/delivery/assignments/{assignment}/dispatchDespachar entrega

delivery:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
assignment obrigatóriocaminhostring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/delivery/assignments/<assignment>/dispatch" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
POST/delivery/assignments/{assignment}/deliverConcluir entrega

delivery:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
assignment obrigatóriocaminhostring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/delivery/assignments/<assignment>/deliver" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
POST/delivery/routesCriar rota com várias entregas

delivery:writeIdempotency-KeyX-Location-Id

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/delivery/routes" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
POST/delivery/routes/{route}/dispatchDespachar rota

delivery:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
route obrigatóriocaminhostring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/delivery/routes/<route>/dispatch" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
POST/delivery/assignments/{assignment}/tracking-tokenGerar link de rastreio

delivery:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
assignment obrigatóriocaminhostring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/delivery/assignments/<assignment>/tracking-token" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
POST/delivery/geocodeLocalizar endereço no mapa

delivery:readIdempotency-KeyX-Location-Id

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/delivery/geocode" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
GET/delivery/tracking/{token}Consultar rastreio público (sem token)

Sem autenticação

Parâmetros

NomeOndeTipoDescrição
token obrigatóriocaminhostring

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/delivery/tracking/<token>" \
  -H "Accept: application/json"

Estoque e compras

Insumos

GET/stock/unitsListar unidades de medida

stock:readX-Location-Id

Unidades de medida disponíveis para conversão

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/stock/units" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
GET/stock/itemsListar insumos

stock:readX-Location-Id

Parâmetros

NomeOndeTipoDescrição
per_pageconsultainteger

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/stock/items" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
GET/stock/items/{item}Consultar insumo

stock:readX-Location-Id

Parâmetros

NomeOndeTipoDescrição
item obrigatóriocaminhointeger

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/stock/items/123" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
PUT/stock/items/{item}/units/{unit}Configurar conversão de unidade do insumo

stock:writeIdempotency-KeyX-Location-Id

Configura a equivalência da unidade informada para a unidade-base do insumo

Parâmetros

NomeOndeTipoDescrição
item obrigatóriocaminhointeger
unit obrigatóriocaminhostring

Corpo application/json

CampoTipoDescrição
factor_to_base obrigatórionumber

Exemplo

curl -X PUT "$CHAMEJAR_URL/api/v1/stock/items/123/units/<unit>" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "factor_to_base": 0.001
}'
GET/stock/movementsListar movimentações de estoque

stock:readX-Location-Id

Extrato imutável de estoque da unidade

Parâmetros

NomeOndeTipoDescrição
per_pageconsultainteger

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/stock/movements" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/stock/purchasesRegistrar entrada por compra

stock:writeIdempotency-KeyX-Location-Id

Corpo application/json

CampoTipoDescrição
item_id obrigatóriointeger
quantity obrigatórionumber
unit obrigatóriostring
unit_cost obrigatórionumberCusto por unidade informada
occurred_atstring
notesstring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/stock/purchases" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "item_id": 123,
  "quantity": 10.5,
  "unit": "kg",
  "unit_cost": 10.5
}'
POST/stock/lossesRegistrar perda

stock:writeIdempotency-KeyX-Location-Id

Corpo application/json

CampoTipoDescrição
item_id obrigatóriointeger
quantity obrigatórionumber
unit obrigatóriostring
occurred_atstring
notes obrigatóriostring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/stock/losses" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "item_id": 123,
  "quantity": 10.5,
  "unit": "kg",
  "notes": "texto"
}'
POST/stock/inventory-countsAbrir contagem de inventário

stock:writeIdempotency-KeyX-Location-Id

Abre inventário físico em rascunho

Corpo application/json

CampoTipoDescrição
started_atstring
notesstring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/stock/inventory-counts" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "started_at": "2026-11-10T19:30:00-03:00",
  "notes": "texto"
}'
PUT/stock/inventory-counts/{count}/items/{item}Informar quantidade contada

stock:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
count obrigatóriocaminhointeger
item obrigatóriocaminhointeger

Corpo application/json

CampoTipoDescrição
quantity obrigatórionumber
unitstring

Exemplo

curl -X PUT "$CHAMEJAR_URL/api/v1/stock/inventory-counts/123/items/123" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "quantity": 10.5
}'
POST/stock/inventory-counts/{count}/closeFechar contagem de inventário

stock:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
count obrigatóriocaminhointeger

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/stock/inventory-counts/123/close" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
GET/stock/suppliersListar fornecedores

stock:readX-Location-Id

Parâmetros

NomeOndeTipoDescrição
per_pageconsultainteger

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/stock/suppliers" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/stock/suppliersCadastrar fornecedor

stock:writeIdempotency-KeyX-Location-Id

Corpo application/json

CampoTipoDescrição
name obrigatóriostring
tax_idstring
emailstring
phonestring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/stock/suppliers" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "texto"
}'
GET/stock/purchase-ordersListar pedidos de compra

stock:readX-Location-Id

Parâmetros

NomeOndeTipoDescrição
per_pageconsultainteger

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/stock/purchase-orders" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/stock/purchase-ordersCriar pedido de compra

stock:writeIdempotency-KeyX-Location-Id

Corpo application/json

CampoTipoDescrição
supplier_id obrigatóriointeger
notesstring
lines obrigatórioarray

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/stock/purchase-orders" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "supplier_id": 123,
  "lines": [
    {}
  ]
}'
POST/stock/purchase-orders/{purchase}/approveAprovar pedido de compra

stock:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
purchase obrigatóriocaminhostring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/stock/purchase-orders/<purchase>/approve" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
POST/stock/purchase-orders/{purchase}/receiveReceber pedido de compra

stock:writeIdempotency-KeyX-Location-Id

Recebe total ou parte de um pedido e atualiza custo médio

Parâmetros

NomeOndeTipoDescrição
purchase obrigatóriocaminhostring

Corpo application/json

CampoTipoDescrição
quantities obrigatórioobject
received_atstring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/stock/purchase-orders/<purchase>/receive" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "quantities": {}
}'
POST/stock/purchase-orders/{purchase}/reconcileConciliar pedido de compra com a nota do fornecedor

stock:writeIdempotency-KeyX-Location-Id

Concilia documento/XML do fornecedor com o pedido

Parâmetros

NomeOndeTipoDescrição
purchase obrigatóriocaminhostring

Corpo application/json

CampoTipoDescrição
status obrigatóriostringValores: pending, matched, divergent.
notesstring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/stock/purchase-orders/<purchase>/reconcile" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "pending"
}'

Financeiro

Contas

GET/finance/categoriesListar categorias financeiras

finance:readX-Location-Id

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/finance/categories" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/finance/categoriesCriar categoria financeira

finance:writeIdempotency-KeyX-Location-Id

Corpo application/json

CampoTipoDescrição
code obrigatóriostring
name obrigatóriostring
kind obrigatóriostringValores: expense, income, transfer.

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/finance/categories" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "code": "texto",
  "name": "texto",
  "kind": "expense"
}'
GET/finance/accountsListar contas financeiras

finance:readX-Location-Id

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/finance/accounts" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/finance/accountsCriar conta financeira

finance:writeIdempotency-KeyX-Location-Id

Corpo application/json

CampoTipoDescrição
name obrigatóriostring
kind obrigatóriostringValores: cash, bank, card, other.

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/finance/accounts" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "texto",
  "kind": "cash"
}'
GET/finance/cost-centersListar centros de custo

finance:readX-Location-Id

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/finance/cost-centers" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/finance/cost-centersCriar centro de custo

finance:writeIdempotency-KeyX-Location-Id

Corpo application/json

CampoTipoDescrição
code obrigatóriostring
name obrigatóriostring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/finance/cost-centers" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "code": "texto",
  "name": "texto"
}'
GET/finance/titlesListar títulos a pagar e a receber

finance:readX-Location-Id

Parâmetros

NomeOndeTipoDescrição
per_pageconsultainteger

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/finance/titles" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/finance/titlesCriar título a pagar ou a receber

finance:writeIdempotency-KeyX-Location-Id

Corpo application/json

CampoTipoDescrição
description obrigatóriostring
amount obrigatórionumber
kind obrigatóriostringValores: payable, receivable.
due_on obrigatóriostring
installmentsinteger

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/finance/titles" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "texto",
  "amount": 10.5,
  "kind": "payable",
  "due_on": "2026-11-10"
}'
POST/finance/installments/{installment}/settleBaixar parcela de título

finance:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
installment obrigatóriocaminhointeger

Corpo application/json

CampoTipoDescrição
account_id obrigatóriointeger
amount obrigatórionumber
settled_atstring
external_referencestring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/finance/installments/123/settle" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "account_id": 123,
  "amount": 10.5
}'
GET/finance/cash-flowConsultar fluxo de caixa

finance:readX-Location-Id

Parâmetros

NomeOndeTipoDescrição
from obrigatórioconsultastring
to obrigatórioconsultastring

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/finance/cash-flow?from=2026-11-10&to=2026-11-10" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"

Relatórios e DRE

Relatórios operacionais

GET/reportsListar relatórios disponíveis

reports:readX-Location-Id

Read models publicados e suas colunas de exportação

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/reports" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/reports/dre/rebuildRecalcular a DRE

reports:manageIdempotency-KeyX-Location-Id

Recalcular DRE em fila

Exige habilidade reports:manage, permissão administrativa e acesso à unidade. Veja docs/RELATORIOS-DRE.md.

Corpo application/json

CampoTipoDescrição
from obrigatóriostring
to obrigatóriostring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/reports/dre/rebuild" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "from": "2026-11-10",
  "to": "2026-11-10"
}'
POST/reports/dre/categoryClassificar categoria na DRE

reports:manageIdempotency-KeyX-Location-Id

Classificar categoria global (superusuário)

Exige habilidade reports:manage, permissão administrativa e acesso à unidade. Veja docs/RELATORIOS-DRE.md.

Corpo application/json

CampoTipoDescrição
category_id obrigatóriointeger
dre_section obrigatóriostringValores: deduction, variable_expense, fixed_expense, other_expense, other_income.
dre_order obrigatóriointeger

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/reports/dre/category" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "category_id": 123,
  "dre_section": "deduction",
  "dre_order": 123
}'
POST/reports/dre/titleDefinir competência e categoria de título

reports:manageIdempotency-KeyX-Location-Id

Definir competência e categoria do título

Exige habilidade reports:manage, permissão administrativa e acesso à unidade. Veja docs/RELATORIOS-DRE.md.

Corpo application/json

CampoTipoDescrição
title_id obrigatóriointeger
category_id obrigatóriointeger
competence_on obrigatóriostring
dre_channelstringValores: pdv, delivery_online, retirada_online, online.

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/reports/dre/title" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "title_id": 123,
  "category_id": 123,
  "competence_on": "2026-11-10"
}'
POST/reports/dre/entryRegistrar lançamento gerencial

reports:manageIdempotency-KeyX-Location-Id

Exige habilidade reports:manage, permissão administrativa e acesso à unidade. Veja docs/RELATORIOS-DRE.md.

Corpo application/json

CampoTipoDescrição
description obrigatóriostring
amount_minor obrigatóriointeger
category_id obrigatóriointeger
occurred_on obrigatóriostring
channelstringValores: pdv, delivery_online, retirada_online, online.
financial_title_idinteger

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/reports/dre/entry" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "texto",
  "amount_minor": 1000,
  "category_id": 123,
  "occurred_on": "2026-11-10"
}'
POST/reports/dre/budgetDefinir orçamento mensal

reports:manageIdempotency-KeyX-Location-Id

Exige habilidade reports:manage, permissão administrativa e acesso à unidade. Veja docs/RELATORIOS-DRE.md.

Corpo application/json

CampoTipoDescrição
month obrigatóriostring
category_id obrigatóriointeger
amount_minor obrigatóriointeger

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/reports/dre/budget" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "month": "2026-08",
  "category_id": 123,
  "amount_minor": 1000
}'
POST/reports/dre/marketplaceCostClassificar custo de marketplace

reports:manageIdempotency-KeyX-Location-Id

Exige habilidade reports:manage, permissão administrativa e acesso à unidade. Veja docs/RELATORIOS-DRE.md.

Corpo application/json

CampoTipoDescrição
entry_id obrigatóriointeger
category_id obrigatóriointeger

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/reports/dre/marketplaceCost" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "entry_id": 123,
  "category_id": 123
}'
POST/reports/dre/closeFechar mês da DRE

reports:closeIdempotency-KeyX-Location-Id

Fechar período mensal

Exige habilidade reports:close, permissão administrativa e acesso à unidade. Veja docs/RELATORIOS-DRE.md.

Corpo application/json

CampoTipoDescrição
month obrigatóriostring
titles_reviewed obrigatórioboolean
taxes_reviewed obrigatórioboolean
fees_reviewed obrigatórioboolean

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/reports/dre/close" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "month": "2026-08",
  "titles_reviewed": true,
  "taxes_reviewed": true,
  "fees_reviewed": true
}'
POST/reports/dre/reopenReabrir mês da DRE

reports:closeIdempotency-KeyX-Location-Id

Reabrir período mensal com justificativa

Exige habilidade reports:close, permissão administrativa e acesso à unidade. Veja docs/RELATORIOS-DRE.md.

Corpo application/json

CampoTipoDescrição
month obrigatóriostring
reason obrigatóriostring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/reports/dre/reopen" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "month": "2026-08",
  "reason": "texto"
}'
GET/reports/{report}Consultar relatório no período

reports:readX-Location-Id

Agregados do read model na janela informada

Consulte o catálogo para conhecer os relatórios e suas colunas. Valores com sufixo _minor são centavos. A DRE é gerencial, depende de apuração e informa cobertura e avisos; consulte docs/RELATORIOS-DRE.md.

Parâmetros

NomeOndeTipoDescrição
report obrigatóriocaminhostringValores: dre, vendas-horario, vendas-operador, vendas-regiao, performance-produtos, consumo-insumos, posicao-historica, lista-compras, fluxo-de-caixa, rede-consolidado, sales, cash, production, stock, finance, fiscal-apuracao, fiscal-itens, fiscal-recebimentos.
fromconsultastringInício da janela (ISO 8601 ou AAAA-MM-DD). Padrão, início do dia atual.
toconsultastringFim da janela (ISO 8601 ou AAAA-MM-DD, que vale o dia inteiro). Padrão, agora.
intervalconsultastringPara fluxo-de-caixa; a semana começa na segunda-feira. Valores: day, week.
coverage_daysconsultaintegerPara lista-compras; cobertura desejada em dias.
sla_minutesconsultaintegerApenas para production; minutos tolerados entre recebido e pronto.

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/reports/<report>" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/reports/{report}/exportsSolicitar exportação de relatório

reports:exportIdempotency-KeyX-Location-Id

Solicita exportação assíncrona do relatório

Responde 202 imediatamente; o arquivo é gerado por worker e baixado depois.

Parâmetros

NomeOndeTipoDescrição
report obrigatóriocaminhostringValores: dre, vendas-horario, vendas-operador, vendas-regiao, performance-produtos, consumo-insumos, posicao-historica, lista-compras, fluxo-de-caixa, rede-consolidado, sales, cash, production, stock, finance, fiscal-apuracao, fiscal-itens, fiscal-recebimentos.
fromconsultastringInício da janela (ISO 8601 ou AAAA-MM-DD). Padrão, início do dia atual.
toconsultastringFim da janela (ISO 8601 ou AAAA-MM-DD, que vale o dia inteiro). Padrão, agora.

Corpo application/json

CampoTipoDescrição
formatstringValores: csv, xlsx, pdf.

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/reports/<report>/exports" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "format": "csv"
}'
GET/reports/exportsListar exportações

reports:readX-Location-Id

Parâmetros

NomeOndeTipoDescrição
per_pageconsultainteger
reportconsultastringValores: dre, vendas-horario, vendas-operador, vendas-regiao, performance-produtos, consumo-insumos, posicao-historica, lista-compras, fluxo-de-caixa, rede-consolidado, sales, cash, production, stock, finance, fiscal-apuracao, fiscal-itens, fiscal-recebimentos.
statusconsultastringValores: queued, processing, completed, failed.

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/reports/exports" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
GET/reports/exports/{export}Consultar exportação

reports:readX-Location-Id

Parâmetros

NomeOndeTipoDescrição
export obrigatóriocaminhostring

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/reports/exports/<export>" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
GET/reports/exports/{export}/downloadBaixar arquivo exportado

reports:exportX-Location-Id

Baixa o arquivo gerado

Parâmetros

NomeOndeTipoDescrição
export obrigatóriocaminhostring

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/reports/exports/<export>/download" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"

Fiscal

Perfil fiscal

GET/fiscal/profileConsultar perfil fiscal

fiscal:readX-Location-Id

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/fiscal/profile" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
PUT/fiscal/profileSalvar perfil fiscal

fiscal:writeIdempotency-KeyX-Location-Id

Exemplo

curl -X PUT "$CHAMEJAR_URL/api/v1/fiscal/profile" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
POST/fiscal/profile/certificateEnviar certificado digital

fiscal:writeIdempotency-KeyX-Location-Id

Exige HTTPS, perfil fiscal existente e habilidade fiscal:write. A senha é validada e a validade é extraída do certificado; expires_at é aceito por compatibilidade e não substitui a validade do arquivo.

Corpo multipart/form-data

CampoTipoDescrição
certificate obrigatóriostringArquivo PFX ou P12 de até 5 MB
password obrigatóriostring
expires_atstring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/fiscal/profile/certificate" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -F "file=@arquivo"
GET/fiscal/rulesListar regras fiscais

fiscal:readX-Location-Id

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/fiscal/rules" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/fiscal/rulesCriar regra fiscal

fiscal:writeIdempotency-KeyX-Location-Id

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/fiscal/rules" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
PUT/fiscal/rules/{rule}Alterar regra fiscal

fiscal:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
rule obrigatóriocaminhostring

Exemplo

curl -X PUT "$CHAMEJAR_URL/api/v1/fiscal/rules/<rule>" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
GET/orders/{order}/fiscal-documentsListar documentos fiscais do pedido

fiscal:readX-Location-Id

Parâmetros

NomeOndeTipoDescrição
order obrigatóriocaminhointeger

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/orders/123/fiscal-documents" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/orders/{order}/fiscal-documentsSolicitar emissão de NFC-e do pedido

fiscal:emitIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
order obrigatóriocaminhointeger

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/orders/123/fiscal-documents" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
GET/fiscal/documents/{document}Consultar documento fiscal

fiscal:readX-Location-Id

Parâmetros

NomeOndeTipoDescrição
document obrigatóriocaminhostring

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/fiscal/documents/<document>" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/fiscal/documents/{document}/processProcessar documento fiscal

fiscal:emitIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
document obrigatóriocaminhostring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/fiscal/documents/<document>/process" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
POST/fiscal/documents/{document}/retryTentar de novo a emissão

fiscal:emitIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
document obrigatóriocaminhostring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/fiscal/documents/<document>/retry" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
POST/fiscal/documents/{document}/queryConsultar situação na SEFAZ

fiscal:readIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
document obrigatóriocaminhostring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/fiscal/documents/<document>/query" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
GET/fiscal/documents/{document}/attemptsListar tentativas de emissão

fiscal:readX-Location-Id

Parâmetros

NomeOndeTipoDescrição
document obrigatóriocaminhostring

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/fiscal/documents/<document>/attempts" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/fiscal/documents/{document}/transmit-contingencyTransmitir nota emitida em contingência

fiscal:emitIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
document obrigatóriocaminhostring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/fiscal/documents/<document>/transmit-contingency" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
POST/fiscal/documents/{document}/cancelCancelar documento fiscal

fiscal:emitIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
document obrigatóriocaminhostring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/fiscal/documents/<document>/cancel" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
GET/fiscal/documents/{document}/xmlBaixar XML do documento fiscal

fiscal:readX-Location-Id

Parâmetros

NomeOndeTipoDescrição
document obrigatóriocaminhostring

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/fiscal/documents/<document>/xml" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
GET/fiscal/documents/{document}/pdfBaixar DANFE em PDF

fiscal:readX-Location-Id

Parâmetros

NomeOndeTipoDescrição
document obrigatóriocaminhostring

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/fiscal/documents/<document>/pdf" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/fiscal/invalidationsInutilizar faixa de numeração

fiscal:emitIdempotency-KeyX-Location-Id

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/fiscal/invalidations" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
GET/fiscal/seriesListar séries de numeração

fiscal:readX-Location-Id

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/fiscal/series" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/fiscal/seriesCriar série de numeração

fiscal:writeIdempotency-KeyX-Location-Id

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/fiscal/series" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
PUT/fiscal/series/{series}Alterar série de numeração

fiscal:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
series obrigatóriocaminhostring

Exemplo

curl -X PUT "$CHAMEJAR_URL/api/v1/fiscal/series/<series>" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
GET/fiscal/emittersListar emitentes

fiscal:readX-Location-Id

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/fiscal/emitters" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/fiscal/emittersCadastrar emitente

fiscal:writeIdempotency-KeyX-Location-Id

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/fiscal/emitters" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
PUT/fiscal/emitters/{emitter}Alterar emitente

fiscal:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
emitter obrigatóriocaminhostring

Exemplo

curl -X PUT "$CHAMEJAR_URL/api/v1/fiscal/emitters/<emitter>" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
GET/fiscal/healthVerificar o provedor fiscal

fiscal:readX-Location-Id

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/fiscal/health" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
GET/fiscal/modeConsultar modo fiscal (produção ou homologação)

fiscal:readX-Location-Id

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/fiscal/mode" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
GET/fiscal/tax-profilesListar perfis tributários

fiscal:readX-Location-Id

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/fiscal/tax-profiles" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/fiscal/tax-profilesCriar perfil tributário

fiscal:writeIdempotency-KeyX-Location-Id

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/fiscal/tax-profiles" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
PUT/fiscal/tax-profiles/{profile}Alterar perfil tributário

fiscal:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
profile obrigatóriocaminhostring

Exemplo

curl -X PUT "$CHAMEJAR_URL/api/v1/fiscal/tax-profiles/<profile>" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
GET/fiscal/rule-assignmentsListar vínculos de regras fiscais

fiscal:readX-Location-Id

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/fiscal/rule-assignments" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/fiscal/rule-assignmentsVincular regra fiscal

fiscal:writeIdempotency-KeyX-Location-Id

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/fiscal/rule-assignments" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
GET/fiscal/assessments/{document}Consultar cálculo de tributos

fiscal:readX-Location-Id

Parâmetros

NomeOndeTipoDescrição
document obrigatóriocaminhostring

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/fiscal/assessments/<document>" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/orders/{order}/fiscal-assessmentsCalcular tributos do pedido

fiscal:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
order obrigatóriocaminhointeger

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/orders/123/fiscal-assessments" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
GET/fiscal/rejections/{code}Explicar código de rejeição da SEFAZ

fiscal:readX-Location-Id

Parâmetros

NomeOndeTipoDescrição
code obrigatóriocaminhostring

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/fiscal/rejections/<code>" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
GET/fiscal/incoming-documentsListar notas de entrada

fiscal:readX-Location-Id

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/fiscal/incoming-documents" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/fiscal/incoming-documents/uploadEnviar XML de nota de entrada

fiscal:writeX-Location-Id

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/fiscal/incoming-documents/upload" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
GET/fiscal/incoming-documents/{document}Consultar nota de entrada

fiscal:readX-Location-Id

Parâmetros

NomeOndeTipoDescrição
document obrigatóriocaminhostring

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/fiscal/incoming-documents/<document>" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
GET/fiscal/incoming-documents/{document}/xmlBaixar XML da nota de entrada

fiscal:readX-Location-Id

Parâmetros

NomeOndeTipoDescrição
document obrigatóriocaminhostring

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/fiscal/incoming-documents/<document>/xml" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/fiscal/incoming-documents/{document}/items/{line}/reconcileVincular item da nota a um insumo

fiscal:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
document obrigatóriocaminhostring
line obrigatóriocaminhostring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/fiscal/incoming-documents/<document>/items/<line>/reconcile" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
POST/fiscal/incoming-documents/{document}/receiveDar entrada da nota no estoque

fiscal:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
document obrigatóriocaminhostring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/fiscal/incoming-documents/<document>/receive" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
GET/fiscal/paf/profileConsultar perfil regional do PAF

fiscal:readX-Location-Id

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/fiscal/paf/profile" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
PUT/fiscal/paf/profileSalvar perfil regional do PAF

fiscal:writeIdempotency-KeyX-Location-Id

Exemplo

curl -X PUT "$CHAMEJAR_URL/api/v1/fiscal/paf/profile" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
GET/fiscal/paf/identifyIdentificar o PAF

fiscal:readX-Location-Id

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/fiscal/paf/identify" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
GET/fiscal/paf/exportsListar arquivos do PAF

fiscal:readX-Location-Id

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/fiscal/paf/exports" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/fiscal/paf/exportsGerar arquivo do PAF

fiscal:writeIdempotency-KeyX-Location-Id

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/fiscal/paf/exports" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
GET/fiscal/paf/exports/{export}/downloadBaixar arquivo do PAF

fiscal:readX-Location-Id

Parâmetros

NomeOndeTipoDescrição
export obrigatóriocaminhostring

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/fiscal/paf/exports/<export>/download" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"

Marketplaces

Conexões com iFood e aiqfome

GET/marketplaces/connectionsListar conexões

marketplaces:readX-Location-Id

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/marketplaces/connections" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/marketplaces/connectionsCriar conexão

marketplaces:writeIdempotency-KeyX-Location-Id

Corpo application/json

CampoTipoDescrição
idinteger?
provider obrigatóriostring
name obrigatóriostring
environmentstringValores: sandbox, homologation, production.
statusstringAtivar iFood oficial em homologação ou produção exige autorização concluída para a loja; sandbox local é simulação. Valores: active, inactive, error.
credentialsobjectPara iFood, aceita merchant_id, application_client_id e application_client_secret. access_token, refresh_token e dados de sessão são gravados exclusivamente pelo fluxo OAuth.
webhook_secretstring
settingsobject
settings.ifoodobjectOpções do iFood na conexão (settings.ifood). Chaves ausentes assumem o padrão.

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/marketplaces/connections" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "provider": "texto",
  "name": "texto"
}'
PUT/marketplaces/connections/{connection}Alterar conexão

marketplaces:writeIdempotency-KeyX-Location-Id

Atualiza a conexão. Provider e ambiente iFood são imutáveis; crie outra conexão para trocar de canal ou passar de homologação a produção. Sem webhook_secret no corpo, o segredo já cadastrado é preservado; credentials é mesclado às credenciais guardadas.

Parâmetros

NomeOndeTipoDescrição
connection obrigatóriocaminhointeger

Corpo application/json

CampoTipoDescrição
idinteger?
provider obrigatóriostring
name obrigatóriostring
environmentstringValores: sandbox, homologation, production.
statusstringAtivar iFood oficial em homologação ou produção exige autorização concluída para a loja; sandbox local é simulação. Valores: active, inactive, error.
credentialsobjectPara iFood, aceita merchant_id, application_client_id e application_client_secret. access_token, refresh_token e dados de sessão são gravados exclusivamente pelo fluxo OAuth.
webhook_secretstring
settingsobject
settings.ifoodobjectOpções do iFood na conexão (settings.ifood). Chaves ausentes assumem o padrão.

Exemplo

curl -X PUT "$CHAMEJAR_URL/api/v1/marketplaces/connections/123" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "provider": "texto",
  "name": "texto"
}'
GET/marketplaces/connections/{connection}/healthConsultar saúde da conexão

marketplaces:readX-Location-Id

Estado local da conexão (nunca chama o marketplace). No iFood oficial de homologação ou produção devolve status ok, degraded, error ou not_configured, token, polling, pending_catalog, failed_pushes e stuck_events; no sandbox local, sandbox_ready ou configured_not_verified.

Parâmetros

NomeOndeTipoDescrição
connection obrigatóriocaminhointeger

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/marketplaces/connections/123/health" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
GET/marketplaces/connections/{connection}/checklistConsultar lista de verificação da conexão

marketplaces:readX-Location-Id

Parâmetros

NomeOndeTipoDescrição
connection obrigatóriocaminhointeger

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/marketplaces/connections/123/checklist" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
GET/marketplaces/connections/{connection}/merchantConsultar status, pausas e horários da loja no iFood

marketplaces:readX-Location-Id

Consulta status por operação, pausas e horários publicados diretamente no iFood. CLOSED por horário é estado normal. Exige marketplaces:read e unidade da conexão.

Parâmetros

NomeOndeTipoDescrição
connection obrigatóriocaminhointeger

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/marketplaces/connections/123/merchant" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/marketplaces/connections/{connection}/merchant/interruptionsPausar a loja no iFood

marketplaces:writeX-Location-Id

Pausa temporária de 1 minuto a 7 dias. Idempotency-Key é obrigatória e reserva o POST por 24 horas; resultado incerto exige consultar a lista antes de nova chave. Exige marketplaces:write.

Parâmetros

NomeOndeTipoDescrição
connection obrigatóriocaminhointeger

Corpo application/json

CampoTipoDescrição
description obrigatóriostring
start obrigatóriostring
end obrigatóriostring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/marketplaces/connections/123/merchant/interruptions" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "texto",
  "start": "2026-11-10T19:30:00-03:00",
  "end": "2026-11-10T19:30:00-03:00"
}'
DELETE/marketplaces/connections/{connection}/merchant/interruptions/{interruption}Remover pausa da loja no iFood

marketplaces:writeX-Location-Id

Confere se a pausa pertence à loja antes de solicitar a remoção. Exige marketplaces:write.

Parâmetros

NomeOndeTipoDescrição
connection obrigatóriocaminhointeger
interruption obrigatóriocaminhostring

Exemplo

curl -X DELETE "$CHAMEJAR_URL/api/v1/marketplaces/connections/123/merchant/interruptions/<interruption>" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
PUT/marketplaces/connections/{connection}/merchant/opening-hoursSubstituir horários da loja no iFood

marketplaces:writeX-Location-Id

Substitui explicitamente toda a grade semanal do iFood. Dias omitidos são fechados. Não modifica os horários públicos do TastyIgniter. Exige marketplaces:write.

Parâmetros

NomeOndeTipoDescrição
connection obrigatóriocaminhointeger

Corpo application/json

CampoTipoDescrição
shifts obrigatórioarray
shifts[].dayOfWeek obrigatóriostringValores: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.
shifts[].start obrigatóriostring
shifts[].duration obrigatóriointeger

Exemplo

curl -X PUT "$CHAMEJAR_URL/api/v1/marketplaces/connections/123/merchant/opening-hours" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "shifts": [
    {
      "dayOfWeek": "MONDAY",
      "start": "18:00:00",
      "duration": 123
    }
  ]
}'
POST/marketplaces/connections/{connection}/pollSincronizar agora

marketplaces:writeX-Location-Id

Sincroniza agora, de forma síncrona, os eventos do iFood oficial de homologação ou produção (a mesma rodada do agendador). Não usa Idempotency-Key, pois o polling é naturalmente idempotente (ack e unicidade dos eventos) e o middleware de idempotência executaria o handler dentro de uma transação, deixando chamadas ao iFood, ack e rotação do refresh token sem confirmação no banco. Limitado a 6 chamadas por minuto por usuário. O resultado pode ser locked, backoff, skipped ou error sem que a requisição falhe.

Parâmetros

NomeOndeTipoDescrição
connection obrigatóriocaminhointeger

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/marketplaces/connections/123/poll" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/marketplaces/connections/{connection}/ifood/connect/startIniciar autorização da loja no iFood

marketplaces:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
connection obrigatóriocaminhointeger

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/marketplaces/connections/123/ifood/connect/start" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
POST/marketplaces/connections/{connection}/ifood/connect/centralVincular loja ao aplicativo iFood centralizado

marketplaces:writeX-Location-Id

Exige superusuário da plataforma além de marketplaces:write e escopo da unidade. Vincula uma conexão nova à loja já autorizada no Portal para a aplicação centralizada do ambiente da conexão; tokens de loja não podem reivindicar merchants com a credencial global. Requer IFOOD_AUTH_MODE=centralized em produção ou IFOOD_TEST_AUTH_MODE=centralized em homologação e verifica GET merchant antes de ativar. Não usa idempotência transacional por envolver token externo.

Parâmetros

NomeOndeTipoDescrição
connection obrigatóriocaminhointeger

Corpo application/json

CampoTipoDescrição
merchant_id obrigatóriostring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/marketplaces/connections/123/ifood/connect/central" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "merchant_id": "texto"
}'
POST/marketplaces/connections/{connection}/ifood/connect/completeConcluir autorização da loja no iFood

marketplaces:writeIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
connection obrigatóriocaminhointeger

Corpo application/json

CampoTipoDescrição
state obrigatóriostring
authorization_code obrigatóriostring
authorization_code_verifierstring
merchant_idstringIdentificador da loja no iFood; obrigatório para o polling

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/marketplaces/connections/123/ifood/connect/complete" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "state": "texto",
  "authorization_code": "texto"
}'
GET/marketplaces/connections/{connection}/mappingsListar vínculos de catálogo

marketplaces:readX-Location-Id

Parâmetros

NomeOndeTipoDescrição
connection obrigatóriocaminhointeger

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/marketplaces/connections/123/mappings" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
PUT/marketplaces/connections/{connection}/mappingsSubstituir vínculos manuais de catálogo

marketplaces:writeIdempotency-KeyX-Location-Id

Substitui os vínculos manuais da conexão; vínculos gerenciados pela publicação do catálogo iFood são preservados e não podem ser forjados. entity_type option vincula um código de opção do marketplace a um option_value_id global.

Parâmetros

NomeOndeTipoDescrição
connection obrigatóriocaminhointeger

Corpo application/json

CampoTipoDescrição
mappings obrigatórioarray
mappings[].entity_type obrigatóriostringValores: menu, category, payment, status, option.
mappings[].local_id obrigatóriostring
mappings[].external_id obrigatóriostring
mappings[].metadataobject
mappings[].is_activeboolean

Exemplo

curl -X PUT "$CHAMEJAR_URL/api/v1/marketplaces/connections/123/mappings" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "mappings": [
    {
      "entity_type": "menu",
      "local_id": "texto",
      "external_id": "texto"
    }
  ]
}'
POST/marketplaces/connections/{connection}/catalog/syncSincronizar catálogo com o canal

marketplaces:writeIdempotency-KeyX-Location-Id

No iFood de produção, enfileira um produto local selecionado para publicação no Catalog v2.0; não significa que o iFood já o aceitou. Nos adaptadores de teste, registra o pedido no outbox.

Parâmetros

NomeOndeTipoDescrição
connection obrigatóriocaminhointeger

Corpo application/json

CampoTipoDescrição
menu_id obrigatóriointeger
category_idinteger
sync_stockbooleanEstoque rastreado da unidade; adesão opcional

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/marketplaces/connections/123/catalog/sync" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "menu_id": 123
}'
GET/marketplaces/connections/{connection}/catalogListar produtos publicados no iFood

marketplaces:readX-Location-Id

Lista produtos locais da unidade com o estado da publicação iFood; não consulta o catálogo remoto.

Parâmetros

NomeOndeTipoDescrição
per_pageconsultainteger
connection obrigatóriocaminhointeger

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/marketplaces/connections/123/catalog" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
GET/marketplaces/connections/{connection}/catalog/menus/{menu}/previewPrever publicação de produto no iFood

marketplaces:readX-Location-Id

Prévia local de preço, disponibilidade, categorias, adicionais e impedimentos de publicação; não altera o iFood.

Parâmetros

NomeOndeTipoDescrição
connection obrigatóriocaminhointeger
menu obrigatóriocaminhointeger

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/marketplaces/connections/123/catalog/menus/123/preview" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/marketplaces/connections/{connection}/catalog/menus/{menu}/publishPublicar produto no iFood

marketplaces:writeIdempotency-KeyX-Location-Id

Publica ou atualiza um produto explicitamente selecionado. Apenas produtos já publicados são conferidos pelo agendador. Pizzas meio a meio, promoções e regras locais sem tradução fiel são recusadas.

Parâmetros

NomeOndeTipoDescrição
connection obrigatóriocaminhointeger
menu obrigatóriocaminhointeger

Corpo application/json

CampoTipoDescrição
category_idintegerObrigatório quando o produto tem várias categorias
sync_stockbooleanOpt-in do estoque rastreado da unidade

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/marketplaces/connections/123/catalog/menus/123/publish" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "category_id": 123,
  "sync_stock": true
}'
POST/marketplaces/connections/{connection}/catalog/categories/{category}/bindVincular categoria ao iFood

marketplaces:writeIdempotency-KeyX-Location-Id

Vincula uma categoria local a uma categoria já conferida na loja iFood após resultado incerto de criação. O ID e o nome são verificados na API autenticada do parceiro.

Parâmetros

NomeOndeTipoDescrição
connection obrigatóriocaminhointeger
category obrigatóriocaminhointeger

Corpo application/json

CampoTipoDescrição
external_id obrigatóriostring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/marketplaces/connections/123/catalog/categories/123/bind" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "external_id": "texto"
}'
POST/marketplaces/connections/{connection}/orders/{order}/statusReenviar status do pedido ao canal

marketplaces:writeIdempotency-KeyX-Location-Id

Reenvia manualmente ao marketplace o status do pedido, sem alterar o pedido local. Pedidos do iFood importados passam pelo ledger de envios (push_id e action); o pedido local precisa estar no estado pedido ou além. Pedidos sem vínculo (sandbox) apenas registram o pedido de atualização no outbox.

Parâmetros

NomeOndeTipoDescrição
connection obrigatóriocaminhointeger
order obrigatóriocaminhointeger

Corpo application/json

CampoTipoDescrição
status obrigatóriostringValores: placed, accepted, preparing, ready, dispatched, completed, cancelled.

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/marketplaces/connections/123/orders/123/status" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "placed"
}'
GET/marketplaces/eventsListar eventos recebidos dos canais

marketplaces:readX-Location-Id

Eventos recebidos e seus estados. O pedido completo buscado no marketplace (details) nunca é exposto.

Parâmetros

NomeOndeTipoDescrição
per_pageconsultainteger

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/marketplaces/events" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
GET/marketplaces/issuesListar pendências das integrações

marketplaces:readX-Location-Id

Parâmetros

NomeOndeTipoDescrição
per_pageconsultainteger

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/marketplaces/issues" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/marketplaces/events/{event}/replayReprocessar evento

marketplaces:writeIdempotency-KeyX-Location-Id

Reenfileira um evento com status failed, needs_mapping, received ou deferred. Eventos processed e ignored são finais e não são reabertos. Evento antigo já minimizado por retenção de privacidade também é recusado (422), pois os dados necessários ao processamento já foram removidos.

Parâmetros

NomeOndeTipoDescrição
event obrigatóriocaminhointeger

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/marketplaces/events/123/replay" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
GET/marketplaces/catalog/pendingListar itens do canal sem vínculo

marketplaces:readX-Location-Id

Fila de catálogo pendente da unidade, com as 3 melhores sugestões de vínculo (apenas para itens pending) e o número de pedidos bloqueados. Sugestões só ordenam candidatos; o vínculo é sempre decisão do operador.

Parâmetros

NomeOndeTipoDescrição
per_pageconsultainteger
statusconsultastringValores: pending, resolved, ignored, all.
connection_idconsultainteger

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/marketplaces/catalog/pending" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/marketplaces/catalog/pending/{pending}/resolveVincular item pendente a um produto

marketplaces:writeIdempotency-KeyX-Location-Id

Vincula o item pendente a um produto (ou valor de opção) local e reprocessa os pedidos que ele bloqueava. Repetir com o mesmo local_id não tem efeito; outro local_id para item já vinculado é recusado.

Parâmetros

NomeOndeTipoDescrição
pending obrigatóriocaminhointeger

Corpo application/json

CampoTipoDescrição
local_id obrigatóriostringIdentificador numérico do produto ou do valor de opção local

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/marketplaces/catalog/pending/123/resolve" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "local_id": "texto"
}'
POST/marketplaces/catalog/pending/{pending}/ignoreIgnorar item pendente

marketplaces:writeIdempotency-KeyX-Location-Id

Ignora uma opção pendente (ela segue como texto no comentário do pedido). Itens do cardápio não podem ser ignorados.

Parâmetros

NomeOndeTipoDescrição
pending obrigatóriocaminhointeger

Corpo application/json

CampoTipoDescrição
reasonstring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/marketplaces/catalog/pending/123/ignore" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "reason": "texto"
}'
GET/marketplaces/ordersListar pedidos importados dos canais

marketplaces:readX-Location-Id

Pedidos importados do marketplace. Não inclui snapshot nem dados pessoais do cliente.

Parâmetros

NomeOndeTipoDescrição
per_pageconsultainteger
connection_idconsultainteger
external_statusconsultastringValores: PLACED, CONFIRMED, READY_TO_PICKUP, DISPATCHED, CONCLUDED, CANCELLED.
needs_attentionconsultaboolean

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/marketplaces/orders" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
GET/marketplaces/orders/{marketplaceOrder}/financialConsultar financeiro do pedido iFood

marketplaces:readpayments:readX-Location-Id

Composição financeira e situação fiscal do pedido iFood

Exige marketplaces:read e payments:read. Total do cliente difere da venda comercial/fiscal e do repasse. Documento do consumidor não é retornado. not_migrated exige recarga explícita; review_required impede cobrança e nova apuração.

Parâmetros

NomeOndeTipoDescrição
marketplaceOrder obrigatóriocaminhointeger

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/marketplaces/orders/123/financial" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/marketplaces/orders/{marketplaceOrder}/financial/resyncRecarregar financeiro do pedido iFood

marketplaces:writepayments:writeIdempotency-KeyX-Location-Id

Recarregar valores do iFood e reconhecer pagamento externo

Exige marketplaces:write e payments:write. Consulta autenticada fora da transação OAuth. Não altera itens, não cobra gateway, não confirma repasse. Mudança após captura continua em review_required. Pedido minimizado ou itens divergentes exigem tratamento próprio.

Parâmetros

NomeOndeTipoDescrição
marketplaceOrder obrigatóriocaminhointeger

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/marketplaces/orders/123/financial/resync" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
GET/marketplaces/connections/{connection}/financialListar conciliação e repasses do iFood

marketplaces:readpayments:readX-Location-Id

Conciliação oficial importada e títulos de repasse

Exige marketplaces:read e payments:read. Valores inteiros assinados em centavos. competence filtra lançamentos/resumo; settlements contém até 100 títulos recentes de todas as competências. Apenas impacto_no_repasse SIM compõe expected_net_minor. confirmed significa conferência manual do extrato, sem consulta bancária automática. api_sync_available é false.

Parâmetros

NomeOndeTipoDescrição
per_pageconsultainteger
connection obrigatóriocaminhointeger
competenceconsultastring

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/marketplaces/connections/123/financial" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/marketplaces/connections/{connection}/financial/importImportar arquivo de conciliação do iFood

marketplaces:writepayments:writeIdempotency-KeyX-Location-Id

Importar arquivo mensal cumulativo oficial de conciliação

Exige marketplaces:write e payments:write. CSV/CSV.gz UTF-8, delimitador ponto e vírgula, máximo 10 MB e 20 mil linhas. Loja e competência devem corresponder à conexão. Importação atômica e idempotente; não remove/altera lançamentos já conciliados. Reutilizar chave com outro conteúdo retorna 409. Não confirma repasses nem estorna cliente.

Parâmetros

NomeOndeTipoDescrição
connection obrigatóriocaminhointeger

Corpo multipart/form-data

CampoTipoDescrição
competence obrigatóriostring
file obrigatóriostring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/marketplaces/connections/123/financial/import" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -F "file=@arquivo"
POST/marketplaces/connections/{connection}/financial/settlements/{settlement}/confirmConfirmar repasse do iFood no extrato

marketplaces:writepayments:writeIdempotency-KeyX-Location-Id

Registrar conferência manual de título no extrato bancário

Exige marketplaces:write e payments:write. Uso de operador financeiro com comprovante; não dar esta ferramenta ao atendente para confirmar por alegação do cliente. Valor assinado deve ser exatamente o esperado; títulos divergentes ou já confirmados com outros dados são recusados. Título negativo representa saída. Não confirma pagamento de pedido nem processa estorno ao consumidor.

Parâmetros

NomeOndeTipoDescrição
connection obrigatóriocaminhointeger
settlement obrigatóriocaminhointeger

Corpo application/json

CampoTipoDescrição
amount_minor obrigatóriointeger
date obrigatóriostringData ISO não futura da movimentação no extrato
bank_reference obrigatóriostring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/marketplaces/connections/123/financial/settlements/123/confirm" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "amount_minor": 7080,
  "date": "2026-11-10",
  "bank_reference": "texto"
}'
GET/marketplaces/orders/{marketplaceOrder}/negotiationsListar negociações e alterações do pedido iFood

marketplaces:readX-Location-Id

Acompanhar disputas Handshake e alterações do pedido

Exige marketplaces:read. IDs locais do vínculo e da negociação. Mensagens, fotos e URLs privadas não são expostas. changes informa revisões pendentes, datas e versão canônica para conferência.

Parâmetros

NomeOndeTipoDescrição
per_pageconsultainteger
marketplaceOrder obrigatóriocaminhointeger

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/marketplaces/orders/123/negotiations" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/marketplaces/orders/{marketplaceOrder}/negotiations/{negotiation}/responseResponder negociação do iFood

marketplaces:writeorders:cancelIdempotency-KeyX-Location-Id

Aceitar, recusar ou fazer contraproposta em uma disputa iFood

Exige marketplaces:write e orders:cancel. Uma resposta por disputa antes do prazo. 202 é envio, não acordo final nem cancelamento do pedido. Timeout/5xx/422 podem deixar resultado incerto sem reenvio; 429 respeita Retry-After. Aprovação order.cancel é exigida para aceite/oferta financeira quando configurada.

Parâmetros

NomeOndeTipoDescrição
marketplaceOrder obrigatóriocaminhointeger
negotiation obrigatóriocaminhointeger

Corpo application/json

CampoTipoDescrição
action obrigatóriostringValores: accept, reject, alternative.
reasonstringMotivo oferecido para aceite ou prazo; justificativa obrigatória para recusa
detail_reasonstring
alternative_idstringID de uma alternativa oferecida nesta disputa
amount_minorintegerCentavos inteiros para REFUND ou BENEFIT, até maxAmount e em BRL
additional_time_minutesintegerMinutos entre as opções oferecidas
approval_challengestring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/marketplaces/orders/123/negotiations/123/response" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "accept"
}'
POST/marketplaces/orders/{marketplaceOrder}/changes/reviewRegistrar conferência de alterações do pedido iFood

marketplaces:writeorders:writepayments:writeIdempotency-KeyX-Location-Id

Registrar conferência operacional de alterações externas

Exige marketplaces:write, orders:write e payments:write. Não movimenta estoque ou dinheiro. sync e espera de CANCELLED não são apagáveis por conferência. Versão divergente exige nova leitura.

Parâmetros

NomeOndeTipoDescrição
marketplaceOrder obrigatóriocaminhointeger

Corpo application/json

CampoTipoDescrição
review_keys obrigatórioarray
expected_version obrigatóriointeger

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/marketplaces/orders/123/changes/review" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "review_keys": [
    "items"
  ],
  "expected_version": 123
}'
GET/marketplaces/orders/{marketplaceOrder}/cancellation-reasonsListar motivos de cancelamento do iFood

marketplaces:readX-Location-Id

Consultar motivos de cancelamento disponíveis no iFood para este pedido

Exige marketplaces:read. marketplaceOrder é o id do vínculo retornado por GET /marketplaces/orders, e não o order_id local. Falha transitória do parceiro retorna 503 e Retry-After quando informado.

Parâmetros

NomeOndeTipoDescrição
marketplaceOrder obrigatóriocaminhointeger

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/marketplaces/orders/123/cancellation-reasons" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
GET/marketplaces/orders/{marketplaceOrder}/cancellationConsultar cancelamento do pedido iFood

marketplaces:readX-Location-Id

Consultar solicitação e confirmação de cancelamento iFood

Parâmetros

NomeOndeTipoDescrição
marketplaceOrder obrigatóriocaminhointeger

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/marketplaces/orders/123/cancellation" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/marketplaces/orders/{marketplaceOrder}/cancellationSolicitar cancelamento do pedido ao iFood

marketplaces:writeorders:cancelIdempotency-KeyX-Location-Id

Solicitar cancelamento sem encerrar o pedido antes da confirmação do iFood

Exige marketplaces:write e orders:cancel. O motivo é revalidado no envio. requested e awaiting_confirmation preservam o pedido ativo. Somente CANCELLED confirma o cancelamento. Recusa ou erro não geram estorno nem retorno de estoque.

Parâmetros

NomeOndeTipoDescrição
marketplaceOrder obrigatóriocaminhointeger

Corpo application/json

CampoTipoDescrição
cancellation_code obrigatóriostring
reason_codestring
approval_challengestring?

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/marketplaces/orders/123/cancellation" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "cancellation_code": "503"
}'
GET/marketplaces/status-pushesListar envios de status aos canais

marketplaces:readX-Location-Id

Ledger de envios de status ao marketplace (um por pedido e ação).

Parâmetros

NomeOndeTipoDescrição
per_pageconsultainteger
statusconsultastringValores: pending, sending, sent, skipped, failed, dead.
connection_idconsultainteger

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/marketplaces/status-pushes" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/marketplaces/status-pushes/{push}/retryReenviar envio de status com falha

marketplaces:writeIdempotency-KeyX-Location-Id

Devolve à fila um envio que falhou ou esgotou as tentativas (failed ou dead). O envio segue a ordem do pedido.

Parâmetros

NomeOndeTipoDescrição
push obrigatóriocaminhointeger

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/marketplaces/status-pushes/123/retry" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"

Governança

Auditoria

GET/auditConsultar trilha de auditoria

audit:readX-Location-Id

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/audit" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
GET/reasonsListar motivos operacionais

reasons:manageX-Location-Id

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/reasons" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Accept: application/json"
POST/approvalsSolicitar aprovação de supervisor

approvals:grantIdempotency-KeyX-Location-Id

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/approvals" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"
POST/approvals/{approval}/approveConceder aprovação de supervisor

approvals:grantIdempotency-KeyX-Location-Id

Parâmetros

NomeOndeTipoDescrição
approval obrigatóriocaminhostring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/approvals/<approval>/approve" \
  -H "Authorization: Bearer $CHAMEJAR_TOKEN" \
  -H "X-Location-Id: $CHAMEJAR_UNIDADE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Accept: application/json"

Webhooks de entrada

Endereços chamados pelos próprios canais e provedores. Não são para chamar a partir da sua integração.

POST/webhooks/fiscal/{provider}Receber retorno do provedor fiscal (uso do provedor)

Sem autenticação

Endereço chamado pelo próprio canal ou provedor. Não chame a partir da sua integração.

Receptor Chamejar autenticado por segredo exclusivo do provedor e da unidade (FISCAL_WEBHOOK_SECRETS). X-Fiscal-Signature contém o HMAC-SHA256 hexadecimal do corpo bruto usando esse segredo; aceita prefixo sha256=. Limite de 64 KiB. O corpo identifica evento e documento; status e protocolo são obtidos por consulta autenticada ao adaptador fiscal, nunca aceitos do callback. Exige adaptador instalado para provedores reais.

Parâmetros

NomeOndeTipoDescrição
provider obrigatóriocaminhostring
X-Fiscal-Location-Id obrigatóriocabeçalhointeger
X-Fiscal-Webhook-Token obrigatóriocabeçalhostring
X-Fiscal-Signature obrigatóriocabeçalhostring

Corpo application/json

CampoTipoDescrição
idstring
event_idstring
typestring
document_idstring
provider_document_idstring
access_keystring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/webhooks/fiscal/<provider>" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '"texto"'
POST/webhooks/marketplaces/{provider}Receber evento de marketplace (uso dos canais)

Sem autenticação

Endereço chamado pelo próprio canal ou provedor. Não chame a partir da sua integração.

Recebe um evento do marketplace de forma idempotente (por conexão e identificador externo). Fora do sandbox, exige segredo de pelo menos 32 caracteres, X-Marketplace-Timestamp Unix em segundos e X-Marketplace-Signature hexadecimal HMAC-SHA256 sobre timestamp + ponto + corpo bruto usando o token como chave. Janela de 300 segundos. Conexão inexistente, token inválido ou assinatura inválida retornam 401. Limite de 256 KiB. Payload no formato de evento do iFood (fullCode e orderId) preenche event_type, event_code, external_order_id, occurred_at e source=webhook e entra no mesmo pipeline do polling.

Parâmetros

NomeOndeTipoDescrição
provider obrigatóriocaminhostring
X-Marketplace-Connection obrigatóriocabeçalhointeger
X-Marketplace-Token obrigatóriocabeçalhostring
X-Marketplace-Timestampcabeçalhostring
X-Marketplace-Signaturecabeçalhostring

Corpo application/json

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/webhooks/marketplaces/<provider>" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
GET/opendelivery/{merchant}/merchantFornecer dados da loja no padrão Open Delivery (uso do aiqfome)

Sem autenticação

Endereço chamado pelo próprio canal ou provedor. Não chame a partir da sua integração.

Retorna dados e cardápio da loja Aiqfome quando a conexão está ativa. Disponível em produção somente com AIQFOME_ENABLED.

Parâmetros

NomeOndeTipoDescrição
merchant obrigatóriocaminhostring
X-API-KEY obrigatóriocabeçalhostring

Exemplo

curl -X GET "$CHAMEJAR_URL/api/v1/opendelivery/<merchant>/merchant" \
  -H "Accept: application/json"
POST/webhooks/aiqfome/eventsReceber evento do aiqfome (uso do aiqfome)

Sem autenticação

Endereço chamado pelo próprio canal ou provedor. Não chame a partir da sua integração.

Recebe evento Aiqfome V2 autenticado pelo segredo da conexão. Disponível em produção somente com AIQFOME_ENABLED.

Parâmetros

NomeOndeTipoDescrição
Authorization obrigatóriocabeçalhostring

Corpo application/json

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/webhooks/aiqfome/events" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
POST/webhooks/keeta/eventsReceber evento da Keeta (uso da Keeta)

Sem autenticação

Endereço chamado pelo próprio canal ou provedor. Não chame a partir da sua integração.

Evento Open Delivery Keeta autenticado por HMAC-SHA256 Base64 do corpo bruto e roteado pelo merchant externo para uma única conexão ativa. Persiste e deduplica antes de responder 204; limite de 256 KiB, sem throttle API compartilhado. Disponível em produção somente com KEETA_ENABLED. Configurar ordersWebhookURL no onboarding; não executar acknowledgment de polling para webhooks.

Parâmetros

NomeOndeTipoDescrição
X-App-Id obrigatóriocabeçalhostringIdentificador da Keeta
X-App-MerchantId obrigatóriocabeçalhostring
X-App-Signature obrigatóriocabeçalhostring

Corpo application/json

CampoTipoDescrição
eventId obrigatóriostring
eventType obrigatóriostring
orderId obrigatóriostring
createdAt obrigatóriostring

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/webhooks/keeta/events" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "eventId": "texto",
  "eventType": "texto",
  "orderId": "texto",
  "createdAt": "2026-11-10T19:30:00-03:00"
}'
POST/webhooks/vainabag/eventsReceber evento da Vainabag (uso da Vainabag)

Sem autenticação

Endereço chamado pelo próprio canal ou provedor. Não chame a partir da sua integração.

Recebe evento Vainabag assinado; consulta o estado remoto antes de atualizar a entrega. Disponível em produção somente com VAINABAG_ENABLED.

Parâmetros

NomeOndeTipoDescrição
X-Vainabag-Signature obrigatóriocabeçalhostring

Corpo application/json

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/webhooks/vainabag/events" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
POST/webhooks/vainabag-marketplace/eventsReceber evento do Marketplace da Vainabag (uso da Vainabag)

Sem autenticação

Endereço chamado pelo próprio canal ou provedor. Não chame a partir da sua integração.

Recebe evento assinado do Marketplace da Vainabag (order.created e order.status_changed). É apenas um sinal que antecipa a conferência de pedidos na API da Vainabag; nunca cria pedido por conta própria. A assinatura é sha256= mais HMAC-SHA256 de timestamp, ponto e corpo bruto, com tolerância de 5 minutos no X-Vainabag-Timestamp. Canal desligado por padrão; sem VAINABAG_MARKETPLACE_ENABLED responde 404 em qualquer ambiente.

Parâmetros

NomeOndeTipoDescrição
X-Vainabag-Signature obrigatóriocabeçalhostring
X-Vainabag-Timestamp obrigatóriocabeçalhostringSegundos Unix do envio
X-Vainabag-EventcabeçalhostringValores: order.created, order.status_changed.

Corpo application/json

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/webhooks/vainabag-marketplace/events" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
POST/webhooks/ifood/eventsReceber evento do iFood (uso do iFood)

Sem autenticação

Endereço chamado pelo próprio canal ou provedor. Não chame a partir da sua integração.

Webhook oficial exclusivo de aplicação iFood centralizada. Valida X-IFood-Signature com HMAC-SHA256 hexadecimal em maiúsculas ou minúsculas sobre o corpo bruto antes do JSON. Evento é persistido por ID e loja antes do 202; KEEPALIVE exige presença por merchant e responde apenas lojas ativas vinculadas. Exclui o throttle:api herdado; as demais rotas mantêm seus limites. Sem vínculo roteável persiste em quarentena cifrada da aplicação antes do 202, sem atribuir unidade. Recuperação a cada 30 s após vínculo ativo único na mesma aplicação; conteúdo expira em 24 h, sem extensão por replay, e é removido na próxima rotina. Falha de persistência retorna 503. A URL HTTPS é cadastrada no Portal iFood.

Parâmetros

NomeOndeTipoDescrição
X-IFood-Signature obrigatóriocabeçalhostring

Corpo application/json

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/webhooks/ifood/events" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
POST/webhooks/ifood/test/eventsReceber evento de teste do iFood (uso do iFood)

Sem autenticação

Endereço chamado pelo próprio canal ou provedor. Não chame a partir da sua integração.

Mesmo contrato do webhook oficial, com credenciais, assinatura e quarentena da aplicação de teste. Exige IFOOD_TEST_ENABLED e aplicação de teste centralizada; não compartilha eventos nem vínculos com produção.

Parâmetros

NomeOndeTipoDescrição
X-IFood-Signature obrigatóriocabeçalhostring

Corpo application/json

Exemplo

curl -X POST "$CHAMEJAR_URL/api/v1/webhooks/ifood/test/events" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'