Skip to main content

Modifiers

API Key and Store id that can be used in staging environment.#

Store_id: 5c5981496bcf7500013afeb0

API Key: rna4etAXd11XRqbMTcNnWca216daxiFE

Getting the modifiers of a store.#

URL:https://api.lingaros.com/v1/lingapos/store/{store-id}/modifiers

curl -X GET -H "apikey: generated-api-key" \
"https://api.lingaros.com/v1/lingapos/store/{store-id}/modifiers"
queryParms
?page=1 => [paging no]
?search= => [null]
?status=true => [active modifiers list]
?status=false => [inactive modifiers list]

Getting a modifier.#

URL:https://api.lingaros.com/v1/lingapos/modifier/{modifier-id}

curl -X GET -H "apikey: generated-api-key" \
"https://api.lingaros.com/v1/lingapos/modifier/{modifier-id}"

Creating a new modifier.#

URL:http://api.lingaros.com/v1/lingapos/modifier

MethodTypeDescription
modifyWithbson.ObjectIdModifier group id.
taxes[]bson.ObjectIdTaxes that are applicable for the modifier.
servingSizeLevels[]ServingSizePriceModifier price for it’s serving size.
prefixes[]ModifierPrefixModifier Prefixes.
maxNoOfTimes[]mandatoryModifierGroupHow many times a modifier is applicable over an item.
setPriceHereBoolModifier price can be overridden.
overrideFreeNToppingsBoolTrue if price overriding after N toppings
buttonColor(Optional)StringButton color selection for the modifier.
includeDefaultTaxesBoolTrue if default taxes are included.
nameStringName of the modifier.
kitchenPrinters(Optional)[]bson.ObjectIdList of kitchen printers attached to this category.
store[]bson.ObjectIdStore id.
printMenuInModPrintBoolDenotes if modifier will seem in modifier print.
printModInMenuPrintBoolDenotes if modifier will seem in menu print.
nameStringName of the category.
createdAtIntWhich store created the modifier.
createdForbson.StringStore id for which the modifier is created.
ownedBybson.StringAccount id related to the Store by whom the modifier is created.
curl -X POST \
-H "apikey: generated-api-key" \
-H "Content-Type: application/json" \
-d '{"alternate": []
"modifyWith": null
"taxes": ["5c5981496bcf7500013afee4"]
"servingSizeLevels": []
"prefixes": []
"maxNoOfTimes": 1
"setPriceHere": false
"buttonColor": "#E67E22"
"includeDefaultTaxes": true
"printMenuInModPrint": true
"printModInMenuPrint": true
"name": "CHEESE"
"kitchenPrinters": ["5dfa27586c38720001829f23"]
"store": "5c5981496bcf7500013afeb0"
"createdAt": 2
"createdFor": "5c5981496bcf7500013afeb0"
"ownedBy": "5c5981496bcf7500013afeb2"}' \
"https://api.lingaros.com/v1/lingapos/modifier" \

Updating a modifier.#

URL:http://api.lingaros.com/v1/lingapos/modifier/{modifier-id}

MethodTypeDescription
activeStatusBoolModifier activity status.
buttonColor(Optional)StringButton color selection for the modifier.
idbson.ObjectIdUnique modifier ID.
imageAvailableBoolDenotes if an image is available for the modifiers group.
imageExtensionStringImage extension.
imageUrlStringImage URL.
imageVersionIntModifier group image version.
kitchenPrinters(Optional)[]bson.ObjectIdList of kitchen printers attached to this category.
maxNoOfTimes[]mandatoryModifierGroupHow many times a modifier is applicable over an item.
modifyWith[]bson.ObjectIdModifier group ID.
nameStringName of the modifier.
originalIDbson.ObjectIdOriginal modifier ID.
pluCodeStringPlu code for that menuItem.
prefixes[]ModifierPrefixModifier Prefixes.
printMenuInModPrintBoolDenotes if modifier will seem in modifier print.
printModInMenuPrintBoolDenotes if modifier will seem in menu print.
servingSizeLevels[]ServingSizePriceModifier price for it’s serving size.
setPriceHereBoolModifier price can be overridden.
showModifierBoolShow modifier in the printer template.
taxes[]bson.ObjectIdTaxes applicable for the modifier.
store[]bson.ObjectIdStore id.
createdAtIntWhich store created the modifier.
createdForbson.StringStore id for which the modifier is created.
ownedBybson.StringAccount id related to the Store by whom the modifier is created.
curl -X PUT \
-H "apikey: generated-api-key" \
-H "Content-Type: application/json" \
-d '{"activeStatus":true,
"buttonColor":"#2980B9",
"id":"5e1366da6581de00016f06d7",
"imageAvailable":false,
"imageExtension":"",
"imageUrl":"/modifier/5e1366da6581de00016f06d7/image",
"imageVersion":1,
"kitchenPrinters":["5e1366c76581de00016f06d5"],
"maxNoOfTimes":1,
"modifyWith":"5c5981496bcf7500013afeeb",
"name":"Test_Modifier",
"originalID":"5e1366da6581de00016f06d7",
"pluCode":"",
"prefixes":[],
"printMenuInModPrint":true,
"printModInMenuPrint":true,
"servingSizeLevels":[],
"setPriceHere":true,
"showModifier":false,
"taxes":["5c5981496bcf7500013afee4"],
"store":"5c5981496bcf7500013afeb0",
"createdAt":2,
"createdFor":"5c5981496bcf7500013afeb0",
"ownedBy":"5c5981496bcf7500013afeb2"}' \
"https://api.lingaros.com/v1/lingapos/modifier/{modifier-id}" \

Getting default printers.#

URL:https://api.lingaros.com/v1/lingapos/defaultPrinters

curl -X GET -H "apikey: generated-api-key" \
"https://api.lingaros.com/v1/lingapos/defaultPrinters"
queryParms
?printerType=KitchenPrinter => [Printer type]

Getting active serving size levels by store.#

URL:https://api.lingaros.com/v1/lingapos/store/{store-id}/activeServingSizeLevels

curl -X GET -H "apikey: generated-api-key" \
"https://api.lingaros.com/v1/lingapos/store/{store-id}/activeServingSizeLevels"

Getting active modifier groups by store.#

URL:https://api.lingaros.com/v1/lingapos/store/{store-id}/activeModifierGroups

curl -X GET -H "apikey: generated-api-key" \
"https://api.lingaros.com/v1/lingapos/store/{store-id}/activeModifierGroups"

Getting active taxes applied to items, by store.#

URL:https://api.lingaros.com/v1/lingapos/store/{store-id}/activeTaxes

curl -X GET -H "apikey: generated-api-key" \
"https://api.lingaros.com/v1/lingapos/store/{store-id}/activeTaxes"
queryParms
?ApplyTo=Item => [Denotes taxes applied to which unit]

Getting kitchen printers by store.#

URL:https://api.lingaros.com/v1/lingapos/store/{store-id}/kitchenPrinters

curl -X GET -H "apikey: generated-api-key" \
"https://api.lingaros.com/v1/lingapos/store/{store-id}/kitchenPrinters"

Getting service types by store.#

URL:https://api.lingaros.com/v1/lingapos/store/{store-id}/getServiceTypesByStore

curl -X GET -H "apikey: generated-api-key" \
"https://api.lingaros.com/v1/lingapos/store/{store-id}/getServiceTypesByStore"