OrderHeader
This class is the attribute for the header object. It might be used across services and ID defined in JSON format.
Element Name | Element Type | Description |
---|---|---|
OrderDescription | String
(Optional) |
Order description. |
OrderStatus | String
(Optional) |
Current order status. |
CustomerID | String
(Optional) |
Customer unique identifier. Omit for non-corporate orders. Either CustomerID or SubscriberID is necessary. |
SubscriberID | String
(Optional) |
Subscriber unique identifier. Omit for corporate orders. Either CustomerID or SubscriberID is necessary. |
SubmittedDate | Date
(Optional) |
Date order was submitted. |
SubmittedTime | Time
(Optional) |
The time order was submitted. |
RequiredByDate | DateTime
(Optional) |
Date and time that a particular order is required to start on. |
orderPriority |
Integer(Optional) |
The priority value assigned to order. The value ranges from 0-9. |
ExpirationDate | Date
(Optional) |
The expiration date for the offer. Not relevant for orders. |
ExpectedCompletionDate | DateTime
(Optional) |
The date order is expected to be completed. |
InvoiceAddress | Type
(Optional) |
Invoice address. |
InvoiceAddress/AddressLine1 | String
(Mandatory) |
Invoice address line 1. |
InvoiceAddress/AddressLine2 | String
(Optional) |
Invoice address line 2. |
InvoiceAddress/Locality | String
(Mandatory) |
Invoice address locality. |
InvoiceAddress/Region | String
(Optional) |
Invoice address region. |
InvoiceAddress/PostCode | String
(Mandatory) |
Invoice address postcode. |
InvoiceAddress/Country | String
(Mandatory) |
Invoice address country. |
DeliveryAddress | Type
(Optional) |
Delivery address. |
DeliveryAddress/AddressLine1 | String
(Mandatory) |
Delivery address line 1. |
DeliveryAddress/AddressLine2 | String
(Optional) |
Delivery address line 2. |
DeliveryAddress/Locality | String
(Mandatory) |
Delivery address locality. |
DeliveryAddress/Region | String
(Optional) |
Delivery address region. |
DeliveryAddress/PostCode | String
(Mandatory) |
Delivery address postcode. |
DeliveryAddress/Country | String
(Mandatory) |
Delivery address country. |
Notes | String
(Optional) |
Order notes. |
SLAs | Type
(Optional) |
List of SLAs passed through to back-end systems. These SLAs do not apply within the order management. |
SLAs/SLA | Type (*) | SLA type. |
SLAs/SLA/SLAID | String
(Mandatory) |
SLA ID. |
UDF | Type (*) | UDF type |
UDF/Name | String
(Mandatory) |
Name of the attribute. |
UDF/Value | String
(Mandatory) |
Value of the attribute. |
Copyright © Cloud Software Group, Inc. All rights reserved.