TMF637 v5 Product Inventory Management API

The Product Inventory Management API (TMF637) provides a standardized mechanism for product inventory and subscription asset management. A product represents an instance of a product offering subscribed to by a party, such as a customer. In Salesforce, these products are customer-purchased offerings stored as Asset records.

TMF637 v5 supports these operations.

Retrieve a list of product inventory records
Retrieve a single product inventory record by ID
Update the name, description, and product serial number of a product inventory record (Winter ‘27)

Out-of-the-box support is read-only for GET. POST and DELETE are not supported.

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

Note

Access Methods

Access TMF637 v5 API using Direct Access Connect REST endpoints.

See TMF637 v5 Use Cases for sample URLs and payloads.
See TMF637 v5 Resource Mappings for parameter descriptions.

Starting from the Winter ‘27 release, only the Direct Access option is supported for this API.

Important

Available In

This API is available in the Salesforce platform.

Prerequisites

The CommsCloud license must be enabled to invoke the API.
GET list and retrieve are available from Summer ‘26.
PATCH, and price alteration in the response, are available from Winter ‘27.
Grant the integration user read access to these fields.
- Asset.AccountId (Account Name)
- Asset.AssetLevel (Asset Level)
- Asset.ContactId (Contact Name)
- OrderItem.OrderActionId (Order Action)
To return order actions, enable the GlobalPromotionsMgmtBasicAddOn license and grant view access to Promotion fields and AssetActionSrcPriceAdjustment fields.
To return price alteration, enable the GlobalPrmtRevenueCloudInteg license.
If you implement Apex extensibility hooks, annotate the custom Apex class with @PermGuard('IndustriesComms.orgHasCommsTMFAPIAccess'). Exactly one Apex class may implement comms_apex_ext.IProductInventoryManagementGET per org.

Extensibility

This API uses the TMF extensibility framework. For an overview of the framework and the release when extensibility is available for each API, see Extensibility for TMF APIs.

Extensibility applies only to TMF637 v5 on the Salesforce platform, and only to GET. For extensibility features, see Extensibility for TMF637 v5 Product Inventory Management.

Sample URL (Direct Access Method)

TMF637 v5 API uses the following URL format:

{https://MyDomainLoginUrl}/services/data/{{version}}/connect/comms/productinventorymanagement/v5/productinventory.

Use TMF637 v5 API

To access and use the TMF637 v5 API:

Authorize and use a connected app and an OAuth 2.0 authorization flow. See Authorize Access.
Trigger the API call. Refer to the preceding section for the sample URL.
Use the TMF637 v5 API resources and endpoints.
- See TMF637 v5 Use Cases for sample URLs and payloads.
- See TMF637 v5 Resource Mappings for parameter descriptions.
Based on the requirements, extend TMF637 v5 GET. See Extensibility for TMF637 v5 Product Inventory Management.