TMF637 v4 Product Inventory Management - Outbound Notification
Use TMF637 to retrieve product inventory information. Outbound notifications are triggered for these events. They are triggered only for the parent entity (Asset entity).
/api/notification/productCreateEvent/api/notification/productAttributeValueChangeEvent/api/notification/productStateChangeEvent(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.
- 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.
- Lifecycle Management license with AssetLifecycleManagementAddon.
- Org Perm check: IndustriesCPQService
- 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 product resource and the supported related sub-resources, for all events.
- OAuth authentication method used to access the target systems.
- 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.
- TMF637 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.
- 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.
This is a sample payload sent to the target system endpoint for the event Type: ProductCreateEvent.
The event notification payload is same for all three events (ProductCreateEvent, ProductAttributeValueChangeEvent, ProductAttributeValueChangeEvent). The eventType value will differ between the three events.
| 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 | ProductCreateEvent or ProductAttributeValueChangeEvent or ProductStateChangeEvent |
| correlationId | string | No | TRUE | inputPayload.correlationId |
| timeOcurred | string | No | TRUE | inputPayload.commitTimestamp as UTC |
| event.product | object | Yes | TRUE | TMF637v4 Inbound response payload |