> ## 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. # Submit a bulk import > Create and queue a bulk-import job. Two payload formats are supported: - **CSV (recommended)** — `multipart/form-data` with a `.csv` file (up to 20 MB), the import `type`, and an optional `column_mapping` JSON string (system field → CSV header). File uploads are recommended for speed: the server streams rows directly from disk rather than parsing a JSON array in memory, so throughput is significantly higher for non-trivial datasets. - **JSON** — `application/json` with `type` and `rows` (up to 10,000 items). `column_mapping` here maps system field names → keys present in each row object. Use CSV upload for anything larger. ### File support | Extension | Accepted | Notes | | --- | --- | --- | | `.csv` | ✅ | Preferred. Comma-delimited, UTF-8, header row required. | | `.txt` | ✅ | Treated as CSV (same parser, same expectations). | | `.xlsx` / `.xls` | ❌ | Excel files are not accepted — export to CSV first. | Other CSV details: - **Max upload size:** 20 MB. Larger files are rejected with `422`. - **Header row:** the first row must contain column names. Headers are trimmed of whitespace. - **Delimiter / quoting:** standard CSV — comma delimiter, double-quote enclosure. Use double quotes to wrap fields that contain commas, newlines, or quotes (escape an embedded quote by doubling it: `""`). - **Empty rows** are skipped automatically. - **Encoding:** UTF-8 is strongly recommended. Other encodings may parse but can corrupt non-ASCII characters. On success the endpoint returns `201` with the import record (including its `job` progress fields). Poll `GET /imports/{id}` to track progress. ## OpenAPI ````yaml /api-reference/build.yaml post /imports 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: Purchase Orders description: Get and modify purchase orders - 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 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: Integration Mappings description: Manage integration mappings for external systems - name: Integration Field Mappings description: Manage field-level mappings between Luminous and external systems paths: /imports: post: tags: - Imports summary: Submit a bulk import description: > Create and queue a bulk-import job. Two payload formats are supported: - **CSV (recommended)** — `multipart/form-data` with a `.csv` file (up to 20 MB), the import `type`, and an optional `column_mapping` JSON string (system field → CSV header). File uploads are recommended for speed: the server streams rows directly from disk rather than parsing a JSON array in memory, so throughput is significantly higher for non-trivial datasets. - **JSON** — `application/json` with `type` and `rows` (up to 10,000 items). `column_mapping` here maps system field names → keys present in each row object. Use CSV upload for anything larger. ### File support | Extension | Accepted | Notes | | --- | --- | --- | | `.csv` | ✅ | Preferred. Comma-delimited, UTF-8, header row required. | | `.txt` | ✅ | Treated as CSV (same parser, same expectations). | | `.xlsx` / `.xls` | ❌ | Excel files are not accepted — export to CSV first. | Other CSV details: - **Max upload size:** 20 MB. Larger files are rejected with `422`. - **Header row:** the first row must contain column names. Headers are trimmed of whitespace. - **Delimiter / quoting:** standard CSV — comma delimiter, double-quote enclosure. Use double quotes to wrap fields that contain commas, newlines, or quotes (escape an embedded quote by doubling it: `""`). - **Empty rows** are skipped automatically. - **Encoding:** UTF-8 is strongly recommended. Other encodings may parse but can corrupt non-ASCII characters. On success the endpoint returns `201` with the import record (including its `job` progress fields). Poll `GET /imports/{id}` to track progress. operationId: createImport requestBody: required: true content: multipart/form-data: schema: type: object required: - type - file properties: type: type: string description: Import type key (see `GET /imports/types`) example: master_skus file: type: string format: binary description: CSV file (`.csv` or `.txt`, max 20 MB) column_mapping: type: string description: >- JSON object as a string — system field name → CSV header name example: '{"MASTER_SKU":"Product ID","PRODUCT_NAME":"Name"}' email: type: string format: email description: Email address to notify when the import finishes job_name: type: string maxLength: 255 description: Human-readable name for the job options: type: string description: JSON object as a string — additional per-type options application/json: schema: type: object required: - type - rows properties: type: type: string description: Import type key example: master_skus rows: type: array maxItems: 10000 description: > Up to 10,000 row objects. Each row is an object whose keys correspond to canonical system field names (or to the keys you supply in `column_mapping`). Use the CSV upload for larger datasets. items: type: object additionalProperties: true column_mapping: type: object description: > Optional mapping from system field name → the key used in each row object. Useful when your row objects use source-system field names rather than canonical ones. additionalProperties: type: string email: type: string format: email description: Email address to notify when the import finishes job_name: type: string maxLength: 255 options: type: object description: Free-form per-type options additionalProperties: true responses: '201': description: Import created and job queued content: application/json: schema: type: object properties: data: type: object description: > Bulk import job record. Returned from the imports endpoints and reflects the async `ImportJob` that processes the rows. properties: id: type: integer description: Import ID example: 8421 type: type: string description: Import type key (see `GET /imports/types`) example: master_skus created_at: type: string format: date-time updated_at: type: string format: date-time email: type: string nullable: true description: >- Email address that will receive the completion notification (PII-hashed when PII filtering is enabled) example: ops@example.com options: type: object nullable: true description: >- Free-form import options recorded with the job (PII-redacted when applicable) imported_by: type: string nullable: true description: >- Name or email of the user who created the import (PII-redacted when applicable) example: Jane Doe stats: type: object properties: total_rows: type: integer example: 1240 success_count: type: integer description: > Rows imported without error (`total_rows` minus `error_count`). For `inventory_quantities` imports this reports `0` while the underlying job is still in flight (queued or running) and only reflects the real count once the job has finished — poll until the `job.finished_at` timestamp is set before relying on it. example: 1235 error_count: type: integer example: 5 job: type: object nullable: true description: > The underlying async job. Only present when the `job` relation is loaded (which is the case for create, resume, retry, copy, and `GET /imports/{id}` responses). properties: id: type: integer job_id: type: string nullable: true description: Underlying queue job identifier type: type: string nullable: true status: type: string nullable: true description: e.g. `queued`, `executing`, `finished`, `failed` queue: type: string nullable: true attempts: type: integer nullable: true progress_now: type: integer nullable: true description: Rows processed so far progress_max: type: integer nullable: true description: Total rows to process created_at: type: string format: date-time nullable: true updated_at: type: string format: date-time nullable: true started_at: type: string format: date-time nullable: true finished_at: type: string format: date-time nullable: true required: - id - type - stats '401': description: Unauthorized content: application/json: schema: type: object properties: message: type: string '422': description: Validation error 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. ````