Create Order (NBN Modification)

Testing Env

https://benzine.telcoinabox.com/tiab/api

POST

/v1/service/orders/change

ordernbn

This API can be used for creating all orders. This specific definition will explain how to create an order to complete an NBN Activation specifically

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Body Params application/json

orderType

enum<string>

required

Order Type

Allowed value:

Change

subOrderType

enum<string>

required

Order Sub Type. Selecting the option here will determine the type of Change Request that will be carried out on the Service.

Allowed values:

PlanChangeSuspendUnsuspendShapeUnshape

service

object

required

Details about the Service being provisioned

custNo

integer

required

Customer Account number that this service belongs to.

csn

enum<string>

required

Service Number that is being changed

Allowed value:

nbn-tc4

planNo

integer

optional

Retail Plan ID to change the Service's plan to. Should only be provided for PlanChange orders.

custReqDate

string <date-time>

required

Customer Requested Date for completing the order.

Note: orders that require appointments will always be set to the earliest available appointment, ignoring this date. Orders must be rescheduled if the earliest available appointment is not suitable.

For all other orders, the order will be held until due date for completion.

Example

{
    "orderType": "Change",
    "subOrderType": "PlanChange",
    "service": {
        "custNo": 0,
        "csn": "nbn-tc4",
        "planNo": 0
    },
    "custReqDate": "2019-08-24T14:15:22Z"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://benzine.telcoinabox.com/tiab/api/v1/service/orders/change' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "orderType": "Change",
    "subOrderType": "PlanChange",
    "service": {
        "custNo": 0,
        "csn": "nbn-tc4",
        "planNo": 0
    },
    "custReqDate": "2019-08-24T14:15:22Z"
}'

Responses

🟢200OK

application/json

Body

orderId

string

optional

Unique identifier of the Order.

success

boolean

optional

Indicator of whether or not order request was successful or not

Example

{
    "orderId": "string",
    "success": true
}

🟠403Invalid access

🟢200Validation Error

Modified at 2024-04-23 04:37:09

Create Order (NBN Activation)

Create Order (NBN Disconnection)