注文履歴の取得

必須条件

Authenticate - OAuth2認証のためのユーザー認証情報、クライアントID、クライアントシークレットを送信します。OAuth APIを呼び出して認証情報を検証および認証する方法については、API Authenticationを参照してください。

注文履歴の取得

注文履歴を取得するには、/colocations/v2/orders/{orderId}エンドポイントに POST リクエストを送信します。

サンプルcURLリクエスト：

IBX DC3 および DC4 の注文または通知担当者の姓が smith で、この要求が送信された日付からの日付範囲を定義する、送信された Smart Hands 注文にリンクする注文履歴の要求が行われました。

curl -X  
POST "https://api.equinix.com/v1/retrieve-orders"  
-H "content-type: application/json"  
-H "authorization: Bearer <token>"  
-d '{  
    "filters": {  
    "orderStatus": [  
        "SUBMITTED",  
        "IN_PROGRESS"  
    ],  
    "productTypes": [  
        "SMART_HANDS"  
    ],  
    "ibxs": [  
        "DC3",  
        "DC4"  
        ],  
        "dateRange": "PAST_YEAR"  
    },  
    "sorts": [  
        {  
            "name": "CREATED_ON",  
            "direction": "DESC"  
        }  
    ],  
    "source": [  
        "CONTACT_LAST_NAME"  
    ],  
    "page": {  
        "number": 0,  
        "size": 1  
    },  
    "q": "smith"  
}

リクエストボディに含まれるパラメータは、この例に特有のものです。パラメータの完全なリストとその説明については、APIリファレンスを参照してください。

サンプルcURLリクエスト：

IBX の DC3 および DC4 で名字が「smith`」の注文または通知担当者にリンクされ、2 つの特定の日付の間の日付範囲を定義している送信済みの Smart Hands 注文について、注文履歴の要求が行われました。

curl -X  
POST "https://api.equinix.com/v1/retrieve-orders"  
-H "content-type: application/json"  
-H "authorization: Bearer <token>"  
-d '{  
    "filters": {  
    "orderStatus": [  
        "SUBMITTED",  
        "IN_PROGRESS"  
    ],  
    "productTypes": [  
        "SMART_HANDS"  
    ],  
    "ibxs": [  
        "DC3",  
        "DC4"  
     ],  
     "fromDate": "09/02/2019",  
     "toDate": "09/15/2019"  
    },  
    "sorts": [  
     {  
        "name": "CREATED_ON",  
        "direction": "DESC"  
     }  
    ],  
    "source": [  
        "CONTACT_LAST_NAME"  
    ],  
    "page": {  
        "number": 0,  
        "size": 1  
    },  
    "q": "smith"  
}

回答例

{  
    "links": [  
        {  
            "rel": "self",  
            "href": "https://api.equinix.com/v1/orders-history/"  
        },  
        {  
            "rel": "next",  
            "href": "https://api.equinix.com/v1/orders-history/?page=1"  
        }  
    ],  
    "content": [  
        {  
            "orderNumber": "1-190123456789",  
            "createdAt": "2019-09-17T22:49:34Z",  
            "orderStatus": "SUBMITTED",  
            "orderSource": "Portal",  
            "account": {  
                "accountName": "John Doe Corp",  
                "accountNumber": "12345"  
            },  
            "uiMetaData": {  
                "pricingEnforcementFlag": "false"  
            },  
            "orderingContacts": {  
                "firstName": "James",  
                "lastName": "Smith",  
                "workPhone": "(972) 123-4567",  
                "contactUCId": "234432",  
                "username": "JSmith123",  
                "emailAddress": "jsmith@johndoecorp.com"  
            },  
            "notificationContacts": [  
                {  
                "phone": "972-890-1234",  
                "workPhone": "972-123-4567",  
                "lastName": "Smith",  
                "firstName": "James",  
                "contactUCId": "234432",  
                "emailAddress": "jsmith@johndoecorp.com",  
                "username": "JSmith123"  
                }  
            ],  
            "ibx": [  
                "PAA"  
            ],  
            "type": [  
                "Smart Hands"  
            ],  
            "customerReferenceNumber": "RQT12345",  
            "poNumbers": [  
                "1-1007"  
            ],  
            "piiHoldFlag": false,  
            "technicalContacts": [  
                {  
                "firstName": "James",  
                "lastName": "Smith",  
                "workPhone": "(972) 123-4567",  
                "contactUCId": "234432",  
                "username": "JSmith123",  
                "emailAddress": "jsmith@johndoecorp.com"  
                }  
            ],  
            "pendingCustomerInputFlag": false,  
            "awaitingCustomerResponse": false,  
            "srNumber": "9-191234567890",  
            "cancellable": true,  
            "modifiable": true,  
            "links": [  
                {  
                "rel": "orderFullDetails",  
                "href": "https://api.equinix.com/v1/orders-history/1-190123456789"  
                }  
            ]  
        }  
    ],  
    "page": {  
        "size": 1,  
        "totalElements": 19,  
        "totalPages": 19,  
        "number": 0  
    }  
}

レスポンスペイロードには、リクエストボディで定義された設定パラメータが含まれます。使用可能なパラメータの完全なリストとその説明については、APIリファレンスを参照してください。

必須条件​

注文履歴の取得​

必須条件

注文履歴の取得