Themes built on the Twig templating engine are now deprecated and require migration to Vitrin to ensure continued support and compatibility with Zid.

Search Products

Developing

GET

https://api.zid.sa//products/search

Searches for products using a free-text query with support for pagination, sorting, and advanced filters such as category, price range, sale status, and attribute values.

This endpoint is optimized for search-driven experiences (e.g., global search, autocomplete results, filtered search pages).

Request

Body Params application/jsonRequired

Example

{
    "page": 1,
    "page_size": 24,
    "q": "running shoes",
    "sort_by": "popularity_order",
    "order": "asc",
    "categories": "sports",
    "price_min": 100,
    "price_max": 500,
    "on_sale": true,
    "attribute_values": [
        "black",
        "size-42"
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.zid.sa//products/search' \
--header 'Content-Type: application/json' \
--data-raw '{
    "page": 1,
    "page_size": 24,
    "q": "running shoes",
    "sort_by": "popularity_order",
    "order": "asc",
    "categories": "sports",
    "price_min": 100,
    "price_max": 500,
    "on_sale": true,
    "attribute_values": [
        "black",
        "size-42"
    ]
}'

Responses

🟢200Success

application/json

Body

Example

"Success"

🟠422Validation Error

Modified at 2025-12-18 07:38:00

List Products

Calculate Product Options Price