← Back to Orders

Introduction

Use the orders endpoint to create an order for the location / infrastructure you are interested in. This endpoint will return the location of the order resource in the response headers and the order resource in the body as at the time of creation.

Order Type

When an order is created it will have an order type (orderType) of either:

  1. New or

  2. Transfer

Request Lifecycle

To create an order and a service for the location / infrastructure, you must send a POST request to /api/connect/orders/create with the request specification.

If the order request was successful, the response’s http status will be 201. The response body will have information about the newly created order (order resource). There will be a Location response header with a URL. This URL returns the same information (order resource) as the response body about the newly created order.

Request Specifications

Table 1. API Versions
Version Header Changes

1 (Deprecated)

X-API-VERSION=1

Initial Version

2 (Deprecated)

X-API-VERSION=2

No change

3

X-API-VERSION=3

No change

4

X-API-VERSION=4

New required field added - "aggregationMethod"

5

X-API-VERSION=5

No change

6

X-API-VERSION=6

No Change

7

X-API-VERSION=7

No Change

ALL

ALL

During the first half of 2025 to meet nbn requirements, the avc id will be required to be provided if the Port’s status is "Used" or serviceStatus is "Line In Use".

API Version 4, 5, 6 and 7 - POST

POST Request

Table 2. POST Request

Verb

POST

URI

/api/connect/orders/create
Table 3. POST HTTP Request Headers
Name Description

Authorization

The OAuth bearer access token

X-API-VERSION

The version of the endpoint you are accessing
Table 4. POST Request Body Fields
Path Type Description Required

sourceType

String

The service source to order for. Currently only nbn is supported.

Required

customerReference

String

Should not be greater than 200 characters.

quoteName

String

Should not be greater than 50 characters.

contactName

String

Should not be greater than 40 characters.

Required

contactPhone

String

Valid Australian landline or mobile phone number.

Required

contactEmail

String

Valid email address. Should not be greater than 50 characters.

Required

remoteQualificationSearchId

String

nbn qualification id.

Required

qualificationSearchId

String

360 qualification id.

Required

remoteOrderId

String

nbn order id.

Required

locationId

String

nbn location id.

Required

planName

String

Required

term

Number

Required

trafficClass

String

tc2 | tc4 | ee

Required

productType

String

Allowed product type is "Access Only"

restorationSla

String

Required

potsServiceOwner

Boolean

Indicates the customer is the owner of the current service. Set this to true or false when SQ has returned "hasActivePOTS": true, "serviceType": "ULL" or "ULL - Special"

potsWaiver

Boolean

Indicates the customer has confirmed they are allowed to transfer the existing service. Set this to true when SQ has returned "hasActivePOTS": true, "serviceType": "FNN" or "FNN -Special and "potsInterconnectMatch": falseor "hasActivePOTS": true, "serviceType": "ULL" or "ULL - Special" and "potsServiceOwner": false

infrastructureId

String

portId

Number

requireVLAN

Boolean

Required

vlanId

Number

Required when requireVLAN is true, value should be between 2 - 4004

Required

ntdInstallation

String

nbn-tech | nbn-no-action | nbn-dispatch. Refer to the SQ response to obtain a list of valid installation options. The option with recommended 'true' is the preferred install option. * if you can order a new infrastructure and you do, provide an option under "infrastructureInstallationOptions" : [ { "option" : "nbn-tech", "recommended" : true, "fees" : [ ], "hardwareShortfall" : null } ] " * if you can order an existing infrastructure and you do, provide an option from under the chosen infrastructure "infrastructureId": "CPI380100023422", "installationOptions": [ { "option": "nbn-tech", "recommended": true, "fees": [], "hardwareShortfall": null } ]

Required

ntdName

String

Required when ntdInstallation is nbn-dispatch, Shipping details - Recipient’s name

ntdPhoneNumber

String

Required when ntdInstallation is nbn-dispatch, a valid Australian landline or mobile phone number

ntdSameAddressDelivery

Boolean

Shipping details - same as site address

ntdBusinessName

String

Required when ntdSameAddressDelivery is false. Should not be greater than 40 characters.

ntdAddressLine1

String

Required when ntdSameAddressDelivery is false. Should not be greater than 40 characters.

ntdAddressLine2

String

Required when ntdSameAddressDelivery is false. Should not be greater than 40 characters.

ntdSuburb

String

Required when ntdSameAddressDelivery is false. Should not be greater than 30 characters.

ntdPostcode

String

Required when ntdSameAddressDelivery is false. Should not be greater than 4 characters.

ntdState

String

Required when ntdSameAddressDelivery is false. It can either be the abbreviated state or the full name.

ntdAuthorityToLeave

Boolean

Required when ntdInstallation is nbn-dispatch.

ntdDeliveryInstructions

String

Should not be greater than 128 characters.

aggregationMethod

String

L2TP | ETHERNET

Required

avcIdForTransfer

String

The avc id must be provided if the Port’s status is "Used" or the serviceStatus is "Line In Use". NBN will use this AVC ID to verify the transfer is allowed. It is suggested you verify the AVC ID by performing an AVC SQ before submitting the order.

transferType

String

The transfer type must be provided if the Port’s status is "Used" or the serviceStatus is "Line In Use". Possible values are SERVICE_TRANSFER and CONNECT_OUTSTANDING. If the transfer type is CONNECT_OUTSTANDING, there is no need to provide an AVC ID (avcId).

POST Response

Table 5. POST HTTP Status Codes
Status Code Meaning

201

The request was created successfully

401

Bearer token is missing or invalid

404

You do not have permission to perform this task

422

There are validation errors on the request you mean. Check the response body to see what fields had issues.

500

There was an unexpected error processing the request

502

There was an unexpected error with one or more of the upstream services
Table 6. POST HTTP Response Headers
Name Description

Location

The URL of the new order you just created.

API Version 4, 5, 6 and 7 - GET

GET Request

Note
 The URI will be given to you in the Location header of the POST request.
Table 7. GET Request

Verb

GET

URI

/api/connect/orders/{id}
Table 8. GET Request Path Variables

Path Variable

Purpose

id

The ID of the order. This was generated by the POST request
Table 9. GET HTTP Request Headers
Name Description

Authorization

The OAuth bearer access token

X-API-VERSION

The version of the endpoint you are accessing

GET Response

Table 10. GET HTTP Status Codes
Status Code Meaning

200

The request was created successfully

401

Bearer token is missing or invalid

404

You do not have permission to perform this task
Table 11. GET Response Body Fields
Path Type Description

id

Number

The Connect identifier of the order resource.

orderType

String

Whether the order is for a new service or a transfer.

status

String

Status of the order.

serviceClass

String

The standard nbn service class of the site.

technologyType

String

The type of nbn technology that the service is delivered through. See "nbn Technology Type Map" below.

trafficClass

String

The nbn traffic class, e.g. TC4

installationType

String

Whether the NTD is going to be installed by an nbn technician or by the site’s tenant.

customerRef

String

The reference string that you provided when you placed the order.

locId

String

The nbn LOC ID of the address of the site the order is for.

avcId

Null

The AVC ID of the virtual circuit that is created for this service. This might not be set, depending on when you make the call. This is not set until the order has been accepted by the NBN.

avcIdForTransfer

String

The AVC ID that was specified at order time for a transfer order. That is for an NTD with a port that is Used or NCD (Copper Pair) with a Line In Use. Null in all other cases.

vlanId

Number

The VLAN that was specified at order time.

poi

String

The code of the nbn POI that the site will be serviced from.

poiName

String

The name of the nbn POI that the site will be serviced from.

region

String

The nbn region identifier that nbn places the site in.

eSla

String

The level of restoration SLA that the service will have. Currently, only Standard is available.

bandwidthProfile

Object

An object that contains details on the bandwidth profile that was selected for the service.

bandwidthProfile.speedDown

Number

The download speed of the service, in mbps.

bandwidthProfile.speedUp

Number

The upload speed of the service, in mbps.

bandwidthProfile.planName

String

The name of the plan that was selected for the service.

bandwidthProfile.cvcInclusion

Number

The CVC inclusion that is applied to CVC rebates, if applicable.

infrastructure

Object

Information about the infrastructure at the site, including NTDs and Copper Pairs.

infrastructure.id

String

The nbn identifier of the equipment.

infrastructure.portId

String

The port on the device that was chosen for the service.Only for NTD infrastructure.

infrastructure.productId

String

The nbn identifier of the product component that is activated for the Customer.

address

Object

The address of the site where the service is being provided.

address.buildingLevel

String

The level that the site is on.

address.unitNumber

String

The unit number of the site.

address.buildingName

String

The name of the building.

address.streetNumber

String

The street number of the site.

address.street

String

The name of the street, including street type.

address.suburb

String

The suburb.

address.state

String

The state.

address.postcode

String

The postcode.

address.formattedAddress

String

The whole address, formatted in a single line.

fee

Object

Applied fee for the ordered plan.

fee.attributes

Object

Attributes of the ordered plan.

fee.oneTimeCharge.amount

String

One time charge for the ordered plan.

fee.oneTimeCharge.currency

String

Currency of the one time charge.

fee.oneTimeCharge.symbol

String

Symbol of the one time charge currency.

fee.monthlyRecurringCharge.amount

String

Monthly recurring charge of the ordered plan.

fee.monthlyRecurringCharge.currency

String

Currency of the monthly recurring charge.

fee.monthlyRecurringCharge.symbol

String

Symbol of the monthly recurring charge currency.

additionalFees

Array

List of additional fees applied for the ordered plan.

additionalFees.[].addOnTypeName

String

Name of the addon type.

additionalFees.[].fee

Object

Applied charge for the addon type.

additionalFees.[].fee.attributes

Object

Attributes of the addon type.

additionalFees.[].fee.oneTimeCharge.amount

String

One time charge of the addon type.

additionalFees.[].fee.oneTimeCharge.currency

String

Currency of the addon type charge.

additionalFees.[].fee.oneTimeCharge.symbol

String

Symbol of the addon type charge currency.

additionalFees.[].fee.monthlyRecurringCharge.amount

String

Monthly recurring charge of the addon type.

additionalFees.[].fee.monthlyRecurringCharge.currency

String

Currency of the monthly recurring charge.

additionalFees.[].fee.monthlyRecurringCharge.symbol

String

Symbol of the monthly recurring charge currency.

appointments

Array

List of appointments for the order.

appointments.[].id

Number

The Connect identifier of the appointment resource.

appointments.[].nbnAppointmentId

String

The NBN identifier of the appointment.

appointments.[].slotType

String

The type of confirmed appointment slot. AM/ PM.

appointments.[].startTime

String

The date/time, including UTC offset, appointment start time will be visible only when appointment has been confirmed.

appointments.[].endTime

String

The date/time, including UTC offset, appointment end time, will be visible only when appointment has been confirmed.

appointments.[].timezoneOffset

String

Represents an offset defined in a Timezone.

appointments.[].priorityAssist

Boolean

Indicates whether the appointment is priority assisted or not.

appointments.[].eSla

String

The level of restoration SLA that the service will have. Currently, only Standard is available.

appointments.[].demandType

String

The type of installation the appointment slot is provided for.

appointments.[].contact

Object

The contact details of the appointment.

appointments.[].contact.name

String

The name of the contact.

appointments.[].contact.type

String

The type of the contact.

appointments.[].contact.phone

String

The number of the contact.

appointments.[].contact.notes

String

Additional information. If any.

appointments.[].bookedOn

String

The date/time, including UTC offset, when nbn validated the appointment.

appointments.[].cancellationRequests

Array

List of cancellation requests for the appointment.

appointments.[].cancellationRequests[].id

Number

Connect identifier of the cancellation request resource.

appointments.[].cancellationRequests[].status

String

The status of the cancellation request. One of IN_PROGRESS, COMPLETE or FAILED.

appointments.[].cancellationRequests[].statusDateChangedTo

String

The date/time, including UTC offset, the status was set.

appointments.[].cancellationRequests[].requestedOn

String

The date/time, including UTC offset, the cancellation request was made.

appointments.[].cancellationRequests[].errorDetail

String

If the status is FAILED, will contain details on why the request failed.

360ServiceId

Number

The ID of the 360 service that the order fulfils

aggregationMethod

String

L2TP | ETHERNET

isNfas

Boolean

Indicates whether the order is a nbn Co’s Fibre Access Service (NFAS)

legacyTechnologyType

String

Legacy nbn technology type of the the service if the service is NFAS otherwise NULL

isCancellable

Boolean

Indicates whether the order is cancellable

transferType

String

Indicates type of the transfer if the order is a transfer order otherwise value will be NULL Possible values are SERVICE_TRANSFER and CONNECT_OUTSTANDING
Table 12. Service Order statuses
Status Description

OPEN

Order is created and ready to be submitted to nbn

IN_PROGRESS

Order is submitted to nbn and is in progress.

AWAITING_CUSTOMER

Created order needs action from customer

IN_ERROR

Order is in error

CANCELLATION_REQUESTED

Order is requested for cancellation

CANCELLED

Order is cancelled by nbn

REJECTED

Order is rejected by nbn

FAILED

Order is failed by nbn.

COMPLETE

Order is successfully processed by nbn, and the service is ready to be used.

OPEN_TRANSFER_ORDER

Applicable only to internal transfer orders.

Order status will be set to OPEN_TRANSFER_ORDER once the existing active service is disconnected by nbn. It indicates that the transfer order is now ready to be submitted to the nbn

TRANSFER_ORDERING

Applicable only to internal transfer orders.

Set when the transfer order is submitted to nbn for processing

TRANSFER_ORDER_IN_RETRY

Applicable only to internal transfer orders.

Set when the transfer order submitted is rejected by nbn due to any reason and 360 internally continue to re-submit the order

API Version 4, 5, 6 and 7 - Examples - Request

Successful Order creation

An order request is created by sending a POST request to /api/connect/orders/create.

POST Request
POST /api/connect/orders/create HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 7
Content-Length: 667
Host: 360-api.superloop.com

{
  "sourceType" : "nbn",
  "planName" : "Fixed Wireless Plus",
  "term" : 1,
  "trafficClass" : "tc4",
  "remoteQualificationSearchId" : "90cf4836-2bf6-4e92-b10a-f54045e85255",
  "qualificationSearchId" : "d8a71e0b-4da6-44b4-a28e-b6d3ff5abb5c",
  "locationId" : "LOC151638001609",
  "remoteOrderId" : "1eb878c4-d4b9-6e0e-9f99-7e380507f753",
  "productType" : "Access Only",
  "restorationSla" : "Standard",
  "contactName" : "Bruce Wayne",
  "contactPhone" : "4000000000",
  "contactEmail" : "bruce@wayne.com",
  "infrastructureId" : null,
  "portId" : null,
  "ntdInstallation" : "nbn-tech",
  "requireVLAN" : true,
  "vlanId" : 56,
  "aggregationMethod" : "L2TP"
}

If all required fields were given, then the response to the request will have:

  1. a http status of 201

  2. a Location header with the URI of the newly created order entity.

Successful POST Response
HTTP/1.1 201 Created
Location: /api/connect/orders/1
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1745

{
  "id" : 1,
  "orderType" : "new",
  "status" : "OPEN",
  "serviceClass" : "5",
  "technologyType" : "FW",
  "trafficClass" : "TC4",
  "installationType" : "nbn-tech",
  "customerRef" : null,
  "locId" : "LOC151638001609",
  "avcId" : null,
  "avcIdForTransfer" : null,
  "vlanId" : 56,
  "poi" : "9trptogdu",
  "poiName" : "West Milo",
  "region" : "Urban",
  "eSla" : "Standard",
  "bandwidthProfile" : {
    "speedDown" : 75,
    "speedUp" : 10,
    "planName" : "Fixed Wireless Plus",
    "cvcInclusion" : null
  },
  "infrastructure" : null,
  "address" : {
    "buildingLevel" : null,
    "unitNumber" : null,
    "buildingName" : null,
    "streetNumber" : "1609",
    "street" : "GURRIEL AV",
    "suburb" : "BULLEEN",
    "state" : "VIC",
    "postcode" : "3105",
    "formattedAddress" : "1609 GURRIEL Avenue, BULLEEN, Victoria, 3105"
  },
  "fee" : {
    "attributes" : {
      "plan" : "Fixed Wireless Plus",
      "term" : "1"
    },
    "oneTimeCharge" : {
      "amount" : "0.00",
      "currency" : "AUD",
      "symbol" : "$"
    },
    "monthlyRecurringCharge" : {
      "amount" : "50.00",
      "currency" : "AUD",
      "symbol" : "$"
    }
  },
  "additionalFees" : [ {
    "addOnTypeName" : "SLA",
    "fee" : {
      "attributes" : {
        "sla" : "Standard"
      },
      "oneTimeCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      },
      "monthlyRecurringCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      }
    }
  } ],
  "appointments" : [ ],
  "aggregationMethod" : "L2TP",
  "legacyTechnologyType" : null,
  "transferType" : null,
  "360ServiceId" : null,
  "isCancellable" : false,
  "isNfas" : false
}

Optionally, Once you have the URI from the Location header, you can make a GET request to get the newly created order information.

GET Request
GET /api/connect/orders/1 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 5
Host: 360-api.superloop.com
Successful GET Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2142

{
  "id" : 1,
  "orderType" : "new",
  "status" : "OPEN",
  "serviceClass" : "3",
  "technologyType" : "FTTP",
  "trafficClass" : "TC4",
  "installationType" : "nbn-tech",
  "customerRef" : "ABC123",
  "locId" : "LOC151638001451",
  "avcId" : null,
  "avcIdForTransfer" : null,
  "vlanId" : 100,
  "poi" : "3CBN",
  "poiName" : "Cranbourne",
  "region" : "Urban",
  "eSla" : "Standard",
  "bandwidthProfile" : {
    "speedDown" : 100,
    "speedUp" : 20,
    "planName" : "Home Fast 100/20",
    "cvcInclusion" : null
  },
  "infrastructure" : null,
  "address" : {
    "buildingLevel" : null,
    "unitNumber" : null,
    "buildingName" : null,
    "streetNumber" : "1451",
    "street" : "GARLAND DR",
    "suburb" : "BALWYN EAST",
    "state" : "VIC",
    "postcode" : "3103",
    "formattedAddress" : "1451 GARLAND Drive, BALWYN EAST, Victoria, 3103"
  },
  "fee" : {
    "attributes" : {
      "plan" : "Home Fast 100/20",
      "term" : "1"
    },
    "oneTimeCharge" : {
      "amount" : "0.00",
      "currency" : "AUD",
      "symbol" : "$"
    },
    "monthlyRecurringCharge" : {
      "amount" : "65.00",
      "currency" : "AUD",
      "symbol" : "$"
    }
  },
  "additionalFees" : [ {
    "addOnTypeName" : "SUBSEQUENT_INSTALLATION_CHARGE",
    "fee" : {
      "attributes" : {
        "technology_type" : "fttp"
      },
      "oneTimeCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      },
      "monthlyRecurringCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      }
    }
  }, {
    "addOnTypeName" : "SLA",
    "fee" : {
      "attributes" : {
        "sla" : "Standard"
      },
      "oneTimeCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      },
      "monthlyRecurringCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      }
    }
  } ],
  "appointments" : [ ],
  "aggregationMethod" : "L2TP",
  "legacyTechnologyType" : null,
  "transferType" : null,
  "360ServiceId" : null,
  "isCancellable" : false,
  "isNfas" : false
}

Invalid Order creation

If the order request is invalid for any reason, a http status of 422 is returned and the body of the response will list the problems with the request.

This example is of submitting an order request without a suburb field.

POST Request
POST /api/connect/orders/create HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 7
Content-Length: 545
Host: 360-api.superloop.com

{
  "sourceType" : "nbn",
  "planName" : "Home Fast 100/40",
  "term" : 1,
  "trafficClass" : "tc4",
  "remoteQualificationSearchId" : "1eb878c4-d5e1-63cc-8780-7e380507f753",
  "qualificationSearchId" : "4317d956-1b3f-43f1-8161-28f72b5b55cd",
  "locationId" : "LOC151638001451",
  "remoteOrderId" : "1eb878c4-d4b9-6e0e-9f99-7e380507f753",
  "productType" : "Access Only",
  "restorationSla" : "Standard",
  "contactEmail" : "bruce@wayne.com",
  "infrastructureId" : "NTD151638001451",
  "portId" : null,
  "requireVLAN" : true,
  "vlanId" : 56
}
POST Response with request validation errors
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 946

{
  "httpStatusCode" : 422,
  "type" : "client.validation",
  "code" : "method.argument.not.valid",
  "message" : "Validation error",
  "apiSubErrors" : [ {
    "code" : "constraints.not.blank",
    "message" : "must not be blank",
    "object" : "connectCreateOrderCommand",
    "field" : "ntdInstallation",
    "rejectedValue" : null
  }, {
    "code" : "constraints.not.blank",
    "message" : "must not be blank",
    "object" : "connectCreateOrderCommand",
    "field" : "aggregationMethod",
    "rejectedValue" : null
  }, {
    "code" : "constraints.not.blank",
    "message" : "must not be blank",
    "object" : "connectCreateOrderCommand",
    "field" : "contactPhone",
    "rejectedValue" : null
  }, {
    "code" : "constraints.not.blank",
    "message" : "must not be blank",
    "object" : "connectCreateOrderCommand",
    "field" : "contactName",
    "rejectedValue" : null
  } ],
  "timestamp" : "2025-03-11T22:25:11.309936916Z"
}

A company cannot create an order if they already own an active service with the product instance Id (PRI) of the infrastructure the order is for. The request is invalid and a http status of 422 is returned and the body of the response will list the problems with the request.

This example is for submitting an order request with active PRI ID.

POST Request
POST /api/connect/orders/create HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 7
Content-Length: 1093
Host: 360-api.superloop.com

{
  "sourceType" : "nbn",
  "planName" : "Home Fast 100/20",
  "term" : 1,
  "trafficClass" : "tc4",
  "remoteQualificationSearchId" : "1eb878c4-d5e1-63cc-8780-7e380507f753",
  "qualificationSearchId" : "d8a71e0b-4da6-44b4-a28e-b6d3ff5abb5c",
  "locationId" : "LOC151638001451",
  "remoteOrderId" : "1eb878c4-d4b9-6e0e-9f99-7e380507f753",
  "productType" : "Access Only",
  "restorationSla" : "Standard",
  "contactName" : "Bruce Wayne",
  "contactPhone" : "4000000000",
  "contactEmail" : "bruce@wayne.com",
  "infrastructureId" : "NTD151638001451",
  "portId" : 1,
  "requireVLAN" : true,
  "vlanId" : 100,
  "ntdInstallation" : "nbn-no-action",
  "ntdName" : "John Smith",
  "ntdPhoneNumber" : "4000000001",
  "ntdBusinessName" : "Wayne Industries",
  "ntdAddressLine1" : "Dark Street",
  "ntdAddressLine2" : "Gotham",
  "ntdSuburb" : "Crest Hill",
  "ntdPostcode" : "4000",
  "ntdState" : "QLD",
  "ntdAuthorityToLeave" : true,
  "ntdDeliveryInstructions" : "Please leave at reception",
  "ntdSameAddressDelivery" : false,
  "customerReference" : "ABC123",
  "aggregationMethod" : "L2TP"
}
POST Response with request validation errors
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 886

{
  "httpStatusCode" : 422,
  "type" : "client.validation",
  "code" : "validation",
  "message" : "Validation error",
  "apiSubErrors" : [ {
    "code" : "constraints.service.already.owned.requesting.rsp",
    "message" : "Service is already owned by the requesting RSP",
    "object" : "CreateServiceQuoteNbnCommand",
    "field" : "service",
    "rejectedValue" : null
  }, {
    "code" : "constraints.transfer.type.required",
    "message" : "transferType must be provided if port is Used",
    "object" : "CreateServiceQuoteNbnCommand",
    "field" : "transferType",
    "rejectedValue" : null
  }, {
    "code" : "constraints.avc.id.required.for.transfer",
    "message" : "avcId must be provided if port is Used",
    "object" : "CreateServiceQuoteNbnCommand",
    "field" : "avcIdForTransfer",
    "rejectedValue" : null
  } ],
  "timestamp" : "2025-03-11T22:25:12.522906291Z"
}

Another example of invalid order creation is customer requesting an NFAS upgrade on a location in which either NFAS upgrade has already been completed or it’s already a FTTP location. This request is invalid and a http status of 422 is returned and the body of the response will list the problems with the request.

POST Request
POST /api/connect/orders/create HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 7
Content-Length: 699
Host: 360-api.superloop.com

{
  "sourceType" : "nbn",
  "planName" : "Home Fast 100/20",
  "term" : 1,
  "trafficClass" : "tc4",
  "remoteQualificationSearchId" : "d8a71e0b-4da6-44b4-a28e-b6d3ff5abb5c",
  "qualificationSearchId" : "d8a71e0b-4da6-44b4-a28e-b6d3ff5abb5c",
  "locationId" : "LOC151638001599",
  "remoteOrderId" : "9003bd63-43f3-49ee-80bc-633244aa6358",
  "productType" : "Access Only",
  "restorationSla" : "Standard",
  "contactName" : "Bruce Wayne",
  "contactPhone" : "4000000000",
  "contactEmail" : "bruce@wayne.com",
  "infrastructureId" : null,
  "portId" : null,
  "requireVLAN" : true,
  "vlanId" : 100,
  "ntdInstallation" : "nbn-tech",
  "customerReference" : "ABC123",
  "aggregationMethod" : "L2TP"
}
POST Response with request validation errors
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 458

{
  "httpStatusCode" : 422,
  "type" : "client.validation",
  "code" : "validation",
  "message" : "Validation error",
  "apiSubErrors" : [ {
    "code" : "constraints.fttp.upgrade.not.allowed",
    "message" : "This is already an FTTP location, and an upgrade request cannot be processed",
    "object" : "CreateServiceQuoteNbnCommand",
    "field" : "accessTechnology",
    "rejectedValue" : "FTTP"
  } ],
  "timestamp" : "2025-03-11T22:25:08.700994803Z"
}

Upstream Service Unavailable

If one of the services that Connect API uses for creating an order is down or unreachable, Connect API will send a 502 status.

Successful Order creation FTTP Service Class 3

POST Request - Additional NTD , nbn-tech
POST /api/connect/orders/create HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 7
Content-Length: 699
Host: 360-api.superloop.com

{
  "sourceType" : "nbn",
  "planName" : "Home Fast 100/20",
  "term" : 1,
  "trafficClass" : "tc4",
  "remoteQualificationSearchId" : "1eb878c4-d5e1-63cc-8780-7e380507f753",
  "qualificationSearchId" : "d8a71e0b-4da6-44b4-a28e-b6d3ff5abb5c",
  "locationId" : "LOC151638001451",
  "remoteOrderId" : "1eb878c4-d4b9-6e0e-9f99-7e380507f753",
  "productType" : "Access Only",
  "restorationSla" : "Standard",
  "contactName" : "Bruce Wayne",
  "contactPhone" : "4000000000",
  "contactEmail" : "bruce@wayne.com",
  "infrastructureId" : null,
  "portId" : null,
  "requireVLAN" : true,
  "vlanId" : 100,
  "ntdInstallation" : "nbn-tech",
  "customerReference" : "ABC123",
  "aggregationMethod" : "L2TP"
}
Successful Response
HTTP/1.1 201 Created
Location: /api/connect/orders/1
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2142

{
  "id" : 1,
  "orderType" : "new",
  "status" : "OPEN",
  "serviceClass" : "3",
  "technologyType" : "FTTP",
  "trafficClass" : "TC4",
  "installationType" : "nbn-tech",
  "customerRef" : "ABC123",
  "locId" : "LOC151638001451",
  "avcId" : null,
  "avcIdForTransfer" : null,
  "vlanId" : 100,
  "poi" : "3CBN",
  "poiName" : "Cranbourne",
  "region" : "Urban",
  "eSla" : "Standard",
  "bandwidthProfile" : {
    "speedDown" : 100,
    "speedUp" : 20,
    "planName" : "Home Fast 100/20",
    "cvcInclusion" : null
  },
  "infrastructure" : null,
  "address" : {
    "buildingLevel" : null,
    "unitNumber" : null,
    "buildingName" : null,
    "streetNumber" : "1451",
    "street" : "GARLAND DR",
    "suburb" : "BALWYN EAST",
    "state" : "VIC",
    "postcode" : "3103",
    "formattedAddress" : "1451 GARLAND Drive, BALWYN EAST, Victoria, 3103"
  },
  "fee" : {
    "attributes" : {
      "plan" : "Home Fast 100/20",
      "term" : "1"
    },
    "oneTimeCharge" : {
      "amount" : "0.00",
      "currency" : "AUD",
      "symbol" : "$"
    },
    "monthlyRecurringCharge" : {
      "amount" : "65.00",
      "currency" : "AUD",
      "symbol" : "$"
    }
  },
  "additionalFees" : [ {
    "addOnTypeName" : "SLA",
    "fee" : {
      "attributes" : {
        "sla" : "Standard"
      },
      "oneTimeCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      },
      "monthlyRecurringCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      }
    }
  }, {
    "addOnTypeName" : "SUBSEQUENT_INSTALLATION_CHARGE",
    "fee" : {
      "attributes" : {
        "technology_type" : "fttp"
      },
      "oneTimeCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      },
      "monthlyRecurringCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      }
    }
  } ],
  "appointments" : [ ],
  "aggregationMethod" : "L2TP",
  "legacyTechnologyType" : null,
  "transferType" : null,
  "360ServiceId" : null,
  "isCancellable" : false,
  "isNfas" : false
}

Successful Order creation FW Service Class 6

POST Request - Existing NTD , nbn-no-action
POST /api/connect/orders/create HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 7
Content-Length: 1093
Host: 360-api.superloop.com

{
  "sourceType" : "nbn",
  "planName" : "Fixed Wireless Plus",
  "term" : 1,
  "trafficClass" : "tc4",
  "remoteQualificationSearchId" : "1eb878c4-d5e1-63cc-8780-7e380507f753",
  "qualificationSearchId" : "d8a71e0b-4da6-44b4-a28e-b6d3ff5abb5c",
  "locationId" : "LOC151638001891",
  "remoteOrderId" : "1eb878c4-d4b9-6e0e-9f99-7e380507f753",
  "productType" : "Access Only",
  "restorationSla" : "Standard",
  "contactName" : "Bruce Wayne",
  "contactPhone" : "4000000000",
  "contactEmail" : "bruce@wayne.com",
  "infrastructureId" : "NTD151638001891",
  "portId" : null,
  "requireVLAN" : true,
  "vlanId" : 100,
  "ntdInstallation" : "nbn-no-action",
  "ntdName" : "John Smith",
  "ntdPhoneNumber" : "4000000001",
  "ntdBusinessName" : "Wayne Industries",
  "ntdAddressLine1" : "Dark Street",
  "ntdAddressLine2" : "Gotham",
  "suburb" : "Crest Hill",
  "postCode" : "4000",
  "ntdState" : "QLD",
  "ntdAuthorityToLeave" : true,
  "ntdDeliveryInstructions" : "Please leave at reception",
  "ntdSameAddressDelivery" : false,
  "customerReference" : "ABC123",
  "aggregationMethod" : "L2TP"
}
Successful Response
HTTP/1.1 201 Created
Location: /api/connect/orders/1
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1837

{
  "id" : 1,
  "orderType" : "new",
  "status" : "OPEN",
  "serviceClass" : "6",
  "technologyType" : "FW",
  "trafficClass" : "TC4",
  "installationType" : "nbn-no-action",
  "customerRef" : "ABC123",
  "locId" : "LOC151638001891",
  "avcId" : null,
  "avcIdForTransfer" : null,
  "vlanId" : 100,
  "poi" : "9trptogdu",
  "poiName" : "West Milo",
  "region" : "Urban",
  "eSla" : "Standard",
  "bandwidthProfile" : {
    "speedDown" : 75,
    "speedUp" : 10,
    "planName" : "Fixed Wireless Plus",
    "cvcInclusion" : null
  },
  "infrastructure" : {
    "id" : "NTD151638001891",
    "portId" : "null",
    "productId" : null
  },
  "address" : {
    "buildingLevel" : null,
    "unitNumber" : null,
    "buildingName" : null,
    "streetNumber" : "1891",
    "street" : "OWINGS DR",
    "suburb" : "TEMPLESTOWE",
    "state" : "VIC",
    "postcode" : "3106",
    "formattedAddress" : "1891 OWINGS Drive, TEMPLESTOWE, Victoria, 3106"
  },
  "fee" : {
    "attributes" : {
      "plan" : "Fixed Wireless Plus",
      "term" : "1"
    },
    "oneTimeCharge" : {
      "amount" : "0.00",
      "currency" : "AUD",
      "symbol" : "$"
    },
    "monthlyRecurringCharge" : {
      "amount" : "50.00",
      "currency" : "AUD",
      "symbol" : "$"
    }
  },
  "additionalFees" : [ {
    "addOnTypeName" : "SLA",
    "fee" : {
      "attributes" : {
        "sla" : "Standard"
      },
      "oneTimeCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      },
      "monthlyRecurringCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      }
    }
  } ],
  "appointments" : [ ],
  "aggregationMethod" : "L2TP",
  "legacyTechnologyType" : null,
  "transferType" : null,
  "360ServiceId" : null,
  "isCancellable" : false,
  "isNfas" : false
}

Successful Order creation FTTN Service Class 13

POST Request - Existing NTD , nbn-no-action
POST /api/connect/orders/create HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 7
Content-Length: 699
Host: 360-api.superloop.com

{
  "sourceType" : "nbn",
  "planName" : "Home Fast 100/20",
  "term" : 1,
  "trafficClass" : "tc4",
  "remoteQualificationSearchId" : "1eb878c4-d5e1-63cc-8780-7e380507f753",
  "qualificationSearchId" : "d8a71e0b-4da6-44b4-a28e-b6d3ff5abb5c",
  "locationId" : "LOC151638003251",
  "remoteOrderId" : "1eb878c4-d4b9-6e0e-9f99-7e380507f753",
  "productType" : "Access Only",
  "restorationSla" : "Standard",
  "contactName" : "Bruce Wayne",
  "contactPhone" : "4000000000",
  "contactEmail" : "bruce@wayne.com",
  "infrastructureId" : null,
  "portId" : null,
  "requireVLAN" : true,
  "vlanId" : 100,
  "ntdInstallation" : "nbn-tech",
  "customerReference" : "ABC123",
  "aggregationMethod" : "L2TP"
}
Successful Response
HTTP/1.1 201 Created
Location: /api/connect/orders/1
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2148

{
  "id" : 1,
  "orderType" : "new",
  "status" : "OPEN",
  "serviceClass" : "13",
  "technologyType" : "FTTN",
  "trafficClass" : "TC4",
  "installationType" : "nbn-tech",
  "customerRef" : "ABC123",
  "locId" : "LOC151638003251",
  "avcId" : null,
  "avcIdForTransfer" : null,
  "vlanId" : 100,
  "poi" : "9zrvcxfsn",
  "poiName" : "East Antonette",
  "region" : "Urban",
  "eSla" : "Standard",
  "bandwidthProfile" : {
    "speedDown" : 100,
    "speedUp" : 20,
    "planName" : "Home Fast 100/20",
    "cvcInclusion" : null
  },
  "infrastructure" : null,
  "address" : {
    "buildingLevel" : null,
    "unitNumber" : null,
    "buildingName" : null,
    "streetNumber" : "3251",
    "street" : "SLATER DR",
    "suburb" : "WARRANDYTE",
    "state" : "VIC",
    "postcode" : "3113",
    "formattedAddress" : "3251 SLATER Drive, WARRANDYTE, Victoria, 3113"
  },
  "fee" : {
    "attributes" : {
      "plan" : "Home Fast 100/20",
      "term" : "1"
    },
    "oneTimeCharge" : {
      "amount" : "0.00",
      "currency" : "AUD",
      "symbol" : "$"
    },
    "monthlyRecurringCharge" : {
      "amount" : "65.00",
      "currency" : "AUD",
      "symbol" : "$"
    }
  },
  "additionalFees" : [ {
    "addOnTypeName" : "SLA",
    "fee" : {
      "attributes" : {
        "sla" : "Standard"
      },
      "oneTimeCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      },
      "monthlyRecurringCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      }
    }
  }, {
    "addOnTypeName" : "SUBSEQUENT_INSTALLATION_CHARGE",
    "fee" : {
      "attributes" : {
        "technology_type" : "fttn"
      },
      "oneTimeCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      },
      "monthlyRecurringCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      }
    }
  } ],
  "appointments" : [ ],
  "aggregationMethod" : "L2TP",
  "legacyTechnologyType" : null,
  "transferType" : null,
  "360ServiceId" : null,
  "isCancellable" : false,
  "isNfas" : false
}

Successful Order creation FTTB Service Class 13

POST Request - Existing NTD , nbn-no-action
POST /api/connect/orders/create HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 7
Content-Length: 699
Host: 360-api.superloop.com

{
  "sourceType" : "nbn",
  "planName" : "Home Fast 100/20",
  "term" : 1,
  "trafficClass" : "tc4",
  "remoteQualificationSearchId" : "1eb878c4-d5e1-63cc-8780-7e380507f753",
  "qualificationSearchId" : "d8a71e0b-4da6-44b4-a28e-b6d3ff5abb5c",
  "locationId" : "LOC151638003258",
  "remoteOrderId" : "1eb878c4-d4b9-6e0e-9f99-7e380507f753",
  "productType" : "Access Only",
  "restorationSla" : "Standard",
  "contactName" : "Bruce Wayne",
  "contactPhone" : "4000000000",
  "contactEmail" : "bruce@wayne.com",
  "infrastructureId" : null,
  "portId" : null,
  "requireVLAN" : true,
  "vlanId" : 100,
  "ntdInstallation" : "nbn-tech",
  "customerReference" : "ABC123",
  "aggregationMethod" : "L2TP"
}
Successful Response
HTTP/1.1 201 Created
Location: /api/connect/orders/1
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2156

{
  "id" : 1,
  "orderType" : "new",
  "status" : "OPEN",
  "serviceClass" : "13",
  "technologyType" : "FTTB",
  "trafficClass" : "TC4",
  "installationType" : "nbn-tech",
  "customerRef" : "ABC123",
  "locId" : "LOC151638003258",
  "avcId" : null,
  "avcIdForTransfer" : null,
  "vlanId" : 100,
  "poi" : "4avuzteny",
  "poiName" : "Heathcotemouth",
  "region" : "Urban",
  "eSla" : "Standard",
  "bandwidthProfile" : {
    "speedDown" : 100,
    "speedUp" : 20,
    "planName" : "Home Fast 100/20",
    "cvcInclusion" : null
  },
  "infrastructure" : null,
  "address" : {
    "buildingLevel" : null,
    "unitNumber" : null,
    "buildingName" : null,
    "streetNumber" : "3258",
    "street" : "GEARRIN RD",
    "suburb" : "NORTH RYDE",
    "state" : "NSW",
    "postcode" : "2113",
    "formattedAddress" : "3258 GEARRIN Road, NORTH RYDE, New South Wales, 2113"
  },
  "fee" : {
    "attributes" : {
      "plan" : "Home Fast 100/20",
      "term" : "1"
    },
    "oneTimeCharge" : {
      "amount" : "0.00",
      "currency" : "AUD",
      "symbol" : "$"
    },
    "monthlyRecurringCharge" : {
      "amount" : "65.00",
      "currency" : "AUD",
      "symbol" : "$"
    }
  },
  "additionalFees" : [ {
    "addOnTypeName" : "SLA",
    "fee" : {
      "attributes" : {
        "sla" : "Standard"
      },
      "oneTimeCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      },
      "monthlyRecurringCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      }
    }
  }, {
    "addOnTypeName" : "SUBSEQUENT_INSTALLATION_CHARGE",
    "fee" : {
      "attributes" : {
        "technology_type" : "fttb"
      },
      "oneTimeCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      },
      "monthlyRecurringCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      }
    }
  } ],
  "appointments" : [ ],
  "aggregationMethod" : "L2TP",
  "legacyTechnologyType" : null,
  "transferType" : null,
  "360ServiceId" : null,
  "isCancellable" : false,
  "isNfas" : false
}

Successful Order creation HFC Service Class 24

POST Request - Existing NTD , nbn-dispatch
POST /api/connect/orders/create HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 7
Content-Length: 1095
Host: 360-api.superloop.com

{
  "sourceType" : "nbn",
  "planName" : "Home Fast 100/20",
  "term" : 1,
  "trafficClass" : "tc4",
  "remoteQualificationSearchId" : "1eb878c4-d5e1-63cc-8780-7e380507f753",
  "qualificationSearchId" : "d8a71e0b-4da6-44b4-a28e-b6d3ff5abb5c",
  "locationId" : "LOC151638004251",
  "remoteOrderId" : "1eb878c4-d4b9-6e0e-9f99-7e380507f753",
  "productType" : "Access Only",
  "restorationSla" : "Standard",
  "contactName" : "Bruce Wayne",
  "contactPhone" : "4000000000",
  "contactEmail" : "bruce@wayne.com",
  "infrastructureId" : "NTD151638004251",
  "portId" : null,
  "requireVLAN" : true,
  "vlanId" : 100,
  "ntdInstallation" : "nbn-dispatch",
  "ntdName" : "John Smith",
  "ntdPhoneNumber" : "4000000001",
  "ntdBusinessName" : "Wayne Industries",
  "ntdAddressLine1" : "Dark Street",
  "ntdAddressLine2" : "Gotham",
  "ntdSuburb" : "Crest Hill",
  "ntdPostcode" : "4000",
  "ntdState" : "QLD",
  "ntdAuthorityToLeave" : true,
  "ntdDeliveryInstructions" : "Please leave at reception",
  "ntdSameAddressDelivery" : false,
  "customerReference" : "ABC123",
  "aggregationMethod" : "L2TP"
}
Successful Response
HTTP/1.1 201 Created
Location: /api/connect/orders/1
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1824

{
  "id" : 1,
  "orderType" : "new",
  "status" : "OPEN",
  "serviceClass" : "24",
  "technologyType" : "HFC",
  "trafficClass" : "TC4",
  "installationType" : "nbn-dispatch",
  "customerRef" : "ABC123",
  "locId" : "LOC151638004251",
  "avcId" : null,
  "avcIdForTransfer" : null,
  "vlanId" : 100,
  "poi" : "9ABC",
  "poiName" : "Zanzibar",
  "region" : "Urban",
  "eSla" : "Standard",
  "bandwidthProfile" : {
    "speedDown" : 100,
    "speedUp" : 20,
    "planName" : "Home Fast 100/20",
    "cvcInclusion" : null
  },
  "infrastructure" : {
    "id" : "NTD151638004251",
    "portId" : "null",
    "productId" : null
  },
  "address" : {
    "buildingLevel" : null,
    "unitNumber" : null,
    "buildingName" : null,
    "streetNumber" : "4251",
    "street" : "JAIRO ST",
    "suburb" : "CAMBERWELL",
    "state" : "VIC",
    "postcode" : "3124",
    "formattedAddress" : "4251 JAIRO Street, CAMBERWELL, Victoria, 3124"
  },
  "fee" : {
    "attributes" : {
      "plan" : "Home Fast 100/20",
      "term" : "1"
    },
    "oneTimeCharge" : {
      "amount" : "0.00",
      "currency" : "AUD",
      "symbol" : "$"
    },
    "monthlyRecurringCharge" : {
      "amount" : "65.00",
      "currency" : "AUD",
      "symbol" : "$"
    }
  },
  "additionalFees" : [ {
    "addOnTypeName" : "SLA",
    "fee" : {
      "attributes" : {
        "sla" : "Standard"
      },
      "oneTimeCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      },
      "monthlyRecurringCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      }
    }
  } ],
  "appointments" : [ ],
  "aggregationMethod" : "L2TP",
  "legacyTechnologyType" : null,
  "transferType" : null,
  "360ServiceId" : null,
  "isCancellable" : false,
  "isNfas" : false
}

Successful Order creation FTTC Service Class 34

POST Request - Existing NTD , nbn-dispatch
POST /api/connect/orders/create HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 7
Content-Length: 1095
Host: 360-api.superloop.com

{
  "sourceType" : "nbn",
  "planName" : "Home Fast 100/20",
  "term" : 1,
  "trafficClass" : "tc4",
  "remoteQualificationSearchId" : "1eb878c4-d5e1-63cc-8780-7e380507f753",
  "qualificationSearchId" : "d8a71e0b-4da6-44b4-a28e-b6d3ff5abb5c",
  "locationId" : "LOC151638005051",
  "remoteOrderId" : "1eb878c4-d4b9-6e0e-9f99-7e380507f753",
  "productType" : "Access Only",
  "restorationSla" : "Standard",
  "contactName" : "Bruce Wayne",
  "contactPhone" : "4000000000",
  "contactEmail" : "bruce@wayne.com",
  "infrastructureId" : "CPI151638005051",
  "portId" : null,
  "requireVLAN" : true,
  "vlanId" : 100,
  "ntdInstallation" : "nbn-dispatch",
  "ntdName" : "John Smith",
  "ntdPhoneNumber" : "4000000001",
  "ntdBusinessName" : "Wayne Industries",
  "ntdAddressLine1" : "Dark Street",
  "ntdAddressLine2" : "Gotham",
  "ntdSuburb" : "Crest Hill",
  "ntdPostcode" : "4000",
  "ntdState" : "QLD",
  "ntdAuthorityToLeave" : true,
  "ntdDeliveryInstructions" : "Please leave at reception",
  "ntdSameAddressDelivery" : false,
  "customerReference" : "ABC123",
  "aggregationMethod" : "L2TP"
}
Successful Response
HTTP/1.1 201 Created
Location: /api/connect/orders/1
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2200

{
  "id" : 1,
  "orderType" : "new",
  "status" : "OPEN",
  "serviceClass" : "34",
  "technologyType" : "FTTC",
  "trafficClass" : "TC4",
  "installationType" : "nbn-dispatch",
  "customerRef" : "ABC123",
  "locId" : "LOC151638005051",
  "avcId" : null,
  "avcIdForTransfer" : null,
  "vlanId" : 100,
  "poi" : "9zrvcxfsn",
  "poiName" : "East Antonette",
  "region" : "Urban",
  "eSla" : "Standard",
  "bandwidthProfile" : {
    "speedDown" : 100,
    "speedUp" : 20,
    "planName" : "Home Fast 100/20",
    "cvcInclusion" : null
  },
  "infrastructure" : {
    "id" : "CPI151638005051",
    "productId" : null
  },
  "address" : {
    "buildingLevel" : null,
    "unitNumber" : null,
    "buildingName" : null,
    "streetNumber" : "5051",
    "street" : "MARSALIS DR",
    "suburb" : "AVONDALE HEIGHTS",
    "state" : "VIC",
    "postcode" : "3034",
    "formattedAddress" : "5051 MARSALIS Drive, AVONDALE HEIGHTS, Victoria, 3034"
  },
  "fee" : {
    "attributes" : {
      "plan" : "Home Fast 100/20",
      "term" : "1"
    },
    "oneTimeCharge" : {
      "amount" : "0.00",
      "currency" : "AUD",
      "symbol" : "$"
    },
    "monthlyRecurringCharge" : {
      "amount" : "65.00",
      "currency" : "AUD",
      "symbol" : "$"
    }
  },
  "additionalFees" : [ {
    "addOnTypeName" : "SLA",
    "fee" : {
      "attributes" : {
        "sla" : "Standard"
      },
      "oneTimeCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      },
      "monthlyRecurringCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      }
    }
  }, {
    "addOnTypeName" : "NDF",
    "fee" : {
      "attributes" : {
        "ndf" : "New Development Fee"
      },
      "oneTimeCharge" : {
        "amount" : "300.00",
        "currency" : "AUD",
        "symbol" : "$"
      },
      "monthlyRecurringCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      }
    }
  } ],
  "appointments" : [ ],
  "aggregationMethod" : "L2TP",
  "legacyTechnologyType" : null,
  "transferType" : null,
  "360ServiceId" : null,
  "isCancellable" : false,
  "isNfas" : false
}

Order GET with Appointments

GET Request
GET /api/connect/orders/1 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 7
Host: 360-api.superloop.com
Successful GET Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 3201

{
  "id" : 1,
  "orderType" : "transfer",
  "status" : "OPEN",
  "serviceClass" : "3",
  "technologyType" : "FTTP",
  "trafficClass" : "TC4",
  "installationType" : "nbn-no-action",
  "customerRef" : "REF123",
  "locId" : "LOC000000000001",
  "avcId" : null,
  "avcIdForTransfer" : null,
  "vlanId" : 102,
  "poi" : "4CPH",
  "poiName" : "Camp Hill",
  "region" : "Urban",
  "eSla" : "Enhanced - 8 (24/7)",
  "bandwidthProfile" : {
    "speedDown" : 25,
    "speedUp" : 5,
    "planName" : "Home Fast 25/5",
    "cvcInclusion" : 1.25
  },
  "infrastructure" : {
    "id" : "NTD000033427450",
    "portId" : "1",
    "productId" : "PRI000000000000"
  },
  "address" : {
    "buildingLevel" : "7",
    "unitNumber" : "702",
    "buildingName" : "ARANA HILLS LIBRARY",
    "streetNumber" : "63",
    "street" : "COBBITY CR",
    "suburb" : "ARANA HILLS",
    "state" : "QLD",
    "postcode" : "4054",
    "formattedAddress" : "ARANA HILLS LIBRARY, Lot 798, 63 COBBITY Crescent, ARANA HILLS, Queensland, 4054"
  },
  "fee" : {
    "attributes" : {
      "term" : "12",
      "plan" : "Home Fast 50/20"
    },
    "oneTimeCharge" : {
      "amount" : "1700.00",
      "currency" : "AUD",
      "symbol" : "&#36"
    },
    "monthlyRecurringCharge" : {
      "amount" : "350.00",
      "currency" : "AUD",
      "symbol" : "&#36"
    }
  },
  "additionalFees" : [ {
    "addOnTypeName" : "NDF",
    "fee" : {
      "attributes" : {
        "technology_type" : "fttn"
      },
      "oneTimeCharge" : {
        "amount" : "100.00",
        "currency" : "AUD",
        "symbol" : "$"
      },
      "monthlyRecurringCharge" : {
        "amount" : "10.00",
        "currency" : "AUD",
        "symbol" : "$"
      }
    }
  } ],
  "appointments" : [ {
    "id" : 2,
    "nbnAppointmentId" : "APT190003450395",
    "slotType" : "PM",
    "startTime" : "2020-09-01T03:00:00Z",
    "endTime" : "2020-09-01T07:00:00Z",
    "timezoneOffset" : "+10:00",
    "priorityAssist" : false,
    "eSla" : "Standard",
    "demandType" : "Standard Install",
    "contact" : {
      "name" : "Bruce Wayne",
      "type" : "Primary Contact",
      "phone" : "0422151651",
      "notes" : "Please use bat signal"
    },
    "bookedOn" : "2020-08-20T08:51:30Z",
    "cancellationRequests" : [ {
      "id" : 1,
      "status" : "FAILED",
      "statusDateChangedTo" : "2023-06-16T23:12:05Z",
      "requestedOn" : "2021-06-15T04:34:31Z",
      "errorDetail" : "Appointment is past point of no return"
    } ]
  }, {
    "id" : 1,
    "nbnAppointmentId" : "APT790002088781",
    "slotType" : "AM",
    "startTime" : "2020-08-31T22:00:00Z",
    "endTime" : "2020-09-01T02:00:00Z",
    "timezoneOffset" : "+10:00",
    "priorityAssist" : false,
    "eSla" : "Standard",
    "demandType" : "Standard Install",
    "contact" : {
      "name" : "Bruce Wayne",
      "type" : "Primary Contact",
      "phone" : "0422151651",
      "notes" : "Please use bat signal"
    },
    "bookedOn" : "2020-08-18T08:51:30Z",
    "cancellationRequests" : [ ]
  } ],
  "aggregationMethod" : "L2TP",
  "legacyTechnologyType" : "FTTN",
  "transferType" : "SERVICE_TRANSFER",
  "360ServiceId" : 300,
  "isCancellable" : false,
  "isNfas" : true
}

API Version 1, 2 and 3 - POST

POST Request

Table 13. POST Request

Verb

POST

URI

/api/connect/orders/create
Table 14. POST HTTP Request Headers
Name Description

Authorization

The OAuth bearer access token

X-API-VERSION

The version of the endpoint you are accessing
Table 15. POST Request Body Fields
Path Type Description Required

sourceType

String

The service source to order for. Currently only nbn is supported.

Required

customerReference

String

Should not be greater than 200 characters.

quoteName

String

Should not be greater than 50 characters.

contactName

String

Should not be greater than 40 characters.

Required

contactPhone

String

Valid Australian landline or mobile phone number.

Required

contactEmail

String

Valid email address. Should not be greater than 50 characters.

Required

remoteQualificationSearchId

String

nbn qualification id.

Required

qualificationSearchId

String

360 qualification id.

Required

remoteOrderId

String

nbn order id.

Required

locationId

String

nbn location id.

Required

planName

String

Required

term

Number

Required

trafficClass

String

tc2 | tc4 | ee

Required

productType

String

Allowed product type is "Access Only"

restorationSla

String

Required

potsServiceOwner

Boolean

Indicates the customer is the owner of the current service. Set this to true or false when SQ has returned "hasActivePOTS": true, "serviceType": "ULL" or "ULL - Special"

potsWaiver

Boolean

Indicates the customer has confirmed they are allowed to transfer the existing service. Set this to true when SQ has returned "hasActivePOTS": true, "serviceType": "FNN" or "FNN -Special and "potsInterconnectMatch": falseor "hasActivePOTS": true, "serviceType": "ULL" or "ULL - Special" and "potsServiceOwner": false

infrastructureId

String

portId

Number

requireVLAN

Boolean

Required

vlanId

Number

Required when requireVLAN is true, value should be between 2 - 4004

Required

ntdInstallation

String

nbn-tech | nbn-no-action | nbn-dispatch. Refer to the SQ response to obtain a list of valid installation options. The option with recommended 'true' is the preferred install option. * if you can order a new infrastructure and you do, provide an option under "infrastructureInstallationOptions" : [ { "option" : "nbn-tech", "recommended" : true, "fees" : [ ], "hardwareShortfall" : null } ] " * if you can order an existing infrastructure and you do, provide an option from under the chosen infrastructure "infrastructureId": "CPI380100023422", "installationOptions": [ { "option": "nbn-tech", "recommended": true, "fees": [], "hardwareShortfall": null } ]

Required

ntdName

String

Required when ntdInstallation is nbn-dispatch, Shipping details - Recipient’s name

ntdPhoneNumber

String

Required when ntdInstallation is nbn-dispatch, a valid Australian landline or mobile phone number

ntdSameAddressDelivery

Boolean

Shipping details - same as site address

ntdBusinessName

String

Required when ntdSameAddressDelivery is false. Should not be greater than 40 characters.

ntdAddressLine1

String

Required when ntdSameAddressDelivery is false. Should not be greater than 40 characters.

ntdAddressLine2

String

Required when ntdSameAddressDelivery is false. Should not be greater than 40 characters.

ntdSuburb

String

Required when ntdSameAddressDelivery is false. Should not be greater than 30 characters.

ntdPostcode

String

Required when ntdSameAddressDelivery is false. Should not be greater than 4 characters.

ntdState

String

Required when ntdSameAddressDelivery is false. It can either be the abbreviated state or the full name.

ntdAuthorityToLeave

Boolean

Required when ntdInstallation is nbn-dispatch

ntdDeliveryInstructions

String

Should not be greater than 128 characters.

avcIdForTransfer

String

The avc id must be provided if the Port’s status is "Used" or the serviceStatus is "Line In Use". NBN will use this AVC ID to verify the transfer is allowed. It is suggested you verify the AVC ID by performing an AVC SQ before submitting the order.

transferType

String

The transfer type must be provided if the Port’s status is "Used" or the serviceStatus is "Line In Use". Possible values are SERVICE_TRANSFER and CONNECT_OUTSTANDING. If the transfer type is CONNECT_OUTSTANDING, there is no need to provide an AVC ID (avcId).

POST Response

Table 16. POST HTTP Status Codes
Status Code Meaning

201

The request was created successfully

401

Bearer token is missing or invalid

404

You do not have permission to perform this task

422

There are validation errors on the request you mean. Check the response body to see what fields had issues.

500

There was an unexpected error processing the request

502

There was an unexpected error with one or more of the upstream services
Table 17. POST HTTP Response Headers
Name Description

Location

The URL of the new order you just created.

API Version 1, 2 and 3 - GET

GET Request

Note
 The URI will be given to you in the Location header of the POST request.
Table 18. GET Request

Verb

GET

URI

/api/connect/orders/{id}
Table 19. GET Request Path Variables

Path Variable

Purpose

id

The ID of the order. This was generated by the POST request
Table 20. GET HTTP Request Headers
Name Description

Authorization

The OAuth bearer access token

X-API-VERSION

The version of the endpoint you are accessing

GET Response

Table 21. GET HTTP Status Codes
Status Code Meaning

200

The request was created successfully

401

Bearer token is missing or invalid

404

You do not have permission to perform this task
Table 22. GET Response Body Fields
Path Type Description

id

Number

The Connect identifier of the order resource.

orderType

String

Whether the order is for a new service or a transfer.

status

String

Status of the order.

serviceClass

String

The standard nbn service class of the site.

technologyType

String

The type of nbn technology that the service is delivered through. See "nbn Technology Type Map" below.

trafficClass

String

The nbn traffic class, e.g. TC4

installationType

String

Whether the NTD is going to be installed by an nbn technician or by the site’s tenant.

customerRef

String

The reference string that you provided when you placed the order.

locId

String

The nbn LOC ID of the address of the site the order is for.

avcId

Null

The AVC ID of the virtual circuit that is created for this service. This might not be set, depending on when you make the call. This is not set until the order has been accepted by the NBN.

avcIdForTransfer

String

The AVC ID that was specified at order time for a transfer order. That is for an NTD with a port that is Used or NCD (Copper Pair) with a Line In Use. Null in all other cases.

vlanId

Number

The VLAN that was specified at order time.

poi

String

The code of the nbn POI that the site will be serviced from.

poiName

String

The name of the nbn POI that the site will be serviced from.

region

String

The nbn region identifier that nbn places the site in.

eSla

String

The level of restoration SLA that the service will have. Currently, only Standard is available.

bandwidthProfile

Object

An object that contains details on the bandwidth profile that was selected for the service.

bandwidthProfile.speedDown

Number

The download speed of the service, in mbps.

bandwidthProfile.speedUp

Number

The upload speed of the service, in mbps.

bandwidthProfile.planName

String

The name of the plan that was selected for the service.

bandwidthProfile.cvcInclusion

Number

The CVC inclusion that is applied to CVC rebates, if applicable.

infrastructure

Object

Information about the infrastructure at the site, including NTDs and Copper Pairs.

infrastructure.id

String

The nbn identifier of the equipment.

infrastructure.portId

String

The port on the device that was chosen for the service.Only for NTD infrastructure.

infrastructure.productId

String

The nbn identifier of the product component that is activated for the Customer.

address

Object

The address of the site where the service is being provided.

address.buildingLevel

String

The level that the site is on.

address.unitNumber

String

The unit number of the site.

address.buildingName

String

The name of the building.

address.streetNumber

String

The street number of the site.

address.street

String

The name of the street, including street type.

address.suburb

String

The suburb.

address.state

String

The state.

address.postcode

String

The postcode.

address.formattedAddress

String

The whole address, formatted in a single line.

fee

Object

Applied fee for the ordered plan.

fee.attributes

Object

Attributes of the ordered plan.

fee.oneTimeCharge.amount

String

One time charge for the ordered plan.

fee.oneTimeCharge.currency

String

Currency of the one time charge.

fee.oneTimeCharge.symbol

String

Symbol of the one time charge currency.

fee.monthlyRecurringCharge.amount

String

Monthly recurring charge of the ordered plan.

fee.monthlyRecurringCharge.currency

String

Currency of the monthly recurring charge.

fee.monthlyRecurringCharge.symbol

String

Symbol of the monthly recurring charge currency.

additionalFees

Array

List of additional fees applied for the ordered plan.

additionalFees.[].addOnTypeName

String

Name of the addon type.

additionalFees.[].fee

Object

Applied charge for the addon type.

additionalFees.[].fee.attributes

Object

Attributes of the addon type.

additionalFees.[].fee.oneTimeCharge.amount

String

One time charge of the addon type.

additionalFees.[].fee.oneTimeCharge.currency

String

Currency of the addon type charge.

additionalFees.[].fee.oneTimeCharge.symbol

String

Symbol of the addon type charge currency.

additionalFees.[].fee.monthlyRecurringCharge.amount

String

Monthly recurring charge of the addon type.

additionalFees.[].fee.monthlyRecurringCharge.currency

String

Currency of the monthly recurring charge.

additionalFees.[].fee.monthlyRecurringCharge.symbol

String

Symbol of the monthly recurring charge currency.

appointments

Array

List of appointments for the order.

appointments.[].id

Number

The Connect identifier of the appointment resource.

appointments.[].nbnAppointmentId

String

The NBN identifier of the appointment.

appointments.[].slotType

String

The type of confirmed appointment slot. AM/ PM.

appointments.[].startTime

String

The date/time, including UTC offset, appointment start time will be visible only when appointment has been confirmed.

appointments.[].endTime

String

The date/time, including UTC offset, appointment end time, will be visible only when appointment has been confirmed.

appointments.[].timezoneOffset

String

Represents an offset defined in a Timezone.

appointments.[].priorityAssist

Boolean

Indicates whether the appointment is priority assisted or not.

appointments.[].eSla

String

The level of restoration SLA that the service will have. Currently, only Standard is available.

appointments.[].demandType

String

The type of installation the appointment slot is provided for.

appointments.[].contact

Object

The contact details of the appointment.

appointments.[].contact.name

String

The name of the contact.

appointments.[].contact.type

String

The type of the contact.

appointments.[].contact.phone

String

The number of the contact.

appointments.[].contact.notes

String

Additional information. If any.

appointments.[].bookedOn

String

The date/time, including UTC offset, when nbn validated the appointment.

appointments.[].cancellationRequests

Array

List of cancellation requests for the appointment.

appointments.[].cancellationRequests[].id

Number

Connect identifier of the cancellation request resource.

appointments.[].cancellationRequests[].status

String

The status of the cancellation request. One of IN_PROGRESS, COMPLETE or FAILED.

appointments.[].cancellationRequests[].statusDateChangedTo

String

The date/time, including UTC offset, the status was set.

appointments.[].cancellationRequests[].requestedOn

String

The date/time, including UTC offset, the cancellation request was made.

appointments.[].cancellationRequests[].errorDetail

String

If the status is FAILED, will contain details on why the request failed.

360ServiceId

Number

The ID of the 360 service that the order fulfils

aggregationMethod

String

L2TP | ETHERNET

isNfas

Boolean

Indicates whether the order is a nbn Co’s Fibre Access Service (NFAS)

legacyTechnologyType

String

Legacy nbn technology type of the the service if the service is NFAS otherwise NULL

isCancellable

Boolean

Indicates whether the order is cancellable

transferType

String

Indicates type of the transfer if the order is a transfer order otherwise value will be NULL Possible values are SERVICE_TRANSFER and CONNECT_OUTSTANDING
Table 23. Service Order statuses
Status Description

OPEN

Order is created and ready to be submitted to nbn

IN_PROGRESS

Order is submitted to nbn and is in progress.

AWAITING_CUSTOMER

Created order needs action from customer

IN_ERROR

Order is in error

CANCELLATION_REQUESTED

Order is requested for cancellation

CANCELLED

Order is cancelled by nbn

REJECTED

Order is rejected by nbn

FAILED

Order is failed by nbn.

COMPLETE

Order is successfully processed by nbn, and the service is ready to be used.

OPEN_TRANSFER_ORDER

Applicable only to internal transfer orders.

Order status will be set to OPEN_TRANSFER_ORDER once the existing active service is disconnected by nbn. It indicates that the transfer order is now ready to be submitted to the nbn

TRANSFER_ORDERING

Applicable only to internal transfer orders.

Set when the transfer order is submitted to nbn for processing

TRANSFER_ORDER_IN_RETRY

Applicable only to internal transfer orders.

Set when the transfer order submitted is rejected by nbn due to any reason and 360 internally continue to re-submit the order

API Version 1, 2 and 3 - Examples - Request

Successful Order creation

An order request is created by sending a POST request to /api/connect/orders/create.

POST Request
POST /api/connect/orders/create HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 3
Content-Length: 635
Host: 360-api.superloop.com

{
  "sourceType" : "nbn",
  "planName" : "Fixed Wireless Plus",
  "term" : 1,
  "trafficClass" : "tc4",
  "remoteQualificationSearchId" : "90cf4836-2bf6-4e92-b10a-f54045e85255",
  "qualificationSearchId" : "d8a71e0b-4da6-44b4-a28e-b6d3ff5abb5c",
  "locationId" : "LOC151638001609",
  "remoteOrderId" : "1eb878c4-d4b9-6e0e-9f99-7e380507f753",
  "productType" : "Access Only",
  "restorationSla" : "Standard",
  "contactName" : "Bruce Wayne",
  "contactPhone" : "4000000000",
  "contactEmail" : "bruce@wayne.com",
  "infrastructureId" : null,
  "portId" : null,
  "ntdInstallation" : "nbn-tech",
  "requireVLAN" : true,
  "vlanId" : 56
}

If all required fields were given, then the response to the request will have:

  1. a http status of 201

  2. a Location header with the URI of the newly created order entity.

Successful POST Response
HTTP/1.1 201 Created
Location: /api/connect/orders/1
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1745

{
  "id" : 1,
  "orderType" : "new",
  "status" : "OPEN",
  "serviceClass" : "5",
  "technologyType" : "FW",
  "trafficClass" : "TC4",
  "installationType" : "nbn-tech",
  "customerRef" : null,
  "locId" : "LOC151638001609",
  "avcId" : null,
  "avcIdForTransfer" : null,
  "vlanId" : 56,
  "poi" : "9trptogdu",
  "poiName" : "West Milo",
  "region" : "Urban",
  "eSla" : "Standard",
  "bandwidthProfile" : {
    "speedDown" : 75,
    "speedUp" : 10,
    "planName" : "Fixed Wireless Plus",
    "cvcInclusion" : null
  },
  "infrastructure" : null,
  "address" : {
    "buildingLevel" : null,
    "unitNumber" : null,
    "buildingName" : null,
    "streetNumber" : "1609",
    "street" : "GURRIEL AV",
    "suburb" : "BULLEEN",
    "state" : "VIC",
    "postcode" : "3105",
    "formattedAddress" : "1609 GURRIEL Avenue, BULLEEN, Victoria, 3105"
  },
  "fee" : {
    "attributes" : {
      "plan" : "Fixed Wireless Plus",
      "term" : "1"
    },
    "oneTimeCharge" : {
      "amount" : "0.00",
      "currency" : "AUD",
      "symbol" : "$"
    },
    "monthlyRecurringCharge" : {
      "amount" : "50.00",
      "currency" : "AUD",
      "symbol" : "$"
    }
  },
  "additionalFees" : [ {
    "addOnTypeName" : "SLA",
    "fee" : {
      "attributes" : {
        "sla" : "Standard"
      },
      "oneTimeCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      },
      "monthlyRecurringCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      }
    }
  } ],
  "appointments" : [ ],
  "aggregationMethod" : "L2TP",
  "legacyTechnologyType" : null,
  "transferType" : null,
  "360ServiceId" : null,
  "isCancellable" : false,
  "isNfas" : false
}

Optionally, Once you have the URI from the Location header, you can make a GET request to get the newly created order information.

GET Request
GET /api/connect/orders/1 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 3
Host: 360-api.superloop.com
Successful GET Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2142

{
  "id" : 1,
  "orderType" : "new",
  "status" : "OPEN",
  "serviceClass" : "3",
  "technologyType" : "FTTP",
  "trafficClass" : "TC4",
  "installationType" : "nbn-tech",
  "customerRef" : "ABC123",
  "locId" : "LOC151638001451",
  "avcId" : null,
  "avcIdForTransfer" : null,
  "vlanId" : 100,
  "poi" : "3CBN",
  "poiName" : "Cranbourne",
  "region" : "Urban",
  "eSla" : "Standard",
  "bandwidthProfile" : {
    "speedDown" : 100,
    "speedUp" : 20,
    "planName" : "Home Fast 100/20",
    "cvcInclusion" : null
  },
  "infrastructure" : null,
  "address" : {
    "buildingLevel" : null,
    "unitNumber" : null,
    "buildingName" : null,
    "streetNumber" : "1451",
    "street" : "GARLAND DR",
    "suburb" : "BALWYN EAST",
    "state" : "VIC",
    "postcode" : "3103",
    "formattedAddress" : "1451 GARLAND Drive, BALWYN EAST, Victoria, 3103"
  },
  "fee" : {
    "attributes" : {
      "plan" : "Home Fast 100/20",
      "term" : "1"
    },
    "oneTimeCharge" : {
      "amount" : "0.00",
      "currency" : "AUD",
      "symbol" : "$"
    },
    "monthlyRecurringCharge" : {
      "amount" : "65.00",
      "currency" : "AUD",
      "symbol" : "$"
    }
  },
  "additionalFees" : [ {
    "addOnTypeName" : "SUBSEQUENT_INSTALLATION_CHARGE",
    "fee" : {
      "attributes" : {
        "technology_type" : "fttp"
      },
      "oneTimeCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      },
      "monthlyRecurringCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      }
    }
  }, {
    "addOnTypeName" : "SLA",
    "fee" : {
      "attributes" : {
        "sla" : "Standard"
      },
      "oneTimeCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      },
      "monthlyRecurringCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      }
    }
  } ],
  "appointments" : [ ],
  "aggregationMethod" : "L2TP",
  "legacyTechnologyType" : null,
  "transferType" : null,
  "360ServiceId" : null,
  "isCancellable" : false,
  "isNfas" : false
}

Invalid Order creation

If the order request is invalid for any reason, a http status of 422 is returned and the body of the response will list the problems with the request.

This example is of submitting an order request without a suburb field.

POST Request
POST /api/connect/orders/create HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 3
Content-Length: 545
Host: 360-api.superloop.com

{
  "sourceType" : "nbn",
  "planName" : "Home Fast 100/40",
  "term" : 1,
  "trafficClass" : "tc4",
  "remoteQualificationSearchId" : "1eb878c4-d5e1-63cc-8780-7e380507f753",
  "qualificationSearchId" : "4317d956-1b3f-43f1-8161-28f72b5b55cd",
  "locationId" : "LOC151638001451",
  "remoteOrderId" : "1eb878c4-d4b9-6e0e-9f99-7e380507f753",
  "productType" : "Access Only",
  "restorationSla" : "Standard",
  "contactEmail" : "bruce@wayne.com",
  "infrastructureId" : "NTD151638001451",
  "portId" : null,
  "requireVLAN" : true,
  "vlanId" : 56
}
POST Response with request validation errors
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 758

{
  "httpStatusCode" : 422,
  "type" : "client.validation",
  "code" : "method.argument.not.valid",
  "message" : "Validation error",
  "apiSubErrors" : [ {
    "code" : "constraints.not.blank",
    "message" : "must not be blank",
    "object" : "connectCreateOrderCommand",
    "field" : "contactPhone",
    "rejectedValue" : null
  }, {
    "code" : "constraints.not.blank",
    "message" : "must not be blank",
    "object" : "connectCreateOrderCommand",
    "field" : "contactName",
    "rejectedValue" : null
  }, {
    "code" : "constraints.not.blank",
    "message" : "must not be blank",
    "object" : "connectCreateOrderCommand",
    "field" : "ntdInstallation",
    "rejectedValue" : null
  } ],
  "timestamp" : "2025-03-11T22:24:53.576300626Z"
}

Upstream Service Unavailable

If one of the services that Connect API uses for creating an order is down or unreachable, Connect API will send a 502 status.

Successful Order creation FTTP Service Class 3

POST Request - Additional NTD , nbn-tech
POST /api/connect/orders/create HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 3
Content-Length: 667
Host: 360-api.superloop.com

{
  "sourceType" : "nbn",
  "planName" : "Home Fast 100/20",
  "term" : 1,
  "trafficClass" : "tc4",
  "remoteQualificationSearchId" : "1eb878c4-d5e1-63cc-8780-7e380507f753",
  "qualificationSearchId" : "d8a71e0b-4da6-44b4-a28e-b6d3ff5abb5c",
  "locationId" : "LOC151638001451",
  "remoteOrderId" : "1eb878c4-d4b9-6e0e-9f99-7e380507f753",
  "productType" : "Access Only",
  "restorationSla" : "Standard",
  "contactName" : "Bruce Wayne",
  "contactPhone" : "4000000000",
  "contactEmail" : "bruce@wayne.com",
  "infrastructureId" : null,
  "portId" : null,
  "requireVLAN" : true,
  "vlanId" : 100,
  "ntdInstallation" : "nbn-tech",
  "customerReference" : "ABC123"
}
Successful Response
HTTP/1.1 201 Created
Location: /api/connect/orders/1
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2142

{
  "id" : 1,
  "orderType" : "new",
  "status" : "OPEN",
  "serviceClass" : "3",
  "technologyType" : "FTTP",
  "trafficClass" : "TC4",
  "installationType" : "nbn-tech",
  "customerRef" : "ABC123",
  "locId" : "LOC151638001451",
  "avcId" : null,
  "avcIdForTransfer" : null,
  "vlanId" : 100,
  "poi" : "3CBN",
  "poiName" : "Cranbourne",
  "region" : "Urban",
  "eSla" : "Standard",
  "bandwidthProfile" : {
    "speedDown" : 100,
    "speedUp" : 20,
    "planName" : "Home Fast 100/20",
    "cvcInclusion" : null
  },
  "infrastructure" : null,
  "address" : {
    "buildingLevel" : null,
    "unitNumber" : null,
    "buildingName" : null,
    "streetNumber" : "1451",
    "street" : "GARLAND DR",
    "suburb" : "BALWYN EAST",
    "state" : "VIC",
    "postcode" : "3103",
    "formattedAddress" : "1451 GARLAND Drive, BALWYN EAST, Victoria, 3103"
  },
  "fee" : {
    "attributes" : {
      "plan" : "Home Fast 100/20",
      "term" : "1"
    },
    "oneTimeCharge" : {
      "amount" : "0.00",
      "currency" : "AUD",
      "symbol" : "$"
    },
    "monthlyRecurringCharge" : {
      "amount" : "65.00",
      "currency" : "AUD",
      "symbol" : "$"
    }
  },
  "additionalFees" : [ {
    "addOnTypeName" : "SLA",
    "fee" : {
      "attributes" : {
        "sla" : "Standard"
      },
      "oneTimeCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      },
      "monthlyRecurringCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      }
    }
  }, {
    "addOnTypeName" : "SUBSEQUENT_INSTALLATION_CHARGE",
    "fee" : {
      "attributes" : {
        "technology_type" : "fttp"
      },
      "oneTimeCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      },
      "monthlyRecurringCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      }
    }
  } ],
  "appointments" : [ ],
  "aggregationMethod" : "L2TP",
  "legacyTechnologyType" : null,
  "transferType" : null,
  "360ServiceId" : null,
  "isCancellable" : false,
  "isNfas" : false
}

Successful Order creation FW Service Class 6

POST Request - Existing NTD , nbn-no-action
POST /api/connect/orders/create HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 3
Content-Length: 1061
Host: 360-api.superloop.com

{
  "sourceType" : "nbn",
  "planName" : "Fixed Wireless Plus",
  "term" : 1,
  "trafficClass" : "tc4",
  "remoteQualificationSearchId" : "1eb878c4-d5e1-63cc-8780-7e380507f753",
  "qualificationSearchId" : "d8a71e0b-4da6-44b4-a28e-b6d3ff5abb5c",
  "locationId" : "LOC151638001891",
  "remoteOrderId" : "1eb878c4-d4b9-6e0e-9f99-7e380507f753",
  "productType" : "Access Only",
  "restorationSla" : "Standard",
  "contactName" : "Bruce Wayne",
  "contactPhone" : "4000000000",
  "contactEmail" : "bruce@wayne.com",
  "infrastructureId" : "NTD151638001891",
  "portId" : null,
  "requireVLAN" : true,
  "vlanId" : 100,
  "ntdInstallation" : "nbn-no-action",
  "ntdName" : "John Smith",
  "ntdPhoneNumber" : "4000000001",
  "ntdBusinessName" : "Wayne Industries",
  "ntdAddressLine1" : "Dark Street",
  "ntdAddressLine2" : "Gotham",
  "suburb" : "Crest Hill",
  "postCode" : "4000",
  "ntdState" : "QLD",
  "ntdAuthorityToLeave" : true,
  "ntdDeliveryInstructions" : "Please leave at reception",
  "ntdSameAddressDelivery" : false,
  "customerReference" : "ABC123"
}
Successful Response
HTTP/1.1 201 Created
Location: /api/connect/orders/1
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1837

{
  "id" : 1,
  "orderType" : "new",
  "status" : "OPEN",
  "serviceClass" : "6",
  "technologyType" : "FW",
  "trafficClass" : "TC4",
  "installationType" : "nbn-no-action",
  "customerRef" : "ABC123",
  "locId" : "LOC151638001891",
  "avcId" : null,
  "avcIdForTransfer" : null,
  "vlanId" : 100,
  "poi" : "9trptogdu",
  "poiName" : "West Milo",
  "region" : "Urban",
  "eSla" : "Standard",
  "bandwidthProfile" : {
    "speedDown" : 75,
    "speedUp" : 10,
    "planName" : "Fixed Wireless Plus",
    "cvcInclusion" : null
  },
  "infrastructure" : {
    "id" : "NTD151638001891",
    "portId" : "null",
    "productId" : null
  },
  "address" : {
    "buildingLevel" : null,
    "unitNumber" : null,
    "buildingName" : null,
    "streetNumber" : "1891",
    "street" : "OWINGS DR",
    "suburb" : "TEMPLESTOWE",
    "state" : "VIC",
    "postcode" : "3106",
    "formattedAddress" : "1891 OWINGS Drive, TEMPLESTOWE, Victoria, 3106"
  },
  "fee" : {
    "attributes" : {
      "plan" : "Fixed Wireless Plus",
      "term" : "1"
    },
    "oneTimeCharge" : {
      "amount" : "0.00",
      "currency" : "AUD",
      "symbol" : "$"
    },
    "monthlyRecurringCharge" : {
      "amount" : "50.00",
      "currency" : "AUD",
      "symbol" : "$"
    }
  },
  "additionalFees" : [ {
    "addOnTypeName" : "SLA",
    "fee" : {
      "attributes" : {
        "sla" : "Standard"
      },
      "oneTimeCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      },
      "monthlyRecurringCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      }
    }
  } ],
  "appointments" : [ ],
  "aggregationMethod" : "L2TP",
  "legacyTechnologyType" : null,
  "transferType" : null,
  "360ServiceId" : null,
  "isCancellable" : false,
  "isNfas" : false
}

Successful Order creation FTTN Service Class 13

POST Request - Existing NTD , nbn-no-action
POST /api/connect/orders/create HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 3
Content-Length: 667
Host: 360-api.superloop.com

{
  "sourceType" : "nbn",
  "planName" : "Home Fast 100/20",
  "term" : 1,
  "trafficClass" : "tc4",
  "remoteQualificationSearchId" : "1eb878c4-d5e1-63cc-8780-7e380507f753",
  "qualificationSearchId" : "d8a71e0b-4da6-44b4-a28e-b6d3ff5abb5c",
  "locationId" : "LOC151638003251",
  "remoteOrderId" : "1eb878c4-d4b9-6e0e-9f99-7e380507f753",
  "productType" : "Access Only",
  "restorationSla" : "Standard",
  "contactName" : "Bruce Wayne",
  "contactPhone" : "4000000000",
  "contactEmail" : "bruce@wayne.com",
  "infrastructureId" : null,
  "portId" : null,
  "requireVLAN" : true,
  "vlanId" : 100,
  "ntdInstallation" : "nbn-tech",
  "customerReference" : "ABC123"
}
Successful Response
HTTP/1.1 201 Created
Location: /api/connect/orders/1
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2148

{
  "id" : 1,
  "orderType" : "new",
  "status" : "OPEN",
  "serviceClass" : "13",
  "technologyType" : "FTTN",
  "trafficClass" : "TC4",
  "installationType" : "nbn-tech",
  "customerRef" : "ABC123",
  "locId" : "LOC151638003251",
  "avcId" : null,
  "avcIdForTransfer" : null,
  "vlanId" : 100,
  "poi" : "9zrvcxfsn",
  "poiName" : "East Antonette",
  "region" : "Urban",
  "eSla" : "Standard",
  "bandwidthProfile" : {
    "speedDown" : 100,
    "speedUp" : 20,
    "planName" : "Home Fast 100/20",
    "cvcInclusion" : null
  },
  "infrastructure" : null,
  "address" : {
    "buildingLevel" : null,
    "unitNumber" : null,
    "buildingName" : null,
    "streetNumber" : "3251",
    "street" : "SLATER DR",
    "suburb" : "WARRANDYTE",
    "state" : "VIC",
    "postcode" : "3113",
    "formattedAddress" : "3251 SLATER Drive, WARRANDYTE, Victoria, 3113"
  },
  "fee" : {
    "attributes" : {
      "plan" : "Home Fast 100/20",
      "term" : "1"
    },
    "oneTimeCharge" : {
      "amount" : "0.00",
      "currency" : "AUD",
      "symbol" : "$"
    },
    "monthlyRecurringCharge" : {
      "amount" : "65.00",
      "currency" : "AUD",
      "symbol" : "$"
    }
  },
  "additionalFees" : [ {
    "addOnTypeName" : "SLA",
    "fee" : {
      "attributes" : {
        "sla" : "Standard"
      },
      "oneTimeCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      },
      "monthlyRecurringCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      }
    }
  }, {
    "addOnTypeName" : "SUBSEQUENT_INSTALLATION_CHARGE",
    "fee" : {
      "attributes" : {
        "technology_type" : "fttn"
      },
      "oneTimeCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      },
      "monthlyRecurringCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      }
    }
  } ],
  "appointments" : [ ],
  "aggregationMethod" : "L2TP",
  "legacyTechnologyType" : null,
  "transferType" : null,
  "360ServiceId" : null,
  "isCancellable" : false,
  "isNfas" : false
}

Successful Order creation FTTB Service Class 13

POST Request - Existing NTD , nbn-no-action
POST /api/connect/orders/create HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 3
Content-Length: 667
Host: 360-api.superloop.com

{
  "sourceType" : "nbn",
  "planName" : "Home Fast 100/20",
  "term" : 1,
  "trafficClass" : "tc4",
  "remoteQualificationSearchId" : "1eb878c4-d5e1-63cc-8780-7e380507f753",
  "qualificationSearchId" : "d8a71e0b-4da6-44b4-a28e-b6d3ff5abb5c",
  "locationId" : "LOC151638003258",
  "remoteOrderId" : "1eb878c4-d4b9-6e0e-9f99-7e380507f753",
  "productType" : "Access Only",
  "restorationSla" : "Standard",
  "contactName" : "Bruce Wayne",
  "contactPhone" : "4000000000",
  "contactEmail" : "bruce@wayne.com",
  "infrastructureId" : null,
  "portId" : null,
  "requireVLAN" : true,
  "vlanId" : 100,
  "ntdInstallation" : "nbn-tech",
  "customerReference" : "ABC123"
}
Successful Response
HTTP/1.1 201 Created
Location: /api/connect/orders/1
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2156

{
  "id" : 1,
  "orderType" : "new",
  "status" : "OPEN",
  "serviceClass" : "13",
  "technologyType" : "FTTB",
  "trafficClass" : "TC4",
  "installationType" : "nbn-tech",
  "customerRef" : "ABC123",
  "locId" : "LOC151638003258",
  "avcId" : null,
  "avcIdForTransfer" : null,
  "vlanId" : 100,
  "poi" : "4avuzteny",
  "poiName" : "Heathcotemouth",
  "region" : "Urban",
  "eSla" : "Standard",
  "bandwidthProfile" : {
    "speedDown" : 100,
    "speedUp" : 20,
    "planName" : "Home Fast 100/20",
    "cvcInclusion" : null
  },
  "infrastructure" : null,
  "address" : {
    "buildingLevel" : null,
    "unitNumber" : null,
    "buildingName" : null,
    "streetNumber" : "3258",
    "street" : "GEARRIN RD",
    "suburb" : "NORTH RYDE",
    "state" : "NSW",
    "postcode" : "2113",
    "formattedAddress" : "3258 GEARRIN Road, NORTH RYDE, New South Wales, 2113"
  },
  "fee" : {
    "attributes" : {
      "plan" : "Home Fast 100/20",
      "term" : "1"
    },
    "oneTimeCharge" : {
      "amount" : "0.00",
      "currency" : "AUD",
      "symbol" : "$"
    },
    "monthlyRecurringCharge" : {
      "amount" : "65.00",
      "currency" : "AUD",
      "symbol" : "$"
    }
  },
  "additionalFees" : [ {
    "addOnTypeName" : "SLA",
    "fee" : {
      "attributes" : {
        "sla" : "Standard"
      },
      "oneTimeCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      },
      "monthlyRecurringCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      }
    }
  }, {
    "addOnTypeName" : "SUBSEQUENT_INSTALLATION_CHARGE",
    "fee" : {
      "attributes" : {
        "technology_type" : "fttb"
      },
      "oneTimeCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      },
      "monthlyRecurringCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      }
    }
  } ],
  "appointments" : [ ],
  "aggregationMethod" : "L2TP",
  "legacyTechnologyType" : null,
  "transferType" : null,
  "360ServiceId" : null,
  "isCancellable" : false,
  "isNfas" : false
}

Successful Order creation HFC Service Class 24

POST Request - Existing NTD , nbn-dispatch
POST /api/connect/orders/create HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 3
Content-Length: 1063
Host: 360-api.superloop.com

{
  "sourceType" : "nbn",
  "planName" : "Home Fast 100/20",
  "term" : 1,
  "trafficClass" : "tc4",
  "remoteQualificationSearchId" : "1eb878c4-d5e1-63cc-8780-7e380507f753",
  "qualificationSearchId" : "d8a71e0b-4da6-44b4-a28e-b6d3ff5abb5c",
  "locationId" : "LOC151638004251",
  "remoteOrderId" : "1eb878c4-d4b9-6e0e-9f99-7e380507f753",
  "productType" : "Access Only",
  "restorationSla" : "Standard",
  "contactName" : "Bruce Wayne",
  "contactPhone" : "4000000000",
  "contactEmail" : "bruce@wayne.com",
  "infrastructureId" : "NTD151638004251",
  "portId" : null,
  "requireVLAN" : true,
  "vlanId" : 100,
  "ntdInstallation" : "nbn-dispatch",
  "ntdName" : "John Smith",
  "ntdPhoneNumber" : "4000000001",
  "ntdBusinessName" : "Wayne Industries",
  "ntdAddressLine1" : "Dark Street",
  "ntdAddressLine2" : "Gotham",
  "ntdSuburb" : "Crest Hill",
  "ntdPostcode" : "4000",
  "ntdState" : "QLD",
  "ntdAuthorityToLeave" : true,
  "ntdDeliveryInstructions" : "Please leave at reception",
  "ntdSameAddressDelivery" : false,
  "customerReference" : "ABC123"
}
Successful Response
HTTP/1.1 201 Created
Location: /api/connect/orders/1
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1824

{
  "id" : 1,
  "orderType" : "new",
  "status" : "OPEN",
  "serviceClass" : "24",
  "technologyType" : "HFC",
  "trafficClass" : "TC4",
  "installationType" : "nbn-dispatch",
  "customerRef" : "ABC123",
  "locId" : "LOC151638004251",
  "avcId" : null,
  "avcIdForTransfer" : null,
  "vlanId" : 100,
  "poi" : "9ABC",
  "poiName" : "Zanzibar",
  "region" : "Urban",
  "eSla" : "Standard",
  "bandwidthProfile" : {
    "speedDown" : 100,
    "speedUp" : 20,
    "planName" : "Home Fast 100/20",
    "cvcInclusion" : null
  },
  "infrastructure" : {
    "id" : "NTD151638004251",
    "portId" : "null",
    "productId" : null
  },
  "address" : {
    "buildingLevel" : null,
    "unitNumber" : null,
    "buildingName" : null,
    "streetNumber" : "4251",
    "street" : "JAIRO ST",
    "suburb" : "CAMBERWELL",
    "state" : "VIC",
    "postcode" : "3124",
    "formattedAddress" : "4251 JAIRO Street, CAMBERWELL, Victoria, 3124"
  },
  "fee" : {
    "attributes" : {
      "plan" : "Home Fast 100/20",
      "term" : "1"
    },
    "oneTimeCharge" : {
      "amount" : "0.00",
      "currency" : "AUD",
      "symbol" : "$"
    },
    "monthlyRecurringCharge" : {
      "amount" : "65.00",
      "currency" : "AUD",
      "symbol" : "$"
    }
  },
  "additionalFees" : [ {
    "addOnTypeName" : "SLA",
    "fee" : {
      "attributes" : {
        "sla" : "Standard"
      },
      "oneTimeCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      },
      "monthlyRecurringCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      }
    }
  } ],
  "appointments" : [ ],
  "aggregationMethod" : "L2TP",
  "legacyTechnologyType" : null,
  "transferType" : null,
  "360ServiceId" : null,
  "isCancellable" : false,
  "isNfas" : false
}

Successful Order creation FTTC Service Class 34

POST Request - Existing NTD , nbn-dispatch
POST /api/connect/orders/create HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 3
Content-Length: 1063
Host: 360-api.superloop.com

{
  "sourceType" : "nbn",
  "planName" : "Home Fast 100/20",
  "term" : 1,
  "trafficClass" : "tc4",
  "remoteQualificationSearchId" : "1eb878c4-d5e1-63cc-8780-7e380507f753",
  "qualificationSearchId" : "d8a71e0b-4da6-44b4-a28e-b6d3ff5abb5c",
  "locationId" : "LOC151638005051",
  "remoteOrderId" : "1eb878c4-d4b9-6e0e-9f99-7e380507f753",
  "productType" : "Access Only",
  "restorationSla" : "Standard",
  "contactName" : "Bruce Wayne",
  "contactPhone" : "4000000000",
  "contactEmail" : "bruce@wayne.com",
  "infrastructureId" : "CPI151638005051",
  "portId" : null,
  "requireVLAN" : true,
  "vlanId" : 100,
  "ntdInstallation" : "nbn-dispatch",
  "ntdName" : "John Smith",
  "ntdPhoneNumber" : "4000000001",
  "ntdBusinessName" : "Wayne Industries",
  "ntdAddressLine1" : "Dark Street",
  "ntdAddressLine2" : "Gotham",
  "ntdSuburb" : "Crest Hill",
  "ntdPostcode" : "4000",
  "ntdState" : "QLD",
  "ntdAuthorityToLeave" : true,
  "ntdDeliveryInstructions" : "Please leave at reception",
  "ntdSameAddressDelivery" : false,
  "customerReference" : "ABC123"
}
Successful Response
HTTP/1.1 201 Created
Location: /api/connect/orders/1
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2200

{
  "id" : 1,
  "orderType" : "new",
  "status" : "OPEN",
  "serviceClass" : "34",
  "technologyType" : "FTTC",
  "trafficClass" : "TC4",
  "installationType" : "nbn-dispatch",
  "customerRef" : "ABC123",
  "locId" : "LOC151638005051",
  "avcId" : null,
  "avcIdForTransfer" : null,
  "vlanId" : 100,
  "poi" : "9zrvcxfsn",
  "poiName" : "East Antonette",
  "region" : "Urban",
  "eSla" : "Standard",
  "bandwidthProfile" : {
    "speedDown" : 100,
    "speedUp" : 20,
    "planName" : "Home Fast 100/20",
    "cvcInclusion" : null
  },
  "infrastructure" : {
    "id" : "CPI151638005051",
    "productId" : null
  },
  "address" : {
    "buildingLevel" : null,
    "unitNumber" : null,
    "buildingName" : null,
    "streetNumber" : "5051",
    "street" : "MARSALIS DR",
    "suburb" : "AVONDALE HEIGHTS",
    "state" : "VIC",
    "postcode" : "3034",
    "formattedAddress" : "5051 MARSALIS Drive, AVONDALE HEIGHTS, Victoria, 3034"
  },
  "fee" : {
    "attributes" : {
      "plan" : "Home Fast 100/20",
      "term" : "1"
    },
    "oneTimeCharge" : {
      "amount" : "0.00",
      "currency" : "AUD",
      "symbol" : "$"
    },
    "monthlyRecurringCharge" : {
      "amount" : "65.00",
      "currency" : "AUD",
      "symbol" : "$"
    }
  },
  "additionalFees" : [ {
    "addOnTypeName" : "SLA",
    "fee" : {
      "attributes" : {
        "sla" : "Standard"
      },
      "oneTimeCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      },
      "monthlyRecurringCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      }
    }
  }, {
    "addOnTypeName" : "NDF",
    "fee" : {
      "attributes" : {
        "ndf" : "New Development Fee"
      },
      "oneTimeCharge" : {
        "amount" : "300.00",
        "currency" : "AUD",
        "symbol" : "$"
      },
      "monthlyRecurringCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "$"
      }
    }
  } ],
  "appointments" : [ ],
  "aggregationMethod" : "L2TP",
  "legacyTechnologyType" : null,
  "transferType" : null,
  "360ServiceId" : null,
  "isCancellable" : false,
  "isNfas" : false
}

Order GET with Appointments

GET Request
GET /api/connect/orders/1 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 3
Host: 360-api.superloop.com
Successful GET Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 3201

{
  "id" : 1,
  "orderType" : "transfer",
  "status" : "OPEN",
  "serviceClass" : "3",
  "technologyType" : "FTTP",
  "trafficClass" : "TC4",
  "installationType" : "nbn-no-action",
  "customerRef" : "REF123",
  "locId" : "LOC000000000001",
  "avcId" : null,
  "avcIdForTransfer" : null,
  "vlanId" : 102,
  "poi" : "4CPH",
  "poiName" : "Camp Hill",
  "region" : "Urban",
  "eSla" : "Enhanced - 8 (24/7)",
  "bandwidthProfile" : {
    "speedDown" : 25,
    "speedUp" : 5,
    "planName" : "Home Fast 25/5",
    "cvcInclusion" : 1.25
  },
  "infrastructure" : {
    "id" : "NTD000033427450",
    "portId" : "1",
    "productId" : "PRI000000000000"
  },
  "address" : {
    "buildingLevel" : "7",
    "unitNumber" : "702",
    "buildingName" : "ARANA HILLS LIBRARY",
    "streetNumber" : "63",
    "street" : "COBBITY CR",
    "suburb" : "ARANA HILLS",
    "state" : "QLD",
    "postcode" : "4054",
    "formattedAddress" : "ARANA HILLS LIBRARY, Lot 798, 63 COBBITY Crescent, ARANA HILLS, Queensland, 4054"
  },
  "fee" : {
    "attributes" : {
      "term" : "12",
      "plan" : "Home Fast 50/20"
    },
    "oneTimeCharge" : {
      "amount" : "1700.00",
      "currency" : "AUD",
      "symbol" : "&#36"
    },
    "monthlyRecurringCharge" : {
      "amount" : "350.00",
      "currency" : "AUD",
      "symbol" : "&#36"
    }
  },
  "additionalFees" : [ {
    "addOnTypeName" : "NDF",
    "fee" : {
      "attributes" : {
        "technology_type" : "fttn"
      },
      "oneTimeCharge" : {
        "amount" : "100.00",
        "currency" : "AUD",
        "symbol" : "$"
      },
      "monthlyRecurringCharge" : {
        "amount" : "10.00",
        "currency" : "AUD",
        "symbol" : "$"
      }
    }
  } ],
  "appointments" : [ {
    "id" : 2,
    "nbnAppointmentId" : "APT190003450395",
    "slotType" : "PM",
    "startTime" : "2020-09-01T03:00:00Z",
    "endTime" : "2020-09-01T07:00:00Z",
    "timezoneOffset" : "+10:00",
    "priorityAssist" : false,
    "eSla" : "Standard",
    "demandType" : "Standard Install",
    "contact" : {
      "name" : "Bruce Wayne",
      "type" : "Primary Contact",
      "phone" : "0422151651",
      "notes" : "Please use bat signal"
    },
    "bookedOn" : "2020-08-20T08:51:30Z",
    "cancellationRequests" : [ {
      "id" : 1,
      "status" : "FAILED",
      "statusDateChangedTo" : "2023-06-16T23:12:05Z",
      "requestedOn" : "2021-06-15T04:34:31Z",
      "errorDetail" : "Appointment is past point of no return"
    } ]
  }, {
    "id" : 1,
    "nbnAppointmentId" : "APT790002088781",
    "slotType" : "AM",
    "startTime" : "2020-08-31T22:00:00Z",
    "endTime" : "2020-09-01T02:00:00Z",
    "timezoneOffset" : "+10:00",
    "priorityAssist" : false,
    "eSla" : "Standard",
    "demandType" : "Standard Install",
    "contact" : {
      "name" : "Bruce Wayne",
      "type" : "Primary Contact",
      "phone" : "0422151651",
      "notes" : "Please use bat signal"
    },
    "bookedOn" : "2020-08-18T08:51:30Z",
    "cancellationRequests" : [ ]
  } ],
  "aggregationMethod" : "L2TP",
  "legacyTechnologyType" : "FTTN",
  "transferType" : "SERVICE_TRANSFER",
  "360ServiceId" : 300,
  "isCancellable" : false,
  "isNfas" : true
}