> ## 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.

# Resume an incomplete import

> Re-dispatch an import job that did not finish, picking up from where it left off.

If the original import recorded job progress, no body is required — the resume
will start from the recorded position. If progress was not recorded, pass
`start_position` to indicate which row to resume from.




## OpenAPI

````yaml /api-reference/build.yaml post /imports/{id}/resume
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/{id}/resume:
    post:
      tags:
        - Imports
      summary: Resume an incomplete import
      description: >
        Re-dispatch an import job that did not finish, picking up from where it
        left off.


        If the original import recorded job progress, no body is required — the
        resume

        will start from the recorded position. If progress was not recorded,
        pass

        `start_position` to indicate which row to resume from.
      operationId: resumeImport
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: integer
          description: Import ID
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                start_position:
                  type: integer
                  minimum: 0
                  description: Row index to resume from when no job progress is available
      responses:
        '200':
          description: Resume 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
        '400':
          description: >-
            Cannot resume — no progress recorded and `start_position` was not
            supplied
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '404':
          description: Import not found
          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.

````