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