Get a paginated list of products with optional filtering.
For detailed information about the filtering system and available operators, refer to the Filter System Documentation.
name: Product namedescription: Product descriptionsku: Product SKU (searches both internal SKU and alternate SKUs)upc: Product UPC/Barcodetag: Product tagsq: General search matches name OR upc OR skucategory.name: Filter by category namesub_category.name: Filter by sub-category namesupplier.name: Filter by supplier namecategory.id: Filter by category IDsub_category.id: Filter by sub-category IDsupplier.id: Filter by supplier IDbom.id: Filter by Bill of Materials ID (returns products attached to the specified BOM)kit_items.product_id: Filter by kit item product ID (returns kit products that contain the specified product as a component)type: Filter by product type (PRODUCT or KIT)retail_price: Product retail pricewholesale_price: Product wholesale priceproduct_weight: Product weightproduct_length: Product lengthproduct_width: Product widthproduct_height: Product heightbox_length: Box lengthbox_width: Box widthbox_height: Box heightcarton_length: Carton lengthcarton_width: Carton widthcarton_height: Carton heightshipping_length: Shipping lengthshipping_width: Shipping widthshipping_height: Shipping heightpallet_length: Pallet lengthpallet_width: Pallet widthpallet_height: Pallet heightbox_weight: Box weightcarton_weight: Carton weightshipping_weight: Shipping weightpallet_weight: Pallet weightsellable: If the product is sellable or notdiscontinued: If the product is discontinuedcreated_at: When the product was createdupdated_at: When the product was last updated# Find products by SKU (includes alternate SKUs)
?sku[eq]=SKU-001
# Find products with specific price range
?retail_price[gte]=50.00&retail_price[lte]=100.00
# Find recently updated products
?updated_at[gte]=2024-01-01 00:00:00
# Search products by name
?name[contains]=Test Product
# Find products by category and sub-category
?category.name[eq]=Electronics&sub_category.name[eq]=Smartphones
# Find products by supplier
?supplier.name[contains]=Acme
# Find products by type
?type=PRODUCT
?type=KIT
# Find kit products that contain a specific product as a component
?kit_items.product_id=123
# Find products by dimension filters
?product_length[gt]=10.0&product_width[lt]=20.0
?box_length[eq]=12.5
?carton_height[gte]=10.0
?shipping_length[lte]=18.0
?pallet_width[gt]=40.0
Authenticate using a bearer token. To obtain a token, contact [email protected]
Page number for pagination
Number of items per page (max 100)
x <= 100Filter by name OR upc OR sku
Filter by product name
Filter by product description
Filter by SKU (searches both internal and alternate SKUs)
Filter by UPC/Barcode
Filter by sellable status
Filter by whether the product is discontinued
Filter by retail price
Filter by wholesale price
Filter by creation date
Filter by last update date
Filter by product tags
Filter by category ID
Filter by category name
Filter by sub-category ID
Filter by sub-category name
Filter by supplier ID
Filter by supplier name
Filter by Bill of Materials ID (returns products attached to the specified BOM)
Filter by kit item product ID (returns kit products that contain the specified product as a component)
Filter by product type (PRODUCT for regular products, KIT for kit products)
PRODUCT, KIT Filter by product weight
Filter by product length
Filter by product width
Filter by product height
Filter by box weight
Filter by box length
Filter by box width
Filter by box height
Filter by carton weight
Filter by carton length
Filter by carton width
Filter by carton height
Filter by shipping weight
Filter by shipping length
Filter by shipping width
Filter by shipping height
Filter by pallet weight
Filter by pallet length
Filter by pallet width
Filter by pallet height