Saltar para o conteúdo principal
DELETE
Cancela um pedido de envio. Isto chama a API do operador logístico para cancelar o pedido e atualiza o estado do envio para cancelled. Cancelar um envio que já está cancelled devolve 200 com esse envio, e o operador só é chamado uma vez. A resposta inclui Idempotent-Replayed: true para poderes distinguir uma repetição da chamada que realizou a ação. Consulta Idempotência.
Não é possível cancelar envios após a recolha — isso devolve 409 Conflict.
Não é possível cancelar uma etiqueta de devolução da DHL isoladamente; isso também devolve 409 Conflict. Em vez disso, cancela a encomenda de ida. Cancelar uma encomenda de ida da DHL também cancela os respetivos registos de devolução pending. Cada um passa a cancelled com uma entrada RETURN_LEG_CANCELLED em status_updates. Consulta Etiquetas de devolução. Numa caixa com vários kits, cada kit tem o seu próprio registo de ida e a sua própria etiqueta de devolução, mesmo quando a caixa viaja com a etiqueta de apenas um kit. Cancelar o registo de ida de um kit também cancela a etiqueta de devolução desse kit. Para cancelar uma encomenda de kit para casa, todos os pedidos de kit para casa associados 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).

Resposta

Em caso de sucesso, a API devolve 200 OK com o objeto do envio cancelado.
string
obrigatório
Identificador de referência do envio.
string
obrigatório
Estado do ciclo de vida do envio. Será cancelled após um cancelamento bem-sucedido.
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 que estavam associadas a este envio antes do cancelamento. Cada entrada tem o formato { id, added_at }; cruza cada id com Obter marcação. Apenas 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