Skip to main content
API docs by Redocly

Quote APIs (2.0)

Download OpenAPI specification:Download

URL: https://docs.equinix.com/api-support.htm Terms of Service

Quote API allow users to retrieve detailed information about their Equinix quote. Users can use this API to get line level product and service pricing. In additional, users can also obtain important information such as quote expiry date and terms of use. Note that only quotes from the past 12 months will be returned.

Quote

Quote

Retrieve a quote

This method retrieves a specific quote by its ID for a user with appropriate viewing permission.

Authorizations:
BearerAuth
path Parameters
quoteId
required
string [ 1 .. 100 ]

Identifier of the quote

query Parameters
ibxs
Array of strings
Example: ibxs=SG1

List of IBXs to be filtered

Responses

Response Schema: application/json
quoteId
string

Equinix quote ID.

accountName
string

Customer account name

accountNumber
string

Customer account number

quoteRequestType
string
Enum: "NEW" "AMENDMENT" "PAPERWORK" "REPLACEMENT_RENEWAL" "TERMINATION" "MIGRATION"

The request type of the quote

Array of objects (Contacts)

The related party(ies) that are associated to the quote.

Array
registeredUser
string

Username of a registered user.

firstName
string

First name of the contact.

lastName
string

Last name of the contact.

type
string
Enum: "QUOTATION" "SUPPLIER"

contact type

Array of objects (ContactsDetails)

Reference of the related party, could be a party reference or a party role reference

status
string
Enum: "SUBMITTED" "APPROVED"

The current status of the quote

createdDateTime
string <date-time>

The quote created date and time in UTC timezone.

updatedDateTime
string <date-time>

The quote updated date and time in UTC timezone.

expirationDateTime
string <date-time>

The quote expiration date and time in UTC timezone. Quote will be invalid when expirationDateTime has passed.

channel
string
Enum: "PORTAL" "OFFLINE"

The channel which quote was being requested.

subChannel
string
Value: "QUOTE"

The sub-channel which quote was being requested.

customerReferenceId
string

Customer Reference Number / External Reference Number

agreementNumber
string

Quote agreement number

currencyCode
string
Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BOV" "BRL" "BSD" "BTN" "BWP" "BYN" "BZD" "CAD" "CDF" "CHE" "CHF" "CHW" "CLF" "CLP" "CNY" "COP" "COU" "CRC" "CUC" "CUP" "CVE" "CZK" "DJF" "DKK" "DOP" "DZD" "EGP" "ERN" "ETB" "EUR" "FJD" "FKP" "GBP" "GEL" "GHS" "GIP" "GMD" "GNF" "GTQ" "GYD" "HKD" "HNL" "HRK" "HTG" "HUF" "IDR" "ILS" "INR" "IQD" "IRR" "ISK" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MRU" "MUR" "MVR" "MWK" "MXN" "MXV" "MYR" "MZN" "NAD" "NGN" "NIO" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "RWF" "SAR" "SBD" "SCR" "SDG" "SEK" "SGD" "SHP" "SLL" "SOS" "SRD" "SSP" "STN" "SVC" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TOP" "TRY" "TTD" "TWD" "TZS" "UAH" "UGX" "USD" "USN" "UYI" "UYU" "UYW" "UZS" "VES" "VND" "VUV" "WST" "XAF" "XAG" "XAU" "XBA" "XBB" "XBC" "XBD" "XCD" "XDR" "XOF" "XPD" "XPF" "XPT" "XSU" "XTS" "XUA" "XXX" "YER" "ZAR" "ZMW" "ZWL"

The quote currency code in ISO-4217 format

Array of objects (termsOfUse_Details)

Terms and conditions of quote such as initial term, renewal period and non-renewal notice.

Array
value
integer

Denotes the value of period

period
string
Enum: "MONTHS" "DAYS"

Denotes the period type

type
string
Enum: "INITIAL_TERM" "RENEWAL_TERM" "NON_RENEWAL_NOTICE"

Type of quote terms

Array of objects (Pricing Details)

Pricing details of grand total price

Array
value
number

To be used with valueType and type. Can be used to denote price or discount for an order or service

valueType
string
Enum: "ABSOLUTE" "PERCENTAGE"

To indicate if value is of absolute or percentage value. i.e Use ABSOLUTE for $50 or PERCENTAGE for 50%

type
string
Enum: "ONE_TIME_CHARGE" "MONTHLY_CHARGE" "MONTHLY_DISCOUNT" "ONE_TIME_DISCOUNT" "NET_MONTHLY_CHARGE" "NET_ONE_TIME_CHARGE" "TAX"

To indicate the type of value and `valueType.

versionNumber
string

Version number will be updated when quote is revised

Array of objects (quote_details)

Quote details of line items

Array
lineId
string

Unique identifier associated with line item.

parentLineId
string

Unique identifier associated with lineId to denote hierarchy of the product. When this field is null, item is at root level.

rootLineId
string

Unique identifier to specify root item. Useful when product order hierarchy exceeds 2.

ibx
string

Location code of Equinix datacenter

cage
string

Cage ID

productDescription
string

Description of the product.

productType
string
Enum: "CROSS_CONNECT" "SMART_HANDS" "WORK_VISIT" "SECURITY_ACCESS" "CONFERENCE_ROOM" "TROUBLE_TICKET" "SHIPMENTS" "NETWORK_PORTS" "DEINSTALL_CROSS_CONNECT" "CLOUD_EXCHANGE_PORTS" "OTHER"

Product type

productCode
string

Equinix Product catalog code.

productName
string

Product name

assetizable
boolean

When this value is true, line item is assetizable.

lineItemModified
boolean

When this value is true, it means there are changes to POE.

quantity
number

The total amount of quantity bought. To be used with unitOfMeasure to derive value

unitOfMeasure
string
Enum: "CAB" "EACH" "MBP" "KVA" "GB" "HRS" "SFT" "LF" "KWH"

Metric of quantity

Array of objects (Pricing Details)
Array of objects (Pricing Details)
requestType
string
Enum: "ADD" "DELETE" "UPDATE" "NO_CHANGE"

Type of order request. For example, requestType can be of ADD if you are adding new services/product.

Array of objects

This section is reserved to display product specific information

Response samples

Content type
application/json
{
  • "quoteId": "1-100000000009",
  • "accountName": "Company Name LLC",
  • "accountNumber": "1000001",
  • "quoteRequestType": "NEW",
  • "contacts": [
    ],
  • "status": "APPROVED",
  • "createdDateTime": "2020-11-12T19:07:21.000Z",
  • "updatedDateTime": "2020-11-12T20:03:15.000Z",
  • "expirationDateTime": "2021-02-10T00:00:00.000Z",
  • "channel": "OFFLINE",
  • "subChannel": "QUOTE",
  • "currencyCode": "USD",
  • "termsOfUse": [
    ],
  • "totalPricing": [
    ],
  • "versionNumber": "1",
  • "details": [
    ]
}