Demander l'emplacement d'un colis

Conditions préalables
-
Authentifier - soumettre vos informations d'identification utilisateur, ID client et secret client pour l'authentification OAuth2. Reportez-vous à authentification API pour obtenir des instructions sur la façon d'appeler le API OAuth pour valider et authentifier vos informations d'identification.
-
Récupérer votre numéro de commande d'expédition entrante - envoyez une
GETdemande au/colocations/v2/orders/{orderId}point de terminaison pour récupérer un numéro de commande pour une expédition entrante qui a déjà été planifiée. Pour planifier une nouvelle expédition entrante, envoyez unePOSTdemande au/colocations/v2/orders/shipmentspoint de terminaison. Pour planifier une expédition entrante, l'utilisateur doit disposer d'Shipmentsune autorisation. Vous pouvez ignorer cette étape si vous avez déjà le numéro de commande d'expédition entrante. -
Pour obtenir les détails Smart Hands, vous devez disposer de
Smart Handsl'autorisation de commande. -
Get Smart Hands types - envoie une
GETdemande au/v1/orders/smarthands/typesnoeud final pour obtenir tous les types de commande Smart Hands. Vous pouvez ignorer cette étape si vous connaissez déjà le type de commande Smart Hands. -
Obtenir des informations sur l'emplacement : envoyez une
GETdemande au/v1/orders/smarthands/locationsnoeud final pour récupérer les emplacements IBX disponibles auxquels vous avez accès. Vous pouvez ignorer cette étape si vous connaissez déjà les informations de localisation.
Obtenir l'emplacement d'un colis
Pour demander l'emplacement de vos colis au IBX, envoyez une POST demande au /v1/orders/smarthands/locatePackagepoint de terminaison. Spécifiez les détails de vos packages et besoins dans l'serviceDetailsobjet dans le corps de la requête. Utilisez l'objet facultatif attachmentspour inclure des détails supplémentaires pour un technicien.
Avant de créer une commande avec pièce jointe, appelez le Attachments File noeud final.
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 corporels 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.