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

TM Forum productOffering API

Operations for ProductOffering Resource

TM Forum productOffering 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), Duration (2 properties). Each schema is shown below with its type and property counts.

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

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
TM Forum agreementSpecification API
TM Forum billFormat API
TM Forum billingAccount API
TM Forum billingCycleSpecification API
TM Forum billPresentationMedia API
TM Forum cancelProductOrder API
TM Forum cancelServiceOrder API
TM Forum category API
TM Forum customer API
TM Forum events subscription API
TM Forum exportJob API
Where this information came from

This is an independent, third-party profile of TM Forum productOffering 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.