SuportePainel
Recursos da API (ERP Loja)

Card de impressão

Criação, retorno, consulta e cancelamento de cards de impressão.

Use ordens de impressão para enviar uma imagem ou conteúdo renderizado ao Smart TEF.

Regras do arquivo

  • Tamanho máximo recomendado de 56000 bytes.
  • Largura de 450px.
  • Altura máxima de 2000px.
  • Formato JPEG ou PNG.
  • Envie o conteúdo em Base64 no campo file.data.
  • Quando print_id for usado, trate-o como identificador funcional da impressão na loja.

Headers

NomeDescriçãoValor
AuthorizationBearer Token recebido na criação da loja.Bearer <token>
ocp-apim-subscription-keyGateway Token recebido na criação da loja.<subscription-key>
Content-TypeConteúdo da requisição.application/json

Criar impressão

POST /smarttef/commands/erp/print/create

Os cards de impressão servem para enviar uma imagem ao terminal.

{
  "order_type": "CRD_UNICO",
  "has_details": true,
  "print_id": "12345",
  "file": {
    "name": "nome da imagem",
    "data": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAIAAACQd1PeAAAADElEQVQImWP4z8AAAAMBAQAY3Y20AAAAASUVORK5CYII="
  }
}
CampoObrigatórioDescrição
order_typeNãoCRD_UNICO exibe imediatamente. NRM deixa o card em lista.
user_idCondicionalUsuário que receberá o card quando order_type for CRD_UNICO. Não pode ser enviado junto com serial_pos.
serial_posCondicionalSerial do POS que receberá o card quando order_type for CRD_UNICO. Não pode ser enviado junto com user_id.
print_idNãoIdentificador do card criado pelo ERP.
has_detailsNãoSe true, exibe tela de detalhes ao clicar. Em card CRD_UNICO sem interação, use false.
fileSimObjeto com name e data em Base64 da imagem.

Regras de impressão

TemaRegra
DirecionamentoPara CRD_UNICO, envie apenas user_id ou apenas serial_pos.
ArquivoA criação exige arquivo em Base64. Informe nome e extensão compatíveis com o formato enviado.
Duplicidadeprint_id não deve ser reutilizado enquanto existir impressão pendente ou processando para a mesma loja.
CancelamentoSó é permitido cancelar impressões ainda pendentes.

Retorno da criação

{
  "print_identifier": "019c9618-0d2f-7405-8e07-2a3e75b20172",
  "print_status": "PDT",
  "order_type": "CRD_UNICO",
  "file": "https://storage.blob.com/smart-tef/68ab8366-29db-438e-9a39-8ca72691c0b7-SR4YK.png",
  "print_id": "189"
}
CampoDescrição
print_identifierIdentificador único gerado para cada impressão.
print_statusStatus atual do card.
order_typeTipo do card, único ou normal.
fileURL da imagem armazenada para download.
print_idIdentificador informado pelo ERP.

Consultar impressão

POST /smarttef/pooling/erp/print/get
{
  "print_identifier": "019c9618-0d2f-7405-8e07-2a3e75b20172"
}
CampoTipoObrigatórioDescrição
print_identifierstringSimIdentificador único da impressão em UUID.

Exemplo de retorno de consulta

{
  "print_identifier": "019c9618-0d2f-7405-8e07-2a3e75b20172",
  "cnpj": "22140418000160",
  "create_at": "2026-02-25T15:38:04.603Z",
  "update_at": "2026-02-25T15:38:04.603Z",
  "file": "https://storage.blob.com/smart-tef/68ab8366-29db-438e-9a39-8ca72691c0b7-SR4YK.png",
  "order_type": "CRD_UNICO",
  "print_status": "PDT",
  "serial_pos": "",
  "user_id": 24,
  "type": "PRINT",
  "has_details": true,
  "print_id": "189",
  "location": {
    "lat": "",
    "long": ""
  },
  "reason": null
}

Campos de retorno

CampoDescrição
print_identifierIdentificador único gerado para cada impressão.
cnpjCNPJ da loja.
create_atData e hora da criação do card.
update_atData e hora da última atualização.
fileURL da imagem para download.
order_typeCRD_UNICO ou NRM.
print_statusStatus atual do card.
serial_posSerial do POS.
user_idID do usuário que enviou a imagem.
typeTipo do card. Para impressão, será PRINT.
has_detailsIndica se há detalhes adicionais no card.
print_idIdentificador do card criado pelo ERP.
location.latLatitude do terminal.
location.longLongitude do terminal.
reasonMotivo da rejeição, quando houver.

Cancelar impressão pendente

POST /smarttef/commands/erp/print/status/cancelar
{
  "print_identifier": "019c9618-0d2f-7405-8e07-2a3e75b20172"
}

O cancelamento só se aplica a impressões ainda pendentes. Se a impressão já estiver processando no POS, acompanhe o resultado pela consulta ou pelo webhook.

Retorno do cancelamento

{
  "print_identifier": "019c9618-0d2f-7405-8e07-2a3e75b20172",
  "print_status": "CAN_ERP",
  "order_type": "CRD_UNICO"
}
CampoDescrição
print_identifierIdentificador único gerado para cada impressão.
print_statusStatus atual do card.
order_typeTipo do card, único ou normal.