Pular para o conteúdo principal

Agendar Remessas

Todas as remessas devem ser programadas com antecedência, criando um pedido de remessa de entrada ou saída. Se isso não for feito, a remessa poderá ser rejeitada. Somente um usuário do Equinix Customer Portal com permissão de pedidos de Remessas pode programar essas remessas. Os tipos de remessas atualmente suportados pelas APIs do Equinix Customer Portal podem ser encontrados aqui.

Pré-requisitos​

  1. Para obter detalhes da remessa, o usuário deve ter Shipmentspermissões de pedido.

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

  3. Para agendar uma remessa, você precisa determinar o ID exato da gaiola e o número da conta para a remessa. Esses valores serão passados para os cageIdparâmetros e accountNumberno corpo da solicitação.

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

Agendando uma Remessa de Entrada​

Para agendar uma Remessa de Entrada, envie uma POST solicitação para o /colocations/v2/orders/shipments endpoint. Use o "type": "INBOUND" parâmetro para especificar que é uma Remessa de Entrada e forneça o restante dos detalhes da remessa no corpo da solicitação. Uma solicitação de remessa de entrada requer, no mínimo, o tipo de remessa, a data de remessa, a gaiola associada, a transportadora e o número de caixas a serem incluídos. As outras informações necessárias que você precisa passar no corpo de solicitação de remessa de entrada dependem do seguinte:

  • Se sua Remessa interna for de uma cage vinculada a várias contas.
  • Se a transportadora que entrega a remessa for de sua organização, de uma transportadora listada ou de uma transportadora não listada. Se o seu transportador não é DHL, Fedex, UPS, seu transportador não está listado.

Exemplo de solicitação cURL:

Uma Remessa interna de uma cage associada a uma única conta que será entregue pela sua organização.

Para esse cenário, sua remessa de entrada é entregue em seu CAGE vinculada a apenas uma conta por alguém de sua organização. As informações mínimas necessárias para este cenário são passadas nesta solicitação de amostra.

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

Exemplo de solicitação cURL:

Uma remessa de entrada de uma gaiola associada a várias contas que será entregue por uma transportadora não listada. Solicitações adicionais de Smart Hands, informações, detalhes de contato e anexos também estão incluídos.

observação

Antes de criar um pedido com anexo, chame o Attachments File endpoint.

Neste cenário, você forneceu as informações mínimas necessárias para facilitar uma Remessa interna e incluiu parâmetros de corpo adicionais que suporte ao seguinte:

  • solicitar adicional da Smart Hands para entregar a remessa em sua cage
  • descrição adicional
  • anexos de suporte
  • seu próprio identificador de referência
  • informações do pedido de compra
  • informações de contato para notificação ou pessoas de contato técnico

Todos os parâmetros corporais disponíveis e aplicáveis são passados nesta solicitação de exemplo.

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

A ordem é criada com sucesso quando um código HTTP de 201 é retornado e o cabeçalho de resposta é retornado. Não há corpo de resposta.

Se você quiser atualizar este pedido, consulte /v2/orders/shipments/{orderId} na seção Referência do API para obter mais informações.

Se você quiser adicionar notas a este pedido, recuperar e responder negociações para este pedido ou cancelar este pedido, consulte Pedidos na Seção de Referência do API para obter mais informações.

Agende uma remessa de saída​

Para programar uma Remessa de Saída, envie uma POST solicitação para o /colocations/v2/orders/shipments endpoint. Use o "type": "OUTBOUND" parâmetro para especificar que é uma Remessa de Saída e forneça o restante dos detalhes da remessa no corpo da solicitação. Uma solicitação de envio de saída exige, no mínimo, que o tipo de envio, a data de envio, o compartimento associado e a transportadora sejam incluídos. As outras informações necessárias que você precisa passar no corpo de solicitação de remessa de saída dependem do seguinte:

  • Se sua Remessa externa for de uma cage vinculada a várias contas.
  • Se a transportadora que entrega a remessa for de sua organização, de uma transportadora listada ou de uma transportadora não listada. Se a sua transportadora não é DHL, FedEx, UPS, sua transportadora não está listada.
  • Se você precisar que uma etiqueta de remessa seja impressa pela Equinix.

Exemplo de solicitação cURL:

Uma Remessa externa de uma cage associada a uma única conta que será entregue por alguém da sua organização.

Para esse cenário, sua remessa de saída é entregue em seu CAGE vinculado a apenas uma conta por alguém de sua organização. As informações mínimas necessárias para este cenário são passadas nesta solicitação de amostra.

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

Exemplo de solicitação cURL:

Uma remessa de saída de uma gaiola associada a várias contagens que será entregue por uma transportadora não listada e requer que a Equinix imprima a etiqueta de envio. Os detalhes relevantes da etiqueta de envio são fornecidos como um anexo. Solicitações adicionais de Smart Hands, informações, detalhes de contato e anexos também estão incluídos.

observação

Antes de criar um pedido com anexo, chame o Attachments File endpoint.

Neste cenário, você forneceu as informações mínimas necessárias para facilitar uma solicitar de Remessa externa e incluiu parâmetros de corpo adicionais que suporte ao seguinte:

  • valor de remessa declarado em uma moeda diferente de USD
  • solicitações adicionais da Smart Hands para retirar sua remessa de sua cage ou para segurá-la
  • descrição adicional
  • anexos de suporte
  • seu próprio identificador de referência
  • informações do pedido de compra
  • informações de contato para notificação ou pessoas de contato técnico

Todos os parâmetros corporais disponíveis e aplicáveis são passados nesta solicitação de exemplo.

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

A ordem é criada com sucesso quando um código HTTP de 201 é retornado e o cabeçalho de resposta é retornado. Não há corpo de resposta.

Se você quiser atualizar este pedido, consulte /v2/orders/shipments/{orderId} na seção Referência do API para obter mais informações.

Se você quiser adicionar notas a este pedido, recuperar e responder negociações para este pedido ou cancelar este pedido, consulte Pedidos na Seção de Referência do API para obter mais informações.

Esta página foi útil?