# Agendar Remessas Todas as remessas devem ser agendadas com antecedência, criando um pedido de remessa de entrada ou saída. Se isso não for feito, a remessa poderá ser rejeitada. Apenas um usuário Equinix Customer Portal com permissão de pedido de Remessas pode agendar essas remessas. Os tipos de remessas atualmente suportados pelas APIs da Equinix Customer Portal podem ser encontrados aqui. ## Pré-requisitos[​](#pré-requisitos "Link direto para Pré-requisitos") 1. Para obter os detalhes da remessa, o usuário deve ter `Shipments`permissõ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](https://docs.equinix.com/pt-BR/equinix-api/api-authentication.md) 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 do cage e o número da conta da remessa. Esses valores serão passados para os `cageId`parâmetros e `accountNumber`no corpo da solicitação. 4. Obter informações de localização - Envie uma `GET` solicitação ao [`/v1/orders/smarthands/locations`](https://docs.equinix.com/pt-BR/api-catalog/smarthandsv1/smarthands/getlocation.md) terminal 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[​](#agendando-uma-remessa-de-entrada "Link direto para Agendando uma Remessa de Entrada") ![](https://docs.equinix.com/pt-BR/assets/images/ScheduleInboundShipment-v2-d5af65c2680a6aea37f81b1b698a86fd.png) Para agendar uma Remessa de entrada, envie uma `POST` solicitação para o [`/colocations/v2/orders/shipments`](https://docs.equinix.com/pt-BR/api-catalog/shipmentsv2/shipments/schedule%20inbound%20or%20outbound%20shipment.md) endpoint. Use o `"type": "INBOUND"` parâmetro para especificar que se trata de 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, o cage associado, 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 da sua organização, de uma transportadora listada ou de uma transportadora não listada. Se a sua operadora não é DHL, FedEx, UPS, sua operadora não está listada. 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 da sua organização. As informações mínimas necessárias para este cenário são passadas nesta solicitação de exemplo. ``` curl -X POST "https://api.equinix.com/colocations/v2/orders/shipments" -H "content-type: application/json" -H "authorization: Bearer " -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 um cage associado a várias contas que será entregue por uma transportadora não listada. Outras solicitações, informações, detalhes de contato e anexos do Smart Hands também estão incluídos. > **Observação** > > Antes de criar um pedido com anexo, ligue para o [`Attachments File`](https://docs.equinix.com/pt-BR/api-catalog/attachmentsv1/attachments/createattachment.md) terminal. 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 " -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 um código HTTP de 201 é retornado e o cabeçalho de resposta é retornado. Não há corpo de resposta. Para atualizar este pedido, consulte [`/v2/orders/shipments/{orderId}`](https://docs.equinix.com/pt-BR/api-catalog/shipmentsv2/shipments/update%20inbound%20or%20outbound%20shipment.md) na seção Referência do API para obter mais informações. Para adicionar notas a este pedido, recuperar e responder negociações para este pedido, ou cancelar este pedido, consulte [Pedidos](https://docs.equinix.com/pt-BR/api-catalog/ordersv2/orders.md) na Seção de Referência API para obter mais informações. ## Agende uma remessa de saída[​](#agende-uma-remessa-de-saída "Link direto para Agende uma remessa de saída") ![](https://docs.equinix.com/pt-BR/assets/images/ScheduleOutboundShipment-v2-b917e877e1720215570527401150a9f0.png) Para agendar uma Remessa de saída, envie uma `POST` solicitação para o [`/colocations/v2/orders/shipments`](https://docs.equinix.com/pt-BR/api-catalog/shipmentsv2/shipments/schedule%20inbound%20or%20outbound%20shipment.md) terminal. Use o `"type": "OUTBOUND"` parâmetro para especificar que se trata de uma Remessa de Saída e forneça o restante dos detalhes da remessa no corpo da solicitação. Uma solicitação de remessa de saída exige, no mínimo, que o tipo de remessa, a data de remessa, o cage 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 da sua organização, de uma transportadora listada ou de uma transportadora não listada. Se a sua transportadora não for DHL, FedEx, UPS, a 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 da sua organização. As informações mínimas necessárias para este cenário são passadas nesta solicitação de exemplo. ``` curl -X POST "https://api.equinix.com/colocations/v2/orders/shipments" -H "content-type: application/json" -H "authorization: Bearer " -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 um cage associado 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. Outras solicitações, informações, detalhes de contato e anexos do Smart Hands também estão incluídos. > **Observação** > > Antes de criar um pedido com anexo, ligue para o [`Attachments File`](https://docs.equinix.com/pt-BR/api-catalog/attachmentsv1/attachments/createattachment.md) terminal. 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 " -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 um código HTTP de 201 é retornado e o cabeçalho de resposta é retornado. Não há corpo de resposta. Para atualizar este pedido, consulte [`/v2/orders/shipments/{orderId}`](https://docs.equinix.com/pt-BR/api-catalog/shipmentsv2/shipments/update%20inbound%20or%20outbound%20shipment.md) na seção Referência do API para obter mais informações. Para adicionar notas a este pedido, recuperar e responder negociações para este pedido, ou cancelar este pedido, consulte [Pedidos](https://docs.equinix.com/pt-BR/api-catalog/ordersv2/orders.md) na Seção de Referência API para obter mais informações.