Visão geral

A Prefiro Delivery expõe uma API compatível com o padrão Open Delivery V2, no papel de Ordering Application: a plataforma origina pedidos, publica eventos e hospeda os endpoints que o seu sistema consome.

Papel na integração

Papel Open Delivery	Quem implementa
Ordering Application (OA)	Prefiro Delivery
Software Service (SS) — PDV, CRM	Você (integrador)

Seu sistema autentica com as credenciais do App Open Delivery, consome eventos ou webhooks de pedidos, consulta detalhes via GET e executa transições de lifecycle conforme a especificação.

O que a API oferece

Área	Descrição
Autenticação	OAuth `client_credentials` com escopos `od.orders`, `od.crm` e `od.all`
Discovery	Manifesto `/.well-known/opendelivery` com capabilities e eventos
Orders	Polling, ACK, GET de pedido e transições de lifecycle
Customer	Listagem e consulta de clientes do tenant
Loyalty	Programa de cashback (programas, contas, extrato, resgate)
Prefiro Extensions	Crédito programático de cashback — ver Extensions

Base URL

https://opendelivery.prefirodelivery.com/{HASH}/od/v2

{HASH} é o identificador do estabelecimento / merchant autorizado no App Open Delivery (fornecido no onboarding).

Discovery (manifesto da integração):

GET https://opendelivery.prefirodelivery.com/{HASH}/.well-known/opendelivery

Por onde começar

Primeiros passos — obter API URL, Client ID e Client Secret
Autenticação — token e escopos
API Reference — contrato OpenAPI interativo

Especificação completa do protocolo: docs.opendelivery.com.br.