Themes built on the Twig templating engine are now deprecated and require migration to Vitrin to ensure continued support and compatibility with Zid.
{
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Page number to retrieve.",
"example": 1,
"default": 1
},
"page_size": {
"type": "integer",
"description": "Number of items returned per page.",
"example": 24,
"default": 24
},
"q": {
"type": ["string", "null"],
"description": "Search keyword used to filter products.",
"example": "t-shirt"
},
"sort_by": {
"type": ["string", "null"],
"description": "Field used to sort products.",
"enum": ["popularity_order", "price", "display_order", "created_at"],
"example": "price"
},
"order": {
"type": "string",
"description": "Sorting order direction.",
"enum": ["asc", "desc"],
"default": "asc",
"example": "desc"
},
"categories": {
"type": ["string", "null"],
"description": "Category identifier used to filter products.",
"example": "men-clothing"
},
"price_min": {
"type": ["number", "null"],
"description": "Minimum product price filter.",
"example": 50
},
"price_max": {
"type": ["number", "null"],
"description": "Maximum product price filter.",
"example": 300
},
"on_sale": {
"type": ["boolean", "null"],
"description": "Filters products that are currently on sale.",
"example": true
},
"attribute_values": {
"type": ["array", "null"],
"description": "List of attribute values used to filter products.",
"items": {
"type": "string"
},
"example": ["red", "large"]
}
}
}
curl --location --request GET 'https://api.zid.sa//products' \
--header 'Content-Type: application/json' \
--data-raw '{
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Page number to retrieve.",
"example": 1,
"default": 1
},
"page_size": {
"type": "integer",
"description": "Number of items returned per page.",
"example": 24,
"default": 24
},
"q": {
"type": ["string", "null"],
"description": "Search keyword used to filter products.",
"example": "t-shirt"
},
"sort_by": {
"type": ["string", "null"],
"description": "Field used to sort products.",
"enum": ["popularity_order", "price", "display_order", "created_at"],
"example": "price"
},
"order": {
"type": "string",
"description": "Sorting order direction.",
"enum": ["asc", "desc"],
"default": "asc",
"example": "desc"
},
"categories": {
"type": ["string", "null"],
"description": "Category identifier used to filter products.",
"example": "men-clothing"
},
"price_min": {
"type": ["number", "null"],
"description": "Minimum product price filter.",
"example": 50
},
"price_max": {
"type": ["number", "null"],
"description": "Maximum product price filter.",
"example": 300
},
"on_sale": {
"type": ["boolean", "null"],
"description": "Filters products that are currently on sale.",
"example": true
},
"attribute_values": {
"type": ["array", "null"],
"description": "List of attribute values used to filter products.",
"items": {
"type": "string"
},
"example": ["red", "large"]
}
}
}'"Success"