---
title: "Atualizar dados de um pacote"
method: PATCH
path: "/v1/companies/{company_id}/packages"
tags: ["PackageUpdateAPI"]
---

# Atualizar dados de um pacote

`PATCH /v1/companies/{company_id}/packages`

## Path parameters

- `company_id` string, required

## Query parameters

- `loggi_key` string
- `tracking_code` string

## Request body

- V1PackageUpdateRequest — Objeto que configura o formato da requisição de atualização de um pacote. Contém as informações a serem atualizadas.
  - `package` object
    - `updateMask` string — Identifica o campo do pacote que será atualizado. Os campos shipTo e returnTo não podem ser atualizados na mesma requisição.
    - `shipTo` object — Objeto que configura o formato da requisição de atualização do destinatário. Contém as informações da pessoa destinatária e do endereço de entrega.
      - `name` string — Nome da pessoa destinatária associada ao pacote.
      - `email` string — Email da pessoa destinatária associada ao pacote.
      - `phoneNumber` string — Número de telefone da pessoa destinatária associada ao pacote.
      - `federalTaxId` string — Número de identificação fiscal da pessoa destinatária associada ao pacote. Poder ser o número do CPF ou CNPJ.
      - `address` union — Objeto que representa um endereço nacional em formato dos Correios ou um endereço internacional. Ambas as representações são mutuamente exclusivas, sendo assim, só é possível utilizar uma delas por request.
        - object — Objeto que contém informações detalhadas do endereço compatível com o formato da API dos Correios.
          - `correios` object
            - `logradouro` string — Nome do endereço associado a pessoa destinatária do pacote.
            - `numero` string — Número que identifica o local onde o pacote será entregue para a pessoa destinatária associada ao pacote.
            - `complemento` string — Informações complementares associadas ao endereço da pessoa destinatária do pacote.
            - `bairro` string — Bairro do endereço associado a pessoa destinatária do pacote.
            - `cep` string — Código postal do endereço associado a pessoa destinatária do pacote.
            - `cidade` string — Cidade do endereço associado a pessoa destinatária do pacote.
            - `uf` string — Unidade federativa do endereço associado a pessoa destinatária do pacote.
        - object — Objeto que representa um endereço com padrão internacional.
          - `lines` object
            - `addressLine1` string — Representação mais simples do endereço associado a pessoa destinatária do pacote. Comumente associado ao formato inserido pelo usuário.
            - `addressLine2` string — Informações complementares associadas ao endereço da pessoa destinatária do pacote.
            - `postalCode` string — Código postal do endereço associado a pessoa destinatária do pacote. No Brasil, usa-se o CEP.
            - `city` string — Cidade do endereço associado a pessoa destinatária do pacote.
            - `state` string — Unidade federativa do endereço associado a pessoa destinatária do pacote.
            - `country` string — País do endereço associado a pessoa destinatária do pacote.
    - `returnTo` object — Objeto que configura o formato da requisição de atualização do endereço de devolução. Disponível apenas para pacotes que já estão em processo de devolução. Apenas o campo address pode ser atualizado. Para pacotes com devolução consolidada, a atualização do endereço de devolução não terá efeito.
      - `address` union — Objeto que representa um endereço nacional em formato dos Correios ou um endereço internacional. Ambas as representações são mutuamente exclusivas, sendo assim, só é possível utilizar uma delas por request.
        - object — Objeto que contém informações detalhadas do endereço compatível com o formato da API dos Correios.
          - `correios` object
            - `logradouro` string — Nome do endereço de devolução associado ao pacote.
            - `numero` string — Número que identifica o local onde o pacote será devolvido.
            - `complemento` string — Informações complementares associadas ao endereço de devolução do pacote.
            - `bairro` string — Bairro do endereço de devolução associado ao pacote.
            - `cep` string — Código postal do endereço de devolução associado ao pacote.
            - `cidade` string — Cidade do endereço de devolução associado ao pacote. O endereço não poderá ser alterado para outro município.
            - `uf` string — Unidade federativa do endereço de devolução associado ao pacote.
        - object — Objeto que representa um endereço com padrão internacional.
          - `lines` object
            - `addressLine1` string — Representação mais simples do endereço de devolução associado ao pacote. Comumente associado ao formato inserido pelo usuário.
            - `addressLine2` string — Informações complementares associadas ao endereço de devolução do pacote.
            - `postalCode` string — Código postal do endereço de devolução associado ao pacote. No Brasil, usa-se o CEP.
            - `city` string — Cidade do endereço de devolução associado ao pacote. O endereço não poderá ser alterado para outro município.
            - `state` string — Unidade federativa do endereço de devolução associado ao pacote.
            - `country` string — País do endereço de devolução associado ao pacote.

## Response `200`

- V1PackageUpdateResponse — Objeto que configura a resposta da API de atualizar dados de um pacote.
  - `warning_type` string — Mensagem com a constante que identifica casos em que a atualização dos dados do pacote não pode ser confirmada.
  - `warning_message` string — Mensagem de alerta para casos em que a atualização dos dados do pacote não pode ser confirmada.

## Other responses

- `400` — Mensagem do cliente não segue a especificação
- `401` — Falha de autenticação
- `403` — Sem autorização para acessar o serviço
- `404` — Recurso não encontrado
- `429` — Requisições massivas bloqueadas
- `500` — Erro interno
- `503` — Serviço temporariamente indisponível

---

[API](https://skmtc.net/loggi/apis/authentication.md) · [All operations](https://skmtc.net/loggi/apis/authentication/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/loggi/authentication/revisions/46512f6e2419/schema)
