Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

TM Forum

TM Forum productOfferingPrice API

Operations for ProductOfferingPrice Resource

Documentation Provider Profile APIs.io OpenAPI GitHub

TM Forum productOfferingPrice 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 productOfferingPrice. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 2 paths, and defines 55 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 55 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
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.

productOfferingPrice 5

Operations for ProductOfferingPrice Resource

GET
/productOfferingPrice
TM Forum List or Find ProductOfferingPrice Objects
listProductOfferingPrice 3 params → 200400401403404405500501
POST
/productOfferingPrice
TM Forum Creates a ProductOfferingPrice
createProductOfferingPrice 1 param body → 201202400401403404405409
GET
/productOfferingPrice/{id}
TM Forum Retrieves a ProductOfferingPrice by ID
retrieveProductOfferingPrice 2 params → 200400401403404405500501
PATCH
/productOfferingPrice/{id}
TM Forum Updates Partially a ProductOfferingPrice
patchProductOfferingPrice 2 params body → 200202400401403404405409
DELETE
/productOfferingPrice/{id}
TM Forum Deletes a ProductOfferingPrice
deleteProductOfferingPrice 1 param → 202204400401403404405409

Schemas 55

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

EntityRef_FVO
PlaceRef
object
Place reference.
ProductSpecificationCharacteristicValueUse_MVO
BundledProductOfferingPriceRelationship
BundledProductOfferingPriceRelationship_FVO
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
JsonPatchOperations
array
JSONPatch Operations document as defined by RFC 6902
Quantity
object
An amount in a given unit
2 properties
Duration
object
A time interval in a given unit of time
2 properties
ProductSpecificationRef
CharacteristicValueSpecification
TargetProductSchema
object
The reference object to the schema and type of target product which is described by product specification
2 properties
ProductSpecificationRef_MVO
Entity_FVO
object
Base entity schema for use in TMForum Open-APIs. Property.
ProductOfferingPrice_MVO
ProductOfferingPrice_FVO
ProductOfferingTerm
ExternalIdentifier_MVO
PricingLogicAlgorithm_FVO
ProductSpecificationCharacteristicValueUse_FVO
Entity_MVO
object
Base entity schema for use in TMForum Open-APIs. Property.
PlaceRef_FVO
object
Place reference.
PolicyRef
Money
object
A base / value business entity used to represent money
2 properties
CharacteristicValueSpecification_FVO
ProductOfferingPriceRelationship_FVO
PricingLogicAlgorithm_MVO
Error
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
TargetProductSchema_MVO
object
The reference object to the schema and type of target product which is described by product specification
2 properties
ProductSpecificationCharacteristicValueUse
JsonPatch
object
A JSONPatch document as defined by RFC 6902
4 properties 2 required
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.
ProductOfferingTerm_MVO
BundledProductOfferingPriceRelationship_MVO
TaxItem_FVO
ProductOfferingTerm_FVO
TaxItem
ProductOfferingPriceRelationship_MVO
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
TaxItem_MVO
ProductOfferingPriceRelationship
CharacteristicValueSpecification_MVO
ExternalIdentifier
Addressable
object
Base schema for adressable entities
2 properties
PolicyRef_MVO
PricingLogicAlgorithm
ProductOfferingPrice
Addressable_FVO
object
Base schema for adressable entities
1 property
PolicyRef_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
EntityRef
ExternalIdentifier_FVO

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs TM Forum publishes across the network.

TM Forum agreement API
AE Profile APIs.io
TM Forum agreementSpecification API
AE Profile APIs.io
TM Forum billFormat API
AE Profile APIs.io
TM Forum billingAccount API
AE Profile APIs.io
TM Forum billingCycleSpecification API
AE Profile APIs.io
TM Forum billPresentationMedia API
AE Profile APIs.io
TM Forum cancelProductOrder API
AE Profile APIs.io
TM Forum cancelServiceOrder 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 exportJob API
AE Profile APIs.io
#productOfferingPrice
← Back to T APIs
API Details
ID
tm-forum:tm-forum-productofferingprice-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