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

# List available transformations

> Return every transformation the mapping engine can execute, with the shape of each
one's `transformationConfig`. The mapping editor renders directly from this catalogue,
and it is parity-tested against the transformation engine, so this list is exactly what
will run — never more, never less.

Some entries carry an `aliases` array of legacy identifiers that resolve to that type
(for example `round` accepts the legacy `roundToInt`). The engine accepts aliases on
input; the canonical `type` is what should be stored going forward.

Entries with `advanced: true` (such as `jsonExtract` and `customFunction`) are powerful
and should be gated in customer-facing UI.




## OpenAPI

````yaml /api-reference/build.yaml get /integration-mappings/transformations
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/transformations:
    get:
      tags:
        - Integration Mappings
      summary: List available transformations
      description: >
        Return every transformation the mapping engine can execute, with the
        shape of each

        one's `transformationConfig`. The mapping editor renders directly from
        this catalogue,

        and it is parity-tested against the transformation engine, so this list
        is exactly what

        will run — never more, never less.


        Some entries carry an `aliases` array of legacy identifiers that resolve
        to that type

        (for example `round` accepts the legacy `roundToInt`). The engine
        accepts aliases on

        input; the canonical `type` is what should be stored going forward.


        Entries with `advanced: true` (such as `jsonExtract` and
        `customFunction`) are powerful

        and should be gated in customer-facing UI.
      operationId: getIntegrationMappingTransformations
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          description: >-
                            Canonical transformation identifier used in
                            `mapping_config`.
                        label:
                          type: string
                          description: Human-readable name for the transformation.
                        description:
                          type: string
                        group:
                          type: string
                          description: Grouping used by the editor.
                          enum:
                            - text
                            - number
                            - date
                            - lookup
                            - convert
                            - advanced
                        advanced:
                          type: boolean
                          description: >-
                            Whether the transformation is advanced/powerful and
                            should be gated in customer-facing UI.
                        note:
                          type: string
                          nullable: true
                        aliases:
                          type: array
                          nullable: true
                          description: Legacy identifiers that resolve to this `type`.
                          items:
                            type: string
                        config:
                          type: array
                          description: >-
                            Settings the transformation accepts. Empty when the
                            transformation takes no configuration.
                          items:
                            type: object
                            properties:
                              key:
                                type: string
                                description: >-
                                  Config key stored under
                                  `transformationConfig`.
                              label:
                                type: string
                              type:
                                type: string
                                description: Rendering hint for the setting.
                                enum:
                                  - string
                                  - number
                                  - boolean
                                  - select
                                  - keyValue
                                  - code
                                  - json
                              required:
                                type: boolean
                              default:
                                nullable: true
                                description: >-
                                  Default value used when the setting is
                                  omitted.
                              help:
                                type: string
                                nullable: true
        '401':
          description: Unauthorized
          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.

````