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

# Refresh a sales order

> Dispatch a background refresh for a single active sales order — the same pipeline
used by the admin `order:refresh` Artisan command. The job pulls shipping updates,
recalculates quantities, deletes unpushed fulfillment orders, and auto-generates
new ones.

The endpoint validates and queues the work, then returns immediately; the refresh
itself runs asynchronously on the `order-refresh` queue.

Only active sales orders (`status > 0`) can be refreshed. Requests targeting
completed, cancelled, or deleted orders return `404`.




## OpenAPI

````yaml /api-reference/build.yaml post /sales-orders/{salesOrderId}/refresh
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:
  /sales-orders/{salesOrderId}/refresh:
    post:
      tags:
        - Sales Orders
      summary: Refresh a sales order
      description: >
        Dispatch a background refresh for a single active sales order — the same
        pipeline

        used by the admin `order:refresh` Artisan command. The job pulls
        shipping updates,

        recalculates quantities, deletes unpushed fulfillment orders, and
        auto-generates

        new ones.


        The endpoint validates and queues the work, then returns immediately;
        the refresh

        itself runs asynchronously on the `order-refresh` queue.


        Only active sales orders (`status > 0`) can be refreshed. Requests
        targeting

        completed, cancelled, or deleted orders return `404`.
      operationId: refreshSalesOrder
      parameters:
        - in: path
          name: salesOrderId
          required: true
          schema:
            type: integer
          description: Sales order ID
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                reset_skip_inventory:
                  type: boolean
                  default: false
                  description: >
                    When `true`, the order's `skip_inventory` flag is set to
                    `false` before

                    the refresh runs, so fulfillment-order creation can take
                    place.
                delete_all_shipments:
                  type: boolean
                  default: false
                  description: >
                    When `true`, the refresh job deletes all existing shipments
                    (including

                    pushed ones) before regenerating fulfillment orders. Use
                    with care.
      responses:
        '200':
          description: Refresh job dispatched
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                      message:
                        type: string
                        example: >-
                          Order refresh job dispatched. Processing runs
                          asynchronously on the order-refresh queue.
                      sales_order_id:
                        type: integer
                        example: 12345
                      order_number:
                        type: string
                        example: SO-1001
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '404':
          description: Sales order not found or is not active
          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.

````