Search

Sleekshop provides powerful search capabilities to help you find various types of data in your e-commerce system. On this page, we'll explore the different search endpoints you can use to find products, contents, orders, users, warehouse entities, and classes.

POSTsearch_products

Search products

This endpoint allows you to search for products based on specified criteria.

Required attributes

Name
constraint
Type
object
Description
A constraint defining which products to deliver.
Name
language
Type
string
Description
A valid language code.
Name
country
Type
string
Description
A valid country code.

Optional attributes

Name
order_columns
Type
array
Description
The columns to order by.
Name
order_type
Type
string
Description
The order of sorting (ASC or DESC).
Name
left_limit
Type
integer
Description
The left limit of your selection.
Name
right_limit
Type
integer
Description
The right limit of your selection.
Name
needed_attributes
Type
array
Description
The attributes you want to be listed.

Request

POST

search_products

curl https://demo.sleekshop.net/srv/service/ \
-d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \
-d licence_password='s9vmrbwT23B7bmjR4Vmz' \
-d request='search_products' \
-d constraint='{"name":["LIKE","a"]}' \
-d language="de_DE" \
-d country="DE" \
-d order_columns='["price"]' \
-d order_type="DESC" \
-d left_limit=0 \
-d right_limit=2 \
-d needed_attributes='["name","price"]'

Response

{
    "object": "search_products_result",
    "count": 16,
    "limit_count": 2,
    "result": [
        {
            "object": "product",
            "id": 30,
            "name": "Polar Jacket blau",
            "creation_date": "2016-03-25 14:36:37",
            "class": "colorprod",
            "seo": {
                "permalink": "blaue-funktionsjacke-baumwolle",
                "title": "Damen Funktionsjacke aus BIO-Baumwolle",
                "description": "Blaue Funktionsjacke für Damen",
                "keywords": "damen,blau,bio,baumwolle,funktionsjacke"
            },
            "availability": {
                "quantity": 0,
                "quantity_warning": 0,
                "allow_override": 0,
                "active": 0
            },
            "metadata": {
                "element_number": "",
                "taxclass": {
                    "name": "Standard",
                    "calculation": "INC",
                    "value": 0.19
                },
                "length": 0,
                "width": 0,
                "height": 0,
                "weight": 0,
                "notes": ""
            },
            "attributes": {
                "name": {
                    "type": "CHAR",
                    "id": 366,
                    "name": "name",
                    "label": "Name",
                    "value": "Polar Jacket blau"
                },
                "price": {
                    "type": "FLOAT",
                    "id": 369,
                    "name": "price",
                    "label": "Preis",
                    "value": 75
                }
            },
            "variations": {
            // Variations data...
            }
        },
    // More products...
    ]
}

POSTsearch_contents

Search contents

This endpoint allows you to search for content objects based on specified criteria.

Required attributes

Name
constraint
Type
object
Description
The constraint determining which contents to deliver.
Name
language
Type
string
Description
A valid language code.

Optional attributes

Name
order_columns
Type
array
Description
The columns to order by.
Name
order_type
Type
string
Description
The order of sorting (ASC or DESC).
Name
left_limit
Type
integer
Description
The left limit of your selection.
Name
right_limit
Type
integer
Description
The right limit of your selection.
Name
needed_attributes
Type
array
Description
The attributes you want to be listed.

Request

POST

search_contents

curl https://demo.sleekshop.net/srv/service/ \
-d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \
-d licence_password='s9vmrbwT23B7bmjR4Vmz' \
-d request='search_contents' \
-d constraint='{"main.name":["LIKE","a"]}' \
-d language="de_DE" \
-d order_columns='["price"]' \
-d order_type="DESC" \
-d left_limit=0 \
-d right_limit=2 \
-d needed_attributes='["name","price"]'

Response

{
    "object": "search_contents_result",
    "count": 3,
    "limit_count": 2,
    "result": [
        {
            "object": "content",
            "id": 5,
            "name": "Teaser 1",
            "creation_date": "2016-03-25 12:38:23",
            "class": "teaser_pic",
            "seo": {
                "permalink": "",
                "title": "",
                "description": "",
                "keywords": ""
            },
            "attributes": {},
            "variations": {}
        },
    // More contents...
    ]
}

POSTsearch_orders

Search orders

This endpoint allows you to search for orders based on specified criteria.

Required attributes

Name
constraint
Type
object
Description
A valid constraint.
Name
language
Type
string
Description
A valid language code.

Optional attributes

Name
order_columns
Type
array
Description
The columns to order by.
Name
order_type
Type
string
Description
The order of sorting (ASC or DESC).
Name
left_limit
Type
integer
Description
The left limit of your selection.
Name
right_limit
Type
integer
Description
The right limit of your selection.
Name
needed_attributes
Type
array
Description
The attributes you want to be listed.

Request

POST

search_orders

curl https://demo.sleekshop.net/srv/service/ \
-d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \
-d licence_password='s9vmrbwT23B7bmjR4Vmz' \
-d request='search_orders' \
-d constraint='{"delivery_firstname":"kaveh"}' \
-d language="de_DE" \
-d left_limit=0 \
-d right_limit=1

Response

{
    "object": "search_orders_result",
    "count": 12,
    "limit_count": 1,
    "result": [
        {
            "object": "order",
            "id": 3,
            "order_number": 3,
            "creation_date": "2016-11-13 16:31:46",
            "username": "root",
            "order_delivery_firstname": "kaveh",
            // More order details...
        }
    ]
}

POSTsearch_users

Search users

This endpoint allows you to search for users based on specified criteria.

Required attributes

Name
constraint
Type
object
Description
A constraint defining which users to deliver.

Optional attributes

Name
order_columns
Type
array
Description
The columns to order by.
Name
order_type
Type
string
Description
The order of sorting (ASC or DESC).
Name
left_limit
Type
integer
Description
The left limit of your selection.
Name
right_limit
Type
integer
Description
The right limit of your selection.
Name
needed_attributes
Type
array
Description
The attributes you want to be listed.

Request

POST

search_users

curl https://demo.sleekshop.net/srv/service/ \
-d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \
-d licence_password='s9vmrbwT23B7bmjR4Vmz' \
-d request='search_users' \
-d constraint='{"username":["LIKE","testuser"]}' \
-d order_columns='["reg_date"]' \
-d order_type="DESC" \
-d left_limit=0 \
-d right_limit=1

Response

{
    "object": "search_users_result",
    "count": 1,
    "limit_count": 1,
    "result": [
        {
            "object": "user",
            "status": "active",
            "id_user": 481,
            "username": "testuser",
            "email": "test123@test123.de",
            "default_language": "de_DE",
            "reg_date": "2023-05-17 01:56:51",
            "first_login": "",
            "last_login": "",
            "attributes": {
                "salutation": {
                    "name": "salutation",
                    "value": "Mrs"
                },
                "firstname": {
                    "name": "firstname",
                    "value": "test1"
                },
                // More attributes...
            },
            "additional_attributes": {},
            "addresses": []
        }
    ]
}

POSTsearch_warehouse_entities

Search warehouse entities

This endpoint allows you to search for warehouse entities based on specified criteria.

Required attributes

Name
constraint
Type
object
Description
A constraint defining which warehouse entities to deliver.
Name
language
Type
string
Description
A valid language code.

Optional attributes

Name
order_columns
Type
array
Description
The columns to order by.
Name
order_type
Type
string
Description
The order of sorting (ASC or DESC).
Name
left_limit
Type
integer
Description
The left limit of your selection.
Name
right_limit
Type
integer
Description
The right limit of your selection.
Name
needed_attributes
Type
array
Description
The attributes you want to be listed.

Request

POST

search_warehouse_entities

curl https://demo.sleekshop.net/srv/service/ \
-d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \
-d licence_password='s9vmrbwT23B7bmjR4Vmz' \
-d licence_secret_key='' \
-d request='search_warehouse_entities' \
-d constraint='{"name":["LIKE","a"]}' \
-d language="de_DE" \
-d order_columns='["price"]' \
-d order_type="DESC" \
-d left_limit=0 \
-d right_limit=2 \
-d needed_attributes='["name","price"]'

Response

{
    "object": "search_warehouse_entities_result",
    "count": 4,
    "limit_count": 2,
    "result": [
        {
            "object": "warehouse_entity",
            "id": 153,
            "name": "tchibo_1_blonde_roast",
            "creation_date": "2021-02-25 00:52:52",
            "class": "product",
            "availability": {
                "quantity": 0,
                "quantity_warning": 0
            },
            "metadata": {
                "element_number": "",
                "length": 0,
                "width": 0,
                "height": 0,
                "weight": 0,
                "notes": ""
            },
            "attributes": {
                "name": {
                    "type": "CHAR",
                    "id": 2343,
                    "name": "name",
                    "label": "Name",
                    "value": "Blonde Roast"
                },
                "price": {
                    "type": "FLOAT",
                    "id": 2346,
                    "name": "price",
                    "label": "Preis",
                    "value": 9
                }
            }
        },
    // More warehouse entities...
    ]
}

POSTsearch_classes

Search classes

This endpoint allows you to search for classes based on specified criteria.

Required attributes

Name
constraint
Type
object
Description
A constraint defining which classes to deliver.
Name
language
Type
string
Description
A valid language code.

Optional attributes

Name
order_columns
Type
array
Description
The columns to order by.
Name
order_type
Type
string
Description
The order of sorting (ASC or DESC).
Name
left_limit
Type
integer
Description
The left limit of your selection.
Name
right_limit
Type
integer
Description
The right limit of your selection.

Request

POST

search_classes

curl https://demo.sleekshop.net/srv/service/ \
-d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \
-d licence_password='s9vmrbwT23B7bmjR4Vmz' \
-d licence_secret_key='' \
-d request='search_classes' \
-d constraint='{"name":["LIKE","a"]}' \
-d language="de_DE" \
-d order_columns='["name"]' \
-d order_type="DESC" \
-d left_limit=0 \
-d right_limit=2

Response

{
    "object": "search_classes_result",
    "count": 1,
    "limit_count": 1,
    "result": [
        {
            "object": "class",
            "id": 265,
            "name": "test",
            "creation_date": "2024-06-14 02:01:51",
            "attributes": {
                "name": {
                    "type": "CHAR",
                    "id": 5123,
                    "name": "name",
                    "label": "Name",
                    "value": ""
                },
                "short_description": {
                    "type": "TXT",
                    "id": 5124,
                    "name": "short_description",
                    "label": "Kurzbeschreibung",
                    "value": ""
                },
                "price": {
                    "type": "FLOAT",
                    "id": 5125,
                    "name": "price",
                    "label": "Preis",
                    "value": 0
                }
            }
        }
    ]
}

POSTsearch_distinct_products

Search distinct products

This endpoint allows you to search for distinct values of a specific field in products.

Required attributes

Name
constraint
Type
object
Description
A valid constraint array in JSON format.
Name
field
Type
string
Description
The name of the field to search for distinct values.
Name
language
Type
string
Description
A valid language code.

Request

POST

search_distinct_products

curl https://demo.sleekshop.net/srv/service/ \
-d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \
-d licence_password='s9vmrbwT23B7bmjR4Vmz' \
-d request='search_distinct_products' \
-d field='name' \
-d constraint='{"main.name":["LIKE","a"]}' \
-d language="de_DE"

Response

{
    "object": "search_distinct_products_result",
    "count": 13,
    "result": [
        "Polar Jacket pink",
        "Polar Jacket blau",
        "winterjacke rot L",
        "Winterjacke rot S",
        "Winterjacke rot M",
        "winterjacke rot XL",
        "Laufschuh blau",
        "Sneakers italian",
        "Schneehut dunkelblau",
        "Mütze blau",
        "Mütze orange",
        "Sneakers grün",
        "Schneehut schwarz"
    ]
}