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