Get Order Detail (NBN)

Get full detail for an order

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

Responses

🟢200OK

application/json

Body

orderId

string

optional

Unique identifier of the Order.

productType

enum<string>

required

Type of Product being ordered

Allowed values:

NBNMOBILESIPTRUNKRESIUNITE_CALLINGUC_THINADVANCED_PBX

orderType

string

required

Order Type

orderSubType

string

required

Order Sub Type

customerPreferredDate

string <date-time>

optional

Customer's Preferred Date for completing the order

providerOrderId

string

optional

Order Identifier for the related Order on the Carrier/Provider side

externalReference

string

optional

External System Reference for the Order

orderStatus

string

optional

Order Status

orderSubStatus

string

optional

Order Sub Status

orderExternalStatus

string

optional

Order Status from the External Carrier/Provider

orderReason

string

optional

Reason for creating the order

dateAdded

string <date-time>

optional

Datetime of when the order was created

userAdded

string

optional

User who created the order

dateModified

string <date-time>

optional

Datetime of when the order was last modified

userModified

string

optional

User who modified the order

orderContact

object

optional

Contact details for this Order

contactName

string

optional

Name of the contact person for this Order

contactNumber

string

optional

Phone number of the contact person for this Order

contactEmail

string <email>

optional

Email Address of the contact person for this Order

customerDetails

object

required

Customer details for this Order

custno

integer

optional

Customer Account Number.

group

object

optional

The Service Provider Group that this Customer belongs to.

customerIdentity

object

optional

The identity of the Customer that owns this Account.

device

object

optional

Details about any device ordered as part of this Order

deviceOption

enum<string>

optional

Indicates whether a New device is being ordered with this order, or Customer is choosing to use a BYO device

Allowed values:

BYONew

deviceId

string

optional

Identifier of the Device being ordered

deliveryDetails

object

optional

Delivery details for this Order

deliveryAddress

object (Address)

optional

Delivery Address

deliveryContactName

string

optional

Delivery Contact Name

deliveryContactNumber

string

optional

Delivery Contact Number

deliveryRecipientName

string

optional

Delivery Recipient Name

authorityToLeave

boolean

optional

Indicator of whether the package can be left on doorstep without signing

deliveryInstructions

string

optional

Additional instructions for the delivery

qualification

object

optional

Details about the Service Qualification done for this Order

remoteQualificationSearchId

string

required

SQ ID returned on the SQ response used for the order.

qualificationSearchId

string

required

SQ ID returned on the SQ response used for the order.

remoteOrderId

string

required

SQ ID returned on the SQ response used for the order.

infrastructureOption

object

optional

Details about the infrastructure option selected for this order. Applicable for NBN & Opticomm orders

infrastructureID

string

required

The Infrastructure ID to use for the connection based on the SQ response

NTDxxx for non-Copper tech types
-CPIxxx for Copper tech types
-SUBSEQUENT_INSTALL where a new NTD is required
-NEW_INFRASTRUCTURE where no existing infrastructure exists

The ID can be retrieved from the Service Qualification Response. Multiple Infrastructure IDs may be returned, you need to determine which to use based on the End Customer’s requirements.

portID

string

optional

The NTD Port ID to connect on, where selected Infrastructure Option is an Existing NTD

transferWaiverAccepted

boolean

optional

Indicator confirming that Transfer Waiver has been accepted where SubOrderType is Transfer

potsWaiverAccepted

boolean

optional

Indicator confirming that POTS Waiver has been accepted where SubOrderType is Transition and CSN has not been provided

installOption

string

required

Indication of what installation to use for the Infrastructure selected.

Pass one of the install options returned on the Service Qualification Response for the selected Infrastructure ID.

csn

string

optional

The existing CSN connected at the selected Infrastructure Option

Note: CSN is used for validation only, CSN will not be kept on transfer/transition

dids

array [object {8}]

required

List of DIDs for the Trunk

changeType

string

required

Type of action to take with this number block

countryCode

string

required

The country code for the DID being allocated

rangeType

string

required

The type of number being allocated

selectNumber

string

required

Whether or not the number is being selected before reservation or not

rangeSize

string

required

The size of the block

range

string

optional

The service number to be allocated

zoneId

string

optional

The zone ID of the service being allocated

subZoneId

string

optional

The subzone ID of the service being allocated

sipPortDetails

object

optional

Details about the Port being submitted for a Hosted Voice service

portType

enum<string>

required

Type of Port being submitted

Allowed values:

CAT_ACAT_C

portingNumbers

array [object {2}]

required

List of numbers being ported

retailServiceProvider

string

required

Losing Service Provider for the Numbers

accountNumber

string

required

Losing Account Number for the Numbers

customerAuth

boolean

required

Indicator of whether customer has authorised the port to take place

termsAndConditions

boolean

required

Indicator of whether customer has accepted the T&Cs to proceed with the port

service

object

required

Details about the Service being provisioned

custNo

integer

required

Customer Account number that this service belongs to.

lineSeqNo

integer

required

Unique instance identifier for the service

parentLineSeqNo

integer

optional

Indicates whether this service has a parent service it's linked to and what that parrent service is

phone_number

string

required

Unique service identifier for this service

usageType

string

required

Type of service

subUsageType

string

required

Sub-type of the service

name

string

optional

Name given to the service

department

string

optional

Department that this service may be under

lineType

enum<string>

optional

Indication of the type of customer this service is for

Allowed values:

agentNo

integer

optional

Agent identifier of the person who sold this service in

dateReleased

string <date-time>

optional

Datetime the service was end dated in the system

dateAdded

string <date-time>

optional

Datetime of when this service was added in the system

userAdded

string

optional

User who added this service in the system

dateModified

string <date-time>

optional

Datetime of when this service was last modified

userModified

string

optional

User who last modified this service

instance

array[object (Service Instance) {12}]

required

Details about the billing instances for this services

serviceAgreement

object (Service Agreement)

optional

Details about the agreement that exists for this service, including selected plan and contract term

voipService

object (Voip Service)

optional

Details relating to Voip services

dataService

object (Data Service)

optional

Details relating to Data services

nbnService

object (NBN Service)

optional

Details relating to NBN services

inboundService

object (Inbound Service)

optional

Details relating to Inbound Numbers

address

object (Address)

optional

Address details for the Service

contact

object (Service Contact)

optional

Contact Details for this service

sipBinding

array [object {6}]

optional

Details about the SIP Binding for the Trunk

changeType

enum<string>

required

Type of action to take with this SIP binding

Allowed values:

ADDCHANGEDELETE

name

string

required

The name of the binding that is being CHANGED or DELETED

authenticationMethod

string

required

The authentication method that is being ADDED

ipAddress

string

optional

The ip address of the binding that is being ADDED

port

integer

optional

The port of the binding that is being added

routingActionNumber

integer

optional

The order of the binding

sipSettings

object

optional

List of settings that can be modified for a SIP service via an order

resetSipPassword

boolean

optional

Whether or not the SipPassword should be reset

resetEasPassword

boolean

optional

Whether or not the EasPassword should be reset

resetCfsPin

boolean

optional

Whether or not the resetCfsPin should be reset

timeZone

string

optional

The timezone of the service

lineSelectionMethod

string

optional

The line selection method

routingPrefixId

string

optional

The routing prefix Id

serviceLocation

string

optional

The location of the service

callBarring

string

optional

The call barring level of the service

orderNotes

array[object (Order Note) {6}]

optional

List of activity notes for this order

string

optional

ID of the activity note.

name

string

optional

The name of the activity note

description

string

optional

Actual text of the note that's been added

creatorName

string

optional

Name of the User that created the note

creationDate

string

optional

Datetime of when this note was created

type

string

optional

Type of note that's been added

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

Request

Request samples

Responses