Elead Sales Opportunities

Status: Preview

Tier: Premium

Version: 1.0

Name

Summary

Opportunities_Search ([Optional]integer page, [Optional]integer pageSize, [Optional]string dateFrom, [Optional]string dateTo, string client_id, string client_secret, string subscription_id, [Optional]string Accept, [Optional]string Accept-Charset, [Optional]string Accept-Encoding, [Optional]string Accept-Language, [Optional]string If-Match, [Optional]string If-None-Match, [Optional]string Prefer, string Request-Id)

Query sales opportunities by date range

Opportunities_SearchDelta ([Optional]integer page, [Optional]integer pageSize, [Optional]string dateFrom, string client_id, string client_secret, string subscription_id, [Optional]string Accept, [Optional]string Accept-Charset, [Optional]string Accept-Encoding, [Optional]string Accept-Language, [Optional]string If-Match, [Optional]string If-None-Match, [Optional]string Prefer, string Request-Id)

Query sales opportunities since the provided date and time

Opportunities_SendEmail (string client_id, string client_secret, string subscription_id, [Optional]string Accept, [Optional]string Accept-Charset, [Optional]string Accept-Encoding, [Optional]string Accept-Language, [Optional]string If-Match, [Optional]string If-None-Match, [Optional]string Prefer, string Request-Id, [Optional]SendEmailRequest sendEmailRequest)

Send an email and create the corresponding activity

Opportunities_CreateOpportunity (string client_id, string client_secret, string subscription_id, [Optional]string Accept, [Optional]string Accept-Charset, [Optional]string Accept-Encoding, [Optional]string Accept-Language, [Optional]string If-Match, [Optional]string If-None-Match, [Optional]string Prefer, string Request-Id, [Optional]CreateOpportunityRequest createOpportunityRequest)

Create new opportunity

Opportunities_AddComment (string client_id, string client_secret, string subscription_id, [Optional]string Accept, [Optional]string Accept-Charset, [Optional]string Accept-Encoding, [Optional]string Accept-Language, [Optional]string If-Match, [Optional]string If-None-Match, [Optional]string Prefer, string Request-Id, [Optional]AddOpportunityCommentRequest addOpportunityCommentRequest)

Add comment to opportunity

Opportunities_AddTradeIn (string client_id, string client_secret, string subscription_id, [Optional]string Accept, [Optional]string Accept-Charset, [Optional]string Accept-Encoding, [Optional]string Accept-Language, [Optional]string If-Match, [Optional]string If-None-Match, [Optional]string Prefer, string Request-Id, [Optional]AddOpportunityTradeInRequest addOpportunityTradeInRequest)

Add trade-in to opportunity

Opportunities_DeleteTradeIn (string tradeInId, string client_id, string client_secret, string subscription_id, [Optional]string Accept, [Optional]string Accept-Charset, [Optional]string Accept-Encoding, [Optional]string Accept-Language, [Optional]string If-Match, [Optional]string If-None-Match, [Optional]string Prefer, string Request-Id)

Remove trade-in from opportunity

Opportunities_AddVehicleSought (string client_id, string client_secret, string subscription_id, [Optional]string Accept, [Optional]string Accept-Charset, [Optional]string Accept-Encoding, [Optional]string Accept-Language, [Optional]string If-Match, [Optional]string If-None-Match, [Optional]string Prefer, string Request-Id, [Optional]AddOpportunityVehicleSoughtRequest addOpportunityVehicleSoughtRequest)

Add vehicle sought to opportunity

Opportunities_DeleteVehicleSought (string vehicleSoughtId, string client_id, string client_secret, string subscription_id, [Optional]string Accept, [Optional]string Accept-Charset, [Optional]string Accept-Encoding, [Optional]string Accept-Language, [Optional]string If-Match, [Optional]string If-None-Match, [Optional]string Prefer, string Request-Id)

Remove vehicle sought from opportunity

Opportunities_ReassignPrimarySalesPerson (string client_id, string client_secret, string subscription_id, [Optional]string Accept, [Optional]string Accept-Charset, [Optional]string Accept-Encoding, [Optional]string Accept-Language, [Optional]string If-Match, [Optional]string If-None-Match, [Optional]string Prefer, string Request-Id, [Optional]ReassignPrimarySalesPersonRequest reassignPrimarySalesPersonRequest)

Reassign the primary salesperson for the specified opportunity

Opportunities_ReassignPrimaryBDCAgent (string client_id, string client_secret, string subscription_id, [Optional]string Accept, [Optional]string Accept-Charset, [Optional]string Accept-Encoding, [Optional]string Accept-Language, [Optional]string If-Match, [Optional]string If-None-Match, [Optional]string Prefer, string Request-Id, [Optional]ReassignPrimaryBDCAgentRequest reassignPrimaryBDCAgentRequest)

Reassign the primary bdc agent for the specified opportunity

Opportunities_AddSalesperson (string opportunityId, string client_id, string client_secret, string subscription_id, [Optional]string Accept, [Optional]string Accept-Charset, [Optional]string Accept-Encoding, [Optional]string Accept-Language, [Optional]string If-Match, [Optional]string If-None-Match, [Optional]string Prefer, string Request-Id, [Optional]Salesperson salesperson)

Add salesperson to opportunity

Opportunities_RemoveSalesperson (string opportunityId, string client_id, string client_secret, string subscription_id, [Optional]string Accept, [Optional]string Accept-Charset, [Optional]string Accept-Encoding, [Optional]string Accept-Language, [Optional]string If-Match, [Optional]string If-None-Match, [Optional]string Prefer, string Request-Id, [Optional]RemoveOpportunitySalespersonRequest removeOpportunitySalespersonRequest)

Remove salesperson from opportunity

Name

Summary

Name

Summary

ActivityMessage

AddOpportunityCommentRequest

AddOpportunityTradeInRequest

AddOpportunityVehicleSought

AddOpportunityVehicleSoughtRequest

AddOpportunityVehicleTradeIn

CreateOpportunityRequest

CreateOpportunityResponse

LinkDescriptionObject

Opportunity

OpportunityCustomer

OpportunitySalesperson

OpportunityVehicleSought

OpportunityVehicleTradeIn

ReassignPrimaryBDCAgentRequest

ReassignPrimarySalesPersonRequest

RemoveOpportunitySalespersonRequest

Salesperson

SalesStep

SearchDeltaOpportunitiesResponse

SearchOpportunitiesResponse

SendEmailRequest

SendEmailResponse

Name

Type

Summary

Required

Related Action

page

integer

(Page)

Format - int32.

False

pageSize

integer

(Page Size)

Format - int32.

False

dateFrom

string

(Date From)

Format - date-time (as date-time in RFC3339).

False

dateTo

string

(Date To)

Format - date-time (as date-time in RFC3339).

False

client_id

string

(Client Id)

A client ID that should be unique to developer/solution provider building the solution.

True

client_secret

string

(Client Secret)

A client secret that should be unique to developer/solution provider building the solution.

True

subscription_id

string

(Subscription Id)

A correlation ID that should be returned back to the caller to indicate the return of the given request.

True

Accept

string

(Accept)

Accept Header

False

Accept-Charset

string

(Accept-Charset)

Accept-Charset Header

False

Accept-Encoding

string

(Accept-Encoding)

Accept-Encoding Header

False

Accept-Language

string

(Accept-Language)

Accept-Language Header

False

If-Match

string

(If-Match)

If-Match Header

False

If-None-Match

string

(If-None-Match)

If-None-Match Header

False

Prefer

string

(Prefer)Values: [return=representation, return=minimal]

Preference of the customer

False

Request-Id

string

(Request Id)

Format - guid. A correlation ID that should be returned back to the caller to indicate the return of the given request

True

Name

Type

Summary

Required

Related Action

page

integer

(Page)

Format - int32.

False

pageSize

integer

(Page Size)

Format - int32.

False

dateFrom

string

(Date From)

Format - date-time (as date-time in RFC3339).

False

client_id

string

(Client Id)

A client ID that should be unique to developer/solution provider building the solution.

True

client_secret

string

(Client Secret)

A client secret that should be unique to developer/solution provider building the solution.

True

subscription_id

string

(Subscription Id)

A correlation ID that should be returned back to the caller to indicate the return of the given request.

True

Accept

string

(Accept)

Accept Header

False

Accept-Charset

string

(Accept-Charset)

Accept-Charset Header

False

Accept-Encoding

string

(Accept-Encoding)

Accept-Encoding Header

False

Accept-Language

string

(Accept-Language)

Accept-Language Header

False

If-Match

string

(If-Match)

If-Match Header

False

If-None-Match

string

(If-None-Match)

If-None-Match Header

False

Prefer

string

(Prefer)Values: [return=representation, return=minimal]

Preference of the customer

False

Request-Id

string

(Request Id)

Format - guid. A correlation ID that should be returned back to the caller to indicate the return of the given request

True

Name

Type

Summary

Required

Related Action

client_id

string

(Client Id)

A client ID that should be unique to developer/solution provider building the solution.

True

client_secret

string

(Client Secret)

A client secret that should be unique to developer/solution provider building the solution.

True

subscription_id

string

(Subscription Id)

A correlation ID that should be returned back to the caller to indicate the return of the given request.

True

Accept

string

(Accept)

Accept Header

False

Accept-Charset

string

(Accept-Charset)

Accept-Charset Header

False

Accept-Encoding

string

(Accept-Encoding)

Accept-Encoding Header

False

Accept-Language

string

(Accept-Language)

Accept-Language Header

False

If-Match

string

(If-Match)

If-Match Header

False

If-None-Match

string

(If-None-Match)

If-None-Match Header

False

Prefer

string

(Prefer)Values: [return=representation, return=minimal]

Preference of the customer

False

Request-Id

string

(Request Id)

Format - guid. A correlation ID that should be returned back to the caller to indicate the return of the given request

True

sendEmailRequest

SendEmailRequest

False

Name

Type

Summary

Required

Related Action

client_id

string

(Client Id)

A client ID that should be unique to developer/solution provider building the solution.

True

client_secret

string

(Client Secret)

A client secret that should be unique to developer/solution provider building the solution.

True

subscription_id

string

(Subscription Id)

A correlation ID that should be returned back to the caller to indicate the return of the given request.

True

Accept

string

(Accept)

Accept Header

False

Accept-Charset

string

(Accept-Charset)

Accept-Charset Header

False

Accept-Encoding

string

(Accept-Encoding)

Accept-Encoding Header

False

Accept-Language

string

(Accept-Language)

Accept-Language Header

False

If-Match

string

(If-Match)

If-Match Header

False

If-None-Match

string

(If-None-Match)

If-None-Match Header

False

Prefer

string

(Prefer)Values: [return=representation, return=minimal]

Preference of the customer

False

Request-Id

string

(Request Id)

Format - guid. A correlation ID that should be returned back to the caller to indicate the return of the given request

True

createOpportunityRequest

CreateOpportunityRequest

False

Name

Type

Summary

Required

Related Action

client_id

string

(Client Id)

A client ID that should be unique to developer/solution provider building the solution.

True

client_secret

string

(Client Secret)

A client secret that should be unique to developer/solution provider building the solution.

True

subscription_id

string

(Subscription Id)

A correlation ID that should be returned back to the caller to indicate the return of the given request.

True

Accept

string

(Accept)

Accept Header

False

Accept-Charset

string

(Accept-Charset)

Accept-Charset Header

False

Accept-Encoding

string

(Accept-Encoding)

Accept-Encoding Header

False

Accept-Language

string

(Accept-Language)

Accept-Language Header

False

If-Match

string

(If-Match)

If-Match Header

False

If-None-Match

string

(If-None-Match)

If-None-Match Header

False

Prefer

string

(Prefer)Values: [return=representation, return=minimal]

Preference of the customer

False

Request-Id

string

(Request Id)

Format - guid. A correlation ID that should be returned back to the caller to indicate the return of the given request

True

addOpportunityCommentRequest

AddOpportunityCommentRequest

False

Name

Type

Summary

Required

Related Action

client_id

string

(Client Id)

A client ID that should be unique to developer/solution provider building the solution.

True

client_secret

string

(Client Secret)

A client secret that should be unique to developer/solution provider building the solution.

True

subscription_id

string

(Subscription Id)

A correlation ID that should be returned back to the caller to indicate the return of the given request.

True

Accept

string

(Accept)

Accept Header

False

Accept-Charset

string

(Accept-Charset)

Accept-Charset Header

False

Accept-Encoding

string

(Accept-Encoding)

Accept-Encoding Header

False

Accept-Language

string

(Accept-Language)

Accept-Language Header

False

If-Match

string

(If-Match)

If-Match Header

False

If-None-Match

string

(If-None-Match)

If-None-Match Header

False

Prefer

string

(Prefer)Values: [return=representation, return=minimal]

Preference of the customer

False

Request-Id

string

(Request Id)

Format - guid. A correlation ID that should be returned back to the caller to indicate the return of the given request

True

addOpportunityTradeInRequest

AddOpportunityTradeInRequest

False

Name

Type

Summary

Required

Related Action

tradeInId

string

(TradeIn Id)

Format - uuid.

True

client_id

string

(Client Id)

A client ID that should be unique to developer/solution provider building the solution.

True

client_secret

string

(Client Secret)

A client secret that should be unique to developer/solution provider building the solution.

True

subscription_id

string

(Subscription Id)

A correlation ID that should be returned back to the caller to indicate the return of the given request.

True

Accept

string

(Accept)

Accept Header

False

Accept-Charset

string

(Accept-Charset)

Accept-Charset Header

False

Accept-Encoding

string

(Accept-Encoding)

Accept-Encoding Header

False

Accept-Language

string

(Accept-Language)

Accept-Language Header

False

If-Match

string

(If-Match)

If-Match Header

False

If-None-Match

string

(If-None-Match)

If-None-Match Header

False

Prefer

string

(Prefer)Values: [return=representation, return=minimal]

Preference of the customer

False

Request-Id

string

(Request Id)

Format - guid. A correlation ID that should be returned back to the caller to indicate the return of the given request

True

Name

Type

Summary

Required

Related Action

client_id

string

(Client Id)

A client ID that should be unique to developer/solution provider building the solution.

True

client_secret

string

(Client Secret)

A client secret that should be unique to developer/solution provider building the solution.

True

subscription_id

string

(Subscription Id)

A correlation ID that should be returned back to the caller to indicate the return of the given request.

True

Accept

string

(Accept)

Accept Header

False

Accept-Charset

string

(Accept-Charset)

Accept-Charset Header

False

Accept-Encoding

string

(Accept-Encoding)

Accept-Encoding Header

False

Accept-Language

string

(Accept-Language)

Accept-Language Header

False

If-Match

string

(If-Match)

If-Match Header

False

If-None-Match

string

(If-None-Match)

If-None-Match Header

False

Prefer

string

(Prefer)Values: [return=representation, return=minimal]

Preference of the customer

False

Request-Id

string

(Request Id)

Format - guid. A correlation ID that should be returned back to the caller to indicate the return of the given request

True

addOpportunityVehicleSoughtRequest

AddOpportunityVehicleSoughtRequest

False

Name

Type

Summary

Required

Related Action

vehicleSoughtId

string

(Vehicle Sought Id)

Format - uuid.

True

client_id

string

(Client Id)

A client ID that should be unique to developer/solution provider building the solution.

True

client_secret

string

(Client Secret)

A client secret that should be unique to developer/solution provider building the solution.

True

subscription_id

string

(Subscription Id)

A correlation ID that should be returned back to the caller to indicate the return of the given request.

True

Accept

string

(Accept)

Accept Header

False

Accept-Charset

string

(Accept-Charset)

Accept-Charset Header

False

Accept-Encoding

string

(Accept-Encoding)

Accept-Encoding Header

False

Accept-Language

string

(Accept-Language)

Accept-Language Header

False

If-Match

string

(If-Match)

If-Match Header

False

If-None-Match

string

(If-None-Match)

If-None-Match Header

False

Prefer

string

(Prefer)Values: [return=representation, return=minimal]

Preference of the customer

False

Request-Id

string

(Request Id)

Format - guid. A correlation ID that should be returned back to the caller to indicate the return of the given request

True

Name

Type

Summary

Required

Related Action

client_id

string

(Client Id)

A client ID that should be unique to developer/solution provider building the solution.

True

client_secret

string

(Client Secret)

A client secret that should be unique to developer/solution provider building the solution.

True

subscription_id

string

(Subscription Id)

A correlation ID that should be returned back to the caller to indicate the return of the given request.

True

Accept

string

(Accept)

Accept Header

False

Accept-Charset

string

(Accept-Charset)

Accept-Charset Header

False

Accept-Encoding

string

(Accept-Encoding)

Accept-Encoding Header

False

Accept-Language

string

(Accept-Language)

Accept-Language Header

False

If-Match

string

(If-Match)

If-Match Header

False

If-None-Match

string

(If-None-Match)

If-None-Match Header

False

Prefer

string

(Prefer)Values: [return=representation, return=minimal]

Preference of the customer

False

Request-Id

string

(Request Id)

Format - guid. A correlation ID that should be returned back to the caller to indicate the return of the given request

True

reassignPrimarySalesPersonRequest

ReassignPrimarySalesPersonRequest

False

Name

Type

Summary

Required

Related Action

client_id

string

(Client Id)

A client ID that should be unique to developer/solution provider building the solution.

True

client_secret

string

(Client Secret)

A client secret that should be unique to developer/solution provider building the solution.

True

subscription_id

string

(Subscription Id)

A correlation ID that should be returned back to the caller to indicate the return of the given request.

True

Accept

string

(Accept)

Accept Header

False

Accept-Charset

string

(Accept-Charset)

Accept-Charset Header

False

Accept-Encoding

string

(Accept-Encoding)

Accept-Encoding Header

False

Accept-Language

string

(Accept-Language)

Accept-Language Header

False

If-Match

string

(If-Match)

If-Match Header

False

If-None-Match

string

(If-None-Match)

If-None-Match Header

False

Prefer

string

(Prefer)Values: [return=representation, return=minimal]

Preference of the customer

False

Request-Id

string

(Request Id)

Format - guid. A correlation ID that should be returned back to the caller to indicate the return of the given request

True

reassignPrimaryBDCAgentRequest

ReassignPrimaryBDCAgentRequest

False

Name

Type

Summary

Required

Related Action

opportunityId

string

(Opportunity Id)

Format - uuid.

True

client_id

string

(Client Id)

A client ID that should be unique to developer/solution provider building the solution.

True

client_secret

string

(Client Secret)

A client secret that should be unique to developer/solution provider building the solution.

True

subscription_id

string

(Subscription Id)

A correlation ID that should be returned back to the caller to indicate the return of the given request.

True

Accept

string

(Accept)

Accept Header

False

Accept-Charset

string

(Accept-Charset)

Accept-Charset Header

False

Accept-Encoding

string

(Accept-Encoding)

Accept-Encoding Header

False

Accept-Language

string

(Accept-Language)

Accept-Language Header

False

If-Match

string

(If-Match)

If-Match Header

False

If-None-Match

string

(If-None-Match)

If-None-Match Header

False

Prefer

string

(Prefer)Values: [return=representation, return=minimal]

Preference of the customer

False

Request-Id

string

(Request Id)

Format - guid. A correlation ID that should be returned back to the caller to indicate the return of the given request

True

salesperson

Salesperson

False

Name

Type

Summary

Required

Related Action

opportunityId

string

(Opportunity Id)

Format - uuid.

True

client_id

string

(Client Id)

A client ID that should be unique to developer/solution provider building the solution.

True

client_secret

string

(Client Secret)

A client secret that should be unique to developer/solution provider building the solution.

True

subscription_id

string

(Subscription Id)

A correlation ID that should be returned back to the caller to indicate the return of the given request.

True

Accept

string

(Accept)

Accept Header

False

Accept-Charset

string

(Accept-Charset)

Accept-Charset Header

False

Accept-Encoding

string

(Accept-Encoding)

Accept-Encoding Header

False

Accept-Language

string

(Accept-Language)

Accept-Language Header

False

If-Match

string

(If-Match)

If-Match Header

False

If-None-Match

string

(If-None-Match)

If-None-Match Header

False

Prefer

string

(Prefer)Values: [return=representation, return=minimal]

Preference of the customer

False

Request-Id

string

(Request Id)

Format - guid. A correlation ID that should be returned back to the caller to indicate the return of the given request

True

removeOpportunitySalespersonRequest

RemoveOpportunitySalespersonRequest

False

Name

Type

Summary

from

string

Sender's Email address

recipients

array of (string)

A collection of recipient email addresses

carbonCopies

array of (string)

A collection of carbon copy email addresses

subject

string

Subject of the email

body

string

Body of the email

isHtml

boolean

Is the body in HTML format?

Name

Type

Summary

opportunityId

string(uuid)

Unique identifier of the opportunity

comment

string

Comments to be added to the specified opportunity

Name

Type

Summary

opportunityId

string(uuid)

Unique identifier for the opportunity

year

integer(int32)

Year of this vehicle trade-in

make

string

Make of this vehicle trade-in

model

string

Model of this vehicle trade-in

trim

string

Trim of this vehicle trade-in

vin

string

VIN of this vehicle trade-in

estimatedMileage

integer(int32)

Estimated mileage of this vehicle trade-in

interiorColor

string

Interior color of this vehicle trade-in

exteriorColor

string

Exterior color of this vehicle trade-in

Name

Type

Summary

isNew

boolean

true/false whether the vehicle sought is new

yearFrom

integer(int32)

Starting year range for this vehicle sought

yearTo

integer(int32)

Ending year range for this vehicle sought

make

string

Make of the vehicle sought

model

string

Model of the vehicle sought

trim

string

Trim of the vehicle sought

vin

string

VIN of the vehicle sought

priceFrom

number(double)

Starting price range of the vehicle sought

priceTo

number(double)

Ending price range of the vehicle sought

maxMileage

integer(int32)

Max mileage of the vehicle sought

stockNumber

string

Stock number of the vehicle sought

isPrimary

boolean

true/false whether this vehicle sought is the primary for the specified opportunity

Name

Type

Summary

opportunityId

string(uuid)

Unique opportunity identifier

isNew

boolean

true/false whether the vehicle sought is new

yearFrom

integer(int32)

Starting year range for this vehicle sought

yearTo

integer(int32)

Ending year range for this vehicle sought

make

string

Make of the vehicle sought

model

string

Model of the vehicle sought

trim

string

Trim of the vehicle sought

vin

string

VIN of the vehicle sought

priceFrom

number(double)

Starting price range of the vehicle sought

priceTo

number(double)

Ending price range of the vehicle sought

maxMileage

integer(int32)

Max mileage of the vehicle sought

stockNumber

string

Stock number of the vehicle sought

isPrimary

boolean

true/false whether this vehicle sought is the primary for the specified opportunity

Name

Type

Summary

year

integer(int32)

Year of this vehicle trade-in

make

string

Make of this vehicle trade-in

model

string

Model of this vehicle trade-in

trim

string

Trim of this vehicle trade-in

vin

string

VIN of this vehicle trade-in

estimatedMileage

integer(int32)

Estimated mileage of this vehicle trade-in

interiorColor

string

Interior color of this vehicle trade-in

exteriorColor

string

Exterior color of this vehicle trade-in

Name

Type

Summary

customerId

string(uuid)

Unique identifier of the customer

dateIn

string(date-time)

Date and time that the opportunity came in

source

string

Source name for this opportunity

subSource

string

Subsource name for this opportunity

status

string

Current status of this opportunity

subStatus

string

Substatus of this opportunity

upType

string

Up type for this opportunity  Values: [Unknown, Campaign, Internet, Phone, Showroom]

comments

string

soughtVehicles

array of (AddOpportunityVehicleSought)

A collection of vehicles sought for this opportunity

tradeIns

array of (AddOpportunityVehicleTradeIn)

A collection of vehicle trade-ins for this opportunity

salesSteps

array of (SalesStep)

A collection of sales steps for this opportunity

salesTeam

array of (Salesperson)

A collection of sales team members and their positions associated with this opportunity

Name

Type

Summary

opportunity

Opportunity

isDuplicate

boolean

true/false whether the given opportunity was determined to be a duplicate

opportunityActivityId

string(uuid)

Unique identifier of the activity for the specified opportunity

Name

Type

Summary

href

string

The target URI

rel

string

The link relation type

method

string

The HTTP verb that MUST be used to make a request to the target of the link

title

string

The title that describes the object

Name

Type

Summary

id

string(uuid)

Unique identifier for this opportunity

customer

OpportunityCustomer

dateIn

string(date-time)

Date and time that the opportunity came in

source

string

Source name for this opportunity

subSource

string

Subsource name for this opportunity

status

string

Current status of this opportunity

subStatus

string

Substatus of this opportunity

upType

string

Up type for this opportunity  Values: [Unknown, Campaign, Internet, Phone, Showroom]

soughtVehicles

array of (OpportunityVehicleSought)

A collection of vehicles sought for this opportunity

tradeIns

array of (OpportunityVehicleTradeIn)

A collection of vehicle trade-ins for this opportunity

salesTeam

array of (OpportunitySalesperson)

A collection of sales team members and their positions for this opportunity

links

array of (LinkDescriptionObject)

A collection of HATEOAS links for this opportunity

Name

Type

Summary

id

string(uuid)

Unique identifier for this customer

links

array of (LinkDescriptionObject)

A collection of HATEOAS links for this customer

Name

Type

Summary

id

string(uuid)

Unique identifier of this salesperson

firstName

string

First name of this salesperson

lastName

string

Last name of this salesperson

isPrimary

boolean

true/false whether this is the primary salesperson for the given opportunity

isPositionPrimary

boolean

true/false whether this is the primary salesperson for this position on the given opportunity

positionName

string

Position name for this salesperson on the given opportunity

positionCode

string

Position code for this salesperson on the given opportunity

links

array of (LinkDescriptionObject)

A collection of HATEOAS links for this salesperson

Name

Type

Summary

id

string(uuid)

Unique identifier for this vehicle sought

isNew

boolean

true/false whether the vehicle sought is new

yearFrom

integer(int32)

Starting year range for this vehicle sought

yearTo

integer(int32)

Ending year range for this vehicle sought

make

string

Make of the vehicle sought

model

string

Model of the vehicle sought

trim

string

Trim of the vehicle sought

vin

string

VIN of the vehicle sought

priceFrom

number(double)

Starting price range of the vehicle sought

priceTo

number(double)

Ending price range of the vehicle sought

maxMileage

integer(int32)

Max mileage of the vehicle sought

stockNumber

string

Stock number of the vehicle sought

isPrimary

boolean

true/false whether this vehicle sought is the primary for the given opportunity

Name

Type

Summary

id

string(uuid)

Unique identifier for this vehicle trade-in

year

integer(int32)

Year of this vehicle trade-in

make

string

Make of this vehicle trade-in

model

string

Model of this vehicle trade-in

trim

string

Trim of this vehicle trade-in

vin

string

VIN of this vehicle trade-in

estimatedMileage

integer(int32)

Estimated mileage of this vehicle trade-in

interiorColor

string

Interior color of this vehicle trade-in

exteriorColor

string

Exterior color of this vehicle trade-in

Name

Type

Summary

opportunityId

string(uuid)

Unique identifier for the specific opportunity

primaryBDCAgentId

string(uuid)

Unique identifier for the newly-assigned primary bdc agent

Name

Type

Summary

opportunityId

string(uuid)

Unique identifier for the specific opportunity

salesPersonId

string(uuid)

Unique identifier for the newly-assigned primary salesperson

Name

Type

Summary

salespersonId

string(uuid)

Unique identifier of the salesperson

positionCode

string

Position code for this salesperson on the given opportunity

Name

Type

Summary

id

string(uuid)

Unique identifier of this salesperson

isPrimary

boolean

true/false whether this is the primary salesperson for the given opportunity

isPositionPrimary

boolean

true/false whether this is the primary salesperson for this position on the given opportunity

positionCode

string

Position code for this salesperson on the given opportunity

Name

Type

Summary

name

string

Name of the sales step

Name

Type

Summary

items

array of (Opportunity)

A collection of opportunities

totalItems

integer(int32)

Total number of opportunities for the given query

totalPages

integer(int32)

Total number of pages of opportunities for the given query

pageNumber

integer(int32)

Current page number for this set of paged results

pageSize

integer(int32)

Page size for this set of paged results

links

array of (LinkDescriptionObject)

A collection of HATEOAS links

Name

Type

Summary

items

array of (Opportunity)

A collection of opportunities

totalItems

integer(int32)

Total number of opportunities for the given query

totalPages

integer(int32)

Total number of pages of opportunities for the given query

pageNumber

integer(int32)

Current page number for this set of paged results

pageSize

integer(int32)

Page size for this set of paged results

links

array of (LinkDescriptionObject)

A collection of HATEOAS links

Name

Type

Summary

opportunityId

string(uuid)

Unique idenitifer of the opportunity

message

ActivityMessage

Name

Type

Summary

activityId

string(uuid)

Unique identifier of the activity