Create Order Type
Register a new order type in the shared catalog.
Authorization
default You can retrieve your token by logging in.
In: header
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"Request Body
application/json
Unique catalog key. Derived from name_en (uppercase, underscore-slug) when omitted. Must not be greater than 64 characters.
Canonical order type name (English). Must not be greater than 255 characters.
Canonical order type name (Arabic). Must not be greater than 255 characters.
Canonical uploaded image URL (custom image). Use icon_id instead to pick a catalog icon. Must be a valid URL.
Canonical icon reference into the shared icon catalog (GET /v2/icons). Must match an existing stored value.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://api.flavours.sa/dev/api/v2/orders/types" \ -H "X-API-Version: 2.3.0" \ -H "Content-Type: application/json" \ -d '{ "name_en": "Dine In" }'{
"meta": {
"code": 200,
"status": "success",
"message": "Order type created successfully."
},
"data": {
"key": "BANQUET_HALL",
"market_id": null,
"name_en": "Banquet Hall",
"name_ar": "قاعة الولائم",
"image_url": null,
"created_at": 1787446697322,
"updated_at": 1787446697322,
"icon_id": "8254803d-1404-4a64-8dfb-01fbda0c487e"
}
}{
"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": 422,
"status": "error",
"message": "The name en field is required."
},
"data": [
{
"code": 0,
"message": "The name en field is required.",
"field": "name_en"
}
]
}{
"meta": {
"code": 500,
"status": "error",
"message": "Internal server error."
},
"data": null
}