TMF622 v4 Product Ordering Management API

The Product Ordering API (TMF622) provides a standardized mechanism for placing a product order with all of the necessary order parameters. The API consists of a simple set of operations that interact with CRM/Order negotiation systems in a consistent manner. A product order is created based on a product offering that is defined in a catalog. The product offering identifies the product or set of products that are available to a customer, and includes characteristics such as pricing, product options and market.

The Product Ordering API is certified by TM Forum.
Certification

For TMF Open API release and specification version, see Industry API Version.

From Summer'25 release, you will need to ensure that the client application uses ProductCode as external ID.
Replace the use of the GlobalKey__c with the ProductCode as the external ID for products. This change is not backward compatible.

For the Spring'26 and Summer'26 releases, TMF622 v4 API can be accessed using either of the following methods.

Mule Gateway: Access API through standard MuleSoft endpoints. For sample URLs, payloads, and parameter descriptions, see Reference section for details on TMF622 v4 MuleSoft endpoints.
Direct Access: Bypass Mule Gateway using Connect/Apex REST endpoints.
- See TMF622 v4 Use Cases section for sample URLs and payloads.
- See TMF622 v4 Resource Mappings section for parameter descriptions.

Starting from the Winter ’27 release, only the Direct Access option will be supported. The MuleSoft gateway option will be deprecated, and customers must update their integrations to use the Connect/Apex REST endpoints for continued access to the inbound APIs.

This API is available in the managed package.

TMF622 v4 resources are available as static resources. Import the TMF622 v4 components to your Salesforce org. See Import TMFOpenAPI Static Resources.

TMF622 v4 API uses the following URL format: {https://MyDomainLoginUrl}/services/apexrest/{namespace}/tmforum/productopenapi/v1/productorder.

To access and use the TMF622 v4 API:

Read and accept the terms and conditions of usage. See Accept Terms and Enable Access.
Authorize and use a connected app and an OAuth 2.0 authorization flow. See Authorize Access.
Trigger the API call. Refer the above section for sample URL.
Use the TMF622 v4 API available resources and API endpoints.
- See TMF622 v4 Use Cases section for sample URLs and payloads.
- See TMF622 v4 Resource Mappings section for parameter descriptions.
Based on the requirements, extend and customize TMF622 API. Extend the TMF622 v4 API.