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

# Push a product to an OMS/WMS integration

> Pushes a single Luminous product (RFQ) to a destination OMS/WMS integration account — for example
creating or updating the matching product/variant in a connected TrackStar-backed system.

Set `debug` to `true` to enable request tracing; the response then includes a `debug` object with the
outbound HTTP requests made to the third party (the same pattern as the External fulfillment-order push).

Returns `200` when the push succeeds and `422` when it fails; inspect `data.success` and `data.message`
for the outcome in both cases.




## OpenAPI

````yaml /api-reference/build.yaml post /products/{productId}/push
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:
  /products/{productId}/push:
    post:
      tags:
        - Products
      summary: Push a product to an OMS/WMS integration
      description: >
        Pushes a single Luminous product (RFQ) to a destination OMS/WMS
        integration account — for example

        creating or updating the matching product/variant in a connected
        TrackStar-backed system.


        Set `debug` to `true` to enable request tracing; the response then
        includes a `debug` object with the

        outbound HTTP requests made to the third party (the same pattern as the
        External fulfillment-order push).


        Returns `200` when the push succeeds and `422` when it fails; inspect
        `data.success` and `data.message`

        for the outcome in both cases.
      operationId: pushProductToIntegration
      parameters:
        - in: path
          name: productId
          required: true
          schema:
            type: integer
          description: Luminous product (RFQ) ID to push.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - destination_integration_account_id
              properties:
                destination_integration_account_id:
                  type: integer
                  description: >-
                    ID of the destination integration account to push the
                    product to.
                update_existing_variants:
                  type: boolean
                  default: true
                  description: >
                    When `true` (the default), variants (child SKUs) that are
                    already linked to the destination

                    integration are re-synced on push, so product-level changes
                    propagate to existing mappings.

                    Set to `false` to only create newly added variants and leave
                    already-mapped variants untouched

                    (the push then reports success without updating existing
                    variants).
                debug:
                  type: boolean
                  default: false
                  description: >-
                    When `true`, enables request tracing and returns a `debug`
                    object in the response.
      responses:
        '200':
          description: Push completed
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                      message:
                        type: string
                        nullable: true
                      data:
                        type: object
                        nullable: true
                        additionalProperties: true
                        description: >-
                          Push result payload from the integration, when
                          present.
                      debug:
                        type: object
                        nullable: true
                        additionalProperties: true
                        description: >-
                          Outbound HTTP request trace; only present when
                          `debug=true`.
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '422':
          description: Push failed (see `data.message`), or validation error
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                      message:
                        type: string
                        nullable: true
      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.

````