Quote Messages

Messages that represent a change or an action performed on a Quote Request, Staged Quote, or Quote.

Messages are available in a variety of Message Types specific to a resource. Common fields across all Message Types are represented by a base resource, Message.
You can access Messages either by querying the Messages API, or by subscribing to them with a Subscription. To query Messages using the API, you must enable the feature first.

Quote Request Messages

Messages that represent a change or an action performed on a QuoteRequest.

Quote Request Created

Generated after a successful Create QuoteRequest request.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int​

Version of the resource on which the change or action was performed.

type​
String​
"QuoteRequestCreated"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
quoteRequest​
QuoteRequest​
Quote Request that was created.
createdAt​
DateTime​

Date and time (UTC) the Message was generated.

createdBy​BETA
CreatedBy​

IDs and references that created the Message.

lastModifiedAt​
DateTime​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Quote Request State Changed

Generated after a successful Change Quote Request State update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int​

Version of the resource on which the change or action was performed.

type​
String​
"QuoteRequestStateChanged"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
quoteRequestState​
State of the Quote Request after the Change Quote Request State update action.
oldQuoteRequestState​
State of the Quote Request before the Change Quote Request State update action.
createdAt​
DateTime​

Date and time (UTC) the Message was generated.

createdBy​BETA
CreatedBy​

IDs and references that created the Message.

lastModifiedAt​
DateTime​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Quote Request State Transition

Generated after a successful Transition State update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int​

Version of the resource on which the change or action was performed.

type​
String​
"QuoteRequestStateTransition"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
state​
State of the Quote after the Transition State update action.
oldState​
State of the Quote before the Transition State update action.
force​
Boolean​
Whether State transition validations were turned off during the Transition State update action.
createdAt​
DateTime​

Date and time (UTC) the Message was generated.

createdBy​BETA
CreatedBy​

IDs and references that created the Message.

lastModifiedAt​
DateTime​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Quote Request Customer Changed

Generated after a successful Change Customer update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int​

Version of the resource on which the change or action was performed.

type​
String​
"QuoteRequestCustomerChanged"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
customer​
The Buyer who now owns the Quote Request.
previousCustomer​
The previous Buyer.
createdAt​
DateTime​

Date and time (UTC) the Message was generated.

createdBy​BETA
CreatedBy​

IDs and references that created the Message.

lastModifiedAt​
DateTime​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Quote Request Deleted

Generated after a successful Delete QuoteRequest request.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int​

Version of the resource on which the change or action was performed.

type​
String​
"QuoteRequestDeleted"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
createdAt​
DateTime​

Date and time (UTC) the Message was generated.

createdBy​BETA
CreatedBy​

IDs and references that created the Message.

lastModifiedAt​
DateTime​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Staged Quote Messages

Messages that represent a change or an action performed on a StagedQuote.

Staged Quote Created

Generated after a successful Create StagedQuote request.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int​

Version of the resource on which the change or action was performed.

type​
String​
"StagedQuoteCreated"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
stagedQuote​
StagedQuote​
Staged Quote that was created.
createdAt​
DateTime​

Date and time (UTC) the Message was generated.

createdBy​BETA
CreatedBy​

IDs and references that created the Message.

lastModifiedAt​
DateTime​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Staged Quote State Changed

Generated after a successful Change Staged Quote State update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int​

Version of the resource on which the change or action was performed.

type​
String​
"StagedQuoteStateChanged"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
stagedQuoteState​
State of the Staged Quote after the Change Staged Quote State update action.
oldStagedQuoteState​
State of the Staged Quote before the Change Staged Quote State update action.
createdAt​
DateTime​

Date and time (UTC) the Message was generated.

createdBy​BETA
CreatedBy​

IDs and references that created the Message.

lastModifiedAt​
DateTime​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Staged Quote State Transition

Generated after a successful Transition State update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int​

Version of the resource on which the change or action was performed.

type​
String​
"StagedQuoteStateTransition"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
state​
State of the Quote after the Transition State update action.
oldState​
State of the Quote before the Transition State update action.
force​
Boolean​
Whether State transition validations were turned off during the Transition State update action.
createdAt​
DateTime​

Date and time (UTC) the Message was generated.

createdBy​BETA
CreatedBy​

IDs and references that created the Message.

lastModifiedAt​
DateTime​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Staged Quote ValidTo Set

Generated after a successful Set Valid To update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int​

Version of the resource on which the change or action was performed.

type​
String​
"StagedQuoteValidToSet"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
validTo​
DateTime​
Expiration date for the Staged Quote after the Set Valid To update action.
createdAt​
DateTime​

Date and time (UTC) the Message was generated.

createdBy​BETA
CreatedBy​

IDs and references that created the Message.

lastModifiedAt​
DateTime​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Staged Quote Seller Comment Set

Generated after a successful Set Seller Comment update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int​

Version of the resource on which the change or action was performed.

type​
String​
"StagedQuoteSellerCommentSet"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
sellerComment​
String​
sellerComment on the StagedQuote after a successful Set Seller Comment update action.
createdAt​
DateTime​

Date and time (UTC) the Message was generated.

createdBy​BETA
CreatedBy​

IDs and references that created the Message.

lastModifiedAt​
DateTime​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Staged Quote Deleted

Generated after a successful Delete StagedQuote request.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int​

Version of the resource on which the change or action was performed.

type​
String​
"StagedQuoteDeleted"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
createdAt​
DateTime​

Date and time (UTC) the Message was generated.

createdBy​BETA
CreatedBy​

IDs and references that created the Message.

lastModifiedAt​
DateTime​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Quote Messages

Messages that represent a change or an action performed on a Quote.

Quote Created

Generated after a successful Create Quote request.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int​

Version of the resource on which the change or action was performed.

type​
String​
"QuoteCreated"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
quote​
Quote​
Quote that was created.
createdAt​
DateTime​

Date and time (UTC) the Message was generated.

createdBy​BETA
CreatedBy​

IDs and references that created the Message.

lastModifiedAt​
DateTime​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Quote Renegotiation Requested

Generated after a successful Request Quote Renegotiation update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int​

Version of the resource on which the change or action was performed.

type​
String​
"QuoteRenegotiationRequested"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
buyerComment​
String​
Message from the Buyer regarding the Quote renegotiation request.
createdAt​
DateTime​

Date and time (UTC) the Message was generated.

createdBy​BETA
CreatedBy​

IDs and references that created the Message.

lastModifiedAt​
DateTime​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Quote State Changed

Generated after a successful Change Quote State update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int​

Version of the resource on which the change or action was performed.

type​
String​
"QuoteStateChanged"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
quoteState​
QuoteState​
State of the Quote after the Change Quote State update action.
oldQuoteState​
QuoteState​
State of the Quote before the Change Quote State update action.
createdAt​
DateTime​

Date and time (UTC) the Message was generated.

createdBy​BETA
CreatedBy​

IDs and references that created the Message.

lastModifiedAt​
DateTime​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Quote State Transition

Generated after a successful Transition State update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int​

Version of the resource on which the change or action was performed.

type​
String​
"QuoteStateTransition"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
state​
State of the Quote after the Transition State update action.
oldState​
State of the Quote before the Transition State update action.
force​
Boolean​
Whether State transition validations were turned off during the Transition State update action.
createdAt​
DateTime​

Date and time (UTC) the Message was generated.

createdBy​BETA
CreatedBy​

IDs and references that created the Message.

lastModifiedAt​
DateTime​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Quote Customer Changed

Generated after a successful Change Customer update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int​

Version of the resource on which the change or action was performed.

type​
String​
"QuoteCustomerChanged"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
customer​
The Buyer who now owns the Quote.
previousCustomer​
The previous Buyer.
createdAt​
DateTime​

Date and time (UTC) the Message was generated.

createdBy​BETA
CreatedBy​

IDs and references that created the Message.

lastModifiedAt​
DateTime​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Quote Deleted

Generated after a successful Delete Quote request.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int​
Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.
resource​
Reference​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int​

Version of the resource on which the change or action was performed.

type​
String​
"QuoteDeleted"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
createdAt​
DateTime​

Date and time (UTC) the Message was generated.

createdBy​BETA
CreatedBy​

IDs and references that created the Message.

lastModifiedAt​
DateTime​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.