TMF620 v4 Product Catalog Management API

The Product Catalog Management API allows the management of the entire lifecycle of the catalog elements, the consultation of catalog elements during several processes such as ordering process, campaign management, and sales management.

The Product Catalog Management API is certified by TM Forum.

Certification

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

Note

Access Methods

For the Spring’26 and Summer’26 releases, TMF620 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 TMF620 MuleSoft endpoints.
Direct Access: Bypass Mule Gateway using Connect/Apex REST endpoints.
- See TMF620 v4 Use Cases section for sample URLs and payloads.
- See TMF620 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.

Important

Available In

This API is available in the managed package.

Prerequisites

Ensure you complete these prerequisites before using the TMF620 API:

Licenses

You must have at least one of these licenses:

Permission Set Licenses for Shared Product Catalog and Industries CPQ provisioned in your Salesforce org.
A Managed Package License assigned to the API user.

Install TMF620 Datapacks

Install the TMF620 multipack and Attribute Category datapacks. See TMF620 datapacks.

In API version 57.0, the TMF620 multipack includes these TMF620 resources:

Catalog
Category
Product Offering
Product Offering Price
Product Specification

Attribute Category is a stand-alone data pack.

Import TMFOpenAPI Static Resources

If you are using Salesforce API version 58.0 and later, TMF620 API are available as static resources. Import the TMF620 static resources to your Salesforce org. See Import TMFOpenAPI Static Resources.

Sample Apex URL (Direct Access Method)

Refer the following table, which lists sample URL for the respective TMF620 API resources.

TMF620 Resource	Sample URL
Catalog	{https://yourInstance.salesforce.com}/services/apexrest/{namespace}/tmforum/productopenapi/v1/catalog
Category	{https://yourInstance.salesforce.com}/services/apexrest/{namespace}/tmforum/productopenapi/v1/category
Product Offering	{https://yourInstance.salesforce.com}/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOffering
Product Offering Price	{https://yourInstance.salesforce.com}/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOfferingPrice
Product Specification	{https://yourInstance.salesforce.com}/services/apexrest/{namespace}/tmforum/productopenapi/v1/productSpecification

Use TMF620 v4 API

To access and use the TMF620 v4 API:

Authorize and use a connected app and an OAuth 2.0 authorization flow. See Authorize Access.
Trigger the API call. Refer the above table for sample URL.
Use the TMF620 API available resources and API endpoints.
- See TMF620 v4 Use Cases section for sample URLs and payloads.
- See TMF620 v4 Resource Mappings section for parameter descriptions.
Based on the requirements, extend and customize TMF620 API. Extend the TMF620 API.