Recuperar histórico de pedidos
Pré-requisitos
Autenticar - Envie suas credenciais de usuário, ID do Cliente e Segredo do Cliente para autenticação OAuth2. Consulte Autenticação de API para obter instruções sobre como chamar a API OAuth para validar e autenticar suas credenciais.
Recuperando o histórico de Pedido
Para recuperar seu histórico de pedidos, envie uma solicitação POST para /colocations/v2/orders/{orderId}.%20Order%20 detalhes) ponto final.
Exemplo de solicitação cURL:
Foi realizada uma consulta ao histórico de pedidos para pedidos Smart Hands submetidos, vinculados à pessoa de contato responsável pelo pedido ou notificação com o sobrenome "Smith" nos IBXs DC3 e DC4, definindo o intervalo de datas. a partir da data em que este pedido for submetido.
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"
}
Os parâmetros incluídos no corpo da requisição são específicos deste exemplo. Para obter uma lista completa dos parâmetros e suas descrições, consulte a Referência da API.%20Order%20 detalhes).
Exemplo de solicitação cURL:
Foi realizada uma consulta ao histórico de pedidos para pedidos Smart Hands submetidos, vinculados à pessoa de contato responsável pelo pedido ou notificação, cujo sobrenome é "Smith", nos IBXs DC3 e DC4, definindo um intervalo de datas. entre duas datas específicas.
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"
}
Os parâmetros incluídos no corpo da requisição são específicos deste exemplo. Para obter uma lista completa dos parâmetros e suas descrições, consulte a Referência da API.%20Order%20 detalhes).
Exemplo de resposta:
{
"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
}
}
A resposta inclui parâmetros de configuração definidos no corpo da requisição. Para obter uma lista completa dos parâmetros possíveis e suas descrições, consulte a Referência da API.%20Order%20 detalhes).