Skip to main content
GET
Obter cliente (CRM)
Detalha a ficha completa de um cliente da loja pelo customerId — vindo da listagem, de uma conversão, de um cupom ou de uma avaliação.
Diferente da listagem (pseudonimizada), o detalhe traz dados pessoais: nome, telefone, e-mail, data de nascimento e endereço. Trate esses campos conforme a LGPD — use-os apenas para a finalidade autorizada e não os armazene além do necessário.
Além da identificação, a resposta agrupa:
  • address — endereço estruturado (street, number, neighborhood, city, state, postalCode, country), no mesmo formato usado pelo Open Delivery. complement hoje vem sempre null e type/country vêm sempre fixos em delivery/BR.
  • orderHistory — produtos favoritos e canal de compra preferido. Ticket médio, intervalo entre compras e última compra não estão mais aqui: use esses campos na listagem, que já os traz por cliente.
  • consentAndEngagement — opt-in de WhatsApp e se o cliente interagiu com a última comunicação. orderOrigin está no schema mas hoje vem sempre null (ainda não implementado).
O customerId não é global: ele pertence à loja. Um cliente de outra loja — ou inexistente — responde 404 com Customer not found.

Erros

Conversões

As vendas atribuídas a campanhas — cada uma referencia um customerId.

Autorizações

Authorization
string
header
obrigatório

Token de acesso emitido por POST /od/v2/oauth/token (fluxo client_credentials). Envie no header Authorization como Bearer <token>.

Parâmetros de caminho

merchantId
string<uuid>
obrigatório

Identificador (UUID) do merchant — o mesmo id de GET /od/v2/merchants.

customerId
integer<int32>
obrigatório

Identificador do cliente na loja, retornado em customerId na listagem.

Resposta

Cliente encontrado.

id
integer<int32>

Mesmo valor de customerId da listagem.

name
string | null
phoneNumber
string | null
email
string | null
birthDate
string<date-time> | null
address
object | null
orderHistory
object