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/.
The identity and technical contract details declared by the specification.
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.
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…
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
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
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..
CharacteristicValueSpecification_FVO
Error
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
ProductOfferingPriceRelationship_FVO
CharacteristicSpecificationRelationship_FVO
BundledGroupProductOffering_FVO
ProductSpecificationCharacteristicValueUse
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
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…
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..
ProductOfferingPriceRefOrValue_MVO
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the ProductOfferingPrice entity and not the ProductOfferingPriceRefOrValue cla…
CharacteristicValueSpecification
BundledProductOfferingPriceRelationship_MVO
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.
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
BundledProductOfferingOption
ProductSpecificationCharacteristicValueUse_MVO
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…
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
BundledProductOffering_MVO
ProductOfferingPriceRelationship_MVO
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…
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…
BundledGroupProductOfferingOption
ProductOfferingPriceRef_MVO
ProductOfferingRelationship_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
ProductOfferingPriceRef_FVO
BundledProductOfferingPriceRelationship_FVO
ProductSpecificationRef_FVO
PlaceRef_FVO
object
Place reference.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs TM Forum publishes across the network.