← pedidofacil

Admin API

API compatível com a Admin API de apps de mercado (token OAuth2 password, recursos de pedidos e status, webhooks) com extensão para o módulo Meu Evento. Troque apenas a URL base e as credenciais no seu ERP.

URL base: https://sua-loja.app/api/public/admin-api

Especificação OpenAPI (importe no Postman/Insomnia): openapi.json

1. Autenticação

Gere as credenciais no painel da loja (Integrações / API). Depois peça um token e envie-o em Authorization: Bearer <token>.

curl -X POST https://sua-loja.app/api/public/admin-api/token \
  -d grant_type=password -d client_id=bd_xxx -d client_secret=xxx \
  -d username=erp_xxx -d password=xxx

{ "access_token": "…", "token_type": "Bearer", "expires_in": 3600 }

2. Recursos

post/tokenAutenticação

Gerar token de acesso (válido por 1h)

get/v1/ordersPedidos

Listar pedidos da loja

Parâmetros: status (query), updatedSince (query), page (query), limit (query)

get/v1/orders/{id}Pedidos

Detalhar pedido

Parâmetros: id (path)

put/v1/orders/{id}/statusPedidos

Alterar status do pedido (dispara ORDER_STATUS_CHANGED)

Parâmetros: id (path)

get/v1/productsProdutos

Listar catálogo

patch/v1/productsProdutos

Sincronizar estoque/preço por SKU (até 1000 itens)

get/v1/eventsMeu Evento (extensão)

Listar eventos

Parâmetros: status (query), from (query), to (query)

get/v1/events/{id}Meu Evento (extensão)

Detalhar evento com itens, contagem e pagamentos

Parâmetros: id (path)

3. Webhooks

Cadastre URLs no painel. Enviamos um POST JSON com o cabeçalho X-Webhook-Event, com até 3 tentativas. Responda 2xx para confirmar.

  • ORDER_CREATED — Novo pedido recebido
  • ORDER_STATUS_CHANGED — Pedido mudou de status (WAITING, APPROVED, IN_TRANSIT, DONE, REJECTED, HIDDEN)
  • EVENT_STATUS_CHANGED — Meu Evento mudou de etapa (orçamento, contrato, entrega, recolha, fechamento)
{ "event": "ORDER_STATUS_CHANGED", "timestamp": "2026-09-26T12:00:00Z", "data": { /* Order */ } }

4. Migrando do seu app de mercado atual

  • Mesmo fluxo de token (grant password com client_id, client_secret, username e password).
  • Mesmos códigos de status de pedido e evento de webhook ORDER_STATUS_CHANGED.
  • Troque a URL base e as credenciais; o cabeçalho legado de ID de integração é aceito e ignorado.
  • Novidade: rotas /v1/events para contratos de comodato, contagem e fechamento.