CFShopAPI 2 Completa
PDV e gestor

CFShop API 2 Completa

Esta API foi criada em uma rota nova para cobrir o que existe hoje no gestor e no PDV: pedidos, pagamentos, status, produtos, clientes, caixa, financeiro, mesas, entregadores, estoque, impressoes e integracoes.

A API base em /api2/ continua sem alteracao. Esta documentacao usa /api2-completa/.

Autenticacao

Todos os endpoints operacionais exigem token da loja. Os catalogos publicos e o health podem ser consultados sem token.

curl "https://cfshop.com.br/api2-completa/store" \
  -H "Authorization: Bearer TOKEN_DA_LOJA"

Rotas

Catalogos publicos

MetodoRotaFuncao
GET /health Status da API completa.
GET /catalog/payment-methods Formas de pagamento usadas pelo PDV e caixa.
GET /catalog/order-statuses Status de pedidos usados hoje.
GET /catalog/order-types Tipos de atendimento: delivery, balcao, mesa e servico.
GET /catalog/modules Mapa dos modulos cobertos pela API.

Gestor / loja

MetodoRotaFuncao
GET /store Dados, modos de atendimento, modulos e configuracoes seguras da loja.
POST/PATCH /store/status Abre ou fecha a loja no atendimento online.
GET /integrations Status das integracoes iFood, 99Food, Zé, Anota AI, Machine, Juma e WhatsApp.

Cardapio e clientes

MetodoRotaFuncao
GET/POST /categories Lista ou cria categorias.
PATCH /categories/{id} Atualiza categoria.
GET/POST /products Lista ou cria produtos com precos, estoque e variacoes.
PATCH /products/{id} Atualiza produto.
GET/POST /customers Lista ou cria clientes.
PATCH /customers/{id} Atualiza cliente.

PDV / pedidos

MetodoRotaFuncao
GET /orders Lista pedidos com filtro por status, tipo, mesa, periodo e integracao pendente.
GET /orders/{id} Detalhe completo do pedido, incluindo JSON bruto e dados de entrega parceira.
GET /orders/{id}/items Itens do pedido.
GET /orders/{id}/payments Pagamentos lancados no caixa.
POST/PATCH /orders/{id}/status Atualiza status do pedido. Delivery aceito vira producao.
POST /orders/{id}/integrated Marca pedido como integrado.
POST/PATCH /orders/{id}/payment Atualiza forma de pagamento do pedido.
POST/PATCH /orders/{id}/assign-deliverer Atribui ou remove entregador.

Caixa e financeiro

MetodoRotaFuncao
GET /cash-registers Lista caixas.
GET/POST /cash-registers/open Consulta ou abre caixa.
GET /cash-registers/{id}/movements Movimentacoes do caixa.
GET /cash-registers/{id}/summary Resumo por vendas, entradas, saidas e formas de pagamento.
POST /cash-registers/{id}/close Fecha caixa e grava totais por forma.
GET/POST /finance/movements Lista ou cria lancamentos financeiros em contas.

Mesas, entregas, estoque e impressao

MetodoRotaFuncao
GET /tables Mapa de mesas e valores em aberto.
GET /tables/{numero}/orders Pedidos abertos de uma mesa.
GET/POST/PATCH /deliverers Entregadores da loja.
GET /stock/products Produtos com saldo de estoque e flags de esgotado.
GET /print-queue Filas de impressao driver, producao e auto aceite.

Formas de Pagamento

A lista oficial vem do endpoint /catalog/payment-methods. Ela inclui dinheiro, credito, debito, PIX, Mercado Pago, Getnet, Pix Online, Pix QRCode, Pix maquininha, link de pagamento, credito/debito online, iFood Pago Online, conta assinada e cashback.

GET https://cfshop.com.br/api2-completa/catalog/payment-methods

Status de Pedido

A lista oficial vem do endpoint /catalog/order-statuses. O status 4 em delivery e convertido para 9, preservando a regra atual do PDV.

GET https://cfshop.com.br/api2-completa/catalog/order-statuses

Exemplos

Listar pedidos em producao

curl "https://cfshop.com.br/api2-completa/orders?status=9&limit=50" \
  -H "Authorization: Bearer TOKEN_DA_LOJA"

Atualizar status

curl -X POST "https://cfshop.com.br/api2-completa/orders/759450/status" \
  -H "Authorization: Bearer TOKEN_DA_LOJA" \
  -H "Content-Type: application/json" \
  -d '{"status":9}'

Abrir caixa

curl -X POST "https://cfshop.com.br/api2-completa/cash-registers/open" \
  -H "Authorization: Bearer TOKEN_DA_LOJA" \
  -H "Content-Type: application/json" \
  -d '{"initial_balance":100.00,"user_id":1}'

Lancar despesa

curl -X POST "https://cfshop.com.br/api2-completa/finance/movements" \
  -H "Authorization: Bearer TOKEN_DA_LOJA" \
  -H "Content-Type: application/json" \
  -d '{"cash_register_id":374,"type":3,"nature":-1,"payment_method":1,"value":25.00,"info":"Compra avulsa"}'