> ## 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. # Create an integration mapping > Create a new integration mapping. The `mapping_config` payload defines how source fields are transformed into the destination shape. See the [Integration Mapping Guide](/integration-mapping-guide) for the rule structure, field-path syntax, the full transformation catalogue, and fallback behavior. A mapping may optionally be seeded from an existing source record by passing one of the `source_*` foreign keys. `source_supplier_purchase_order_shipment_id` seeds the mapping from an inbound purchase-order shipment and is used together with `action: PUSH_INBOUND_SHIPMENT`. For inbound-shipment mappings you may pass `source_supplier_purchase_order_shipment_id` on its own — `source_purchase_order_id` is then inferred from the shipment's linked purchase-order items (the majority PO). The request is rejected if the shipment has no linked purchase-order items. ## OpenAPI ````yaml /api-reference/build.yaml post /integration-mappings 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: post: tags: - Integration Mappings summary: Create an integration mapping description: > Create a new integration mapping. The `mapping_config` payload defines how source fields are transformed into the destination shape. See the [Integration Mapping Guide](/integration-mapping-guide) for the rule structure, field-path syntax, the full transformation catalogue, and fallback behavior. A mapping may optionally be seeded from an existing source record by passing one of the `source_*` foreign keys. `source_supplier_purchase_order_shipment_id` seeds the mapping from an inbound purchase-order shipment and is used together with `action: PUSH_INBOUND_SHIPMENT`. For inbound-shipment mappings you may pass `source_supplier_purchase_order_shipment_id` on its own — `source_purchase_order_id` is then inferred from the shipment's linked purchase-order items (the majority PO). The request is rejected if the shipment has no linked purchase-order items. operationId: createIntegrationMapping requestBody: required: true content: application/json: schema: type: object additionalProperties: true required: - name - action properties: name: type: string maxLength: 255 description: Human-readable name for the mapping. description: type: string nullable: true action: type: string enum: - PUSH_ORDERS - PUSH_PRODUCTS - PUSH_INBOUND_SHIPMENT description: What the mapping transforms. source_type: type: string nullable: true enum: - FULFILLMENT_ORDER - PRODUCT - PURCHASE_ORDER description: Type of record the mapping reads from. source_integration_account_id: type: integer nullable: true description: Integration account the source payload comes from. destination_integration_account_id: type: integer nullable: true description: Integration account the transformed payload is pushed to. source_order_id: type: integer nullable: true description: Seed the mapping from an existing fulfillment order. source_product_id: type: integer nullable: true description: Seed the mapping from an existing product. source_purchase_order_id: type: integer nullable: true description: > Seed the mapping from an existing purchase order. For `PUSH_INBOUND_SHIPMENT` mappings this may be omitted when `source_supplier_purchase_order_shipment_id` is provided — it is then inferred from the shipment's majority linked purchase-order items. source_supplier_purchase_order_shipment_id: type: integer nullable: true description: > Seed the mapping from an existing inbound purchase-order shipment. Used with `action: PUSH_INBOUND_SHIPMENT`. May be supplied without `source_purchase_order_id`, in which case the purchase order is inferred from the shipment's linked purchase-order items; the request is rejected if the shipment has none. mapping_config: type: array nullable: true description: > Transformation rules. See the [Integration Mapping Guide](/integration-mapping-guide) for the rule structure and field-path syntax. items: type: object source_schema: type: array nullable: true items: type: object destination_schema: type: array nullable: true items: type: object is_active: type: boolean nullable: true responses: '201': description: Integration mapping created content: application/json: schema: type: object properties: data: type: object '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. ````