Возможности продаж Elead (предварительная версия)

API возможностей продаж Elead ищет и извлекает существующие сведения о возможностях продаж в Elead CRM. Сведения о возможностях включают сведения, связанные с отделом продаж, источником, автомобилем интереса и информацией о торговле автомобилями. Этот API включает следующие возможности и функции для управления сведениями, связанными с возможностями.

Этот соединитель доступен в следующих продуктах и регионах:

Услуга Class Регионы
Copilot Studio Премия Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Логические приложения Стандарт Все регионы Logic Apps , кроме следующих:
     — Регионы Azure для государственных организаций
     — Регионы Azure Для Китая
     - Министерство обороны США (DoD)
Power Apps Премия Все регионы Power Apps , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Power Automate Премия Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Контакт
Имя CDK Global
URL https://serviceconnect.support.cdk.com
Адрес электронной почты mbd_support@cdk.com
Метаданные соединителя
Publisher CDK Global
Веб-сайт https://fortellis.io
Политика конфиденциальности https://fortellis.io/privacy
Категории Данные

Что делает этот API?

Этот API ищет и извлекает существующие сведения о возможностях продаж в Elead CRM. Сведения о возможностях включают сведения, связанные с отделом продаж, источником, автомобилем интереса и информацией о торговле автомобилями.

Целевая аудитория

Этот API предназначен для дилеров и партнеров-поставщиков, которые управляют возможностями и возможностью электронной почты.

Возможности и компоненты

Этот API включает следующие возможности и функции для управления сведениями, связанными с возможностями.

  • Поиск и получение ранее отправленных возможностей во всех источниках
  • Запрос продаж по идентификатору клиента, диапазонам дат или по дате и времени
  • Получение возможности по Elead Id
  • Создание новых возможностей для существующих записей клиентов
  • Добавление комментария в возможность
  • Добавление, изменение и удаление интересующих транспортных средств и записей торговли автомобилями
  • Переназначение основного продавца в команде
  • Переназначение основного агента BDC в команде
  • Отправка сообщения электронной почты от имени дилера или партнера поставщика
  • Добавление продавца в группу продаж возможностей
  • Удаление продавца из группы продаж возможностей
  • Обновление состояния вложенных возможностей
  • Добавление, удаление и получение шагов по продажам возможностей

Pre-requisites

Чтобы продолжить, вам потребуется следующее.

  • Чтобы использовать соединитель, необходимо быть пользователем Fortellis
  • Необходимо создать решение в Fortellis для создания идентификатора клиента и секрета для использования при вызове API

Подробные сведения о документации можно найти по адресу

https://apidocs.fortellis.io/specs/3c6d6b40-7215-4a81-a087-4f956bb36ec9

Ограничения регулирования

Имя Вызовы Период обновления
Вызовы API для каждого подключения 100 60 секунд

Действия

Добавление примечания к возможности

Добавляет комментарий к указанной возможности

Добавление продавца в возможность

Добавляет продавца в указанную возможность

Добавление торговых возможностей

Добавляет торговую сделку в указанную возможность

Добавление транспортного средства, стремясь к возможности

Добавляет автомобиль, стремясь к указанной возможности

Запрос возможностей продаж по диапазону дат

Получение возможностей продаж по диапазону дат

Запрос возможностей продаж с предоставленной даты и времени

Получение возможностей продаж по предоставленной дате и времени (за последние 7 дней)

Отправка сообщения электронной почты и создание соответствующего действия

Отправляет сообщение электронной почты и создает соответствующее действие

Переназначение первичного продавца для указанной возможности

Переназначает основного продавца для указанной возможности

Переназначьте основной агент bdc для указанной возможности

Переназначает основной агент bdc для указанной возможности

Создание новой возможности

Создает новую возможность

Удаление продавца из возможности

Удаляет продавца из указанной возможности

Удаление торговых возможностей

Удаляет указанный торговый элемент из возможности

Удаление транспортного средства, искомого от возможности

Удаляет указанный автомобиль, запрошенный из возможности

Добавление примечания к возможности

Добавляет комментарий к указанной возможности

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор клиента
client_id True string

Идентификатор клиента, который должен быть уникальным для разработчика или поставщика решений, создающего решение.

Секрет клиента
client_secret True string

Секрет клиента, который должен быть уникальным для разработчика или поставщика решений, создающего решение.

идентификатор подписки;
subscription_id True string

Идентификатор корреляции, который должен быть возвращен вызывающему объекту, чтобы указать возврат заданного запроса.

Принять
Accept string

Принять заголовок

Accept-Charset
Accept-Charset string

Заголовок Accept-Charset

Accept-Encoding
Accept-Encoding string

Заголовок Accept-Encoding

Accept-Language
Accept-Language string

Заголовок Accept-Language

If-Match
If-Match string

Заголовок If-Match

If-None-Match
If-None-Match string

Если— заголовокNone-Match

Возможно, предпочтительно
Prefer string

Предпочтения клиента

Идентификатор запроса
Request-Id True string

Формат — guid. Идентификатор корреляции, который должен быть возвращен вызывающему объекту, чтобы указать возврат заданного запроса.

opportunityId
opportunityId True uuid

Уникальный идентификатор возможности

Комментарий
comment True string

Примечания, добавляемые в указанную возможность

Добавление продавца в возможность

Добавляет продавца в указанную возможность

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор возможности
opportunityId True string

Формат — uuid.

Идентификатор клиента
client_id True string

Идентификатор клиента, который должен быть уникальным для разработчика или поставщика решений, создающего решение.

Секрет клиента
client_secret True string

Секрет клиента, который должен быть уникальным для разработчика или поставщика решений, создающего решение.

идентификатор подписки;
subscription_id True string

Идентификатор корреляции, который должен быть возвращен вызывающему объекту, чтобы указать возврат заданного запроса.

Принять
Accept string

Принять заголовок

Accept-Charset
Accept-Charset string

Заголовок Accept-Charset

Accept-Encoding
Accept-Encoding string

Заголовок Accept-Encoding

Accept-Language
Accept-Language string

Заголовок Accept-Language

If-Match
If-Match string

Заголовок If-Match

If-None-Match
If-None-Match string

Если— заголовокNone-Match

Возможно, предпочтительно
Prefer string

Предпочтения клиента

Идентификатор запроса
Request-Id True string

Формат — guid. Идентификатор корреляции, который должен быть возвращен вызывающему объекту, чтобы указать возврат заданного запроса.

id
id True uuid

Уникальный идентификатор этого продавца

isPrimary
isPrimary True boolean

true/false, является ли это основным продавцом для данной возможности

isPositionPrimary
isPositionPrimary True boolean

true/false, является ли это основным продавцом для этой позиции по данной возможности

positionCode
positionCode True string

Код позиции для этого продавца по данной возможности

Возвращаемое значение

Тело
Salesperson

Добавление торговых возможностей

Добавляет торговую сделку в указанную возможность

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор клиента
client_id True string

Идентификатор клиента, который должен быть уникальным для разработчика или поставщика решений, создающего решение.

Секрет клиента
client_secret True string

Секрет клиента, который должен быть уникальным для разработчика или поставщика решений, создающего решение.

идентификатор подписки;
subscription_id True string

Идентификатор корреляции, который должен быть возвращен вызывающему объекту, чтобы указать возврат заданного запроса.

Принять
Accept string

Принять заголовок

Accept-Charset
Accept-Charset string

Заголовок Accept-Charset

Accept-Encoding
Accept-Encoding string

Заголовок Accept-Encoding

Accept-Language
Accept-Language string

Заголовок Accept-Language

If-Match
If-Match string

Заголовок If-Match

If-None-Match
If-None-Match string

Если— заголовокNone-Match

Возможно, предпочтительно
Prefer string

Предпочтения клиента

Идентификатор запроса
Request-Id True string

Формат — guid. Идентификатор корреляции, который должен быть возвращен вызывающему объекту, чтобы указать возврат заданного запроса.

opportunityId
opportunityId True uuid

Уникальный идентификатор возможности

год
year integer

Год торговли автомобилями

делать
make string

Создание этого транспортного средства в торговле

model
model string

Модель этого транспортного средства торговли

подстригать
trim string

Обрезка этого транспортного средства в торговле

вин
vin string

VIN этого транспортного средства торговли

estimatedMileage
estimatedMileage integer

Оценочный пробег этого транспортного средства в торговле

interiorColor
interiorColor string

Цвет интерьера этого транспортного средства торговли

внешний цвет
exteriorColor string

Внешний цвет этого транспортного средства торговли

Возвращаемое значение

Добавление транспортного средства, стремясь к возможности

Добавляет автомобиль, стремясь к указанной возможности

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор клиента
client_id True string

Идентификатор клиента, который должен быть уникальным для разработчика или поставщика решений, создающего решение.

Секрет клиента
client_secret True string

Секрет клиента, который должен быть уникальным для разработчика или поставщика решений, создающего решение.

идентификатор подписки;
subscription_id True string

Идентификатор корреляции, который должен быть возвращен вызывающему объекту, чтобы указать возврат заданного запроса.

Принять
Accept string

Принять заголовок

Accept-Charset
Accept-Charset string

Заголовок Accept-Charset

Accept-Encoding
Accept-Encoding string

Заголовок Accept-Encoding

Accept-Language
Accept-Language string

Заголовок Accept-Language

If-Match
If-Match string

Заголовок If-Match

If-None-Match
If-None-Match string

Если— заголовокNone-Match

Возможно, предпочтительно
Prefer string

Предпочтения клиента

Идентификатор запроса
Request-Id True string

Формат — guid. Идентификатор корреляции, который должен быть возвращен вызывающему объекту, чтобы указать возврат заданного запроса.

opportunityId
opportunityId True uuid

Уникальный идентификатор возможности

Новый
isNew True boolean

true/false, является ли искомый автомобиль новым

yearFrom
yearFrom integer

Начальный диапазон года для этого транспортного средства искал

YearTo
yearTo integer

Конечный год диапазона для этого транспортного средства искал

делать
make string

Макияж транспортного средства искомого

model
model string

Модель искомого транспортного средства

подстригать
trim string

Обрезка транспортного средства искомая

вин
vin string

VIN автомобиля, искомого

priceFrom
priceFrom double

Начальный ценовой диапазон запрашиваемого транспортного средства

priceTo
priceTo double

Конечный ценовой диапазон транспортного средства искомого

maxMileage
maxMileage integer

Максимальное количество миль транспортного средства, искомого

stockNumber
stockNumber string

Количество запрошенных транспортных средств

isPrimary
isPrimary True boolean

true/false, является ли этот автомобиль основным для указанной возможности

Возвращаемое значение

Запрос возможностей продаж по диапазону дат

Получение возможностей продаж по диапазону дат

Параметры

Имя Ключ Обязательно Тип Описание
Страница
page integer

Формат — int32.

Размер страницы
pageSize integer

Формат — int32.

Дата из
dateFrom string

Формат — время даты (в RFC3339).

Дата до
dateTo string

Формат — время даты (в RFC3339).

Идентификатор клиента
client_id True string

Идентификатор клиента, который должен быть уникальным для разработчика или поставщика решений, создающего решение.

Секрет клиента
client_secret True string

Секрет клиента, который должен быть уникальным для разработчика или поставщика решений, создающего решение.

идентификатор подписки;
subscription_id True string

Идентификатор корреляции, который должен быть возвращен вызывающему объекту, чтобы указать возврат заданного запроса.

Принять
Accept string

Принять заголовок

Accept-Charset
Accept-Charset string

Заголовок Accept-Charset

Accept-Encoding
Accept-Encoding string

Заголовок Accept-Encoding

Accept-Language
Accept-Language string

Заголовок Accept-Language

If-Match
If-Match string

Заголовок If-Match

If-None-Match
If-None-Match string

Если— заголовокNone-Match

Возможно, предпочтительно
Prefer string

Предпочтения клиента

Идентификатор запроса
Request-Id True string

Формат — guid. Идентификатор корреляции, который должен быть возвращен вызывающему объекту, чтобы указать возврат заданного запроса.

Возвращаемое значение

Запрос возможностей продаж с предоставленной даты и времени

Получение возможностей продаж по предоставленной дате и времени (за последние 7 дней)

Параметры

Имя Ключ Обязательно Тип Описание
Страница
page integer

Формат — int32.

Размер страницы
pageSize integer

Формат — int32.

Дата из
dateFrom string

Формат — время даты (в RFC3339).

Идентификатор клиента
client_id True string

Идентификатор клиента, который должен быть уникальным для разработчика или поставщика решений, создающего решение.

Секрет клиента
client_secret True string

Секрет клиента, который должен быть уникальным для разработчика или поставщика решений, создающего решение.

идентификатор подписки;
subscription_id True string

Идентификатор корреляции, который должен быть возвращен вызывающему объекту, чтобы указать возврат заданного запроса.

Принять
Accept string

Принять заголовок

Accept-Charset
Accept-Charset string

Заголовок Accept-Charset

Accept-Encoding
Accept-Encoding string

Заголовок Accept-Encoding

Accept-Language
Accept-Language string

Заголовок Accept-Language

If-Match
If-Match string

Заголовок If-Match

If-None-Match
If-None-Match string

Если— заголовокNone-Match

Возможно, предпочтительно
Prefer string

Предпочтения клиента

Идентификатор запроса
Request-Id True string

Формат — guid. Идентификатор корреляции, который должен быть возвращен вызывающему объекту, чтобы указать возврат заданного запроса.

Возвращаемое значение

Отправка сообщения электронной почты и создание соответствующего действия

Отправляет сообщение электронной почты и создает соответствующее действие

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор клиента
client_id True string

Идентификатор клиента, который должен быть уникальным для разработчика или поставщика решений, создающего решение.

Секрет клиента
client_secret True string

Секрет клиента, который должен быть уникальным для разработчика или поставщика решений, создающего решение.

идентификатор подписки;
subscription_id True string

Идентификатор корреляции, который должен быть возвращен вызывающему объекту, чтобы указать возврат заданного запроса.

Принять
Accept string

Принять заголовок

Accept-Charset
Accept-Charset string

Заголовок Accept-Charset

Accept-Encoding
Accept-Encoding string

Заголовок Accept-Encoding

Accept-Language
Accept-Language string

Заголовок Accept-Language

If-Match
If-Match string

Заголовок If-Match

If-None-Match
If-None-Match string

Если— заголовокNone-Match

Возможно, предпочтительно
Prefer string

Предпочтения клиента

Идентификатор запроса
Request-Id True string

Формат — guid. Идентификатор корреляции, который должен быть возвращен вызывающему объекту, чтобы указать возврат заданного запроса.

opportunityId
opportunityId True uuid

Уникальный иденитифер возможности

от / из / с (context-dependent)
from True string

Адрес электронной почты отправителя

recipients
recipients True array of string

Коллекция адресов электронной почты получателя

углеродCopies
carbonCopies array of string

Коллекция адресов электронной почты для углеродного копирования

субъект
subject True string

Тема сообщения электронной почты

body
body True string

Текст сообщения электронной почты

isHtml
isHtml True boolean

Текст в формате HTML?

Возвращаемое значение

Переназначение первичного продавца для указанной возможности

Переназначает основного продавца для указанной возможности

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор клиента
client_id True string

Идентификатор клиента, который должен быть уникальным для разработчика или поставщика решений, создающего решение.

Секрет клиента
client_secret True string

Секрет клиента, который должен быть уникальным для разработчика или поставщика решений, создающего решение.

идентификатор подписки;
subscription_id True string

Идентификатор корреляции, который должен быть возвращен вызывающему объекту, чтобы указать возврат заданного запроса.

Принять
Accept string

Принять заголовок

Accept-Charset
Accept-Charset string

Заголовок Accept-Charset

Accept-Encoding
Accept-Encoding string

Заголовок Accept-Encoding

Accept-Language
Accept-Language string

Заголовок Accept-Language

If-Match
If-Match string

Заголовок If-Match

If-None-Match
If-None-Match string

Если— заголовокNone-Match

Возможно, предпочтительно
Prefer string

Предпочтения клиента

Идентификатор запроса
Request-Id True string

Формат — guid. Идентификатор корреляции, который должен быть возвращен вызывающему объекту, чтобы указать возврат заданного запроса.

Переназначение запроса первичного сотрудника по продажам
reassignPrimarySalesPersonRequest

Переназначение основного текста запроса на продажу

Переназначьте основной агент bdc для указанной возможности

Переназначает основной агент bdc для указанной возможности

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор клиента
client_id True string

Идентификатор клиента, который должен быть уникальным для разработчика или поставщика решений, создающего решение.

Секрет клиента
client_secret True string

Секрет клиента, который должен быть уникальным для разработчика или поставщика решений, создающего решение.

идентификатор подписки;
subscription_id True string

Идентификатор корреляции, который должен быть возвращен вызывающему объекту, чтобы указать возврат заданного запроса.

Принять
Accept string

Принять заголовок

Accept-Charset
Accept-Charset string

Заголовок Accept-Charset

Accept-Encoding
Accept-Encoding string

Заголовок Accept-Encoding

Accept-Language
Accept-Language string

Заголовок Accept-Language

If-Match
If-Match string

Заголовок If-Match

If-None-Match
If-None-Match string

Если— заголовокNone-Match

Возможно, предпочтительно
Prefer string

Предпочтения клиента

Идентификатор запроса
Request-Id True string

Формат — guid. Идентификатор корреляции, который должен быть возвращен вызывающему объекту, чтобы указать возврат заданного запроса.

Переназначение первичного запроса агента BDC
reassignPrimaryBDCAgentRequest

переназначение основного текста запроса агента BDC

Создание новой возможности

Создает новую возможность

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор клиента
client_id True string

Идентификатор клиента, который должен быть уникальным для разработчика или поставщика решений, создающего решение.

Секрет клиента
client_secret True string

Секрет клиента, который должен быть уникальным для разработчика или поставщика решений, создающего решение.

идентификатор подписки;
subscription_id True string

Идентификатор корреляции, который должен быть возвращен вызывающему объекту, чтобы указать возврат заданного запроса.

Принять
Accept string

Принять заголовок

Accept-Charset
Accept-Charset string

Заголовок Accept-Charset

Accept-Encoding
Accept-Encoding string

Заголовок Accept-Encoding

Accept-Language
Accept-Language string

Заголовок Accept-Language

If-Match
If-Match string

Заголовок If-Match

If-None-Match
If-None-Match string

Если— заголовокNone-Match

Возможно, предпочтительно
Prefer string

Предпочтения клиента

Идентификатор запроса
Request-Id True string

Формат — guid. Идентификатор корреляции, который должен быть возвращен вызывающему объекту, чтобы указать возврат заданного запроса.

customerId
customerId True uuid

Уникальный идентификатор клиента

dateIn
dateIn date-time

Дата и время, в которое появилась возможность

source
source True string

Имя источника для этой возможности

subSource
subSource string

Имя подресурса для этой возможности

статус
status string

Текущее состояние этой возможности

подстатус
subStatus string

Подстатус этой возможности

upType
upType True string

Тип для этой возможности

comments
comments string
Новый
isNew True boolean

true/false, является ли искомый автомобиль новым

yearFrom
yearFrom integer

Начальный диапазон года для этого транспортного средства искал

YearTo
yearTo integer

Конечный год диапазона для этого транспортного средства искал

делать
make string

Макияж транспортного средства искомого

model
model string

Модель искомого транспортного средства

подстригать
trim string

Обрезка транспортного средства искомая

вин
vin string

VIN автомобиля, искомого

priceFrom
priceFrom double

Начальный ценовой диапазон запрашиваемого транспортного средства

priceTo
priceTo double

Конечный ценовой диапазон транспортного средства искомого

maxMileage
maxMileage integer

Максимальное количество миль транспортного средства, искомого

stockNumber
stockNumber string

Количество запрошенных транспортных средств

isPrimary
isPrimary True boolean

true/false, является ли этот автомобиль основным для указанной возможности

год
year integer

Год торговли автомобилями

делать
make string

Создание этого транспортного средства в торговле

model
model string

Модель этого транспортного средства торговли

подстригать
trim string

Обрезка этого транспортного средства в торговле

вин
vin string

VIN этого транспортного средства торговли

estimatedMileage
estimatedMileage integer

Оценочный пробег этого транспортного средства в торговле

interiorColor
interiorColor string

Цвет интерьера этого транспортного средства торговли

внешний цвет
exteriorColor string

Внешний цвет этого транспортного средства торговли

имя
name True string

Имя шага продаж

id
id True uuid

Уникальный идентификатор этого продавца

isPrimary
isPrimary True boolean

true/false, является ли это основным продавцом для данной возможности

isPositionPrimary
isPositionPrimary True boolean

true/false, является ли это основным продавцом для этой позиции по данной возможности

positionCode
positionCode True string

Код позиции для этого продавца по данной возможности

Возвращаемое значение

Удаление продавца из возможности

Удаляет продавца из указанной возможности

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор возможности
opportunityId True string

Формат — uuid.

Идентификатор клиента
client_id True string

Идентификатор клиента, который должен быть уникальным для разработчика или поставщика решений, создающего решение.

Секрет клиента
client_secret True string

Секрет клиента, который должен быть уникальным для разработчика или поставщика решений, создающего решение.

идентификатор подписки;
subscription_id True string

Идентификатор корреляции, который должен быть возвращен вызывающему объекту, чтобы указать возврат заданного запроса.

Принять
Accept string

Принять заголовок

Accept-Charset
Accept-Charset string

Заголовок Accept-Charset

Accept-Encoding
Accept-Encoding string

Заголовок Accept-Encoding

Accept-Language
Accept-Language string

Заголовок Accept-Language

If-Match
If-Match string

Заголовок If-Match

If-None-Match
If-None-Match string

Если— заголовокNone-Match

Возможно, предпочтительно
Prefer string

Предпочтения клиента

Идентификатор запроса
Request-Id True string

Формат — guid. Идентификатор корреляции, который должен быть возвращен вызывающему объекту, чтобы указать возврат заданного запроса.

SalespersonId
salespersonId True uuid

Уникальный идентификатор продавца

positionCode
positionCode True string

Код позиции для этого продавца по данной возможности

Удаление торговых возможностей

Удаляет указанный торговый элемент из возможности

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор TradeIn
tradeInId True string

Формат — uuid.

Идентификатор клиента
client_id True string

Идентификатор клиента, который должен быть уникальным для разработчика или поставщика решений, создающего решение.

Секрет клиента
client_secret True string

Секрет клиента, который должен быть уникальным для разработчика или поставщика решений, создающего решение.

идентификатор подписки;
subscription_id True string

Идентификатор корреляции, который должен быть возвращен вызывающему объекту, чтобы указать возврат заданного запроса.

Принять
Accept string

Принять заголовок

Accept-Charset
Accept-Charset string

Заголовок Accept-Charset

Accept-Encoding
Accept-Encoding string

Заголовок Accept-Encoding

Accept-Language
Accept-Language string

Заголовок Accept-Language

If-Match
If-Match string

Заголовок If-Match

If-None-Match
If-None-Match string

Если— заголовокNone-Match

Возможно, предпочтительно
Prefer string

Предпочтения клиента

Идентификатор запроса
Request-Id True string

Формат — guid. Идентификатор корреляции, который должен быть возвращен вызывающему объекту, чтобы указать возврат заданного запроса.

Удаление транспортного средства, искомого от возможности

Удаляет указанный автомобиль, запрошенный из возможности

Параметры

Имя Ключ Обязательно Тип Описание
Искомый идентификатор транспортного средства
vehicleSoughtId True string

Формат — uuid.

Идентификатор клиента
client_id True string

Идентификатор клиента, который должен быть уникальным для разработчика или поставщика решений, создающего решение.

Секрет клиента
client_secret True string

Секрет клиента, который должен быть уникальным для разработчика или поставщика решений, создающего решение.

идентификатор подписки;
subscription_id True string

Идентификатор корреляции, который должен быть возвращен вызывающему объекту, чтобы указать возврат заданного запроса.

Принять
Accept string

Принять заголовок

Accept-Charset
Accept-Charset string

Заголовок Accept-Charset

Accept-Encoding
Accept-Encoding string

Заголовок Accept-Encoding

Accept-Language
Accept-Language string

Заголовок Accept-Language

If-Match
If-Match string

Заголовок If-Match

If-None-Match
If-None-Match string

Если— заголовокNone-Match

Возможно, предпочтительно
Prefer string

Предпочтения клиента

Идентификатор запроса
Request-Id True string

Формат — guid. Идентификатор корреляции, который должен быть возвращен вызывающему объекту, чтобы указать возврат заданного запроса.

Определения

LinkDescriptionObject

Имя Путь Тип Описание
href
href string

Целевой универсальный код ресурса (URI)

rel
rel string

Тип отношения связи

method
method string

HTTP-команда, которая должна использоваться для выполнения запроса к целевому объекту ссылки

title
title string

Заголовок, описывающий объект

SearchOpportunitiesResponse

Имя Путь Тип Описание
items
items array of Opportunity

Коллекция возможностей

общееКоличествоЭлементов
totalItems integer

Общее количество возможностей для данного запроса

totalPages
totalPages integer

Общее количество страниц возможностей для данного запроса

pageNumber
pageNumber integer

Текущий номер страницы для этого набора результатов страницы

pageSize
pageSize integer

Размер страницы для этого набора результатов страниц

links
links array of LinkDescriptionObject

Коллекция ссылок HATEOAS

SearchDeltaOpportunitiesResponse

Имя Путь Тип Описание
items
items array of Opportunity

Коллекция возможностей

общееКоличествоЭлементов
totalItems integer

Общее количество возможностей для данного запроса

totalPages
totalPages integer

Общее количество страниц возможностей для данного запроса

pageNumber
pageNumber integer

Текущий номер страницы для этого набора результатов страницы

pageSize
pageSize integer

Размер страницы для этого набора результатов страниц

links
links array of LinkDescriptionObject

Коллекция ссылок HATEOAS

Возможность

Имя Путь Тип Описание
id
id uuid

Уникальный идентификатор этой возможности

клиент
customer OpportunityCustomer
dateIn
dateIn date-time

Дата и время, в которое появилась возможность

source
source string

Имя источника для этой возможности

subSource
subSource string

Имя подресурса для этой возможности

статус
status string

Текущее состояние этой возможности

подстатус
subStatus string

Подстатус этой возможности

upType
upType string

Тип для этой возможности

искомые вехиклы
soughtVehicles array of OpportunityVehicleSought

Коллекция транспортных средств, стремясь к этой возможности

tradeIns
tradeIns array of OpportunityVehicleTradeIn

Коллекция торгов транспортных средств для этой возможности

salesTeam
salesTeam array of OpportunitySalesperson

Коллекция участников группы продаж и их должностей для этой возможности

links
links array of LinkDescriptionObject

Коллекция ссылок HATEOAS для этой возможности

OpportunityCustomer

Имя Путь Тип Описание
id
id uuid

Уникальный идентификатор для этого клиента

links
links array of LinkDescriptionObject

Коллекция ссылок HATEOAS для этого клиента

OpportunityVehicleSought

Имя Путь Тип Описание
id
id uuid

Уникальный идентификатор для этого транспортного средства

Новый
isNew boolean

true/false, является ли искомый автомобиль новым

yearFrom
yearFrom integer

Начальный диапазон года для этого транспортного средства искал

YearTo
yearTo integer

Конечный год диапазона для этого транспортного средства искал

делать
make string

Макияж транспортного средства искомого

model
model string

Модель искомого транспортного средства

подстригать
trim string

Обрезка транспортного средства искомая

вин
vin string

VIN автомобиля, искомого

priceFrom
priceFrom double

Начальный ценовой диапазон запрашиваемого транспортного средства

priceTo
priceTo double

Конечный ценовой диапазон транспортного средства искомого

maxMileage
maxMileage integer

Максимальное количество миль транспортного средства, искомого

stockNumber
stockNumber string

Количество запрошенных транспортных средств

isPrimary
isPrimary boolean

true/false, искомый автомобиль является основным для данной возможности

OpportunityVehicleTradeIn

Имя Путь Тип Описание
id
id uuid

Уникальный идентификатор для этого торгового объекта транспортного средства

год
year integer

Год торговли автомобилями

делать
make string

Создание этого транспортного средства в торговле

model
model string

Модель этого транспортного средства торговли

подстригать
trim string

Обрезка этого транспортного средства в торговле

вин
vin string

VIN этого транспортного средства торговли

estimatedMileage
estimatedMileage integer

Оценочный пробег этого транспортного средства в торговле

interiorColor
interiorColor string

Цвет интерьера этого транспортного средства торговли

внешний цвет
exteriorColor string

Внешний цвет этого транспортного средства торговли

OpportunitySalesperson

Имя Путь Тип Описание
id
id uuid

Уникальный идентификатор этого продавца

Имя
firstName string

Имя этого продавца

lastName
lastName string

Фамилия этого продавца

isPrimary
isPrimary boolean

true/false, является ли это основным продавцом для данной возможности

isPositionPrimary
isPositionPrimary boolean

true/false, является ли это основным продавцом для этой позиции по данной возможности

positionName
positionName string

Имя позиции для этого продавца по данной возможности

positionCode
positionCode string

Код позиции для этого продавца по данной возможности

links
links array of LinkDescriptionObject

Коллекция ссылок HATEOAS для этого продавца

Продавец

Имя Путь Тип Описание
id
id uuid

Уникальный идентификатор этого продавца

isPrimary
isPrimary boolean

true/false, является ли это основным продавцом для данной возможности

isPositionPrimary
isPositionPrimary boolean

true/false, является ли это основным продавцом для этой позиции по данной возможности

positionCode
positionCode string

Код позиции для этого продавца по данной возможности

SendEmailResponse

Имя Путь Тип Описание
activityId
activityId uuid

Уникальный идентификатор действия

CreateOpportunityResponse

Имя Путь Тип Описание
возможность
opportunity Opportunity
isDuplicate
isDuplicate boolean

true/false, является ли данная возможность определенной возможностью дубликатом

opportunityActivityId
opportunityActivityId uuid

Уникальный идентификатор действия для указанной возможности