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

List Products

Testing

GET

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

Retrieve a list of all products with extensive filtering options.

💡 Use Cases

Full Product Synchronization

🔑 Scopes

products.read - Products Read

Request

Query Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.zid.sa/v1/products/?page=&page_size=&product_class=voucher&is_published=true&quantity=10&category_id=1462448&search=Backpack&ordering=created_at' \
--header 'Accept-Language: en' \
--header 'Access-Token: {{Access-Token}}' \
--header 'Authorization: {{Autherization}}' \
--header 'Store-Id: 3' \
--header 'Role: Manager'

Responses

🟢200List of products

application/json

Body

Example

{
    "total_products_count": 2273,
    "normal_products_count": 2268,
    "voucher_products_count": 2,
    "grouped_products_count": 1,
    "downloadable_products_count": 0,
    "dynamic_bundle_products_count": 2,
    "donation_item_count": 0,
    "crowd_funding_count": 0,
    "next": null,
    "previous": null,
    "count": 0,
    "results": []
}

🟠401Unauthorized

🔴500Internal Server error

Modified at 2026-02-05 15:36:42

Managing Products

View Product