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