Engage / API v1
Referência

Vendas

Registre e consulte vendas realizadas. Cada venda vincula um cliente a um conjunto de itens (produtos × quantidade × preço). Pode ser estendida com campos customizados.

Endpoints

Modelo da venda

  • idstring (uuid)
    Identificador único da venda, gerado pelo Engage.
  • customerIdstring (uuid)
    ID do cliente da venda. Deve existir na sua conta.
  • totalAmountnumber
    Soma de quantity × unitPrice de todos os itens. Calculado pelo servidor.
  • saleDatestring (ISO 8601)
    Data e hora em que a venda aconteceu.
  • itemsarray
    Lista de itens vendidos. Cada item traz productId, productName, quantity, unitPrice e totalPrice.
  • createdAtstring (ISO 8601)
    Data e hora em que a venda foi registrada no Engage.
  • customFieldsobject
    Campos customizados configurados para a entidade Venda. Presente apenas em respostas de busca.

Modelo do item

  • productIdstring (uuid)
    ID do produto vendido. Deve existir na sua conta.
  • productNamestring | null
    Nome do produto, resolvido a partir do produto referenciado. Apenas em respostas.
  • quantitynumber
    Quantidade do produto vendido. Mínimo 1.
  • unitPricenumber
    Preço unitário praticado nesta venda. Mínimo 0. Pode ser diferente do preço cadastrado no produto.
  • totalPricenumber
    quantity × unitPrice. Calculado pelo servidor.