O endpoint /shipping/v1/ é usado para criar um envio de um cartão inominado. Tenha em mente que, para criar um envio, é requisito que você criado um lote de cartões inominados.

Considerações#

O campo região corresponde a:

• Província, na Argentina
• Estado, do Brasil
• Estado, na Colômbia
• Estado, no México

O campo courier.tracking_url da resposta estará disponível assim que o envio for informado pelo parceiro logístico correspondente. Até lá, terá valor nulo

Para o Brasil

• Se você opera no Brasil, o taxIdentificationNumber será sempre obrigatório.
• Os campos documentNumber e documentType não serão necessários.
• El campo additional_info no está disponible para su uso.
• Além disso, precisará preencher o campo da região com o código da UF de dois caracteres. Exemplo: 'SP' para São Paulo
  • Rondônia (RO)
  • Acre (AC)
  • Amazonas (AM)
  • Roraima (RR)
  • Pará (PA)
  • Amapá (AP)
  • Tocantins (TO)
  • Maranhão (MA)
  • Piauí (PI)
  • Ceará (CE)
  • Rio Grande do Norte (RN)
  • Paraíba (PB)
  • Pernambuco (PE)
  • Alagoas (AL)
  • Sergipe (SE)
  • Bahia (BA)
  • Minas Gerais (MG)
  • Espírito Santo (ES)
  • Rio de Janeiro (RJ)
  • São Paulo (SP)
  • Paraná (PR)
  • Santa Catarina (SC)
  • Rio Grande do Sul (RS)
  • Mato Grosso do Sul (MS)
  • Mato Grosso (MT)
  • Goiás (GO)
  • Distrito Federal (DF)

Para a Colômbia

• Se você opera na Colômbia, o campo zip_code é opcional, o que significa que você não pode enviá-lo.
• El campo additional_info no está disponible para su uso.

Para o México

El campo additional_info estará disponible únicamente para envíos que utilicen logística 99 Minutos.

Envio de tarjetas innominadas desde deposito#

Puedes asociar un envío con el usuario al que le enviarás la tarjeta especificando el user_id en el body del shipment.

O endpoint `/shipping/v1/ permite buscar um grupo de envios com base nos atributos especificados.

Você conseguirá aplicar filtros e classificar os envios seguindo esta documentação.

Os atributos que podem ser ordenados são:

• shipment_type
• status
• status_detail
• created_at

O endpoint /shipping/v1/{shipment_id} permite que você atualize o endereço de entrega de um envio.

Considerações#

Para actualizar la dirección de entrega, el envío debe tener como STATUS_DETAIL alguno de los siguientes valores según la transportadora:

Você não poderá criar outra solicitação de alteração de endereço para um envio enquanto houver uma pendente.

Para consultar o estado da solicitação, você precisará interagir com o endpoint Obter envio. No campo request_status, você verá um dos seguintes valores:

• PENDING_UPDATE_ADDRESS: aguardando a resposta da transportadora.
• CONFIRMED_UPDATE_ADDRESS: la transportadora nos confirmó el cambio de domicilio de envío.
• REJECTED_UPDATE_ADDRESS: a transportadora rejeitou a alteração de endereço do envio.

Se a sua solicitação for rejeitada, você continuará visualizando o endereço de envio original.

O endpoint /shipping/v1/{shipment_id} é utilizado para obtenção de informações sobre uma remessa específica.

Tem dúvidas sobre os status de envio? Explicamos o significado de cada um na nossa documentação.

Considerações#

Será preciso especificar o shipping_id para fazer a consulta.

Envios para um warehouse e em território mexicano:

Nos casos de envios para um warehouse e aqueles feitos dentro do México, não forneceremos um ID externo de rastreamento, mas não se preocupe! Vamos garantir que você fique atualizado sobre o status do envio através do Dashboard e também por meio de webhooks.

O endpoint /shipping/v1/{shipment_id}/history permite obter o histórico de estados de um envio específico.

Tem dúvidas sobre os status de envio? Explicamos o significado de cada um na nossa documentação.

Considerações#

Será preciso especificar o shipping_id para fazer a consulta.

A lista de eventos é ordenada em ordem ascendente por data de atualização, ou seja, o estado mais recente está no final da lista.

Você precisa incluir este endpoint em seu serviço para podermos enviar atualizações em tempo real sobre os envios.

Se tiver dúvidas sobre como configurar um webhook, visite nossa documentação.

Considerações#

• Nas novidades, vamos mantê-lo informado sobre quaisquer atualizações relacionadas a um envio. Apenas saiba que será responsável por obter o envio para verificar o status atualizado.
• Esperamos uma resposta na faixa 2XX para garantir que você tenha recebido a notificação. Caso contrário, iremos reenviá-la.

Encontre mais informações sobre o status dos envios na nossa documentação.

O endpoint /shipping/v1/{shipment_id}/receiver permite que você solicite os dados do destinatário que recebeu o envio.

Considerações#

Você não poderá criar uma solicitação enquanto houver uma pendente para o mesmo shipment_id.

Para consultar o estado da solicitação, você precisará interagir com o endpoint Obter envio. No campo request_status, você verá um dos seguintes valores:

• REQUESTED_RECEIVER_DATA: Aguardando a transportadora compartilhar os dados do destinatário do envio.
• GOT_RECEIVER_DATA: A transportadora compartilhou os dados do destinatário do envio conosco.
• MISSING_RECEIVER_DATA: a transportadora não conseguiu compartilhar conosco os dados do envio.

Para visualizar os dados do destinatário do cartão, interaja novamente com o endpoint Obter envio e leia o campo received_by localizado dentro de courier_additional_info.