ProductOrder

Data type: Entity

A Product Order is a type of order which can be used to place an order between a customer and a service provider or between a service provider and a partner and vice versa,

Name	Type	Description	Example
@type (1)	string	When sub-classing, this defines the sub-class Extensible name
category (1)	string	Used to categorize the order from a business perspective (new, productChange, groupChange, productModification, termination, groupMigration)	new
creationDate (1)	DateTime	Date when the order resource was created	2023-01-01T08:00:00+01:00
orderPostedDate (1)	DateTime	Date when the order was posted by the requester	2023-01-01T08:00:00+01:00
productOrderItem (1)	ProductOrderItem [1..m]	Product Order item	[]
state (1)	ProductOrderStateType
stateChangeDate (1)	DateTime	The date and time the state changed.	2024-01-01T12:00:00+01:00
@baseType	string	When sub-classing, this defines the super-class
@schemaLocation	string	A URI to a JSON-Schema file that defines additional attributes and relationships
id	string	Unique identifier	2d7ed5fd-9f62-4211-bc84-357f5f7b80f5
href	URI	Hyperlink reference	https://api.example.org/resource/id
description	string	Description of the Product Order	Lorem ipsum dolor
expectedCompletionDate	DateTime	Expected delivery date amended by the provider	2025-12-24T19:30:00+01:00
orderIsChargingRelevant	boolean	Boolean amended by the provider defining if the processing of the ProductOrder is charging relevant	false
priority	string	A way that can be used by consumers to prioritize orders in OM system (from 0 to 4 : 0 is the highest priority, and 4 the lowest)	4
requestedCompletionDate	DateTime	Requested delivery date from the requestors perspective	2025-12-24T19:30:00+01:00
agreement	AgreementRefOrValue [n..m]	A reference to an agreement defined in the context of the Product Order	[]
externalId	ExternalIdentifier [n..m]	A reference to an externaly defined object in the context of the Product Order	[]
billingAccount	BillingAccountRef
note	Note [n..m]	Note	[]
productOfferingQualification	ProductOfferingQualificationRef [n..m]	Product offering qualification	[]
relatedParty	RelatedPartyOrPartyRole [n..m]	Related party	[]
stateChangeMessage	Message [n..m]	Message for the state change described as a combination of a text and a code.	[]
stateChangeHistory	StateChange [n..m]	The state change history that is associated to the Entity. Populated by the server	[]
earliestOrderRetry	DateTime	Earliest date when the order can be submitted again.	2023-01-01T08:00:00+01:00
attachment	AttachmentRefOrValue [n..m]	Attachment	[]
productOrderJeopardyAlert	ProductOrderJeopardyAlert [n..m]	List of ProductOrderJeopardyAlerts. A ProductOrderJeopardyAlert represents a predicted exception during a Product Order processing that would brings risk to complete successfully the order.	[]
productOrderMilestone	ProductOrderMilestone [n..m]	List of ProductOrderMilestones. A ProductOrderMilestone represents an action or event marking a significant change or stage in processing of a Product Order.	[]
productOrderRelationship	ProductOrderRelationship [n..m]	Product Order relationship	[]
providerChangeInfo	ProviderChangeInfo
additionalOrderInformation	AdditionalOrderInformation