v1

latestOpenAPI 3.0.02026-07-24102197.9 KB
PackageCancelAPI

Cancelar envio

post/v1/companies/{company_id}/packages/cancel

Path parameters

company_idstring required

Código numérico fornecido pela Loggi para identificação.

Query parameters

loggi_keystring

Código único gerado pela Loggi, ou seja, cada pacote deve ter um loggi_key único.

tracking_codestring

Código de rastreio do pacote, que é gerado pela Loggi ou pelo parceiro por meio da API de envio.

Response

Pacote cancelado com sucesso

warning_typestring

Mensagem com a constante que identifica casos em que o cancelamento não pode ser confirmado.

warning_messagestring

Mensagem de alerta para casos em que o cancelamento não pode ser confirmado.

Example response

{
  "warning_type": "REDISPATCH_CANCELLATION",
  "warning_message": "O pacote está com os correios. Vamos tentar cancelar e devolver pra você."
}