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

Get Order Detail (NBN)

Testing
Testing Env
https://benzine.telcoinabox.com/tiab/api
Testing Env
https://benzine.telcoinabox.com/tiab/api
GET
https://benzine.telcoinabox.com/tiab/api
/v1/service/orders/{orderId}
Get full detail for an order

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 *****************
Path Params

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 GET 'https://benzine.telcoinabox.com/tiab/api/v1/service/orders/' \
--header 'Authorization: Basic Og=='

Responses

🟢200OK
application/json
Body

Example
{
    "orderId": "string",
    "productType": "NBN",
    "orderType": "string",
    "orderSubType": "string",
    "customerPreferredDate": "2019-08-24T14:15:22Z",
    "providerOrderId": "string",
    "externalReference": "string",
    "orderStatus": "string",
    "orderSubStatus": "string",
    "orderExternalStatus": "string",
    "orderReason": "string",
    "dateAdded": "2019-08-24T14:15:22Z",
    "userAdded": "string",
    "dateModified": "2019-08-24T14:15:22Z",
    "userModified": "string",
    "orderContact": {
        "contactName": "string",
        "contactNumber": "string",
        "contactEmail": "user@example.com"
    },
    "customerDetails": {
        "custno": 0,
        "group": {
            "id": 0,
            "name": "string",
            "href": "string"
        },
        "customerIdentity": {
            "customerType": "Business",
            "company": "string",
            "legalEntity": "string",
            "abn": "string",
            "acn": "string",
            "customerSalutation": "string",
            "customerGivenNames": "string",
            "customerSurname": "string",
            "customerDob": "string"
        }
    },
    "device": {
        "deviceOption": "BYO",
        "deviceId": "string"
    },
    "deliveryDetails": {
        "deliveryAddress": {
            "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",
            "countryCode": "AU"
        },
        "deliveryContactName": "string",
        "deliveryContactNumber": "string",
        "deliveryRecipientName": "string",
        "authorityToLeave": true,
        "deliveryInstructions": "string"
    },
    "qualification": {
        "remoteQualificationSearchId": "string",
        "qualificationSearchId": "string",
        "remoteOrderId": "string"
    },
    "infrastructureOption": {
        "infrastructureID": "string",
        "portID": "string",
        "transferWaiverAccepted": true,
        "potsWaiverAccepted": true,
        "installOption": "string",
        "csn": "string"
    },
    "dids": [
        {
            "changeType": "string",
            "countryCode": "string",
            "rangeType": "string",
            "selectNumber": "string",
            "rangeSize": "string",
            "range": "string",
            "zoneId": "string",
            "subZoneId": "string"
        }
    ],
    "sipPortDetails": {
        "portType": "CAT_A",
        "portingNumbers": [
            {
                "serviceNumberRangeStart": "string",
                "serviceNumberRangeEnd": "string"
            }
        ],
        "retailServiceProvider": "string",
        "accountNumber": "string",
        "customerAuth": true,
        "termsAndConditions": true
    },
    "service": {
        "custNo": 0,
        "lineSeqNo": 0,
        "parentLineSeqNo": 0,
        "phone_number": "string",
        "usageType": "string",
        "subUsageType": "string",
        "name": "string",
        "department": "string",
        "lineType": "B",
        "agentNo": 0,
        "dateReleased": "2019-08-24T14:15:22Z",
        "dateAdded": "2019-08-24T14:15:22Z",
        "userAdded": "string",
        "dateModified": "2019-08-24T14:15:22Z",
        "userModified": "string",
        "instance": [
            {
                "serviceid": "string",
                "dateDeclared": "2019-08-24T14:15:22Z",
                "dateProvisioned": "2019-08-24T14:15:22Z",
                "dateDisconnected": "2019-08-24T14:15:22Z",
                "provisionStatus": "string",
                "status": "string",
                "statusExtra": "string",
                "reasonStatusChange": "string",
                "dateAdded": "2019-08-24T14:15:22Z",
                "userAdded": "string",
                "dateModified": "2019-08-24T14:15:22Z",
                "userModified": "string"
            }
        ],
        "serviceAgreement": {
            "planNo": 0,
            "retailContractTerm": 0,
            "retailContractStartDate": "string",
            "retailContractEndDate": "string",
            "whsPlanNo": "string",
            "wholesaleContractTerm": 0,
            "wholesaleContractStartDate": "string",
            "wholesaleContractEndDate": "string"
        },
        "voipService": {
            "serviceType": "PBXDID",
            "pbxId": "string",
            "defaultDidPlanNo": 0,
            "defaultExtPlanNo": 0,
            "extId": 0,
            "maxCalls": 0,
            "packageId": 0,
            "packageDesc": "string",
            "feature": [
                {
                    "hvId": 0,
                    "featureType": "string",
                    "featureSubType": "string",
                    "dateStart": "2019-08-24T14:15:22Z",
                    "dateEnd": "2019-08-24T14:15:22Z",
                    "dateAdded": "2019-08-24T14:15:22Z",
                    "userAdded": "string",
                    "dateModified": "2019-08-24T14:15:22Z",
                    "userModified": "string"
                }
            ]
        },
        "dataService": {
            "username": "string",
            "password": "string",
            "ipAddress": "string",
            "ipType": "Static",
            "subnetMask": "string",
            "authenticationType": "IPoE",
            "networkProfile": "string"
        },
        "nbnService": {
            "technologyType": "FTTP",
            "avcIdData": "string",
            "avcIdVoice": "string",
            "portIdData": "string",
            "portIdVoice": "string",
            "infrastructureId": "string",
            "pri": "string",
            "poi": "string",
            "region": "string",
            "isNfas": true,
            "hasNfasCommitment": true,
            "legacyTechnologyType": "string",
            "nfasCommitmentDate": "2019-08-24T14:15:22Z"
        },
        "inboundService": {
            "routingType": "Simple",
            "firstAnswerpoint": "string",
            "secondAnswerpoint": "string",
            "finalAnswerpoint": "string",
            "complexRouting": "string",
            "transferType": "string",
            "terminationNumber": "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",
            "countryCode": "AU"
        },
        "contact": {
            "contactName": "string",
            "contactPhone": "string",
            "contactEmail": "user@example.com",
            "contactDob": "2019-08-24"
        }
    },
    "sipBinding": [
        {
            "changeType": "ADD",
            "name": "string",
            "authenticationMethod": "string",
            "ipAddress": "string",
            "port": 0,
            "routingActionNumber": 0
        }
    ],
    "sipSettings": {
        "resetSipPassword": true,
        "resetEasPassword": true,
        "resetCfsPin": true,
        "timeZone": "string",
        "lineSelectionMethod": "string",
        "routingPrefixId": "string",
        "serviceLocation": "string",
        "callBarring": "string"
    },
    "orderNotes": [
        {
            "id": "string",
            "name": "string",
            "description": "string",
            "creatorName": "string",
            "creationDate": "string",
            "type": "string"
        }
    ]
}
🟠403Invalid access
Modified at 2024-05-03 02:05:48
Previous
Cancel (NBN Activation) Order
Next
List Orders (NBN)
Built with