TM Forum · Schema

ProductOrder_FVO

TelcoTelecommunicationsBSSOSSOpen APIsStandards
View JSON Schema on GitHub

JSON Schema

tm-forum-productorder-fvo-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ProductOrder_FVO",
  "title": "ProductOrder_FVO",
  "allOf": [
    {
      "$ref": "#/components/schemas/Entity_FVO"
    },
    {
      "type": "object",
      "description": "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,",
      "properties": {
        "agreement": {
          "type": "array",
          "description": "A reference to an agreement defined in the context of the product order",
          "items": {
            "$ref": "#/components/schemas/AgreementRef_FVO"
          }
        },
        "billingAccount": {
          "$ref": "#/components/schemas/BillingAccountRef_FVO"
        },
        "requestedInitialState": {
          "$ref": "#/components/schemas/InitialProductOrderStateType",
          "default": "acknowledged"
        },
        "category": {
          "type": "string",
          "description": "Used to categorize the order from a business perspective that can be useful for the OM system (e.g. \"enterprise\", \"residential\", ...)"
        },
        "channel": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/RelatedChannel_FVO"
          }
        },
        "description": {
          "type": "string",
          "description": "Description of the product order"
        },
        "externalId": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/ExternalIdentifier_FVO"
          }
        },
        "note": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/Note_FVO"
          }
        },
        "notificationContact": {
          "type": "string",
          "description": "Contact attached to the order to send back information regarding this order"
        },
        "orderTotalPrice": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/OrderPrice_FVO"
          }
        },
        "payment": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/PaymentRef_FVO"
          }
        },
        "orderRelationship": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/OrderRelationship_FVO"
          }
        },
        "priority": {
          "type": "string",
          "description": "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)"
        },
        "productOfferingQualification": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/ProductOfferingQualificationRef_FVO"
          }
        },
        "quote": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/QuoteRef_FVO"
          }
        },
        "productOrderErrorMessage": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/ProductOrderErrorMessage_FVO"
          }
        },
        "productOrderJeopardyAlert": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/ProductOrderJeopardyAlert_FVO"
          }
        },
        "productOrderMilestone": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/ProductOrderMilestone_FVO"
          }
        },
        "productOrderItem": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/ProductOrderItem_FVO"
          },
          "minItems": 1
        },
        "relatedParty": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/RelatedPartyRefOrPartyRoleRef_FVO"
          }
        },
        "requestedCompletionDate": {
          "type": "string",
          "format": "date-time",
          "description": "Requested delivery date from the requestor perspective"
        },
        "requestedStartDate": {
          "type": "string",
          "format": "date-time",
          "description": "Order fulfillment start date wished by the requestor. This is used when, for any reason, requestor cannot allow seller to begin to operationally begin the fulfillment before a date. "
        }
      },
      "required": [
        "productOrderItem"
      ]
    }
  ],
  "discriminator": {
    "propertyName": "@type",
    "mapping": {
      "ProductOrder": "#/components/schemas/ProductOrder_FVO"
    }
  }
}