How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
TM Forum

TM Forum Product Offering API

Operations for ProductOffering Resource

Documentation Provider Profile APIs.io OpenAPI GitHub

TM Forum Product Offering API is one of 38 APIs that TM Forum publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 2 paths, and defines 121 schemas. It is described by OpenAPI 3.2.0, at version 5.0.0.

Requests are made against a single base URL, https://serverRoot/productCatalogManagement/v5/.

5 operations 2 paths 121 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
5.0.0
Server
https://serverRoot/productCatalogManagement/v5/
Resource Areas
1

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

productOffering 5

Operations for ProductOffering Resource

GET
/productOffering
TM Forum List or Find ProductOffering Objects
listProductOffering 3 params → 200400401403404405500501
POST
/productOffering
TM Forum Creates a ProductOffering
createProductOffering 1 param body → 201202400401403404405409
GET
/productOffering/{id}
TM Forum Retrieves a ProductOffering by ID
retrieveProductOffering 2 params → 200400401403404405500501
PATCH
/productOffering/{id}
TM Forum Updates Partially a ProductOffering
patchProductOffering 2 params body → 200202400401403404405409
DELETE
/productOffering/{id}
TM Forum Deletes a ProductOffering
deleteProductOffering 1 param → 202204400401403404405409

Schemas 121

The contract defines 121 schemas that model the data the API accepts and returns. The most detailed are JsonPatch (4 properties), Extensible_FVO (3 properties), Extensible (3 properties), Money (2 properties). Each schema is shown below with its type and property counts.

AttachmentRefOrValue
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the Attachment entity and not the AttachmentRefOrValue class itself
ProductSpecificationCharacteristicValueUse_MVO
ProductOfferingPriceRelationship_FVO
PlaceRef_FVO
object
Place reference.
EntityRef
BundledGroupProductOffering
Addressable_FVO
object
Base schema for adressable entities
1 property
PricingLogicAlgorithm
ProductOfferingRef_MVO
ProductOfferingRelationship_MVO
BundledProductOffering_FVO
AllowedProductAction_MVO
ResourceCandidateRef
MarketSegmentRef_MVO
object
provides references to the corresponding market segment as target of product offerings. A market segment is grouping of Parties, GeographicAreas, SalesChannels…
ProductSpecificationRef_FVO
ResourceCandidateRef_MVO
Entity
object
Base entity schema for use in TMForum Open-APIs. Property.
BundledProductOfferingOption
BundledGroupProductOfferingOption_MVO
ExternalIdentifier
AgreementRef_FVO
object
Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agre…
Extensible
object
Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
3 properties 1 required
ProductOfferingPriceRelationship_MVO
SLARef
object
ServiceLevelAgreement reference: A service level agreement (SLA) is a type of agreement that represents a formal negotiated agreement between two parties desig…
BundledGroupProductOffering_MVO
CategoryRef_FVO
ProductSpecificationCharacteristicValueUse_FVO
ProductOfferingTerm
ProductOffering_MVO
ChannelRef_MVO
object
The channel to which the resource reference to. e.g. channel for selling product offerings, channel for opening a trouble ticket etc..
EntityRef_FVO
ProductSpecificationRef_MVO
ServiceCandidateRef
ProductOfferingRef
SLARef_MVO
object
ServiceLevelAgreement reference: A service level agreement (SLA) is a type of agreement that represents a formal negotiated agreement between two parties desig…
ProductOfferingPriceRef
Attachment
TaxItem_FVO
ProductOfferingPriceRefOrValue
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the ProductOfferingPrice entity and not the ProductOfferingPriceRefOrValue cla…
ProductOfferingPriceRefOrValue_MVO
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the ProductOfferingPrice entity and not the ProductOfferingPriceRefOrValue cla…
ProductOfferingRef_FVO
PlaceRef
object
Place reference.
AgreementRef
object
Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agre…
JsonPatch
object
A JSONPatch document as defined by RFC 6902
4 properties 2 required
CharacteristicValueSpecification
ProductOfferingPriceRef_FVO
TimePeriod
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
ProductOffering
ChannelRef
object
The channel to which the resource reference to. e.g. channel for selling product offerings, channel for opening a trouble ticket etc..
PricingLogicAlgorithm_FVO
ProductOfferingPrice_FVO
PlaceRef_MVO
object
Place reference.
ChannelRef_FVO
object
The channel to which the resource reference to. e.g. channel for selling product offerings, channel for opening a trouble ticket etc..
AttachmentRef_MVO
ProductOfferingPrice_MVO
ServiceCandidateRef_FVO
CharacteristicValueSpecification_MVO
BundledGroupProductOfferingOption
BundledProductOfferingPriceRelationship_FVO
ProductOfferingPriceRelationship
SLARef_FVO
object
ServiceLevelAgreement reference: A service level agreement (SLA) is a type of agreement that represents a formal negotiated agreement between two parties desig…
TaxItem_MVO
ExternalIdentifier_FVO
TargetProductSchema
object
The reference object to the schema and type of target product which is described by product specification
2 properties
BundledProductOfferingPriceRelationship_MVO
AttachmentRef_FVO
BundledProductOfferingOption_FVO
BundledProductOfferingPriceRelationship
ProductSpecificationCharacteristicValueUse
CategoryRef_MVO
CharacteristicSpecificationRelationship
TargetProductSchema_MVO
object
The reference object to the schema and type of target product which is described by product specification
2 properties
ProductOfferingTerm_MVO
Error
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
BundledGroupProductOffering_FVO
ExternalIdentifier_MVO
AllowedProductAction_FVO
BundledProductOffering
Entity_FVO
object
Base entity schema for use in TMForum Open-APIs. Property.
JsonPatchOperations
array
JSONPatch Operations document as defined by RFC 6902
ProductOffering_FVO
CategoryRef
CharacteristicSpecification
CharacteristicValueSpecification_FVO
BundledProductOffering_MVO
CharacteristicSpecificationRelationship_MVO
Attachment_FVO
Addressable
object
Base schema for adressable entities
2 properties
Money
object
A base / value business entity used to represent money
2 properties
BundledGroupProductOfferingOption_FVO
CharacteristicSpecification_MVO
MarketSegmentRef_FVO
object
provides references to the corresponding market segment as target of product offerings. A market segment is grouping of Parties, GeographicAreas, SalesChannels…
ProductOfferingPriceRef_MVO
TargetProductSchema_FVO
object
The reference object to the schema and type of target product which is described by product specification
2 properties 2 required
ProductSpecificationRef
ProductOfferingPrice
Extensible_FVO
object
Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
3 properties 1 required
TaxItem
Quantity
object
An amount in a given unit
2 properties
AgreementRef_MVO
object
Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agre…
BundledProductOfferingOption_MVO
Attachment_MVO
Entity_MVO
object
Base entity schema for use in TMForum Open-APIs. Property.
MarketSegmentRef
object
provides references to the corresponding market segment as target of product offerings. A market segment is grouping of Parties, GeographicAreas, SalesChannels…
AttachmentRef
CharacteristicSpecificationRelationship_FVO
AllowedProductAction
PricingLogicAlgorithm_MVO
AttachmentRefOrValue_FVO
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the Attachment entity and not the AttachmentRefOrValue class itself
PolicyRef
ResourceCandidateRef_FVO
CharacteristicSpecification_FVO
AttachmentRefOrValue_MVO
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the Attachment entity and not the AttachmentRefOrValue class itself
Duration
object
A time interval in a given unit of time
2 properties
ProductOfferingRelationship_FVO
PolicyRef_FVO
ProductOfferingTerm_FVO
ProductOfferingRelationship
PolicyRef_MVO
ServiceCandidateRef_MVO
ProductOfferingPriceRefOrValue_FVO
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the ProductOfferingPrice entity and not the ProductOfferingPriceRefOrValue cla…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tm-forum-productoffering-api-openapi.yml Raw ↑

Other APIs TM Forum publishes across the network.

TM Forum Agreement API
AE Profile APIs.io
TM Forum Agreement Specification API
AE Profile APIs.io
TM Forum Bill Format API
AE Profile APIs.io
TM Forum Billing Cycle Specification API
AE Profile APIs.io
TM Forum Bill Presentation Media API
AE Profile APIs.io
TM Forum Cancel Product Order API
AE Profile APIs.io
TM Forum Cancel Service Order API
AE Profile APIs.io
TM Forum Category API
AE Profile APIs.io
TM Forum Customer API
AE Profile APIs.io
TM Forum events subscription API
AE Profile APIs.io
TM Forum Individual API
AE Profile APIs.io
TM Forum notification listener API
AE Profile APIs.io
← Back to T APIs
API Details
ID
tm-forum:tm-forum-productoffering-api
Server
https://serverRoot/productCatalogManagement/v5/
Docs
https://www.tmforum.org/resources/specification/tmf620-product-catalog-management-api-rest-specification-r17-5-0/
Provider
TM Forum
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=tm-forum-productoffering-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/tm-forum-productoffering-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of TM Forum Product Offering API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.