v1

latestOpenAPI 3.1.02026-08-04650218.3 KB

/sales/total

Esse endpoint irá contabilizar todas as vendas realizadas em uma loja. Para isso, é necessário realizar uma chamada cada venda efetuada. Mesmo as vendas que não passaram pelo fluxo da CRMBonus.

post/sales/total

Headers

Content-Typestring required
System-Namestring required

Nome do sistema PDV que está enviando a requisição

User-Agentstring required
Request-Hashstring required

request_hash obtido na requisição user/verify

Request body

sales_type'IN_STORE' | 'ONLINE' | 'PRE-SALE' | 'WHOLESALE' | 'TELESALES' | 'MARKETPLACE' | 'RETAIL' | 'POSTPAID_SALES'

Tipo de venda

seller_namestring

Nome do vendedor

generated_bonus_idsstring[]

IDs dos bônus que foram gerados <br><br> Importante <br> Se um bônus foi gerado, deve-se informá-lo (dado retornado em /bonus/submit).

internal_order_idstring required

Identificador do pedido

referential_order_idstring

Referência do pedido (opcional)

invoicestring

Nota fiscal do pedido

terminalstring

Identificação do terminal ou caixa onde a venda foi realizada

Response

200

statusboolean
messagestring

Example response

{
  "status": true,
  "message": "Success",
  "data": {
    "sale_id": "22a87c-01d4-4da5-81de-b43acb052332"
  }
}