Order Management And Progress Updates

Introduction

A Broadband One order comprises an access product offering, and several associated product offerings.

• Each product offering is represented in the Broadband One order by an id value in a product.productOffering object
• Access technology product offering, and associated product offerings except dynamic IP, and router, include attributes - name/value pairs in product.productCharacteristic arrays
• Values are derived from multiple data sources - other Broadband One APIs, your BT Wholesale account details, and tables on this page.

Visit the Broadband One ordering tutorial for a deeper dive.

Code example

productOffering object for FTTP 160_30M

Note the productOffering.id for the access technology and speed. And product attributes in the productCharacteristic array.

There are many more attributes required for the access technology than associated products.

                "productOffering": {
                    "id": "E0000160"
                },
                "place": [
                    {
                        "id": "R00000521994",
                        "role": "SiteAddress",
                        "@type": "btRelatedPlaceRefOrValue"
                    },
                    {
                        "id": "A99923776374",
                        "role": "OpenreachAddress",
                        "address": {
                            "districtCode": "LS"
                        },
                        "@type": "btRelatedPlaceRefOrValue"
                    }
                ],
                "productCharacteristic": [
                    {
                        "name": "ATT_RT_InstallType",
                        "value": "M"
                    },
                    {
                        "name": "ATT_RT_AccessTechnology",
                        "value": "FTTP"
                    },
                    {
                        "name": "ATT_X_JOURNEYTYPE",
                        "value": "NewLineProvide"
                    },
                    {
                        "name": "ATT_RT_ONTType",
                        "value": "New ONT"
                    },
                    {
                        "name": "ATT_RT_ProductMinimumGuaranteedSpeed",
                        "value": "130"
                    },
                    {
                        "name": "ATT_RT_EndUserType",
                        "value": "Residential"
                    },
                    {
                        "name": "ATT_RT_TrafficWeighting",
                        "value": "Standard"
                    },
                    {
                        "name": "ATT_RT_ContractTerm",
                        "value": "12"
                    },
                    {
                        "name": "ATT_RT_ContractTermUnit",
                        "value": "Month"
                    },
                    {
                        "name": "ATT_RT_ResellerID",
                        "value": "ZYX"
                    }
                ],

 The access technology id, shown in line 2 of the above code snippet, is shown in the Access technology product codes table.

Its data source is the productOffering.id value in the product availability API.

Here's what that looks like:

"productOffering": {
                    "id": "FTTP 0.5_0.5M",
                    "name": "FTTP"
                },

Navigating this page

Below you'll find tables of attributes to help you build Broadband One ordering into your app:

• Access product codes (productOffering.id value in order payload) to map from the required productOffering.id in the product availability API response.
• Access product attributes
• Associated product codes
• Static IP and managed install attributes.

Access technology product codes

FTTP attributes

SOGEA attributes

SOADSL attributes

FTTC attributes

ADSL attributes

Associated product codes

Static IP attribute

Managed install attributes

Installation is either self or managed installation, depending on the customer's infrastructure and/or custom requirements.

• Managed install is a product. It is not available for ADSL orders
• For more information on the managed install products - standard, premium, and advanced - read the Broadband One Product Handbook.

Key product attributes for Order and Journey Types

When placing orders to start stopped lines, takeover working lines, migrate services or provide new services various attributes are needed to identify existing products, copper  lines and ONT ports plus various other attributes are needed to identify the scenario at work. The image below summarises these for each order/journey type and network technology. Note that not all combinations of order/journey type and technology shown below are currently supported. (Open the image below in a new browser tab to see the image in more detail).

Helpful resources

• Fork our Broadband One Postman Collection
• Broadband One Product Handbook (login required).