Customer

Endpoints para sincronizar ou consultar dados de clientes. Requer escopo od.crm ou od.all.

Endpoints

Operação	Método	Path
Listar	GET	/customers
Obter por ID	GET	/customers/{customerId}

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

Identificador do cliente

customerId é um UUID determinístico — o mesmo valor aparece no bloco customer do GET order.

Listagem

Parâmetros de paginação (obrigatórios na prática; defaults aplicados se omitidos):

Parâmetro	Regra
page	≥ 1 (default 1)
pageSize	1–100 (default 50)

Filtros opcionais: customerIdentifierType + customerIdentifierValue (phone, document, email), updatedFrom, updatedTo.

Resposta: { items, page, pageSize, total }.

Clientes excluídos no sistema Prefiro não aparecem na API. O filtro merchantId é ignorado — clientes são do tenant inteiro.

Campos principais

Campo	Descrição
id	UUID do cliente
identifier	Canal principal conforme configuração do tenant
contacts[]	Telefone, e-mail, documento quando disponíveis
status	lead (sem pedidos) ou active
createdAt / updatedAt	ISO 8601 UTC

Especificação: Customer — Open Delivery.