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