Recipe
Create Recipe
Create a new recipe with its ingredients.
Authorization
default AuthorizationBearer <token>
You can retrieve your token by logging in.
In: header
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
market_id*string
The id of an existing record in the markets table.
branch_id*string
The id of an existing record in the branches table.
name*string
ingredients*array<>
Must have at least 1 items.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:8000/api/v2/recipes" \ -H "X-API-Version: 2.3.0" \ -H "Content-Type: application/json" \ -d '{ "market_id": "ea", "branch_id": "repellat", "name": "ut", "ingredients": [ [] ] }'{
"meta": {
"code": 200,
"status": "success",
"message": "Recipe created successfully."
},
"data": {
"id": "9c1d6b7e-3f2a-4c5b-9e8d-1a2b3c4d5e6f",
"market_id": "6f88aed5-6f6d-4394-a120-6dc470736b31",
"branch_id": "df1f36b7-1587-4746-a450-7e0487475df4",
"name": "Tomato Sauce",
"created_at": 1770542643118,
"updated_at": 1770542643118,
"market": {
"id": "6f88aed5-6f6d-4394-a120-6dc470736b31",
"name_en": "Mertz Group",
"name_ar": "Mertz Group"
},
"branch": {
"id": "df1f36b7-1587-4746-a450-7e0487475df4",
"name_en": "Main Branch",
"name_ar": "الفرع الرئيسي"
},
"ingredients": [
{
"id": "1b2c3d4e-5f60-7182-93a4-b5c6d7e8f900",
"recipe_id": "9c1d6b7e-3f2a-4c5b-9e8d-1a2b3c4d5e6f",
"ingredient_id": "0a1b2c3d-4e5f-6071-8293-a4b5c6d7e8f9",
"qty": "2.50",
"ingredient": {
"id": "0a1b2c3d-4e5f-6071-8293-a4b5c6d7e8f9",
"name_en": "Tomato",
"name_ar": "طماطم",
"target_unit": "kg"
}
}
]
}
}{
"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 market id field is required. (and 2 more errors)"
},
"data": [
{
"code": 0,
"message": "The market id field is required.",
"field": "market_id"
},
{
"code": 0,
"message": "The name field is required.",
"field": "name"
},
{
"code": 0,
"message": "The ingredients field is required.",
"field": "ingredients"
}
]
}{
"meta": {
"code": 500,
"status": "error",
"message": "Internal server error."
},
"data": null
}