Sign in

v1

latestOpenAPI 3.0.02026-07-24102197.9 KB
PackageUpdateAPI

Atualizar dados de um pacote

patch/v1/companies/{company_id}/packages

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.

Request body

Example request

{
  "package": {
    "updateMask": "shipTo",
    "shipTo": {
      "name": "Maria das Dores",
      "email": "email@email.com",
      "address": {
        "correios": {
          "logradouro": "Alameda Santos",
          "complemento": "Apto 103, Bloco C",
          "bairro": "Centro",
          "cidade": "São Paulo",
          "uf": "SP"
        }
      }
    },
    "returnTo": {
      "address": {
        "correios": {
          "logradouro": "Alameda Santos",
          "complemento": "Apto 103, Bloco C",
          "bairro": "Centro",
          "cidade": "São Paulo",
          "uf": "SP"
        }
      }
    }
  }
}

Response

warning_typestring

Mensagem com a constante que identifica casos em que a atualização dos dados do pacote não pode ser confirmada.

warning_messagestring

Mensagem de alerta para casos em que a atualização dos dados do pacote não pode ser confirmada.

Example response

{
  "warning_type": "PACKAGE_DESTINATION_UPDATE_DRIVER_CUSTODY_WARNING_TYPE",
  "warning_message": "Package update while package is in drivers custody."
}