Agendar Remessas

Todos os envios devem ser agendados com antecedência, criando um pedido de Remessa externa . A não observância dessa regra poderá resultar na rejeição do envio. Somente um usuário do Portal do Cliente Equinix (ECP) com permissão para pedindo Envios pode agendar esses envios. Os tipos de envios atualmente suportados pelas APIs do Portal do Cliente Equinix (ECP) podem ser encontrados aqui.

Pré-requisitos

Para obter detalhes da remessa, o usuário deve ter permissões de pedido de "Remessas".
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.
Para agendar um envio, você precisa determinar o ID exato da gaiola e o número da conta para o envio. Esses valores serão passados como parâmetros cageId e accountNumber no corpo da solicitação.
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.

Agendando uma Remessa de Entrada

Para agendar uma remessa de entrada, envie uma solicitação POST para [/colocations/v2/orders/shipments](/api-catalog/shipmentsv2/#tag/Shipments/operation/Schedule%20inbound%20 ou%20outbound%endpoint 20shipment). Use o parâmetro "type": "INBOUND" para especificar que se trata de uma remessa de entrada e forneça os demais 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 envio, a gaiola associada, a transportadora e o número de caixas. As demais informações necessárias que você precisa passar no corpo da 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 da sua organização, uma transportadora listada ou não listada. Se a sua transportadora não for DHL, FedEx ou UPS, ela não é listada.

Exemplo de solicitação cURL:

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

Neste cenário, sua Remessa interna é entregue à sua cage vinculada a apenas uma conta por alguém da sua organização. As informações mínimas necessárias para este cenário são passadas nesta solicitar 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",  
    "details": {  
    "carrier": "CUSTOMER_CARRIER",  
    "numberOfBoxes": 2  
    }  
}'

Exemplo de solicitação cURL:

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

observação

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

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

O pedido é criado com sucesso quando o código HTTP 201 e o cabeçalho de resposta são retornados. Não há corpo de resposta.

Se você deseja atualizar este pedido, consulte [/v2/orders/shipments/{orderId}](/api-catalog/shipmentsv2/#tag/Shipments/operation/Update%20inbound%20 ou%20outbound%20shipment) na seção de Referência da API para obter mais informações.

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

Agende uma remessa de saída

Para agendar um envio de saída, envie uma solicitação POST para [/colocations/v2/orders/shipments](/api-catalog/shipmentsv2/#tag/Shipments/operation/Schedule%20inbound%20 ou%20outbound%endpoint 20shipment). Use o parâmetro "type": "OUTBOUND" para especificar que se trata de um envio de saída e forneça os demais detalhes do envio no corpo da solicitação. Uma solicitação de envio de saída requer, no mínimo, o tipo de envio, a data de envio, a gaiola associada e a transportadora. As demais informações necessárias que você precisa passar no envio de saída são: O corpo da requisição depende do seguinte:

Se sua Remessa externa for de uma cage vinculada a várias contas.
Se a transportadora que entrega a remessa for da sua organização, uma transportadora listada ou não listada. Se a sua transportadora não for DHL, FedEx ou UPS, ela não é 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.

Neste cenário, sua Remessa externa é entregue à sua cage vinculada a apenas uma conta por alguém da sua organização. As informações mínimas necessárias para este cenário são passadas nesta solicitar 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",  
    "details": {  
    "carrier": "CUSTOMER_CARRIER"  
    ]  
    }  
}'

Exemplo de solicitação cURL:

Um envio de saída de uma gaiola associada a várias unidades que será entregue por uma transportadora não listada e requer A Equinix irá imprimir a etiqueta de envio. Os detalhes da etiqueta de envio estão anexados. Smart Hands adicionais Também estão incluídos pedidos, informações, detalhes de contato e anexos.

observação

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

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

O pedido é criado com sucesso quando o código HTTP 201 e o cabeçalho de resposta são retornados. Não há corpo de resposta.

Pré-requisitos​

Agendando uma Remessa de Entrada​

Agende uma remessa de saída​

Pré-requisitos

Agendando uma Remessa de Entrada

Agende uma remessa de saída