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

# Update an integration mapping

> Update an existing integration mapping by ID.

When changing `mapping_config`, see the [Integration Mapping Guide](/integration-mapping-guide)
for the rule structure, field-path syntax, the full transformation catalogue, and
fallback behavior.

At most one of `source_order_id`, `source_product_id`, or `source_purchase_order_id`
may be set on a single request. `source_supplier_purchase_order_shipment_id` links the
mapping to an inbound purchase-order shipment (for `PUSH_INBOUND_SHIPMENT` mappings).
On these inbound-shipment mappings, updating `source_supplier_purchase_order_shipment_id`
alone re-infers `source_purchase_order_id` from the shipment's linked purchase-order
items (the majority PO); the request is rejected if the shipment has none.




## OpenAPI

````yaml /api-reference/build.yaml post /integration-mappings/{id}
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:
  /integration-mappings/{id}:
    post:
      tags:
        - Integration Mappings
      summary: Update an integration mapping
      description: >
        Update an existing integration mapping by ID.


        When changing `mapping_config`, see the [Integration Mapping
        Guide](/integration-mapping-guide)

        for the rule structure, field-path syntax, the full transformation
        catalogue, and

        fallback behavior.


        At most one of `source_order_id`, `source_product_id`, or
        `source_purchase_order_id`

        may be set on a single request.
        `source_supplier_purchase_order_shipment_id` links the

        mapping to an inbound purchase-order shipment (for
        `PUSH_INBOUND_SHIPMENT` mappings).

        On these inbound-shipment mappings, updating
        `source_supplier_purchase_order_shipment_id`

        alone re-infers `source_purchase_order_id` from the shipment's linked
        purchase-order

        items (the majority PO); the request is rejected if the shipment has
        none.
      operationId: updateIntegrationMapping
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: integer
          description: Integration mapping ID
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
              properties:
                name:
                  type: string
                  maxLength: 255
                description:
                  type: string
                  nullable: true
                source_order_id:
                  type: integer
                  nullable: true
                  description: >-
                    Source fulfillment order. Mutually exclusive with the other
                    two `source_*` order fields.
                source_product_id:
                  type: integer
                  nullable: true
                  description: >-
                    Source product. Mutually exclusive with the other two
                    `source_*` order fields.
                source_purchase_order_id:
                  type: integer
                  nullable: true
                  description: >-
                    Source purchase order. Mutually exclusive with the other two
                    `source_*` order fields.
                source_supplier_purchase_order_shipment_id:
                  type: integer
                  nullable: true
                  description: >-
                    Inbound purchase-order shipment the mapping is sourced from
                    (for `PUSH_INBOUND_SHIPMENT` mappings). Setting this without
                    `source_purchase_order_id` infers the purchase order from
                    the shipment's linked purchase-order items; the request is
                    rejected if the shipment has none.
                mapping_config:
                  type: array
                  nullable: true
                  items:
                    type: object
                is_active:
                  type: boolean
                  nullable: true
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    additionalProperties: true
                    description: >-
                      Updated integration mapping record (same shape as `GET
                      /integration-mappings/{id}`).
        '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: 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.

````