Ingredient
Update Ingredient
Update an existing ingredient and its branch stock.
Authorization
API-TOKEN API-TOKEN<token>
Your partner API key. Send it in the API-TOKEN header on every request.
In: header
Path Parameters
ingredientId*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
branch_id?|
Must match an existing stored value.
source_unit?|
Must not be greater than 191 characters.
target_unit?|
Must not be greater than 191 characters.
source_rate?|
target_rate?|
minimum?|
maximum?|
stock?|
Must be at least 0.
cost?|
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://api.flavours.sa/dev/api/v2/ingredients/et" \ -H "X-API-Version: 2.3.0" \ -H "Content-Type: application/json" \ -d '{}'{
"meta": {
"code": 200,
"status": "success",
"message": "Ingredient updated successfully."
},
"data": {
"id": "0b81ebdf-b1b3-4e8b-a03f-e1ffacff3645",
"name_en": "Praesentium aperiam",
"name_ar": "quia",
"deleted_at": null,
"market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
"source_unit": "carton",
"target_unit": "kg",
"source_rate": "2.00",
"target_rate": "24.00",
"minimum": "10.00",
"created_at": 1792593338933,
"updated_at": 1792593338956,
"maximum": "200.00"
}
}{
"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 selected branch id is invalid. (and 3 more errors)"
},
"data": [
{
"code": 0,
"message": "The selected branch is invalid.",
"field": "branch"
},
{
"code": 0,
"message": "The Storage Unit Factor must be a number.",
"field": "source_rate"
},
{
"code": 0,
"message": "The Storage Unit Factor must be greater than 0.",
"field": "source_rate"
},
{
"code": 0,
"message": "The Cost must be greater than 0.",
"field": "cost"
}
]
}{
"meta": {
"code": 500,
"status": "error",
"message": "Internal server error."
},
"data": null
}