Quote

Grow your footprint by reviewing Zayo products in our Product Catalog API, generating quotes with our Quoting API, and automating the ordering process through the Order API.

Create or edit quote

Creates a quote using building or location information from the Network Discovery APIs and product code details from the Product Catalog APIs. You can also update an existing quote by passing in the quoteId. Each quote response will include the quote confinguration, estimatedInstallInterval, and pricing for multiple terms within the financialTerms array.

SecurityBearerToken or OAuthClientCredentials
Request
Request Body schema: application/json

Quote request body. This includes 3 major components - attrs array, configuration object, and preferences object. The configuration object will vary based on the product code and version, while the attrs and preferences object will have the same schema for all product codes and versions.

Any of:
object
object
Responses
200

Success

400

Bad Request

post/services/quote-management/v3/quotes/quote
Request samples
application/json
{
  • "configuration": {
    • "nodeId": "C8E0AA1C-D301-462C-A9B7-3CA3B33F5E1C",
    • "productCode": "ETH-ELINE-UNI",
    • "version": "3.2.0",
    • "currencyIsoCode": "USD",
    • "bandwidth": "1G",
    • "burstableService": "No",
    • "qualityOfService": "Off",
    • "mefCertified": "No",
    • "children": [
      • {
        • "productCode": "ETH-ELINE-UNI",
        • "version": "3.2.0",
        • "nodeId": "4620C865-9EED-4E7E-9B1B-789263D692D8",
        • "portHandoffSpeed": "GigE",
        • "handoff": "2-Fiber (Optical MMF)",
        • "networkInterfaceDevice": "Yes",
        • "cfaProvidedBy": "Zayo",
        • "buildingA": "a0W60000000CVbEEAW",
        • "locationA": "a0b6000000A6IzoAAF",
        • "cloudProvider": "Amazon AWS",
        • "connectionType": "Hosted",
        • "nniId": "a0M0z00000OuUB8EAN"
        }
      ]
    },
  • "preferences": {
    • "requestFollowUp": "No",
    • "notes": "These are some notes",
    • "quoteNameIdentifier": "Quote-123"
    }
}
Response samples
application/json
{
  • "apiVersion": "v3",
  • "data": {
    • "configuration": {
      • "children": [
        • {
          • "productCode": "IP-DIA",
          • "version": "3.7.0",
          • "nodeId": "EED0662D-0710-43D2-8539-498496F3B77E",
          • "portHandoffSpeed": "10GigE",
          • "locationA": "a0b60000000W6LjAAK",
          • "connectedIpv4Address": "IPv4/31",
          • "additionalIpv4Addresses": [
            • {
              • "IPv4/31": 0,
              • "IPv4/29": 0,
              • "IPv4/28": 0,
              • "IPv4/27": 0,
              • "IPv4/26": 0,
              • "IPv4/24": 0,
              • "IPv4/30": 0
              }
            ],
          • "additionalIpv6Addresses": [
            • "IPv6/64 IPv6/48"
            ],
          • "routing": "No",
          • "lag": "No",
          • "networkInterfaceDevice": "No",
          • "cfaProvidedBy": "Zayo",
          • "handoff": "2-Fiber (Optical SMF)"
          }
        ],
      • "nodeId": "6DD6BC0E-CE1F-4EAC-8D4A-07DE8F5BF597",
      • "productCode": "IP-DIA",
      • "version": "3.7.0",
      • "ddosProtection": {
        • "ddosProtectionIncluded": false,
        • "cleanTraffic": "None",
        • "subscription": "None"
        },
      • "currencyIsoCode": "USD",
      • "bandwidth": "10G",
      • "burstableService": "No",
      • "bandwidthType": "Standard",
      • "product": "DIA",
      • "productCategory": "DIA",
      • "aggregatedBandwidth": "No",
      • "locations": [
        • {
          • "locationId": "a0b60000000W6LjAAK",
          • "address": "393 Inverness Pkwy Englewood, CO 80112",
          • "floorRoomSuite": "Fl-1/Rm-DC-04",
          • "buildingNetworkStatus": "On Zayo Network",
          • "locationNetworkStatus": "On Zayo Network"
          }
        ]
      },
    • "preferences": [
      • {
        • "requestFollowUp": "No",
        • "notes": "Some notes",
        • "quoteNameIdentifier": "Cutomer identifier, like a PO Number"
        }
      ],
    • "quoteId": "1cd080ac-1d02-4a9d-b7ee-3fe0d4a77d2b",
    • "quoteNumber": "Quote-10900936",
    • "estimatedInstallInterval": "45 days",
    • "financialTerms": [
      • {
        • "term": 12,
        • "totalMrc": 1434.69,
        • "totalNrc": 1100
        },
      • {
        • "term": 24,
        • "totalMrc": 1274.1,
        • "totalNrc": 1100
        },
      • {
        • "term": 36,
        • "totalMrc": 1220.57,
        • "totalNrc": 1100
        },
      • {
        • "term": 48,
        • "totalMrc": 1167.04,
        • "totalNrc": 1100
        },
      • {
        • "term": 60,
        • "totalMrc": 1113.51,
        • "totalNrc": 1100
        }
      ],
    • "lineItems": [ ],
    • "cpqStatus": "Approved"
    }
}

Get quote details

View quote, product configuration, and pricing information by quoteId. Get the same details you'd get from a create quote or edit quote request. You can pass in the quoteId or quoteName param, only one is required to retrieve your quote information.

SecurityBearerToken or OAuthClientCredentials
Request
path Parameters
quoteId
required
string

Either quoteId or quoteName is required. Unique quote identifier returned by the create or edit quote route.

Examples:
4d5c2bdc-473b-47d6-8958-a8028ac35850
Quote-10256816
Responses
200

Success

400

Bad Request

get/services/quote-management/v3/quotes/quote/{quoteId}
Request samples
curl -i -X GET \
  'https://api.zayo.com/services/quote-management/v3/quotes/quote/{quoteId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "apiVersion": "v2",
  • "data": {
    • "configuration": {
      • "children": [
        • {
          • "productCode": "ETH-ELINE-P2P",
          • "version": "3.2.0",
          • "nodeId": "3D4E25D1-7905-488B-90F0-D245B233807C",
          • "portHandoffSpeed": "10GigE",
          • "locationA": "a0b6000000FZkaZAAT",
          • "cfaProvidedBy": "Zayo",
          • "handoff": "2-Fiber (Optical SMF)",
          • "networkInterfaceDevice": "No"
          },
        • {
          • "productCode": "ETH-ELINE-P2P",
          • "version": "3.2.0",
          • "nodeId": "4BB7696F-AF5C-4BA7-9B4A-7D46A1D3F2A1",
          • "portHandoffSpeed": "10GigE",
          • "locationZ": "a0b60000003M8uxAAC",
          • "cfaProvidedBy": "Zayo",
          • "handoff": "2-Fiber (Optical SMF)",
          • "networkInterfaceDevice": "No"
          }
        ],
      • "nodeId": "AE7D188C-A5F0-4109-A944-15E3BB5871B7",
      • "productCode": "ETH-ELINE-P2P",
      • "version": "3.2.0",
      • "currencyIsoCode": "USD",
      • "bandwidth": "5G",
      • "burstableService": "No",
      • "qualityOfService": "Off",
      • "mefCertified": "No",
      • "aggregatedBandwidth": "No",
      • "bandwidthType": "Standard",
      • "product": "ELine",
      • "productCategory": "Point-to-Point",
      • "locations": [
        • {
          • "locationId": "a0b6000000FZkaZAAT",
          • "address": "151 Front St W Toronto, ON M5J 2N1",
          • "floorSuiteRoom": "Fl-1/Rm-MMR 2",
          • "buildingNetworkStatus": "On Zayo Network",
          • "locationNetworkStatus": "On Zayo Network"
          },
        • {
          • "locationId": "a0b60000003M8uxAAC",
          • "address": "3420 Ocean Park Blvd Santa Monica, CA 90405",
          • "floorSuiteRoom": "Fl-1/Rm-OSP Demarc",
          • "buildingNetworkStatus": "On Zayo Network",
          • "locationNetworkStatus": "On Zayo Network"
          }
        ]
      },
    • "preferences": {
      • "requestFollowUp": "No"
      },
    • "quoteId": "629896f7-61d4-4d19-ac6e-ddbcfe3e298b",
    • "quoteNumber": "Quote-10153701",
    • "estimatedInstallInterval": "40 days",
    • "financialTerms": [
      • {
        • "term": "12",
        • "totalMrc": 1541.17,
        • "totalNrc": 859.17
        },
      • {
        • "term": "24",
        • "totalMrc": 1348.52,
        • "totalNrc": 859.17
        },
      • {
        • "term": "36",
        • "totalMrc": 1284.31,
        • "totalNrc": 859.17
        },
      • {
        • "term": "48",
        • "totalMrc": 1220.09,
        • "totalNrc": 859.17
        },
      • {
        • "term": "60",
        • "totalMrc": 1155.88,
        • "totalNrc": 859.17
        }
      ],
    • "lineItems": [ ],
    • "cpqStatus": "Approved"
    }
}

View all NNI records

Retrieve all NNI records including quotes, orders, and services. Used to identify an NNI to associate with your UNI quote via the nniId in the quote request payload. The nniId attribute is optional, so if it is omitted from the quote request, Zayo will always default to the nearest NNI.

SecurityBearerToken or OAuthClientCredentials
Request
Request Body schema: application/json

Optional request body to add a filter on type of record and to add pagination.

object

Object to define filter options.

object

Object to define pagination for the number of records per page, and how many records to skip. Follows odata pagination standards.

Responses
200

Success

400

Bad Request

post/services/quote-management/v2/quotes/nnis
Request samples
application/json
{
  • "filter": {
    • "locationId": "a0b60000003KP8EAAW",
    • "type": [
      • "Service"
      ]
    },
  • "paging": {
    • "top": 50,
    • "skip": 0
    }
}
Response samples
application/json
{
  • "apiVersion": "v2",
  • "data": {
    • "records": [
      • {
        • "nniId": "a0M0z00000PiJ3DEAV",
        • "custNNI": "a1X0z000004aLbmEAE",
        • "type": "Service",
        • "bandwidth": "10G",
        • "circuitId": "ETYX/TEST008/ZYO",
        • "name": 559510,
        • "productCategory": "Pt to Multi-Pt (NNI)",
        • "location": "393 Inverness Pkwy/Fl-1/Rm-DC-04 Englewood, CO 80112",
        • "locationId": "a0b60000000W6LjAAK",
        • "address": "393 Inverness Pkwy",
        • "floor": 1,
        • "suite": null,
        • "room": "DC-04",
        • "state": "CO",
        • "zip": 80112,
        • "city": "Englewood",
        • "country": "USA",
        • "sortBy": 1
        },
      • {
        • "nniId": "a0M0z00000PiJ33EAF",
        • "custNNI": "a1X0z000004aLbcEAE",
        • "type": "Service",
        • "bandwidth": "1G",
        • "circuitId": "ETYX/TEST005/ZYO",
        • "name": 559510,
        • "productCategory": "Pt to Multi-Pt (NNI)",
        • "location": "4100 Bryan St/Fl-1/Rm-LSA 199 Dallas, TX 75204",
        • "locationId": "a0b60000003N9p6AAC",
        • "address": "4100 Bryan St",
        • "floor": 1,
        • "suite": null,
        • "room": "LSA 199",
        • "state": "TX",
        • "zip": 75204,
        • "city": "Dallas",
        • "country": "USA",
        • "sortBy": 1
        }
      ],
    • "metaData": {
      • "top": 2,
      • "skip": 0,
      • "currentPage": 1,
      • "totalPages": 98,
      • "totalRecordCount": 195
      }
    }
}