Create Order

POST /v1/Order/Create

The ISP should send a POST request to /v1/Order/Create to start the provisioning process with the OAP. When this Order is created, it may not be activated immediately by the OAP in case of unmet dependancies, such as a drop not being install, or an ONT not being placed or provisioned.

Request

{
    "objectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "serviceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "externalOrderNumber": "string",
    "fromDate": 0,
    "toDate": 0,
    "customer": {
        "firstName": "string",
        "lastName": "string",
        "email": "string",
        "phoneNumber": "string",
        "mobileNumber": "string",
        "companyName": "string",
        "customerReference": "string"
    },
    "addons": [
        "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    ]
}

Fields

Param	Description	Required
objectId	The objectId is the UUID that represents the service location. See Object.	Yes
serviceId	The serviceId is the UUID that represents the service. See Service.	Yes
externalOrderNumber	The externalOrderNumber is the order number from the ISP.	No
fromDate	The fromDate is the start date of the service in unix timestampe format. This will be the earliest date an Order is possible to be provisioned. Recommendation in most cases is to use now().	Yes
toDate	The toDate is the end date of the service in unix timestampe format. This will be the latest date an Order is possible to be provisioned.	No
customer	The customer object contains the customer information.	Yes
addons	The addons is an array of UUIDs that represent the addons that are being ordered. See Addon.	No

Customer

Customer information is not strictly required by the system or API. However, the ISP should consult with the OAP to determine what information, if any, is required by policy.

Param	Description	Required
firstName	The first name of the customer.	No
lastName	The last name of the customer.	No
email	The email address of the customer.	No
phoneNumber	The phone number of the customer.	No
mobileNumber	The mobile number of the customer.	No
companyName	The company name of the customer.	No
customerReference	The ISP's customer reference of the customer.	No

Addon

Param	Description	Required
addonId	The addonId is the UUID that represents the addon. See Addon.	Yes

Response

On a successful POST, the API will respond with the orderId of the newly created Order. It is suggested that the ISP store this orderId tangentially to the subscription they are selling to the end subscriber.

{
    "orderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

This orderId will be used in future requests to manage the Order and will always be a UUID.