Saltar para o conteúdo principal
PATCH
Atualiza os detalhes do envio, como o horário de recolha, o número de pacotes ou as notas. Se algum campo relevante para a logística mudar (data de recolha, hora, número de pacotes ou peso), o pedido logístico existente é cancelado e é criado um novo automaticamente. Os campos que omitires mantêm-se a partir do envio existente. Os campos de horário atualizados são validados segundo as regras de agendamento de recolha.
Os envios não podem ser alterados após a recolha. Tentar atualizar um envio que já foi recolhido devolve 409 Conflict.
Um pacote de kit de teste em casa já tem a etiqueta impressa, por isso só notes pode mudar. Uma nova janela de recolha ou peso num pacote de kit de teste em casa devolve 409 Conflict; cancela-o e cria um novo envio em vez disso. Para atualizar um pacote de kit de teste em casa, todas as encomendas de kit de teste em casa associadas têm de estar no teu contexto de acesso. Caso contrário, a chamada devolve 403. Consulta Acesso.

Pedido

Parâmetros de caminho

string
obrigatório
ID de referência do envio (por ex., P2611194821).

Parâmetros do corpo

Todos os parâmetros do corpo são opcionais — inclui apenas os campos que queres alterar.
string
Nova data de recolha no formato YYYY-MM-DD, interpretada no fuso horário do local de origem.
string
Nova hora mais cedo para a recolha no formato HH:MM, interpretada como hora local no fuso horário do local de origem.
string
Nova hora mais tarde para a recolha no formato HH:MM, interpretada como hora local no fuso horário do local de origem.
integer
Novo número de pacotes.
number
Novo peso em kg.
string
Novas notas ou observações. Máximo de 128 caracteres.

Resposta

Em caso de sucesso, a API devolve 200 OK com o envio atualizado.
string
obrigatório
Identificador de referência do envio.
string
obrigatório
Estado do ciclo de vida do envio. Um dos seguintes: pending, in_transit, delivered, fault ou cancelled.
string
obrigatório
Operador logístico. Um de go, dhl_parcel, dhl_warenpost, rotrunner, rapido, ups ou dhl_express. Uma encomenda de kit para casa é dhl_parcel, ou dhl_warenpost quando segue para o estrangeiro como Warenpost International.
string
Número de seguimento externo do operador logístico. Pode ser null.
string
Descrição em texto livre do conteúdo da encomenda, conforme indicado na criação. Pode ser null.
string
obrigatório
Quem imprimiu a etiqueta: aniva ou external. Apenas os envios aniva aceitam esta chamada.
string
Referência da outra encomenda de uma remessa com duas encomendas. null para uma encomenda só de ida.
object
Morada de recolha. Pode ser null.
object
Morada de entrega. Mesma estrutura que origin. Pode ser null.
object
Janela de recolha agendada. Pode ser null.
string
Notas opcionais. Pode ser null.
object[]
obrigatório
Eventos cronológicos do ciclo de vida do operador logístico (mais antigos primeiro). Cada entrada tem state, code, detail_code, status, description, location e time. Consulta Obter envio para cada campo. Array vazio se ainda não houver eventos registados.
ShipmentAppointmentLink[]
obrigatório
Marcações associadas a este envio, pela ligação mais antiga primeiro. Cada entrada é { id, added_at }; cruza cada id com Obter marcação. Só são listadas as marcações no teu contexto de acesso.
ShipmentHomeKitOrderLink[]
obrigatório
Pedidos de kits para casa associados a este envio, da associação mais antiga para a mais recente, no mesmo formato { id, added_at }. Apenas são listados os pedidos no teu contexto de acesso. Array vazio para encomendas de clínicas.
string
Quando o envio foi reconciliado pela última vez com a transportadora, como instante UTC. null até à primeira sincronização.
string
obrigatório
Data e hora de criação (ISO 8601).
string
Data e hora da última atualização (ISO 8601). Pode ser null.

Respostas de erro