Engage / API v1
Vendas

Buscar por ID

Retorna os dados completos de uma venda a partir do seu identificador único.

GET/v1/sales/id/:id

Use este endpoint para recuperar uma venda já registrada. A resposta traz os dados principais, todos os itens com productName resolvido a partir do produto, e o objeto customFields com os campos customizados configurados para Venda.

Obrigatório

Apenas o parâmetro de path id é obrigatório. Não há body nem query string.

Exemplo

http
GET /v1/sales/id/9f8e7d6c-5b4a-3210-fedc-ba9876543210

Parâmetros de path

  • idstring (uuid)obrigatório
    Identificador único da venda, recebido no campo id da resposta de criação.

Campos da resposta

  • idstringopcional
    Identificador único da venda.
  • customerIdstringopcional
    ID do cliente vinculado à venda.
  • totalAmountnumberopcional
    Soma de quantity × unitPrice de todos os itens.
  • saleDatestring (ISO 8601)opcional
    Data e hora em que a venda aconteceu.
  • itemsarrayopcional
    Lista de itens vendidos. Cada item traz productId, productName, quantity, unitPrice e totalPrice.
  • createdAtstring (ISO 8601)opcional
    Quando a venda foi registrada no Engage.
  • customFieldsobjectopcional
    Mapa { <nome do campo>: valor } com os campos customizados preenchidos. Vazio se nenhum campo foi definido.