Return a quote for available services for a given address.

post/quote

This endpoint can be called to generate a quote for advanced services, such as Ethernet. The details of the individual supplier or list of suppliers must be specified in the request.

Request
header Parameters
X-Request-ID
required
string

Unique identifier to link request and response events across the gateway

X-Conversation-ID
required
string

Identifier to track message journey across the gateway

Request Body schema: application/json
id
required
integer >= 1

A unique identifier of the quote (generated by the Fibre Cafe)

externalIdentifier
string [ 0 .. 64 ] characters

A unique identifier of the quote as provided by the tenant

required
Array of objects (Site) >= 2 items
required
object (ContractItem)

A generic entity to capture the contract details of a product/service.

required
Array of objects (Service) non-empty
Responses
201

Request successful - quote details were returned

400

Bad request - supplied request was malformed or missing mandatory parameters

401

Unauthorised access

403

The client is not permitted to access this resource.

422

Unprocessable entity - invalid data was provided

500

Unexpected Fibre Gateway error

503

Fibre Gateway is temporarily unavailable

Request samples
application/json
{
  • "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"
          }
        ]
      }
    ]
}
Response samples
application/json
{
  • "id": "3456cf7d-4471-42e4-a5be-c24ed58a7aa6",
  • "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",
        • "name": "FTTH"
        },
      • "serviceCharacteristic": [
        • {
          • "name": "END_USER_CPE",
          • "value": "Zyzel DX3301"
          }
        ]
      }
    ],
  • "supplierQuoteId": "SUPP2-QUO-ETH-5001",
  • "estimate": false,
  • "created": "2022-01-01T09:09:33.001Z",
  • "validFor": "2022-01-01T09:45:39.001Z",
  • "quotePrices": [
    • {
      • "product": "string",
      • "productLocation": "string",
      • "priceType": "ONE_OFF",
      • "pricePeriod": "ONCE",
      • "price": {
        • "value": 25,
        • "unit": "GBP"
        },
      • "description": "string"
      }
    ]
}