API de Promociones

45 min

Comenzando

La API de Promociones permite al distribuidor obtener las promociones disponibles para una unidad por su número de serie (VIN) o número de modelo.

👉 En la versión actual, solo las promociones de la unidad están disponibles. En una versión futura de la API, deberían estar disponibles las promociones de PA&A.

Las promociones disponibles para un modelo de unidad están documentadas mediante boletines de promoción que contienen una o más promociones.

¿Dónde empezar? ¡Léeme primero!

Antes de comenzar a trabajar en esta API, debes leer las siguientes secciones si aún no las has revisado:

¡Comienza aquí con la lectura obligatoria!
Información Técnica para información técnica general sobre la API y los entornos.
Autenticación y Credenciales para obtener detalles sobre autenticación y credenciales.
Proceso de Certificación para obtener detalles sobre el proceso de certificación y Jira.
Obteniendo Apoyo para obtener detalles sobre cómo recibir ayuda y Jira.

Resumen empresarial

Tema	Descripción
Alcance	Unidad en Norteamérica en DMS y CRM
Escenarios	Pedido de unidad en DMS: obtener promociones disponibles mientras se prepara una cotización de venta para un cliente CRM: encontrar promociones disponibles mientras se responde a un cliente potencial
Funcionalidades principales	Proporcionar promociones disponibles para una unidad Proporcionar promociones disponibles para un modelo
Procesos empresariales soportados	Ventas de unidades Cliente potencial
Beneficios para concesionarios	Encontrar rápidamente las promociones disponibles Ayudar a las ventas de unidades
Beneficios para BRP	Ayudar a las ventas de unidades

Información técnica

Características

Tipo de API	Tipo de DSP	Versión de DCP	Complejidad
Obtener datos de BRP	DMS	V3 - Internacional	Bajo
Enviar datos a BRP	CRM	V4 - Norteamérica	Un poco más
Transacción con BRP			Algo más

Autenticación

La API está usando Autenticación de Aplicaciones.

Necesitas un token de acceso válido antes de llamar a esta API o tienes que llamar a la API de Autenticación de Aplicaciones para obtener uno.

¡El token de acceso es válido por 30 minutos! (1799 segundos)

URL base

Prueba	https://qa-cloud-api.brp.com/dcp/v4
Producción	https://cloud-api.brp.com/dcp/v4

Recurso: Promociones

Cuando se llama para solicitar las promociones de un número de serie (VIN) o un número de modelo, la API de Promociones devuelve un recurso de Promociones .

Representación 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"
                        }
                    ]
                }
            ]
        }
    ]
},

Propiedades

Property	Type	Definition	Note
model_number	string	Code that uniquely identifies a unit model.	Length: 9
model_name	string	The model description.
bulletins	List of objects	List of bulletins.
bulletins.bulletin_code	string	Bulletin number.	Max Length: 15
bulletin.bulletin_description	string	Bulletin description.
bulletins.date_until_reserved	datetime	Promotion start date, in ISO 8601 format.	Format: YYYY-MM-DDTHH:MM:SSZ
bulletins.date_until_consumed	datetime	Promotion end date, in ISO 8601 format.	Format: YYYY-MM-DDTHH:MM:SSZ
bulletins.is_stackable	boolean	Indicates if the promotion types are stackable (AND) or not stackable (OR). In the first case, the dealer can select more than one promotion bulletin.
bulletins.is_pre_order	boolean	Indicates if the promotion is applicable for pre-order.
bulletins.promotions	List of objects	List of promotions.
bulletins .promotions .promotion_category	string	Promotion category, one of the following values: Certificate PIN Code Authorization Code Immediate	Max Length: 18
bulletins .promotions .promotion_deposit_amount	string	Amount of the deposit required to reserve a promotion.
Bulletins .promotions .promotion_code	string	Promotion code (agreement code).	Max Length: 10
bulletins .promotions .promotion_types	List of object	List of promotion types.
bulletins .promotions .promotion_types .promotion_type	string	Promotion type. One of the values from the Promotion Types table below.	Max Length: 2
bulletins .promotions .promotion_types .component_description	string	Component description.
bulletins .promotions .promotion_types .benefit_promotion_code	string	Benefit promotion code.	Max Length: 18

Tipos de promociones

Código	Descripción
01	Reembolso en efectivo
02	Cobertura extendida
03	Financiación minorista
04	Reembolso en efectivo y cobertura extendida
05	Reembolso en efectivo y financiación minorista
06	Cobertura extendida y financiación minorista
07	Reembolso en efectivo y cobertura y financiación minorista
08	Efectivo en lugar de actualizaciones
09	Efectivo en lugar de accesorios y vestimenta
10	Monto del depósito
11	SPIFF (incentivos o bonificaciones de ventas a corto plazo)
12	Efectivo en lugar de actualizaciones y cobertura extendida
13	Efectivo en lugar de accesorios y vestimenta + cobertura extendida
14	Demostración

Limitaciones y restricciones

Promociones para la Unidad

En esta versión, la API de Promociones devuelve solo las promociones relacionadas con las ventas por unidad.

Comprender las promociones

Esta sección proporciona más información sobre la estructura de las promociones y cómo se muestran en BOSSWeb.

👉 Ten en cuenta que las promociones son específicas del concesionario y cambian con el tiempo.

Son específicas del concesionario porque una promoción puede ser válida solo para regiones específicas, por ejemplo, la costa oeste de EE. UU.

Boletines de Promoción

La información devuelta por la API de Promociones es una lista deresúmenesde promociones documentadas en los boletines de promoción. La API de Promociones no devuelve la documentación completa de la promoción: el concesionario debe ir a BOSSWeb para recuperar los documentos de la promoción según sea necesario.

👉Los concesionarios saben cómo usar la información devuelta por la API de Promociones ya que es la misma que se muestra en BOSSWeb.

Más de un boletín de promoción puede estar activo al mismo tiempo para un número de modelo. En algunos casos, el concesionario puede seleccionar más de un boletín de promoción según lo controla la propiedadis_stackable .

Un boletín de promoción contiene una o más promociones. Cuando hay más de una promoción en un boletín, el concesionario debe seleccionar una de ellas.

Escenarios de Promociones

Esta sección presenta diferentes escenarios de promoción. Para cada uno, se muestra la carga JSON de la API de Promociones con la visualización correspondiente en BOSSWeb.

Su DSP debería tener una pantalla similar a la mostrada en las capturas de pantalla de BOSSWeb para visualizar las promociones.

👉 Los ejemplos fueron realizados para el concesionario 0000694307 el 5 de julio de 2024, en el entorno de producción.

Si llama a la API de Promociones cuando lea esto, obtendrá una lista diferente de promociones.

Un boletín con una promoción

El payload a continuación muestra las promociones para el modelo 0003CNA00. Solo hay un boletín que contiene una promoción.

{
    "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": ""
                        }
                    ]
                }
            ]
        }
    ]
}

La visualización de BOSSWeb es la siguiente.

Dos boletines con una promoción

El payload para el modelo 0002WNA00 contiene 2 boletines y cada uno contiene una promoción.

Todos los boletines de promoción tienen la propiedad is_stackable establecida en true, lo que significa que el distribuidor puede seleccionar una promoción de todos los boletines de promoción, como se muestra con el AND entre los boletines de promoción en la pantalla de 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": ""
                        }
                    ]
                }
            ]
        }
    ]
}

La pantalla de BOSSWeb muestra que el concesionario puede seleccionar las 2 promociones ya que hay un AND entre los 2 boletines.

Múltiples Boletines con Múltiples Promociones

La carga útil para el modelo 000G1RA00 muestra que el concesionario puede seleccionar promociones de los 3 boletines ya que la propiedad is_stackable está configurada en true.

El concesionario puede seleccionar:

Una promoción del Compensación de Apple CarPlay boletín.

La promoción del RECOMPENSA B.E.S.T. PARA EL VENDEDOR (SPIFF) boletín.

Una promoción del Experiencia Can-Am (Paradas Corporativas) boletín.

{
    "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": ""
                        }
                    ]
                }
            ]
        }
    ]
}

La pantalla de BOSSWeb es así. Observe el Y entre los boletines y el O entre las promociones en el primer y el último boletín.

Boletines no apilables

La carga útil para el modelo 000MXSD00 muestra un ejemplo de boletines no apilables ya que la es_apilable propiedad está establecida en falso.

Esto significa que el concesionario debe seleccionar ya sea una promoción del primer boletín (SNO MY25 TEST) o una promoción del último boletín (B.E.S.T. RECOMPENSA PARA EL VENDEDOR (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": ""
                        }
                    ]
                }
            ]
        }
    ]
}

La pantalla de BOSSWeb muestra un OR entre los boletines, lo que significa que no son acumulables.

Promociones con VIN

La API de Promociones ofrece un servicio para obtener las promociones de un VIN. La carga devuelta funciona exactamente igual que las llamadas con un número de modelo.

Por ejemplo, esta llamada:

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'

Devuelve la siguiente carga útil:

{
    "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": ""
                        }
                    ]
                }
            ]
        }
    ]
}

Y la visualización de BOSSWeb es así:

Referencia de la API

Get Promotions for a VIN

Get the promotions using a unit VIN (serial number).

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'

Get Promotions for a Model Number or VIN

Get the promotions using a unit model number or a unit serial number. Only one of the parameters model_no and serial_no can be provided.

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	Descripción
REC_01	Recreativo/Personal
DE_01	Demostración
LE_01	Arrendamiento
LO_01	Préstamo
GOV_01	Gobierno
REN_01	Alquiler
COM_01	Comercial
AG_01	Agrícola
PS_01	Pro-Staff
FR_01	Registro Forzoso
CSG_01	Consignación
RA_01	Carreras
SL/LS_01	Préstamo Escolar LS 365 Días Condiciones de Financiamiento
SL/LT_01	Préstamo Escolar LT 465 Días Condiciones de Financiamiento
MI_01	Militar
NC_01	Sin Cargo

Cómo hacer

Esta sección proporciona información sobre cómo obtener resultados específicos con la API.

Obtener promociones para un VIN

Obtén las promociones disponibles usando el VIN de una unidad y para uso comercial. Esta llamada puede utilizarse cuando un concesionario desea obtener las promociones disponibles mientras prepara una cotización de venta para un 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'

Obtener promociones para un número de modelo

Obtenga las promociones disponibles para un número de modelo. La llamada permite al distribuidor ver las promociones para un modelo de unidad en su inventario.

Tenga en cuenta que el parámetro registration_date se utiliza en esta llamada para ver todas las promociones disponibles después del 1 de noviembre de 2023. Este tipo de llamada podría devolver promociones vencidas, por lo que es importante mostrar los campos date_until_reserved y date_until_consumed.

Obtener promociones para un 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'

Manejo de errores

Esta sección presenta varios escenarios de llamadas incorrectas o inapropiadas, que resultan en mensajes de error y resultados incorrectos.

400 Solicitud incorrecta

El código de estado 400 generalmente se observa durante el desarrollo y la integración y no debería recibirse durante las operaciones normales. La respuesta devuelta contiene la información necesaria para corregir el problema.

Muchos problemas pueden causar un código de estado 400; los más comunes se enumeran en la tabla a continuación.

Respuesta	Resolución
Se devuelve si el parámetro de cabecera Dealer-Number falta. { "status": "400", "id": "rrt-074faba1d0796ac77-c-ea-24396-616154-1", "title": "solicitud_incorrecta", "meta": { "service": "01", "detail": "la validación de la solicitud falló", "payload": { "details": [ { "message": "El parámetro de cabecera 'Dealer-Number' es obligatorio en la ruta '/invoices' pero no se encontró en la solicitud." } ] } } }	Actualice su llamada a la API para añadir el parámetro Dealer-Number en la cabecera.
Se devuelve si faltan el número de modelo y el número de serie en la consulta. { "status": "400", "id": "rrt-023ba21d3844ea361-c-ea-22598-2461748-1.1", "title": "solicitud_incorrecta", "meta": { "service": "98", "detail": "No se proporcionó número de modelo ni número de serie. Debe proporcionarse uno de los dos: model_no o serial_no." } }	Asegúrese de incluir un número de modelo o un número de serie (VIN) en la ruta de la consulta.
Se devuelve si se proporcionan el número de modelo y el número de serie (VIN). { "status": "400", "id": "rrt-08b132083d72c98ab-b-ea-26817-2169562-1.1", "title": "solicitud_incorrecta", "meta": { "service": "98", "detail": "Se proporcionaron un número de modelo y un número de serie. Solo uno de model_no o serial_no puede proporcionarse a la vez." } }	Proporcione solo el número de modelo o el número de serie.
Se devuelve si el número de modelo no es válido. { "status": "400", "id": "rrt-0d1e94b23f6aa0176-d-ea-28384-5536739-1.1", "title": "solicitud_incorrecta", "meta": { "service": "15", "detail": "Número de modelo no válido: 000AAA00" } }	El distribuidor puede haber cometido un error al ingresar el número de modelo. Debe informar el error al usuario para que lo intente de nuevo.
Se devuelve si el número de serie (VIN) no es válido. { "status": "400", "id": "rrt-08b132083d72c98ab-b-ea-26817-2169562-1.1", "title": "solicitud_incorrecta", "meta": { "service": "98", "detail": "VIN no válido 2BPSABNA3NV000000" } }	El distribuidor puede haber ingresado por error el número de serie (VIN). Debe informar el error al usuario para que pueda intentarlo de nuevo.
Se devuelve si el número de distribuidor no es válido. { "status": "400", "id": "rrt-0d1e94b23f6aa0176-d-ea-28384-5536117-1.1", "title": "solicitud_incorrecta", "meta": { "service": "06", "detail": "Número de distribuidor no válido :0000123456" } }	Si el distribuidor está usando su DMS, puede que ya no sea un distribuidor BRP. Verifíquelo con ellos y desactive las actualizaciones de inventario de repuestos. Asegúrese de que el número de distribuidor tenga 10 caracteres. Si guarda el número sin los '0' iniciales, añádalos antes de llamar a la API. El error también se devuelve si el distribuidor no es un distribuidor BRP activo.

401 No autorizado

El código de estado de error 401 Unauthorized se devuelve cuando intentas llamar a la API con un access_token expirado.

Debes obtener un nuevo access_token haciendo una llamada a la API de Autenticación de Aplicaciones.

El código de estado de error 401 Unauthorized también se devuelve si no solicitaste acceso a la API creando un ticket en el DCP Jira.

Cuando estés listo para comenzar a trabajar en una API, debes crear un ticket de certificación en Jira, como se describe en la sección Actividades de Certificación con Jira.

Si ya comenzaste a trabajar en una API y perdiste el acceso, crea un ticket de soporte como se describe en la sección Abrir un Ticket de Soporte.

404 No Encontrado

El código de estado 404 Not Found se devuelve cuando no hay promociones disponibles para el número de modelo o número de serie (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 Funcionales

ID	Tipo	Requisito
1	Obligatorio	El concesionario debe poder recuperar las promociones de una unidad utilizando el VIN.
2	Obligatorio	El concesionario debe poder recuperar las promociones de una unidad utilizando el número de modelo.
3	Obligatorio	Si no se encuentra ninguna, el DSP debe mostrar las promociones recuperadas o un mensaje.
4	Obligatorio	El DSP debe mostrar las promociones en una pantalla similar a la mostrada en la sección Visualización de Promociones.

Actividades de Certificación

Esta sección presenta todas las actividades de certificación y validaciones que deben completarse para certificar la API.

Aseguramiento de la calidad

Las pruebas enumeradas en la tabla a continuación deben realizarse correctamente en el entorno de prueba antes de que pueda comenzar la fase piloto del concesionario.

👉 Para las pruebas, dado que el número de promociones en el entorno de prueba es limitado, debe utilizar VIN y números de modelo específicos para los concesionarios de Canadá y Estados Unidos.

👉 Si puedes, usa los siguientes números de distribuidor:

EE. UU.: 0000690095

Canadá: 0000691690

ID	Prueba	Resultado Esperado
1	Solicitar las promociones basadas en un número de serie (VIN) y usando el REC_01 usage_code. EE. UU.: RLVDGF114NVN00631 Canadá:3JBUJAX51MK000001	Las promociones se recuperan y se muestran.
2	Solicitar las promociones basadas en un número de modelo y usando el REC_01 usage_code. EE. UU.: 0006RMB00 Canadá:0002WNA00	Las promociones se recuperan y se muestran.
3	Solicitar las promociones basadas en un número de serie (VIN) con el REC_01 usage_code y usando una fecha de registro del 1 de enero de 2023. EE. UU.: RLVDGF114NVN00631 Canadá:3JBUJAX51MK000001	Las promociones se recuperan y se muestran.
4	Solicitar las promociones para el número de modelo 00029RA00, que no tiene promociones.	Se muestra un mensaje indicando que no hay promoción.

Piloto de Distribuidores

La siguiente tabla describe los parámetros y validaciones del piloto de distribuidores.

Parámetro	Valor
Entorno	Producción
Número de distribuidores	1 a 3
Duración	2 semanas
Validación 1	El equipo DCP valida que se llame a la API de Promociones.
Validación 2	El DSP proporciona capturas de pantalla de 5 promociones de cada distribuidor.

Postman

Esta sección describe lo que está disponible en Postman para explorar la API.

Entornos

Un entorno de Postman está disponible para probar la API de Promociones. Este entorno de Postman contiene variables utilizadas por las consultas y configuradas para conectarse al entorno de prueba.

Prueba - Entorno DSP

Colecciones

La colección DSP - Promociones contiene ejemplos de llamadas API para recuperar las promociones disponibles.

DSP - Promociones

Registro de Cambios

Revisión 1.0

Added

Primera versión