1. Documentos para Impressão
Fulfillment - Manual da API
  • 🚀 Introdução
  • 🔒 Autenticação
  • 🚦 Rate Limiting
  • Autenticação
    • Autenticação
    • Sessão do usuário
    • Refresh Token
    • Finalizar Sessão
  • Produtos
    • 📦 Conceitos de Produtos
    • Gerenciamento
      • Coleção de produtos
      • Criar um novo produto
      • Detalhes do produto
      • Estoque do Produto
      • Modificar Produto
      • Excluir Produto
    • Controle
      • Controle de Temperatura
      • Controle de Estoque
      • Data de validade & Lote
    • Códigos fiscais
      • Códigos Fiscais de Produtos
      • Códigos fiscais
      • Código fiscal
      • Código fiscal
      • Código fiscal
      • Código fiscal
    • RMA
      • Estatísticas
      • Qualidade
      • Ocorrências
  • Tipos de Operações
    • ♻️ Tipos de Operação
    • 📦 Entrada de Mercadoria
    • Tipos de Operações
    • Tipo de Operação
  • Clientes
    • 👔 Clientes & Parceiros
    • Gerenciamento
      • Coleção de Clientes
      • Novo cliente
      • Detalhes
      • Modificar
      • Excluir
    • Endereços
      • Endereços
      • Adicionar Endereço
      • Detalhes do Endereço
      • Modificar Endereço
  • Pedidos - Gerenciamento
    • 🛒 Pedidos Fulfillment
    • Gerenciamento
      • Pedidos
        GET
      • Novo Pedido
        POST
      • Detalhes do Pedido
        GET
      • Confirmar Pedido
        POST
      • Update Order
        PUT
    • Workflows
      • Situação atual de um pedido
        GET
      • Fluxos de execução disponíveis
        GET
      • Avançar Workflow
        POST
      • Cancelar Pedido / Workflow
        POST
    • Itens do Pedido
      • Gerenciamento
        • Itens do Pedido
        • Adicionar Item
        • Detalhes do Item
        • Modificar Item
        • Excluir Item
      • Rastreamento
        • Rastreamentos
        • Adicionar Rastreamento
        • Detalhes do Rastreamento
        • Excluir Rastreamento
    • Agendamento
      • Agendamento
        GET
      • Slots Disponíveis
        GET
      • Reservar Slots
        POST
      • Cancelar Agendamento
        POST
      • Confirmar Agendamento
        POST
    • Identificação de Produtos
      • Etiquetas
        GET
      • Gerar Etiquetas
        POST
      • Confirmar impressão
        POST
    • Documentos Fiscais
      • Documentos Fiscais
        GET
      • Documento Fiscal
        POST
      • Detalhes do Documento
        GET
      • Excluir Documento
        DELETE
    • Documentos para Impressão
      • Documentos
        GET
      • Adicionar Documento
        POST
      • Detalhes do Documento
        GET
      • Pré-visualização
        GET
      • Excluir Documento
        DELETE
  • Pedidos - Aguardando NFe
    • Totais
    • Aguardando NFe
    • Detalhes Fiscal
  • Configurações
    • Webhooks
      • Webhooks
      • Webhook
      • Webhook
      • Webhook
      • Webhook
      • Histórico
      • Estatísticas
      • Teste
      • Eventos Disponíveis
    • Enumeração
      • Enumeração
      • Tipos disponíveis
    • Token de API
      • Token de API
      • Criar um novo Token
  • Locais de Estoque
    • Localizações Exclusivas
    • Ocupação das Localizações
    • Detalhes de uma Localização
    • Produtos de uma Localização
  • Inventário
    • Resumo Geral do Estoque
    • Inventário Detalhado
    • Produtos com Estoque Baixo
    • Consulta Detalhada de Estoque
  1. Documentos para Impressão

Pré-visualização

Developing
GET
/api/v1/orders/{order_code}/print-documents/{documentId}/preview
Last modified:2025-08-29 14:22:35

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params

Responses

🟢200OK
application/json
Body

Examples
{
    "success": true,
    "message": "Operação realizada com sucesso",
    "data": {
        "document": {
            "document_id": 2,
            "name": "Etiqueta",
            "description": "Enviado via Customer",
            "order_print_document_type": {
                "value": "zpl",
                "label": "Documento ZPL",
                "description": "Documento em formato ZPL para impressoras térmicas (etiquetas, códigos de barras, etc.)"
            },
            "file_name": null,
            "file_size": 441,
            "human_file_size": "441 B",
            "is_active": true,
            "last_printed_at": null,
            "print_count": 0,
            "metadata": null,
            "created_at": "2025-09-19 09:50:52",
            "updated_at": "2025-09-19 09:50:52",
            "derived_printer_type": {
                "value": "thermal",
                "label": "Térmica",
                "description": "Impressora térmica (Zebra, Argox, etc.)"
            },
            "usage_stats": {
                "never_printed": true,
                "frequently_printed": false,
                "last_print_days_ago": null
            }
        },
        "content": "^XA^CI28^LH10,10^FS^FX Caixa principal da etiqueta^FO10,10^GB780,380,2^FS^FX Título do documento^FO30,30^A0N,40,40^FDIdentificação de Documento^FS^FX Número do documento^FO30,90^A0N,30,30^FDNúmero: DOC-20250626-001^FS^FX Responsável^FO30,140^A0N,30,30^FDResponsável: João da Silva^FS^FX Data^FO30,190^A0N,30,30^FDData: 26/06/2025^FS^FX Código de barras (número do documento)^FO30,250^BY2,2,50^BCN,100,Y,N,N^FD>;DOC20250626001^FS^XZ",
        "mime_type": "text/plain",
        "zpl_analysis": {
            "total_commands": 31,
            "unique_commands": 15,
            "commands": [
                {
                    "command": "^FS",
                    "count": 7
                },
                {
                    "command": "^FX",
                    "count": 6
                },
                {
                    "command": "^FO",
                    "count": 6
                },
                {
                    "command": "^XA",
                    "count": 1
                },
                {
                    "command": "^CI",
                    "count": 1
                },
                {
                    "command": "^LH",
                    "count": 1
                },
                {
                    "command": "^GB",
                    "count": 1
                },
                {
                    "command": "^FDI",
                    "count": 1
                },
                {
                    "command": "^FDN",
                    "count": 1
                },
                {
                    "command": "^FDR",
                    "count": 1
                },
                {
                    "command": "^FDD",
                    "count": 1
                },
                {
                    "command": "^BY",
                    "count": 1
                },
                {
                    "command": "^BCN",
                    "count": 1
                },
                {
                    "command": "^FD",
                    "count": 1
                },
                {
                    "command": "^XZ",
                    "count": 1
                }
            ]
        }
    }
}
Modified at 2025-08-29 14:22:35
Previous
Detalhes do Documento
Next
Excluir Documento
Built with