Retrieve Orders API | Equinix Product Documentation

Search Orders History

Request

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

Headers

Authorizationstringrequired

Specify the Access token with prefix 'Bearer'.

Bodyapplication/json

filtersobject(Retrieve Order filters)

Example:

{
  "orderStatus": [
    "PENDING_QA",
    "IN_PROGRESS",
    "PARTIAL_SUBMISSION"
  ],
  "productTypes": [
    "SMART_HANDS"
  ],
  "ibxs": [
    "SV1"
  ],
  "fromDate": "05/01/2018",
  "toDate": "05/02/2018"
}

sourceArray of strings

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).

Items Enum:"ORDER_NUMBER""PO_NUMBER""CUSTOMER_REFERENCE_NUMBER""CONTACT_LAST_NAME""SR_NUMBER""TROUBLE_TICKET_NUMBER""WORK_ACTIVITY_NUMBER"

qstring

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

Example:"1-123456789"

sortsArray of objects(Sort)

pageobject(Page Request)

Payload

{
  "filters": {
    "orderStatus": [ … ],
    "productTypes": [ … ],
    "ibxs": [ … ],
    "fromDate": "05/01/2018",
    "toDate": "05/02/2018"
  },
  "source": [
    "ORDER_NUMBER"
  ],
  "q": "1-123456789",
  "sorts": [
    { … }
  ],
  "page": {
    "number": 0,
    "size": 25
  }
}

Responses

Bodyapplication/json

contentArray of objects(Order Header)

linksArray of objects(Link)

pageobject(Orders Response Page Details)

Response

{
  "content": [
    { … }
  ],
  "links": [
    { … }
  ],
  "page": {
    "size": "25",
    "totalElements": "160",
    "totalPages": "7",
    "number": "0"
  }
}