Ethernet

  • Data services
  • Wholesale

End to End APIs for every step of the Wholesale Ethernet journey.

Ethernet offers a national layer 2 Ethernet service,
targeting UK communication providers with bandwidth optionsranging from 0.2Mbps to 10Gbps.

Integrating Ethernet APIs into your business applications increases efficiency and visibility by enabling a truly digital order experience for you and your end customers. These APIs, based on TMF standards, allow you to manage the entire product lifecycle—from quote to order, through to repair and diagnostics—without ever having to log into a portal.

The following information is to help you order and manage BT Wholesale Ethernet products using our APIs. You can use our APIs for the following key operations:

  • Validate sites and services: Perform address management checks and verify technical eligibility using Product Qualification.
  • Generate pricing: Retrieve synchronous quotes for Ethernet and DIA products, including recurring and non-recurring costs.
  • Manage appointments: Pre-book Openreach engineer appointments for GEA variants (FTTP/SOGEA) before order placement.
  • Execute orders: Place, modify, amend, or cease orders for Etherway and Etherflow services.
  • Track progress: Monitor order status based on milestones, order IDs, and open actions.

APIs Included

BT

OAuth 2

Identity and Authentication

OAuth 2 produces an access token which is required to authorise API calls for a given app.

Product Documentation
BT Wholesale

Address Management (Ethernet)

Ethernet

Set an address using a UK postcode, or manually create a temporary one, before placing an order.

Product Documentation
BT Wholesale

Quote Management (Ethernet)

Ethernet

Create and retrieve quotes for BT Wholesale Ethernet and Optical products. More information about this API is available in the 'Further information' tab.

The sandbox/test API is a dynamic test environment and should...

Product Documentation
BT Wholesale

Product Qualification (Ethernet)

Ethernet

Provides a standardized mechanism for placing a qualification request, to check offer eligibility with all of the necessary parameters.

Product Documentation
BT Wholesale

Appointment Management (Ethernet)

Ethernet

Users can query for appointment slots based on particular date and book engineer appointment. This is only for standard appointments of Etherway Superfast GEA product.

Product Documentation
BT Wholesale

Product Order (Ethernet)

Ethernet

Place, modify and track Ethernet orders across Etherway Fibre (EAD), Etherflow Connected, Etherflow Internet and Etherway Superfast GEA (SOGEA & FTTP).

Product Documentation
BT Wholesale

Order Notification Import Orders (Ethernet)

Ethernet

Automated notifications on progress of orders placed via the Import Order APIs will be sent directly to the provided URL ('callback URL') provided at onboarding.

Product Documentation

How it works

The Ethernet API suite delivers an end-to-end digital journey across the product lifecycle. The quoting process is synchronous, providing immediate pricing results. However, the product ordering API uses an asynchronous, webhook-driven model. You submit an order to perform an action, and our platform notifies your Webhook Listener as the order moves through lifecycle states such as acknowledged, inProgress, and completed.

Note: This flow is a simplified overview focusing on the "Happy path" using a Gold NAD key. It assumes all technical and commercial validations pass successfully.

  1. Get access token

    Authenticate using an OAuth 2.0 bearer token. Use this token in the Authorization header for all subsequent requests.
     
  2. Retrieve Address ID (NAD Key)

    Use the Address Management API to find a site with an Openreach Address ID. Gold keys ( starting with A) provide a higher resolution view and avoid data gaps during technical checks.
     
  3. (Optional) Check product availability

    Perform a high-resolution technical check via the Product Qualification API. A GREEN status confirms technical viability, while a BLACK status indicates a data failure, often caused by using non-Gold keys.
     
  4. (Optional) Generate a quote

    Submit your requirements to the synchronous /quote endpoint.
    • Structure: Ethernet Internet and E-LAN require one place and two services (Physical + Virtual).
    • Nesting logic: Optional hardware must be nested within the EtherwayFibreService using a bundle like "Managed Installation & Maintenance".
    • Output: Returns indicative pricing for 1, 3, and 5-year terms, including Option B variations.
       
  5. (Mandatory for Etherway Superfast GEA only) Reserve an appointment

    For Etherway Superfast GEA (SOGEA & FTTP), you must secure a mandatory Appointment ID using the Appointment Management API before ordering.
     
  6. Submit product order

    Submit the final payload to /productOrder. Remember that products must be ordered individually (e.g., do not mix Ethernet and Optical).
     
  7. Listen for order notifications

    Monitor your webhook listener for asynchronous state changes until the status reaches completed.

Getting started

Whether you are exploring our sandbox or are ready to integrate, we have the resources you need.

If you are new to our portal, the first step is to register and create a sandbox application. This will give you the credentials to start making test calls to the API.

If you are already registered, dive into our comprehensive technical documentation to understand the API in detail. Our tutorials provide step-by-step guidance for the most common use cases.

Get started

Benefits and features

  • Reduced Errors: Automated API journeys reduce manual entry errors and order management costs.
  • Near Real-Time Tracking: Gain full visibility into the order lifecycle with near real-time status updates via webhooks.
  • Faster Diagnostics: Integrated functionality reduces the time required to raise diagnostics and fault tickets compared to manual portal entries.
  • Flexible Access: Supports multiple access types including Etherway Fibre (EAD, OSA), Superfast GEA, Radio, and Data Centre Connect.
Ethernet

Help and support

Have questions? 

Explore our Knowledge Centre. Find "how-to" guides to walk you through setup and app creation, visit the troubleshooting section to resolve common errors, and get quick answers in our FAQ.

Knowledge Centre

Unfamiliar with a term?

Our glossary defines the key technical terms and acronyms used across the developer portal.                                                                                                                           

Glossary

Contact us

If you need to contact our support team, use the contact form. 

I need help
Back to top