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.

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