Get Order Detail (NBN)

Testing Env

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

GET

/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

Responses

🟢200OK

application/json

Body

🟠403Invalid access

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://benzine.telcoinabox.com/tiab/api/v1/service/orders/' \
--header 'Authorization: Basic <encoded-value>'

Response Example

200 - Example 1

{
    "id": "string",
    "interactionStatus": {
        "id": "string",
        "name": "string",
        "type": "string"
    },
    "interactionDate": "string",
    "businessInteractionInvolves": [
        {
            "type": "Submitter",
            "partyRole": {
                "id": "string",
                "type": "string",
                "status": "string",
                "party": {
                    "id": "string",
                    "name": "string",
                    "status": "string",
                    "firstName": "string",
                    "lastName": "string",
                    "organisationName": "string"
                },
                "contactMediums": [
                    {
                        "emailAddress": "string",
                        "countryCode": "string",
                        "areaCode": "string",
                        "number": "string",
                        "@type": "string"
                    }
                ],
                "billingAccountId": "string",
                "defaultCpaId": "string"
            }
        }
    ],
    "businessInteractionComprisedOf": [
        {
            "action": "string",
            "itemInvolvesInventoryEntities": [
                {
                    "id": "string",
                    "name": "string",
                    "offeringDescribes": {
                        "id": "string",
                        "name": "string",
                        "version": "string"
                    },
                    "describedBy": {
                        "csn": "string",
                        "abbServiceId": "string",
                        "username": "string",
                        "password": "string",
                        "technologyType": "string",
                        "productType": "string",
                        "authenticationType": "string",
                        "serviceTerm": "string",
                        "avcID": "string",
                        "portID": "string",
                        "infrastructureID": "string",
                        "pri": "string",
                        "customerDetails": {
                            "customerType": "string",
                            "customerNameForAccount": "string",
                            "dateOfBirth": "string",
                            "abn": "string",
                            "acn": "string"
                        },
                        "address": {
                            "addressID": "string",
                            "addressString": "string",
                            "propertyName": "string",
                            "streetNoFrom": "string",
                            "streetNoFromSuffix": "string",
                            "streetNoTo": "string",
                            "streetNoToSuffix": "string",
                            "streetName": "string",
                            "streetNameSuffix": "string",
                            "streetType": "string",
                            "suburb": "string",
                            "state": "string",
                            "postcode": "string",
                            "poiID": "string",
                            "poiName": "string",
                            "poiState": "string"
                        },
                        "planDetails": {
                            "ratePlanID": "string",
                            "carrierPlanId": "string",
                            "sla": "string",
                            "cvcInclusion": "string",
                            "bandwidthProfile": "string",
                            "productId": "string"
                        },
                        "ipType": "Dynamic",
                        "ipAddress": "string",
                        "action": "string",
                        "shellServiceStatusProcess": "string",
                        "subnetMask": "255.255.255.255",
                        "nfas": {
                            "isNfas": true,
                            "hasNfasCommitment": true,
                            "nfasCommitmentDate": "string",
                            "legacyTechnologyType": "string"
                        },
                        "networkType": "ABB",
                        "serviceStatus": "string",
                        "ouiID": "string"
                    }
                }
            ],
            "@type": "string"
        }
    ],
    "describedBy": {},
    "externalReferences": [
        {
            "referenceId": "string",
            "system": "string"
        }
    ],
    "priority": 0,
    "completionDate": "string",
    "notes": [
        {
            "id": "string",
            "name": "string",
            "description": "string",
            "creatorName": "string",
            "creationDate": "string",
            "type": "string"
        }
    ],
    "customerReference": "string",
    "category": "Service",
    "type": "New"
}

Modified at 2025-09-01 04:29:18

Cancel (NBN Activation) Order

List Orders (NBN)