Inventory & Products | Products | Product Data | Get Products | Filters

Product Filters Overview

This page provides an overview of all available product filters in the ProLasku.fi API. Each filter allows you to refine your product search results based on specific criteria.

Available Product Filters

The following filters are available to help you narrow down your product search results:

Product IDs Filter

Filter products by specific product IDs. Supports single ID (pid), array of IDs (IN[]), or exclusion (NOT_IN[]).

Product Name Filter

Filter products by name. This filter enables searching for products that match a specific name or contain certain keywords in their name. Supports multi-word search with space or + separated keywords.

Category IDs Filter

Filter products by category IDs. Supports single category (cid) or array of categories (cid[]).

Brand IDs Filter

Filter products by brand IDs. Supports single brand (bid) or array of brands (bid[]).

Location ID Filter

Filter products by location ID. Only products with stock at the specified location are returned (uses INNER JOIN on tbl_stockcurrent). Also affects stock data — only stock for the specified location is included.

Barcode Filter

Filter products by barcode. Searches across tbl_products.barcode, tbl_products.box_code, and tbl_products_multi.code / tbl_products_multi.boxcode. Returns each matching product only once.

Discounted Products Filter

Filter for discounted products only. Set only_return_discounted_items=1 to return only products that currently have a discount applied.

Price Range Filter

Filter products by price range using min_price and max_price parameters. Values should be doubles representing net prices. Default range is 0 to 500000.

Discount Range Filter

Filter products by discount percentage range using discount_min and discount_max parameters. Values should be floats (e.g., 10.5 for 10.5%).

Supplier Filter

Filter products by supplier ID using supplier_id (single integer) or supplier_id[] (array of integers). For products with multi_code_supplier=1, this also checks the tbl_products_multi table. When combined with location_id, products with multi-supplier codes must match BOTH the supplier and location in the same row.

Product Tags Filter

Filter products by tag using products_tags_id (single integer) or products_tags_id[] (array of integers). Uses the tbl_product_tag_relations junction table. When multiple tag IDs are passed, products matching any of the tags are returned (OR logic).

Customer-Specific Pricing

Apply customer-specific pricing by passing customer_id. When provided, prices and discounts reflect the customer's negotiated pricing, including locked prices. The response will contain customer-specific price_gross, price_net_after_discount, price_gross_after_discount, and discount values.

Include Product Costs

Include product cost breakdown data in the response by setting include_costs=1. Adds a costs object to each product containing cost fields such as customs_fees, transportation_costs, warehousing, financial_costs, etc.

Custom WHERE Conditions

For advanced filtering, pass where[] as an array of conditions. Each condition is [column, value] or [column, value, operator]. Supported operators: =, !=, >, <, >=, <=, IN, NOT IN, LIKE, NOT LIKE, BETWEEN, NOT BETWEEN. Default operator is =.

Ordering

Control result ordering with the following parameters:

  • orderBy — Column to sort by. Supported: product_name, price, price_gross, price_net_after_discount, price_gross_after_discount, discount, category, brand, supplier, pid.
  • orderDir — Sort direction: ASC or DESC (default: ASC).
  • lang — Language code for multilingual sort fields (e.g., fi_FI, en_GB). Used when sorting by product_name, category, or brand.

Pagination

  • start — Offset (row number to start from). Default: 0.
  • limit — Number of results per request. Maximum: 50. Default: 50.

How to Use Filters

All filters can be combined in a single API call to narrow down your search results. When multiple filters are used together, they are applied with AND logic, meaning products must match all specified criteria.

For detailed implementation instructions and code examples for each filter, please visit the respective filter documentation page linked above. For the complete parameter reference, see the get_products documentation.

API Endpoint

All product filters use the same base endpoint:

  • Endpoint: https://easycms.fi/public_api/get_products/
  • Method: POST

Each filter adds specific parameters to this endpoint to refine the results.