Open Delivery vs Prefiro Extensions
A API segue o padrão Open Delivery V2 na maior parte dos endpoints. Algumas funcionalidades são extensões proprietárias da Prefiro Delivery — úteis, mas fora da especificação oficial.
Como identificar
| Indicador | Open Delivery V2 | Prefiro Extension |
|---|---|---|
| OpenAPI | Sem flag especial | x-prefiro-extension: true |
| Discovery | Pode constar em supportedOperations | Não declarada no manifesto OD |
| Documentação | Guias Orders / Customer / Loyalty | Esta página + tag na API Reference |
Extensões disponíveis
| Endpoint | Descrição |
|---|---|
POST /customers/{customerId}/cashback | Creditar cashback em uma conta de loyalty |
Body esperado: accountId, rewardId (prefiro-cashback-reward), amount (centavos, > 0), currency: BRL, reason (opcional), externalReference (opcional).
Resposta 201 com objeto LoyaltyAccount atualizado.
Por que extensões existem
O Open Delivery padroniza leitura e resgate de loyalty; a Prefiro adiciona crédito programático de cashback para integrações de CRM/parceiros que precisam bonificar clientes fora do fluxo de pedido.
Ao implementar, trate extensões como contrato Prefiro ↔ integrador, não como requisito do ecossistema Open Delivery genérico.