Passer au contenu principal

Récupérer l'historique des commandes

Trois étapes pour récupérer l'historique des commandes

Conditions préalables​

Authentifier - envoyez vos identifiants utilisateur, votre identifiant client et votre secret client pour l'authentification OAuth2. Pour obtenir des instructions sur la façon d'appeler l'API OAuth pour valider et authentifier vos identifiants, reportez-vous à authentification API.

Récupération de l'historique des commandes​

Pour récupérer l'historique de vos commandes, envoyez une POST demande au point de terminaison/colocations/v2/orders/{orderId}.

Exemple de requête cURL :

Une demande d'historique des commandes a été effectuée pour les commandes Smart Hands envoyées liées à la personne de contact de commande ou de notification ayant le nom de famille smithdans les datacentres IBX DC3 et DC4 et définissant la plage de dates à partir de la date de soumission de cette demande.

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"
}

Les paramètres inclus dans le corps de la demande sont spécifiques à cet exemple. Pour obtenir la liste complète des paramètres et leurs descriptions, reportez-vous à la référence API .

Exemple de requête cURL :

Une demande d'historique des commandes a été effectuée pour les commandes Smart Hands soumises liées à la personne de contact de commande ou de notification avec le nom de famille smithdans IBX DC3 et DC4 et définissant une plage de dates comprise entre deux dates spécifiques.

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"
}

Les paramètres inclus dans le corps de la demande sont spécifiques à cet exemple. Pour obtenir la liste complète des paramètres et leurs descriptions, reportez-vous à la référence API .

Exemple de réponse :

{
    "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
    }
}

La charge utile de réponse comprend les paramètres de configuration définis dans le corps de la demande. Pour obtenir la liste complète des paramètres possibles et leurs descriptions, reportez-vous à la référence API .

Cette page vous a-t-elle été utile ?