OrderTypeConfig
List Order Type Configs
List the caller market's adopted order types with pagination and filtering options.
Authorization
API-TOKEN API-TOKEN<token>
Your partner API key. Send it in the API-TOKEN header on every request.
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 the order type name.
sort?|
Sort field and direction (e.g., name_en, -created_at).
key_by?|
Key the results by this field.
includes*array<>
filter?object
filter.is_active?|
filter.is_split?|
filter.target?|
Value in
"ORDER" | "PRODUCT"filter.method?|
Value in
"AFTER_TAX" | "EXCLUSIVE" | "INCLUSIVE"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/orders/types/configs?page=1&per_page=20&search=dine&sort=-created_at&key_by=id&includes=aut&filter.is_active=false&filter.is_split=true&filter.target=PRODUCT&filter.method=INCLUSIVE" \ -H "X-API-Version: 2.3.0"{
"meta": {
"code": 200,
"status": "success",
"message": "Order type config list retrieved successfully."
},
"data": {
"current_page": 1,
"data": [
{
"id": "f99cf8e0-7d3b-438d-8643-e68b628a5bde",
"market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
"type_key": "TAKE_AWAY",
"target": null,
"name_en": null,
"name_ar": null,
"image_url": null,
"value": null,
"value_type": null,
"sort": 0,
"settings": [],
"is_split": true,
"is_active": true,
"created_at": 1792593340444,
"updated_at": 1792593340444,
"icon_id": null,
"is_digital": false,
"type": null,
"methods": [],
"products": []
},
{
"id": "33259efe-4632-4c4d-97e8-89b9e6e2b3a5",
"market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
"type_key": "TAKE_AWAY_LIST",
"target": null,
"name_en": null,
"name_ar": null,
"image_url": null,
"value": null,
"value_type": null,
"sort": 1,
"settings": [
"WITH_TABLE"
],
"is_split": true,
"is_active": true,
"created_at": 1792593340955,
"updated_at": 1792593340955,
"icon_id": null,
"is_digital": false,
"type": {
"key": "TAKE_AWAY_LIST",
"name_en": "Take Away List",
"name_ar": "سفري",
"image_url": null,
"created_at": 1792593340954,
"updated_at": 1792593340954,
"icon_id": null
},
"methods": [],
"products": []
}
],
"first_page_url": "https://localhost:8000/api/v2/orders/types/configs?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "https://localhost:8000/api/v2/orders/types/configs?page=1",
"links": [
{
"url": null,
"label": "« Previous",
"page": null,
"active": false
},
{
"url": "https://localhost:8000/api/v2/orders/types/configs?page=1",
"label": "1",
"page": 1,
"active": true
},
{
"url": null,
"label": "Next »",
"page": null,
"active": false
}
],
"next_page_url": null,
"path": "https://localhost:8000/api/v2/orders/types/configs",
"per_page": 20,
"prev_page_url": null,
"to": 2,
"total": 2
}
}{
"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
}