Récupérer l'historique des commandes
Conditions préalables
Authentifier - Soumettez vos informations d'identification de l'utilisateur, l'ID du client et le secret du client pour l'authentification OAuth2. Reportez-vous à API Authentication pour savoir comment appeler l'API OAuth afin de valider et d'authentifier vos informations d'identification.
Récupération de l'historique des commandes
Pour récupérer l'historique de votre commande, envoyez une requête POST au point de terminaison /colocations/v2/orders/{orderId}.
Exemple de requête cURL :
Une demande d'historique de commande 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 smith dans les IBX DC3 et DC4 et définissant la plage de dates à partir de la date à laquelle cette demande est soumise.
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 spécifiques à cet exemple. Pour obtenir la liste complète des paramètres et leur description, consultez la [Référence API] (/api-catalog/ordersv2/#tag/Orders/operation/GET%20Order%20details).
Exemple de requête cURL :
Une demande d'historique de commande 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 smith dans les IBX DC3 et DC4 et définissant une plage de dates 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 requête sont spécifiques à cet exemple. Pour obtenir la liste complète des paramètres et leur description, consultez la [Référence API] (/api-catalog/ordersv2/#tag/Orders/operation/GET%20Order%20details).
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 comprend les paramètres de configuration définis dans le corps de la demande. Pour obtenir une liste complète des paramètres possibles et leur description, consultez la [Référence API] (/api-catalog/ordersv2/#tag/Orders/operation/GET%20Order%20details).