Zayo API Developer Portal logo

API Developer Portal

Open Search

Order

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.

Get order contacts

Returns order contact information per billing account for a specified quote. Use the id returned in the billingAccounts array, id returned in the signers array, and id returned in the primary array in the following respective fields in the order request payload - billingAccountId, primaryContactId, and contractSignerId. You use either the quoteId or quoteName path param, only one is required to retrieve your order information.

Please Note: At the moment, only quoteId is accepted in the order request payload.

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/order-management/v2/orders/contacts/{quoteId}
Request samples
curl -i -X GET \
  'https://api.zayo.com/services/order-management/v2/orders/contacts/{quoteId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "apiVersion": "v2",
  • "data": {
    • "quoteId": "0b85fdf6-f462-47b9-8bf3-7996f4f2db9a",
    • "currencyIsoCode": "USD",
    • "billingAccounts": [
      • {
        • "id": "0010z00001RkkUVAAZ",
        • "billingAccountNumber": "1-TrazDemo",
        • "currencyIsoCode": "USD",
        • "name": "Mordor Forging - Trial Account",
        • "signers": [
          • {
            • "id": "0030z00002OamyHAAR",
            • "firstName": "Hannah",
            • "lastName": "Wanderer"
            },
          • {
            • "id": "0030z00002V068qAAB",
            • "firstName": "Leidy",
            • "lastName": "Perez"
            }
          ],
        • "primary": [
          • {
            • "id": "0030z00002OamyHAAR",
            • "firstName": "Hannah",
            • "lastName": "Wanderer"
            }
          ]
        },
      • {
        • "id": "0010z00001RmCjJAAV",
        • "billingAccountNumber": "31857",
        • "currencyIsoCode": "USD",
        • "name": "Enterprise Networks Demo Test Account",
        • "signers": [
          • {
            • "id": "0030z00002UxqhqAAB",
            • "firstName": "Randall",
            • "lastName": "Holman"
            }
          ],
        • "primary": [
          • {
            • "id": "0030z00002UxqhqAAB",
            • "firstName": "Randall",
            • "lastName": "Holman"
            },
          • {
            • "id": "0030z00002RTQwMAAX",
            • "firstName": "Devon",
            • "lastName": "Holt"
            }
          ]
        }
      ]
    }
}

Submit order

Order a quote. Creates a job to be completed in the background that creates the New Order and saves the result as a jobId for lookup. Since this is a time-consuming task for Zayo, this route will trigger a job that will create an order directly in Zayo's ordering system. The response is a jobId, and you will follow up on the request via the job/{jobId} route to get the Order details.

Pre-requisite APIs include quotes route (alternativly have your account rep provide this value) and the contacts route to get your billing account and order contact information. SOF signature is still required after the order is placed. Certain orders are eligible for digital signature.

Please Note: At the moment, only quoteId is accepted in the order request payload.

SecurityBearerToken or OAuthClientCredentials
Request
Request Body schema: application/json

Order request body. Prequisites include having a quoteId or quoteName from the quotes/quote route as well as billingAccountId, primaryContactId, and contractSignerId from the /orders/contacts/{quoteId} route.

quoteId
required
string <uuid>

Unique quote identifier returned by quotes/quote route.

required
integer or string

Term of the order, pricing per term is provided from the create or edit quote route.

billingAccountId
required
string = 18 characters

Unique identifier to designate the billing account to be billed for the Order. This value is returned in the /orders/contacts/{quoteId}.

primaryContactId
required
string = 18 characters

Unique identifier to designate the contact responsible for general support for the Order. This value is returned in the /orders/contacts/{quoteId}.

contractSignerId
required
string = 18 characters

Unique identifier to designate the contact responsible for signing the contract for the Order. This value is returned in the /orders/contacts/{quoteId}.

notes
string <= 4000 characters

Any additional notes you'd like to specify on the Order.

poNumber
string <= 40 characters

Optional field to store purchase order number.

boolean or string

Represents the user has read the related Master Service Agreement related to the Order. At this time we do not support sending these documents via API and must be coordinated with your account representative. This field must be set to True in order to submit an order for auto-provisioning.

boolean or string

Represents the user has read the related Service Schedule related to the Order. At this time we do not support sending these documents via API and must be coordinated with your account representative. This field must be set to True in order to submit an order for auto-provisioning.

boolean or string

Represents a digital version of the user’s signature agreeing to the terms and conditions presented in the related MSA and Service Schedule. This field must be set to True (and is required when msaRead = True, serviceScheduleRead = True) in order to submit an order for auto-provisioning.

Array of objects
Responses
200

Success

400

Bad Request

post/services/order-management/v2/orders/order
Request samples
application/json
{
  • "quoteId": "826e5192-f8c6-4e24-aab3-3910e46c52b7",
  • "term": 12,
  • "billingAccountId": "0014z00001d89HqAAI",
  • "primaryContactId": "0030z00002YnGLRAA3",
  • "contractSignerId": "0030z00002YnGLRAA3",
  • "notes": "These are some notes",
  • "poNumber": "Zayo-12345",
  • "msaRead": true,
  • "serviceScheduleRead": true,
  • "digitalSignature": true,
  • "provisioningDetails": [
    • {
      • "cloudProvider": "Amazon AWS",
      • "accountId": "529554258215",
      • "sTagVlanId": "101",
      • "cTagVlanId": "232"
      }
    ]
}
Response samples
application/json
{
  • "apiVersion": "v2",
  • "data": {
    • "jobId": "a0e5a907-0851-47f2-8870-e58e565061f3"
    }
}

Get job details

Returns job status. Once the job is finished processing it will return order details. The order job typically finishes processing within 30 seconds. The order details include a similar schema as the quote response in addition to the serviceOrderNumber attribute.

SecurityBearerToken or OAuthClientCredentials
Request
path Parameters
jobId
required
string <uuid>

Unique order job identifier returned by submit order route.

Example: a0e5a907-0851-47f2-8870-e58e565061f3
Responses
200

Success

400

Bad Request

get/services/order-management/v2/job/{jobId}
Request samples
curl -i -X GET \
  'https://api.zayo.com/services/order-management/v2/job/{jobId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "apiVersion": "v2",
  • "data": {
    • "status": "processing",
    • "result": null
    }
}