Product
Create Product
Create a new product with its modifiers, prices, ingredients and recipes.
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?|
The id of an existing record in the branches table.
category_id?|
The id of an existing record in the product_categories table.
name_en*string
Must not be greater than 350 characters.
name_ar?|
Must not be greater than 350 characters.
description_en?|
description_ar?|
duration?|
images*array<>
Must be a valid URL.
min_additionals?|
Must be at least 0.
max_additionals?|
Must be at least 0.
branches?array<|>
Must have at least 1 items.
options*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 "http://localhost:8000/api/v2/products" \ -H "X-API-Version: 2.3.0" \ -H "Content-Type: application/json" \ -d '{ "market_id": "deserunt", "name_en": "zswmuztnlx", "images": [ "https://www.sipes.com/unde-enim-omnis-fugiat-aut-quasi-ut-facilis" ], "options": [ [] ] }'{
"meta": {
"code": 200,
"status": "success",
"message": "Product created successfully."
},
"data": {
"id": "9c1d6b7e-3f2a-4c5b-9e8d-1a2b3c4d5e6f",
"market_id": "6f88aed5-6f6d-4394-a120-6dc470736b31",
"branch_id": "df1f36b7-1587-4746-a450-7e0487475df4",
"category_id": 4,
"name_en": "Cheeseburger",
"name_ar": "تشيز برجر",
"duration": 10,
"order": 1,
"images": [],
"is_active": true,
"created_at": 1770542643118,
"updated_at": 1770542643118,
"options": [],
"additionals": []
}
}{
"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 en field is required.",
"field": "name_en"
},
{
"code": 0,
"message": "The options field is required.",
"field": "options"
}
]
}{
"meta": {
"code": 500,
"status": "error",
"message": "Internal server error."
},
"data": null
}