| Name | Description | Type | Additional information |
|---|---|---|---|
| SKU | string |
None. |
|
| SkuTerms |
SkuTerms are required for SIP Overlay products as a CPE SKU may have many term options. e.g. "24 month rental (DaaS) (SIP Overlay Bundle {1/3/12/24}M)". You may fetch the term options for a SKU via the api/v1/cpe/GetCPESKUs endpoint |
string |
None. |
| TariffId | globally unique identifier |
None. |
|
| CustomerId | globally unique identifier |
None. |
|
| DeliveryAddress |
Specify the order's delivery address details. |
DeliveryAddress |
None. |
| SipOverlayContactAddress |
For SIP Overlay orders, specify the contact address details associated the service's telephone number. |
NumberContactAddress |
None. |
| DeliveryNotes | string |
None. |
|
| RequestedDeliveryDate |
Specify the requested date of order delivery. If not provided, the default is 1 day after dispatch is complete. |
date |
None. |
| SIMDefaultEmail | string |
None. |
|
| SIMTags | string |
None. |
|
| CustomerReference | string |
None. |
|
| NumberAreaId |
For SIP Overlay orders, please specify the identifier of the area for the service's telephone number. Use GET endpoint api/v1/orders/numberareas to retrieve Number Area details. |
string |
None. |
| PartnerEmailAddress |
For SIP Overlay orders, this is the email address used for receiving partner specific order progress updates. |
string |
None. |
| UseDeliveryAddressForNumberContact |
For SIP Overlay orders, this flag indicates whether to re-use the Delivery Address details as the SIP Overlay Contact Address. |
boolean |
None. |
| Reason | string |
None. |