Passer au contenu principal

Planifier les expéditions

Toutes les expéditions doivent être planifiées à l'avance en créant une commande d'expédition entrante ou sortante. Le non-respect de cette consigne peut entraîner le rejet de l'envoi. Seul un utilisateur Equinix Customer Portal disposant de l'autorisation de commander des expéditions peut planifier ces expéditions. Les types d'envois actuellement pris en charge par les API Equinix Customer Portal peuvent être trouvés ici.

Conditions préalables​

  1. Pour obtenir les détails de l'expédition, l'utilisateur doit disposer Shipmentsdes autorisations de commande.

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

  3. Pour planifier une expédition, vous devez déterminer l'ID de cage et le numéro de compte exacts pour l'expédition. Ces valeurs seront transmises pour les cageIdparamètres et accountNumberdans le corps de la requête.

  4. Obtenir des informations sur l'emplacement : envoyez une GET demande 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.

Planification d'une expédition entrante​

Pour planifier une expédition entrante, envoyez POSTune demande au /colocations/v2/orders/shipmentspoint de terminaison. Utilisez le "type": "INBOUND" paramètre pour indiquer qu'il s'agit d'une expédition entrante et fournissez le reste des détails de l'expédition dans le corps de la demande. Une demande d'expédition entrante nécessite au minimum le type d'expédition, la date d'expédition, la cage associée, le transporteur et le nombre de boîtes à inclure. Les autres informations nécessaires que vous devez transmettre au corps de demande d'expédition entrante dépendent des éléments suivants :

  • Si votre envoi entrant provient d'une cage liée à plusieurs comptes.
  • Si le transporteur qui livre l'envoi provient de votre organisation, d'un transporteur listé ou non listé. Si votre transporteur n'est pas DHL, FedEx, UPS, votre transporteur n'est pas répertorié.

Exemple de requête cURL:

Un envoi entrant provenant d'une cage associée à un seul compte qui sera livré par votre organisation.

Pour ce scénario, votre envoi entrant est livré à votre cage liée à un seul compte par un membre de votre organisation. Les informations minimales requises pour ce scénario sont transmises dans cette demande d'exemple.

curl -X  
POST "https://api.equinix.com/colocations/v2/orders/shipments"  
-H "content-type: application/json"  
-H "authorization: Bearer <token>"  
-d '{  
    "type": "INBOUND",  
    "requestedDateTime": "2020-11-02T10:45:41Z",  
    "cageId": "AM1:01:000111",  
    "details": {  
    "carrier": "CUSTOMER_CARRIER",  
    "numberOfBoxes": 2  
    }  
}'

Exemple de requête cURL:

Envoi entrant provenant d'une cage associée à plusieurs comptes et livré par un transporteur non répertorié. Des demandes Smart Hands supplémentaires, des informations, des coordonnées et des pièces jointes sont également incluses.

remarque

Avant de créer une commande avec pièce jointe, appelez le Attachments File noeud final.

Dans ce scénario, vous avez fourni les informations minimales requises pour faciliter une expédition entrante et inclus des paramètres de corps supplémentaires qui prennent en charge les éléments suivants:

  • demande supplémentaire de Smart Hands pour livrer l'envoi à votre cage
  • description supplémentaire
  • pièces jointes de soutien
  • votre propre identifiant de référence
  • informations sur le bon de commande
  • coordonnées pour les personnes à contacter en cas de notification ou pour les contacts techniques

Tous les paramètres corporels disponibles et applicables sont transmis dans cet exemple de demande.

curl -X  
POST "https://api.equinix.com/colocations/v2/orders/shipments"  
-H "content-type: application/json"  
-H "authorization: Bearer <token>"  
-d '{  
    "type": "INBOUND",  
    "requestedDateTime": "2020-11-02T10:45:41Z",  
    "cageId": "AM1:01:000111",  
    "accountNumber": 901011,  
    "details": {  
        "carrier": "OTHER",  
        "carrierName": "New Carrier",  
        "numberOfBoxes": 2,  
        "carrierTrackingNumbers": [  
            "t1Z294AK92654678989",  
            "t1Z086DK96424456780"  
        ],  
        "cageDelivery": true  
    },  
    "description": "Package is fragile and heavy. Handle with care. Additional description in attachment.",  
    "attachments": [  
        {  
            "id": "85d9660a-f877-405a-b38e-8e61a4f77f44",  
            "name": "OrderInstructions.docx"  
        }  
    ],   
    "customerReferenceId": "2020/16347",  
        "purchaseOrder": {  
        "type": "NEW",  
        "number": "9654284",  
        "amount": "10000",  
        "startDate": "2020-10-01",  
        "endDate": "2021-09-30",  
        "attachmentId": "56d10de6-f2c0-4edd-ba29-b70736aa2093"  
    },  
    "contacts": [  
    {  
        "type": "NOTIFICATION",  
        "registeredUsers": [  
            "john_doe1",  
            "jane_smith1"  
        ]  
    },  
    {  
        "type": "TECHNICAL",  
        "firstName": "John",  
        "lastName": "Doe",  
        "availability": "WORK_HOURS",  
        "timezone": "America/Los_Angeles",  
        "details": [  
            {  
                "type": "EMAIL",  
                "value": "johndoe@acme.com""  
            },  
            {  
                "type": "PHONE",  
                "value": "+1-987654321"  
            },  
            {  
                "type": "MOBILE",  
                "value": "+1-912345678"  
            }  
        ]  
    }  
  ]  
}'

La commande est créée avec succès lorsqu'un code HTTP de 201 est renvoyé et que l'en-tête de réponse est renvoyé. Il n'y a pas de corps de réponse.

Si vous souhaitez mettre à jour cette commande, reportez-vous à /v2/orders/shipments/{orderId} la section référence API pour plus d'informations.

Si vous souhaitez ajouter des notes à cette commande, récupérer et répondre aux négociations pour cette commande, ou annuler cette commande, voir commandes dans la section référence API pour plus d'informations.

Planifier une expédition sortante​

Pour planifier une expédition sortante, envoyez POSTune demande au /colocations/v2/orders/shipmentspoint de terminaison. Utilisez le "type": "OUTBOUND" paramètre pour indiquer qu'il s'agit d'une expédition sortante et fournissez le reste des détails de l'expédition dans le corps de la demande. Une demande d'expédition sortante nécessite au minimum d'inclure le type d'expédition, la date d'expédition, la cage associée et le transporteur. Les autres informations nécessaires que vous devez transmettre au corps de demande d'expédition sortante dépendent des éléments suivants :

  • Si votre envoi sortant provient d'une cage liée à plusieurs comptes.
  • Si le transporteur qui livre l'envoi provient de votre organisation, d'un transporteur listé ou non listé. Si votre transporteur n'est pas DHL, FedEx, UPS, votre transporteur n'est pas répertorié.
  • Si vous souhaitez qu'une étiquette d'expédition soit imprimée par Equinix.

Exemple de requête cURL:

Un envoi sortant d'une cage associée à un seul compte qui sera livré par une personne de votre organisation.

Pour ce scénario, votre envoi sortant est livré à votre cage liée à un seul compte par un membre de votre organisation. Les informations minimales requises pour ce scénario sont transmises dans cette demande d'exemple.

curl -X  
POST "https://api.equinix.com/colocations/v2/orders/shipments"  
-H "content-type: application/json"  
-H "authorization: Bearer <token>"  
-d '{  
    "type": "OUTBOUND",  
    "requestedDateTime": "2020-11-02T10:45:41Z",  
    "cageId": "AM1:01:000111",  
    "details": {  
    "carrier": "CUSTOMER_CARRIER"  
    ]  
    }  
}'

Exemple de requête cURL:

Expédition sortante à partir d'une cage associée à plusieurs comptages qui sera livrée par un transporteur non répertorié et qui nécessite que Equinix imprime l'étiquette d'expédition. Les détails de l'étiquette d'expédition correspondante sont fournis en pièce jointe. Des demandes Smart Hands supplémentaires, des informations, des coordonnées et des pièces jointes sont également incluses.

remarque

Avant de créer une commande avec pièce jointe, appelez le Attachments File noeud final.

Dans ce scénario, vous avez fourni les informations minimales requises pour faciliter une demande d'expédition sortante et inclus des paramètres de corps supplémentaires qui prennent en charge les éléments suivants:

  • valeur d'expédition déclarée dans une devise autre que l'USD
  • demandes supplémentaires de Smart Hands pour récupérer votre envoi dans votre cage ou pour l'assurer
  • description supplémentaire
  • pièces jointes de soutien
  • votre propre identifiant de référence
  • informations sur le bon de commande
  • coordonnées pour les personnes à contacter en cas de notification ou pour les contacts techniques

Tous les paramètres corporels disponibles et applicables sont transmis dans cet exemple de demande.

curl -X  
POST "https://api.equinix.com/colocations/v2/orders/shipments"  
-H "content-type: application/json"  
-H "authorization: Bearer <token>"  
-d '{  
    "type": "OUTBOUND",  
    "requestedDateTime": "2020-11-02T10:45:41Z",  
    "cageId": "AM1:01:000111",  
    "accountNumber": 901011,  
    "details": {  
    "carrier": "OTHER",  
    "carrierName": "New Carrier",  
    "numberOfBoxes": 2,  
    "declaredValue": 1000,  
    "declaredValueCurrency": "EUR",  
    "carrierTrackingNumbers": [  
        "t1Z294AK92654678989",  
        "t1Z086DK96424456780"  
    ],  
        "shipmentLabelRequired": true,  
        "shipmentAttachmentId": "f49891fc-d9a5-4b4b-bc65-150b1c5e6dff",  
        "requirePickup": true,  
        "insureShipment": true  
    },  
    "description": "Package is fragile and heavy. Handle with care. Additional description in attachment.",  
    "attachments": [  
    {  
        "id": "85d9660a-f877-405a-b38e-8e61a4f77f44",  
        "name": "OrderInstructions.docx"  
    }  
    ],  
    "customerReferenceId": "2020/16347",  
    "purchaseOrder": {  
        "type": "NEW",  
        "number": "9654284",  
        "amount": "10000",  
        "startDate": "2020-10-01",  
        "endDate": "2021-09-30",  
        "attachmentId": "56d10de6-f2c0-4edd-ba29-b70736aa2093"  
    },  
    "contacts": [  
    {  
        "type": "NOTIFICATION",  
        "registeredUsers": [  
            "john_doe1",  
            "jane_smith1"  
        ]  
    },  
    {  
        "type": "TECHNICAL",  
        "firstName": "John",  
        "lastName": "Doe",  
        "availability": "WORK_HOURS",  
        "timezone": "America/Los_Angeles",  
        "details": [  
            {  
                "type": "EMAIL",  
                "value": "johndoe@acme.com"  
            },  
            {  
                "type": "PHONE",  
                "value": "+1-987654321"  
            },  
            {  
                "type": "MOBILE",  
                "value": "+1-912345678"  
            }  
        ]  
    }  
  ]  
}'

La commande est créée avec succès lorsqu'un code HTTP de 201 est renvoyé et que l'en-tête de réponse est renvoyé. Il n'y a pas de corps de réponse.

Si vous souhaitez mettre à jour cette commande, reportez-vous à /v2/orders/shipments/{orderId} la section référence API pour plus d'informations.

Si vous souhaitez ajouter des notes à cette commande, récupérer et répondre aux négociations pour cette commande, ou annuler cette commande, voir commandes dans la section référence API pour plus d'informations.

Cette page vous a-t-elle été utile ?