Skip to main content

List Products

GET 
//:domain/api/products

List all products with DataTable support. Supports searching, sorting, filtering, pagination, and column selection.

Authentication: Requires Bearer token.

Filter scopes available on the Product model:

  • filter[type]: standard | bundle | kit | matrix
  • filter[brand]: brand name string
  • filter[category]: category name or path
  • filter[tag]: tag name
  • filter[supplier]: supplier name or ID

Sort fields: sku, name, barcode, type, created_at, updated_at, inventory_total, inventory_available, average_cost

Inclusion columns: sku, id, name, barcode, type, image, image_url, brand, price, weight, weight_unit, length, width, height, dimension_unit, case_quantity, inventory_total, inventory_available, inventory_allocated, inventory_on_hold, inventory_in_transit, inventory_incoming, average_cost, default_supplier, default_supplier_sku, suppliers, tags, attributes, created_at, updated_at, archived_at

Stock UoM filters (added 2026-05-30):

  • filter[stock_uom_id] — by uom_id (exact, comma-separated)
  • filter[stock_uom_code] — by UoM code (advanced text ops)
  • filter[stock_uom_name] — by UoM display name (advanced text ops)

Request​

Responses​

OK

Response Headers
    Content-Type