> ## Documentation Index > Fetch the complete documentation index at: https://docs.joinluminous.com/llms.txt > Use this file to discover all available pages before exploring further. # Preview a saved export template > Render a saved template against a live document and return the result. The template's `type` and `fields` are taken from the saved record — the body only needs `document_id` (and optionally `format`). Preview requires the template to be in HTML render mode (`fields.render_mode = "html"`). CSV/`*_data` types and label types are not previewable and return `422`. **`document_id` is interpreted by template type:** | Type | `document_id` | | --- | --- | | `packing_slip`, `sales_order` | Sales order ID | | `invoice_pdf` | Client purchase order (invoice) ID | | `supplier_purchase_order` | Supplier purchase order ID | | `assembly_order` | Assembly order ID | | `work_order` | Work order ID | | `production_run` | Production batch ID | **Response format** follows `format`: - `html` (default) → JSON `{ data: { html, errors, paper_size, type, format } }`. - `pdf` → `application/pdf` binary, unless the request sends `Accept: application/json`, in which case JSON is returned with a base64 `pdf_base64` field instead of `html`. ## OpenAPI ````yaml /api-reference/build.yaml post /export-templates/{exportTemplateId}/preview openapi: 3.0.0 info: title: Luminous API version: 1.0.0 description: API documentation for Luminous servers: - url: https://{companyName}.api.joinluminous.com/external/api/v1 variables: companyName: default: companyName description: Your company-specific subdomain security: [] tags: - name: Products description: Get and manage products - name: Pricing description: Manage price schedules, levels, and customizations - name: BOMs description: Manage Bills of Materials (BOMs) - name: Labels description: Label rendering via Labelary ZPL service - name: Companies description: Manage business accounts and their associated data - name: Contacts description: Manage contact information for individuals - name: Suppliers description: Manage suppliers (factories) — vendors used on purchase orders - name: Supplier SKUs description: Manage per-supplier SKU and unit-cost overrides for products - name: Locations description: Manage warehouses and locations - name: Inventory description: Get and adjust product stock levels - name: Lots description: Create, update, and delete product lots (batches) - name: Transfer Orders description: Manage transfer orders - name: Fulfillment Orders description: Manage fulfillment orders and picklists - name: Freight description: >- Freightview LTL freight — quotes, booking and documents for fulfillment orders - name: Fulfillment Priority Lists description: Configure fulfillment routing priority lists - name: Purchase Orders description: Get and modify purchase orders - name: Supplier Portal description: >- Read a supplier's response to a purchase order and control the one-click portal link - name: Receiving Reports description: Manage receiving reports - name: Payment Obligations description: Manage payment obligations for purchase orders - name: Sales Orders description: Manage sales orders and sales order shipments - name: Purgatory description: >- Inspect and resolve non-posted sales orders in the purgatory staging workflow - name: PickFlow Warehouse description: >- Warehouse-floor lookups for PickFlow — barcode resolution, bin and product stock, bin search, and receivables - name: PickFlow Shipping description: >- Provider-agnostic shipping rates, services, packages, and label purchase for PickFlow - name: Cycle Counts description: >- Create, drive, and post PickFlow cycle counts — batches, per-warehouse sessions, and CSV import/export - name: Print Stations description: List paired print stations and enqueue print jobs to them - name: Invoices description: Get and manage invoices - name: Work Orders description: >- Manage work orders — production lifecycle, steps, materials, links, shipments, and comments - name: Production Batches description: Group and manage work orders as production batches - name: Bills description: >- Accounts payable bill management, payments, attachments, allocations, and variance - name: Prepayments description: Manage vendor prepayments and applications - name: Vendor Credits description: Manage vendor credits and applications - name: Vendor Returns description: Manage vendor returns and credit generation - name: Customer Returns description: Manage customer returns (sales returns), receiving, and restock behavior - name: Stock Snapshot description: Point-in-time stock snapshots with export support - name: Consumption description: Consumption reports and exports - name: Inventory Aging description: Cost-layer-based inventory aging reports - name: Bills Reports description: Accounts payable bills aging reports - name: Forecast description: Materialized forecast data - name: Reports description: Close the books, inventory discrepancy, transaction COGS, and EDI reports - name: Tags description: Add/remove tags across various resources - name: Custom Fields description: Get and set custom fields across various resources - name: Currency description: Currency configuration, exchange rates, and conversion - name: Drive description: > Browse, upload, tag and manage files in your Luminous Drive. An API token sees the shared drive only, never My Files or restricted folders and files. Every write and download made through the API is recorded in the file's activity log (`GET /file-cabinet/files/{id}/activity`) with `actor_kind: api_token`. - name: Integration Mappings description: Manage integration mappings for external systems - name: Integration Field Mappings description: Manage field-level mappings between Luminous and external systems - name: Automations description: Create, test, and inspect automation rules and their runs paths: /export-templates/{exportTemplateId}/preview: post: tags: - Export Templates summary: Preview a saved export template description: > Render a saved template against a live document and return the result. The template's `type` and `fields` are taken from the saved record — the body only needs `document_id` (and optionally `format`). Preview requires the template to be in HTML render mode (`fields.render_mode = "html"`). CSV/`*_data` types and label types are not previewable and return `422`. **`document_id` is interpreted by template type:** | Type | `document_id` | | --- | --- | | `packing_slip`, `sales_order` | Sales order ID | | `invoice_pdf` | Client purchase order (invoice) ID | | `supplier_purchase_order` | Supplier purchase order ID | | `assembly_order` | Assembly order ID | | `work_order` | Work order ID | | `production_run` | Production batch ID | **Response format** follows `format`: - `html` (default) → JSON `{ data: { html, errors, paper_size, type, format } }`. - `pdf` → `application/pdf` binary, unless the request sends `Accept: application/json`, in which case JSON is returned with a base64 `pdf_base64` field instead of `html`. operationId: previewSavedExportTemplate parameters: - in: path name: exportTemplateId required: true schema: type: integer description: Export template ID. requestBody: required: true content: application/json: schema: type: object description: > Preview request. `document_id` is always required. For the draft-preview endpoint (`POST /export-templates/preview`), `type` and `fields` are also required. For the saved-preview endpoint (`POST /export-templates/{id}/preview`), `type`/`fields` are ignored — they come from the saved template. required: - document_id properties: document_id: type: integer minimum: 1 description: >- ID of the live document to render against. Interpreted by template type — see the endpoint description. example: 12345 format: type: string enum: - html - pdf default: html description: >- Output format. `html` returns JSON with rendered markup; `pdf` returns a PDF (binary, or base64 in JSON when `Accept: application/json`). type: type: string description: >- Template type. **Required for draft preview** (`POST /export-templates/preview`); ignored for saved preview. enum: - packing_slip - supplier_purchase_order - assembly_order - invoice_pdf - work_order - production_run - sales_order fields: type: object additionalProperties: true description: >- Raw template body (must be HTML render mode). **Required for draft preview**; ignored for saved preview. example: document_id: 12345 format: html responses: '200': description: >- Rendered preview. JSON for `html` (or `pdf` with `Accept: application/json`); raw PDF bytes for `pdf`. content: application/json: schema: type: object description: >- JSON preview result. `html` is present for `format=html`; `pdf_base64` replaces it for `format=pdf` requested with `Accept: application/json`. properties: data: type: object properties: type: type: string description: Resolved template type. example: packing_slip format: type: string enum: - html - pdf example: html paper_size: type: string nullable: true description: Paper size used to render (HTML-mode paged templates). example: A4 errors: type: array description: Render-time errors, if any (empty on a clean render). items: type: string html: type: string nullable: true description: Rendered HTML. Present when `format=html`. pdf_base64: type: string nullable: true description: >- Base64-encoded PDF. Present when `format=pdf` and JSON is requested. application/pdf: schema: type: string format: binary '401': description: Unauthorized content: application/json: schema: type: object properties: message: type: string '404': description: Document or template not found. content: application/json: schema: type: object properties: message: type: string '422': description: >- Preview not possible — e.g. non-HTML template, unsupported type, or invalid input. content: application/json: schema: type: object properties: message: type: string security: - BearerAuth: [] components: securitySchemes: BearerAuth: type: http scheme: bearer description: >- Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.