> ## 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. # Purchase order items > Get a paginated list of purchase order items with optional filtering. For detailed information about the filtering system and available operators, refer to the [Filter System Documentation](/filters). ### Available Filters #### Integer Filters - `purchase_order_id`: Filter by purchase order ID #### String Filters - `source_sku`: Source SKU on the purchase order item #### Float Filters - `quantity`: Ordered quantity - `received_quantity`: Quantity received - `unit_price`: Unit price of the item #### Boolean Filters - `on_shipment`: Whether the item is on a shipment (true) or not (false) #### DateTime Filters - `created_at`: When the purchase order item was created - `updated_at`: When the purchase order item was last updated ### Product Filters All product filters are available with the `product.` prefix. These filter based on the product associated with the purchase order item. #### String Filters - `product.name`: Product name - `product.description`: Product description - `product.sku`: Product SKU (searches both internal SKU and alternate SKUs) - `product.upc`: Product UPC/Barcode - `product.tag`: Product tags - `product.q`: General search matches name OR upc OR sku - `product.category.name`: Filter by category name - `product.sub_category.name`: Filter by sub-category name - `product.supplier.name`: Filter by supplier name #### Integer Filters - `product.id`: Product ID - `product.category.id`: Filter by category ID - `product.sub_category.id`: Filter by sub-category ID - `product.supplier.id`: Filter by supplier ID #### Float Filters - `product.retail_price`: Product retail price - `product.wholesale_price`: Product wholesale price #### Boolean Filters - `product.sellable`: If the product is sellable or not - `product.discontinued`: If the product is discontinued #### DateTime Filters - `product.created_at`: When the product was created - `product.updated_at`: When the product was last updated ## Examples ``` # Get all items for a specific purchase order ?purchase_order_id[eq]=123 # Find items with a specific source SKU ?source_sku[eq]=VENDOR-SKU-001 # Find items with quantity greater than 100 ?quantity[gt]=100 # Find items that have been partially received ?received_quantity[gt]=0&quantity[gt]=received_quantity # Find items that are on a shipment ?on_shipment[eq]=1 # Find items where the associated product is discontinued ?product.discontinued[eq]=1 # Find items by product category ?product.category.name[eq]=Electronics # Find items with products from a specific supplier ?product.supplier.name[contains]=Acme # Find items with unit price in a specific range ?unit_price[gte]=10.00&unit_price[lte]=50.00 # Find recently updated items ?updated_at[gte]=2024-01-01 00:00:00 # Combine multiple filters: items for a purchase order with products in a category ?purchase_order_id[eq]=123&product.category.name[eq]=Electronics # Find items for products with a specific SKU ?product.sku[eq]=PROD-SKU-001 ``` ## OpenAPI ````yaml /api-reference/build.yaml get /purchase-orders/items 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: /purchase-orders/items: get: tags: - Purchase Orders summary: Purchase order items description: > Get a paginated list of purchase order items with optional filtering. For detailed information about the filtering system and available operators, refer to the [Filter System Documentation](/filters). ### Available Filters #### Integer Filters - `purchase_order_id`: Filter by purchase order ID #### String Filters - `source_sku`: Source SKU on the purchase order item #### Float Filters - `quantity`: Ordered quantity - `received_quantity`: Quantity received - `unit_price`: Unit price of the item #### Boolean Filters - `on_shipment`: Whether the item is on a shipment (true) or not (false) #### DateTime Filters - `created_at`: When the purchase order item was created - `updated_at`: When the purchase order item was last updated ### Product Filters All product filters are available with the `product.` prefix. These filter based on the product associated with the purchase order item. #### String Filters - `product.name`: Product name - `product.description`: Product description - `product.sku`: Product SKU (searches both internal SKU and alternate SKUs) - `product.upc`: Product UPC/Barcode - `product.tag`: Product tags - `product.q`: General search matches name OR upc OR sku - `product.category.name`: Filter by category name - `product.sub_category.name`: Filter by sub-category name - `product.supplier.name`: Filter by supplier name #### Integer Filters - `product.id`: Product ID - `product.category.id`: Filter by category ID - `product.sub_category.id`: Filter by sub-category ID - `product.supplier.id`: Filter by supplier ID #### Float Filters - `product.retail_price`: Product retail price - `product.wholesale_price`: Product wholesale price #### Boolean Filters - `product.sellable`: If the product is sellable or not - `product.discontinued`: If the product is discontinued #### DateTime Filters - `product.created_at`: When the product was created - `product.updated_at`: When the product was last updated ## Examples ``` # Get all items for a specific purchase order ?purchase_order_id[eq]=123 # Find items with a specific source SKU ?source_sku[eq]=VENDOR-SKU-001 # Find items with quantity greater than 100 ?quantity[gt]=100 # Find items that have been partially received ?received_quantity[gt]=0&quantity[gt]=received_quantity # Find items that are on a shipment ?on_shipment[eq]=1 # Find items where the associated product is discontinued ?product.discontinued[eq]=1 # Find items by product category ?product.category.name[eq]=Electronics # Find items with products from a specific supplier ?product.supplier.name[contains]=Acme # Find items with unit price in a specific range ?unit_price[gte]=10.00&unit_price[lte]=50.00 # Find recently updated items ?updated_at[gte]=2024-01-01 00:00:00 # Combine multiple filters: items for a purchase order with products in a category ?purchase_order_id[eq]=123&product.category.name[eq]=Electronics # Find items for products with a specific SKU ?product.sku[eq]=PROD-SKU-001 ``` operationId: getPurchaseOrderItems parameters: - in: query name: page schema: type: integer default: 1 description: Page number for pagination - in: query name: per_page schema: type: integer default: 10 maximum: 100 description: Number of items per page (max 100) - in: query name: purchase_order_id schema: type: integer description: Filter by purchase order ID - in: query name: source_sku schema: type: string description: Filter by source SKU - in: query name: quantity schema: type: number format: float description: Filter by ordered quantity - in: query name: received_quantity schema: type: number format: float description: Filter by received quantity - in: query name: unit_price schema: type: number format: float description: Filter by unit price - in: query name: on_shipment schema: type: boolean description: Filter by whether the item is on a shipment - in: query name: created_at schema: type: string format: date-time description: Filter by creation date - in: query name: updated_at schema: type: string format: date-time description: Filter by last update date - in: query name: product.id schema: type: integer description: Filter by product ID - in: query name: product.name schema: type: string description: Filter by product name - in: query name: product.description schema: type: string description: Filter by product description - in: query name: product.sku schema: type: string description: Filter by product SKU (searches both internal and alternate SKUs) - in: query name: product.upc schema: type: string description: Filter by product UPC/Barcode - in: query name: product.sellable schema: type: boolean description: Filter by product sellable status - in: query name: product.discontinued schema: type: boolean description: Filter by whether the product is discontinued - in: query name: product.retail_price schema: type: number format: float description: Filter by product retail price - in: query name: product.wholesale_price schema: type: number format: float description: Filter by product wholesale price - in: query name: product.tag schema: type: string description: Filter by product tags - in: query name: product.category.id schema: type: integer description: Filter by product category ID - in: query name: product.category.name schema: type: string description: Filter by product category name - in: query name: product.sub_category.id schema: type: integer description: Filter by product sub-category ID - in: query name: product.sub_category.name schema: type: string description: Filter by product sub-category name - in: query name: product.supplier.id schema: type: integer description: Filter by product supplier ID - in: query name: product.supplier.name schema: type: string description: Filter by product supplier name - in: query name: product.q schema: type: string description: General product search (matches name OR upc OR sku) responses: '200': description: Successful response content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: integer description: Line item ID purchase_order_id: type: integer description: ID of the parent purchase order created_at: type: string format: date-time description: Creation timestamp updated_at: type: string format: date-time description: Last update timestamp quantity: type: number format: float description: Quantity ordered unit_price: type: number format: float description: Price per unit unit: type: string nullable: true description: Unit of measure tax: type: number format: float description: Tax amount discount_amount: type: number format: float description: Discount amount line_total: type: number format: float description: Total for this line item received_quantity: type: number format: float description: Quantity received source_sku: type: string nullable: true description: Source SKU from the supplier product: type: object nullable: true description: Associated product information properties: id: type: integer description: Product ID name: type: string description: Product name description: type: string nullable: true description: Product description retail_price: type: number format: float description: Product retail price wholesale_price: type: number format: float description: Product wholesale price unit_cost: type: number format: float description: Product unit cost product_weight: type: number format: float description: Product weight product_length: type: number format: float description: Product length (in inches) product_width: type: number format: float description: Product width (in inches) product_height: type: number format: float description: Product height (in inches) sellable: type: boolean description: Whether the product is sellable discontinued: type: boolean description: Whether the product is discontinued image_url: type: string nullable: true description: Product image URL variant_attributes: type: object nullable: true description: Product variant attributes sku: type: string description: Product internal SKU upc: type: string description: Product UPC/Barcode created_at: type: string format: date-time description: Product creation timestamp updated_at: type: string format: date-time description: Product last update timestamp base_unit_of_measure: type: object nullable: true description: Base unit of measure properties: id: type: integer name: type: string abbreviation: type: string ordered_unit_of_measure: type: object nullable: true description: Ordered unit of measure properties: id: type: integer name: type: string abbreviation: type: string lot: type: object nullable: true description: Product lot information properties: id: type: integer lot_number: type: string expiration_date: type: string format: date nullable: true 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: 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. ````