---
title: "Criar Etiqueta"
method: POST
path: "/v1/companies/{company_id}/labels"
tags: ["LabelAPI"]
---

# Criar Etiqueta

`POST /v1/companies/{company_id}/labels`

## Request

- Base URL: `https://stg.api.loggi.com`
- URL: `https://stg.api.loggi.com/v1/companies/{company_id}/labels`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://api.loggi.com/oauth2/token`
- TypeScript: <https://skmtc.dev/loggi/apis/authentication/docs/v1/companies/:company_id/labels/post.ts> (a function with typed inputs; its response is checked against the schema)

A geração de etiqueta Loggi só pode ser feita após a resposta de sucesso do serviço de criação de pacotes.
Para o serviço de criação de pacotes assíncrono, deve-se aguardar a mensagem de confirmação do webhook de que o pacote foi criado.

A solicitação de geração de uma etiqueta está sempre associada à um envio previamente criado.
Para referenciar este(s) envio(s), será necessário informar o(s) loggiKey(s) associado(s).

### Teste abaixo o endpoint</h2>
<div class="warning-docs">
  ⚠️ <em>Os campos abaixo precisam ser preenchidos para realização dos testes de endpoint.</em>
</div>

## Path parameters

- `company_id` string, required

## Request body

- V1CreateLabelRequest
  - `loggiKeys` string[], required: Lista de Loggi Keys.
  - `format` 'LABEL_FORMAT_PDF': Formato do arquivo gerado que contém a etiqueta. Nesta versão é possível apenas gerar no formato PDF
  - `layout` 'LABEL_LAYOUT_A4' | 'LABEL_LAYOUT_A6': Tamanho da página de um label.
  - `labelType` 'LABEL_TYPE_DEFAULT' | 'LABEL_TYPE_DROP_QR_CODE': Tipo de etiqueta.
  - `responseType` 'LABEL_RESPONSE_TYPE_URL' | 'LABEL_RESPONSE_TYPE_BASE_64', required: Tipo de retorno do label gerado.

## Response `200`

Etiquetas geradas com sucesso para às loggi keys que não apresentaram erro.

Os campos **content** e **url** são **mutuamente exclusivos**.

O campo **content** será retornado quando informado o valor LABEL_RESPONSE_TYPE_BASE_64 para o campo **responseType**
e o campo **url** será retornado quando informado o valor LABEL_RESPONSE_TYPE_URL para o campo **responseType**.

- V1CreateLabelResponse
  - `success` union: Arquivo binário em BASE64 com as etiquetas geradas com sucesso.
    - object
      - `createdTime` string, date-time: Horário de geração da etiqueta em formato UTC.
      - `content` string: Bytes do arquivo codificado em base 64. Este dado é retornado quando informado o valor LABEL_RESPONSE_TYPE_BASE_64 para o campo **responseType**.
    - object
      - `createdTime` string, date-time: Horário de geração da etiqueta em formato UTC.
      - `url` string: Link para download da etiqueta gerada. Este dado é retornando quando informado o valor LABEL_RESPONSE_TYPE_URL para o campo **responseType**.
  - `failure` object[]: Lista de loggi keys dos pacotes que não puderam ter as etiquetas geradas e seus respectivos erros.
    - `loggiKey` string: Loggi key não processada durante a geração de uma etiqueta.
    - `status` object: Detalhamento do erro na geração da etiqueta.
      - `code` integer: Código numérico referente à falha. CANCELLED = 1 UNKNOWN = 2 INVALID_ARGUMENT = 3 DEADLINE_EXCEEDED = 4 NOT_FOUND = 5 ALREADY_EXISTS = 6 PERMISSION_DENIED = 7 RESOURCE_EXHAUSTED = 8 FAILED_PRECONDITION = 9 ABORTED = 10 OUT_OF_RANGE = 11 UNIMPLEMENTED = 12 INTERNAL = 13 UNAVAILABLE = 14 DATA_LOSS = 15 UNAUTHENTICATED = 16
      - `message` string: Texto pequeno informativo sobre a falha
      - `details` unknown[]: Detalhes sobre à falha. Nesta versão da API ainda não está sendo retornado, mas deve ser considerado um array de objetos de tipos distintos.
        - unknown

## 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`: Service temporariamente indisponivel

---

[API](https://skmtc.dev/loggi/apis/authentication.md) - [All operations](https://skmtc.dev/loggi/apis/authentication/llms.txt) - [OpenAPI document](https://skmtc.dev/loggi/apis/authentication/revisions/46512f6e2419?raw)