Products & Categories Run in API Explorer
Ask AI
Insert/update Products
The Source of Truth in terms of product data and structure is almost always sourced from an integrated POS system. When a POS successfully syncs products with their unique identifiers (PLUs), these will be selected by the customer for inclusion in their menu(s).
In turn, orders will be created with these same PLUs and injected into the POS via an 'Order Webhook'
This process does not necessarily need a complete transfer of products stored in the POS, but can involve only a subset of products i.e. 'Online Only products' which a customer can possibly flag as being suitable for selling online.
ⓘ Endpoint Behaviour
Every call to this endpoint will either; create, update or delete products, based on the products that already exist in the specified location.
POST
/productAndCategories
curl \
--request POST 'https://api.staging.deliverect.com/productAndCategories' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{"accountId":"6**f578fa205bc3eca854***","locationId":"6**91e9273d6950b4b0a8***","products":[{"productType":1,"plu":"STK-01","price":1500,"name":"Delicious Steak Frites","kitchenName":"Steak","posProductId":"POS-ID-001","posCategoryIds":["STK"],"imageUrl":"https://storage.googleapis.com/ikona-bucket-staging/images/5ff6ee089328c8aefeeabe33/steak-622862588c506f015be6018e.jpeg","description":"Delicious Steak Frites","descriptionTranslations":{"es":"Deliciosos Bistecs Fritos","fr":"Steak Frites Délicieux","nl":"Heerlijke Biefstuk Frites","ar":"شريحة لحم فريتس","el":"Νοστιμη χοιρινή παντσέτα με πατάτες"},"deliveryTax":9000,"takeawayTax":9000,"nameTranslations":{"en":"Delicious Steak Frites","es":"Deliciosos Bistecs Fritos","fr":"Steak Frites Délicieux","nl":"Heerlijke Biefstuk Frites","ar":"شريحة لحم فريتس","el":"Νοστιμη χοιρινή παντσέτα με πατάτες"},"eatInTax":9000,"multiMax":1,"nutritionalInfo":{"fat":1,"sugar":4,"saturatedFat":1,"carbohydrates":1,"protein":1,"salt":1},"subProducts":["AUTO-01","MOD-01","MOD-02"]},{"productType":3,"plu":"MOD-01","name":"Cooking instructions","posProductId":"POS-ID-009","posCategoryIds":["POS-CAT-001"],"imageUrl":"","description":"Cooking Instructions","descriptionTranslations":{"es":"Cocinado","fr":"Cuisson","nl":"Kook instructies","ar":"تعليمات الطبخ","el":"Οδηγίες μαγειρέματος"},"deliveryTax":6000,"takeawayTax":6000,"nameTranslations":{"en":"Cooking Instructions","es":"Cocinado","fr":"Cuisson","nl":"Kook instructies","ar":"تعليمات الطبخ","el":"Οδηγίες μαγειρέματος"},"min":1,"max":1,"subProducts":["COOK-01","COOK-02","COOK-03"]},{"productType":3,"plu":"MOD-02","name":"Add a side","posProductId":"POS-ID-014","posCategoryIds":"INTERNAL-POS-CAT-2","imageUrl":"https://www.stockvault.net/data/2009/07/20/109569/preview16.jpg","description":"Pizza made for cheese fanatics","deliveryTax":6000,"takeawayTax":6000,"nameTranslations":{"en":"Choose a side","es":"Elige tu acompañamiento","fr":"Choisissez votre garniture","nl":"Kies je bijgerecht","ar":"اختر طبقك الجانبي","el":"Διαλέξτε ακόμα"},"subProducts":["SI-01","SI-02","SI-03"],"min":0,"max":0,"multiMax":3},{"productType":3,"plu":"AUTO-01","price":900,"name":"Garnishes","posProductId":"POS-ID-032","imageUrl":"","description":"","deliveryTax":6000,"takeawayTax":6000,"min":0,"max":0,"autoApply":[{"plu":"PR1"},{"plu":"PR2"}],"subProducts":["PR1","PR2"]},{"productType":2,"plu":"PR1","price":0,"name":"Parsley","posProductId":"PA_POS-0023","posCategoryIds":"","imageUrl":"","description":"","deliveryTax":0,"takeawayTax":0,"defaultQuantity":3},{"productType":2,"plu":"PR2","price":0,"name":"Melted Butter","posProductId":"PA_POS-0024","posCategoryIds":"","imageUrl":"","description":"","deliveryTax":0,"takeawayTax":0},{"productType":2,"plu":"COOK-01","price":0,"name":"Rare","posProductId":"POS-ID-003","posCategoryIds":["POS-CAT-001"],"imageUrl":"","description":"","deliveryTax":9000,"takeawayTax":9000,"nameTranslations":{"en":"Rare","es":"Poco hecho","fr":"Saignant","nl":"Rood","ar":"غير ناضج جيدا","el":"Ωμό"}},{"productType":2,"plu":"COOK-02","price":0,"name":"Medium Rare","posProductId":"POS-ID-004","posCategoryIds":"INTERNAL-POS-CAT-2","imageUrl":"","description":"","deliveryTax":9000,"takeawayTax":9000,"nameTranslations":{"en":"Medium Rare","es":"Al punto","fr":"À point","nl":"Half doorbakken","ar":"مُتَوَسِّط النُضْجِ","el":"Μισοψημένο"}},{"productType":2,"plu":"COOK-03","price":0,"name":"Well Done","posProductId":"POS-ID-005","posCategoryIds":"INTERNAL-POS-CAT-2","imageUrl":"","description":"","deliveryTax":9000,"takeawayTax":9000,"nameTranslations":{"en":"Well done","es":"Muy hecho","fr":"Bien cuit","nl":"Doorbakken","ar":"مطبوخ جيدا","el":"καλοψημένο"}},{"productType":2,"plu":"SI-01","price":0,"name":"Fries","posProductId":"POS-ID-012","posCategoryIds":["SD"],"imageUrl":"","description":"Fries","descriptionTranslations":{"es":"Patatas fritas","fr":"Frites","nl":"Frietjes","ar":"بطاطس مقلية","ελ":"Πατάτες"},"deliveryTax":9000,"takeawayTax":9000,"nameTranslations":{"en":"Fries","es":"Patatas fritas","fr":"Frites","nl":"Frietjes","ar":"بطاطس مقلية","ελ":"Πατάτες"},"eatInTax":9000,"defaultQuantity":1},{"productType":2,"plu":"SI-02","price":200,"name":"Salad","kitchenName":"","posProductId":"POS-ID-013","posCategoryIds":["SD"],"imageUrl":"","description":"Salad","descriptionTranslations":{"es":"Ensalada","fr":"Salade","nl":"Salade","ar":"سلطة","ελ":"Σαλάτα"},"deliveryTax":9000,"takeawayTax":9000,"nameTranslations":{"en":"Salad","es":"Ensalada","fr":"Salade","nl":"Salade","ar":"سلطة","ελ":"Σαλάτα"},"eatInTax":9000},{"productType":2,"plu":"SI-03","price":100,"name":"Mashed Potato","kitchenName":"Mash","posProductId":"POS-ID-014","posCategoryIds":["SD"],"imageUrl":"","description":"Mashed Potato","descriptionTranslations":{"es":"Puré de patata","fr":"Purée de pommes de terre","nl":"Aardappelpuree","ar":"البطاطا المهروسة","el":"Πουρές πατάτας"},"deliveryTax":9000,"takeawayTax":9000,"nameTranslations":{"en":"Mashed Potato","es":"Puré de patata","fr":"Purée de pommes de terre","nl":"Aardappelpuree","ar":"البطاطا المهروسة","el":"Πουρές πατάτας"},"eatInTax":9000}],"categories":[{"name":"Steaks","posCategoryId":"STK"},{"name":"Sides","posCategoryId":"SD"}]}'
Request examples
Basic example
{
"accountId": "6**f578fa205bc3eca854***",
"locationId": "6**91e9273d6950b4b0a8***",
"products": [
{
"productType": 1,
"plu": "STK-01",
"price": 1500,
"name": "Delicious Steak Frites",
"kitchenName": "Steak",
"posProductId": "POS-ID-001",
"posCategoryIds": [
"STK"
],
"imageUrl": "https://storage.googleapis.com/ikona-bucket-staging/images/5ff6ee089328c8aefeeabe33/steak-622862588c506f015be6018e.jpeg",
"description": "Delicious Steak Frites",
"descriptionTranslations": {
"es": "Deliciosos Bistecs Fritos",
"fr": "Steak Frites Délicieux",
"nl": "Heerlijke Biefstuk Frites",
"ar": "شريحة لحم فريتس",
"el": "Νοστιμη χοιρινή παντσέτα με πατάτες"
},
"deliveryTax": 9000,
"takeawayTax": 9000,
"nameTranslations": {
"en": "Delicious Steak Frites",
"es": "Deliciosos Bistecs Fritos",
"fr": "Steak Frites Délicieux",
"nl": "Heerlijke Biefstuk Frites",
"ar": "شريحة لحم فريتس",
"el": "Νοστιμη χοιρινή παντσέτα με πατάτες"
},
"eatInTax": 9000,
"multiMax": 1,
"nutritionalInfo": {
"fat": 1,
"sugar": 4,
"saturatedFat": 1,
"carbohydrates": 1,
"protein": 1,
"salt": 1
},
"subProducts": [
"AUTO-01",
"MOD-01",
"MOD-02"
]
},
{
"productType": 3,
"plu": "MOD-01",
"name": "Cooking instructions",
"posProductId": "POS-ID-009",
"posCategoryIds": [
"POS-CAT-001"
],
"imageUrl": "",
"description": "Cooking Instructions",
"descriptionTranslations": {
"es": "Cocinado",
"fr": "Cuisson",
"nl": "Kook instructies",
"ar": "تعليمات الطبخ",
"el": "Οδηγίες μαγειρέματος"
},
"deliveryTax": 6000,
"takeawayTax": 6000,
"nameTranslations": {
"en": "Cooking Instructions",
"es": "Cocinado",
"fr": "Cuisson",
"nl": "Kook instructies",
"ar": "تعليمات الطبخ",
"el": "Οδηγίες μαγειρέματος"
},
"min": 1,
"max": 1,
"subProducts": [
"COOK-01",
"COOK-02",
"COOK-03"
]
},
{
"productType": 3,
"plu": "MOD-02",
"name": "Add a side",
"posProductId": "POS-ID-014",
"posCategoryIds": "INTERNAL-POS-CAT-2",
"imageUrl": "https://www.stockvault.net/data/2009/07/20/109569/preview16.jpg",
"description": "Pizza made for cheese fanatics",
"deliveryTax": 6000,
"takeawayTax": 6000,
"nameTranslations": {
"en": "Choose a side",
"es": "Elige tu acompañamiento",
"fr": "Choisissez votre garniture",
"nl": "Kies je bijgerecht",
"ar": "اختر طبقك الجانبي",
"el": "Διαλέξτε ακόμα"
},
"subProducts": [
"SI-01",
"SI-02",
"SI-03"
],
"min": 0,
"max": 0,
"multiMax": 3
},
{
"productType": 3,
"plu": "AUTO-01",
"price": 900,
"name": "Garnishes",
"posProductId": "POS-ID-032",
"imageUrl": "",
"description": "",
"deliveryTax": 6000,
"takeawayTax": 6000,
"min": 0,
"max": 0,
"autoApply": [
{
"plu": "PR1"
},
{
"plu": "PR2"
}
],
"subProducts": [
"PR1",
"PR2"
]
},
{
"productType": 2,
"plu": "PR1",
"price": 0,
"name": "Parsley",
"posProductId": "PA_POS-0023",
"posCategoryIds": "",
"imageUrl": "",
"description": "",
"deliveryTax": 0,
"takeawayTax": 0,
"defaultQuantity": 3
},
{
"productType": 2,
"plu": "PR2",
"price": 0,
"name": "Melted Butter",
"posProductId": "PA_POS-0024",
"posCategoryIds": "",
"imageUrl": "",
"description": "",
"deliveryTax": 0,
"takeawayTax": 0
},
{
"productType": 2,
"plu": "COOK-01",
"price": 0,
"name": "Rare",
"posProductId": "POS-ID-003",
"posCategoryIds": [
"POS-CAT-001"
],
"imageUrl": "",
"description": "",
"deliveryTax": 9000,
"takeawayTax": 9000,
"nameTranslations": {
"en": "Rare",
"es": "Poco hecho",
"fr": "Saignant",
"nl": "Rood",
"ar": "غير ناضج جيدا",
"el": "Ωμό"
}
},
{
"productType": 2,
"plu": "COOK-02",
"price": 0,
"name": "Medium Rare",
"posProductId": "POS-ID-004",
"posCategoryIds": "INTERNAL-POS-CAT-2",
"imageUrl": "",
"description": "",
"deliveryTax": 9000,
"takeawayTax": 9000,
"nameTranslations": {
"en": "Medium Rare",
"es": "Al punto",
"fr": "À point",
"nl": "Half doorbakken",
"ar": "مُتَوَسِّط النُضْجِ",
"el": "Μισοψημένο"
}
},
{
"productType": 2,
"plu": "COOK-03",
"price": 0,
"name": "Well Done",
"posProductId": "POS-ID-005",
"posCategoryIds": "INTERNAL-POS-CAT-2",
"imageUrl": "",
"description": "",
"deliveryTax": 9000,
"takeawayTax": 9000,
"nameTranslations": {
"en": "Well done",
"es": "Muy hecho",
"fr": "Bien cuit",
"nl": "Doorbakken",
"ar": "مطبوخ جيدا",
"el": "καλοψημένο"
}
},
{
"productType": 2,
"plu": "SI-01",
"price": 0,
"name": "Fries",
"posProductId": "POS-ID-012",
"posCategoryIds": [
"SD"
],
"imageUrl": "",
"description": "Fries",
"descriptionTranslations": {
"es": "Patatas fritas",
"fr": "Frites",
"nl": "Frietjes",
"ar": "بطاطس مقلية",
"ελ": "Πατάτες"
},
"deliveryTax": 9000,
"takeawayTax": 9000,
"nameTranslations": {
"en": "Fries",
"es": "Patatas fritas",
"fr": "Frites",
"nl": "Frietjes",
"ar": "بطاطس مقلية",
"ελ": "Πατάτες"
},
"eatInTax": 9000,
"defaultQuantity": 1
},
{
"productType": 2,
"plu": "SI-02",
"price": 200,
"name": "Salad",
"kitchenName": "",
"posProductId": "POS-ID-013",
"posCategoryIds": [
"SD"
],
"imageUrl": "",
"description": "Salad",
"descriptionTranslations": {
"es": "Ensalada",
"fr": "Salade",
"nl": "Salade",
"ar": "سلطة",
"ελ": "Σαλάτα"
},
"deliveryTax": 9000,
"takeawayTax": 9000,
"nameTranslations": {
"en": "Salad",
"es": "Ensalada",
"fr": "Salade",
"nl": "Salade",
"ar": "سلطة",
"ελ": "Σαλάτα"
},
"eatInTax": 9000
},
{
"productType": 2,
"plu": "SI-03",
"price": 100,
"name": "Mashed Potato",
"kitchenName": "Mash",
"posProductId": "POS-ID-014",
"posCategoryIds": [
"SD"
],
"imageUrl": "",
"description": "Mashed Potato",
"descriptionTranslations": {
"es": "Puré de patata",
"fr": "Purée de pommes de terre",
"nl": "Aardappelpuree",
"ar": "البطاطا المهروسة",
"el": "Πουρές πατάτας"
},
"deliveryTax": 9000,
"takeawayTax": 9000,
"nameTranslations": {
"en": "Mashed Potato",
"es": "Puré de patata",
"fr": "Purée de pommes de terre",
"nl": "Aardappelpuree",
"ar": "البطاطا المهروسة",
"el": "Πουρές πατάτας"
},
"eatInTax": 9000
}
],
"categories": [
{
"name": "Steaks",
"posCategoryId": "STK"
},
{
"name": "Sides",
"posCategoryId": "SD"
}
]
}{
"accountId": "6**f578fa205bc3eca854***",
"locationId": "6**91e9273d6950b4b0a8***",
"products": [
{
"productType": 1,
"plu": "P-SATE",
"price": 450,
"name": "Chicken Sate",
"posProductId": "POS-001",
"posCategoryIds": [
"SATE"
],
"imageUrl": "https://storage.googleapis.com/ikona-bucket-staging/images/5ff6ee089328c8aefeeabe33/satay-62284e3c8c506f015be60184.jpeg",
"description": "8 pieces of Chicken Sate",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000,
"subProducts": [
"MG-RICE",
"MG-NOODLES"
],
"productTags": [
104,
109
]
},
{
"productType": 3,
"plu": "MG-RICE",
"name": "Rice Selection",
"posProductId": "POS-002",
"subProducts": [
"RICE-01",
"RICE-02"
],
"min": 0,
"max": 0
},
{
"productType": 3,
"plu": "MG-NOODLES",
"name": "Noodles Selection",
"posProductId": "POS-003",
"subProducts": [
"NOOD-01",
"NOOD-02"
],
"min": 0,
"max": 0
},
{
"productType": 1,
"plu": "RICE-01",
"price": 450,
"name": "White Rice",
"posProductId": "POS-004",
"posCategoryIds": [
"SD"
],
"imageUrl": "https://storage.googleapis.com/ikona-bucket-staging/images/5ff6ee089328c8aefeeabe33/nasiputi-1610290140494.jpg",
"description": "",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000,
"subProducts": [
"MG-SAUCES"
]
},
{
"productType": 1,
"plu": "RICE-02",
"price": 450,
"name": "Yellow Rice",
"posProductId": "POS-005",
"posCategoryIds": [
"SD"
],
"imageUrl": "https://storage.googleapis.com/ikona-bucket-staging/images/5ff6ee089328c8aefeeabe33/Nasi-kuning-3-1610289726946.jpg",
"description": "",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000,
"subProducts": [
"MG-SAUCES"
]
},
{
"productType": 1,
"plu": "NOOD-01",
"price": 450,
"name": "Egg Noodles",
"posProductId": "POS-006",
"posCategoryIds": [
"SD"
],
"imageUrl": "https://storage.googleapis.com/ikona-bucket-staging/images/5ff6ee089328c8aefeeabe33/bamigoreng-1610289922969.jpg",
"description": "",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000,
"subProducts": [
"MG-SAUCES"
]
},
{
"productType": 1,
"plu": "NOOD-02",
"price": 450,
"name": "Ramen Noodles",
"posProductId": "POS-007",
"posCategoryIds": [
"SD"
],
"imageUrl": "https://storage.googleapis.com/ikona-bucket-staging/images/5ff6ee089328c8aefeeabe33/Mihoen-2-1-1610289870157.jpg",
"description": "",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000,
"subProducts": [
"MG-SAUCES"
]
},
{
"productType": 3,
"plu": "MG-SAUCES",
"name": "Choose a sauce",
"posProductId": "POS-008",
"imageUrl": "",
"multiMax": 2,
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000,
"subProducts": [
"SAUCE-01",
"SAUCE-02"
],
"min": 0,
"max": 0
},
{
"productType": 2,
"plu": "SAUCE-01",
"price": 0,
"name": "Sate Sauce",
"posProductId": "POS-009",
"imageUrl": "",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000
},
{
"productType": 2,
"plu": "SAUCE-02",
"price": 0,
"name": "Hot Sauce",
"posProductId": "POS-010",
"imageUrl": "",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000
}
],
"categories": [
{
"name": "Sate Dishes",
"posCategoryId": "SATE"
},
{
"name": "Side Dishes",
"posCategoryId": "SD"
}
]
}{
"accountId": "6**f578fa205bc3eca854***",
"locationId": "6**91e9273d6950b4b0a8***",
"products": [
{
"productType": 1,
"isCombo": true,
"plu": "P-BRGR",
"price": 950,
"name": "Burger Meal (Drink not Included)",
"posProductId": "POS-ID-0001",
"posCategoryIds": [
"BURG"
],
"subProducts": [
"BNDL-BRG",
"MG-FRS",
"UPSLL-01"
],
"imageUrl": "https://storage.googleapis.com/ikona-bucket-staging/images/5ff6ee089328c8aefeeabe33/burger-62286be78c506f015be60190.jpeg",
"description": "",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000
},
{
"productType": 4,
"plu": "BNDL-BRG",
"name": "Burger Selection",
"sortOrder": 1,
"posProductId": "",
"subProducts": [
"P-BURG-CHK",
"P-BURG-CHE",
"P-BURG-VEG"
],
"imageUrl": "",
"description": "",
"min": 1,
"max": 1
},
{
"productType": 3,
"plu": "MG-FRS",
"name": "Fries Selection",
"sortOrder": 2,
"posProductId": "",
"subProducts": [
"P-FRS-S",
"P-FRS-M",
"P-FRS-L"
],
"imageUrl": "",
"description": "",
"min": 1,
"max": 1
},
{
"productType": 3,
"plu": "UPSLL-01",
"name": "Add a Drink? (not included)",
"isUpsell": true,
"posProductId": "POS-ID-0002",
"min": 0,
"multiMax": 99,
"eatInTax": 9000,
"subProducts": [
"DRNK-01",
"DRNK-02",
"DRNK-03"
]
},
{
"productType": 1,
"plu": "P-FRS-S",
"price": 200,
"name": "French Fries",
"posProductId": "POS-ID-0002",
"posCategoryIds": [
"FRS"
],
"imageUrl": "",
"description": "",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000
},
{
"productType": 1,
"plu": "P-FRS-M",
"price": 250,
"name": "Curly Fries",
"posProductId": "POS-ID-0003",
"posCategoryIds": [
"FRS"
],
"imageUrl": "",
"description": "",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000
},
{
"productType": 1,
"plu": "P-FRS-L",
"price": 300,
"name": "Seasoned Fries",
"posProductId": "",
"posCategoryIds": [
"FRS"
],
"imageUrl": "",
"description": "",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000
},
{
"productType": 1,
"plu": "P-BURG-CHK",
"price": 0,
"name": "Chicken Burger",
"posProductId": "",
"posCategoryIds": [
"BURG"
],
"imageUrl": "https://storage.googleapis.com/ikona-bucket-staging/images/5ff6ee089328c8aefeeabe33/chkburger-6228c1dcdb5986001ebf58df.jpeg",
"description": "",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000
},
{
"productType": 1,
"plu": "P-BURG-CHE",
"price": 0,
"name": "Cheeseburger",
"posProductId": "",
"posCategoryIds": [
"BURG"
],
"imageUrl": "https://storage.googleapis.com/ikona-bucket-staging/images/5ff6ee089328c8aefeeabe33/cheeseburger-62286e26db5986001ebf58d7.jpg",
"description": "",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000
},
{
"productType": 1,
"plu": "P-BURG-VEG",
"price": 0,
"name": "Veggie Burger",
"posProductId": "",
"posCategoryIds": [
"BURG"
],
"imageUrl": "https://storage.googleapis.com/ikona-bucket-staging/images/5ff6ee089328c8aefeeabe33/veggieburger-62286cbac715b403b0eb7294.jpeg",
"description": "",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000,
"productTags": [
5
]
},
{
"productType": 1,
"plu": "DRNK-01",
"price": 400,
"name": "Coca Cola",
"gtin": [
"8901764012273",
"5310006000009"
],
"posProductId": "POS-ID-0003",
"posCategoryIds": [
"DRK"
],
"imageUrl": "https://storage.googleapis.com/ikona-bucket-staging/images/5ff6ee089328c8aefeeabe33/cocacola-622854a78c506f015be6018a.jpeg",
"description": "",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000,
"productTags": [
10
]
},
{
"productType": 1,
"plu": "DRNK-02",
"price": 400,
"name": "Diet Coke",
"gtin": [
"0049000006346"
],
"posProductId": "POS-ID-0004",
"posCategoryIds": [
"DRK"
],
"imageUrl": "https://storage.googleapis.com/ikona-bucket-staging/images/5ff6ee089328c8aefeeabe33/dietcoke-622854ce8c506f015be6018c.jpeg",
"description": "",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000,
"productTags": [
10,
1128
]
},
{
"productType": 1,
"plu": "DRNK-03",
"price": 400,
"gtin": [
"74993001078"
],
"name": "Ginger Beer",
"posProductId": "POS-ID-0005",
"posCategoryIds": [
"DRK"
],
"imageUrl": "https://storage.googleapis.com/ikona-bucket-staging/images/5ff6ee089328c8aefeeabe33/gingerbeer-62285548db5986001ebf58d1.jpg",
"description": "",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000,
"productTags": [
10
]
}
],
"categories": [
{
"name": "Burgers",
"posCategoryId": "BURG"
},
{
"name": "Drinks",
"posCategoryId": "DRK"
},
{
"name": "Fries",
"posCategoryId": "FRS"
}
]
}{
"accountId": "6**f578fa205bc3eca854***",
"locationId": "6**91e9273d6950b4b0a8***",
"products": [
{
"productType": 1,
"isCombo": true,
"plu": "P-PB-01",
"price": 1000,
"name": "Build a Poke Bowl",
"posProductId": "POS-ID-017",
"posCategoryIds": [
"POKB"
],
"imageUrl": "https://storage.googleapis.com/ikona-bucket-staging/images/5ff6ee089328c8aefeeabe33/poke-622850c8b303fc03a148de44.jpg",
"description": "Select a size then choose your ingredients",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000,
"subProducts": [
"POKE-SZ",
"BNDL-01",
"BNDL-02"
]
},
{
"productType": 3,
"plu": "POKE-SZ",
"name": "Choose your size",
"posProductId": "POS-ID-0012",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000,
"subProducts": [
"SZ-01",
"SZ-02"
],
"min": 1,
"max": 1
},
{
"productType": 1,
"plu": "SZ-01",
"price": 0,
"name": "Mini Poke Bowl",
"posProductId": "POS-ID-001",
"description": "A little bowl of Poke",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000,
"subProducts": [
"BNDL-01-SML"
]
},
{
"productType": 1,
"plu": "SZ-02",
"price": 1200,
"name": "Large Poke Bowl",
"posProductId": "POS-ID-001",
"description": "A big bowl of Poke",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000,
"subProducts": [
"BNDL-LG"
]
},
{
"productType": 4,
"plu": "BNDL-01",
"name": "Choose Your Base",
"posProductId": "POS-ID-012",
"min": 1,
"max": 1,
"subProducts": [
"BS-01",
"BS-02"
]
},
{
"productType": 4,
"plu": "BNDL-01-SML",
"price": 0,
"name": "Choose Your Protein",
"posProductId": "POS-ID-012",
"imageUrl": "",
"min": 1,
"max": 1,
"subProducts": [
"PRT-01",
"PRT-02",
"PRT-03"
]
},
{
"productType": 4,
"plu": "BNDL-LG",
"name": "Choose Your Protein",
"posProductId": "POS-ID-012",
"imageUrl": "",
"min": 1,
"max": 1,
"subProducts": [
"PRT-01",
"PRT-02",
"PRT-03"
]
},
{
"productType": 4,
"plu": "BNDL-02",
"name": "Add Extras",
"posProductId": "POS-ID-012",
"imageUrl": "",
"min": 0,
"max": 3,
"multiMax": 3,
"subProducts": [
"XTRA-TOF",
"XTRA-CONI",
"XTRA-AVO"
]
},
{
"productType": 1,
"plu": "BS-01",
"price": 0,
"name": "Sushi Rice",
"posProductId": "POS-ID-006",
"imageUrl": "",
"description": "",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000
},
{
"productType": 1,
"plu": "BS-02",
"price": 0,
"name": "Cruncy Cabbage Slaw",
"posProductId": "POS-ID-006",
"imageUrl": "",
"description": "",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000
},
{
"productType": 1,
"plu": "PRT-01",
"price": 0,
"name": "Yuzu Salmon",
"posProductId": "POS-ID-006",
"imageUrl": "",
"description": "",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000,
"overloads": [
{
"scopes": [
"BNDL-01-SML"
],
"bundlePrice": 180
},
{
"scopes": [
"BNDL-LG"
],
"bundlePrice": 250
}
]
},
{
"productType": 1,
"plu": "PRT-02",
"price": 0,
"name": "Spicy Tuna",
"posProductId": "POS-ID-006",
"imageUrl": "",
"description": "",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000
},
{
"productType": 1,
"plu": "PRT-03",
"price": 0,
"name": "Teriyaki Chicken",
"posProductId": "POS-ID-006",
"imageUrl": "",
"description": "",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000
},
{
"productType": 1,
"plu": "XTRA-TOF",
"price": 0,
"name": "Spicy Tofu",
"posProductId": "POS-ID-001",
"imageUrl": "",
"description": "",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000
},
{
"productType": 1,
"plu": "XTRA-CONI",
"price": 0,
"name": "Crispy Onions",
"posProductId": "POS-ID-001",
"imageUrl": "",
"description": "",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000
},
{
"productType": 1,
"plu": "XTRA-AVO",
"price": 0,
"name": "Smashed Avocado",
"posProductId": "POS-ID-001",
"imageUrl": "",
"description": "",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000
}
],
"categories": [
{
"name": "Poke Bowls",
"posCategoryId": "POKB"
}
]
}{
"accountId": "6**f578fa205bc3eca854***",
"locationId": "6**91e9273d6950b4b0a8***",
"products": [
{
"productType": 1,
"plu": "PIZZ-00",
"price": 800,
"name": "Build your own Pizza",
"posCategoryIds": [
"PZ"
],
"posProductId": "POS-ID-0001",
"imageUrl": "https://storage.googleapis.com/ikona-bucket-staging/images/5ff6ee089328c8aefeeabe33/pizza-6228525eb303fc03a148de46.jpeg",
"description": "Build your own pizza, first topping is free!",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000,
"subProducts": [
"FREE-TOP",
"PIZZ-TOP"
]
},
{
"productType": 3,
"plu": "FREE-TOP",
"name": "Choose your First Topping",
"posProductId": "POS-ID-002",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000,
"subProducts": [
"PEPP",
"BAC",
"ANCHO",
"RONION",
"MUSH",
"REDPEPP"
],
"min": 1,
"max": 1
},
{
"productType": 3,
"plu": "PIZZ-TOP",
"name": "Add extra toppings",
"posProductId": "POS-ID-003",
"min": 0,
"max": 0,
"multiMax": 10,
"subProducts": [
"PEPP",
"BAC",
"ANCHO",
"RONION",
"MUSH",
"REDPEPP"
]
},
{
"productType": 2,
"plu": "PEPP",
"price": 0,
"name": "Pepperoni",
"posProductId": "POS-ID-004",
"imageUrl": "",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000,
"overloads": [
{
"scopes": [
"FREE-TOP"
],
"price": 0
},
{
"scopes": [
"PIZZ-TOP"
],
"price": 100
}
]
},
{
"productType": 2,
"plu": "RONION",
"price": 0,
"name": "Red Onion",
"posProductId": "POS-ID-005",
"imageUrl": "",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000,
"overloads": [
{
"scopes": [
"FREE-TOP"
],
"price": 0
},
{
"scopes": [
"PIZZ-TOP"
],
"price": 100
}
]
},
{
"productType": 2,
"plu": "MUSH",
"price": 0,
"name": "Mushroom",
"posProductId": "POS-ID-006",
"imageUrl": "",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000,
"overloads": [
{
"scopes": [
"FREE-TOP"
],
"price": 0
},
{
"scopes": [
"PIZZ-TOP"
],
"price": 100
}
]
},
{
"productType": 2,
"plu": "BAC",
"price": 0,
"name": "Bacon",
"posProductId": "POS-ID-007",
"imageUrl": "",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000,
"overloads": [
{
"scopes": [
"FREE-TOP"
],
"price": 0
},
{
"scopes": [
"PIZZ-TOP"
],
"price": 100
}
]
},
{
"productType": 2,
"plu": "REDPEPP",
"price": 0,
"name": "Red Pepper",
"posProductId": "POS-ID-008",
"imageUrl": "",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000,
"overloads": [
{
"scopes": [
"FREE-TOP"
],
"price": 0
},
{
"scopes": [
"PIZZ-TOP"
],
"price": 100
}
]
},
{
"productType": 2,
"plu": "Pine",
"price": 0,
"name": "Pineapple",
"posProductId": "POS-ID-009",
"imageUrl": "",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000,
"overloads": [
{
"scopes": [
"FREE-TOP"
],
"price": 0
},
{
"scopes": [
"PIZZ-TOP"
],
"price": 100
}
]
}
],
"categories": [
{
"name": "Pizzas",
"posCategoryId": "PZ"
}
]
}{
"accountId": "6**f578fa205bc3eca854***",
"locationId": "6**91e9273d6950b4b0a8***",
"products": [
{
"productType": 1,
"plu": "VAR-PROD-1",
"price": 0,
"name": "Chicken Tenders",
"posProductId": "POS-001",
"posCategoryIds": [
"CHK"
],
"imageUrl": "https://storage.googleapis.com/ikona-bucket-staging/images/5ff6ee089328c8aefeeabe33/chicken-62285f90db5986001ebf58d5.jpg",
"description": "Choose 3, 6 or 9 Pieces of Delicious Fried Chicken",
"isVariant": true,
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000,
"subProducts": [
"MG-VAR-1"
]
},
{
"productType": 3,
"plu": "MG-VAR-1",
"name": "How many pieces?",
"posProductId": "POS-002",
"description": "",
"isVariantGroup": true,
"subProducts": [
"VAR-1",
"VAR-2",
"VAR-3"
],
"min": 1,
"max": 1
},
{
"productType": 1,
"plu": "VAR-1",
"price": 800,
"name": "3 Pieces",
"posProductId": "POS-003",
"imageUrl": "",
"description": "",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000
},
{
"productType": 1,
"plu": "VAR-2",
"price": 1100,
"name": "6 Pieces",
"posProductId": "POS-004",
"imageUrl": "",
"description": "",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000
},
{
"productType": 1,
"plu": "VAR-3",
"price": 1350,
"name": "9 Pieces",
"posProductId": "POS-005",
"imageUrl": "",
"description": "",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000
}
],
"categories": [
{
"name": "Chicken",
"posCategoryId": "CHK"
}
]
}{
"accountId": "6**f578fa205bc3eca854***",
"locationId": "6**91e9273d6950b4b0a8***",
"products": [
{
"productType": 1,
"plu": "PIZZ-01",
"price": 800,
"priceLevels": {
"UE": 900,
"DL": 850,
"TA": 825
},
"name": "The Hawaiian",
"posCategoryIds": [
"PZ"
],
"imageUrl": "https://storage.googleapis.com/ikona-bucket-staging/images/5ff6ee089328c8aefeeabe33/hawaiian-622855c7b303fc03a148de48.jpeg",
"posProductId": "POS-ID-0001",
"description": "Italys favourite Pizza!",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000
}
],
"categories": [
{
"name": "Pizzas",
"posCategoryId": "PZ"
}
],
"priceLevels": [
{
"name": "Takeaway",
"posId": "TA"
},
{
"name": "Delivery",
"posId": "DL"
},
{
"name": "UberEats",
"posId": "UE"
}
]
}{
"accountId": "62d7*******cc2b5af1",
"locationId": "651153***a976f15c26",
"products": [
{
"productType": 1,
"plu": "DRNK-03",
"price": 400,
"gtin": [
"74993001078"
],
"bottleDepositPrice": 100,
"name": "Ginger Beer",
"description": "Made with the finest, locally grown ginger and sugarcane",
"posProductId": "POS-ID-0005",
"posCategoryIds": [
"DRK"
],
"imageUrl": "https://storage.googleapis.com/ikona-bucket-staging/images/5ff6ee089328c8aefeeabe33/gingerbeer-62285548db5986001ebf58d1.jpg",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000,
"priceLevels": {
"TA": 350,
"DE": 380,
"EI": 280
},
"calories": 500,
"caloriesRangeHigh": 750,
"nutritionalInfo": {
"fat": 2,
"sugar": 2,
"saturatedFat": 1.5,
"carbohydrates": 1.5,
"protein": 2,
"salt": 2,
"servingSize": {
"amount": 3,
"unitType": 3,
"countUnitDescription": "g"
},
"netQuantity": {
"amount": 12,
"unitType": 1,
"countUnitDescription": "g"
}
},
"beverageInfo": {
"caffeine": 13,
"alcohol": 3
},
"supplementalInfo": {
"instructionsForUse": "Cool before drink.",
"ingredients": [
"Water",
"Sugar"
],
"additives": [
"Artificial Food Coloring",
"Sodium Nitrite",
"Salt",
"Aspartame"
],
"prepackaged": true,
"deposit": 0
},
"packaging": {
"count": 1,
"reusable": true,
"storageInstructions": "Keep cool"
}
},
{
"productType": 1,
"plu": "PR06",
"price": 0,
"name": "bottle deposit",
"posProductId": "POS-000",
"deliveryTax": 0,
"takeawayTax": 0,
"eatInTax": 0
}
],
"categories": [
{
"name": "Drinks",
"posCategoryId": "DRK"
}
]
}{
"accountId": "61c3070aexxxxxdd0306de1",
"locationId": "61c30761xxxxxxd03072af",
"products": [
{
"productType": 1,
"isCombo": true,
"plu": "P-BRGR",
"price": 950,
"name": "Burger Meal (Drink not Included)",
"sortOrder": 0,
"posProductId": "POS-ID-0001",
"posCategoryIds": [
"BURG"
],
"subProducts": [
"BNDL-BRG",
"UPSLL-01"
],
"imageUrl": "https://storage.googleapis.com/ikona-bucket-staging/images/5ff6ee089328c8aefeeabe33/burger-62286be78c506f015be60190.jpeg",
"description": "",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000
},
{
"productType": 4,
"plu": "BNDL-BRG",
"name": "Burger Selection",
"posProductId": "",
"subProducts": [
"P-BURG-CHK",
"P-BURG-CHE",
"P-BURG-VEG"
],
"imageUrl": "",
"description": "",
"min": 1,
"max": 1
},
{
"productType": 3,
"plu": "MG-FRS",
"name": "Size",
"isVariantGroup": true,
"posProductId": "",
"subProducts": [
"P-FRS-S",
"P-FRS-M",
"P-FRS-L"
],
"description": "",
"min": 1,
"max": 1
},
{
"productType": 3,
"plu": "UPSLL-01",
"name": "Add a Drink? (not included)",
"posProductId": "POS-ID-0002",
"min": 0,
"multiMax": 99,
"subProducts": [
"DRNK-01",
"DRNK-02",
"DRNK-03"
]
},
{
"productType": 1,
"plu": "P-FRS-S",
"price": 200,
"name": "Small",
"posProductId": "POS-ID-0002",
"posCategoryIds": [
"FRS"
],
"imageUrl": "",
"description": "",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000
},
{
"productType": 1,
"plu": "P-FRS-M",
"price": 250,
"name": "Medium",
"posProductId": "POS-ID-0003",
"posCategoryIds": [
"FRS"
],
"imageUrl": "",
"description": "",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000
},
{
"productType": 1,
"plu": "P-FRS-L",
"price": 300,
"name": "Large",
"posProductId": "",
"posCategoryIds": [
"FRS"
],
"imageUrl": "",
"description": "",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000
},
{
"productType": 1,
"plu": "P-BURG-CHK",
"price": 0,
"name": "Chicken Burger",
"posProductId": "",
"isVariant": true,
"subProducts": [
"MG-FRS"
],
"posCategoryIds": [
"BURG"
],
"imageUrl": "https://storage.googleapis.com/ikona-bucket-staging/images/5ff6ee089328c8aefeeabe33/chkburger-6228c1dcdb5986001ebf58df.jpeg",
"description": "",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000
},
{
"productType": 1,
"plu": "P-BURG-CHE",
"price": 0,
"name": "Cheeseburger",
"posProductId": "",
"subProducts": [
"MG-FRS"
],
"posCategoryIds": [
"BURG"
],
"imageUrl": "https://storage.googleapis.com/ikona-bucket-staging/images/5ff6ee089328c8aefeeabe33/cheeseburger-62286e26db5986001ebf58d7.jpg",
"description": "",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000
},
{
"productType": 1,
"plu": "P-BURG-VEG",
"price": 0,
"name": "Veggie Burger",
"subProducts": [
"MG-FRS"
],
"posProductId": "",
"posCategoryIds": [
"BURG"
],
"imageUrl": "https://storage.googleapis.com/ikona-bucket-staging/images/5ff6ee089328c8aefeeabe33/veggieburger-62286cbac715b403b0eb7294.jpeg",
"description": "",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000
},
{
"productType": 1,
"plu": "DRNK-01",
"price": 400,
"gtin": [
"8901764012273",
"5310006000009"
],
"name": "Coca Cola",
"posProductId": "POS-ID-0003",
"posCategoryIds": [
"DRK"
],
"imageUrl": "https://storage.googleapis.com/ikona-bucket-staging/images/5ff6ee089328c8aefeeabe33/cocacola-622854a78c506f015be6018a.jpeg",
"description": "",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000
},
{
"productType": 1,
"plu": "DRNK-02",
"price": 400,
"gtin": [
"0049000006346"
],
"name": "Diet Coke",
"posProductId": "POS-ID-0004",
"posCategoryIds": [
"DRK"
],
"imageUrl": "https://storage.googleapis.com/ikona-bucket-staging/images/5ff6ee089328c8aefeeabe33/dietcoke-622854ce8c506f015be6018c.jpeg",
"description": "",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000
},
{
"productType": 1,
"plu": "DRNK-03",
"price": 400,
"gtin": [
"74993001078"
],
"name": "Ginger Beer",
"posProductId": "POS-ID-0005",
"posCategoryIds": [
"DRK"
],
"imageUrl": "https://storage.googleapis.com/ikona-bucket-staging/images/5ff6ee089328c8aefeeabe33/gingerbeer-62285548db5986001ebf58d1.jpg",
"description": "",
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000
}
],
"categories": [
{
"name": "Burgers",
"posCategoryId": "BURG"
},
{
"name": "Drinks",
"posCategoryId": "DRK"
},
{
"name": "Fries",
"posCategoryId": "FRS"
}
]
}
Response examples (200)
{
"products": {
"inserted": 2,
"updated": 0,
"deleted": 1,
"ignored": 0
},
"modifiers": {
"inserted": 2,
"updated": 0,
"deleted": 1,
"ignored": 0
},
"modifierGroups": {
"inserted": 2,
"updated": 0,
"deleted": 1,
"ignored": 0
},
"bundles": {
"inserted": 1,
"updated": 0,
"deleted": 0,
"ignored": 0
},
"priceLevels": 0,
"warnings": 0,
"errors": 0
}
Response examples (403)
Not allowed access to this account.
Response examples (404)
Location 5c****ecc6489f0001****b8 not found