Skip to main content

Search Products

POST 
/api/v2/products

Returns the same paginated product catalog list as the GET version of this endpoint, but accepts filters as a JSON request body instead of the query string. Use this POST variant when the filter set is too large or too complex to fit in a URL (for example, filtering by a long list of SKUs or ids). The response includes an unfiltered_total alongside the standard paginator totals so clients can show both the filtered and total record counts.

Required scope: products:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Provide advanced filters under filter_groups, a tree of conditions combined with a conjunction of and or or. Each condition names a column, an operator, and a value. A free-text search term matches against id, SKU, name, barcode, MPN, and brand.

Text columns (sku, name, barcode, mpn, hts_code, brand_name, supplier_name, supplier_sku, tag, category, stock_uom_code, stock_uom_name, component_skus, parent_product) accept: is, is_not, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty, is_one_of, is_not_one_of. Numeric columns (id, unit_cost, average_cost, supplier_price, default_supplier_leadtime, default_supplier_moq, default_supplier_target_stock_days) accept: is, is_not, greater_than, greater_than_or_equal, less_than, less_than_or_equal, between, is_empty, is_not_empty. Additional filters include type, archived, brand_id, default_supplier_id, stock_uom_id, stock_status (in_stock / out_of_stock), has_backorder, and ids.

Sortable columns (via sort, prefix with - for descending): id, sku, name, type, barcode, mpn, hts_code, unit_cost, average_cost, supplier_price, weight, case_quantity, daily_average_consumption, min_stock_level, archived_at, created_at, updated_at, plus inventory snapshot sorts (inventory_available, inventory_available_to_sell, inventory_allocated, inventory_on_hold, inventory_in_transit, inventory_total, inventory_backorder, inventory_stock_value, inventory_incoming, total_quantity_sold, total_orders). Results default to -created_at.

Request​

Responses​

OK

Response Headers
    Content-Type