OrderLine

This class is the data model for the OrderLine object. It may be used across services and ID defined in XSD format.


OrderLine Schema

The following order line actions are supported:

Provide Install a new product or service.
Update Update an existing product or service.
Cease Terminate an existing product or service.
Cancel Cancel an outstanding order currently in-flight.
Line Element Details
Element Name Element Type Description
lineNumber String

(Mandatory)

Order line number.
subscriberID String

(Optional)

Subscriber ID for this order line. Omit for orders for corporate customers not linked to an individual subscriber.
productID String

(Mandatory)

ID of the product being ordered.
productVersion String Version ID of the product being ordered.
quantity String

(Mandatory)

Number of items required for each product in this line.
uom String

(Mandatory)

Unit of measure.
deliveryAddress addressType (Mandatory) Delivery address.
action String

(Mandatory)

Action required. Valid values are:

  • PROVIDE
  • UPDATE
  • CEASE
  • CANCEL
actionMode String

(Optional)

Action mode. This is optional supplemental information to go with OrderLineAction. Valid value is:

  • MOVE
requiredByDate DateTime

(Mandatory)

Date and time that a particular order is required to start on.
linkID String

(Optional)

Correlation ID used by order management to group order lines together for provisioning.
inventoryID String

(Optional)

Inventory ID for this product.
notes String

(Optional)

Order line notes.
slaID String

(Mandatory)

SLA ID. (SLAs passed through to back-end systems. These SLAs do not apply within order management itself.)
udf String

(Mandatory)

Value of the attribute. This must be minimum of one character in length.
characteristic Type

(Optional)

List of characteristics.
customerItemID String

(Optional)

Customer item ID.
status String (Optional) Current order status.
statusChanged
extension