API de Promoções

45 min

Começando

A API de Promoções permite que o revendedor obtenha promoções disponíveis para uma unidade pelo seu número de série (VIN) ou número do modelo.

👉 Na versão atual, apenas as promoções de unidade estão disponíveis. Em uma versão futura da API, as promoções de PA&A deverão estar disponíveis.

As promoções disponíveis em um modelo de unidade são documentadas por meio de boletins de promoção que contêm uma ou mais promoções.

Por onde começar? Leia isto primeiro!

Antes de começar a trabalhar nesta API, você precisa ler as seguintes seções se ainda não as tiver visto:

Comece Aqui Com Leitura Obrigatória!
Informações Técnicas para informações técnicas gerais sobre a API e os ambientes.
Autenticação e Credenciais para detalhes sobre autenticação e credenciais.
Processo de Certificação para detalhes sobre o processo de certificação e Jira.
Obtendo Suporte para detalhes sobre como obter ajuda e Jira.

Resumo de Negócios

Tópico	Descrição
Escopo	Unidade na América do Norte em DMS e CRM
Cenários	Pedido de Unidade DMS: obter promoções disponíveis ao preparar uma cotação de venda para um cliente CRM: encontrar promoções disponíveis ao responder a um lead de vendas
Funcionalidades principais	Fornecer promoções disponíveis para uma unidade Fornecer promoções disponíveis para um modelo
Processos de negócio suportados	Vendas de unidades Lead de vendas
Benefícios para concessionárias	Encontrar rapidamente as promoções disponíveis Ajudar nas vendas de unidades
Benefícios para BRP	Ajudar nas vendas de unidades

Informações Técnicas

Características

Tipo de API	Tipo de DSP	Versão DCP	Complexidade
Obter dados do BRP	DMS	V3 - Internacional	Baixa
Enviar dados para BRP	CRM	V4 - América do Norte	Um pouco mais
Transação com BRP			Um pouco mais ainda

Autenticação

A API está usando Autenticação da Aplicação.

Você precisa de um token de acesso válido antes de chamar esta API ou deve chamar a API de Autenticação de Aplicativos para obter um.

O token de acesso é válido por 30 minutos! (1799 segundos)

URL Base

Teste	https://qa-cloud-api.brp.com/dcp/v4
Produção	https://cloud-api.brp.com/dcp/v4

Recurso: Promoções

Quando chamada para solicitar as promoções para um número de série (VIN) ou um número de modelo, a API de Promoções retorna um recurso de Promoções .

Representação JSON

{
    "module_number": "00029RA00",
    "model_name": "PWC GTI SE 130 BE IBR 24",
    "bulletins": [
        {
            "bulletin_code": "02-23-BRP-UNT-CA",
            "bulletin_description": "B.E.S.T. SALESPERSON REWARD (SPIFF) PROG",
            "date_until_reserved": "2023-04-01",
            "date_until_consumed": "2024-01-31",
            "is_stackable": true,
            "is_pre_order": false,
            "promotions": [
                {
                    "promotion_category": "Immediate",
                    "promotion_deposit_amount": 0.00,
                    "promotion_code": "0000000387",
                    "promotion_types": [
                        {
                            "promotion_type": "11",
                            "component_description": "50$ SPIFF CONTINGENT ON 2 YEAR BEST SALE",
                            "benefit_promo_code": "02-23-BRP-UNT-CA_SPIFF50"
                        }
                    ]
                }
            ]
        },
        {
            "bulletin_code": "01-24-PWC-UNT-CA",
            "bulletin_description": "2024 Sea-Doo PWC Pre-Order Sales Event",
            "date_until_reserved": "2024-03-31",
            "date_until_consumed": "2024-06-30",
            "is_stackable": true,
            "is_pre_order": false,            
            "promotions": [
                {
                    "promotion_category": "Certificate",
                    "promotion_deposit_amount": 500.00,
                    "promotion_code": "0000000976",
                    "promotion_types": [
                        {
                            "promotion_type": "04",
                            "component_description": "2Y + $250 OFF $1,000 IN ACCESSORIES / 2A + 250 $ DE RABAIS SUR UN ACHAT DE 1 000 $ D'ACCESSOIRES",
                            "benefit_promo_code": "01-24-PWC-UNT-CA_COV2_ACCESSORIES"
                        }
                    ]
                }
            ]
        }
    ]
},

Propriedades

Propriedade	Tipo	Definição	Nota
model_number	string	Código que identifica de forma única um modelo de unidade.	Comprimento: 9
model_name	string	A descrição do modelo.
bulletins	Lista de objetos	Lista de boletins.
bulletins.bulletin_code	string	Número do boletim.	Comprimento máximo: 15
bulletin.bulletin_description	string	Descrição do boletim.
bulletins.date_until_reserved	datetime	Data de início da promoção, no formato ISO 8601.	Formato: YYYY-MM-DDTHH:MM:SSZ
bulletins.date_until_consumed	datetime	Data de término da promoção, no formato ISO 8601.	Formato: YYYY-MM-DDTHH:MM:SSZ
bulletins.is_stackable	boolean	Indica se os tipos de promoção são acumuláveis (E) ou não acumuláveis (OU). No primeiro caso, o revendedor pode selecionar mais de um boletim de promoção.
bulletins.is_pre_order	boolean	Indica se a promoção é aplicável para pré-venda.
bulletins.promotions	Lista de objetos	Lista de promoções.
bulletins .promotions .promotion_category	string	Categoria da promoção, um dos seguintes valores: Certificado Código PIN Código de Autorização Imediato	Comprimento máximo: 18
bulletins .promotions .promotion_deposit_amount	string	Valor do depósito necessário para reservar uma promoção.
Bulletins .promotions .promotion_code	string	Código da promoção (código do acordo).	Comprimento máximo: 10
bulletins .promotions .promotion_types	Lista de objetos	Lista de tipos de promoção.
bulletins .promotions .promotion_types .promotion_type	string	Tipo de promoção. Um dos valores da tabela Tipos de Promoção abaixo.	Comprimento máximo: 2
bulletins .promotions .promotion_types .component_description	string	Descrição do componente.
bulletins .promotions .promotion_types .benefit_promotion_code	string	Código da promoção de benefício.	Comprimento máximo: 18

Tipos de Promoções

Código	Descrição
01	Reembolso em Dinheiro
02	Cobertura Estendida
03	Financiamento ao Consumidor
04	Reembolso em Dinheiro e Cobertura Estendida
05	Reembolso em Dinheiro e Financiamento ao Consumidor
06	Cobertura Estendida e Financiamento ao Consumidor
07	Reembolso em Dinheiro, Cobertura e Financiamento ao Consumidor
08	Dinheiro em vez de Upgrades
09	Dinheiro em vez de Acessórios e Vestuário
10	Valor do Depósito
11	SPIFF (incentivos ou bônus de vendas de curto prazo)
12	Dinheiro em vez de Upgrades e Cobertura Estendida
13	Dinheiro em vez de Acessórios e Vestuário + Cobertura Estendida
14	Demonstração

Limitações e Restrições

Promoções por Unidade

Nesta versão, a API de Promoções retorna apenas promoções relacionadas a vendas por unidade.

Compreendendo Promoções

Esta seção fornece mais informações sobre a estrutura das promoções e como elas são exibidas no BOSSWeb.

👉 Lembre-se de que as promoções são específicas do concessionário e mudam ao longo do tempo.

Elas são específicas do concessionário porque uma promoção pode ser válida apenas para regiões específicas, por exemplo, a costa oeste dos EUA.

Boletins de Promoção

As informações retornadas pela API de Promoções são uma lista de resumos de promoções documentadas em boletins de promoções. A API de Promoções não retorna a documentação completa da promoção: o revendedor deve ir ao BOSSWeb para recuperar os documentos de promoção conforme necessário.

👉Os revendedores sabem como usar as informações retornadas pela API de Promoções, pois são as mesmas exibidas no BOSSWeb.

Mais de um boletim de promoção pode estar ativo ao mesmo tempo para um número de modelo. Em alguns casos, o revendedor pode selecionar mais de um boletim de promoção conforme controlado pela propriedade is_stackable .

Um boletim de promoção contém uma ou mais promoções. Quando há mais de uma promoção em um boletim, o revendedor deve selecionar uma delas.

Cenários de Promoções

Esta seção apresenta diferentes cenários de promoção. Para cada um, o payload JSON da API de Promoções é mostrado com a correspondente exibição no BOSSWeb.

Seu DSP deve ter uma tela semelhante à mostrada nas capturas de tela do BOSSWeb para exibir as promoções.

👉 Os exemplos foram feitos para o revendedor 0000694307 em 5 de julho de 2024, no ambiente de produção.

Se você chamar a API de Promoções ao ler isto, receberá uma lista diferente de promoções.

Um Boletim Com Uma Promoção

O payload abaixo mostra as promoções para o modelo 0003CNA00. Há apenas um boletim que contém uma promoção.

{
    "model_number": "0003CNA00",
    "model_name": "ATV DS 90-4ST 90 RD 22",
    "bulletins": [
        {
            "bulletin_code": "12-24-ORV-UNT-US",
            "bulletin_description": "BUY ONE ATV/SSV,GET $500 OFF A YOUTH ATV",
            "date_until_reserved": "2024-06-01",
            "date_until_consumed": "2024-07-31",
            "is_stackable": true,
            "is_pre_order": false,
            "promotions": [
                {
                    "promotion_category": "Authorization Code",
                    "promotion_deposit_amount": "0.00",
                    "promotion_code": "0000002097",
                    "promotion_types": [
                        {
                            "promotion_type": "01",
                            "component_description": "BUY ONE ADULT ORV GET $500 ON A YOUTH MODEL (250$ CREDIT PER UNIT)",
                            "benefit_promotion_code": ""
                        }
                    ]
                }
            ]
        }
    ]
}

A exibição no BOSSWeb é a seguinte.

Dois Boletins Com Uma Promoção

O payload para o modelo 0002WNA00 contém 2 boletins e cada um contém uma promoção.

Todos os boletins de promoção têm a propriedade is_stackable definida como true, o que significa que o concessionário pode selecionar uma promoção de todos os boletins de promoção, conforme mostrado pelo AND entre os boletins de promoção na tela do BOSSWeb.

{
    "model_number": "0002WNA00",
    "model_name": "ATV OUTL DPS 450 GY 22",
    "bulletins": [
        {
            "bulletin_code": "01-24-BRP-UNT-US",
            "bulletin_description": "B.E.S.T. SALESPERSON REWARD (SPIFF)",
            "date_until_reserved": "2024-02-01",
            "date_until_consumed": "2025-01-31",
            "is_stackable": true,
            "is_pre_order": false,
            "promotions": [
                {
                    "promotion_category": "Immediate",
                    "promotion_deposit_amount": "0.00",
                    "promotion_code": "0000001707",
                    "promotion_types": [
                        {
                            "promotion_type": "11",
                            "component_description": "50$ SPIFF CONTINGENT ON 2 YEAR BEST SALE",
                            "benefit_promotion_code": ""
                        }
                    ]
                }
            ]
        },
        {
            "bulletin_code": "12-24-ORV-UNT-US",
            "bulletin_description": "BUY ONE ATV/SSV,GET $500 OFF A YOUTH ATV",
            "date_until_reserved": "2024-06-01",
            "date_until_consumed": "2024-07-31",
            "is_stackable": true,
            "is_pre_order": false,
            "promotions": [
                {
                    "promotion_category": "Authorization Code",
                    "promotion_deposit_amount": "0.00",
                    "promotion_code": "0000002097",
                    "promotion_types": [
                        {
                            "promotion_type": "01",
                            "component_description": "BUY ONE ADULT ORV GET $500 ON A YOUTH MODEL (250$ CREDIT PER UNIT)",
                            "benefit_promotion_code": ""
                        }
                    ]
                }
            ]
        }
    ]
}

A exibição do BOSSWeb mostra que o concessionário pode selecionar as 2 promoções, pois há um AND entre os 2 boletins.

Múltiplos Boletins com Múltiplas Promoções

O payload para o modelo 000G1RA00 mostra que o concessionário pode selecionar promoções dos 3 boletins, já que a propriedade is_stackable está definida como true.

O concessionário pode selecionar:

Uma promoção do boletim Apple CarPlay Compensation .

A promoção do boletim B.E.S.T. SALESPERSON REWARD (SPIFF) .

Uma promoção do boletim Can-Am Experience (Corporate Stops) .

{
    "model_number": "000G1RA00",
    "model_name": "RD SPYDER RT LTD 1330 SE6 GY DRK 24",
    "bulletins": [
        {
            "bulletin_code": "10-24-3WV-UNT-US",
            "bulletin_description": "Apple CarPlay Compensation",
            "date_until_reserved": "2023-08-20",
            "date_until_consumed": "2024-10-31",
            "is_stackable": true,
            "is_pre_order": false,
            "promotions": [
                {
                    "promotion_category": "Immediate",
                    "promotion_deposit_amount": "0.00",
                    "promotion_code": "0000002114",
                    "promotion_types": [
                        {
                            "promotion_type": "02",
                            "component_description": "APPLE CARPLAY COMP. 1Y EXTRA COV",
                            "benefit_promotion_code": ""
                        },
                        {
                            "promotion_type": "01",
                            "component_description": "500$(375$ DEALER CREDIT) APPLE CARPLAY COMP.",
                            "benefit_promotion_code": ""
                        }
                    ]
                }
            ]
        },
        {
            "bulletin_code": "01-24-BRP-UNT-US",
            "bulletin_description": "B.E.S.T. SALESPERSON REWARD (SPIFF)",
            "date_until_reserved": "2024-02-01",
            "date_until_consumed": "2025-01-31",
            "is_stackable": true,
            "is_pre_order": false,
            "promotions": [
                {
                    "promotion_category": "Immediate",
                    "promotion_deposit_amount": "0.00",
                    "promotion_code": "0000001707",
                    "promotion_types": [
                        {
                            "promotion_type": "11",
                            "component_description": "50$ SPIFF CONTINGENT ON 2 YEAR BEST SALE",
                            "benefit_promotion_code": ""
                        }
                    ]
                }
            ]
        },
        {
            "bulletin_code": "05-24-3WV-UNT-US",
            "bulletin_description": "Can-Am Experience (Corporate Stops)",
            "date_until_reserved": "2024-03-01",
            "date_until_consumed": "2024-07-31",
            "is_stackable": true,
            "is_pre_order": false,
            "promotions": [
                {
                    "promotion_category": "PIN Code",
                    "promotion_deposit_amount": "0.00",
                    "promotion_code": "0000001801",
                    "promotion_types": [
                        {
                            "promotion_type": "01",
                            "component_description": "500$ CASH REBATE",
                            "benefit_promotion_code": ""
                        },
                        {
                            "promotion_type": "09",
                            "component_description": "500$ IN PA&A (CREDIT OF 400$)  - PENDING CLAIM SUBMISSION",
                            "benefit_promotion_code": ""
                        }
                    ]
                }
            ]
        }
    ]
}

A tela do BOSSWeb é assim. Observe o AND entre os boletins e o OR entre as promoções no primeiro e no último boletim.

Boletins Não Empilháveis

A carga útil para o modelo 000MXSD00 mostra um exemplo de boletins não empilháveis, pois a is_stackable propriedade está definida como falso.

Isso significa que o concessionário deve selecionar uma promoção do primeiro boletim (SNO MY25 TEST) ou uma promoção do último boletim (B.E.S.T. SALESPERSON REWARD (SPIFF)).

{
    "model_number": "000MXSD00",
    "model_name": "SM MXZ XRS 850 YL 129 1.2RS HUB 25",
    "bulletins": [
        {
            "bulletin_code": "01-25-SNO-UNT-TEST",
            "bulletin_description": "SNO MY25 TEST",
            "date_until_reserved": "2024-07-06",
            "date_until_consumed": "2024-12-31",
            "is_stackable": false,
            "is_pre_order": false,
            "promotions": [
                {
                    "promotion_category": "Certificate",
                    "promotion_deposit_amount": "1000.00",
                    "promotion_code": "0000002421",
                    "promotion_types": [
                        {
                            "promotion_type": "02",
                            "component_description": "3 YEAR COVERAGE/3 ANS DE GARANTIE",
                            "benefit_promotion_code": ""
                        },
                        {
                            "promotion_type": "06",
                            "component_description": "3 YEAR COVERAGE+ SECURE RATE/3 ANS DE GARANTIE+SÉCURISER VOTRE TAUX",
                            "benefit_promotion_code": ""
                        },
                        {
                            "promotion_type": "01",
                            "component_description": "1000$ IN PA&A (800$ CREDIT) PENDING CLAIM/1000$ EN PAV(CRÉDIT DE 800$)  AVEC REQUÊTE",
                            "benefit_promotion_code": ""
                        },
                        {
                            "promotion_type": "05",
                            "component_description": "1000$ IN PA&A (800$ CREDIT)WITH CLAIM+SECURED RATE/1000$ PAV(CRÉDIT 800$) AVEC REQUÊTE+SÉCUR TAUX",
                            "benefit_promotion_code": ""
                        },
                        {
                            "promotion_type": "06",
                            "component_description": "3 YEAR COVERAGE+ SECURE RATE/3 ANS DE GARANTIE+SÉCURISER VOTRE TAUX",
                            "benefit_promotion_code": ""
                        },
                        {
                            "promotion_type": "05",
                            "component_description": "1000$ IN PA&A (800$ CREDIT)WITH CLAIM+SECURED RATE/1000$ PAV(CRÉDIT 800$) AVEC REQUÊTE+SÉCUR TAUX",
                            "benefit_promotion_code": ""
                        }
                    ]
                }
            ]
        },
        {
            "bulletin_code": "01-24-BRP-UNT-US",
            "bulletin_description": "B.E.S.T. SALESPERSON REWARD (SPIFF)",
            "date_until_reserved": "2024-02-01",
            "date_until_consumed": "2025-01-31",
            "is_stackable": true,
            "is_pre_order": false,
            "promotions": [
                {
                    "promotion_category": "Immediate",
                    "promotion_deposit_amount": "0.00",
                    "promotion_code": "0000001707",
                    "promotion_types": [
                        {
                            "promotion_type": "11",
                            "component_description": "50$ SPIFF CONTINGENT ON 2 YEAR BEST SALE",
                            "benefit_promotion_code": ""
                        }
                    ]
                }
            ]
        }
    ]
}

A tela do BOSSWeb mostra um OU entre os boletins, significando que eles não são acumuláveis.

Promoções com VIN

A API de Promoções fornece um serviço para obter as promoções de um VIN. O payload retornado funciona exatamente como as chamadas com um número de modelo.

Por exemplo, esta chamada:

curl --location 'https://cloud-api.brp.com/dcp/v4/unit/2BXNBDD24RV001472/promotions?usage_code=REC_01' \
--header 'Dealer-Number: 00006943075' \
--header 'Authorization: Bearer REPLACE_ME'

Retorna o seguinte payload:

{
    "model_number": "000G1RA00",
    "model_name": "RD SPYDER RT LTD 1330 SE6 GY DRK 24",
    "bulletins": [
        {
            "bulletin_code": "10-24-3WV-UNT-US",
            "bulletin_description": "Apple CarPlay Compensation",
            "date_until_reserved": "2023-08-20",
            "date_until_consumed": "2024-10-31",
            "is_stackable": true,
            "is_pre_order": false,
            "promotions": [
                {
                    "promotion_category": "Immediate",
                    "promotion_deposit_amount": "0.00",
                    "promotion_code": "0000002114",
                    "promotion_types": [
                        {
                            "promotion_type": "02",
                            "component_description": "APPLE CARPLAY COMP. 1Y EXTRA COV",
                            "benefit_promotion_code": ""
                        },
                        {
                            "promotion_type": "01",
                            "component_description": "500$(375$ DEALER CREDIT) APPLE CARPLAY COMP.",
                            "benefit_promotion_code": ""
                        }
                    ]
                }
            ]
        },
        {
            "bulletin_code": "01-24-BRP-UNT-US",
            "bulletin_description": "B.E.S.T. SALESPERSON REWARD (SPIFF)",
            "date_until_reserved": "2024-02-01",
            "date_until_consumed": "2025-01-31",
            "is_stackable": true,
            "is_pre_order": false,
            "promotions": [
                {
                    "promotion_category": "Immediate",
                    "promotion_deposit_amount": "0.00",
                    "promotion_code": "0000001707",
                    "promotion_types": [
                        {
                            "promotion_type": "11",
                            "component_description": "50$ SPIFF CONTINGENT ON 2 YEAR BEST SALE",
                            "benefit_promotion_code": ""
                        }
                    ]
                }
            ]
        },
        {
            "bulletin_code": "05-24-3WV-UNT-US",
            "bulletin_description": "Can-Am Experience (Corporate Stops)",
            "date_until_reserved": "2024-03-01",
            "date_until_consumed": "2024-07-31",
            "is_stackable": true,
            "is_pre_order": false,
            "promotions": [
                {
                    "promotion_category": "PIN Code",
                    "promotion_deposit_amount": "0.00",
                    "promotion_code": "0000001801",
                    "promotion_types": [
                        {
                            "promotion_type": "01",
                            "component_description": "500$ CASH REBATE",
                            "benefit_promotion_code": ""
                        },
                        {
                            "promotion_type": "09",
                            "component_description": "500$ IN PA&A (CREDIT OF 400$)  - PENDING CLAIM SUBMISSION",
                            "benefit_promotion_code": ""
                        }
                    ]
                }
            ]
        }
    ]
}

And the BOSSWeb display is like this:

Referência da API

Obter Promoções por VIN

Obter as promoções usando o VIN (número de série) de uma unidade.

GET

/unit/{serial_no}/promotions

curl --location 'https://qa-cloud-api.brp.com/dcp/v4/unit/3JBLGAR41NJ002076/promotions?usage_code=REC_01' \
--header 'Dealer-Number: 0000690095' \
--header 'Authorization: Bearer REPLACE_ME'

Obter Promoções por Número de Modelo ou VIN

Obter as promoções usando um número de modelo de unidade ou um número de série de unidade. Apenas um dos parâmetros model_no e serial_no pode ser fornecido.

GET

/promotions

curl --location 'https://qa-cloud-api.brp.com/dcp/v4/promotions?usage_code=REC_01&model_no=0002WNA00' \
--header 'Dealer-Number: 0000690095' \
--header 'Authorization: Bearer REPLACE_ME'

Código de uso

Código	Descrição
REC_01	Recreativo/Pessoal
DE_01	Demonstração
LE_01	Arrendamento
LO_01	Empréstimo
GOV_01	Governo
REN_01	Aluguel
COM_01	Comercial
AG_01	Agrícola
PS_01	Equipe Profissional
FR_01	Registro Forçado
CSG_01	Consignação
RA_01	Corrida
SL/LS_01	Empréstimo Escolar LS 365 Dias Termos de Financiamento
SL/LT_01	Empréstimo Escolar LT 465 Dias Termos de Financiamento
MI_01	Militar
NC_01	Sem Custo

Como Fazer

Esta seção fornece informações sobre como obter resultados específicos com a API.

Obter promoções para um VIN

Obtenha as promoções disponíveis usando o VIN de uma unidade e para uso comercial. Essa chamada pode ser usada quando um concessionário deseja obter as promoções disponíveis ao preparar uma cotação de venda para um cliente.

Get Promotions for a VIN

curl --location 'https://cloud-api.brp.com/dcp/v4/unit/3JBLGAR41NJ002076/promotions?usage_code=COM_01' \
--header 'Dealer-Number: 0000691690' \
--header 'Authorization: Bearer REPLACE_ME'

Obter Promoções para um Número de Modelo

Obtenha as promoções disponíveis para um número de modelo. A chamada permite ao revendedor ver as promoções para um modelo de unidade em seu estoque.

Observe que o parâmetro registration_date é usado nesta chamada para ver todas as promoções disponíveis após 1º de novembro de 2023. Esse tipo de chamada pode retornar promoções expiradas, portanto é importante exibir os campos date_until_reserved e date_until_consumed.

Obter Promoções para um Número de Modelo

curl --location 'https://cloud-api.brp.com/dcp/v4/promotions?usage_code=REC_01&registration_date=2023-11-01&model_no=0002WNA00' \
--header 'Dealer-Number: 0000690095' \
--header 'Authorization: Bearer REPLACE_ME'

Tratamento de Erros

Esta seção apresenta vários cenários de chamadas inadequadas ou incorretas, que resultam em mensagens de erro e resultados incorretos.

400 Requisição Inválida

O código de status 400 é geralmente visto durante o desenvolvimento e a integração e não deve ser recebido durante operações normais. A resposta retornada contém as informações necessárias para corrigir o problema.

Muitos problemas podem causar um código de status 400; os mais comuns estão listados na tabela abaixo.

Resposta	Resolução
Retornado se o parâmetro de cabeçalho Dealer-Number estiver ausente. { "status": "400", "id": "rrt-074faba1d0796ac77-c-ea-24396-616154-1", "title": "bad_request", "meta": { "service": "01", "detail": "request validation failed", "payload": { "details": [ { "message": "Header parameter 'Dealer-Number' is required on path '/invoices' but not found in request." } ] } } }	Atualize sua chamada de API para adicionar o parâmetro Dealer-Number no cabeçalho.
Retornado se o número do modelo e o número de série estiverem ausentes na consulta. { "status": "400", "id": "rrt-023ba21d3844ea361-c-ea-22598-2461748-1.1", "title": "bad_request", "meta": { "service": "98", "detail": "No model number or serial number were provided. Either one of model_no or serial_no must be provided." } }	Certifique-se de incluir um número de modelo ou número de série (VIN) no caminho da consulta.
Retornado se os números de modelo e série (VIN) forem fornecidos. { "status": "400", "id": "rrt-08b132083d72c98ab-b-ea-26817-2169562-1.1", "title": "bad_request", "meta": { "service": "98", "detail": "A model number and a serial number were provided. Only one of model_no or serial_no can be provided at one time." } }	Forneça apenas o número do modelo ou o número de série.
Retornado se o número do modelo for inválido. { "status": "400", "id": "rrt-0d1e94b23f6aa0176-d-ea-28384-5536739-1.1", "title": "bad_request", "meta": { "service": "15", "detail": "Invalid model number: 000AAA00" } }	O revendedor pode ter cometido um erro ao inserir o número do modelo. Você deve informar o erro ao usuário para que ele tente novamente.
Retornado se o número de série (VIN) for inválido. { "status": "400", "id": "rrt-08b132083d72c98ab-b-ea-26817-2169562-1.1", "title": "bad_request", "meta": { "service": "98", "detail": "Invalid VIN 2BPSABNA3NV000000" } }	O revendedor pode ter inserido erroneamente o número de série (VIN). Você deve informar o erro ao usuário para que ele tente novamente.
Retornado se o número do revendedor for inválido. { "status": "400", "id": "rrt-0d1e94b23f6aa0176-d-ea-28384-5536117-1.1", "title": "bad_request", "meta": { "service": "06", "detail": "Invalid dealer number :0000123456" } }	Se o revendedor estiver usando seu DMS, pode ser que ele não seja mais um revendedor BRP. Verifique com ele e desative as atualizações de inventário de peças. Certifique-se de que o número do revendedor tenha 10 caracteres. Se você salvar o número sem os zeros à esquerda, adicione-os antes de chamar a API. O erro também é retornado se o revendedor não for um revendedor BRP ativo.

401 Não autorizado

O código de status de erro 401 Unauthorized é retornado quando você tenta chamar a API com um access_token expirado.

Você precisa obter um novo access_token com uma chamada para a API de Autenticação de Aplicativos.

O código de status de erro 401 Unauthorized também é retornado se você não solicitou acesso à API criando um ticket no DCP Jira.

Quando você estiver pronto para começar a trabalhar em uma API, deverá criar um ticket de certificação no Jira, conforme descrito na seção Atividades de Certificação com Jira.

Se você já começou a trabalhar em uma API e perdeu o acesso, crie um ticket de suporte conforme descrito na seção Abrir um Ticket de Suporte.

404 Não Encontrado

O código de status 404 Not Found é retornado quando nenhuma promoção está disponível para o número do modelo ou número de série (VIN).

{
    "status": "404",
    "id": "rrt-023ba21d3844ea361-c-ea-22598-2461228-1.1",
    "title": "not_found",
    "meta": {
        "service": "19",
        "detail": "Requested promotion not found."
    }
}

Requisitos DSP

Requisitos Funcionais

ID	Tipo	Requisito
1	Obrigatório	O revendedor deve ser capaz de recuperar as promoções para uma unidade usando o VIN.
2	Obrigatório	O revendedor deve ser capaz de recuperar as promoções para uma unidade usando o número do modelo.
3	Obrigatório	Se nada for encontrado, o DSP deve exibir as promoções recuperadas ou uma mensagem.
4	Obrigatório	O DSP deve exibir as promoções em uma tela semelhante à mostrada na seção Exibição de Promoções.

Atividades de Certificação

Esta seção apresenta todas as atividades de certificação e validações que devem ser concluídas para certificar a API.

Garantia de Qualidade

Os testes listados na tabela abaixo devem ser realizados com sucesso no ambiente de teste antes que você possa iniciar a fase piloto do concessionário.

👉 Para os testes, como o número de promoções no ambiente de teste é limitado, você deve usar VINs e números de modelo específicos para concessionárias do Canadá e dos EUA.

👉 Se puder, use os seguintes números de revendedor:

EUA: 0000690095

Canadá: 0000691690

ID	Teste	Resultado Esperado
1	Solicitar as promoções com base em um número de série (VIN) e usando o REC_01 usage_code. EUA: RLVDGF114NVN00631 Canadá:3JBUJAX51MK000001	As promoções são recuperadas e exibidas.
2	Solicitar as promoções com base em um número de modelo e usando o REC_01 usage_code. EUA: 0006RMB00 Canadá:0002WNA00	As promoções são recuperadas e exibidas.
3	Solicitar as promoções com base em um número de série (VIN) com o REC_01 usage_code e usando uma data de registro de 1º de janeiro de 2023. EUA: RLVDGF114NVN00631 Canadá:3JBUJAX51MK000001	As promoções são recuperadas e exibidas.
4	Solicitar as promoções para o número de modelo 00029RA00, que não possui promoções.	É exibida uma mensagem indicando que não há promoção.

Piloto de Concessionária

A tabela abaixo descreve os parâmetros e validações do piloto de concessionária.

Parâmetro	Valor
Ambiente	Produção
Número de concessionárias	1 a 3
Duração	2 semanas
Validação 1	A equipe DCP valida que a API de Promoções é chamada.
Validação 2	O DSP fornece capturas de tela de 5 promoções de cada concessionária.

Postman

Esta seção descreve o que está disponível no Postman para explorar a API.

Ambientes

Um ambiente Postman está disponível para testar a API de Promoções. Esse ambiente Postman contém variáveis usadas pelas consultas e configuradas para conectar ao ambiente de teste.

Teste - Ambiente DSP

Coleções

A coleção DSP - Promoções contém exemplos de chamadas de API para recuperar promoções disponíveis.

DSP - Promoções

Registro de alterações

Revisão 1.0

Added

Primeiro lançamento