/sales/total

post

https://apipdv-homol.crmbonus.com/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.

Introdução `/sales/total`

Dicionário de Dados

Campo	Descrição
sales_type	Tipo de venda (ENUM).
seller_name	Nome do vendedor.
generated_bonus_ids	Ids dos bônus que foram gerados (Dado retornado no endpoint /bonus/submit).
internal_order_id	Identificador do pedido.
referential_order_id	Referência do pedido (opcional).
invoice	Nota fiscal do pedido.
terminal	Identificação do terminal ou caixa onde a venda foi realizada.
[customer] country_code	DDI do celular do cliente.
[customer] phone	Celular do cliente (DDD + Número).
[customer] name	Nome do cliente.
[customer] email	E-mail do cliente.
[customer] birth	Data de nascimento do cliente (Ano-Mês-Dia).
[customer] gender	Gênero do cliente (ENUM).
[customer] document_type	Tipo de documento do cliente (ENUM).
[customer] document_number	Número do documento do cliente.
[customer] category_custom	Categoria do cliente.
[customer] custom_data	Campo customizado.
[items] sku	Identificador do produto.
[items] value_of	Valor base de referência do produto. Caso haja mais de um produto, enviar o valor já multiplicado pela quantidade.
[items] value_per	Valor do produto com desconto da loja (não CRM), se houver. Caso haja mais de um produto, enviar o valor já multiplicado pela quantidade.
[items] quantity	Quantidade do produto.
[delivery] type	Tipo da entrega (ENUM).
[delivery] fee	Taxa da entrega.
[payments] id	Identificador do pagamento.
[payments] system_id	Identificador do sistema.
[payments] system_name	Nome do sistema do pagamento.
[payments] type	Tipo de pagamento (ENUM).
[payments] value	Valor do pagamento.
[payments] installments	Parcela do pagamento.
[totals] fee	Taxas adicionais.
[totals] taxes	Impostos.
[totals] subtotal	Valor bruto da compra.
[totals] crm_discounts	Descontos aplicados na CRMBonus.
[totals] other_discounts	Outros descontos.
[totals] total	Valor líquido da compra.

Body Params

sales_type

string

enum

Defaults to IN_STORE

Tipo de venda

seller_name

string

Defaults to Leonardo Campos

Nome do vendedor

generated_bonus_ids

array of strings

Defaults to 60a3f6dc-01d4-4da5-81de-b43acb067504

IDs dos bônus que foram gerados

Importante
Se um bônus foi gerado, deve-se informá-lo (dado retornado em /bonus/submit).

generated_bonus_ids

internal_order_id

string

required

Defaults to 500425

Identificador do pedido

referential_order_id

string

Defaults to ABC100

Referência do pedido (opcional)

invoice

string

Defaults to NF-10050

Nota fiscal do pedido

terminal

string

Defaults to 5

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

customer

object

required

Dados do cliente

items

array

Produtos selecionados na compra

items

delivery

object

Dados da entrega

payments

object

Dados do pagamento

totals

object

required

Subtotal da compra e descontos aplicados

Headers

System-Name

string

required

Defaults to {pdvSystemName}

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

User-Agent

string

required

Request-Hash

string

required

Defaults to 94c9efbb6daaa86995263caf10cb4e17

request_hash obtido na requisição user/verify

Response

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json