Platform Events Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Platform Events Developer Guide
Delivering Custom Notifications with Platform Events
Defining Your Custom Platform Event
Publishing Platform Events
Subscribing to Platform Events
Testing Your Platform Event in Apex
Encrypting Platform Event Messages at Rest in the Event Bus
Monitor Platform Event Publishing and Delivery Usage
Considerations
Examples
Reference
Platform Event Allocations
Platform Event Error Status Codes
Standard Platform Event Objects
Change Data Capture Events
Standard Platform Event Object List
AcademicTermGpaCalcEvent
AIPredictionEvent
AIUpdateRecordEvent
AppointmentSchedulingEvent
AssetCancelInitiatedEvent
AssetAmendInitiatedEvent
AssetRenewInitiatedEvent
AssetTokenEvent
BatchApexErrorEvent
BillingScheduleCreatedEvent
BulkApi2JobEvent (Beta)
CommerceDiagnosticEvent
ConsentEvent
ConsentUnsubscribeAllEvent
ConversationInsightEvent
CreateAssetOrderEvent
CreditInvoiceProcessedEvent
CreditMemoProcessedEvent
DataObjectDataChgEvent
DataObjectMetadataChgEvent
DatasetExportEvent
DiscoveryPredictionEvent
EmailCapturedMatchEvent
ExtlRecShrEvent
ExtlRecShrResultEvent
FirstBillPaymentSetupEvent
FlowExecutionErrorEvent
FlowOrchestrationEvent
FOStatusChangedEvent
FulfillOrdItemQtyChgEvent
InvoiceProcessedEvent
InvoiceProcPymtExclEvent
NegInvcLineProcessedEvent
OmniTrackingEvent
OrderStatusChangedEvent
OrderSummaryCreatedEvent
OrderSumStatusChangedEvent
PaymentCreationEvent
PendingOrdSumProcEvent
PlaceOrderCompletedEvent
PlatformStatusAlertEvent
ProcessExceptionEvent
QuoteSaveEvent
QuoteToOrderCompletedEvent
RealtimeAlertEvent
RemoteKeyCalloutEvent
SrcPredJobStatusChgEvent
SearchIndexJobStatusEvent
ServiceAppointmentEvent
VoidInvoiceProcessedEvent
WebCartAbandonedEvent
WebStoreUserCreatedEvent
Real-Time Event Monitoring Objects
PDF

OrderSumStatusChangedEvent

Notifies subscribers of changes to the status of an order summary record. Use this event to trigger subscribers such as flows in your order workflow. This object is available in API version 48.0 and later.

Supported Calls

describeSObjects()

Supported Subscribers

Subscriber Supported?
Apex Triggers Yes
Flows Yes
Processes Yes
Pub/Sub API Yes
Streaming API (CometD) Yes

Subscription Channel

/event/OrderSumStatusChangedEvent

Event Delivery Allocation Enforced

No

Special Access Rules

OrderSumStatusChangedEvent is available as part of Salesforce Order Management.

Fields

Field Details
EventUuid
Type
string
Properties
Nillable
Description
A universally unique identifier (UUID) that identifies a platform event message. This field is available in API version 52.0 and later.
NewStatus
Type
picklist
Properties
Defaulted on create, Nillable
Description
Required. The new value of the Status field on the OrderSummary.
Possible values are based on the OrderSummary statuses defined in your org. The default value is Created.
OldStatus
Type
picklist
Properties
Defaulted on create, Nillable
Description
Required. The previous value of the Status field on the OrderSummary.
Possible values are based on the OrderSummary statuses defined in your org. The default value is Created.
OrderId
Type
reference
Properties
Nillable
Description
ID of the original order associated with the OrderSummary.
This field is a relationship field.
Relationship Name
Order
Relationship Type
Lookup
Refers To
Order
OrderSummaryId
Type
reference
Properties
Nillable
Description
The ID of the OrderSummary that changed.
This value is functionally required, but is nillable because order summary records can be deleted to comply with data protection and privacy requirements.
This field is a relationship field.
Relationship Name
OrderSummary
Relationship Type
Lookup
Refers To
OrderSummary
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.