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

# Price Levels

> Get a paginated list of price levels with optional filtering.

For detailed information about the filtering system and available operators, 
refer to the [Filter System Documentation](/filters).

## Available Filters
### String Filters
- `name`: Level name
- `type`: Level type

### Float Filters
- `percent_increase`: Percentage increase for the price level

## Examples
```
# Find levels by name
?name[eq]=Retail

# Find levels by type
?type[eq]=percentage

# Find levels with specific percentage increase
?percent_increase[gte]=10
```




## OpenAPI

````yaml /api-reference/build.yaml get /price-levels
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:
  /price-levels:
    get:
      tags:
        - Pricing
      summary: Price Levels
      description: >
        Get a paginated list of price levels with optional filtering.


        For detailed information about the filtering system and available
        operators, 

        refer to the [Filter System Documentation](/filters).


        ## Available Filters

        ### String Filters

        - `name`: Level name

        - `type`: Level type


        ### Float Filters

        - `percent_increase`: Percentage increase for the price level


        ## Examples

        ```

        # Find levels by name

        ?name[eq]=Retail


        # Find levels by type

        ?type[eq]=percentage


        # Find levels with specific percentage increase

        ?percent_increase[gte]=10

        ```
      operationId: getPriceLevels
      parameters:
        - name: page
          in: query
          schema:
            type: integer
            default: 1
            minimum: 1
          description: Page number for pagination (starts at 1)
        - name: limit
          in: query
          schema:
            type: integer
            default: 10
            minimum: 1
            maximum: 100
          description: Number of items per page (max 100)
        - name: sort
          in: query
          schema:
            type: string
            default: id:desc
          description: |
            Sort results by field and direction. Format: `field:direction`

            Examples:
            - `name:asc` - Sort by name in ascending order
            - `created_at:desc` - Sort by creation date in descending order
            - `id:asc` - Sort by ID in ascending order

            Default is `id:desc` 
        - in: query
          name: name
          schema:
            type: string
          description: Filter by level name
        - in: query
          name: type
          schema:
            type: string
          description: Filter by level type
        - in: query
          name: percent_increase
          schema:
            type: number
            format: float
          description: Filter by percentage increase
      responses:
        '200':
          description: A list of price levels
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: number
                          description: Unique identifier for the price level
                          example: 123
                        created_at:
                          type: string
                          format: date-time
                          description: When the price level was created
                          example: '2023-03-15T14:30:00Z'
                        updated_at:
                          type: string
                          format: date-time
                          description: When the price level was last updated
                          example: '2023-03-15T14:30:00Z'
                        status:
                          type: string
                          description: Status of the price level
                          enum:
                            - active
                            - inactive
                          example: active
                        name:
                          type: string
                          description: Name of the price level
                          example: Wholesale
                        type:
                          type: string
                          description: Type of the price level
                          example: percentage
                        percent_increase:
                          type: number
                          format: float
                          description: >-
                            Percentage increase (or decrease) for this price
                            level
                          example: 15.5
                  meta:
                    type: object
                    properties:
                      current_page:
                        type: integer
                        description: The current page number
                        example: 1
                      from:
                        type: integer
                        description: The starting index of the paginated results
                        example: 1
                      last_page:
                        type: integer
                        description: The last page number
                        example: 5
                      per_page:
                        type: integer
                        description: Number of items per page
                        example: 10
                      to:
                        type: integer
                        description: The ending index of the paginated results
                        example: 10
                      total:
                        type: integer
                        description: Total number of items across all pages
                        example: 50
        '401':
          description: Authentication credentials were missing or invalid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Unauthorized
                  message:
                    type: string
                    example: Authentication credentials are missing or invalid
                  status_code:
                    type: integer
                    example: 401
        '403':
          description: You do not have permission to perform this action
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Forbidden
                  message:
                    type: string
                    example: You do not have permission to access this resource
                  status_code:
                    type: integer
                    example: 403
      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.

````