Sign in

v1

latestOpenAPI 3.0.02026-07-24102197.9 KB
LabelAPI

Criar Etiqueta

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>
post/v1/companies/{company_id}/labels

Path parameters

company_idstring required

Identificador do embarcador

Request body

loggiKeysstring[] 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.

Example request

{
  "loggiKeys": [
    "KIF511LG3TBNA3U8G2INVEWO32",
    "LJG622LG3TBNB4V9H3JORFYP45"
  ],
  "format": "LABEL_FORMAT_PDF",
  "layout": "- LABEL_LAYOUT_A4 formato A4\n- LABEL_LAYOUT_A6 formato A6",
  "responseType": "- LABEL_RESPONSE_TYPE_URL: URL para download da etiqueta.\n- LABEL_RESPONSE_TYPE_BASE_64: Bytes do arquivos codificado em base 64."
}

Response

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.

Example response

{
  "success": {
    "createdTime": "2021-01-13T10:43:17Z",
    "content": "DAxODQgMDAwMDAgbg0KMDAwMDAwMDA3OCAwMDAwMCBuDQowMDAwMDAwMjQxIDAwMDAwIG"
  },
  "failure": [
    {
      "loggiKey": "KIF511LG3TBNA3U8G2INVEWO32",
      "status": {
        "code": 14,
        "message": "Requisição com credenciais inválidas",
        "details": []
      }
    }
  ]
}