Skip to main content
API docs by Redocly

Retrieve Orders API (1.0.0)

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.

Retrieve Orders

Retrieve order permissible IBX locations

The API returns locations (IBXs and Cages) where the user's organization has a presence. The user may be able to view orders related to these locations, depending on their permissions.

header Parameters
Authorization
required
string

Specify the Access token with prefix 'Bearer'.

Responses

Response Schema: application/json
Array
object (IBX Detail (Locations Endpoint))
code
string

Ibx Code

metro
string

Metro code where ibx is located

region
string

Region where ibx is located

country
string

Country where ibx is located

city
string

City where ibx is located

state
string

State where ibx is located

address
string

Address of the ibx

postalCode
string

Postal code of ibx location

cages
Array of strings

Response samples

Content type
application/json
[
  • {
    }
]

Search Orders History

Based on filtering criteria, this method returns a list of orders from the last 12 months for IBX locations where the user has permissions.

header Parameters
Authorization
required
string

Specify the Access token with prefix 'Bearer'.

Request Body schema: application/json
object (Retrieve Order filters)
ibxs
Array of strings

ibxs filter

productTypes
Array of strings (Product Types(Order Types) Enum)
Items Enum: "SMART_HANDS" "TROUBLE" "SHIPMENT" "WORK_VISIT" "SECURITY_ACCESS" "CONFERENCE_ROOM" "TOUR_REQUESTS" "CROSS_CONNECT" "CLOUD_EXCHANGE_PORT" "INTERNET_EXCHANGE_PORT" "METRO_CONNECT" "POWER" "IBX_SMARTVIEW_SENSOR" "ACCESSORY" "CAGE" "CABINET" "IBX_SMART_VIEW"

Product(order type) filter

orderStatus
Array of strings (Order Header Status Enum)
Items Enum: "ENTERED" "SUBMITTED" "IN_PROGRESS" "PENDING_QA" "CANCELLED" "CLOSED"

order status filter

dateRange
string
Enum: "PAST_7_DAYS" "PAST_14_DAYS" "PAST_30_DAYS" "PAST_3_MONTHS" "PAST_6_MONTHS" "PAST_YEAR"

Date range filter

fromDate
string <date>

Date Format Should be mm/dd/yyyy.
Not applicable when dateRange is provided.

toDate
string <date>

Date Format Should be mm/dd/yyyy.
Not applicable when dateRange is provided

source
Array of strings
Items Enum: "ORDER_NUMBER" "PO_NUMBER" "CUSTOMER_REFERENCE_NUMBER" "CONTACT_LAST_NAME" "SR_NUMBER" "TROUBLE_TICKET_NUMBER" "WORK_ACTIVITY_NUMBER"

ORDER_NUMBER: Search by order number(1-123456789).
CUSTOMER_REFERENCE_NUMBER: Search by customer reference number which was entered as part place order.
TROUBLE_TICKET_NUMBER: Search by trouble ticket numnber(5-123456).
WORK_ACTIVITY_NUMBER: Search by work order activity number(3-123456).

q
string

Query value to be queried against source values(Or operation against all sources).
Supports partial text search

Array of objects (Sort)
Array
name
string
Enum: "ORDERING_CONTACT" "ACCOUNT_NUMBER" "CREATED_ON"

ORDERING_CONTACT sort is applicable on ordering contact last name.

direction
string
Enum: "ASC" "DESC"
object (Page Request)
number
integer
Default: 0

Page number indexed from 0.

size
integer <= 200
Default: 10

Page Size.

Responses

Response Schema: application/json
Array of objects (Order Header)
Array
orderNumber
string

Order number

type
Array of strings

List Of Proudcts Ordered in the Order.

orderStatus
string (Order Header Status Enum)
Enum: "ENTERED" "SUBMITTED" "IN_PROGRESS" "PENDING_QA" "CANCELLED" "CLOSED"

ENTERED: Order Created.
SUBMITTED: When the order is assigned to the Equinix OPS team.
IN_PROGRESS: When the order fulfillment is in progress
PENDING_QA: The order couldn't be submitted. This order required manual intervention from Equinix end.
CANCELLED: The order is canceled.
CLOSED: Order is closed.

createdAt
string

Order Created DateTime in ISO Date Format

object (Account)
object (Ordering Contact)
object (Notification Contact)
ibx
Array of strings

List of ibxs for the order lines.

customerReferenceNumbers
Array of strings

List of customer reference numbers for the order lines.

Array of objects (Link)
Array of objects (Link)
Array
rel
string
Enum: "self" "prev" "next" "orderFullDetails"
href
string
object (Orders Response Page Details)
size
integer

Page Size

totalElements
number

Total number of records

totalPages
integer

Total number of pages

number
integer

Current page number

Request samples

Content type
application/json
{
  • "filters": {
    },
  • "source": [
    ],
  • "q": "1-123456789",
  • "sorts": [
    ],
  • "page": {
    }
}

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "links": [],
  • "page": {
    }
}