OrderType
Detail Order Type
Get a catalog order type by its key.
Authorization
API-TOKEN API-TOKEN<token>
Your partner API key. Send it in the API-TOKEN header on every request.
In: header
Path Parameters
typeKey*string
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"Request Body
application/json
includes*array<>
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://api.flavours.sa/dev/api/v2/orders/types/ullam" \ -H "X-API-Version: 2.3.0" \ -H "Content-Type: application/json" \ -d '{ "includes": [ "qui" ] }'{
"meta": {
"code": 200,
"status": "success",
"message": "Order type details retrieved successfully."
},
"data": {
"key": "CATERING_DETAIL",
"market_id": null,
"name_en": "Catering Detail",
"name_ar": "تموين تفصيلي",
"image_url": null,
"created_at": 1792593341895,
"updated_at": 1792593341895,
"icon_id": "f9c9cccc-49c8-4bf2-85dc-555183dea6ae"
}
}{
"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
}Delete Order Type DELETE
Remove a catalog order type (blocked while any market has adopted it).
List Order Types GET
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.