Introdução
Esta documentação detalha a API de Webhook responsável por notificar sistemas externos sobre alterações de pedidos.
O webhook pode ser configurado para diferentes tipos de serviços, como alteração de status de pedido, novos pedidos e alterações gerais.
Como Funciona
- O sistema verifica os webhooks cadastrados para o serviço correspondente.
- Para cada webhook válido, uma requisição HTTP é feita para a URL configurada.
- Dependendo do tipo de evento, diferentes parâmetros são passados na URL.
Webhook de Alteração de Pedido
Endpoint
POST {webhook_url}?orderId={OrderId}&storeId={StoreId}&status={Status}
Parâmetros
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| orderId | string | Sim | Identificador do pedido |
| storeId | string | Não | Identificador da loja |
| status | string | Não | Status do pedido (para novos pedidos) |
| situation | string | Não | Situação do pedido (para alterações) |
Tipos de Serviço Suportados
| Tipo | Descrição |
|---|---|
| AlteracaoStatus | Notifica sobre qualquer mudança de status do pedido, como "Processando", "Enviado", "Entregue", entre outros. |
| PedidoNovo | Notifica sobre a criação de um novo pedido. |
| AlteracaoPedido | Notifica sobre qualquer alteração nos detalhes do pedido, incluindo itens do pedido, cliente, pagamento, endereço de entrega, entre outros. |
Exemplo de Requisição
Alteração de Status
POST https://api.exemplo.com/webhook?orderId=123&storeId=456
Novo Pedido
POST https://api.exemplo.com/webhook?orderId=123&storeId=456&status=Iniciado
Alteração de Pedido
POST https://api.exemplo.com/webhook?orderId=123&storeId=456&situation=changed
Resposta Esperada
{
"success": true,
"message": "Webhook processado com sucesso"
}