Referência da API

API REST do Ecom

Uma API REST organizada em torno de recursos previsíveis, com respostas em JSON e códigos de status HTTP convencionais. A URL base é fixa; a autenticação já identifica a sua loja — pelo cookie/JWT de sessão ou pela chave de API.

URL base

https://api.ecomplataforma.com.br

Autenticação (Admin)

POST/auth/login
Login do painel
GET/auth/me
Usuário atual
PUT/auth/profile
Atualizar perfil
PUT/auth/password
Trocar senha
POST/auth/forgot-password
Esqueci a senha
POST/auth/logout
Logout do painel

Autenticação (Cliente)

POST/store-auth/register
Cadastrar cliente
POST/store-auth/login
Login do cliente
GET/store-auth/me
Perfil do cliente
POST/store-auth/magic-link/request
Solicitar magic link
POST/store-auth/magic-link/verify
Verificar magic link
POST/store-auth/social/{provider}/verify
Login social

Produtos

GET/products
Listar produtos
GET/products/{id}
Obter produto
POST/products
Criar produto
PUT/products/{id}
Atualizar produto
DELETE/products/{id}
Excluir produto
GET/products/{id}/variants
Listar variantes
POST/products/csv/import
Importar catálogo (CSV)

Clientes

GET/customers
Listar clientes
POST/customers
Cadastrar cliente (admin)

Categorias & Marketplaces

GET/categories
Listar categorias
GET/categories/{id}
Obter categoria
POST/categories
Criar categoria
PUT/categories/{id}
Atualizar categoria
DELETE/categories/{id}
Excluir categoria
GET/subcategories
Listar subcategorias
POST/subcategories
Criar subcategoria
GET/marketplaces
Listar marketplaces

Estoque

GET/inventory
Listar estoque
GET/inventory/{productId}/movements
Movimentações de estoque
POST/inventory/{productId}/movements
Lançar movimentação

Pedidos

GET/orders
Listar pedidos
GET/orders/{id}
Obter pedido
PUT/orders/{id}
Atualizar pedido
POST/orders/{id}/etiqueta
Gerar etiqueta

Devoluções & Disputas

GET/returns
Listar devoluções
GET/returns/{id}
Obter devolução
POST/returns/{id}/approve
Aprovar devolução
POST/returns/{id}/refund
Estornar devolução
GET/disputes
Listar disputas
GET/disputes/{id}
Obter disputa
POST/disputes/{id}/responder
Responder disputa

Checkout & Loja

POST/store/checkout
Checkout
GET/store/orders
Meus pedidos
GET/store/orders/{id}
Detalhe do meu pedido
GET/store/loyalty/me
Meus pontos
POST/store/track
Evento de analytics
POST/store/newsletter-subscribe
Assinar newsletter

Pedido manual

GET/manual-orders
Listar pedidos manuais
POST/manual-orders
Criar pedido manual
PATCH/manual-orders/{id}
Atualizar pedido manual
POST/manual-orders/{id}/whatsapp
Enviar etapa por WhatsApp
POST/manual-orders/{id}/comprovante/whatsapp
Enviar comprovante

Cupons & Cashback

GET/coupons
Listar cupons
GET/coupons/{id}
Obter cupom
POST/coupons
Criar cupom
PUT/coupons/{id}
Atualizar cupom
DELETE/coupons/{id}
Excluir cupom
POST/coupons/{id}/reativar
Reativar cupom
GET/cashbacks
Listar regras de cashback
POST/cashbacks
Criar regra de cashback
GET/wallet
Carteira / saldo
POST/wallet/transfers
Solicitar transferência

Marketing

GET/campaigns
Listar campanhas
POST/campaigns
Criar campanha
PATCH/campaigns/{id}
Atualizar campanha
POST/campaigns/{id}/dispatch
Disparar campanha
GET/segments
Listar segmentos
GET/automation-rules
Listar regras de automação
POST/automation-rules
Criar regra de automação
GET/abandoned-carts
Carrinhos abandonados
POST/abandoned-carts/{orderId}/checkout-link
Link de recuperação

Fidelidade & Assinaturas

GET/loyalty/config
Config do clube de pontos
PUT/loyalty/config
Atualizar clube de pontos
GET/loyalty/report
Relatório de fidelidade
GET/referral/afiliados
Afiliados / indicações
GET/subscriptions
Assinaturas do cliente

Relatórios & Dashboard

GET/dashboard
Métricas do dashboard
GET/reports/{tipo}
Relatório por tipo
GET/attribution
Atribuição de marketing

GET/whatsapp-config
Config de WhatsApp
PUT/whatsapp-config
Atualizar WhatsApp
POST/whatsapp/qr/connect
Conectar via QR
GET/whatsapp/qr/status
Status da conexão QR

Configurações

GET/settings
Configurações da loja
PUT/settings
Atualizar configurações
GET/shipping-config
Config de frete
POST/shipping-config/simulate
Simular frete

Config avançada

GET/email-config
Config de e-mail
PUT/email-config
Atualizar e-mail
GET/email-templates
Templates de e-mail
PUT/email-templates/{tipo}
Salvar template
GET/nf-config
Config de Nota Fiscal
PUT/nf-config
Atualizar NF
GET/auth-config
Config de login social
PUT/auth-config
Atualizar login social
GET/ai-config
Config de IA
PUT/ai-config
Atualizar IA
GET/ifood-delivery-config
Config de entrega iFood
PUT/ifood-delivery-config
Alternar iFood

Blog, A/B & Temas

GET/blog
Listar posts do blog
POST/blog
Criar post
GET/ab-experiments
Listar experimentos A/B
GET/ab-experiments/{id}/results
Resultados do experimento
GET/themes/catalog
Catálogo de temas

Storefront público

GET/public/products
Produtos (storefront)
GET/public/products/{id}
Produto (storefront)
GET/public/categories
Categorias (storefront)
POST/public/shipping/quote
Cotar frete (storefront)
POST/public/coupons/validate
Validar cupom (storefront)
POST/public/installments/simulate
Simular parcelamento (storefront)
GET/public/blog
Blog (storefront)
GET/public/orders/{id}/tracking
Rastreio público

Webhooks & API Keys

POST/webhooks/{gateway}
Webhook de pagamento (inbound)
GET/webhook-subscriptions
Listar webhooks (outbound)
POST/webhook-subscriptions
Criar webhook (outbound)
GET/webhook-subscriptions/{id}/deliveries
Entregas do webhook
DELETE/webhook-subscriptions/{id}
Revogar webhook
GET/api-keys
Listar chaves de API
POST/api-keys
Criar chave de API
DELETE/api-keys/{id}
Revogar chave de API

API pública v1

GET/api/v1/me
Identidade da chave
GET/api/v1/orders
Pedidos (pública)
GET/api/v1/orders/{id}
Pedido por id (pública)
GET/api/v1/products
Produtos (pública)
GET/api/v1/products/{id}
Produto por id (pública)