Quote APIs | Equinix Product Documentation

Retrieve a quote

Request

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

Security

BearerAuth

Path

quoteIdstring, [ 1 .. 100 ]required

Identifier of the quote

Query

ibxsArray of strings

List of IBXs to be filtered

Example:ibxs=SG1

Payload

// No request payload

Responses

Ok

Bodyapplication/json

quoteIdstring

Equinix quote ID.

Example:"1-1234567891011"

accountNamestring

Customer account name

Example:"AAA Corporation Ltd"

accountNumberstring

Customer account number

Example:"123456"

quoteRequestTypestring

The request type of the quote

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

contactsArray of objects(Contacts)

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

statusstring

The current status of the quote

Enum:"SUBMITTED""APPROVED"

createdDateTimestring, (date-time)

The quote created date and time in UTC timezone.

Example:"2020-11-19T06:51:10.000Z"

updatedDateTimestring, (date-time)

The quote updated date and time in UTC timezone.

Example:"2020-11-20T06:51:10.000Z"

expirationDateTimestring, (date-time)

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

Example:"2020-12-31T06:51:10.000Z"

channelstring

The channel which quote was being requested.

Enum:"PORTAL""OFFLINE"

subChannelstring

The sub-channel which quote was being requested.

Value:"QUOTE"

customerReferenceIdstring

Customer Reference Number / External Reference Number

Example:"048837d6-4cd8-401f-ba41-a4ac015c3f3e"

agreementNumberstring

Quote agreement number

currencyCodestring

The quote currency code in ISO-4217 format

Enum:"AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZN"

termsOfUseArray of objects(termsOfUse_Details)

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

totalPricingArray of objects(Pricing Details)

Pricing details of grand total price

versionNumberstring

Version number will be updated when quote is revised

detailsArray of objects(quote_details)

Quote details of line items

Response

{
  "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": [
    { … },
    { … },
    { … }
  ]
}