Ir para o conteúdo principal

Solicitar localização do pacote

Pré-requisitos

  1. 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.

  2. Recupere o número do seu pedido de remessa de entrada - envie uma solicitação GET para [/colocations/v2/orders/{orderId}](/api-catalog/ordersv2/#tag/Orders/operation/GET%20Order%Para obter o número do pedido de uma remessa de entrada que já foi agendada, envie uma solicitação POST para o endpoint /colocations/v2/orders/shipments. Para agendar uma nova remessa de entrada, envie uma solicitação POST para o endpoint /api-catalog/shipmentsv2/#tag/Shipments/operation/Schedule.%20inbound%20 ou%20outbound%endpoint 20shipment). Para agendar uma remessa de entrada, o usuário deve ter a permissão Remessas. Você pode pular esta etapa se já tiver o número do pedido de remessa de entrada.

  3. Para obter detalhes sobre o Smart Hands, você precisa ter permissão para fazer pedidos do tipo "Smart Hands".

  4. Obtenha os tipos de pedidos Smart Hands - Envie uma solicitação GET para o endpoint /v1/orders/smarthands/types para obter todos os tipos de pedidos Smart Hands. Você pode pular esta etapa se já souber o tipo de pedido Smart Hands.

  5. Obter informações de localização - Envie uma solicitação GET para o endpoint /v1/orders/smarthands/locations para recuperar os locais IBX disponíveis aos quais você tem acesso. Você pode pular esta etapa se já souber as informações de localização.

Obtenha uma localização de pacote

Para solicitar a localização de suas encomendas no IBX, envie uma solicitação POST para o endpoint /v1/orders/smarthands/locatePackage. Especifique os detalhes de suas encomendas e necessidades no objeto serviceDetails no corpo da solicitação. Use o objeto opcional attachments para incluir detalhes adicionais para um técnico.

observação

Antes de criar um pedido com anexo, chame o endpoint Arquivo de anexos.

curl -X
POST "https://api.equinix.com/v1/orders/smarthands/locatePackage"
-H "content-type: application/json"
-H "authorization: Bearer <token>"
-d '{
    "ibxLocation": {
    "ibx": "AM1",
    "cages": [
      {
        "cage": "AM1:0J:00JD11",
        "cabinets": [
            "AM1:0J:00JD11:0001"
        ],
        "accountNumber": "126854"
      }
    ]
  },
  "serviceDetails": {
    "shipmentOrderNumber": "1-1234567890",
    "trackingNumber": "All tracking numbers in this shipment order.",
    "possibleLocation": "Last known location was the loading bay.",
    "packageDescription": "Multiple DHL boxes.",
    "scopeOfWork": "Locate and group all boxes together in a fixed location for easy identification and later collection.",
    "needSupportFromASubmarineCableStationEngineer": true
  },
  "attachments": [
    {
        "id": "fcb2k8763-2947-456e-8d68-f280753d60ba",
        "name": "AdditionalShipmentWorkDetails.docx"
    }
  ],
  "schedule": {
    "scheduleType": "SCHEDULED_MAINTENANCE",
    "requestedStartDate": "2019-08-30T22:00:49.776Z",
    "requestedCompletionDate": "2019-08-31T22:00:49.776Z"
  },
  "customerReferenceNumber": "EQX-PO2019-08-001",
  "purchaseOrder": {
    "purchaseOrderType": "EXEMPTED",
    "attachment": {
        "id": "abc1fd2e-345f-67g4-hi89-01jk234l5m6n",
        "name": "PurchaseOrderExemptionForm123.docx"
    }
  },
  "contacts": [
    {
        "contactType": "ORDERING",
        "userName": "johndoe"
    },
    {
        "contactType": "TECHNICAL",
        "name": "Jane Smith",
        "email": "janesmith@corporation.com",
        "workPhoneCountryCode": "+44",
        "workPhone": "0148211111",
        "workPhonePrefToCall": "MY_BUSINESS_HOURS",
        "workPhoneTimeZone": "Europe/London",
        "mobilePhoneCountryCode": "+44",
        "mobilePhone": "0123456789",
        "mobilePhonePrefToCall": "MY_BUSINESS_HOURS",
        "mobilePhoneTimeZone": "Europe/London"
    },
    {
        "contactType": "NOTIFICATION",
        "userName": "johndoe"
    },
    {
        "contactType": "NOTIFICATION",
        "userName": "janesmith"
    }
  ]
}'

Para obter uma lista completa dos parâmetros e descrições do corpo, consulte a Referência da API.

Exemplo de resposta:

{
  "OrderNumber": "1-457809872838"
}

A resposta indica que o pedido foi bem-sucedido e retorna o número do pedido.

Esta página foi útil?