> ## 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 mapping (dry run)

> Run the mapping's stored source sample (`source_order_json`) through the same
transformation engine the push path uses, and return what the destination would
receive. **This makes no OMS call and writes nothing** — it is how a mapping gets
tested without pushing a real order.

Pass `mapping_config` to preview unsaved edits from the mapping editor; omit it to
preview the stored config. Pass `fulfillment_order_id` to dry-run against a live
fulfillment order sample instead of the stored `source_order_json` — that sample is
**not** persisted on the mapping.

The returned `output` omits nulls and empty strings, matching what the push path sends.




## OpenAPI

````yaml /api-reference/build.yaml post /integration-mappings/{id}/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: 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 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:
  /integration-mappings/{id}/preview:
    post:
      tags:
        - Integration Mappings
      summary: Preview a mapping (dry run)
      description: >
        Run the mapping's stored source sample (`source_order_json`) through the
        same

        transformation engine the push path uses, and return what the
        destination would

        receive. **This makes no OMS call and writes nothing** — it is how a
        mapping gets

        tested without pushing a real order.


        Pass `mapping_config` to preview unsaved edits from the mapping editor;
        omit it to

        preview the stored config. Pass `fulfillment_order_id` to dry-run
        against a live

        fulfillment order sample instead of the stored `source_order_json` —
        that sample is

        **not** persisted on the mapping.


        The returned `output` omits nulls and empty strings, matching what the
        push path sends.
      operationId: previewIntegrationMapping
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: integer
          description: Integration mapping ID
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                mapping_config:
                  type: array
                  description: >-
                    Config to preview. Omit to preview the stored config. Each
                    row requires a `pushField`.
                  items:
                    type: object
                    required:
                      - pushField
                    properties:
                      lumField:
                        type: string
                        description: Source field path.
                      pushField:
                        type: string
                        description: Destination field path.
                      transformation:
                        type: string
                        nullable: true
                      transformationConfig:
                        type: object
                        nullable: true
                fulfillment_order_id:
                  type: integer
                  nullable: true
                  description: >-
                    Fulfillment order ID (`sales_orders_shipments.id`) to
                    extract a live source sample from. Omit to use the mapping's
                    stored `source_order_json`. Does not write to the mapping.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      output:
                        type: object
                        additionalProperties: true
                        description: >-
                          The destination payload the mapping would produce.
                          Nulls and empty strings are omitted, matching the push
                          path.
                      rows:
                        type: array
                        description: Per-row outcome of running each mapping rule.
                        items:
                          type: object
                          properties:
                            index:
                              type: integer
                            lumField:
                              type: string
                              nullable: true
                            pushField:
                              type: string
                            status:
                              type: string
                              description: >
                                Row outcome:

                                - `ok` — resolved to a usable value.

                                - `empty` — ran without error but resolved to
                                null/empty; nothing written.

                                - `error` — the row threw; `message` explains
                                why. The rest of the mapping still ran.
                              enum:
                                - ok
                                - empty
                                - error
                            message:
                              type: string
                              nullable: true
                            resolvedValue:
                              nullable: true
                              description: >-
                                The value written for this row (null when
                                `empty` or `error`).
                      summary:
                        type: object
                        properties:
                          total:
                            type: integer
                          ok:
                            type: integer
                          empty:
                            type: integer
                          error:
                            type: integer
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '404':
          description: Integration mapping not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '422':
          description: >-
            The mapping has no source sample yet — set `source_order_id` (or the
            product / purchase-order shipment equivalent) first.
          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.

````