Começando
Por onde começar? Leia primeiro!
Antes de começar a trabalhar nesta API, você precisa ler as seguintes seções se ainda não as tiver consultado:
Os Tipos de Transação
Existem três tipos de transações realizadas por um revendedor:
- Peças: Vendas de Peças, Acessórios e Vestuário (PA&A) para um cliente.
- Serviços: Ordens de reparo para a reparação e manutenção de veículos.
- Unidades: Vendas de um veículo para um cliente.
Os três tipos de transações são enviados no Transações recurso e muitas transações podem ser enviadas na mesma chamada.
O revendedor deve consentir com o compartilhamento de dados antes de você enviar a transação do revendedor para a BRP.
Consulte a Compartilhamento de Dados seção para mais informações sobre compartilhamento de dados.
A carga útil da API de Transações de Varejo contém muitas informações. Às vezes, seu DMS pode não conseguir fornecer as informações solicitadas.
Está tudo bem, e cada caso será discutido durante as atividades de certificação. Se o seu DMS tiver limitações técnicas que impeçam o envio de algumas informações, as exceções serão documentadas e acordadas.
Os Cenários
Quando um cliente entra em uma concessionária, muitos cenários são possíveis. Aqui estão alguns exemplos:
- O cliente compra um novo capacete Ski-Doo (Peças).
- O cliente traz seu ATV para manutenção (Peças e Serviços).
- O cliente traz seu antigo See-Doo em troca da compra de um novo (Unidades).
- O cliente traz seu Side-by-side para reparo e para adicionar um guincho (Peças e Serviços).
- O cliente entra para comprar um novo Ricker com acessórios e um capacete (Peças, Unidades e Serviços).
Esses cenários criam diferentes transações, fornecendo informações valiosas sobre o comportamento do cliente, tendências de mercado, eficiência de promoções e fidelidade à marca.
As informações são úteis para a BRP na compreensão do mercado e na adaptação das promoções, programas e estratégias para ajudar os concessionários a melhorar seus negócios.
É por isso que a API de Transações de Varejo é muito importante para os grupos de negócios da BRP.
A estrutura da carga útil da API de Transações de Varejo permite o envio de muitas transações de clientes, e cada transação de cliente pode usar um, dois ou três tipos.
Usando os cenários acima, seu DMS enviará os seguintes payloads:
O cliente compra um novo capacete Ski-Doo.
- A carga contém uma transação de Peças .
O cliente traz seu ATV para manutenção.
- A carga contém um trabalho para os reparos e um OTC para as peças.
O cliente traz seu antigo See-Doo em troca da compra de um novo.
- A carga contém uma unidade transação.
O cliente traz seu Side-by-side para reparo e para adicionar um guincho.
- A carga contém um trabalho para os reparos e um Peças para as peças.
O cliente entra para comprar um novo Ryker com acessórios e um capacete, a carga contém.
- Um trabalho para a instalação dos acessórios
- Um Peças para o capacete e os acessórios.
- Uma unidade para a venda da unidade.
Uma carga para enviá-los todos
Todas essas transações poderiam ser enviadas em uma carga útil uma vez que a API recebe um array de transações, e cada transação tem os três tipos.

Há um objeto de cabeçalho global para cada transação, e os objetos Parts, Units e Repairs são preenchidos conforme necessário.
No contexto da API de Transações de Varejo, uma transação na carga útil geralmente corresponde a uma fatura no seu DMS.
Quando você vê "transação" na documentação restante, pode pensar em uma "fatura".
A imagem abaixo mostra uma carga para as 5 transações (ou faturas) descritas nos cenários.

A transação abaixo é um exemplo do cenário 5, no qual o cliente compra um novo Ski-Doo Summit com um suporte e um novo traje e tem o suporte instalado pelo revendedor.

Uma carga pode conter muitas transações se todas forem para o mesmo revendedor!
Na carga, os diferentes tipos de transações são mapeados da seguinte forma:
- Peças: transactions.parts
- Trabalhos: transactions.jobs
- Unidades: transactions.units