Order Header

The table below lists the information contained in an order header:

Type Description
Order Ref ID A unique identifier supplied by the system that submits the order. The Order Reference is used to determine whether the order is a new request or an amendment. OMS does this by checking if an order with the same Order Reference is already stored in the database. If the order already exists, the order is an amendment. If there is not, then it is a new order request.

If the orderRefId is not supplied by external system, then Fulfillment Order Management system generates the reference ID and sends in response.

Order ID Internal ID of the order generated and assigned by OMS.
Status Current status of an order. For instance, COMPLETE.
Execution Plan Execution Plan ID.
Required By Date Indicates the date and time when the order must start fulfillment.
Notes Notes about the order. Basically this is any additional text that may be supplied by the summiteer or submitting system.
Subscriber ID Reference ID of the subscriber.
Customer ID Used to retrieve the current customer profile and to identify the customer to other systems interested in the order.
Changed Date Date when the order is changed.
Execution Status Execution status of an order. For instance, COMPLETE.
Required On Date Currently not supported.
Invoice Address The address to invoice for the order, if different from the customer address.
Delivery Address The address to deliver the order, if different from the customer address.
Service Level Agreements (SLA) This is a list of the identifiers of any service level agreement that applies to a particular order.