Récupérer l'historique des commandes
Préalable
Authentification: soumettez vos identifiants utilisateur, votre identifiant client et votre clé secrète pour l’authentification OAuth2. Consultez la documentation relative à l’authentification API (Authentification API) pour savoir comment appeler l’API OAuth afin de valider et d’authentifier vos identifiants.
Récupération de l'historique des commandes
Pour consulter votre historique de commandes, envoyez une requête POST à l'adresse [/colocations/v2/orders/{orderId}](/api-catalog/ordersv2/#tag/Orders/operation/GET%20Order%20 détails) point de terminaison.
Exemple de requête cURL:
Une requête d'historique des commandes a été effectuée pour les commandes Smart Hands soumises, liées à la personne-ressource pour la commande ou la notification dont le nom de famille est « smith », dans les IBX DC3 et DC4, en définissant la période concernée. à compter 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 requête sont propres à cet exemple. Pour obtenir la liste complète des paramètres et leurs descriptions, consultez la [Référence de l'API](/api-catalog/ordersv2/#tag/Orders/operation/GET%20Order%20 détails).
Exemple de requête cURL:
Une requête d'historique des commandes a été effectuée pour les commandes Smart Hands soumises, liées à la personne-ressource pour la commande ou la notification dont le nom de famille est « smith », dans les IBX DC3 et DC4, en définissant une plage de dates. entre deux dates précises.
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 requête sont propres à cet exemple. Pour obtenir la liste complète des paramètres et leurs descriptions, consultez la [Référence de l'API](/api-catalog/ordersv2/#tag/Orders/operation/GET%20Order%20 détails).
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 la réponse inclut les paramètres de configuration définis dans le corps de la requête. Pour obtenir la liste complète des paramètres possibles et leurs descriptions, consultez la [Référence de l'API](/api-catalog/ordersv2/#tag/Orders/operation/GET%20Order%20 détails).