ProductOrder

Extends

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,

Field Required Nullable Type Description Constraints Example

@type

Yes

No

String

When sub-classing, this defines the sub-class Extensible name

@baseType

No

No

String

When sub-classing, this defines the super-class

@schemaLocation

No

No

String

A URI to a JSON-Schema file that defines additional attributes and relationships

id

No

No

String

Unique identifier

2d7ed5fd-9f62-4211-bc84-357f5f7b80f5

href

No

No

URI

Hyperlink reference

https://api.example.org/resource/id

category

Yes

No

String

Used to categorize the order from a business perspective (new, productChange, groupChange, productModification, termination, groupMigration)

new

description

No

No

String

Description of the product order

Lorem ipsum dolor

expectedCompletionDate

No

No

DateTime

Expected delivery date amended by the provider

2025-12-24T19:30+01:00

creationDate

Yes

No

DateTime

Date when the order resource was created

2023-01-01T08:00+01:00

orderIsChargingRelevant

No

No

Boolean

Boolean amended by the provider defining if the processing of the ProductOrder is charging relevant

false

orderPostedDate

No

No

DateTime

Date when the order was posted by the requester

2023-01-01T08:00+01:00

priority

No

No

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

No

No

DateTime

Requested delivery date from the requestors perspective

2025-12-24T19:30+01:00

agreement

No

No

array of AgreementRefOrValue

A reference to an agreement defined in the context of the product order

[]

externalId

No

No

array of ExternalIdentifier

A reference to an externaly defined object in the context of the product order

[]

billingAccount

No

No

BillingAccountRef

note

No

No

array of Note

Note

[]

productOfferingQualification

No

No

array of ProductOfferingQualificationRef

Product offering qualification

[]

productOrderItem

Yes

No

array of ProductOrderItem

Product order item

minimum items 1;

[]

relatedParty

No

No

array of RelatedPartyOrPartyRole

Related party

[]

state

Yes

No

ProductOrderStateType

stateChangeDate

Yes

No

DateTime

The date and time the state changed.

2024-01-01T12:00+01:00

stateChangeMessage

No

No

array of Message

Message for the state change described as a combination of a text and a code.

[]

stateChangeHistory

No

No

array of StateChange

The state change history that is associated to the Entity. Populated by the server

[]

earliestOrderRetry

No

No

DateTime

Earliest date when the order can be submitted again.

2023-01-01T08:00+01:00

attachment

No

No

array of AttachmentRefOrValue

Attachment

[]

productOrderJeopardyAlert

No

No

array of ProductOrderJeopardyAlert

List of ProductOrderJeopardyAlerts. A ProductOrderJeopardyAlert represents a predicted exception during a product order processing that would brings risk to complete successfully the order.

[]

productOrderMilestone

No

No

array of ProductOrderMilestone

List of ProductOrderMilestones. A ProductOrderMilestone represents an action or event marking a significant change or stage in processing of a product order.

[]

productOrderRelationship

No

No

array of ProductOrderRelationship

Product order relationship

[]

providerChangeInfo

No

No

ProviderChangeInfo

additionalOrderInformation

No

No

AdditionalOrderInformation