Prerequisites
You should have
- an user-account enabled for api access & PIM access
- an api-client
- at least one product-record stored in your Hublify PIM
Hublify fulltext search
- Hublify supports a powerful multi-field search
- Search for multiple partial text-snippets
- Configure in which fields the standard search should search
Simple search
The most simplest search is executed by just providing the search phrase.
Request URL
https://{your hublify url}/api/eos_10/data_getList
Request parameter
{
"dataset": "product",
"fields": [
"pcode",
"name",
"drvd_categories",
"price"
],
"filter": {
"__SEARCH__": {
"phrase": "bundle 001", // Search phrase (entered by user)
}
}
}Response
{
"data": [
{
"pcode": "BP00001",
"name": "Das Bundle \"BP00001\" !",
"drvd_categories": {
"model": "productgroup",
"primaryKey": "node_id",
"displayKey": "node_name",
"data": [
{
"node_id": 3,
"node_code": "lightning_pendant",
"node_name": "H\u00e4ngeleuchten",
"node_path": "|Wohninterieur|Lampen|H\u00e4ngeleuchten"
}
]
},
"price": "799.9000"
}
],
"status": true
}Specifying searched fields
Sometimes you want to define explicitly the fields you want to search within
Request URL
https://{your hublify url}/api/eos_10/data_getList
Request parameter
{
"dataset": "product",
"fields": [
"pcode",
"name",
"drvd_categories",
"price"
],
"filter": {
"__SEARCH__": {
"phrase": "bundle 001", // Search phrase (entered by user)
"fields": [ // (optional) Define own fields to search in.
"name",
"node_path",
]
}
}
}Response
{
"data": [
{
"pcode": "BP00001",
"name": "Das Bundle \"BP00001\" !",
"drvd_categories": {
"model": "productgroup",
"primaryKey": "node_id",
"displayKey": "node_name",
"data": [
{
"node_id": 3,
"node_code": "lightning_pendant",
"node_name": "H\u00e4ngeleuchten",
"node_path": "|Wohninterieur|Lampen|H\u00e4ngeleuchten"
}
]
},
"price": "799.9000"
}
],
"status": true
}
Combine search with other filters
Very easy: Just combine your search parameters with the standard filter-parameters!
Paging of search results
Very easy: Just use the standard paging parameters.