Order

Get Specified Order

	GET /internetAccess/v1/orders/{orderUUID}
Method	GET
Endpoint	/internetAccess/v1/orders/{orderUUID}
Headers	Authorization
Path Parameters	orderUUID
Query Parameters	Not applicable
Body Parameters	Not applicable

This API request returns Equinix Internet Access order details.

Sample curl request

curl -X GET 'https://api.equinix.com/internetAccess/v1/orders/d27c0f84-f1da-498e-95c0-f3d3ae02d16d'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Path parameters

Parameter	Description
orderUUID string REQUIRED	Order identifier. Example: d27c0f84-f1da-498e-95c0-f3d3ae02d16d

Sample response

{
    "href": "https://api.equinix.com/internetAccess/v1/orders/4b8df286-5562-41e2-8753-0379eecbe176",
    "uuid": "4b8df286-5562-41e2-8753-0379eecbe176",
    "type": "AMENDMENT",
    "contacts": [
        {
            "href": "https://api.equinix.com/access/v2/users/joeAverage",
            "type": "TECHNICAL",
            "registeredUser": "joeAverage"
        },
        {
            "href": "https://api.equinix.com/access/v2/users/joeAverage",
            "type": "NOTIFICATION",
            "registeredUser": "joeAverage"
        },
        {
            "href": "https://api.equinix.com/access/v2/users/joeAverage",
            "type": "ORDERING",
            "registeredUser": "joeAverage"
        }
    ],
    "draft": false,
    "links": [
        {
            "href": "https://api.equinix.com/internetAccess/v1/orders/4b8df286-5562-41e2-8753-0379eecbe176",
            "rel": "self",
            "method": "GET",
            "authenticate": true,
            "contentType": "application/json"
        }
    ],
    "purchaseOrder": {
        "href": https://api.equinix.com/internetAccess/v1/accounts/330215/purchaseOrders/12345,
        "number": "12345"
    },
    "referenceNumber": "",
    "signature": {
        "signatory": "DELEGATE",
        "delegate": {
            "firstName": "Michael",
            "lastName": "Scott",
            "email": "cto@business.com"
        }
    },
    "state": "PROCESSING",
    "changeLog": {
        "createdBy": "joeAverage",
        "createdByFullName": "Joe Average",
        "createdByEmail": "joe@average.com",
        "createdDateTime": "2023-01-17T15:39:37.261928Z"
    },
    "number": "1-218336470113"
}

Response payload body description

Parameter	Description
href string	An absolute URL that returns the given order. Example: https://api.equinix.com/internetAccess/v1/orders/4b8df286-5562-41e2-8753-0379eecbe176
uuid string	Equinix Internet Access order identifier. Example: 4b8df286-5562-41e2-8753-0379eecbe176
type string	Order type. Possible values: AMENDMENT NEW
contacts array[object]	Data set contact information.
href string	An absolute URL that returns the given user. Example: https://api.equinix.com/access/v2/users/JoeAverage
type string	Contact information category. Possible values: NOTIFICATION - Notifications related to asset's lifecycle. TECHNICAL - Contact person for technical inquiries. ORDERING - Contact person for order-related inquiries. RESELLING - Contact person for service reselling-purposes BILLING - Contact person for billing-related inquiries.
registeredUser string	Registered user identifier. Example: JoeAverage
draft boolean	Indicates a draft order. Example: false
links array[object]	HATEOAS links specifying possible follow-up interactions.
purchaseOrder object	Purchase order information.
href string	An absolute URL that returns the given purchase order. Example: https://api.equinix.com/internetAccess/v1/accounts/12345/purchaseOrders/PO-123456789
number string	Purchase order number. Example: PO-1234
type string	Purchase order number. Example: STANDARD_PURCHASE_ORDER
referenceNumber string	Reference number for the Equinix Internet Access order. Example: 1234567
signature object	Purchase order type. Example: STANDARD_PURCHASE_ORDER
signatory string	Determines the party responsible for signing the order. Possible values: SELF - User placing the order will sign it. DELEGATE - Someone else will be responsible for signing the order.
delegate object	Signatory delegate contact information.
firstName string	First name of signatory delegate. Example: Joe
lastName string	Last name of signatory delegate. Example: Average
email string	Email address that the signature request is sent to. Example: joe@average.com
state string	Equinix Internet Access order status. Possible values: DRAFT PROCESSING AWAITING_SIGNATURE SIGNATURE_REJECTED SIGNATURE_EXPIRED COMPLETED FAILED
changeLog object	A permanent record of asset creation, modification, or deletion.
createdBy string	Username of the asset creator. Example: AverageJoe
createdByFullName string	First and last name of the asset creator. Example: Joe Average
createdByEmail string	Email address of the asset creator. Example: joe@average.org
createdDateTime string	Asset creation timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000 Example: 2021-07-15T19:30:29.526Z
updatedBy string	Username of the user that modified the asset. Example: AverageJoe
updatedByFullName string	First and last name of the user that modified the asset. Example: Joe Average
updatedByEmail string	Email address of the user that modified the asset. Example: joe@average.org
updatedDateTime string	Asset update timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000 Example: 2021-07-15T19:30:29.526Z
deletedBy string	Username of the user that modified the asset. Example: AverageJoe
deletedByFullName string	First and last name of the user that modified the asset. Example: Joe Average
deletedByEmail string	Email address of the user that modified the asset. Example: joe@average.org
deletedDateTime string	Asset update timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000 Example: 2021-07-15T19:30:29.526Z
tags array[string]	Additional order-related information. Example: Internet
number string	Equinix Internet Access order number. Example: 1-220955367152