v1
latestOpenAPI 3.0.12026-08-062555238.4 KBCatalog API endpoints
Create/update full catalog
Use this endpoint to create/update a catalog for a specific branch in one go.
The user can provide all necessary details and create/update the entire catalog with a single request.
Please be aware that it may take approximately 5 minutes for the changes to be reflected on the SuperApp.
put/catalogs
Headers
Authorizationstring required
User-Agentstring required
Brand-Idstring
Branch-Idstring required
Request body
Example request
{
"catalog": {
"id": "DefaultCatalog",
"name": "Default",
"include_tax": true,
"tax": 5.2,
"avg_price": 12.25,
"file": "https://loremflickr.com/cache/resized/65535_49625844823_baed6d35f9_320_240_g.jpg",
"currency_id": 1,
"category_ids": [
"breakfast"
]
},
"categories": [
{
"id": "breakfast",
"name": "Default",
"name_localized": {
"en": "Breakfast",
"ar": ""
},
"description": "All the breakfast items",
"description_localized": {
"en": "All breakfast items",
"ar": ""
},
"preparation_time": 20,
"priority": 1,
"media": "https://picsum.photos/300.jpg",
"operational_hours": [
{
"shifts": [
{
"start_time": "10:00",
"end_time": "12:00"
}
],
"active": true,
"day_of_week": 5
}
],
"sub_categories": [
"breakfast"
],
"items": [
"pancakes"
]
}
],
"sub_categories": [
{
"id": "breakfast",
"name": "Default",
"name_localized": {
"en": "Breakfast",
"ar": ""
},
"description": "All the breakfast items",
"description_localized": {
"en": "All breakfast items",
"ar": ""
},
"preparation_time": 20,
"media": "https://picsum.photos/300.jpg",
"priority": 1,
"operational_hours": [
{
"shifts": [
{
"start_time": "10:00",
"end_time": "12:00"
}
],
"active": true,
"day_of_week": 5
}
],
"items": [
"pancakes"
]
}
],
"items": [
{
"id": "pancakes",
"name": "Pancakes",
"name_localized": {
"en": "Pancakes",
"ar": ""
},
"description": "Fresh egg and chocolate pancakes",
"description_localized": {
"en": "Fresh egg and chocolate pancakes",
"ar": ""
},
"active": true,
"price": 20,
"calorie_counts": "200",
"allergic_information": "allergic to eggs",
"operational_hours": [
{
"shifts": [
{
"start_time": "10:00",
"end_time": "12:00"
}
],
"active": true,
"day_of_week": 5
}
],
"media": "https://picsum.photos/300.jpg",
"priority": 3,
"tags": [
"careem-mealson"
],
"groups": [
"addons"
]
}
],
"groups": [
{
"id": "addons",
"deleted": false,
"name": "Choose add-ons",
"name_localized": {
"en": "Choose add-ons",
"ar": ""
},
"description": "Add-ons for pancakes",
"description_localized": {
"en": "Add-ons for pancakes",
"ar": ""
},
"multi_select": false,
"min": 1,
"max": 2,
"priority": 100,
"options": [
"syrup",
"butter"
]
},
{
"id": "choose-syrup",
"deleted": false,
"name": "Choose syrups",
"name_localized": {
"en": "Choose syrups",
"ar": ""
},
"description": "Select what type of syrup you want",
"description_localized": {
"en": "Syrup for pancakes",
"ar": ""
},
"multi_select": false,
"min": 0,
"max": 0,
"priority": 101,
"options": [
"maple",
"honey"
]
}
],
"options": [
{
"id": "syrup",
"deleted": false,
"name": "Syrup",
"name_localized": {
"en": "Syrup",
"ar": ""
},
"active": true,
"price": 10,
"priority": 100,
"groups": [
"choose-syrup"
]
},
{
"id": "butter",
"deleted": false,
"name": "Butter",
"name_localized": {
"en": "Butter",
"ar": ""
},
"active": true,
"price": 5,
"priority": 101
},
{
"id": "maple",
"deleted": false,
"name": "Maple syrup",
"name_localized": {
"en": "Maple syrup",
"ar": ""
},
"active": true,
"price": 1,
"priority": 500
},
{
"id": "honey",
"deleted": false,
"name": "Honey syrup",
"name_localized": {
"en": "Honey syrup",
"ar": ""
},
"active": true,
"price": 1,
"priority": 501
}
],
"item_categories": [
{
"item_id": "item-1",
"category_id": "cat-A",
"deleted": true
}
]
}Response
Catalog created/updated
Example response
{
"request_id": "1400",
"created_at": "2020-06-22T15:01:32.895Z",
"url": "/catalogs/status/1400",
"message": "Please use this request ID string to check status of catalog upload request."
}