Octane REST API
  1. v1
Octane REST API
  • Getting Started
    • API Access & Authentication
    • API Rate Limiting
  • Integration Guides
    • Payment Integration
    • CDR Integration
    • Test Environment Data Sets
    • Mobile Flows
      • Activate Postpaid Mobile (New MSN - Physical SIM)
      • Activate Postpaid (Port MSN - Physical SIM)
      • Activate Postpaid Mobile (New MSN - eSIM)
      • Activate Postpaid (Port MSN - eSIM)
      • Reset eSIM Profile
      • Mobile Data Pool Flow
    • ConnectYou Flows
      • ConnectYou Business SIP Trunk Activate Flow
      • ConnectYou Business SIP Trunk Reactivate Direct Indials Flow
      • ConnectYou Unite Calling Activate Flow
    • NBN Flows
      • NBN Activate Flow
      • NBN Plan Change Flow
      • NBN Termination Flow
      • NBN Reschedule Appointment Flow
      • NBN Withdraw Order Flow
      • Run NBN Diagnostic Test Flow
      • Run NBN Service Health Check Flow
  • API Documentation
    • Customer
      • Add Customer
      • Get Customer Detail
      • List Customers
      • Update Customer
      • Set Customer Direct Debit
      • Send Welcome Email
    • Payment Method
      • List Payment Methods
      • Add Payment Method
      • Update Payment Method
      • Delete Payment Method
    • Transaction
      • List Transactions
      • Make Payment
      • Add Misc Adjustment
      • List Bounced Transactions
    • Plan
    • Service
      • List Services for a Customer
      • Get Service Detail by LineSeqNo
    • Mobile
      • Notification
        • Get Notification Settings
        • Update Notification Settings
      • Get Data Pool
      • Update Data Limit
      • Transfer Services to Another Pool
      • Disconnect a Data Pool
      • Get eSIM Details
      • Manage eSIM
    • Address
      • Search for an Address
      • Search for an Address V2
    • Service Qualification
      • Perform Service Qualification Check
    • Order
      • v1
        • Create Order (NBN Activation)
          POST
        • Create Order (NBN Modification)
          POST
        • Create Order (NBN Disconnection)
          POST
        • Cancel (NBN Activation) Order
          POST
        • Get Order Detail (NBN)
          GET
        • List Orders (NBN)
          GET
    • Enquiry
      • Create Enquiry (NBN Diagnostic Test / Service Health Check)
      • Get Enquiry Detail
      • List Enquiries
    • Appointment
      • Query Appointment Timeslots
      • Book Appointment
    • NBN
      • Get Available Diagnostic Tests
    • Attachment
  • API Documentation (Legacy APIs)
    • WSDL Summary
    • API Guide
      • Account Charges
        • Add a Recurring Charge
        • Get Recurring Charge Details
        • Add a Manual Charge
      • ConnectYou
        • Create a Number Reservation
        • Get Available Numbers
        • queryResiEndPointService
        • Query a Business SIP Trunk Service
        • Get Zone Detail
        • Get Number Detail
      • Contact Log
        • Get Contact Log Types
        • Add a Contact Log
        • Update a Contact Log
        • Query Contact Logs
      • Device
        • getSupplierStockDetail
        • getSupplierProduct
        • getSupplierFreightOption
        • orderDevice
      • Mobile
        • Get Mobile Provisioning Product Catalogue
        • Query a Mobile Service
        • Query Mobile Add Ons
        • Query Mobile Feature Settings
        • Query Mobile Balance
      • Notifications
        • createNotification
        • notificationManageTemplate
      • Pooled Resource
        • Reserve a Resource
        • Unreserve a Resource
        • Select a Resource
        • Query Resource
      • Order
        • Mobile Order
          • Create a Mobile Service (New Number)
          • Create a Mobile Service (Port In Number)
          • Create a Pre-Activation Mobile Order (New Number)
          • Bar/Unbar/Disconnect a Mobile Service
          • Change Mobile Rate Plan
          • Change a Mobile Number
          • Replace a SIM Card
          • Modify Mobile Feature(s)
          • Modify Mobile Feature Setting(s)
          • Change Excess Spend Limit
          • Add a Once-off Bolt On
          • Add a Recurring Bolt On Pack
          • Remove a Recurring Bolt On Pack
        • Mobile (Data Pool) Order
          • Create a Data Pool
          • Add Consumers to Data Pool
          • Remove Consumers from Data Pool
        • ConnectYou (SIP Trunk) Order
          • Create a New Business SIP Trunk
          • Bar/Unbar International Calls on a Business SIP Trunk
          • Suspend Business SIP Trunk
          • Unsuspend Business SIP Trunk
          • Deactivate Business SIP Trunk
          • Port Numbers to a Business SIP Trunk
          • Configure Business SIP Trunk
        • Other Rated Order
          • Create an Other Rated Service
          • Change Access of an Other Rated Service
        • Create an Order
        • Cancel an Order
        • Query an Order
        • Reset an Order
      • Statements & Billing
        • Get a List of Customer Bills
        • Get Charge Item Detail for a Bill
        • Get a Single Bill PDF for a Customer
        • Get a Summary of a Bill
      • Unbilled Calls
        • Query Summary of Unbilled Calls & Charges
        • Query Detail of Unbilled Calls & Charges
      • OTP
        • Manage OTP (Get & Verify OTP)
    • Reference Data
  1. v1

Create Order (NBN Activation)

Testing Env
https://benzine.telcoinabox.com/tiab/api
Testing Env
https://benzine.telcoinabox.com/tiab/api
POST
https://benzine.telcoinabox.com/tiab/api
/v1/service/orders/activate
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

Example
{
    "orderType": "New",
    "subOrderType": "New",
    "serviceClass": "string",
    "remoteQualificationSearchId": "string",
    "qualificationSearchId": "string",
    "remoteOrderId": "string",
    "infrastructureOption": {
        "infrastructureID": "string",
        "portID": "string",
        "transferWaiverAccepted": true,
        "potsWaiverAccepted": true,
        "installOption": "string",
        "csn": "string"
    },
    "service": {
        "custNo": 0,
        "productType": "nbn-tc4",
        "planNo": "string",
        "serviceTerm": "string",
        "dataService": {
            "ipType": "Static",
            "authenticationType": "IPoE",
            "technologyType": "string"
        },
        "address": {
            "addressID": "string",
            "addressString": "string",
            "propertyName": "string",
            "subType": "string",
            "subNo": "string",
            "streetNoFrom": "string",
            "streetNoFromSuffix": "string",
            "streetNoTo": "string",
            "streetNoToSuffix": "string",
            "streetName": "string",
            "streetType": "string",
            "streetNameSuffix": "string",
            "suburb": "string",
            "state": "string",
            "postcode": "string",
            "poiID": "string",
            "poiName": "string",
            "poiState": "string"
        },
        "customerDetails": {
            "customerType": "Business",
            "customerNameForAccount": "string",
            "abn": "string",
            "acn": "string",
            "dateOfBirth": "2019-08-24T14:15:22Z"
        }
    },
    "device": {
        "deviceOption": "BYO",
        "deviceID": "string",
        "deviceSupplier": "BYO"
    },
    "deliveryDetails": {
        "deliveryAddress": {
            "addressString": "string",
            "addressLine1": "string",
            "addressLine2": "string",
            "suburb": "string",
            "state": "string",
            "postCode": "string"
        },
        "sameAddressDelivery": true,
        "deliveryRecipientName": "string",
        "deliveryContactName": "string",
        "deliveryContactNumber": "string",
        "deliveryInstructions": "string",
        "authorityToLeave": true
    },
    "customerContact": {
        "contactName": "string",
        "contactEmail": "string",
        "contactNumber": "string"
    },
    "custReqDate": "2019-08-24T14:15:22Z"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://benzine.telcoinabox.com/tiab/api/v1/service/orders/activate' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "orderType": "New",
    "subOrderType": "New",
    "serviceClass": "string",
    "remoteQualificationSearchId": "string",
    "qualificationSearchId": "string",
    "remoteOrderId": "string",
    "infrastructureOption": {
        "infrastructureID": "string",
        "portID": "string",
        "transferWaiverAccepted": true,
        "potsWaiverAccepted": true,
        "installOption": "string",
        "csn": "string"
    },
    "service": {
        "custNo": 0,
        "productType": "nbn-tc4",
        "planNo": "string",
        "serviceTerm": "string",
        "dataService": {
            "ipType": "Static",
            "authenticationType": "IPoE",
            "technologyType": "string"
        },
        "address": {
            "addressID": "string",
            "addressString": "string",
            "propertyName": "string",
            "subType": "string",
            "subNo": "string",
            "streetNoFrom": "string",
            "streetNoFromSuffix": "string",
            "streetNoTo": "string",
            "streetNoToSuffix": "string",
            "streetName": "string",
            "streetType": "string",
            "streetNameSuffix": "string",
            "suburb": "string",
            "state": "string",
            "postcode": "string",
            "poiID": "string",
            "poiName": "string",
            "poiState": "string"
        },
        "customerDetails": {
            "customerType": "Business",
            "customerNameForAccount": "string",
            "abn": "string",
            "acn": "string",
            "dateOfBirth": "2019-08-24T14:15:22Z"
        }
    },
    "device": {
        "deviceOption": "BYO",
        "deviceID": "string",
        "deviceSupplier": "BYO"
    },
    "deliveryDetails": {
        "deliveryAddress": {
            "addressString": "string",
            "addressLine1": "string",
            "addressLine2": "string",
            "suburb": "string",
            "state": "string",
            "postCode": "string"
        },
        "sameAddressDelivery": true,
        "deliveryRecipientName": "string",
        "deliveryContactName": "string",
        "deliveryContactNumber": "string",
        "deliveryInstructions": "string",
        "authorityToLeave": true
    },
    "customerContact": {
        "contactName": "string",
        "contactEmail": "string",
        "contactNumber": "string"
    },
    "custReqDate": "2019-08-24T14:15:22Z"
}'

Responses

🟢200OK
application/json
Body

Example
{
    "orderId": "string",
    "success": true
}
🟠403Invalid access
🟢200Validation Error
Modified at 2024-04-23 04:37:17
Previous
Perform Service Qualification Check
Next
Create Order (NBN Modification)
Built with