The Fibre Cafe is a scalable, unified platform to support L2C provisioning, in-life modification/cease and T2R trouble resolution between communication providers (CP) and network operators or aggregators.
CPs are known as 'tenants' on the Fibre Cafe and communicate with this API - the Fibre Cafe's Tenant API. The network operators and aggregators providing the underlying services are known as 'suppliers'.
The Fibre Cafe will route requests from this API to appropriate supplier(s). Tenants will be configured to use suppliers based on requirements and commercial agreements.
Initial availability and appointing requests are synchronous. Ordering requests are asynchronous with confirmation and updates via KCIs (Keep Customer Informed).
Note: Order updates (KCIs) will be sent to the Tenant Updates API which the tenant must implement. __
© 2022-2026 Strategic Imperatives
Used to look up address identifiers and details for a given postal code or UPRN.
This is not implemented by all suppliers - it is primarily provided to assist with NAD/District Code lookup for suppliers operating on the Openreach network.
This follows the concepts in TMF673 - Address Management API.
This endpoint can be called to place a order with a supplier to provide, cease or modify a service.
The Fibre Cafe will validate the request and generate an order number which is returned. If the order is rejected immediately then a 400 code will be returned with reason(s) for the rejection in the response.
The order will then be sent to the supplier for processing and further updates will be sent via KCIs - this could include a rejection if the order does not meet supplier validation/processing rules. Once the order is acknowledged, the supplier may assign their own order number which will be returned in the KCI.
Represents an order for new service(s) at a particular address.
The type of order - new, (re)start, takeover, transfer or swap
System identifier for a supplier on the Fibre Cafe that is associated with this order
Address identifier for location including type of identifier.
Address identifier of given type
Type of address identifier e.g. UPRN, NAD, DistrictCode, ROBT
Order for a service that the supplier provides at the selected address.
Details of a service the supplier provides at the selected address.
List of service characteristics for the service order item - e.g. for FTTH service
Represents a contact available at the given address.
Contact email address (if available)
Unique identifier for the reserved appointment (if applicable)
Where not appointed, allows a date to be requested for the service activation.
Engineer tasks to be performed at installation appointment.
Hazard information about the site where the service will be installed
Information about restrictions on the site where the service will be installed
curl -i -X POST \
https://prod.fibregateway.com/v1/service-orders \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-H 'X-Conversation-ID: string' \
-H 'X-Request-ID: string' \
-d '{
"orderType": "NEW",
"supplier": "DUMMY_SUPPLIER",
"address": {
"id": "A00000031882",
"type": "NAD",
"additionalIdentifiers": [
{
"id": "A00000031882",
"type": "NAD"
}
]
},
"serviceOrderItem": {
"serviceSpecification": {
"id": "ftthl2r"
},
"serviceCharacteristics": [
{
"name": "LINE_PROFILE",
"value": "1G1G"
}
]
},
"primaryContact": {
"name": "John Smith",
"email": "john@smith.com",
"phoneNumber": "01234 567890"
},
"secondaryContact": {
"name": "John Smith",
"email": "john@smith.com",
"phoneNumber": "01234 567890"
},
"appointmentReservationId": 345,
"requestedCompletionDate": "2022-01-10",
"engineerTasks": [
"TEST_SINGLE_DEVICE"
],
"hazards": "Hazardous materials stored on site",
"onSiteRestrictions": "Restricted access",
"notes": "Lorem ipsum dolor sit amet..."
}'Order was received by the gateway and will be acknowledged later via a KCI
Unique identifier to identify request and response events across the Fibre Cafe gateway
Represents an order for new service(s) at a particular address.
Unique reference identifying this service order (order number - generated by Fibre Cafe)
Order lifecycle adapted from TMF641 - order update events (KCIs) will be sent to the tenant as the order transitions from one state to the other.
Order reference generated by the supplier once acknowledged (for information only)
Appointment reference generated by the supplier for a re-appointed timeslot (only returned if applicable)
Represents a re-appointed timeslot from the supplier (only returned if applicable)
Date/time when the order was last updated
Order updates (KCIs) received about the order
When the supplier first commits to fulfil the order this field will contain the expected completion date. Once set, this value will not change unless driven by the tenant/customer.
The current expected completion date - set once the order is committed. This can be different to the committedDate if the order has been delayed for any reason, and can change possibly multiple times.
The type of order - new, (re)start, takeover, transfer or swap
System identifier for a supplier on the Fibre Cafe that is associated with this order
Address identifier for location including type of identifier.
Address identifier of given type
Type of address identifier e.g. UPRN, NAD, DistrictCode, ROBT
Order for a service that the supplier provides at the selected address.
Details of a service the supplier provides at the selected address.
List of service characteristics for the service order item - e.g. for FTTH service
Represents a contact available at the given address.
Contact email address (if available)
Unique identifier for the reserved appointment (if applicable)
Where not appointed, allows a date to be requested for the service activation.
Engineer tasks to be performed at installation appointment.
Hazard information about the site where the service will be installed
Information about restrictions on the site where the service will be installed
{ "id": 123, "status": "ACKNOWLEDGED", "supplierOrderNumber": "A123X", "appointmentSupplierReference": "123456543", "appointmentTimeslot": { "timeslotStartDateTime": "2022-01-10T09:00:00.000Z", "timeslotEndDateTime": "2022-01-10T13:00:00.000Z", "classification": "SATURDAY_AM", "standard": true }, "created": "2022-01-01T09:09:33.001Z", "updated": "2022-01-01T09:45:39.001Z", "updates": [ { … } ], "committedDate": "2022-01-01T09:09:33.001Z", "targetDate": "2022-01-01T09:09:33.001Z", "orderType": "NEW", "supplier": "DUMMY_SUPPLIER", "address": { "id": "A00000031882", "type": "NAD", "additionalIdentifiers": [ … ] }, "serviceOrderItem": { "serviceSpecification": { … }, "serviceCharacteristics": [ … ] }, "primaryContact": { "name": "John Smith", "email": "john@smith.com", "phoneNumber": "01234 567890" }, "secondaryContact": { "name": "John Smith", "email": "john@smith.com", "phoneNumber": "01234 567890" }, "appointmentReservationId": 345, "requestedCompletionDate": "2022-01-10", "engineerTasks": [ "TEST_SINGLE_DEVICE" ], "hazards": "Hazardous materials stored on site", "onSiteRestrictions": "Restricted access", "notes": "Lorem ipsum dolor sit amet..." }
curl -i -X GET \
'https://prod.fibregateway.com/v1/service-orders/{id}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'X-Conversation-ID: string' \
-H 'X-Request-ID: string'Request successful - order details were returned
Unique identifier to identify request and response events across the Fibre Cafe gateway
Represents an order for new service(s) at a particular address.
Unique reference identifying this service order (order number - generated by Fibre Cafe)
Order lifecycle adapted from TMF641 - order update events (KCIs) will be sent to the tenant as the order transitions from one state to the other.
Order reference generated by the supplier once acknowledged (for information only)
Appointment reference generated by the supplier for a re-appointed timeslot (only returned if applicable)
Represents a re-appointed timeslot from the supplier (only returned if applicable)
Date/time when the order was last updated
Order updates (KCIs) received about the order
When the supplier first commits to fulfil the order this field will contain the expected completion date. Once set, this value will not change unless driven by the tenant/customer.
The current expected completion date - set once the order is committed. This can be different to the committedDate if the order has been delayed for any reason, and can change possibly multiple times.
The type of order - new, (re)start, takeover, transfer or swap
System identifier for a supplier on the Fibre Cafe that is associated with this order
Address identifier for location including type of identifier.
Address identifier of given type
Type of address identifier e.g. UPRN, NAD, DistrictCode, ROBT
Order for a service that the supplier provides at the selected address.
Details of a service the supplier provides at the selected address.
List of service characteristics for the service order item - e.g. for FTTH service
Represents a contact available at the given address.
Contact email address (if available)
Unique identifier for the reserved appointment (if applicable)
Where not appointed, allows a date to be requested for the service activation.
Engineer tasks to be performed at installation appointment.
Hazard information about the site where the service will be installed
Information about restrictions on the site where the service will be installed
{ "id": 123, "status": "ACKNOWLEDGED", "supplierOrderNumber": "A123X", "appointmentSupplierReference": "123456543", "appointmentTimeslot": { "timeslotStartDateTime": "2022-01-10T09:00:00.000Z", "timeslotEndDateTime": "2022-01-10T13:00:00.000Z", "classification": "SATURDAY_AM", "standard": true }, "created": "2022-01-01T09:09:33.001Z", "updated": "2022-01-01T09:45:39.001Z", "updates": [ { … } ], "committedDate": "2022-01-01T09:09:33.001Z", "targetDate": "2022-01-01T09:09:33.001Z", "orderType": "NEW", "supplier": "DUMMY_SUPPLIER", "address": { "id": "A00000031882", "type": "NAD", "additionalIdentifiers": [ … ] }, "serviceOrderItem": { "serviceSpecification": { … }, "serviceCharacteristics": [ … ] }, "primaryContact": { "name": "John Smith", "email": "john@smith.com", "phoneNumber": "01234 567890" }, "secondaryContact": { "name": "John Smith", "email": "john@smith.com", "phoneNumber": "01234 567890" }, "appointmentReservationId": 345, "requestedCompletionDate": "2022-01-10", "engineerTasks": [ "TEST_SINGLE_DEVICE" ], "hazards": "Hazardous materials stored on site", "onSiteRestrictions": "Restricted access", "notes": "Lorem ipsum dolor sit amet..." }
This endpoint is called to request amendment(s) to an existing inflight order to provision, modify or cease a service.
The Fibre Cafe will validate the request and generate an amendment reference which is returned. If the order amendment is rejected immediately then a 400 code will be returned with reason(s) for the rejection in the response.
The order amendment will then be sent to the supplier for processing and further updates will be sent via KCIs - this could include a rejection if the amendment does not meet supplier validation/processing rules.
Represents a request to amend an existing inflight service provide order. Any value(s) supplied will replace the existing value(s).
System identifier for a supplier on the Fibre Cafe that is associated with this order
List of service characteristics for the service order item
Unique identifier for the reserved appointment (if applicable)
Where not appointed, allows a date to be requested for the service activation
Engineer tasks to be performed at installation appointment.
Hazard information about the site where the service will be installed
Information about restrictions on the site where the service(s) will be installed
curl -i -X POST \
https://prod.fibregateway.com/v1/service-order-amendments \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-H 'X-Conversation-ID: string' \
-H 'X-Request-ID: string' \
-d '{
"orderId": 123,
"supplier": "DUMMY_SUPPLIER",
"serviceCharacteristics": [
{
"name": "LINE_PROFILE",
"value": "1G1G"
}
],
"primaryContact": {
"name": "John Smith",
"email": "john@smith.com",
"phoneNumber": "01234 567890"
},
"secondaryContact": {
"name": "John Smith",
"email": "john@smith.com",
"phoneNumber": "01234 567890"
},
"appointmentReservationId": 345,
"requestedCompletionDate": "2022-01-10",
"engineerTasks": [
"TEST_SINGLE_DEVICE"
],
"hazards": "string",
"onSiteRestrictions": "string",
"notes": "Lorem ipsum dolor sit amet..."
}'Order amendment request has been received and will be confirmed or rejected later by a KCI
Unique identifier to identify request and response events across the Fibre Cafe gateway
Represents a request to amend an existing inflight service provide order. Any value(s) supplied will replace the existing value(s).
Unique identifier for this provide service order amendment request (generated by the Fibre Cafe)
Supplier reference for this amendment request (if available - for information only)
State model for amendment and cancellation requests.
System identifier for a supplier on the Fibre Cafe that is associated with this order
List of service characteristics for the service order item
Unique identifier for the reserved appointment (if applicable)
Where not appointed, allows a date to be requested for the service activation
Engineer tasks to be performed at installation appointment.
Hazard information about the site where the service will be installed
Information about restrictions on the site where the service(s) will be installed
{ "id": 234, "supplierReference": "A123X-1", "status": "REJECTED", "orderId": 123, "supplier": "DUMMY_SUPPLIER", "serviceCharacteristics": [ { … } ], "primaryContact": { "name": "John Smith", "email": "john@smith.com", "phoneNumber": "01234 567890" }, "secondaryContact": { "name": "John Smith", "email": "john@smith.com", "phoneNumber": "01234 567890" }, "appointmentReservationId": 345, "requestedCompletionDate": "2022-01-10", "engineerTasks": [ "TEST_SINGLE_DEVICE" ], "hazards": "string", "onSiteRestrictions": "string", "notes": "Lorem ipsum dolor sit amet..." }
This endpoint is called to request cancellation of an existing inflight order to provision, modify or cease a service.
The Fibre Cafe will validate the request and generate a unique ID which is returned. If the order cancellation is rejected immediately then a 400 code will be returned with reason(s) for the rejection in the response.
The order cancellation will then be sent to the supplier for processing and further updates will be sent via KCIs - this could include a rejection if the cancellation does not meet supplier validation/processing rules.
System identifier for a supplier on the Fibre Cafe that is associated with this order
Unique reference identifying the service order to be cancelled
Codes representing reason for cancellation:
Reason codes for cancellation other (unsolicited cease):
curl -i -X POST \
https://prod.fibregateway.com/v1/service-order-cancellations \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-H 'X-Conversation-ID: string' \
-H 'X-Request-ID: string' \
-d '{
"supplier": "DUMMY_SUPPLIER",
"orderId": 123,
"reasonCode": "CUSTOMER_CHANGED_MIND",
"text": "Delivery too long"
}'Order cancellation request has been received and will be confirmed or rejected later by a KCI
Unique identifier to identify request and response events across the Fibre Cafe gateway
Unique identifier for this service order cancellation request (generated by the Fibre Cafe)
Supplier reference for this cancellation request (if available - for information only)
State model for amendment and cancellation requests.
System identifier for a supplier on the Fibre Cafe that is associated with this order
Unique reference identifying the service order to be cancelled
Codes representing reason for cancellation:
Reason codes for cancellation other (unsolicited cease):
{ "id": 234, "supplierReference": "A123X-1", "status": "REJECTED", "supplier": "DUMMY_SUPPLIER", "orderId": 123, "reasonCode": "CUSTOMER_CHANGED_MIND", "text": "Delivery too long" }
This endpoint can be called to place an ethernet order with a supplier - currently only provide is supported with cease and modify coming soon.
The Fibre Cafe will validate the request and generate an order number which is returned. If the order is rejected immediately then a 400 code will be returned with reason(s) for the rejection in the response.
The ethernet order will then be sent to the supplier for processing and further updates will be sent via KCIs - this could include a rejection if the order does not meet supplier validation/processing rules. Once the order is acknowledged, the supplier may assign their own order number which will be returned in the KCI.
curl -i -X POST \
https://prod.fibregateway.com/v1/ethernet/service-orders \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-H 'X-Conversation-ID: string' \
-H 'X-Request-ID: string' \
-d '{
"supplier": "SUPPLIER2",
"supplierQuoteId": "SUPP2-QUO-ETH-5001",
"siteInformation": [
{
"name": "Strategic Imperative Offices",
"address": {
"id": "A00000031882",
"type": "NAD",
"additionalIdentifiers": [
{
"id": "A00000031882",
"type": "NAD"
}
]
},
"postcode": "TW184LG",
"role": "A-END",
"siteCharacteristics": [
{
"name": "POINT_OF_INTERCONNECT",
"value": "1G1G"
}
],
"wayleave": {
"wayleaveOwner": true,
"wayleaveCharacteristics": [
{
"name": "POINT_OF_INTERCONNECT",
"value": "1G1G"
}
],
"wayleaveContact": {
"name": "John Smith",
"email": "john@smith.com",
"phoneNumber": "01234 567890"
}
},
"primaryContact": {
"name": "John Smith",
"email": "john@smith.com",
"phoneNumber": "01234 567890"
},
"secondaryContact": {
"name": "John Smith",
"email": "john@smith.com",
"phoneNumber": "01234 567890"
},
"hazards": "Hazardous materials stored on site",
"onSiteRestrictions": "Restricted access",
"notes": "Lorem ipsum dolor sit amet..."
},
{
"name": "Strategic Imperative Offices",
"address": {
"id": "A00000031882",
"type": "NAD",
"additionalIdentifiers": [
{
"id": "A00000031882",
"type": "NAD"
}
]
},
"postcode": "TW184LG",
"role": "A-END",
"siteCharacteristics": [
{
"name": "POINT_OF_INTERCONNECT",
"value": "1G1G"
}
],
"wayleave": {
"wayleaveOwner": true,
"wayleaveCharacteristics": [
{
"name": "POINT_OF_INTERCONNECT",
"value": "1G1G"
}
],
"wayleaveContact": {
"name": "John Smith",
"email": "john@smith.com",
"phoneNumber": "01234 567890"
}
},
"primaryContact": {
"name": "John Smith",
"email": "john@smith.com",
"phoneNumber": "01234 567890"
},
"secondaryContact": {
"name": "John Smith",
"email": "john@smith.com",
"phoneNumber": "01234 567890"
},
"hazards": "Hazardous materials stored on site",
"onSiteRestrictions": "Restricted access",
"notes": "Lorem ipsum dolor sit amet..."
}
],
"ethernetOrderItems": [
{
"service": {
"serviceSpecification": {
"id": "ftthl2r"
},
"serviceCharacteristic": [
{
"name": "POINT_OF_INTERCONNECT",
"value": "1G1G"
}
]
},
"contractDetails": {
"contractLength": {
"value": 36,
"unit": "MONTH"
},
"billingFrequency": "MONTHLY",
"priceAlteration": "string"
},
"requestedCompletionDate": "2022-01-10",
"technicalContact": {
"name": "John Smith",
"email": "john@smith.com",
"phoneNumber": "01234 567890"
}
}
]
}'{ "id": 123, "status": "ACKNOWLEDGED", "supplierOrderNumber": "A123X", "created": "2022-01-01T09:09:33.001Z", "updated": "2022-01-01T09:45:39.001Z", "updates": [ { … } ], "committedDate": "2022-01-01T09:09:33.001Z", "targetDate": "2022-01-01T09:09:33.001Z", "supplier": "SUPPLIER2", "supplierQuoteId": "SUPP2-QUO-ETH-5001", "siteInformation": [ { … }, { … } ], "ethernetOrderItems": [ { … } ] }
curl -i -X GET \
'https://prod.fibregateway.com/v1/ethernet/service-orders/{id}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'X-Conversation-ID: string' \
-H 'X-Request-ID: string'{ "id": 123, "status": "ACKNOWLEDGED", "supplierOrderNumber": "A123X", "created": "2022-01-01T09:09:33.001Z", "updated": "2022-01-01T09:45:39.001Z", "updates": [ { … } ], "committedDate": "2022-01-01T09:09:33.001Z", "targetDate": "2022-01-01T09:09:33.001Z", "supplier": "SUPPLIER2", "supplierQuoteId": "SUPP2-QUO-ETH-5001", "siteInformation": [ { … }, { … } ], "ethernetOrderItems": [ { … } ] }