TM Forum Product Order API
Operations for ProductOrder Resource
TM Forum Product Order API is one of 38 APIs that TM Forum publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 5 operations across 2 paths, and defines 310 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
310 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.
productOrder 5
Operations for ProductOrder Resource
GET
/productOrder
TM Forum List or Find ProductOrder Objects
POST
/productOrder
TM Forum Creates a ProductOrder
GET
/productOrder/{id}
TM Forum Retrieves a ProductOrder by ID
DELETE
/productOrder/{id}
TM Forum Deletes a ProductOrder
PATCH
/productOrder/{id}
TM Forum Updates Partially a ProductOrder
Schemas 310
The contract defines 310 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.
Note
PartyRef_FVO
object
A Party reference
GeographicLocationRef
object
PlaceRefOrValue_MVO
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the Place entity and not the PlaceRefOrValue class itself
ProductOfferingQualificationRef_FVO
object
A productOfferingQualification that has been executed previously
GeographicLocationRefOrValue
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the GeographicLocation entity and not the GeographicLocationRefOrValue class i…
ErrorMessage_FVO
RelatedOrderItem_FVO
RelatedChannel_FVO
GeographicSubAddress_MVO
Party_MVO
OrderRelationship_FVO
ExternalIdentifier
ProductOfferingQualificationRef_MVO
object
A productOfferingQualification that has been executed previously
Individual_FVO
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…
CreditProfile
Producer_MVO
object
ProductOrderJeopardyAlert_MVO
RelatedPartyRefOrPartyRoleRef
PriceAlteration
Consumer_FVO
object
Producer_FVO
object
ProductOrderItem_MVO
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
PaymentRef_FVO
object
If an immediate payment has been done at the product order submission, the payment information are captured and stored (as a reference) in the order.
Attachment
PartyRoleSpecificationRef
object
Party role specification reference. A party role specification gives additional details on the part played by a party in a given context.
PartyRoleRef_MVO
PlaceRef
object
Place reference.
OtherNameOrganization_MVO
PartyRefOrPartyRoleRef
object
CharacteristicRelationship
TimePeriod
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
OrderTerm
OtherNameOrganization_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..
BillingAccountRef_FVO
Milestone_MVO
ProductOrderItemRef_MVO
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).
OrganizationChildRelationship_FVO
Product_MVO
Disability
object
Lack or inadequate strength or ability.
3 properties
GeographicSite_FVO
ProductOfferingQualificationItemRef_FVO
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
ProductOrderMilestone_FVO
IntentRef_FVO
object
Intent reference, for when Intent is used by other entities
ProductPrice_FVO
PartyOrPartyRole_FVO
object
ExternalIdentifier_MVO
ExpressionLanguageEnum
string
Possible values for the serialized Expression language of an intent or Intent report
OrderTerm_FVO
EntityRelationship
object
A uni-directionmal relationship from this entity to a target entity instance
11 properties
Supplier
object
When business partner is the Supplier
StandardIdentifier
OrganizationParentRelationship
GeographicSite_MVO
TaxDefinition_FVO
CharacteristicRelationship_FVO
GeographicSubAddressUnit_FVO
ProductSpecificationRef
Expression
Intent
CalendarPeriod_MVO
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
QuoteItemRef
GeographicSiteRelationship_FVO
ProductOrder
AccountRef_MVO
object
Account reference. A account may be a party account or a financial account.
AttachmentRef
RelatedPartyOrPartyRole
Supplier_FVO
object
When business partner is the Supplier
ProductOrderItemRef_FVO
GeographicSiteRelationship_MVO
ProductOrderErrorMessage_MVO
CreditProfile_MVO
ProductPrice_MVO
PartyRef_MVO
object
A Party reference
OrderItemRelationship_FVO
GeographicSite
JeopardyAlert_MVO
OrderPrice
PartyRoleRef_FVO
IntentRefOrValue
object
Intent Ref (if Intent already exists) or Value (if Intent be created or its details be presented)
AppointmentRef_MVO
AttachmentRefOrValue
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the Attachment entity and not the AttachmentRefOrValue class itself
Party
ProductTerm
IndividualStateType
string
Valid values for the lifecycle state of the individual
AgreementItemRef_MVO
Milestone
ProductOrderItem_FVO
Party_FVO
GeographicSiteRelationship
ServiceRef
object
Service reference, for when Service is used by other entities.
RelatedPlaceRefOrValue_MVO
Consumer_MVO
object
ServiceRef_FVO
object
Service reference, for when Service is used by other entities.
ProductRef_MVO
object
A Product reference
OtherNameOrganization
PriceAlteration_MVO
IndividualIdentification
GeographicSubAddressUnit_MVO
BillingAccountRef_MVO
Expression_MVO
OrganizationStateType
string
Valid values for the lifecycle state of the organization
Note_MVO
JeopardyAlert
EntityRelationship_MVO
object
A uni-directionmal relationship from this entity to a target entity instance
11 properties
RelatedChannel
PartyRefOrPartyRoleRef_FVO
object
EntityRef_FVO
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..
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…
ProductOrderErrorMessage
ContactMedium_FVO
Place_FVO
object
Place reference.
Organization_MVO
ChannelRef
object
The channel to which the resource reference to. e.g. channel for selling product offerings, channel for opening a trouble ticket etc..
PartyRoleRef
OrderItemRelationship_MVO
TaxDefinition
ProductOrderItemRef
BusinessPartner_FVO
object
When business partner is the BusinessPartner
BusinessPartner_MVO
object
When business partner is the BusinessPartner
HourPeriod_FVO
PartyCreditProfile_FVO
TaxExemptionCertificate
TargetProductSchema_MVO
object
The reference object to the schema and type of target product which is described by product specification
2 properties
IntentRef
object
Intent reference, for when Intent is used by other entities
PaymentRef
object
If an immediate payment has been done at the product order submission, the payment information are captured and stored (as a reference) in the order.
PartyRefOrPartyRoleRef_MVO
object
JsonPatchOperations
array
JSONPatch Operations document as defined by RFC 6902
PartyRole
Individual
Addressable
object
Base schema for adressable entities
2 properties
QuoteRef_MVO
object
Quote reference. It's a Quote that has been executed previously.
Money
object
A base / value business entity used to represent money
2 properties
OrganizationRef
object
ProductOfferingPriceRef_MVO
Consumer
object
Individual_MVO
Supplier_MVO
object
When business partner is the Supplier
Characteristic
Milestone_FVO
RelatedChannel_MVO
PaymentMethodRef_MVO
object
PaymentMethod reference. A payment method defines a specific mean of payment (e.g direct debit).
EntityRelationship_FVO
object
A uni-directionmal relationship from this entity to a target entity instance
11 properties
4 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…
Attachment_MVO
ProductOfferingQualificationItemRef
ProductOrder_MVO
LanguageAbility
object
Ability of an individual to understand or converse in a language.
8 properties
OrderItemRelationship
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
OrderPrice_FVO
GeographicLocationRef_MVO
object
ProductOrderItemStateType
string
Possible values for the state of the product order item
AppointmentRef_FVO
AgreementItemRef_FVO
ProductRelationship_FVO
CharacteristicRelationship_MVO
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.
PaymentRef_MVO
object
If an immediate payment has been done at the product order submission, the payment information are captured and stored (as a reference) in the order.
Addressable_FVO
object
Base schema for adressable entities
1 property
OrganizationRef_MVO
object
OrganizationChildRelationship
RelatedOrderItem_MVO
ProductOfferingRef_MVO
PartyRole_MVO
OrganizationChildRelationship_MVO
RelatedOrderItem
GeographicLocation
HourPeriod_MVO
Entity
object
Base entity schema for use in TMForum Open-APIs. Property.
AgreementItemRef
ProductRef_FVO
object
A Product reference
QuoteRef_FVO
object
Quote reference. It's a Quote that has been executed previously.
QuoteItemRef_MVO
AccountRef_FVO
object
Account reference. A account may be a party account or a financial account.
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
InitialProductOrderStateType
string
Possible values for the requested initial state of the order from client- by default acknowledged is considered
ContactMedium_MVO
GeographicLocation_FVO
ProductOfferingPriceRef
ProductOfferingRef_FVO
IntentRefOrValue_FVO
object
Intent Ref (if Intent already exists) or Value (if Intent be created or its details be presented)
IntentRefOrValue_MVO
object
Intent Ref (if Intent already exists) or Value (if Intent be created or its details be presented)
JsonPatch
object
A JSONPatch document as defined by RFC 6902
4 properties
2 required
ProductOfferingPriceRef_FVO
Producer
object
RelatedPlaceRefOrValue
PartyCreditProfile_MVO
GeographicSubAddressUnit
PlaceRef_MVO
object
Place reference.
Expression_FVO
RelatedPlaceRefOrValue_FVO
RelatedPartyOrPartyRole_MVO
AttachmentRef_MVO
BillingAccountRef
ProductOrderMilestone
GeographicLocationRefOrValue_FVO
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the GeographicLocation entity and not the GeographicLocationRefOrValue class i…
OrganizationIdentification
OrderRelationship_MVO
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
ExternalIdentifier_FVO
ProductOrderMilestone_MVO
PriceAlteration_FVO
StandardIdentifier_MVO
ResourceRef
object
Resource reference, for when Resource is used by other entities.
GeographicSubAddress_FVO
ProductPrice
GeographicAddress
Price
OrganizationIdentification_FVO
RelatedPartyRefOrPartyRoleRef_MVO
ProductOrderJeopardyAlert_FVO
Attachment_FVO
GeographicAddress_FVO
Organization
OrganizationRef_FVO
object
GeographicLocationRefOrValue_MVO
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the GeographicLocation entity and not the GeographicLocationRefOrValue class i…
ProductRefOrValue
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the Product entity and not the ProductRefOrValue class itself
ResourceRef_FVO
object
Resource reference, for when Resource is used by other entities.
AccountRef
object
Account reference. A account may be a party account or a financial account.
Quantity
object
An amount in a given unit
2 properties
Entity_MVO
object
Base entity schema for use in TMForum Open-APIs. Property.
CalendarPeriod_FVO
OrganizationParentRelationship_FVO
QuoteItemRef_FVO
CreditProfile_FVO
Note_FVO
AttachmentRefOrValue_FVO
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the Attachment entity and not the AttachmentRefOrValue class itself
Price_FVO
ProductOrderJeopardyAlert
Place
object
Place reference.
HourPeriod
IndividualIdentification_MVO
PlaceRef_FVO
object
Place reference.
EntityRef
GeographicLocationRef_FVO
object
PartyOrPartyRole
object
StandardIdentifier_FVO
ProductOrderItem
PartyRole_FVO
ProductSpecificationRef_FVO
GeographicSubAddress
PlaceRefOrValue_FVO
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the Place entity and not the PlaceRefOrValue class itself
GeographicLocation_MVO
OrderTerm_MVO
ProductOrder_FVO
ProductTerm_MVO
CalendarPeriod
ProductSpecificationRef_MVO
ProductOfferingRef
TaxDefinition_MVO
ProductOfferingQualificationItemRef_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
Price_MVO
ServiceRef_MVO
object
Service reference, for when Service is used by other entities.
RelatedPartyRefOrPartyRoleRef_FVO
ErrorMessage
ErrorMessage_MVO
OrderRelationship
QuoteRef
object
Quote reference. It's a Quote that has been executed previously.
ProductRef
object
A Product reference
PartyRef
object
A Party reference
Intent_MVO
RelatedPartyOrPartyRole_FVO
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
PlaceRefOrValue
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the Place entity and not the PlaceRefOrValue class itself
OrderPrice_MVO
ProductOrderStateType
string
Possible values for the state of the order
AttachmentRef_FVO
Intent_FVO
ResourceRef_MVO
object
Resource reference, for when Resource is used by other entities.
OrganizationParentRelationship_MVO
ProductOrderErrorMessage_FVO
Error
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
ContactMedium
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.
Characteristic_MVO
PartyOrPartyRole_MVO
object
BusinessPartner
object
When business partner is the BusinessPartner
JeopardyAlert_FVO
TaxExemptionCertificate_FVO
ProductOfferingQualificationRef
object
A productOfferingQualification that has been executed previously
TargetProductSchema_FVO
object
The reference object to the schema and type of target product which is described by product specification
2 properties
2 required
OrganizationIdentification_MVO
PartyCreditProfile
Product_FVO
ProductTerm_FVO
Characteristic_FVO
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.
AppointmentRef
Place_MVO
object
Place reference.
ProductRelationship_MVO
Organization_FVO
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
Where this information came from
This is an independent, third-party profile of TM Forum Product Order 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.