ProductModifier
Create Product Modifier
Add a modifier to a product.
Authorization
API-TOKEN API-TOKEN<token>
Your partner API key. Send it in the API-TOKEN header on every request.
In: header
Path Parameters
productId*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
name_en?|
Must not be greater than 191 characters.
name_ar?|
Must not be greater than 191 characters.
barcode?|
sku?|
Must not be greater than 191 characters.
type*string
Value in
"OPTION" | "OPTION_VARIABLE"calorie?|
Must be at least 0.
stock?|
Must be at least 0.
price?|
cost?|
Must be at least 0.
is_tax_included*boolean
weight_unit?|
This field is required when options.*.weight_amount is present.
weight_amount?|
This field is required when options.*.weight_unit is present. Must be at least 0.
ingredients?array<|>
Must have at least 1 items.
recipes?array<|>
Must have at least 1 items.
prices?array<|>
Must have at least 1 items.
additionals?array<|>
Must have at least 1 items.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://api.flavours.sa/dev/api/v2/products/sunt/modifiers" \ -H "X-API-Version: 2.3.0" \ -H "Content-Type: application/json" \ -d '{ "type": "OPTION", "is_tax_included": true }'{
"meta": {
"code": 200,
"status": "success",
"message": "Modifier created successfully."
},
"data": {
"id": 738792839343909,
"modifierable_id": "0b5b3eb3-f3af-4523-a8d6-d8c57855a129",
"name_en": "Eos nobis",
"name_ar": "sit",
"type": "OPTION",
"calorie": null,
"price": 41.74,
"tax": 0,
"total": 41.74,
"cost": null,
"profit": null,
"is_tax_included": true,
"deleted_at": null,
"barcode": null,
"weight_amount": null,
"weight_unit": null,
"market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
"branch_id": "2438ea30-370a-4ca0-9423-f635f83f1bec",
"modifierable_type": "PRODUCT_MODIFIER_PRODUCT",
"stock": null,
"product_id": "0b5b3eb3-f3af-4523-a8d6-d8c57855a129",
"sku": null,
"updated_at": null,
"barcode_img": null,
"ingredients": [],
"prices": [],
"product": {
"id": "0b5b3eb3-f3af-4523-a8d6-d8c57855a129",
"market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
"branch_id": "2438ea30-370a-4ca0-9423-f635f83f1bec",
"name_en": "Nisi qui",
"name_ar": "quidem",
"description_en": null,
"description_ar": null,
"stock": 0,
"order": 55,
"images": null,
"is_active": true,
"created_at": 1792593345442,
"updated_at": 1792593345442,
"deleted_at": null,
"rating_amount": 0,
"rating_avg": "0.00",
"sold_amount": 0,
"sold_revenue": 0,
"qoyod_id": null,
"min_additionals": null,
"max_additionals": null,
"is_global": false,
"product_category_id": null,
"preparation_time": null,
"category": null
},
"recipes": []
}
}{
"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 Type is invalid. (and 1 more error)"
},
"data": [
{
"code": 0,
"message": "The selected Type is invalid.",
"field": "type"
},
{
"code": 0,
"message": "The Price Includes Tax field is required.",
"field": "is_tax_included"
}
]
}{
"meta": {
"code": 500,
"status": "error",
"message": "Internal server error."
},
"data": null
}