TM Forum product API
Operations for Product Resource
TM Forum product 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 product. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 5 operations across 2 paths, and defines 241 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
241 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.
product 5
Operations for Product Resource
GET
/product
TM Forum List or Find Product Objects
POST
/product
TM Forum Creates a Product
GET
/product/{id}
TM Forum Retrieves a Product by ID
DELETE
/product/{id}
TM Forum Deletes a Product
PATCH
/product/{id}
TM Forum Updates Partially a Product
Schemas 241
The contract defines 241 schemas that model the data the API accepts and returns. The most detailed are OtherNameIndividual (12 properties), EntityRelationship_FVO (11 properties), EntityRelationship (11 properties), EntityRelationship_MVO (11 properties). Each schema is shown below with its type and property counts.
Expression_MVO
GeographicLocationRef_FVO
object
BillingAccountRef_FVO
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…
ContactMedium
ProductRef
object
A Product reference
EntityRef_FVO
StandardIdentifier
PlaceRef
object
Place reference.
Product_FVO
PartyOrPartyRole_FVO
object
GeographicLocationRef_MVO
object
ProductOfferingRef_MVO
Intent_MVO
Supplier_MVO
object
When business partner is the Supplier
ProductRefOrValue_MVO
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the Product entity and not the ProductRefOrValue class itself
OrganizationChildRelationship_MVO
PartyRoleRef_MVO
PartyRefOrPartyRoleRef_MVO
object
Producer
object
ProductRelationship_MVO
ExpressionLanguageEnum
string
Possible values for the serialized Expression language of an intent or Intent report
RelatedOrderItem_MVO
Attachment
GeographicSite
OtherNameOrganization_FVO
PlaceRefOrValue
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the Place entity and not the PlaceRefOrValue class itself
PartyCreditProfile_FVO
CalendarPeriod_MVO
PaymentMethodRef
object
PaymentMethod reference. A payment method defines a specific mean of payment (e.g direct debit).
AccountRef
object
Account reference. A account may be a party account or a financial account.
Place_MVO
object
Place reference.
RelatedOrderItem_FVO
GeographicSiteRelationship_FVO
CreditProfile_MVO
ProductPrice
ProductPrice_MVO
Place
object
Place reference.
OrganizationParentRelationship_MVO
PartyRoleRef_FVO
Party_FVO
Characteristic_FVO
GeographicLocation_FVO
IntentRef_FVO
object
Intent reference, for when Intent is used by other entities
ProductRelationship_FVO
Producer_FVO
object
IntentRefOrValue
object
Intent Ref (if Intent already exists) or Value (if Intent be created or its details be presented)
CalendarPeriod
OrganizationRef_FVO
object
Supplier_FVO
object
When business partner is the Supplier
ProductSpecificationRef_FVO
GeographicSite_FVO
ProductRefOrValue
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the Product entity and not the ProductRefOrValue class itself
Product_MVO
Organization
OtherNameOrganization
OrganizationRef
object
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
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…
BusinessPartner_FVO
object
When business partner is the BusinessPartner
GeographicSubAddress_MVO
AgreementItemRef_MVO
Consumer_FVO
object
GeographicLocationRefOrValue
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the GeographicLocation entity and not the GeographicLocationRefOrValue class i…
PartyCreditProfile
TaxExemptionCertificate
JsonPatchOperations
array
JSONPatch Operations document as defined by RFC 6902
OrganizationParentRelationship
IndividualStateType
string
Valid values for the lifecycle state of the individual
ContactMedium_MVO
Quantity
object
An amount in a given unit
2 properties
HourPeriod_MVO
Price_MVO
PriceAlteration_FVO
Organization_FVO
PriceAlteration_MVO
Duration
object
A time interval in a given unit of time
2 properties
CharacteristicRelationship_MVO
PartyRoleRef
Individual_FVO
Price
ProductSpecificationRef
TargetProductSchema
object
The reference object to the schema and type of target product which is described by product specification
2 properties
ProductSpecificationRef_MVO
Attachment_FVO
OrganizationParentRelationship_FVO
EntityRelationship_FVO
object
A uni-directionmal relationship from this entity to a target entity instance
11 properties
4 required
CreditProfile
OtherNameIndividual
object
Keeps track of other names, for example the old name of a woman before marriage or an artist name.
12 properties
Entity_FVO
object
Base entity schema for use in TMForum Open-APIs. Property.
PartyRole_FVO
OrganizationChildRelationship
Individual
ProductRefOrValue_FVO
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the Product entity and not the ProductRefOrValue class itself
AttachmentRefOrValue_FVO
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the Attachment entity and not the AttachmentRefOrValue class itself
IndividualIdentification_MVO
BillingAccountRef
Price_FVO
PartyCreditProfile_MVO
LanguageAbility
object
Ability of an individual to understand or converse in a language.
8 properties
ExternalIdentifier_MVO
PartyRef_MVO
object
A Party reference
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…
Expression_FVO
Party
Disability
object
Lack or inadequate strength or ability.
3 properties
PaymentMethodRef_MVO
object
PaymentMethod reference. A payment method defines a specific mean of payment (e.g direct debit).
RelatedPartyOrPartyRole_MVO
TaxDefinition_MVO
GeographicAddress_FVO
TaxDefinition_FVO
Producer_MVO
object
PartyRef
object
A Party reference
Individual_MVO
BusinessPartner_MVO
object
When business partner is the BusinessPartner
Party_MVO
ResourceRef
object
Resource reference, for when Resource is used by other entities.
ProductPrice_FVO
ServiceRef_FVO
object
Service reference, for when Service is used by other entities.
ResourceRef_MVO
object
Resource reference, for when Resource is used by other entities.
Entity_MVO
object
Base entity schema for use in TMForum Open-APIs. Property.
RelatedPlaceRefOrValue_MVO
TaxExemptionCertificate_MVO
GeographicLocationRefOrValue_MVO
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the GeographicLocation entity and not the GeographicLocationRefOrValue class i…
PlaceRef_FVO
object
Place reference.
ProductRef_MVO
object
A Product reference
TaxDefinition
GeographicSubAddress_FVO
ProductRelationship
OrganizationRef_MVO
object
TaxExemptionCertificate_FVO
Money
object
A base / value business entity used to represent money
2 properties
Characteristic_MVO
Expression
GeographicLocationRef
object
CreditProfile_FVO
IndividualIdentification
IntentRefOrValue_FVO
object
Intent Ref (if Intent already exists) or Value (if Intent be created or its details be presented)
ProductOfferingPriceRef_FVO
OrganizationChildRelationship_FVO
IntentRef_MVO
object
Intent reference, for when Intent is used by other entities
OrganizationIdentification_FVO
ItemActionType
string
action to be performed on the entity managed by the item
ProductTerm_MVO
BillingAccountRef_MVO
RelatedPartyRefOrPartyRoleRef
GeographicLocation
ServiceRef_MVO
object
Service reference, for when Service is used by other entities.
Place_FVO
object
Place reference.
PlaceRef_MVO
object
Place reference.
RelatedPlaceRefOrValue
RelatedPartyRefOrPartyRoleRef_MVO
GeographicLocationRefOrValue_FVO
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the GeographicLocation entity and not the GeographicLocationRefOrValue class i…
PaymentMethodRef_FVO
object
PaymentMethod reference. A payment method defines a specific mean of payment (e.g direct debit).
ProductTerm
OrganizationIdentification
GeographicSiteRelationship
ProductStatusType
string
Possible values for the status of the product
Error
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
CharacteristicRelationship
TargetProductSchema_MVO
object
The reference object to the schema and type of target product which is described by product specification
2 properties
JsonPatch
object
A JSONPatch document as defined by RFC 6902
4 properties
2 required
AccountRef_MVO
object
Account reference. A account may be a party account or a financial account.
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.
ProductOfferingRef
Consumer_MVO
object
ProductOfferingRef_FVO
ProductOfferingPriceRef
RelatedPartyOrPartyRole_FVO
ContactMedium_FVO
PartyRoleSpecificationRef
object
Party role specification reference. A party role specification gives additional details on the part played by a party in a given context.
IndividualIdentification_FVO
ProductRef_FVO
object
A Product reference
Product
RelatedPartyOrPartyRole
Organization_MVO
Intent
StandardIdentifier_MVO
OtherNameOrganization_MVO
GeographicSiteRelationship_MVO
CalendarPeriod_FVO
IntentRefOrValue_MVO
object
Intent Ref (if Intent already exists) or Value (if Intent be created or its details be presented)
ResourceRef_FVO
object
Resource reference, for when Resource is used by other entities.
Attachment_MVO
OrganizationIdentification_MVO
GeographicSubAddressUnit_FVO
PartyRefOrPartyRoleRef_FVO
object
StandardIdentifier_FVO
OrganizationStateType
string
Valid values for the lifecycle state of the organization
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
Intent_FVO
IntentRef
object
Intent reference, for when Intent is used by other entities
GeographicLocation_MVO
ServiceRef
object
Service reference, for when Service is used by other entities.
AttachmentRef_MVO
GeographicAddress
CharacteristicRelationship_FVO
PartyRole_MVO
Characteristic
PartyRoleSpecificationRef_MVO
object
Party role specification reference. A party role specification gives additional details on the part played by a party in a given context.
HourPeriod_FVO
ExternalIdentifier
PartyRoleSpecificationRef_FVO
object
Party role specification reference. A party role specification gives additional details on the part played by a party in a given context.
ProductTerm_FVO
RelatedOrderItem
Addressable
object
Base schema for adressable entities
2 properties
PartyRole
RelatedPlaceRefOrValue_FVO
AgreementItemRef_FVO
PlaceRefOrValue_MVO
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the Place entity and not the PlaceRefOrValue class itself
ProductOfferingPriceRef_MVO
EntityRelationship_MVO
object
A uni-directionmal relationship from this entity to a target entity instance
11 properties
GeographicSubAddress
PartyRef_FVO
object
A Party reference
AttachmentRefOrValue
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the Attachment entity and not the AttachmentRefOrValue class itself
PartyOrPartyRole_MVO
object
PriceAlteration
HourPeriod
GeographicAddress_MVO
Skill
object
Skills evaluated for an individual with a level and possibly with a limited validity when an obsolescence is defined (Ex: the first-aid certificate first level…
5 properties
GeographicSubAddressUnit_MVO
PartyRefOrPartyRoleRef
object
AccountRef_FVO
object
Account reference. A account may be a party account or a financial account.
RelatedPartyRefOrPartyRoleRef_FVO
Addressable_FVO
object
Base schema for adressable entities
1 property
BusinessPartner
object
When business partner is the BusinessPartner
GeographicSite_MVO
AttachmentRef_FVO
Supplier
object
When business partner is the Supplier
GeographicSubAddressUnit
PartyOrPartyRole
object
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
PlaceRefOrValue_FVO
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the Place entity and not the PlaceRefOrValue class itself
ExternalIdentifier_FVO
AgreementItemRef
Consumer
object
AttachmentRef
EntityRelationship
object
A uni-directionmal relationship from this entity to a target entity instance
11 properties
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
#product