purchaseorders

---

title: PurchaseOrders (V2 Beta)

PurchaseOrders (V2 Beta) API allows you to retrieve blanket purchase orders associated with your account.

GET PurchaseOrders

	GET /purchaseOrders
Method	GET
URL or End Point	/colocations/v2/purchaseOrders
Headers	Authorization, Content-Type
Query Parameters	accountNumbers, productTypes, ibxs, offset, limit, sorts
Body	Not applicable

This method retrieves existing blanket purchase orders in your organization based on their applicable accounts, product types, and IBXs. Only users from your organization with portal permissions may retrieve this information. The authorization token and content-type are the only headers that are passed to this API and a response is received based on the values passed.

 

If you are unaware of how to obtain an authorization token, refer to Requesting Access and Refresh tokens under the Getting Access Token section.

The following screenshots show a sample curl request and a successful JSON response.

curl -X
GET "https://api.equinix.com/colocations/v2/purchaseOrders?accountNumber=111111&productType=NETWORK&ibxs=AM1&offset=0&limit=1"
-H "content-type: application/json"
-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

The description of the query parameters is as follows:

Query Parameter name	Mandatory	Type	Example	Applicable Values	Description
accountNumbers	Yes	array [strings]	111111		Account number.   Only one value is currently supported for this parameter.
productTypes	Yes	array [strings]	NETWORK	CROSS_CONNECT, SMART_HANDS, POWER, NETWORK, SMVSENSOR, SMARTVIEW, SERVICES	Product type that is applicable.   Only one value is currently supported for this parameter.
ibxs	Yes	array [strings]	AM1		IBX location code of the associated IBX data center.   Only one value is currently supported for this parameter.
offset	No	integer	0		Defines the index of the first item returned in the response. By specifying the offset, the response returns a subset of records starting with the offset value. For example, if the offset is 10, the starting item returned in the response would be the 11th item. Default value: 0
limit	No	integer	1		Defines the maximum number of records returned per page. Default value: 10 Limit: 1 to 200

{
  "data": [
    {
      "number": "PO123456",
      "amount": 600000,
      "remainingAmount": 1000,
      "startDate": "2021-01-01",
      "endDate": "2021-12-30",
      "productTypes": [
        "CROSS_CONNECT",
        "NETWORK"
      ],
      "productCategories": [
        "INTERCONNECTION"
      ],
      "ibxs": [
        "AM1",
        "AM2",

        "AM3"
      ],
      "description": "Blanket Interconnection PO"
    }
  ],
  "pagination": {
    "offset": 0,
    "limit": 1,
    "total": 1,
    "next": "/purchaseOrders?accountNumber=111111&productType=NETWORK&ibxs=ALL&offset=0&limit=1",
    "previous": "/purchaseOrders?accountNumber=111111&productType=NETWORK&ibxs=ALL&offset=0&limit=1"
  }
}

The description of the response payload is as follows:

Field name	Type	Example	Description
data	array [objects]		Data returned from your query. Each purchase order object comprises the following fields where applicable: number, amount, remainingAmount, startDate, endDate, productTypes, productCategories, ibxs, description.
number	string	PO123456	Purchase order number.
amount	number	600000	Original value amount of this purchase order in USD.
remainingAmount	number	0	Remaining value amount in purchase order in USD.
startDate	string	2021-01-01	Purchase order start date. Format: YYYY-MM-DD
endDate	string	2021-12-30	Purchase order end date. Format: YYYY-MM-DD
productTypes	array [strings]	CROSS_CONNECT, NETWORK	Product types applicable to this purchase order. This is a subset of productCategories. See the following list for a description of the productTypes ENUM values. Product types - Description CROSS_CONNECT - Cross connect NETWORK - Network ports such as Equinix Connect, Metro Connect, Internet Exchange, or Equinix Fabric ports POWER - Power circuits such as AC or DC circuits SERVICES - Professional services SMART_HANDS - Smart Hands services SMARTVIEW - IBX SmartView SMVSENSOR - IBX SmartView environmental sensor SPACE - Space
productCategories	array [strings]	INTERCONNECTION	Product category applicable to this purchase order. See the following list for a mapping of the productCategories ENUM values with related productTypes. Product Categories - Product Types SMART_HANDS - SMART_HANDS INTERCONNECTION - CROSS_CONNECT, NETWORK POWER - POWER SPACE  - SPACE SERVICES - SMVSENSOR, SMARTVIEW, SERVICES
ibxs	array [strings]	AM1, AM2, AM3	IBX location codes applicable to this purchase order. When an empty array is returned, the purchase order is applicable to all Equinix IBXs.
description	string	Blanket Interconnection PO	Additional description of the purchase order.
pagination	object		Page information. This object comprises the following fields: offset, limit, total, next, previous.
offset	integer	0	Offset of the first item in the response.
limit	integer	1	Maximum number of items in the response.
total	integer	1	Total number of available items in the record.
next	string	/purchaseOrders?accountNumber=111111 &productType=NETWORK&ibxs=ALL&offset=0 &limit=1	URL for the next page of results.
previous	string	/purchaseOrders?accountNumber=111111 &productType=NETWORK&ibxs=ALL&offset=0 &limit=1	URL for the previous page of results.

 

If you get “Insufficient permissions” error, contact your Master Administrator.