TMF620 v4 Product Catalog Management

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

Ensure you complete these prerequisites before using the TMF620 API:

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 the TMF620 multipack and Attribute Category datapacks. See TMF620 datapacks.

Note: 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.

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.

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

TMF620 ResourceSample 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

To access and use the TMF620 API:

  1. Read and accept the terms and conditions of usage. See Accept Terms and Enable Access.
  2. Authorize and use a connected app and an OAuth 2.0 authorization flow. See Authorize Access.
  3. Trigger the API call. Refer the above table for sample URL.
  4. Use the TMF620 API available resources and API endpoints. See TMF620 Resource Mappings and TMF620 API Endpoints.
  5. Based on the requirements, extend and customize TMF620 API. Extend the TMF620 API.