Product
List Products
List all products with pagination and filtering options.
Authorization
default AuthorizationBearer <token>
You can retrieve your token by logging in.
In: header
Query Parameters
page?|
Page number for pagination. Must be at least 1.
per_page?|
Number of items per page. Must be at least 1.
search?|
Search in product/option/additional name or duration.
sort?|
Sort field and direction (e.g., order, -created_at).
key_by?|
Key the results by this field.
includes*array<>
filter?object
filter.market_id?|
Must match an existing stored value.
filter.branch_id?|
Must match an existing stored value.
filter.category_id?|
Must match an existing stored value.
filter.has_category?|
Pass 0 for products attached to no category, 1 for products that have one. Omit for both.
filter.is_active?|
filter.has_options?|
filter.products_ids*array<>
Must match an existing stored value.
filter.payment_method_key?|
Must match an existing stored value.
filter.order_type_key?|
Must match an existing stored value.
Header Parameters
X-API-Version*string
API contract version to target. See the Changelog for what changed in each version.
Default
"2.0.0"Value in
"2.3.0" | "2.2.0" | "2.1.0" | "2.0.0"Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://api.flavours.sa/dev/api/v2/products?page=1&per_page=20&search=burger&sort=order&key_by=id&includes=quos&filter.market_id=vero&filter.branch_id=omnis&filter.category_id=7&filter.has_category=false&filter.is_active=true&filter.has_options=false&filter.products_ids=eius&filter.payment_method_key=cumque&filter.order_type_key=est" \ -H "X-API-Version: 2.3.0"{
"meta": {
"code": 200,
"status": "success",
"message": "Product list retrieved successfully."
},
"data": {
"current_page": 1,
"data": [
{
"id": "c74b8c59-c400-47ed-a20d-069ce70192d9",
"market_id": "848aa3f5-fc3d-42d3-8cc9-4c6edd0140d0",
"branch_id": null,
"name_en": "Nam inventore",
"name_ar": "fuga",
"description_en": null,
"description_ar": null,
"stock": 0,
"order": 15,
"images": null,
"is_active": true,
"created_at": 1787446703496,
"updated_at": 1787446703496,
"deleted_at": null,
"rating_amount": 0,
"rating_avg": "0.00",
"sold_amount": 0,
"sold_revenue": 0,
"qoyod_id": null,
"min_additionals": null,
"max_additionals": null,
"is_global": false,
"stock_modifiers_sum_stock": null,
"product_category_id": null,
"preparation_time": null
},
{
"id": "728ed17b-cc85-46e6-9f17-e08c10ef71d6",
"market_id": "848aa3f5-fc3d-42d3-8cc9-4c6edd0140d0",
"branch_id": "7c538fd7-9547-4b16-959d-f01052e04c6f",
"name_en": "Docs Burger",
"name_ar": "برجر",
"description_en": null,
"description_ar": null,
"stock": 0,
"order": 46,
"images": null,
"is_active": true,
"created_at": 1787446695927,
"updated_at": 1787446695927,
"deleted_at": null,
"rating_amount": 0,
"rating_avg": "0.00",
"sold_amount": 0,
"sold_revenue": 0,
"qoyod_id": null,
"min_additionals": null,
"max_additionals": null,
"is_global": false,
"stock_modifiers_sum_stock": null,
"product_category_id": 2,
"preparation_time": null
},
{
"id": "04374bab-ca75-49cd-a88f-781b5a095780",
"market_id": "848aa3f5-fc3d-42d3-8cc9-4c6edd0140d0",
"branch_id": "7c538fd7-9547-4b16-959d-f01052e04c6f",
"name_en": "Docs Burger",
"name_ar": "برجر",
"description_en": null,
"description_ar": null,
"stock": 0,
"order": 56,
"images": null,
"is_active": true,
"created_at": 1787446681959,
"updated_at": 1787446681959,
"deleted_at": null,
"rating_amount": 0,
"rating_avg": "0.00",
"sold_amount": 0,
"sold_revenue": 0,
"qoyod_id": null,
"min_additionals": null,
"max_additionals": null,
"is_global": false,
"stock_modifiers_sum_stock": null,
"product_category_id": 1,
"preparation_time": null
},
{
"id": "6782ad9b-c676-41c3-bfad-8a2a5bba6216",
"market_id": "848aa3f5-fc3d-42d3-8cc9-4c6edd0140d0",
"branch_id": null,
"name_en": "Nulla minima",
"name_ar": "praesentium",
"description_en": null,
"description_ar": null,
"stock": 0,
"order": 56,
"images": null,
"is_active": true,
"created_at": 1787446703496,
"updated_at": 1787446703496,
"deleted_at": null,
"rating_amount": 0,
"rating_avg": "0.00",
"sold_amount": 0,
"sold_revenue": 0,
"qoyod_id": null,
"min_additionals": null,
"max_additionals": null,
"is_global": false,
"stock_modifiers_sum_stock": null,
"product_category_id": null,
"preparation_time": null
},
{
"id": "aed8c598-85e6-4581-a07d-b14521ec9c91",
"market_id": "848aa3f5-fc3d-42d3-8cc9-4c6edd0140d0",
"branch_id": "7c538fd7-9547-4b16-959d-f01052e04c6f",
"name_en": "Docs Fries",
"name_ar": "بطاطس",
"description_en": null,
"description_ar": null,
"stock": 0,
"order": 57,
"images": null,
"is_active": true,
"created_at": 1787446681959,
"updated_at": 1787446681959,
"deleted_at": null,
"rating_amount": 0,
"rating_avg": "0.00",
"sold_amount": 0,
"sold_revenue": 0,
"qoyod_id": null,
"min_additionals": null,
"max_additionals": null,
"is_global": false,
"stock_modifiers_sum_stock": null,
"product_category_id": 1,
"preparation_time": null
},
{
"id": "04f829c8-39ce-4e16-822a-fbdc69a38ba0",
"market_id": "848aa3f5-fc3d-42d3-8cc9-4c6edd0140d0",
"branch_id": "7c538fd7-9547-4b16-959d-f01052e04c6f",
"name_en": "Voluptas hic",
"name_ar": "et",
"description_en": null,
"description_ar": null,
"stock": 50,
"order": 58,
"images": null,
"is_active": true,
"created_at": 1787446696098,
"updated_at": 1787446696098,
"deleted_at": null,
"rating_amount": 0,
"rating_avg": "0.00",
"sold_amount": 0,
"sold_revenue": 0,
"qoyod_id": null,
"min_additionals": null,
"max_additionals": null,
"is_global": false,
"stock_modifiers_sum_stock": 50,
"product_category_id": null,
"preparation_time": null
},
{
"id": "5fb26e4b-383c-4361-8eae-f5f991a4e8b3",
"market_id": "848aa3f5-fc3d-42d3-8cc9-4c6edd0140d0",
"branch_id": "7c538fd7-9547-4b16-959d-f01052e04c6f",
"name_en": "Accusamus necessitatibus",
"name_ar": "vero",
"description_en": null,
"description_ar": null,
"stock": 50,
"order": 59,
"images": null,
"is_active": true,
"created_at": 1787446696964,
"updated_at": 1787446696964,
"deleted_at": null,
"rating_amount": 0,
"rating_avg": "0.00",
"sold_amount": 0,
"sold_revenue": 0,
"qoyod_id": null,
"min_additionals": null,
"max_additionals": null,
"is_global": false,
"stock_modifiers_sum_stock": 50,
"product_category_id": null,
"preparation_time": null
},
{
"id": "a019166d-ef3c-454f-857c-4210b561a8ca",
"market_id": "848aa3f5-fc3d-42d3-8cc9-4c6edd0140d0",
"branch_id": "7c538fd7-9547-4b16-959d-f01052e04c6f",
"name_en": "Ut deleniti",
"name_ar": "incidunt",
"description_en": null,
"description_ar": null,
"stock": 50,
"order": 60,
"images": null,
"is_active": true,
"created_at": 1787446697611,
"updated_at": 1787446697611,
"deleted_at": null,
"rating_amount": 0,
"rating_avg": "0.00",
"sold_amount": 0,
"sold_revenue": 0,
"qoyod_id": null,
"min_additionals": null,
"max_additionals": null,
"is_global": false,
"stock_modifiers_sum_stock": 50,
"product_category_id": null,
"preparation_time": null
},
{
"id": "94db4076-0a3a-46cf-92d3-5df29064fb96",
"market_id": "848aa3f5-fc3d-42d3-8cc9-4c6edd0140d0",
"branch_id": "7c538fd7-9547-4b16-959d-f01052e04c6f",
"name_en": "Rem consequuntur",
"name_ar": "commodi",
"description_en": null,
"description_ar": null,
"stock": 50,
"order": 61,
"images": null,
"is_active": true,
"created_at": 1787446699755,
"updated_at": 1787446699755,
"deleted_at": null,
"rating_amount": 0,
"rating_avg": "0.00",
"sold_amount": 0,
"sold_revenue": 0,
"qoyod_id": null,
"min_additionals": null,
"max_additionals": null,
"is_global": false,
"stock_modifiers_sum_stock": 50,
"product_category_id": null,
"preparation_time": null
},
{
"id": "db6dd349-5965-4fd1-9818-acf7ada72174",
"market_id": "848aa3f5-fc3d-42d3-8cc9-4c6edd0140d0",
"branch_id": "7c538fd7-9547-4b16-959d-f01052e04c6f",
"name_en": "Officia ipsa",
"name_ar": "vero",
"description_en": null,
"description_ar": null,
"stock": 50,
"order": 62,
"images": null,
"is_active": true,
"created_at": 1787446700129,
"updated_at": 1787446700129,
"deleted_at": null,
"rating_amount": 0,
"rating_avg": "0.00",
"sold_amount": 0,
"sold_revenue": 0,
"qoyod_id": null,
"min_additionals": null,
"max_additionals": null,
"is_global": false,
"stock_modifiers_sum_stock": 50,
"product_category_id": null,
"preparation_time": null
},
{
"id": "41a45926-7f75-481d-a78a-682ba4a647a1",
"market_id": "848aa3f5-fc3d-42d3-8cc9-4c6edd0140d0",
"branch_id": "7c538fd7-9547-4b16-959d-f01052e04c6f",
"name_en": "Aut corporis",
"name_ar": "quia",
"description_en": null,
"description_ar": null,
"stock": 50,
"order": 63,
"images": null,
"is_active": true,
"created_at": 1787446700294,
"updated_at": 1787446700294,
"deleted_at": null,
"rating_amount": 0,
"rating_avg": "0.00",
"sold_amount": 0,
"sold_revenue": 0,
"qoyod_id": null,
"min_additionals": null,
"max_additionals": null,
"is_global": false,
"stock_modifiers_sum_stock": 50,
"product_category_id": null,
"preparation_time": null
},
{
"id": "fd345ea2-fe4e-4db3-8a90-69510518b8c6",
"market_id": "848aa3f5-fc3d-42d3-8cc9-4c6edd0140d0",
"branch_id": "7c538fd7-9547-4b16-959d-f01052e04c6f",
"name_en": "Eaque dolor",
"name_ar": "et",
"description_en": null,
"description_ar": null,
"stock": 50,
"order": 64,
"images": null,
"is_active": true,
"created_at": 1787446701144,
"updated_at": 1787446701144,
"deleted_at": null,
"rating_amount": 0,
"rating_avg": "0.00",
"sold_amount": 0,
"sold_revenue": 0,
"qoyod_id": null,
"min_additionals": null,
"max_additionals": null,
"is_global": false,
"stock_modifiers_sum_stock": 50,
"product_category_id": null,
"preparation_time": null
},
{
"id": "3d6327ea-b87e-4e89-93b7-b797ac81b734",
"market_id": "848aa3f5-fc3d-42d3-8cc9-4c6edd0140d0",
"branch_id": "7c538fd7-9547-4b16-959d-f01052e04c6f",
"name_en": "Nesciunt vel",
"name_ar": "voluptatem",
"description_en": null,
"description_ar": null,
"stock": 50,
"order": 65,
"images": null,
"is_active": true,
"created_at": 1787446703123,
"updated_at": 1787446703123,
"deleted_at": null,
"rating_amount": 0,
"rating_avg": "0.00",
"sold_amount": 0,
"sold_revenue": 0,
"qoyod_id": null,
"min_additionals": null,
"max_additionals": null,
"is_global": false,
"stock_modifiers_sum_stock": 50,
"product_category_id": null,
"preparation_time": null
},
{
"id": "ebdff03e-93e7-4b72-a86a-c74da8fb6adb",
"market_id": "848aa3f5-fc3d-42d3-8cc9-4c6edd0140d0",
"branch_id": null,
"name_en": "Odio perspiciatis",
"name_ar": "ab",
"description_en": null,
"description_ar": null,
"stock": 0,
"order": 77,
"images": null,
"is_active": true,
"created_at": 1787446703496,
"updated_at": 1787446703496,
"deleted_at": null,
"rating_amount": 0,
"rating_avg": "0.00",
"sold_amount": 0,
"sold_revenue": 0,
"qoyod_id": null,
"min_additionals": null,
"max_additionals": null,
"is_global": false,
"stock_modifiers_sum_stock": null,
"product_category_id": null,
"preparation_time": null
}
],
"first_page_url": "http://localhost:8000/api/v2/products?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "http://localhost:8000/api/v2/products?page=1",
"links": [
{
"url": null,
"label": "« Previous",
"page": null,
"active": false
},
{
"url": "http://localhost:8000/api/v2/products?page=1",
"label": "1",
"page": 1,
"active": true
},
{
"url": null,
"label": "Next »",
"page": null,
"active": false
}
],
"next_page_url": null,
"path": "http://localhost:8000/api/v2/products",
"per_page": 20,
"prev_page_url": null,
"to": 14,
"total": 14
}
}{
"meta": {
"code": 401,
"status": "error",
"message": "Unauthenticated."
},
"data": null
}{
"meta": {
"code": 403,
"status": "error",
"message": "Unauthorized."
},
"data": null
}{
"meta": {
"code": 404,
"status": "error",
"message": "Resource not found."
},
"data": null
}{
"meta": {
"code": 500,
"status": "error",
"message": "Internal server error."
},
"data": null
}