Search Products

POST 
/products/search

> The product search endpoint is only available on the Propeller legacy version. The cloud version of Propeller does not support this API. Instead, use the GraphQL APIs to query products.

Retrieves a list of products by using the search fields below. Results will be paginated.

Field	Type
term Search through any text indexed on a product, like name, descriptions, product codes, keywords, etc.	array[integer]
categoryId	integer
code	string
oemCode	string
eanCode	string
manufacturer	string
supplierCodes	array[string]
textFilters	array[TextFilter]
rangeFilers	array[RangeFilter]
priceFilters	PriceFilter
dateCreated	DateFilter
dateModified	date (yyyy-mm-ddThh:nn:ss)
orderBy	enum product_price= order by price product_name = order by name product_code = order by skuproduct_manufacturer = order by brand product_suppliercode = order by supplierCodeproduct_oemcode = order by oemCode directory_order = order by dateCreated product_supplier = order by supplier container_name = order by category name best_sold = order by number of times sold
orderDirection	enum ASC = ascending DESC = descending
offset	integer
page	integer

Product text filter

A text filter is used to search through text product fields and product attributes of type text, list, enum or enumlist, in which case searchId is the name of the attribute. When searching product fields, searchId can be:

• searchproduct_code: sku
• searchproduct_name: name
• searchproduct_suppliercode: supplierCode
• searchcode_supplier: supplier
• searchcode_manufacturer:brand
• searchproduct_oemcode: oemCode
• searchproduct_container_name: name of parent category

{
    "searchId": "MATERIAL_FRAME",
    "value": "Leer"
}

Product range filter

A range filter is used to search through numeric product attributes i.e. attributes of type integer or decimal, in which case searchId is the name of the attribute.

{
    "searchId": "WEIGHT",
    "from": 65.2,
    "to": 120
}

Product price filter

A price filter is a special price search object that can search through a range:

{
    "from": 150.23,
    "to": 500.25
}

Product date filter

A date filter is a special date search object that can search through a range:

{
    "from": "2020-12-12T00:00:00",
    "to": "2022-12-12T00:00:00"
}

Request

application/json

Body

categoryId number
code string

dateCreated

object

from string

to string

dateModified

object

from string

to string
eanCode string
manufacturer string
oemCode string
offset number
orderBy string
orderDirection string
page number

priceFilters

object

from number

to number

rangeFilters

object[]

Array [

from number

searchId string

to number

]

supplierCodes string[]
term string

textFilters

object[]

Array [

searchId string

value string

]

Responses

200

Loading...