OrderType
List Order Types
List the shared order type catalog, flagged with whether the caller market has adopted each entry.
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 the order type name.
sort?|
Sort field and direction (e.g., name_en, -created_at, is_adopted, -is_adopted).
key_by?|
Key the results by this field.
includes*array<>
filter?|
filter.is_adopted?|
Filter to catalog entries the caller market has (true) or has not (false) adopted.
filter.is_active?|
Filter to catalog entries whose config for the caller market is active (true) or not active (false), reading order_type_configs.is_active.
filter.original?|
Return the raw registry values instead of the subscriber config overlay (default false = overlaid). When true, an included config is returned unmodified (no fields hidden).
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?page=1&per_page=20&search=dine&sort=-created_at&key_by=key&includes=molestiae&filter.is_adopted=false&filter.is_active=true&filter.original=false" \ -H "X-API-Version: 2.3.0"{
"meta": {
"code": 200,
"status": "success",
"message": "Order type list retrieved successfully."
},
"data": {
"current_page": 1,
"data": [
{
"key": "TAKE_AWAY_LIST",
"name_en": "Take Away List",
"name_ar": "سفري",
"image_url": null,
"created_at": 1787446696123,
"updated_at": 1787446696123,
"icon_id": null,
"is_adopted": true
},
{
"key": "DELIVERY_DETAIL",
"name_en": "Delivery Detail",
"name_ar": "توصيل",
"image_url": null,
"created_at": 1787446696191,
"updated_at": 1787446696191,
"icon_id": null,
"is_adopted": true
},
{
"key": "CURBSIDE_PICKUP",
"name_en": "Curbside Pickup",
"name_ar": "استلام بالسيارة",
"image_url": null,
"created_at": 1787446696232,
"updated_at": 1787446696232,
"icon_id": null,
"is_adopted": true
},
{
"key": "UPDATE_ME",
"name_en": "Updated Name",
"name_ar": "حدثني",
"image_url": null,
"created_at": 1787446696317,
"updated_at": 1787446696321,
"icon_id": null,
"is_adopted": true
},
{
"key": "UPDATE_INVALID",
"name_en": "Update Invalid",
"name_ar": "تحديث غير صالح",
"image_url": null,
"created_at": 1787446696350,
"updated_at": 1787446696350,
"icon_id": null,
"is_adopted": true
},
{
"key": "DELETE_ME",
"name_en": "Delete Me",
"name_ar": "احذفني",
"image_url": null,
"created_at": 1787446696385,
"updated_at": 1787446696385,
"icon_id": null,
"is_adopted": false
},
{
"key": "VIP_MAJLIS",
"name_en": "VIP Majlis",
"name_ar": "مجلس كبار",
"image_url": null,
"created_at": 1787446696420,
"updated_at": 1787446696420,
"icon_id": null,
"is_adopted": true
},
{
"key": "PER_PRODUCT_CHARGE",
"name_en": "Per Product Charge",
"name_ar": "رسوم لكل منتج",
"image_url": null,
"created_at": 1787446696552,
"updated_at": 1787446696552,
"icon_id": null,
"is_adopted": true
},
{
"key": "PRODUCT_CHARGE_UPDATE",
"name_en": "Product Charge Update",
"name_ar": "تحديث رسوم المنتج",
"image_url": null,
"created_at": 1787446696916,
"updated_at": 1787446696923,
"icon_id": null,
"is_adopted": true
},
{
"key": "DETAIL_PRODUCT_PRICING",
"name_en": "Detail Product Pricing",
"name_ar": "تسعير منتج نوع الطلب",
"image_url": null,
"created_at": 1787446696974,
"updated_at": 1787446696974,
"icon_id": null,
"is_adopted": true
},
{
"key": "CREATE_PRODUCT_PRICING",
"name_en": "Create Product Pricing",
"name_ar": "تسعير منتج نوع الطلب",
"image_url": null,
"created_at": 1787446697012,
"updated_at": 1787446697012,
"icon_id": null,
"is_adopted": true
},
{
"key": "UPDATE_PRODUCT_PRICING",
"name_en": "Update Product Pricing",
"name_ar": "تسعير منتج نوع الطلب",
"image_url": null,
"created_at": 1787446697049,
"updated_at": 1787446697049,
"icon_id": null,
"is_adopted": true
},
{
"key": "INVALID_PRODUCT_PRICING",
"name_en": "Invalid Product Pricing",
"name_ar": "تسعير منتج نوع الطلب",
"image_url": null,
"created_at": 1787446697098,
"updated_at": 1787446697098,
"icon_id": null,
"is_adopted": true
},
{
"key": "DELETE_PRODUCT_PRICING",
"name_en": "Delete Product Pricing",
"name_ar": "تسعير منتج نوع الطلب",
"image_url": null,
"created_at": 1787446697160,
"updated_at": 1787446697160,
"icon_id": null,
"is_adopted": true
},
{
"key": "DELETE_404_PRODUCT_PRICING",
"name_en": "Delete 404 Product Pricing",
"name_ar": "تسعير منتج نوع الطلب",
"image_url": null,
"created_at": 1787446697204,
"updated_at": 1787446697204,
"icon_id": null,
"is_adopted": true
},
{
"key": "CATERING_LIST",
"name_en": "Catering List",
"name_ar": "Unknown",
"image_url": null,
"created_at": 1787446697243,
"updated_at": 1787446697243,
"icon_id": "8254803d-1404-4a64-8dfb-01fbda0c487e",
"is_adopted": true
}
],
"first_page_url": "http://localhost:8000/api/v2/orders/types?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "http://localhost:8000/api/v2/orders/types?page=1",
"links": [
{
"url": null,
"label": "« Previous",
"page": null,
"active": false
},
{
"url": "http://localhost:8000/api/v2/orders/types?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/orders/types",
"per_page": 20,
"prev_page_url": null,
"to": 16,
"total": 16
}
}{
"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
}