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.

Securityoauth2
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
externalIdentifier
required
string [ 0 .. 64 ] characters

A unique identifier of the quote request, as provided by the tenant

required
Array of objects (CreateQuoteItem) 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
{
  • "externalIdentifier": "QUO-ETH-5001",
  • "quoteItems": [
    • {
      • "id": 1,
      • "supplier": "SUPPLIER2",
      • "sites": [
        • {
          • "name": "Strategic Imperative Offices",
          • "address": {
            • "id": "A00000031882",
            • "type": "NAD",
            • "additionalIdentifiers": [
              • {
                • "id": null,
                • "type": null
                }
              ]
            },
          • "postcode": "TW184LG",
          • "role": "A-END",
          • "siteCharacteristics": [
            • {
              • "name": "POINT_OF_INTERCONNECT",
              • "value": "1G1G"
              }
            ]
          },
        • {
          • "name": "Strategic Imperative Offices",
          • "address": {
            • "id": "A00000031882",
            • "type": "NAD",
            • "additionalIdentifiers": [
              • {
                • "id": null,
                • "type": null
                }
              ]
            },
          • "postcode": "TW184LG",
          • "role": "A-END",
          • "siteCharacteristics": [
            • {
              • "name": "POINT_OF_INTERCONNECT",
              • "value": "1G1G"
              }
            ]
          }
        ],
      • "contractDetails": {
        • "contractLength": {
          • "value": 36,
          • "unit": "MONTH"
          },
        • "billingFrequency": "MONTHLY",
        • "priceAlteration": "string"
        },
      • "service": [
        • {
          • "serviceSpecification": {
            • "id": "ftthl2r"
            },
          • "serviceCharacteristic": [
            • {
              • "name": "POINT_OF_INTERCONNECT",
              • "value": "1G1G"
              }
            ]
          }
        ]
      }
    ]
}
Response samples
application/json
{
  • "id": "3456cf7d-4471-42e4-a5be-c24ed58a7aa6",
  • "created": "2022-01-01T09:09:33.001Z",
  • "externalId": "QUO-ETH-5001",
  • "quoteItems": [
    • {
      • "id": 1,
      • "supplier": "SUPPLIER2",
      • "sites": [
        • {
          • "name": "Strategic Imperative Offices",
          • "address": {
            • "id": "A00000031882",
            • "type": "NAD",
            • "additionalIdentifiers": [
              • {
                • "id": null,
                • "type": null
                }
              ]
            },
          • "postcode": "TW184LG",
          • "role": "A-END",
          • "siteCharacteristics": [
            • {
              • "name": "POINT_OF_INTERCONNECT",
              • "value": "1G1G"
              }
            ]
          },
        • {
          • "name": "Strategic Imperative Offices",
          • "address": {
            • "id": "A00000031882",
            • "type": "NAD",
            • "additionalIdentifiers": [
              • {
                • "id": null,
                • "type": null
                }
              ]
            },
          • "postcode": "TW184LG",
          • "role": "A-END",
          • "siteCharacteristics": [
            • {
              • "name": "POINT_OF_INTERCONNECT",
              • "value": "1G1G"
              }
            ]
          }
        ],
      • "contractDetails": {
        • "contractLength": {
          • "value": 36,
          • "unit": "MONTH"
          },
        • "billingFrequency": "MONTHLY",
        • "priceAlteration": "string"
        },
      • "service": [
        • {
          • "serviceSpecification": {
            • "id": "ftthl2r",
            • "name": "FTTH"
            },
          • "serviceCharacteristic": [
            • {
              • "name": "POINT_OF_INTERCONNECT",
              • "value": "1G1G"
              }
            ]
          }
        ],
      • "supplierQuoteId": "SUPP2-QUO-ETH-5001",
      • "estimate": false,
      • "validFor": "2022-01-01T09:45:39.001Z",
      • "quotePrices": [
        • {
          • "product": "string",
          • "productLocation": "string",
          • "priceType": "ONE_OFF",
          • "pricePeriod": "ONCE",
          • "price": {
            • "value": 25,
            • "unit": "GBP"
            },
          • "description": "string"
          }
        ]
      }
    ]
}