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.
- For TMF Open API release and specification version, see Industry API Version.
- For resource mappings, see TMF622 v4 Resource Mappings.
- For use cases, see TMF622 v4 Use Cases.
- For the upcoming release (Summer '25), the TMF622 v4 Product Ordering Management API will be updated. The update replaces the use of the
GlobalKey__c
with theProductCode
as the external ID for products. This change is not backward compatible. - If you are using or planning to use TMF 622 v4, then post Summer ‘25, you will need to ensure that the client application uses
ProductCode
as external ID. - Updated documentation will be published by Summer '25.
TMF622 resources are available as static resources. Import the TMF622 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/v57.0/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 API available resources and API endpoints. See TMF622 v4 Resource Mappings and TMF622 API Endpoints.
- Based on the requirements, extend and customize TMF622 API. Extend the TMF622 API.