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

Equinix Retrieve Orders API

The Retrieve Orders API from Equinix — 2 operation(s) for retrieve orders.

Equinix Retrieve 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 Retrieve Orders. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 2 operations across 2 paths, and defines 17 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.

2 operations 2 paths 17 schemas 1 GET1 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
Terms of Service
Resource Areas
1

Paths & Operations 2

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

Retrieve Orders 2
GET
/v1/retrieve-orders/locations
Retrieve order permissible IBX locations
GET_retrieve-orders-locations 1 param → 200400403500
POST
/v1/retrieve-orders
Search Orders History
POST_orders-history 2 params → 200400403500

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are order-header (10 properties), ibx-detail-for-locations-endpoint (8 properties), filters (6 properties), orderhistoryapirequest (5 properties). Each schema is shown below with its type and property counts.

ordering-contact
object
3 properties
page-details-for-response
object
4 properties
order-history-location-response
array
page-request-model
object
2 properties
product-types-enum
string
account
object
2 properties 2 required
notification-contact
object
3 properties
order-header
object
10 properties 1 required
order-header-status-enum
string
ENTERED: Order Created. SUBMITTED: When the order is assigned to the Equinix OPS team. INPROGRESS: When the order fulfillment is in progress PENDINGQA: The ord…
ibx-detail-for-locations-endpoint
object
8 properties
link
object
2 properties
permissible-location
object
2 properties
sort
object
2 properties
order-history-response
object
3 properties
filters
object
6 properties
orderhistoryapirequest
object
5 properties
genericError
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

equinix-retrieve-orders-api-openapi.yml Raw ↑

Other APIs Equinix publishes across the network.

Equinix Agent Templates API
Equinix Agents API
Equinix Authentication API
Equinix availability API
Equinix Batches API
Equinix BGP API
Equinix Capacity API
Equinix Cloud Events API
Equinix Cloud Routers API
Equinix Company Profiles API
Equinix Connections API
Equinix Console Log Details API