Visao Geral
A API principal foi criada para integrações objetivas de loja, cardápio, pedidos, status, marcação de integração e WhatsApp. Os retornos seguem JSON com success, data, meta e error.
Esta página é a entrada principal do CFShop Developer. A API2 Completa fica em rota separada para cobrir PDV e gestor sem alterar a API principal.
Precisa integrar todo o PDV e gestor?
A API2 Completa inclui formas de pagamento, status, pedidos, itens, caixa, financeiro, mesas, entregadores, estoque, filas de impressão e integrações.
Ir para API2 CompletaAutenticacao
Use o token de integracao da loja no header Authorization. Tambem aceitamos X-CFSHOP-Token para sistemas que nao conseguem enviar Bearer Token.
Authorization: Bearer SEU_TOKEN_DA_LOJA
Content-Type: application/json
Padrao de erro
{
"success": false,
"error": {
"code": "invalid_token",
"message": "Token invalido ou loja nao encontrada."
}
}
Endpoints
| Metodo | Rota | Uso | Acesso |
|---|---|---|---|
| GET | /health | Verifica se a API2 esta online. | Publico |
| GET | /store | Consulta dados basicos da loja autenticada. | Token |
| GET | /products | Lista produtos, categorias e variacoes. | Token |
| GET | /orders | Lista pedidos com filtros por status, periodo e integracao pendente. | Token |
| GET | /orders/{id} | Consulta detalhes do pedido, incluindo JSON bruto do pedido. | Token |
| POST | /orders/{id}/status | Atualiza o status operacional do pedido. | Token |
| POST | /orders/{id}/integrated | Marca o pedido como integrado para nao voltar na fila pendente. | Token |
| POST | /whatsapp/messages | Envia mensagem pelo Robo 24hrs quando habilitado na loja. | Token |
Pedidos
Para buscar somente pedidos ainda nao consumidos pela sua integracao, use pending_integration=1. Depois de processar, chame POST /orders/{id}/integrated.
GET https://cfshop.com.br/api2/orders?pending_integration=1&limit=50
GET https://cfshop.com.br/api2/orders?status=1,4,9&created_from=2026-07-02 00:00:00
GET https://cfshop.com.br/api2/orders/759450
Atualizar status
POST https://cfshop.com.br/api2/orders/759450/status
{
"status": 9
}
Codigos de Status
Quando um delivery recebe status 4, a API2 preserva a regra operacional da CFShop e converte para 9, deixando o pedido em producao.
Exemplos
Consultar loja
curl -X GET "https://cfshop.com.br/api2/store" \
-H "Authorization: Bearer SEU_TOKEN_DA_LOJA"
Listar produtos
curl -X GET "https://cfshop.com.br/api2/products?visible=1" \
-H "Authorization: Bearer SEU_TOKEN_DA_LOJA"
Marcar pedido como integrado
curl -X POST "https://cfshop.com.br/api2/orders/759450/integrated" \
-H "Authorization: Bearer SEU_TOKEN_DA_LOJA" \
-H "Content-Type: application/json"
Enviar WhatsApp
curl -X POST "https://cfshop.com.br/api2/whatsapp/messages" \
-H "Authorization: Bearer SEU_TOKEN_DA_LOJA" \
-H "Content-Type: application/json" \
-d '{"to":"5599999999999","message":"Seu pedido saiu para entrega."}'