> ## 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.
# Validate an export template draft
> Dry-run a template draft without saving. Runs the same shape rules as create/update,
compiles the Mustache markup, and flags unknown placeholders. Returns a unified
`{ valid, errors, warnings }` result.
HTTP status is `200` when `valid` is `true` and `422` when `false` — the body uses the
same shape either way. `errors` block a save; `warnings` (e.g. an unrecognized
placeholder) do not.
## OpenAPI
````yaml /api-reference/build.yaml post /export-templates/validate
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/validate:
post:
tags:
- Export Templates
summary: Validate an export template draft
description: >
Dry-run a template draft without saving. Runs the same shape rules as
create/update,
compiles the Mustache markup, and flags unknown placeholders. Returns a
unified
`{ valid, errors, warnings }` result.
HTTP status is `200` when `valid` is `true` and `422` when `false` — the
body uses the
same shape either way. `errors` block a save; `warnings` (e.g. an
unrecognized
placeholder) do not.
operationId: validateExportTemplate
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- type
- fields
properties:
name:
type: string
maxLength: 255
description: Optional template name (used only for messaging).
type:
type: string
description: Template type to validate against.
example: packing_slip
fields:
type: object
additionalProperties: true
description: Raw template body to validate.
example:
type: packing_slip
fields:
render_mode: html
page:
size: A4
orientation: Portrait
headerHtml: 'Packing Slip #{{orderNumber}}
'
itemsHeaderHtml: | SKU |
|---|
itemRowHtml: '{{#orderLines}}| {{sku}} |
{{/orderLines}}'
footerHtml: {{fakeField}}
responses:
'200':
description: Draft is valid.
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
valid:
type: boolean
description: >-
Whether the draft passed all blocking rules and
compiled cleanly.
errors:
type: array
description: >-
Blocking problems (shape rule failures, Mustache
compile errors). A save would fail while non-empty.
items:
type: string
warnings:
type: array
description: >-
Non-blocking advisories, such as placeholders not
found in the type's catalogue.
items:
type: string
example:
data:
valid: true
errors: []
warnings: []
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
message:
type: string
'422':
description: >-
Draft is invalid — see `errors`. Body uses the same `{ valid,
errors, warnings }` shape.
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
valid:
type: boolean
description: >-
Whether the draft passed all blocking rules and
compiled cleanly.
errors:
type: array
description: >-
Blocking problems (shape rule failures, Mustache
compile errors). A save would fail while non-empty.
items:
type: string
warnings:
type: array
description: >-
Non-blocking advisories, such as placeholders not
found in the type's catalogue.
items:
type: string
example:
data:
valid: false
errors:
- >-
The fields.page.size field is required when
fields.render_mode is html.
warnings:
- >-
Unknown placeholder {{fakeField}} in footerHtml (not in
catalogue for packing_slip)
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.