> ## 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 Core inventory transactions

> List Luminous Core inventory ledger transactions (CITs) with offset pagination.

Luminous Core is a detailed inventory cost-tracking ledger. Each transaction represents a
quantity movement (receipt, shipment, adjustment, transfer, etc.) with its computed
`unit_cost` and `total_cost`. Every row includes a `_links` object with URLs to the
transaction detail.

This is distinct from the legacy `GET /reports/transaction-cogs` report, which reports
sales-item cost layers rather than Core ledger transactions.

**Availability:** These endpoints return **404** for tenants that do not have Luminous Core
enabled.




## OpenAPI

````yaml /api-reference/build.yaml get /core/inventory-transactions
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:
  /core/inventory-transactions:
    get:
      tags:
        - Core Inventory Ledger
      summary: List Core inventory transactions
      description: >
        List Luminous Core inventory ledger transactions (CITs) with offset
        pagination.


        Luminous Core is a detailed inventory cost-tracking ledger. Each
        transaction represents a

        quantity movement (receipt, shipment, adjustment, transfer, etc.) with
        its computed

        `unit_cost` and `total_cost`. Every row includes a `_links` object with
        URLs to the

        transaction detail.


        This is distinct from the legacy `GET /reports/transaction-cogs` report,
        which reports

        sales-item cost layers rather than Core ledger transactions.


        **Availability:** These endpoints return **404** for tenants that do not
        have Luminous Core

        enabled.
      operationId: listCoreInventoryTransactions
      parameters:
        - in: query
          name: page
          schema:
            type: integer
            default: 1
            minimum: 1
          description: Page number (offset pagination).
        - in: query
          name: per_page
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 100
          description: Rows per page (max 100).
        - in: query
          name: date[gte]
          schema:
            type: string
            format: date
          description: Only transactions on or after this date.
        - in: query
          name: date[lte]
          schema:
            type: string
            format: date
          description: Only transactions on or before this date.
        - in: query
          name: warehouse_id[in]
          schema:
            type: string
          description: Comma-separated warehouse ids to include.
        - in: query
          name: transaction_type[in]
          schema:
            type: string
          description: Comma-separated transaction types to include.
        - in: query
          name: linked_type
          schema:
            type: string
          description: >-
            Filter by the linked document type (e.g. `shipment`,
            `fulfillment_order`, `sales_order`, `adjustment`, `picklist`).
        - in: query
          name: item_id
          schema:
            type: integer
          description: Filter by product (RFQ) id.
        - in: query
          name: reference
          schema:
            type: string
          description: Search by linked document reference / order number.
        - in: query
          name: qty_filter
          schema:
            type: string
            enum:
              - all
              - increase
              - decrease
            default: all
          description: Restrict to quantity increases or decreases.
        - in: query
          name: unit_cost_filter
          schema:
            type: string
            enum:
              - all
              - gt0
              - zero
            default: all
          description: Restrict to rows with a non-zero or zero unit cost.
        - in: query
          name: sort_by
          schema:
            type: string
            enum:
              - date
              - qty
              - qty_available
              - unit_cost
              - total_cost
              - linked_order_number
            default: date
          description: Sort column.
        - in: query
          name: sort_dir
          schema:
            type: string
            enum:
              - asc
              - desc
            default: desc
          description: Sort direction.
      responses:
        '200':
          description: Paginated list of Core inventory transactions.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      description: A Core inventory ledger transaction (CIT) list row.
                      properties:
                        id:
                          type: integer
                        item_id:
                          type: integer
                          nullable: true
                          description: Product (RFQ) id.
                        transaction_type:
                          type: string
                          nullable: true
                        date:
                          type: string
                        stage_name:
                          type: string
                          nullable: true
                          description: Inventory stage name.
                        warehouse_name:
                          type: string
                          nullable: true
                        qty:
                          type: number
                        unit_cost:
                          type: number
                        total_cost:
                          type: number
                        qty_used:
                          type: number
                        qty_available:
                          type: number
                        is_stock_pull:
                          type: boolean
                        needs_cost_review:
                          type: boolean
                        product_sku:
                          type: string
                          nullable: true
                        product_name:
                          type: string
                          nullable: true
                        linked_type:
                          type: string
                          nullable: true
                          description: >-
                            Linked document type (e.g. `shipment`,
                            `fulfillment_order`, `sales_order`, `adjustment`,
                            `picklist`).
                        linked_id:
                          type: integer
                          nullable: true
                        linked_order_number:
                          type: string
                          nullable: true
                        channel:
                          type: string
                          nullable: true
                        po_number:
                          type: string
                          nullable: true
                        external_po_id:
                          type: integer
                          nullable: true
                        badges:
                          type: array
                          description: >-
                            UI badges describing the row (e.g. stock pull, needs
                            review).
                          items:
                            type: object
                        _links:
                          type: object
                          properties:
                            self:
                              type: string
                              format: uri
                            detail:
                              type: string
                              format: uri
                  meta:
                    type: object
                    properties:
                      current_page:
                        type: integer
                      from:
                        type: integer
                        nullable: true
                      last_page:
                        type: integer
                      per_page:
                        type: integer
                      to:
                        type: integer
                        nullable: true
                      total:
                        type: integer
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '404':
          description: Luminous Core is not enabled for this tenant.
          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.

````