Oportunidades de ventas de Elead (versión preliminar)
La API de oportunidades de ventas de Elead busca y recupera información de oportunidades de ventas existente en Elead CRM. La información de la oportunidad incluye detalles relacionados con el equipo de ventas, la fuente, el vehículo de interés y la información comercial de vehículos. Esta API incluye las siguientes funcionalidades y características para administrar información relacionada con las oportunidades.
Este conector está disponible en los siguientes productos y regiones:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Aplicaciones lógicas | Estándar | Todas las regiones de Logic Apps excepto las siguientes: - Regiones de Azure Government - Regiones de Azure China - Departamento de Defensa de EE. UU. (DoD) |
| Power Apps | Premium | Todas las regiones de Power Apps excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Power Automate | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Contacto | |
|---|---|
| Nombre | CDK Global |
| URL | https://serviceconnect.support.cdk.com |
| Correo Electrónico | mbd_support@cdk.com |
| Metadatos del conector | |
|---|---|
| Publicador | CDK Global |
| Sitio web | https://fortellis.io |
| Directiva de privacidad | https://fortellis.io/privacy |
| Categorías | Data |
¿Qué hace esta API?
Esta API busca y recupera la información de oportunidad de ventas existente en Elead CRM. La información de la oportunidad incluye detalles relacionados con el equipo de ventas, la fuente, el vehículo de interés y la información comercial de vehículos.
Audiencia prevista
Esta API es para distribuidores y asociados de proveedores que administran oportunidades y correos electrónicos relacionados con oportunidades.
Funcionalidades y características
Esta API incluye las siguientes funcionalidades y características para administrar información relacionada con las oportunidades.
- Buscar y recuperar oportunidades enviadas previamente en todos los orígenes
- Consultar clientes potenciales por identificador de cliente, intervalos de fechas o por fecha y hora
- Recuperación de una oportunidad por Elead Id
- Creación de nuevas oportunidades para los registros de clientes existentes
- Agregar un comentario a una oportunidad
- Agregar, editar y eliminar vehículos de interés y registros comerciales de vehículos
- Reasignar al vendedor principal del equipo
- Reasignar el agente de BDC principal en el equipo
- Enviar un correo electrónico en nombre del distribuidor o del asociado del proveedor
- Agregar un vendedor a un equipo de ventas de oportunidades
- Eliminación de un vendedor de un equipo de ventas de oportunidades
- Actualizar subestado de oportunidad
- Incorporación, eliminación y recuperación de pasos de ventas de oportunidades
Requisitos previos
Necesitará lo siguiente para continuar.
- Para usar el conector, debe ser un usuario de Fortellis.
- Debe crear una solución en Fortellis para generar el identificador de cliente y el secreto que se usarán al llamar a las API.
Puede encontrar documentación detallada en
https://apidocs.fortellis.io/specs/3c6d6b40-7215-4a81-a087-4f956bb36ec9
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 100 | 60 segundos |
Acciones
| Adición del intercambio a la oportunidad |
Agrega un intercambio a la oportunidad especificada |
| Agregar comentario a la oportunidad |
Agrega un comentario a la oportunidad especificada. |
| Agregar vehículo buscado a la oportunidad |
Agrega un vehículo buscado a la oportunidad especificada |
| Agregar vendedor a la oportunidad |
Agrega un vendedor a la oportunidad especificada. |
| Consulta de oportunidades de ventas por intervalo de fechas |
Recuperación de oportunidades de ventas por intervalo de fechas |
| Consultar oportunidades de ventas desde la fecha y hora proporcionadas |
Recuperar oportunidades de ventas por la fecha y hora proporcionadas (en los últimos 7 días) |
| Creación de una nueva oportunidad |
Crea una nueva oportunidad |
| Eliminación del intercambio de oportunidades |
Quita el intercambio especificado de la oportunidad. |
| Eliminación del vendedor de la oportunidad |
Quita un vendedor de la oportunidad especificada. |
| Enviar un correo electrónico y crear la actividad correspondiente |
Envía un correo electrónico y crea la actividad correspondiente. |
| Quitar vehículo buscado de la oportunidad |
Quita el vehículo especificado buscado de la oportunidad |
| Reasignar al vendedor principal para la oportunidad especificada |
Reasigna el vendedor principal para la oportunidad especificada |
| Reasignar el agente bdc principal para la oportunidad especificada |
Reasigna el agente bdc principal para la oportunidad especificada |
Adición del intercambio a la oportunidad
Agrega un intercambio a la oportunidad especificada
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de cliente
|
client_id | True | string |
Identificador de cliente que debe ser único para el desarrollador o proveedor de soluciones que compila la solución. |
|
Secreto del cliente
|
client_secret | True | string |
Secreto de cliente que debe ser único para el desarrollador o proveedor de soluciones que compila la solución. |
|
Id. de suscripción
|
subscription_id | True | string |
Identificador de correlación que se debe devolver al autor de la llamada para indicar el retorno de la solicitud especificada. |
|
Aceptar
|
Accept | string |
Aceptar encabezado |
|
|
Accept-Charset
|
Accept-Charset | string |
Encabezado de Accept-Charset |
|
|
Accept-Encoding
|
Accept-Encoding | string |
Encabezado de Accept-Encoding |
|
|
Accept-Language
|
Accept-Language | string |
Encabezado de Accept-Language |
|
|
If-Match
|
If-Match | string |
Encabezado de If-Match |
|
|
If-None-Match
|
If-None-Match | string |
Encabezado if-None-Match |
|
|
Preferir
|
Prefer | string |
Preferencia del cliente |
|
|
Id. de solicitud
|
Request-Id | True | string |
Formato: guid. Identificador de correlación que se debe devolver al autor de la llamada para indicar el retorno de la solicitud dada. |
|
opportunityId
|
opportunityId | True | uuid |
Identificador único de la oportunidad |
|
año
|
year | integer |
Año de este comercio de vehículos |
|
|
hacer
|
make | string |
Make of this vehicle trade-in |
|
|
model
|
model | string |
Modelo de este comercio de vehículos |
|
|
trim
|
trim | string |
Recorte del comercio de este vehículo |
|
|
Vin
|
vin | string |
VIN de este vehículo comercial |
|
|
estimatedMileage
|
estimatedMileage | integer |
Kilometraje estimado de este vehículo |
|
|
interiorColor
|
interiorColor | string |
Color interior del comercio de este vehículo |
|
|
exteriorColor
|
exteriorColor | string |
Color exterior de este vehículo comercial |
Devoluciones
Agregar comentario a la oportunidad
Agrega un comentario a la oportunidad especificada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de cliente
|
client_id | True | string |
Identificador de cliente que debe ser único para el desarrollador o proveedor de soluciones que compila la solución. |
|
Secreto del cliente
|
client_secret | True | string |
Secreto de cliente que debe ser único para el desarrollador o proveedor de soluciones que compila la solución. |
|
Id. de suscripción
|
subscription_id | True | string |
Identificador de correlación que se debe devolver al autor de la llamada para indicar el retorno de la solicitud especificada. |
|
Aceptar
|
Accept | string |
Aceptar encabezado |
|
|
Accept-Charset
|
Accept-Charset | string |
Encabezado de Accept-Charset |
|
|
Accept-Encoding
|
Accept-Encoding | string |
Encabezado de Accept-Encoding |
|
|
Accept-Language
|
Accept-Language | string |
Encabezado de Accept-Language |
|
|
If-Match
|
If-Match | string |
Encabezado de If-Match |
|
|
If-None-Match
|
If-None-Match | string |
Encabezado if-None-Match |
|
|
Preferir
|
Prefer | string |
Preferencia del cliente |
|
|
Id. de solicitud
|
Request-Id | True | string |
Formato: guid. Identificador de correlación que se debe devolver al autor de la llamada para indicar el retorno de la solicitud dada. |
|
opportunityId
|
opportunityId | True | uuid |
Identificador único de la oportunidad |
|
comentario
|
comment | True | string |
Comentarios que se van a agregar a la oportunidad especificada |
Agregar vehículo buscado a la oportunidad
Agrega un vehículo buscado a la oportunidad especificada
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de cliente
|
client_id | True | string |
Identificador de cliente que debe ser único para el desarrollador o proveedor de soluciones que compila la solución. |
|
Secreto del cliente
|
client_secret | True | string |
Secreto de cliente que debe ser único para el desarrollador o proveedor de soluciones que compila la solución. |
|
Id. de suscripción
|
subscription_id | True | string |
Identificador de correlación que se debe devolver al autor de la llamada para indicar el retorno de la solicitud especificada. |
|
Aceptar
|
Accept | string |
Aceptar encabezado |
|
|
Accept-Charset
|
Accept-Charset | string |
Encabezado de Accept-Charset |
|
|
Accept-Encoding
|
Accept-Encoding | string |
Encabezado de Accept-Encoding |
|
|
Accept-Language
|
Accept-Language | string |
Encabezado de Accept-Language |
|
|
If-Match
|
If-Match | string |
Encabezado de If-Match |
|
|
If-None-Match
|
If-None-Match | string |
Encabezado if-None-Match |
|
|
Preferir
|
Prefer | string |
Preferencia del cliente |
|
|
Id. de solicitud
|
Request-Id | True | string |
Formato: guid. Identificador de correlación que se debe devolver al autor de la llamada para indicar el retorno de la solicitud dada. |
|
opportunityId
|
opportunityId | True | uuid |
Identificador de oportunidad único |
|
isNew
|
isNew | True | boolean |
true/false si el vehículo buscado es nuevo |
|
yearFrom
|
yearFrom | integer |
Rango de año inicial para este vehículo buscado |
|
|
yearTo
|
yearTo | integer |
Gama final del año para este vehículo buscado |
|
|
hacer
|
make | string |
Marca del vehículo buscado |
|
|
model
|
model | string |
Modelo del vehículo buscado |
|
|
trim
|
trim | string |
Recorte del vehículo buscado |
|
|
Vin
|
vin | string |
VIN del vehículo buscado |
|
|
priceFrom
|
priceFrom | double |
Rango de precios inicial del vehículo buscado |
|
|
priceTo
|
priceTo | double |
Gama de precios finales del vehículo buscado |
|
|
maxMileage
|
maxMileage | integer |
Kilometraje máximo del vehículo buscado |
|
|
stockNumber
|
stockNumber | string |
Número de existencias del vehículo buscado |
|
|
isPrimario
|
isPrimary | True | boolean |
true/false si este vehículo buscado es el principal para la oportunidad especificada. |
Devoluciones
Agregar vendedor a la oportunidad
Agrega un vendedor a la oportunidad especificada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de oportunidad
|
opportunityId | True | string |
Formato: uuid. |
|
Identificador de cliente
|
client_id | True | string |
Identificador de cliente que debe ser único para el desarrollador o proveedor de soluciones que compila la solución. |
|
Secreto del cliente
|
client_secret | True | string |
Secreto de cliente que debe ser único para el desarrollador o proveedor de soluciones que compila la solución. |
|
Id. de suscripción
|
subscription_id | True | string |
Identificador de correlación que se debe devolver al autor de la llamada para indicar el retorno de la solicitud especificada. |
|
Aceptar
|
Accept | string |
Aceptar encabezado |
|
|
Accept-Charset
|
Accept-Charset | string |
Encabezado de Accept-Charset |
|
|
Accept-Encoding
|
Accept-Encoding | string |
Encabezado de Accept-Encoding |
|
|
Accept-Language
|
Accept-Language | string |
Encabezado de Accept-Language |
|
|
If-Match
|
If-Match | string |
Encabezado de If-Match |
|
|
If-None-Match
|
If-None-Match | string |
Encabezado if-None-Match |
|
|
Preferir
|
Prefer | string |
Preferencia del cliente |
|
|
Id. de solicitud
|
Request-Id | True | string |
Formato: guid. Identificador de correlación que se debe devolver al autor de la llamada para indicar el retorno de la solicitud dada. |
|
id
|
id | True | uuid |
Identificador único de este vendedor |
|
isPrimario
|
isPrimary | True | boolean |
true/false si se trata del vendedor principal para la oportunidad dada |
|
isPositionPrimary
|
isPositionPrimary | True | boolean |
true/false si se trata del vendedor principal para esta posición en la oportunidad dada |
|
positionCode
|
positionCode | True | string |
Colocación de código para este vendedor en la oportunidad dada |
Devoluciones
- Body
- Salesperson
Consulta de oportunidades de ventas por intervalo de fechas
Recuperación de oportunidades de ventas por intervalo de fechas
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
Formato: int32. |
|
|
Tamaño de página
|
pageSize | integer |
Formato: int32. |
|
|
Fecha a partir de
|
dateFrom | string |
Formato: fecha y hora (como fecha y hora en RFC3339). |
|
|
Fecha a
|
dateTo | string |
Formato: fecha y hora (como fecha y hora en RFC3339). |
|
|
Identificador de cliente
|
client_id | True | string |
Identificador de cliente que debe ser único para el desarrollador o proveedor de soluciones que compila la solución. |
|
Secreto del cliente
|
client_secret | True | string |
Secreto de cliente que debe ser único para el desarrollador o proveedor de soluciones que compila la solución. |
|
Id. de suscripción
|
subscription_id | True | string |
Identificador de correlación que se debe devolver al autor de la llamada para indicar el retorno de la solicitud especificada. |
|
Aceptar
|
Accept | string |
Aceptar encabezado |
|
|
Accept-Charset
|
Accept-Charset | string |
Encabezado de Accept-Charset |
|
|
Accept-Encoding
|
Accept-Encoding | string |
Encabezado de Accept-Encoding |
|
|
Accept-Language
|
Accept-Language | string |
Encabezado de Accept-Language |
|
|
If-Match
|
If-Match | string |
Encabezado de If-Match |
|
|
If-None-Match
|
If-None-Match | string |
Encabezado if-None-Match |
|
|
Preferir
|
Prefer | string |
Preferencia del cliente |
|
|
Id. de solicitud
|
Request-Id | True | string |
Formato: guid. Identificador de correlación que se debe devolver al autor de la llamada para indicar el retorno de la solicitud dada. |
Devoluciones
Consultar oportunidades de ventas desde la fecha y hora proporcionadas
Recuperar oportunidades de ventas por la fecha y hora proporcionadas (en los últimos 7 días)
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
Formato: int32. |
|
|
Tamaño de página
|
pageSize | integer |
Formato: int32. |
|
|
Fecha a partir de
|
dateFrom | string |
Formato: fecha y hora (como fecha y hora en RFC3339). |
|
|
Identificador de cliente
|
client_id | True | string |
Identificador de cliente que debe ser único para el desarrollador o proveedor de soluciones que compila la solución. |
|
Secreto del cliente
|
client_secret | True | string |
Secreto de cliente que debe ser único para el desarrollador o proveedor de soluciones que compila la solución. |
|
Id. de suscripción
|
subscription_id | True | string |
Identificador de correlación que se debe devolver al autor de la llamada para indicar el retorno de la solicitud especificada. |
|
Aceptar
|
Accept | string |
Aceptar encabezado |
|
|
Accept-Charset
|
Accept-Charset | string |
Encabezado de Accept-Charset |
|
|
Accept-Encoding
|
Accept-Encoding | string |
Encabezado de Accept-Encoding |
|
|
Accept-Language
|
Accept-Language | string |
Encabezado de Accept-Language |
|
|
If-Match
|
If-Match | string |
Encabezado de If-Match |
|
|
If-None-Match
|
If-None-Match | string |
Encabezado if-None-Match |
|
|
Preferir
|
Prefer | string |
Preferencia del cliente |
|
|
Id. de solicitud
|
Request-Id | True | string |
Formato: guid. Identificador de correlación que se debe devolver al autor de la llamada para indicar el retorno de la solicitud dada. |
Devoluciones
Creación de una nueva oportunidad
Crea una nueva oportunidad
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de cliente
|
client_id | True | string |
Identificador de cliente que debe ser único para el desarrollador o proveedor de soluciones que compila la solución. |
|
Secreto del cliente
|
client_secret | True | string |
Secreto de cliente que debe ser único para el desarrollador o proveedor de soluciones que compila la solución. |
|
Id. de suscripción
|
subscription_id | True | string |
Identificador de correlación que se debe devolver al autor de la llamada para indicar el retorno de la solicitud especificada. |
|
Aceptar
|
Accept | string |
Aceptar encabezado |
|
|
Accept-Charset
|
Accept-Charset | string |
Encabezado de Accept-Charset |
|
|
Accept-Encoding
|
Accept-Encoding | string |
Encabezado de Accept-Encoding |
|
|
Accept-Language
|
Accept-Language | string |
Encabezado de Accept-Language |
|
|
If-Match
|
If-Match | string |
Encabezado de If-Match |
|
|
If-None-Match
|
If-None-Match | string |
Encabezado if-None-Match |
|
|
Preferir
|
Prefer | string |
Preferencia del cliente |
|
|
Id. de solicitud
|
Request-Id | True | string |
Formato: guid. Identificador de correlación que se debe devolver al autor de la llamada para indicar el retorno de la solicitud dada. |
|
customerId
|
customerId | True | uuid |
Identificador único del cliente |
|
dateIn
|
dateIn | date-time |
Fecha y hora en que llegó la oportunidad |
|
|
source
|
source | True | string |
Nombre de origen para esta oportunidad |
|
subSource
|
subSource | string |
Nombre de subrecurso para esta oportunidad |
|
|
estado
|
status | string |
Estado actual de esta oportunidad |
|
|
subStatus
|
subStatus | string |
Subestado de esta oportunidad |
|
|
upType
|
upType | True | string |
Tipo de actualización para esta oportunidad |
|
comments
|
comments | string | ||
|
isNew
|
isNew | True | boolean |
true/false si el vehículo buscado es nuevo |
|
yearFrom
|
yearFrom | integer |
Rango de año inicial para este vehículo buscado |
|
|
yearTo
|
yearTo | integer |
Gama final del año para este vehículo buscado |
|
|
hacer
|
make | string |
Marca del vehículo buscado |
|
|
model
|
model | string |
Modelo del vehículo buscado |
|
|
trim
|
trim | string |
Recorte del vehículo buscado |
|
|
Vin
|
vin | string |
VIN del vehículo buscado |
|
|
priceFrom
|
priceFrom | double |
Rango de precios inicial del vehículo buscado |
|
|
priceTo
|
priceTo | double |
Gama de precios finales del vehículo buscado |
|
|
maxMileage
|
maxMileage | integer |
Kilometraje máximo del vehículo buscado |
|
|
stockNumber
|
stockNumber | string |
Número de existencias del vehículo buscado |
|
|
isPrimario
|
isPrimary | True | boolean |
true/false si este vehículo buscado es el principal para la oportunidad especificada. |
|
año
|
year | integer |
Año de este comercio de vehículos |
|
|
hacer
|
make | string |
Make of this vehicle trade-in |
|
|
model
|
model | string |
Modelo de este comercio de vehículos |
|
|
trim
|
trim | string |
Recorte del comercio de este vehículo |
|
|
Vin
|
vin | string |
VIN de este vehículo comercial |
|
|
estimatedMileage
|
estimatedMileage | integer |
Kilometraje estimado de este vehículo |
|
|
interiorColor
|
interiorColor | string |
Color interior del comercio de este vehículo |
|
|
exteriorColor
|
exteriorColor | string |
Color exterior de este vehículo comercial |
|
|
nombre
|
name | True | string |
Nombre del paso de ventas |
|
id
|
id | True | uuid |
Identificador único de este vendedor |
|
isPrimario
|
isPrimary | True | boolean |
true/false si se trata del vendedor principal para la oportunidad dada |
|
isPositionPrimary
|
isPositionPrimary | True | boolean |
true/false si se trata del vendedor principal para esta posición en la oportunidad dada |
|
positionCode
|
positionCode | True | string |
Colocación de código para este vendedor en la oportunidad dada |
Devoluciones
Eliminación del intercambio de oportunidades
Quita el intercambio especificado de la oportunidad.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
TradeIn Id
|
tradeInId | True | string |
Formato: uuid. |
|
Identificador de cliente
|
client_id | True | string |
Identificador de cliente que debe ser único para el desarrollador o proveedor de soluciones que compila la solución. |
|
Secreto del cliente
|
client_secret | True | string |
Secreto de cliente que debe ser único para el desarrollador o proveedor de soluciones que compila la solución. |
|
Id. de suscripción
|
subscription_id | True | string |
Identificador de correlación que se debe devolver al autor de la llamada para indicar el retorno de la solicitud especificada. |
|
Aceptar
|
Accept | string |
Aceptar encabezado |
|
|
Accept-Charset
|
Accept-Charset | string |
Encabezado de Accept-Charset |
|
|
Accept-Encoding
|
Accept-Encoding | string |
Encabezado de Accept-Encoding |
|
|
Accept-Language
|
Accept-Language | string |
Encabezado de Accept-Language |
|
|
If-Match
|
If-Match | string |
Encabezado de If-Match |
|
|
If-None-Match
|
If-None-Match | string |
Encabezado if-None-Match |
|
|
Preferir
|
Prefer | string |
Preferencia del cliente |
|
|
Id. de solicitud
|
Request-Id | True | string |
Formato: guid. Identificador de correlación que se debe devolver al autor de la llamada para indicar el retorno de la solicitud dada. |
Eliminación del vendedor de la oportunidad
Quita un vendedor de la oportunidad especificada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de oportunidad
|
opportunityId | True | string |
Formato: uuid. |
|
Identificador de cliente
|
client_id | True | string |
Identificador de cliente que debe ser único para el desarrollador o proveedor de soluciones que compila la solución. |
|
Secreto del cliente
|
client_secret | True | string |
Secreto de cliente que debe ser único para el desarrollador o proveedor de soluciones que compila la solución. |
|
Id. de suscripción
|
subscription_id | True | string |
Identificador de correlación que se debe devolver al autor de la llamada para indicar el retorno de la solicitud especificada. |
|
Aceptar
|
Accept | string |
Aceptar encabezado |
|
|
Accept-Charset
|
Accept-Charset | string |
Encabezado de Accept-Charset |
|
|
Accept-Encoding
|
Accept-Encoding | string |
Encabezado de Accept-Encoding |
|
|
Accept-Language
|
Accept-Language | string |
Encabezado de Accept-Language |
|
|
If-Match
|
If-Match | string |
Encabezado de If-Match |
|
|
If-None-Match
|
If-None-Match | string |
Encabezado if-None-Match |
|
|
Preferir
|
Prefer | string |
Preferencia del cliente |
|
|
Id. de solicitud
|
Request-Id | True | string |
Formato: guid. Identificador de correlación que se debe devolver al autor de la llamada para indicar el retorno de la solicitud dada. |
|
salespersonId
|
salespersonId | True | uuid |
Identificador único del vendedor |
|
positionCode
|
positionCode | True | string |
Colocación de código para este vendedor en la oportunidad dada |
Enviar un correo electrónico y crear la actividad correspondiente
Envía un correo electrónico y crea la actividad correspondiente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de cliente
|
client_id | True | string |
Identificador de cliente que debe ser único para el desarrollador o proveedor de soluciones que compila la solución. |
|
Secreto del cliente
|
client_secret | True | string |
Secreto de cliente que debe ser único para el desarrollador o proveedor de soluciones que compila la solución. |
|
Id. de suscripción
|
subscription_id | True | string |
Identificador de correlación que se debe devolver al autor de la llamada para indicar el retorno de la solicitud especificada. |
|
Aceptar
|
Accept | string |
Aceptar encabezado |
|
|
Accept-Charset
|
Accept-Charset | string |
Encabezado de Accept-Charset |
|
|
Accept-Encoding
|
Accept-Encoding | string |
Encabezado de Accept-Encoding |
|
|
Accept-Language
|
Accept-Language | string |
Encabezado de Accept-Language |
|
|
If-Match
|
If-Match | string |
Encabezado de If-Match |
|
|
If-None-Match
|
If-None-Match | string |
Encabezado if-None-Match |
|
|
Preferir
|
Prefer | string |
Preferencia del cliente |
|
|
Id. de solicitud
|
Request-Id | True | string |
Formato: guid. Identificador de correlación que se debe devolver al autor de la llamada para indicar el retorno de la solicitud dada. |
|
opportunityId
|
opportunityId | True | uuid |
Idenitifer único de la oportunidad |
|
desde
|
from | True | string |
Dirección de correo electrónico del remitente |
|
destinatarios
|
recipients | True | array of string |
Colección de direcciones de correo electrónico de destinatarios |
|
carbonCopies
|
carbonCopies | array of string |
Colección de direcciones de correo electrónico de copia de carbono |
|
|
Asunto
|
subject | True | string |
Asunto del correo electrónico |
|
body
|
body | True | string |
Cuerpo del correo electrónico |
|
isHtml
|
isHtml | True | boolean |
¿El cuerpo está en formato HTML? |
Devoluciones
- Body
- SendEmailResponse
Quitar vehículo buscado de la oportunidad
Quita el vehículo especificado buscado de la oportunidad
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Vehículo buscado id.
|
vehicleSoughtId | True | string |
Formato: uuid. |
|
Identificador de cliente
|
client_id | True | string |
Identificador de cliente que debe ser único para el desarrollador o proveedor de soluciones que compila la solución. |
|
Secreto del cliente
|
client_secret | True | string |
Secreto de cliente que debe ser único para el desarrollador o proveedor de soluciones que compila la solución. |
|
Id. de suscripción
|
subscription_id | True | string |
Identificador de correlación que se debe devolver al autor de la llamada para indicar el retorno de la solicitud especificada. |
|
Aceptar
|
Accept | string |
Aceptar encabezado |
|
|
Accept-Charset
|
Accept-Charset | string |
Encabezado de Accept-Charset |
|
|
Accept-Encoding
|
Accept-Encoding | string |
Encabezado de Accept-Encoding |
|
|
Accept-Language
|
Accept-Language | string |
Encabezado de Accept-Language |
|
|
If-Match
|
If-Match | string |
Encabezado de If-Match |
|
|
If-None-Match
|
If-None-Match | string |
Encabezado if-None-Match |
|
|
Preferir
|
Prefer | string |
Preferencia del cliente |
|
|
Id. de solicitud
|
Request-Id | True | string |
Formato: guid. Identificador de correlación que se debe devolver al autor de la llamada para indicar el retorno de la solicitud dada. |
Reasignar al vendedor principal para la oportunidad especificada
Reasigna el vendedor principal para la oportunidad especificada
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de cliente
|
client_id | True | string |
Identificador de cliente que debe ser único para el desarrollador o proveedor de soluciones que compila la solución. |
|
Secreto del cliente
|
client_secret | True | string |
Secreto de cliente que debe ser único para el desarrollador o proveedor de soluciones que compila la solución. |
|
Id. de suscripción
|
subscription_id | True | string |
Identificador de correlación que se debe devolver al autor de la llamada para indicar el retorno de la solicitud especificada. |
|
Aceptar
|
Accept | string |
Aceptar encabezado |
|
|
Accept-Charset
|
Accept-Charset | string |
Encabezado de Accept-Charset |
|
|
Accept-Encoding
|
Accept-Encoding | string |
Encabezado de Accept-Encoding |
|
|
Accept-Language
|
Accept-Language | string |
Encabezado de Accept-Language |
|
|
If-Match
|
If-Match | string |
Encabezado de If-Match |
|
|
If-None-Match
|
If-None-Match | string |
Encabezado if-None-Match |
|
|
Preferir
|
Prefer | string |
Preferencia del cliente |
|
|
Id. de solicitud
|
Request-Id | True | string |
Formato: guid. Identificador de correlación que se debe devolver al autor de la llamada para indicar el retorno de la solicitud dada. |
|
Reasignar solicitud de persona de ventas principal
|
reassignPrimarySalesPersonRequest |
reasignar el cuerpo de la solicitud de la persona de ventas principal |
Reasignar el agente bdc principal para la oportunidad especificada
Reasigna el agente bdc principal para la oportunidad especificada
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de cliente
|
client_id | True | string |
Identificador de cliente que debe ser único para el desarrollador o proveedor de soluciones que compila la solución. |
|
Secreto del cliente
|
client_secret | True | string |
Secreto de cliente que debe ser único para el desarrollador o proveedor de soluciones que compila la solución. |
|
Id. de suscripción
|
subscription_id | True | string |
Identificador de correlación que se debe devolver al autor de la llamada para indicar el retorno de la solicitud especificada. |
|
Aceptar
|
Accept | string |
Aceptar encabezado |
|
|
Accept-Charset
|
Accept-Charset | string |
Encabezado de Accept-Charset |
|
|
Accept-Encoding
|
Accept-Encoding | string |
Encabezado de Accept-Encoding |
|
|
Accept-Language
|
Accept-Language | string |
Encabezado de Accept-Language |
|
|
If-Match
|
If-Match | string |
Encabezado de If-Match |
|
|
If-None-Match
|
If-None-Match | string |
Encabezado if-None-Match |
|
|
Preferir
|
Prefer | string |
Preferencia del cliente |
|
|
Id. de solicitud
|
Request-Id | True | string |
Formato: guid. Identificador de correlación que se debe devolver al autor de la llamada para indicar el retorno de la solicitud dada. |
|
Reasignar solicitud del agente de BDC principal
|
reassignPrimaryBDCAgentRequest |
reasignar el cuerpo de la solicitud del agente BDC principal |
Definiciones
LinkDescriptionObject
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
href
|
href | string |
URI de destino |
|
rel
|
rel | string |
Tipo de relación de vínculo |
|
method
|
method | string |
Verbo HTTP que debe usarse para realizar una solicitud al destino del vínculo. |
|
title
|
title | string |
Título que describe el objeto |
SearchOpportunitiesResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
items
|
items | array of Opportunity |
Una colección de oportunidades |
|
total de elementos
|
totalItems | integer |
Número total de oportunidades para la consulta dada |
|
totalPages
|
totalPages | integer |
Número total de páginas de oportunidades para la consulta dada |
|
pageNumber
|
pageNumber | integer |
Número de página actual para este conjunto de resultados paginados |
|
pageSize
|
pageSize | integer |
Tamaño de página para este conjunto de resultados paginados |
|
Enlaces
|
links | array of LinkDescriptionObject |
Colección de vínculos HATEOAS |
SearchDeltaOpportunitiesResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
items
|
items | array of Opportunity |
Una colección de oportunidades |
|
total de elementos
|
totalItems | integer |
Número total de oportunidades para la consulta dada |
|
totalPages
|
totalPages | integer |
Número total de páginas de oportunidades para la consulta dada |
|
pageNumber
|
pageNumber | integer |
Número de página actual para este conjunto de resultados paginados |
|
pageSize
|
pageSize | integer |
Tamaño de página para este conjunto de resultados paginados |
|
Enlaces
|
links | array of LinkDescriptionObject |
Colección de vínculos HATEOAS |
Oportunidad
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | uuid |
Identificador único de esta oportunidad |
|
cliente
|
customer | OpportunityCustomer | |
|
dateIn
|
dateIn | date-time |
Fecha y hora en que llegó la oportunidad |
|
source
|
source | string |
Nombre de origen para esta oportunidad |
|
subSource
|
subSource | string |
Nombre de subrecurso para esta oportunidad |
|
estado
|
status | string |
Estado actual de esta oportunidad |
|
subStatus
|
subStatus | string |
Subestado de esta oportunidad |
|
upType
|
upType | string |
Tipo de actualización para esta oportunidad |
|
soughtVehicles
|
soughtVehicles | array of OpportunityVehicleSought |
Una colección de vehículos buscados para esta oportunidad |
|
tradeIns
|
tradeIns | array of OpportunityVehicleTradeIn |
Una colección de intercambios de vehículos para esta oportunidad |
|
salesTeam
|
salesTeam | array of OpportunitySalesperson |
Colección de miembros del equipo de ventas y sus posiciones para esta oportunidad |
|
Enlaces
|
links | array of LinkDescriptionObject |
Una colección de vínculos HATEOAS para esta oportunidad |
OpportunityCustomer
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | uuid |
Identificador único para este cliente |
|
Enlaces
|
links | array of LinkDescriptionObject |
Colección de vínculos HATEOAS para este cliente |
OpportunityVehicleSought
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | uuid |
Identificador único para este vehículo buscado |
|
isNew
|
isNew | boolean |
true/false si el vehículo buscado es nuevo |
|
yearFrom
|
yearFrom | integer |
Rango de año inicial para este vehículo buscado |
|
yearTo
|
yearTo | integer |
Gama final del año para este vehículo buscado |
|
hacer
|
make | string |
Marca del vehículo buscado |
|
model
|
model | string |
Modelo del vehículo buscado |
|
trim
|
trim | string |
Recorte del vehículo buscado |
|
Vin
|
vin | string |
VIN del vehículo buscado |
|
priceFrom
|
priceFrom | double |
Rango de precios inicial del vehículo buscado |
|
priceTo
|
priceTo | double |
Gama de precios finales del vehículo buscado |
|
maxMileage
|
maxMileage | integer |
Kilometraje máximo del vehículo buscado |
|
stockNumber
|
stockNumber | string |
Número de existencias del vehículo buscado |
|
isPrimario
|
isPrimary | boolean |
true/false si este vehículo buscado es el principal para la oportunidad dada |
OpportunityVehicleTradeIn
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | uuid |
Identificador único para este comercio de vehículos |
|
año
|
year | integer |
Año de este comercio de vehículos |
|
hacer
|
make | string |
Make of this vehicle trade-in |
|
model
|
model | string |
Modelo de este comercio de vehículos |
|
trim
|
trim | string |
Recorte del comercio de este vehículo |
|
Vin
|
vin | string |
VIN de este vehículo comercial |
|
estimatedMileage
|
estimatedMileage | integer |
Kilometraje estimado de este vehículo |
|
interiorColor
|
interiorColor | string |
Color interior del comercio de este vehículo |
|
exteriorColor
|
exteriorColor | string |
Color exterior de este vehículo comercial |
OpportunitySalesperson
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | uuid |
Identificador único de este vendedor |
|
firstName
|
firstName | string |
Nombre de este vendedor |
|
lastName
|
lastName | string |
Apellidos de este vendedor |
|
isPrimario
|
isPrimary | boolean |
true/false si se trata del vendedor principal para la oportunidad dada |
|
isPositionPrimary
|
isPositionPrimary | boolean |
true/false si se trata del vendedor principal para esta posición en la oportunidad dada |
|
positionName
|
positionName | string |
Nombre de posición para este vendedor en la oportunidad dada |
|
positionCode
|
positionCode | string |
Colocación de código para este vendedor en la oportunidad dada |
|
Enlaces
|
links | array of LinkDescriptionObject |
Colección de vínculos HATEOAS para este vendedor |
Vendedor
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | uuid |
Identificador único de este vendedor |
|
isPrimario
|
isPrimary | boolean |
true/false si se trata del vendedor principal para la oportunidad dada |
|
isPositionPrimary
|
isPositionPrimary | boolean |
true/false si se trata del vendedor principal para esta posición en la oportunidad dada |
|
positionCode
|
positionCode | string |
Colocación de código para este vendedor en la oportunidad dada |
SendEmailResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
activityId
|
activityId | uuid |
Identificador único de la actividad |
CreateOpportunityResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
oportunidad
|
opportunity | Opportunity | |
|
isDuplicate
|
isDuplicate | boolean |
true/false si se determinó que la oportunidad dada era un duplicado |
|
opportunityActivityId
|
opportunityActivityId | uuid |
Identificador único de la actividad para la oportunidad especificada |