TMF637 v4 Product Inventory Management API

The Product Inventory Management API (TMF637) provides a standardized mechanism to retrieve product inventory information.

TMF637 API manages Product resources, where a Product represents an instance of a Product Offering subscribed to by a party (such as a customer). In the Salesforce context, these products correspond to customer-purchased offerings that are represented as Account Assets.

The Product Inventory 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, TMF637 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 TMF637 v4 MuleSoft endpoints.
Direct Access: Bypass Mule Gateway using Connect/Apex REST endpoints.
- See TMF637 v4 Use Cases section for sample URLs and payloads.
- See TMF637 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

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

Sample Apex URL (Direct Access Method)

TMF637 API uses the following URL format: {https://MyDomainLoginUrl}/services/apexrest/{namespace}/tmforum/productopenapi/v1/product.

Use TMF637 v4 API

To access and use the TMF637 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 section for sample URL.
Use the TMF637 v4 API available resources and API endpoints.
- See TMF637 v4 Use Cases section for sample URLs and payloads.
- See TMF637 v4 Resource Mappings section for parameter descriptions.
Based on the requirements, extend and customize TMF637 v4 API. Extend the TMF637 v4 API.