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