CommerceDiagnosticEvent

Tracks checkout, pricing, search, and other activity within your B2B Commerce implementation to monitor events and diagnose issues. This object is available in API version 49.0 and later.

Supported Calls

describeSObjects()

Supported Subscribers

Subscriber	Supported?
Apex Triggers
Flows
Processes
Streaming API (CometD)

Streaming API Subscription Channel

/event/CommerceDiagnosticEvent

Special Access Rules

CommerceDiagnosticEvent is available only if the B2B Commerce deployed with Lightning Experience license is enabled.

Fields

Field	Details
ContextId	Type string Properties Create, Nillable Description The Key Business Domain Value in which the operation is done. For example, for Cart, the ContextId is `cartId`.
ContextId2	Type string Properties Create, Nillable Description Another field used to identify a context ID for a given operation.
ContextMap	Type string Properties Create, Nillable Description A JSON string that captures extra operational context or other diagnostic information.
CorrelationId	Type string Properties Create, Nillable Description Used to correlate client and server calls, and other async calls to Commerce subsystems. Calls can take place across several services and operations.
Count	Type int Properties Create, Nillable Description The number of records impacted by an operation.
EffectiveAccountId	Type string Properties Create, Nillable Description The Commerce Effective Account ID in the context of an operation.
ErrorCode	Type string Properties Create, Nillable Description The API error code that appears when an operation fails.
ErrorMessage	Type string Properties Create, Nillable Description The user-friendly error message that appears when an operation fails.
EventDate	Type dateTime Properties Create, Nillable Description The date when the event occurred.
EventIdentifier	Type string Properties Create, Nillable Description The unique identifier (UUID) used to identify the event.
IsRetry	Type boolean Properties Create, Defaulted on create Description Describes whether an event occurred during a retried operation (`true`), or not (`false`). Default value is `false`.
Operation	Type string Properties Create, Nillable Description The operation where the event originated. For example, `CreateCart`, `EditCart`, and `CreateOrder`.
OperationStage	Type string Properties Create, Nillable Description The stage of the operation where the event originated. This value varies depending on the operation.
OperationStatus	Type string Properties Create, Nillable Description The status of the operation. Values include: `Success` `SystemError` `AdminError` `UserError` `DependencyError`
OperationTime	Type string Properties Create, Nillable Description Duration of the operation in minutes and/or seconds.
RelatedEventIdentifier	Type string Properties Create, Nillable Description EventIdentifier (UUID) of the related event.
ReplayId	Type string Properties Nillable Description Represents an ID value that is populated by the system and refers to the position of the event in the event stream. Replay ID values aren’t guaranteed to be contiguous for consecutive events. A subscriber can store a replay ID value and use it on resubscription to retrieve missed events that are within the retention window.
ServiceName	Type string Properties Create, Nillable Description The service where the event originated. When Commerce generates the event, possible values include: `BuyerGroup` `BuyerAccount` `BuyerManagement` `Cart` `CartAsync` `Checkout` `Entitlements` `Order` `Pricing` `ProductEtl` `Products` `ReOrder` `Search` `Storefront` `Integration` `Wishlist` `ExternalManagedAccouts` `EffectiveAccountService` `EffectiveAccountUIService`
UserId	Type string Properties Create, Nillable Description The ID of the user associated with this event.
Username	Type string Properties Create, Nillable Description Reserved for future use.
WebStoreId	Type string Properties Create, Nillable Description The ID of the Webstore associated with this event.

Platform Events Developer Guide