ProductAddon group
List Addon Groups
List the business add-on group library.
Authorization
API-TOKEN API-TOKEN<token>
Your partner API key. Send it in the API-TOKEN header on every request.
In: header
Query Parameters
page?|
Must be at least 1.
per_page?|
Must be at least 1.
search?|
sort?|
key_by?|
includes*array<>
filter?|
filter.market_id?|
Business the groups belong to. Ignored for a subscriber (always their own business); required for an admin acting on a business. Must match an existing stored value.
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"Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://api.flavours.sa/dev/api/v2/products/addon-groups?page=40&per_page=37&search=quia&sort=incidunt&key_by=et&includes=at" \ -H "X-API-Version: 2.3.0"{
"meta": {
"code": 200,
"status": "success",
"message": "Add-on group list retrieved successfully."
},
"data": {
"current_page": 1,
"data": [
{
"id": "80bfded2-cbc6-4464-9cbe-e457583438d7",
"market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
"name_en": "Est eos",
"name_ar": "الصلصات",
"min_additionals": 0,
"max_additionals": 3,
"order": 0,
"created_at": 1792593344229,
"updated_at": 1792593344229,
"deleted_at": null,
"products_count": 0,
"options": [
{
"id": 738792833966223,
"modifierable_id": "80bfded2-cbc6-4464-9cbe-e457583438d7",
"name_en": "Garlic",
"name_ar": "ثوم",
"type": "ADDITIONAL",
"calorie": 12,
"price": 2,
"tax": 0,
"total": 2,
"cost": 1,
"profit": 1,
"is_tax_included": false,
"deleted_at": null,
"barcode": null,
"weight_amount": null,
"weight_unit": null,
"market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
"branch_id": null,
"modifierable_type": "PRODUCT_MODIFIER_ADDON_GROUP",
"stock": null,
"product_id": null,
"sku": null,
"updated_at": 1792593344195,
"barcode_img": null
}
]
},
{
"id": "0de5d00f-c615-4735-8857-7e7023b91ac0",
"market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
"name_en": "Sauces",
"name_ar": "الصلصات",
"min_additionals": 0,
"max_additionals": 3,
"order": 1,
"created_at": 1792593343812,
"updated_at": 1792593343812,
"deleted_at": null,
"products_count": 1,
"options": [
{
"id": 738792832270764,
"modifierable_id": "0de5d00f-c615-4735-8857-7e7023b91ac0",
"name_en": "Garlic Sauce",
"name_ar": "صلصة ثوم",
"type": "ADDITIONAL",
"calorie": null,
"price": 2,
"tax": 0,
"total": 2,
"cost": null,
"profit": null,
"is_tax_included": false,
"deleted_at": null,
"barcode": null,
"weight_amount": null,
"weight_unit": null,
"market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
"branch_id": null,
"modifierable_type": "PRODUCT_MODIFIER_ADDON_GROUP",
"stock": null,
"product_id": null,
"sku": null,
"updated_at": null,
"barcode_img": null
}
]
},
{
"id": "22601157-c76e-456b-b114-0f649577780d",
"market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
"name_en": "Aut et",
"name_ar": "الصلصات",
"min_additionals": 0,
"max_additionals": 3,
"order": 1,
"created_at": 1792593344054,
"updated_at": 1792593344054,
"deleted_at": null,
"products_count": 0,
"options": [
{
"id": 738792833262640,
"modifierable_id": "22601157-c76e-456b-b114-0f649577780d",
"name_en": "Garlic Sauce",
"name_ar": "صلصة ثوم",
"type": "ADDITIONAL",
"calorie": 40,
"price": 2,
"tax": 0,
"total": 2,
"cost": 1,
"profit": 1,
"is_tax_included": false,
"deleted_at": null,
"barcode": null,
"weight_amount": null,
"weight_unit": null,
"market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
"branch_id": null,
"modifierable_type": "PRODUCT_MODIFIER_ADDON_GROUP",
"stock": null,
"product_id": null,
"sku": null,
"updated_at": null,
"barcode_img": null
}
]
},
{
"id": "3922e8d4-439a-4b4c-a726-fc11dbd96061",
"market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
"name_en": "Sides",
"name_ar": "الصلصات",
"min_additionals": 0,
"max_additionals": 3,
"order": 1,
"created_at": 1792593343654,
"updated_at": 1792593343654,
"deleted_at": null,
"products_count": 1,
"options": [
{
"id": 738792831618439,
"modifierable_id": "3922e8d4-439a-4b4c-a726-fc11dbd96061",
"name_en": "Garlic Sauce",
"name_ar": "صلصة ثوم",
"type": "ADDITIONAL",
"calorie": null,
"price": 2,
"tax": 0,
"total": 2,
"cost": null,
"profit": null,
"is_tax_included": false,
"deleted_at": null,
"barcode": null,
"weight_amount": null,
"weight_unit": null,
"market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
"branch_id": null,
"modifierable_type": "PRODUCT_MODIFIER_ADDON_GROUP",
"stock": null,
"product_id": null,
"sku": null,
"updated_at": null,
"barcode_img": null
}
]
},
{
"id": "40f6301c-ad74-4174-9f4f-dfaed1c90829",
"market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
"name_en": "Sides",
"name_ar": "الصلصات",
"min_additionals": 0,
"max_additionals": 3,
"order": 1,
"created_at": 1792593343819,
"updated_at": 1792593343819,
"deleted_at": null,
"products_count": 1,
"options": [
{
"id": 738792832293067,
"modifierable_id": "40f6301c-ad74-4174-9f4f-dfaed1c90829",
"name_en": "Garlic Sauce",
"name_ar": "صلصة ثوم",
"type": "ADDITIONAL",
"calorie": null,
"price": 2,
"tax": 0,
"total": 2,
"cost": null,
"profit": null,
"is_tax_included": false,
"deleted_at": null,
"barcode": null,
"weight_amount": null,
"weight_unit": null,
"market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
"branch_id": null,
"modifierable_type": "PRODUCT_MODIFIER_ADDON_GROUP",
"stock": null,
"product_id": null,
"sku": null,
"updated_at": null,
"barcode_img": null
}
]
},
{
"id": "4c4183d0-ce73-4e0f-ac68-9039575fff6c",
"market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
"name_en": "Amet qui",
"name_ar": "الصلصات",
"min_additionals": 0,
"max_additionals": 3,
"order": 1,
"created_at": 1792593343936,
"updated_at": 1792593343936,
"deleted_at": null,
"products_count": 0,
"options": [
{
"id": 738792832780060,
"modifierable_id": "4c4183d0-ce73-4e0f-ac68-9039575fff6c",
"name_en": "Garlic Sauce",
"name_ar": "صلصة ثوم",
"type": "ADDITIONAL",
"calorie": 40,
"price": 2,
"tax": 0,
"total": 2,
"cost": 1,
"profit": 1,
"is_tax_included": false,
"deleted_at": null,
"barcode": null,
"weight_amount": null,
"weight_unit": null,
"market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
"branch_id": null,
"modifierable_type": "PRODUCT_MODIFIER_ADDON_GROUP",
"stock": null,
"product_id": null,
"sku": null,
"updated_at": null,
"barcode_img": null
}
]
},
{
"id": "4d61b325-d103-40c7-bf65-33d63c993910",
"market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
"name_en": "Sauces",
"name_ar": "الصلصات",
"min_additionals": 0,
"max_additionals": 3,
"order": 1,
"created_at": 1792593343884,
"updated_at": 1792593343884,
"deleted_at": null,
"products_count": 0,
"options": [
{
"id": 738792832571996,
"modifierable_id": "4d61b325-d103-40c7-bf65-33d63c993910",
"name_en": "Garlic Sauce",
"name_ar": "صلصة ثوم",
"type": "ADDITIONAL",
"calorie": null,
"price": 2,
"tax": 0,
"total": 2,
"cost": null,
"profit": null,
"is_tax_included": false,
"deleted_at": null,
"barcode": null,
"weight_amount": null,
"weight_unit": null,
"market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
"branch_id": null,
"modifierable_type": "PRODUCT_MODIFIER_ADDON_GROUP",
"stock": null,
"product_id": null,
"sku": null,
"updated_at": null,
"barcode_img": null
}
]
},
{
"id": "7434413f-b8af-444e-9acd-b424aef1322c",
"market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
"name_en": "Et nam",
"name_ar": "الصلصات",
"min_additionals": 0,
"max_additionals": 3,
"order": 1,
"created_at": 1792593344012,
"updated_at": 1792593344012,
"deleted_at": null,
"products_count": 0,
"options": [
{
"id": 738792833092236,
"modifierable_id": "7434413f-b8af-444e-9acd-b424aef1322c",
"name_en": "Garlic Sauce",
"name_ar": "صلصة ثوم",
"type": "ADDITIONAL",
"calorie": 40,
"price": 2,
"tax": 0,
"total": 2,
"cost": 1,
"profit": 1,
"is_tax_included": false,
"deleted_at": null,
"barcode": null,
"weight_amount": null,
"weight_unit": null,
"market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
"branch_id": null,
"modifierable_type": "PRODUCT_MODIFIER_ADDON_GROUP",
"stock": null,
"product_id": null,
"sku": null,
"updated_at": null,
"barcode_img": null
}
]
},
{
"id": "80e863e3-e1e0-45e6-8a57-2d3921aebc6a",
"market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
"name_en": "Quasi consequatur",
"name_ar": "الصلصات",
"min_additionals": 0,
"max_additionals": 3,
"order": 1,
"created_at": 1792593344127,
"updated_at": 1792593344127,
"deleted_at": null,
"products_count": 0,
"options": [
{
"id": 738792833567133,
"modifierable_id": "80e863e3-e1e0-45e6-8a57-2d3921aebc6a",
"name_en": "Extra Garlic Sauce",
"name_ar": "صلصة ثوم",
"type": "ADDITIONAL",
"calorie": 40,
"price": 0,
"tax": 0,
"total": 0,
"cost": 1,
"profit": 0,
"is_tax_included": false,
"deleted_at": null,
"barcode": null,
"weight_amount": null,
"weight_unit": null,
"market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
"branch_id": null,
"modifierable_type": "PRODUCT_MODIFIER_ADDON_GROUP",
"stock": null,
"product_id": null,
"sku": null,
"updated_at": null,
"barcode_img": null
}
]
},
{
"id": "848e6469-e5af-4460-86ff-8a256754e032",
"market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
"name_en": "Maxime minus",
"name_ar": "الصلصات",
"min_additionals": 0,
"max_additionals": 3,
"order": 1,
"created_at": 1792593344089,
"updated_at": 1792593344089,
"deleted_at": null,
"products_count": 0,
"options": []
},
{
"id": "94068f90-2f01-460c-bff1-56772b5abe02",
"market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
"name_en": "Sauces",
"name_ar": "الصلصات",
"min_additionals": 0,
"max_additionals": 3,
"order": 1,
"created_at": 1792593343636,
"updated_at": 1792593343636,
"deleted_at": null,
"products_count": 1,
"options": [
{
"id": 738792831559854,
"modifierable_id": "94068f90-2f01-460c-bff1-56772b5abe02",
"name_en": "Garlic Sauce",
"name_ar": "صلصة ثوم",
"type": "ADDITIONAL",
"calorie": null,
"price": 2,
"tax": 0,
"total": 2,
"cost": null,
"profit": null,
"is_tax_included": false,
"deleted_at": null,
"barcode": null,
"weight_amount": null,
"weight_unit": null,
"market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
"branch_id": null,
"modifierable_type": "PRODUCT_MODIFIER_ADDON_GROUP",
"stock": null,
"product_id": null,
"sku": null,
"updated_at": null,
"barcode_img": null
}
]
},
{
"id": "966e1452-c1ac-4e8d-8372-4d6f4b3c6c49",
"market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
"name_en": "Earum omnis",
"name_ar": "الصلصات",
"min_additionals": 0,
"max_additionals": 3,
"order": 1,
"created_at": 1792593344172,
"updated_at": 1792593344172,
"deleted_at": null,
"products_count": 0,
"options": []
},
{
"id": "d00cea0f-e6da-42ea-989c-ebb776d96372",
"market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
"name_en": "Sauces",
"name_ar": "الصلصات",
"min_additionals": 0,
"max_additionals": 3,
"order": 1,
"created_at": 1792593343758,
"updated_at": 1792593343758,
"deleted_at": null,
"products_count": 1,
"options": [
{
"id": 738792832050558,
"modifierable_id": "d00cea0f-e6da-42ea-989c-ebb776d96372",
"name_en": "Garlic Sauce",
"name_ar": "صلصة ثوم",
"type": "ADDITIONAL",
"calorie": null,
"price": 2,
"tax": 0,
"total": 2,
"cost": null,
"profit": null,
"is_tax_included": false,
"deleted_at": null,
"barcode": null,
"weight_amount": null,
"weight_unit": null,
"market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
"branch_id": null,
"modifierable_type": "PRODUCT_MODIFIER_ADDON_GROUP",
"stock": null,
"product_id": null,
"sku": null,
"updated_at": null,
"barcode_img": null
}
]
},
{
"id": "f142f096-e96b-4190-81fe-1b2fea7d055d",
"market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
"name_en": "Sauces",
"name_ar": "الصلصات",
"min_additionals": 0,
"max_additionals": 3,
"order": 1,
"created_at": 1792593343707,
"updated_at": 1792593343707,
"deleted_at": null,
"products_count": 1,
"options": [
{
"id": 738792831837654,
"modifierable_id": "f142f096-e96b-4190-81fe-1b2fea7d055d",
"name_en": "Garlic Sauce",
"name_ar": "صلصة ثوم",
"type": "ADDITIONAL",
"calorie": null,
"price": 2,
"tax": 0,
"total": 2,
"cost": null,
"profit": null,
"is_tax_included": false,
"deleted_at": null,
"barcode": null,
"weight_amount": null,
"weight_unit": null,
"market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
"branch_id": null,
"modifierable_type": "PRODUCT_MODIFIER_ADDON_GROUP",
"stock": null,
"product_id": null,
"sku": null,
"updated_at": null,
"barcode_img": null
}
]
}
],
"first_page_url": "https://localhost:8000/api/v2/products/addon-groups?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "https://localhost:8000/api/v2/products/addon-groups?page=1",
"links": [
{
"url": null,
"label": "« Previous",
"page": null,
"active": false
},
{
"url": "https://localhost:8000/api/v2/products/addon-groups?page=1",
"label": "1",
"page": 1,
"active": true
},
{
"url": null,
"label": "Next »",
"page": null,
"active": false
}
],
"next_page_url": null,
"path": "https://localhost:8000/api/v2/products/addon-groups",
"per_page": 20,
"prev_page_url": null,
"to": 14,
"total": 14
}
}{
"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
}List Addon Group Options GET
Page through every option of an add-on group, in the same id order the product list embeds them. The product list serves at most 100 options per group (`addon_groups[].options`, with `options_count` at `X-API-Version >= 2.9.0`); this is the overflow fetch for the rest. `per_page` is capped at 100.
List Product Addon Groups GET
List the add-on groups attached to a product, in their per-product order.