Demander l'emplacement d'un colis

Conditions préalables

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

2. Récupérer le numéro de commande de votre envoi entrant - envoyez une requête GET au point de terminaison /colocations/v2/orders/{orderId} pour récupérer le numéro de commande d'un envoi entrant qui a déjà été programmé. Pour programmer un nouvel envoi entrant, envoyez une requête POST au point de terminaison /colocations/v2/orders/shipments. Pour planifier un envoi entrant, l'utilisateur doit avoir la permission Shipments. Vous pouvez sauter cette étape si vous avez déjà le numéro de commande de l'envoi entrant.

3. Pour obtenir les détails de Smart Hands, vous devez avoir l'autorisation de commander Smart Hands.

4. Obtenir les types de Smart Hands - Envoyez une requête GET au point de terminaison /v1/orders/smarthands/types pour obtenir tous les types de commandes Smart Hands. Vous pouvez sauter cette étape si vous connaissez déjà le type de commande Smart Hands.

5. Obtenir des informations sur la localisation - Envoyez une requête GET au point de terminaison /v1/orders/smarthands/locations pour récupérer les localisations IBX disponibles auxquelles vous avez accès. Vous pouvez sauter cette étape si vous connaissez déjà les informations de localisation.

Obtenir l'emplacement d'un colis

Pour demander la localisation de vos colis à l'IBX, envoyez une requête POST au point de terminaison /v1/orders/smarthands/locatePackage. Spécifiez les détails de vos paquets et de vos besoins dans l'objet serviceDetails dans le corps de la requête. Utilisez l'objet optionnel attachments pour inclure des détails supplémentaires pour un technicien.

note

Avant de créer une commande avec une pièce jointe, appelez le Fichier de pièces jointes.

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"  
    }  
  ]  
}'

Pour une liste complète des paramètres du corps et des descriptions, voir la référence API.

Exemple de réponse :

{  
  "OrderNumber": "1-457809872838"  
}

La réponse indique que la commande a abouti et renvoie le numéro de commande.