TM Forum · JSON Structure
Tmf622 Product Ordering Product Order Item Structure
ProductOrderItem schema from TM Forum API
Type:
Properties: 0
TelcoTelecommunicationsBSSOSSOpen APIsStandards
ProductOrderItem is a JSON Structure definition published by TM Forum. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
Meta-schema: https://json-structure.org/meta/core/v0/#
JSON Structure
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/tm-forum/refs/heads/main/json-structure/tmf622-product-ordering-product-order-item-structure.json",
"name": "ProductOrderItem",
"description": "ProductOrderItem schema from TM Forum API",
"allOf": [
{
"$ref": "#/components/schemas/Extensible"
},
{
"type": "object",
"description": "An identified part of the order. A product order is decomposed into one or more order items.",
"properties": {
"quantity": {
"type": "int32",
"description": "Quantity ordered"
},
"action": {
"$ref": "#/components/schemas/ItemActionType"
},
"appointment": {
"$ref": "#/components/schemas/AppointmentRef"
},
"billingAccount": {
"$ref": "#/components/schemas/BillingAccountRef"
},
"itemPrice": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderPrice"
}
},
"itemTerm": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderTerm"
}
},
"itemTotalPrice": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderPrice"
}
},
"note": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Note"
}
},
"payment": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentRef"
}
},
"product": {
"$ref": "#/components/schemas/ProductRefOrValue"
},
"productOffering": {
"$ref": "#/components/schemas/ProductOfferingRef"
},
"productOfferingQualificationItem": {
"$ref": "#/components/schemas/ProductOfferingQualificationItemRef"
},
"quoteItem": {
"$ref": "#/components/schemas/QuoteItemRef"
},
"productOrderItem": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductOrderItem"
}
},
"productOrderItemRelationship": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderItemRelationship"
}
},
"state": {
"$ref": "#/components/schemas/ProductOrderItemStateType"
},
"qualification": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductOfferingQualificationRef"
}
},
"id": {
"type": "string",
"description": "Identifier of the ProductOrder item (generally it is a sequence number 01, 02, 03, ...)"
}
}
}
],
"discriminator": {
"propertyName": "@type",
"mapping": {
"ProductOrderItem": "#/components/schemas/ProductOrderItem"
}
}
}