Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Equinix

Equinix Orders API

Orders

Documentation Provider Profile APIs.io OpenAPI GitHub

Equinix Orders API is one of 74 APIs that Equinix publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Orders. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 6 operations across 5 paths, and defines 41 schemas. It is described by OpenAPI 3.0.1, at version 1.2.

Requests are made against a single base URL, https://api.equinix.com.

6 operations 5 paths 41 schemas 2 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.2
Base URL
https://api.equinix.com
Contact
Equinix API Support
Terms of Service
View terms
Resource Areas
1

Paths & Operations 6

Across 5 paths, the API surfaces 6 operations — 2 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Orders 6

Orders

GET
/colocations/v2/orders/{orderId}
Retrieve an order
GET Order details 2 params → 200400401403404405409500
GET
/colocations/v2/orders/{orderId}/negotiations
Retrieve order negotiations
Retrieve order negotiations 1 param → 200400401403409500
POST
/colocations/v2/orders/{orderId}/negotiations
Reply to an order negotiation
Reply to an order negotiation 1 param body → 202204400401403409500
POST
/colocations/v2/orders/{orderId}/notes
Add notes to an order
Add notes to an order 1 param body → 202204400401403404405409
POST
/colocations/v2/orders/{orderId}/cancel
Cancel an order
Cancel an order 1 param body → 202204400401403404405409
POST
/securecabinet/v1/orders
Order a new Secure Cabinet deployment
createOrder body → 202401403422500

Schemas 41

The contract defines 41 schemas that model the data the API accepts and returns. The most detailed are ordersLine (21 properties), ordersBase (18 properties), OrderCreateRequest (8 properties), Negotiations (7 properties). Each schema is shown below with its type and property counts.

NoteRequest
object
Extra notes about a given entity
3 properties 1 required
Rating
number
Maximum, combined power draw of all cabinets in your order, measured in kVA. Applicable values, in 0.5 increments, depend on the IBX data center.
Orders
An order could be request, service or ticket to performs specified activity on an colo businesss
Negotiations_request
object
3 properties 2 required
ValidationError
object
Error responses are included with 4xx and 5xx HTTP responses from the API service. Either "error" or "errors" will be set.
6 properties 2 required
ordersBase
object
Orders Base is the properties or attributes which common for every order details
18 properties
Errors
array
ordersLine
object
Orders Line contains information appplicable for all the orders type i.e smart hands, work visit and cross connect
21 properties
Dimension
object
2 properties 2 required
ValidationErrorAdditionalInfo
object
5 properties 2 required
purchaseOrder
object
Purchase Order
3 properties
Contacts
object
Contact information.
7 properties
OrderDetails
object
1 property
Cancel_Request
object
Cancelling the Order
3 properties 1 required
NegotiationsMessages
array
ValidationErrors
array
price
object
Pricing details for a particular service or order, This can be one time charge or recurring charge
3 properties
Note
object
Extra information about a given entity
7 properties
Phone
object
Phone number details.
2 properties 2 required
Attachment
object
Attachments
2 properties
ValidationErrorAdditionalInfoList
array
Contains application specific information for this error. The object inside this array can have any number of application specific properties.
OrderItem
object
Order details.
5 properties 5 required
OrderCreateRequest
object
8 properties 4 required
IbxCode
string
IBX data center identifier.
Dimensions
object
3 properties 3 required
OrderCreateResponse
object
1 property 1 required
ContactAvailability
string
When is the best time to call.
TIME_ZONE_LIST
string
Contact's timezone
ContactDetails
object
Contact person details for technical inquiries.
4 properties 3 required
Negotiations
object
Negotiations message with alternative date and time
7 properties
Error_2
object
Error responses are included with 4xx and 5xx HTTP responses from the API service. Either "error" or "errors" will be set.
6 properties 2 required
ContractTerm
string
Contract term length.
ErrorAdditionalInfo
object
2 properties
Error
array
ErrorAdditionalInfoList
array
Contains application specific information for this error. The object inside this array can have any number of application specific properties.
AccountNumber
string
Identifier of a billing account, with permission to order colocation products.
productAdditionalInfo
array
This section is reserved to display product specific information
currencyCode
string
ISO-4217 currency code
OrderNumber
string
Order Number
PurchaseOrderNumber
string
Purchase order number. Optional, unless the billing account requires it.
ContactsDetails
object
Contact information.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

equinix-orders-api-openapi.yml Raw ↑

Other APIs Equinix publishes across the network.

Equinix Agent Templates API
AE Profile APIs.io
Equinix Agents API
AE Profile APIs.io
Equinix Authentication API
AE Profile APIs.io
Equinix availability API
AE Profile APIs.io
Equinix Batches API
AE Profile APIs.io
Equinix BGP API
AE Profile APIs.io
Equinix Capacity API
AE Profile APIs.io
Equinix Cloud Events API
AE Profile APIs.io
Equinix Cloud Routers API
AE Profile APIs.io
Equinix Company Profiles API
AE Profile APIs.io
Equinix Connections API
AE Profile APIs.io
Equinix Console Log Details API
AE Profile APIs.io
#Orders
← Back to E APIs
API Details
ID
equinix:equinix-orders-api
Base URL
https://api.equinix.com
Docs
https://developer.equinix.com/catalog/fabricv4
Provider
Equinix
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network