Purchase Orders


Get Account Purchase Orders

GET /internetAccess/v1/accounts/{accountNumber}/purchaseOrders
Method GET
Endpoint /internetAccess/v1/accounts/{accountNumber}/purchaseOrders
Headers Authorization
Path Parameters accountNumber
Query Parameters locations.ibx, category, offset, limit
Body Parameters Not applicable

This API request returns purchase orders associated with the specified account.


Sample curl request

Copy 
curl -X GET 'https://api.equinix.com/internetAccess/v1/accounts/123456/purchaseOrders?locations.ibx=DC5&category=INTERCONNECTION'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Path parameters

Parameter
Description
accountNumber string
REQUIRED
 Customer account number.
Applicable values: Use the Get Accounts API request to retrieve accounts.
Example: 123456

Query parameters

Parameter
Description
locations.ibx string
OPTIONAL		 IBX data center identifier.
Applicable values: Use the Get IBX Data Centers API request to retrieve IBX data centers where Equinix Internet Access is available.
Example: DC5
category string
OPTIONAL
 Product category.
Applicable values:
  • ALL_SERVICES
  • INTERCONNECTION
  • SMART_HANDS
  • POWER
  • NETWORK
  • SERVICES
  • SPACE

Default: INTERCONNECTION
offset integer
OPTIONAL		 Index of the first item returned in the response.
Default: 0
limit integer
OPTIONAL		 Maximum number of items returned per page.
Default: 50

Sample response

Copy 
{
    "pagination": {
        "offset": 0,
        "limit": 20,
        "total": 2
    },
    "data": [
        {
            "type": "BLANKET_PURCHASE_ORDER",
            "number": "10010",
            "account": {
                "accountNumber": "123123"
            },
            "categories": [
                "INTERCONNECTION"
            ],
            "locations": [
                {
                    "ibx": "WA1"
                }
            ],
            "amount": 10000.5,
            "startDate": "2023-01-24",
            "endDate": "2023-08-24",
            "description": "Purchase order desc",
            "draft": false,
            "status": "ACTIVE",
            "currency": "USD"
        }
    ]
}

Response payload body description

Parameter
Description
pagination object
 Data set pagination information.
offset integer
 Index of the first item returned in the response.
limit integer
 Maximum number of items returned per page.
total integer
 Total number of items.
data array[object]
 Data set containing purchase orders associated with the given account.
type string
 Purchase order type.
Possible values:
  • STANDARD_PURCHASE_ORDER
  • BLANKET_PURCHASE_ORDER
number string
Purchase order identifier.
Example: 10010
account object
 Customer billing account.
accountNumber string
 Customer billing account number.
Example: 123123
categories array[string]
 Purchase order product categories.
Possible values:
  • INTERCONNECTION
  • NETWORK
  • POWER
  • SPACE
  • SMART_HANDS
  • SERVICES
locations object
 Location information.
ibx string
 IBX data center identifier.
Example: DC5
amount number
 Amount.
Example: 100.5
startDate string
 Validity period start date in YYYY-MM-DD format.
Example: 2023-01-16
endDate string
 Validity period nd date in YYYY-MM-DD format.
Example: 2023-01-16
description string
 Purchase order description.
Example: Interconnection allowance.
draft boolean
 Indicates if this is a draft purchase order.
Example: false
status string
 Purchase order status.
Possible values:
  • DRAFT
  • ACTIVE
currency string
 Currency in which the purchase order amount is expressed.
Example: USD

Get Specified Purchase Order

GET /internetAccess/v1/accounts/{accountNumber}/purchaseOrders/{number}
Method GET
Endpoint /internetAccess/v1/accounts/{accountNumber}/purchaseOrders/{number}
Headers Authorization
Path Parameters accountNumber, number
Query Parameters Not applicable
Body Parameters Not applicable

This API request returns a specified purchase order.


Sample curl request

Copy 
curl -X GET 'https://api.equinix.com/internetAccess/v1/accounts/123456/purchaseOrders/PO-1234567'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Path parameters

Parameter
Description
accountNumber string
REQUIRED
 Customer account number.
Applicable values: Use the Get Accounts API request to retrieve accounts.
Example: 100013200
number string
REQUIRED
 Purchase order number.
Applicable values: Use the Get Account Purchase Orders API request to retrieve purchase orders associated with the specified account.
Example: 1234567

Sample response

Copy 
{
    "type": "BLANKET_PURCHASE_ORDER",
    "number": "10010",
    "account": {
        "accountNumber": "123123"
    },
    "categories": [
        "INTERCONNECTION"
    ],
    "locations": [
        {
            "ibx": "WA1"
        }
    ],
    "amount": 10000.5,
    "startDate": "2019-08-24",
    "endDate": "2019-08-24",
    "description": "Purchase order desc",
    "draft": false,
    "status": "ACTIVE",
    "currency": "USD"
}

Response payload body description

Parameter
Description
type string
 Purchase order type.
Possible values:
  • STANDARD_PURCHASE_ORDER
  • BLANKET_PURCHASE_ORDER
number string
Purchase order identifier.
Example: 10010
account object
 Customer billing account.
accountNumber string
 Customer billing account number.
Example: 123123
categories array[string]
 Purchase order product categories.
Possible values:
  • INTERCONNECTION
  • NETWORK
  • POWER
  • SPACE
  • SMART_HANDS
  • SERVICES
locations object
 Location information.
ibx string
 IBX data center identifier.
Example: DC5
amount number
 Amount.
Example: 100.5
startDate string
 Validity period start date in YYYY-MM-DD format.
Example: 2023-01-16
endDate string
 Validity period end date in YYYY-MM-DD format.
Example: 2023-01-16
description string
 Purchase order description.
Example: Interconnection allowance.
draft boolean
 Indicates if this is a draft purchase order.
Example: false
status string
 Purchase order status.
Possible values:
  • DRAFT
  • ACTIVE
currency string
 Currency in which the purchase order amount is expressed.
Example: USD