List Order Types
List the shared order type catalog, flagged with whether the caller market has adopted each entry. For the customer role this returns the market's digital-menu order types (is_digital && is_active configs) with the icon relation and allowed payment methods; filter[market_id] is required for customers.
Authorization
API-TOKEN Your partner API key. Send it in the API-TOKEN header on every request.
In: header
Query Parameters
Page number for pagination. Must be at least 1.
Number of items per page. Must be at least 1.
Search in the order type name.
Sort field and direction (e.g., name_en, -created_at, is_adopted, -is_adopted).
Key the results by this field.
Filter to catalog entries the caller market has (true) or has not (false) adopted.
Filter to catalog entries whose config for the caller market is active (true) or not active (false), reading order_type_configs.is_active.
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).
Market whose order types to read. Required for the customer role (which has no fixed market); ignored for staff (their own market is used). Must match an existing stored value.
Header Parameters
API contract version to target. See the Changelog for what changed in each version.
"2.0.0""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=eos&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": 1792593340954,
"updated_at": 1792593340954,
"icon_id": null,
"is_adopted": true
},
{
"key": "DELIVERY_DETAIL",
"name_en": "Delivery Detail",
"name_ar": "توصيل",
"image_url": null,
"created_at": 1792593341053,
"updated_at": 1792593341053,
"icon_id": null,
"is_adopted": true
},
{
"key": "CURBSIDE_PICKUP",
"name_en": "Curbside Pickup",
"name_ar": "استلام بالسيارة",
"image_url": null,
"created_at": 1792593341102,
"updated_at": 1792593341102,
"icon_id": null,
"is_adopted": true
},
{
"key": "UPDATE_ME",
"name_en": "Updated Name",
"name_ar": "حدثني",
"image_url": null,
"created_at": 1792593341218,
"updated_at": 1792593341224,
"icon_id": null,
"is_adopted": true
},
{
"key": "UPDATE_INVALID",
"name_en": "Update Invalid",
"name_ar": "تحديث غير صالح",
"image_url": null,
"created_at": 1792593341294,
"updated_at": 1792593341294,
"icon_id": null,
"is_adopted": true
},
{
"key": "DELETE_ME",
"name_en": "Delete Me",
"name_ar": "احذفني",
"image_url": null,
"created_at": 1792593341343,
"updated_at": 1792593341343,
"icon_id": null,
"is_adopted": false
},
{
"key": "VIP_MAJLIS",
"name_en": "VIP Majlis",
"name_ar": "مجلس كبار",
"image_url": null,
"created_at": 1792593341396,
"updated_at": 1792593341396,
"icon_id": null,
"is_adopted": true
},
{
"key": "DETAIL_PRODUCT_PRICING",
"name_en": "Detail Product Pricing",
"name_ar": "تسعير منتج نوع الطلب",
"image_url": null,
"created_at": 1792593341493,
"updated_at": 1792593341493,
"icon_id": null,
"is_adopted": true
},
{
"key": "CREATE_PRODUCT_PRICING",
"name_en": "Create Product Pricing",
"name_ar": "تسعير منتج نوع الطلب",
"image_url": null,
"created_at": 1792593341546,
"updated_at": 1792593341546,
"icon_id": null,
"is_adopted": true
},
{
"key": "UPDATE_PRODUCT_PRICING",
"name_en": "Update Product Pricing",
"name_ar": "تسعير منتج نوع الطلب",
"image_url": null,
"created_at": 1792593341591,
"updated_at": 1792593341591,
"icon_id": null,
"is_adopted": true
},
{
"key": "INVALID_PRODUCT_PRICING",
"name_en": "Invalid Product Pricing",
"name_ar": "تسعير منتج نوع الطلب",
"image_url": null,
"created_at": 1792593341690,
"updated_at": 1792593341690,
"icon_id": null,
"is_adopted": true
},
{
"key": "DELETE_PRODUCT_PRICING",
"name_en": "Delete Product Pricing",
"name_ar": "تسعير منتج نوع الطلب",
"image_url": null,
"created_at": 1792593341741,
"updated_at": 1792593341741,
"icon_id": null,
"is_adopted": true
},
{
"key": "DELETE_404_PRODUCT_PRICING",
"name_en": "Delete 404 Product Pricing",
"name_ar": "تسعير منتج نوع الطلب",
"image_url": null,
"created_at": 1792593341799,
"updated_at": 1792593341799,
"icon_id": null,
"is_adopted": true
},
{
"key": "CATERING_LIST",
"name_en": "Catering List",
"name_ar": "Unknown",
"image_url": null,
"created_at": 1792593341846,
"updated_at": 1792593341846,
"icon_id": "f9c9cccc-49c8-4bf2-85dc-555183dea6ae",
"is_adopted": true
}
],
"first_page_url": "https://localhost:8000/api/v2/orders/types?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "https://localhost:8000/api/v2/orders/types?page=1",
"links": [
{
"url": null,
"label": "« Previous",
"page": null,
"active": false
},
{
"url": "https://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": "https://localhost:8000/api/v2/orders/types",
"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
}