Ir para o conteúdo principal

Recuperar histórico de pedidos

Três etapas para recuperar o 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 API para obter instruções sobre como chamar o OAuth API para validar e autenticar suas credenciais.

Recuperando o histórico de Pedido​

Para recuperar seu histórico de pedidos, envie uma POST solicitação para o terminal/colocations/v2/orders/

Exemplo de solicitação cURL:

Foi feita uma solicitação de histórico de pedidos para pedidos Smart Hands enviados vinculados à pessoa de contato de pedidos ou notificação com sobrenome smithnos data centers IBX DC3 e DC4 e definindo o intervalo de datas a partir da data em que essa solicitação é enviada.

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 solicitação são específicos deste exemplo. Para obter uma lista completa de parâmetros e suas descrições, consulte a Referência API .

Exemplo de solicitação cURL:

Foi feita uma solicitação de histórico de pedidos para pedidos Smart Hands enviados vinculados à pessoa de contato de pedido ou notificação com sobrenome smithno IBXs DC3 e DC4 e 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 solicitação são específicos deste exemplo. Para obter uma lista completa de parâmetros e suas descrições, consulte a Referência API .

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

O payload de resposta inclui parâmetros de configuração definidos no corpo da solicitação. Para obter uma lista completa dos parâmetros possíveis e suas descrições, consulte a Referência API .

Esta página foi útil?