Skip to main content
API docs by Redocly

Orders (2.0-beta)

Download OpenAPI specification:Download

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

Based on a user's permission, a user may be able to view their own orders or also the orders from all of the users in their organization. These orders can be filtered by product type, order status, location, or date range. Only orders from the past 12 months will be returned.

Orders

Orders

Retrieve an order

This method retrieves an order by its ID for a user with permission to view this request.

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

Identifier of the Order

query Parameters
ibxs
Array of strings
Example: ibxs=SG1

List of IBXs to be filtered

Responses

Response Schema: application/json
orderId
string [ 1 .. 100 ] characters

Unique identifier of the order.

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 associated with the ticket.

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: "ORDERING" "NOTIFICATION" "TECHNICAL" "RESELLER"

Communications type

availability
string
Default: "ANYTIME"
Enum: "WORK_HOURS" "ANYTIME"

Contact's availability to receive calls.

timezone
string (TIME_ZONE_LIST)
Enum: "Atlantic/Canary" "Europe/Dublin" "Europe/London" "Europe/Lisbon" "Africa/Algiers" "Europe/Berlin" "Europe/Amsterdam" "Europe/Copenhagen" "Europe/Madrid" "Europe/Paris" "Europe/Stockholm" "Europe/Zurich" "Europe/Warsaw" "Africa/Cairo" "Africa/Johannesburg" "Africa/Lagos" "Europe/Sofia" "Africa/Nairobi" "Asia/Jerusalem" "Europe/Istanbul" "Europe/Moscow" "Asia/Riyadh" "Asia/Dubai" "Asia/Kabul" "Asia/Tehran" "Asia/Karachi" "Indian/Maldives" "Asia/Kolkata" "Asia/Kathmandu" "Asia/Omsk" "Asia/Rangoon" "Asia/Jakarta" "Asia/Ho_Chi_Minh" "Asia/Brunei" "Asia/Hong_Kong" "Asia/Kuala_Lumpur" "Asia/Manila" "Asia/Shanghai" "Asia/Singapore" "Asia/Taipei" "Australia/Perth" "Asia/Seoul" "Asia/Tokyo" "Australia/Darwin" "Australia/Brisbane" "Pacific/Guam" "Australia/Adelaide" "Australia/Sydney" "Pacific/Auckland" "Pacific/Chatham" "Indian/Christmas" "America/Scoresbysund" "Atlantic/South_Georgia" "America/Sao_Paulo" "America/Detroit" "America/New_York" "America/Puerto_Rico" "America/Toronto" "America/Bogota" "America/Chicago" "America/Winnipeg" "America/Denver" "America/Edmonton" "America/Mexico_City" "America/Los_Angeles" "America/Vancouver" "America/Phoenix" "America/Anchorage" "America/Halifax" "America/Lima" "America/Monterrey" "Pacific/Gambier" "Pacific/Marquesas" "Pacific/Honolulu" "Pacific/Fiji" "Asia/Muscat" "America/Argentina/Buenos_Aires" "America/Caracas" "Etc/GMT+12" "UTC" "GMT" "America/Santiago" "America/St_Johns" "Asia/Almaty" "Asia/Bangkok" "Asia/Calcutta" "Asia/Magadan" "Asia/Yekaterinburg" "Australia/Eucla" "Australia/Lord_Howe" "Europe/Bratislava" "Europe/Brussels" "Europe/Prague" "Europe/Rome" "Europe/Helsinki" "Pacific/Kiritimati" "Pacific/Midway" "Pacific/Tongatapu" "Australia/Melbourne" "Australia/NSW" "Australia/Queensland" "Australia/South" "Australia/Victoria" "Australia/West" "Australia/Canberra"

Contact's timezone

Array of objects (ContactsDetails)

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

status
string
Enum: "RECEIVED" "IN_PROGRESS" "ON_HOLD" "CLOSED" "CANCELLED"

The current status of the order or service

createdDateTime
string <date-time>

The order created date and time in UTC timezone.

updatedDateTime
string <date-time>

The order updated date and time in UTC timezone.

closedDateTime
string <date-time>

The order closed date and time in UTC timezone.

estimatedCompletionDateTime
string <date-time>

The estimated completion date and time in UTC timezone

currencyCode
string (currencyCode)
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"

ISO-4217 currency code

channel
string
Enum: "API" "PORTAL" "MOBILE" "OFFLINE"

Type of channel used to place the order

subChannel
string
Enum: "ECP" "ECX" "IX" "NE" "EMG" "QUOTE"

Type of sub-channel used to place the order

Array of objects (Note)

The notes that are associated to the orders.

Array
id
string

Unique identifier of the note

referenceId
string

Unique identifier for referencing notes.

createdDateTime
string <date-time>

Date and time of the note creation in UTC timezone

text
string [ 5 .. 4000 ] characters

The content of the note

author
string >= 5 characters

Author of the notes

type
string
Enum: "CUSTOMER_QUERY" "CUSTOMER_NOTES" "TECHNICIAN_QUERY" "TECHNICIAN_NOTES"

Type of notes

Array of objects (Attachment)

File(s) attached to the orders. To learn about including attachments in your request, refer to Attachments API.

Array of objects (Additional product details)

This section is reserved to display product specific information

Array
key
string
value
string
customerReferenceId
string [ 5 .. 100 ] characters

Customer Reference Number / External Reference Number

cancellable
boolean
Default: false

When true, order can be cancelled.

modifiable
boolean
Default: false

When true, order can be modified.

Array of objects (ordersLine)
Array
lineId
string

Unique identifier associated with line item.

parentlineId
string

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

rootlineId
string

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

status
string

The current status of the order or service

description
string [ 5 .. 4000 ] characters

Description of the orders.

billingStartDateTime
string <date-time>

Billing commencement date and time in UTC timezone

estimatedCompletionDateTime
string <date-time>

The estimated completion date and time in UTC timezone

Array of objects (price)

Unit Pricing details

Array of objects (price)

Total Pricing details

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

Type of product

productCode
string

Product code associated with a particular product

productName
string

Product name

ibx
string

Location code of Equinix datacenter

cage
string

Cage ID

cabinets
Array of strings

One or more cabinets ID

requestType
string
Enum: "ADD" "DELETE" "NO_CHANGE" "UPDATE"

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

Array of objects (Attachment) <= 5 items

File(s) attached to the Orders. To learn about including attachments in your request, see POST Attachments API.

Array of objects (Additional product details)

This section is reserved to display product specific information

object (purchaseOrder)

Purchase Order

cancellable
boolean
Default: false

When true, order can be cancelled

modifiable
boolean

When true, order can be modified

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve order negotiations

This method retrieves order negotiations by its ID for a user with permission to view this request.

Authorizations:
BearerAuth
path Parameters
orderId
required
string [ 1 .. 100 ] characters
Example: {orderId}

Identifier of the order

Responses

Response Schema: application/json
Array
referenceId
string

Reference id / internal id for customer to identify the actionable order line

orderRequestedDateTime
string <date-time>

Customer requested order date and time at point of order.

proposedDateTime
string <date-time>

Alternative / revised date and time proposed by Equinix for fulfilling the order request.

expirationDateTime
string <date-time>

Validity date and time of the negotiation. Negotiations request after this date will no longer be valid.

createdDateTime
string <date-time>

Negotiations message created date and time by operations team

expedited
boolean

When true, requested order is an expedite order

message
string [ 5 .. 4000 ] characters

Negotiations message

Response samples

Content type
application/json
Example
[
  • {
    }
]

Reply to an order negotiation

This method approves or rejects an order negotiation for a user with permission to view this request.

Authorizations:
BearerAuth
path Parameters
orderId
required
string [ 1 .. 100 ] characters
Example: {orderId}

Identifier of the order

Request Body schema: application/json

The action to be taken for an order negotiation

referenceId
required
string

Unique identifier to reference specific activity or order line id.

action
required
string
Enum: "APPROVE" "APPROVE_NON_EXPEDITE" "CANCEL"

Type of actions to be carried out with negotiation. Use APPROVE to accept order with new proposed date, APPROVE_NON_EXPEDITE to accept order without expedite and CANCEL to cancel order

reason
string [ 5 .. 4000 ] characters

Reason for cancelling the negotiation

Responses

Request samples

Content type
application/json
Example
{
  • "referenceId": "4-9091830",
  • "action": "APPROVE"
}

Response samples

Content type
application/json
Example
[
  • {
    }
]

Add notes to an order

This method adds notes to an order by its ID for a user with permission to view this request.

Authorizations:
BearerAuth
path Parameters
orderId
required
string [ 1 .. 100 ] characters
Example: {orderId}

Identifier of the order

Request Body schema: application/json

The Order Id to be updated

referenceId
string [ 1 .. 50 ] characters

Unique reference ID associated with notes.

text
required
string [ 5 .. 4000 ] characters

The text of the note

Array of objects (Attachment) <= 5 items

File(s) attached to the Orders. To learn about including attachments in your request, see POST Attachments API.

Array (<= 5 items)
id
string = 36 characters

Identifier of the binary attachment UUID.

name
string [ 5 .. 100 ] characters

Name of the binary attachment.

Responses

Request samples

Content type
application/json
Example
{
  • "text": "problem description",
  • "attachments": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Cancel an order

This method cancels an order by its ID for a user with permission to view this request.

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

Identifier of the order

Request Body schema: application/json
required

The Orders to be cancelled

reason
required
string [ 5 .. 4000 ] characters

Reason for cancellation

Array of objects (Attachment) <= 5 items

File(s) attached

Array (<= 5 items)
id
string = 36 characters

Identifier of the binary attachment UUID.

name
string [ 5 .. 100 ] characters

Name of the binary attachment.

lineIds
Array of strings [ 0 .. 1 ] items

Refers to the lineId of product/service.

Responses

Request samples

Content type
application/json
{
  • "reason": "string",
  • "attachments": [
    ],
  • "lineIds": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]