Retrieve what services (if any) the supplier has available for a given address.
This follows the concepts in TMF645 - Service Qualification API and TMF673 - Address Management API.
Fibre Cafe : Supplier API (1.15)
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 the Fibre Cafe's Tenant API. The network operators and aggregators providing the underlying services are known as 'suppliers' and provide the Supplier API.
Each supplier is responsible for implementing this southbound API specification for the Fibre Cafe to retrieve available services and support appointing and order management.
Note: Order updates (KCIs) must be sent to the Supplier Updates API hosted by the Fibre Cafe. __
© 2022-2026 Strategic Imperatives
Download OpenAPI description
Languages
Servers
https://api.provided_by_supplier.net
Bodyapplication/json
A unique identifier of the quote as provided by the tenant
Example: "QUO-ETH-5001"
The role of the site in an Ethernet connection
Enum"A-END""B-END""MULTI-POINT"
Address identifier for location including type of identifier.
A generic entity to capture the contract details of a product/service.
A generic entity to capture the duration of a contract
The frequency the product/service will be invoiced by the supplier
Enum"MONTHLY""QUARTERLY""ANNUALLY"
Details of a service the supplier provides at the selected address.
- https://api.provided_by_supplier.net/quote
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api.provided_by_supplier.net/quote \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-H 'X-Conversation-ID: string' \
-H 'X-Request-ID: string' \
-d '{
"id": 1,
"externalIdentifier": "QUO-ETH-5001",
"sites": [
{
"name": "Strategic Imperative Offices",
"postcode": "TW184LG",
"role": "A-END",
"address": {
"id": "200004033694",
"type": "UPRN"
},
"siteCharacteristics": [
{
"name": "END_USER_CPE",
"value": "Zyzel DX3301"
}
]
},
{
"name": "Strategic Imperative Offices",
"postcode": "TW184LG",
"role": "A-END",
"address": {
"id": "200004033694",
"type": "UPRN"
},
"siteCharacteristics": [
{
"name": "END_USER_CPE",
"value": "Zyzel DX3301"
}
]
}
],
"contractDetails": {
"contractLength": {
"value": 36,
"unit": "MONTH"
},
"billingFrequency": "MONTHLY",
"priceAlteration": "string"
},
"service": [
{
"serviceSpecification": {
"id": "ftthl2r"
},
"serviceCharacteristic": [
{
"name": "END_USER_CPE",
"value": "Zyzel DX3301"
}
]
}
]
}'Request successful - quote details were returned
Unique identifier to identify request and response events across the Fibre Cafe gateway
One of:
A generic entity to capture the available quote detail response.
A unique identifier of the quote (generated by the Fibre Cafe)
Example: "3456cf7d-4471-42e4-a5be-c24ed58a7aa6"
A unique identifier of the quote as provided by the tenant
Example: "QUO-ETH-5001"
The role of the site in an Ethernet connection
Enum"A-END""B-END""MULTI-POINT"
Address identifier for location including type of identifier.
A generic entity to capture the contract details of a product/service.
A generic entity to capture the duration of a contract
The frequency the product/service will be invoiced by the supplier
Enum"MONTHLY""QUARTERLY""ANNUALLY"
Details of a service the supplier provides at the selected address.
A unique identifier generated by the supplier for the quote item within the overall quote entity, as provided by the supplier
Example: "SUPP2-QUO-ETH-5001"
Set to true if the quote provided is considered an advisory quote or estimate and final quote provided as part of the order process.
Example: false
Date/time when the quote was created
Example: "2022-01-01T09:09:33.001Z"
Date/time the quote remains valid
Example: "2022-01-01T09:45:39.001Z"
The price of the quote as provided by the supplier for a product/service.
The product or add-on the price relates to, as defined by the supplier
The location the product is served from, as defined by the supplier. Only provided if it impacts price.
The period the price applies
Enum"ONCE""DAILY""WEEKLY""MONTHLY""QUARTERLY""ANNUALLY"
Response
application/json
{ "id": "3456cf7d-4471-42e4-a5be-c24ed58a7aa6", "externalIdentifier": "QUO-ETH-5001", "sites": [ { … }, { … } ], "contractDetails": { "contractLength": { … }, "billingFrequency": "MONTHLY", "priceAlteration": "string" }, "service": [ { … } ], "supplierQuoteId": "SUPP2-QUO-ETH-5001", "estimate": false, "created": "2022-01-01T09:09:33.001Z", "validFor": "2022-01-01T09:45:39.001Z", "quotePrices": [ { … } ] }