TMF622 v4 Product Ordering Management - Outbound Notification

Use TMF622 Outbound Notification API to automatically send a request to an external service order system when a product order is evaluated and decomposed. This converts the product order into a service order for orchestration and provisioning.
Outbound notifications can be configured to be triggered for change events on the parent entity (Order) as well as for relevant sub-resources, see Supported Sub-Resources for TMF Outbound Notifications for the list of supported sub-resources in scope.

/api/notification/productOrderCreateEvent
/api/notification/productOrderAttributeValueChangeEvent
/api/notification/productOrderStatusChangeEvent (status field)

The user must configure the notification framework to detect CDC events and invoke the relevant TMF Open API implementations that generate the event payloads and forward them to the target systems configured within the API.

This API has been tested with an external system using TMF-aligned customizations. It may not include all optional fields and may not work out-of-the-box with your system. Customizations will likely be required. We recommend a thorough evaluation to ensure it meets your specific needs.

Note

Available In

This API is available in the managed package.

Prerequisites

MuleSoft License required: MuleSoft Direct for Communications Cloud (add-on for Communications Cloud) or MuleSoft Anypoint Base Subscription.
Communications cloud license required: Communications Cloud Growth.
Org Perm check: IndustriesCPQService

Assumptions

The notification uses a fire-and-forget approach. Salesforce does not process or store the response in any objects. MuleSoft logs and tracks all received notifications.
In alignment with TMF v4 standards for event notifications, the system sends the same payload, which includes the full productOrder resource and the supported related sub-resources, for all events.
Access to the target system is authenticated using the OAuth 2.0 Client Credentials grant type.
In case of failure when invoking the target system endpoint, the request is retried up to three times, with a two second interval between attempts.
TMF622 v4 Inbound API response may include optional fields. According to TMF specifications, if the outbound Event Notification payload contains unsupported optional parameters, the downstream system may reject it with a 4xx error. To avoid this, tailor the payload to include only the optional fields supported by the client.
Priority will be given to OrderItem.AttributeSelectedValues__c. If the V2 model is disabled, OrderItem.vlocity_cmt__JSONAttribute__c will be used instead.
Salesforce and MuleSoft do not have a centralized event hub configured by default. Customers are responsible for setting up their own event hub to manage subscribers. Outbound notifications are generated and sent directly to a single, client-defined target endpoint.

The following table summarizes the change events supported for the Order entity, along with the required configurations to trigger them through the Notification Framework.

When configuring Object Integration Definitions, ensure you use the exact RelatedFieldName values provided in the table below.

Important

TMF Resource	Salesforce Entity	Scenario	changeEventType Supported	Notification Event Path	RelatedFieldName
ProductOrder	Order	Creation of a new Order record	Create	`/api/notification/productOrderCreateEvent`	”RelatedFieldName”:“OrderNumber”
		Updates to attributes of an existing Order record	Update	`/api/notification/productOrderAttributeValueChangeEvent`	”RelatedFieldName”:“OrderNumber”
		Updates to the Order.Status attribute	Update	`/api/notification/productOrderStateChangeEvent`	”RelatedFieldName”:“OrderNumber”

Sample Outbound Notification Request

This is a sample payload sent to the target system endpoint for the event Type: ProductOrderCreateEvent.

The event notification payload is same for all three events (ProductOrderCreateEvent, ProductOrderAttributeValueChangeEvent, ProductOrderStatusChangeEvent). The eventType value will differ between the three events.

Note

1{
2  "id": "31bfbd00-51c2-11f0-b574-02cdb84f0a4b",
3  "eventId": "000008b8-8d4c-ff0f-b1dd-21c3495e7ca0_1",
4  "eventTime": "2025-06-25T12:44:51Z",
5  "eventType": "ProductOrderCreateEvent",
6  "correlationId": "000008b8-8d4c-ff0f-b1dd-21c3495e7ca0",
7  "timeOccurred": "2025-06-25T12:44:51Z",
8  "event": {
9    "productOrder": {
10      "PageInfo": "Page 1",
11      "PageSize": 50,
12      "result": {
13        "description": "Product Order illustration sample",
14        "id": "00000449",
15        "orderDate": "2025-06-25T12:44:47.000+0000",
16        "requestedCompletionDate": "2019-05-02T00:00:00.000+0000",
17        "requestedStartDate": "2019-05-03T00:00:00.000+0000",
18        "state": "Draft",
19        "relatedParty": [
20          {
21            "@type": "RelatedParty",
22            "id": "123457",
23            "name": "Emma Williams"
24          }
25        ],
26        "productOrderItem": [
27          {
28            "@type": "ProductOrderItem",
29            "action": "Add",
30            "id": "100",
31            "orderLineItemId": "802LT000014NVrVYAW",
32            "quantity": 1,
33            "productOrderItemRelationship": [
34              {
35                "id": "101",
36                "relationshipType": "bundles"
37              },
38              {
39                "id": "102",
40                "relationshipType": "bundles"
41              },
42              {
43                "id": "103",
44                "relationshipType": "bundles"
45              }
46            ],
47            "productOffering": {
48              "id": "Home_Office_Bundle_89927"
49            }
50          },
51          {
52            "@type": "ProductOrderItem",
53            "action": "Add",
54            "id": "101",
55            "orderLineItemId": "802LT000014NVrWYAW",
56            "quantity": 1,
57            "productOffering": {
58              "id": "Desk_89927"
59            }
60          },
61          {
62            "@type": "ProductOrderItem",
63            "action": "Add",
64            "id": "102",
65            "orderLineItemId": "802LT000014NVrXYAW",
66            "quantity": 1,
67            "productOffering": {
68              "id": "Chair_89927"
69            }
70          },
71          {
72            "@type": "ProductOrderItem",
73            "action": "Add",
74            "id": "103",
75            "orderLineItemId": "802LT000014NVrYYAW",
76            "quantity": 1,
77            "productOrderItemRelationship": [
78              {
79                "id": "104",
80                "relationshipType": "bundles"
81              }
82            ],
83            "productOffering": {
84              "id": "Peripheral_Kit_89927"
85            }
86          },
87          {
88            "@type": "ProductOrderItem",
89            "action": "Add",
90            "id": "104",
91            "orderLineItemId": "802LT000014NVrZYAW",
92            "quantity": 1,
93            "productOffering": {
94              "id": "Mouse_89927"
95            },
96            "product": {
97              "productCharacteristic": [
98                {
99                  "name": "Wireless",
100                  "value": false
101                },
102                {
103                  "name": "Phone_Color_98324"
104                }
105              ]
106            }
107          }
108        ],
109        "note": [
110          {
111            "author": "Jean Pontus",
112            "date": "2019-04-30T08:13:59.509Z",
113            "id": "1",
114            "text": "This is a TMF product order illustration"
115          }
116        ],
117        "channel": [
118          {
119            "id": "1",
120            "name": "Online chanel",
121            "role": "Used channel for order capture"
122          }
123        ]
124      }
125    }
126  }
127}

Outbound Event Notifications Field Mappings

TMF Field	TMF Type	Is it Mandatory ?	Supported	Mappings
id	string	No	TRUE	Mule correlation Id
eventId	string	No	TRUE	inputPayload.eventId
eventTime	string	No	TRUE	inputPayload.commitTimestamp as UTC
eventType	string	No	TRUE	`ProductOrderCreateEvent` or `ProductOrderAttributeValueChangeEvent` or `ProductOrderStateChangeEvent`
correlationId	string	No	TRUE	inputPayload.correlationId
timeOccurred	string	No	TRUE	inputPayload.commitTimestamp as UTC
event.productOrder	object	Yes	TRUE	TMF622 v4 Inbound response payload

Supported Sub-Resources for TMF Outbound Notifications

This section outlines the sub-resources within TMF622 for which outbound notifications can be configured for create, update, and delete operations.

Refer to Assumptions section for essential configuration guidelines and design assumptions required to enable TMF outbound notifications on these sub-resources.

Note

For each sub-resource listed below, use the RelatedFieldName specified in the table to configure the Object Integration Definition mappings. This ensures the Salesforce Notification Framework triggers notifications accurately for the corresponding change events.

TMF Sub-resource: ProductOrderItem
Salesforce entity: OrderItem

Entity Name	Notification Trigger Scenario	changeEventType	Notification Event Path	RelatedFieldName
OrderItem	Addition of an OrderItem to a new or existing Order	Create	`/api/notification/productOrderAttributeValueChangeEvent`	`Order.OrderNumber`
	Update to an existing OrderItem record associated with the Order	Update	`/api/notification/productOrderAttributeValueChangeEvent`	`Order.OrderNumber`
	Deletion of an OrderItem record associated with the parent Order	Delete	`/api/notification/productOrderAttributeValueChangeEvent`	`Order.OrderNumber`

Sample Notification framework Payload Request

Below is a sample payload when an existing OrderItem record associated with the Order is updated.

1[
2 {
3  "entityId": "802LT000014L7V7YAK",
4  "entityName": "OrderItem",
5  "eventId": "000003bf-04e1-f3b7-e4bd-a9437b775e58_1",
6  "commitTimestamp": 1750169966000,
7  "commitNumber": 1750169968435404801,
8  "correlationId": "000003bf-04e1-f3b7-e4bd-a9437b775e58",
9  "changedFields": {
10    "Quantity": "8.0"
11  },
12  "changeEventType": "Update",
13  "enrichedFields": {
14    "Order.OrderNumber": "00000437"
15  }
16}
17]

TMF Sub-resource: productOrderItemResource.productCharacteristic
Salesforce entity: OrderItem

This sub-resource supports update notifications specifically for changes to JSON-based attributes in the OrderItem entity.

Entity Name	Notification Trigger Scenario	changeEventType	Notification Event path	RelatedFieldName
OrderItem	Updates to JSON attributes of an OrderItem assocaited with an Order	Update	`/api/notification/productOrderAttributeValueChangeEvent`	`Order.OrderNumber`

Update event notifications must be configured based on the selected model: Use OrderItem.vlocity_cmt__JSONAttribute__c if the V2 model is enabled, or OrderItem.AttributeSelectedValues__c if the V2 model is not enabled.