Skip to main content

Modifier Groups

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

Store_id: 5c5981496bcf7500013afeb0

API Key: rna4etAXd11XRqbMTcNnWca216daxiFE

Getting the modifier groups of a store.#

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

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

Getting a modifier group by id.#

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

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

Creating a new modifier group.#

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

MethodTypeDescription
modifiers[]bson.ObjectIdIds of the modifiers in the modifier group.
pizzaToppingBoolDenotes if modifier group is a pizza topping.
servingSizeLevels[]ServingSizePriceServing size levels available for the modifier group.
setPriceHereBoolCan Modifier price can be overridden.
alignTypeStringDefines how the modifiers in the group will be sorted. (A-Z, Z-A, Custom sort)
priorityIntPriority of the group.
nameStringName of the modifier group.
createdAtIntWhich store created the modifier group.
createdForbson.StringStore id for which the modifier group is created.
ownedBybson.StringAccount id related to the Store by whom the modifier group is created.
storebson.StringStore id.
curl -X POST \
-H "apikey: generated-api-key" \
-H "Content-Type: application/json" \
-d '{"modifiers: ["5c5981496bcf7500013afee9", "5c5981496bcf7500013afeea", "5c5981496bcf7500013afee6"]
pizzaTopping: true
servingSizeLevels: []
setPriceHere: false
alignType: "A-Z"
priority: 1
name: "PIZZA_TEST"
createdAt: 2
createdFor: "5c5981496bcf7500013afeb0"
ownedBy: "5c5981496bcf7500013afeb2"
modifiersAlignment: {}
store: "5c5981496bcf7500013afeb0"}' \
"https://api.lingaros.com/v1/lingapos/modifierGroup" \

Updating a new modifier group.#

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

MethodTypeDescription
activeStatusBoolStatus of the modifier group.
alignTypeStringDefines how the modifiers in the group will be sorted. (A-Z, Z-A, Custom sort)
idbson.StringModifiers group id.
imageAvailableBoolDenotes if an image is available for the modifier group.
imageExtensionStringImage extension.
imageUrlStringImage URL.
imageVersionIntModifier group image version.
modifiers[]bson.StringIds of the modifiers in the group.
nameStringName of the modifier group.
pizzaToppingBoolDenotes if modifier is a pizza topping.
priorityIntPriority of the modifier group.
servingSizeLevels[]ServingSizePriceDenotes if modifier is a pizza topping.
setPriceHereBoolCan Modifier price can be overridden.
createdAtIntWhich store created the modifier group.
createdForbson.StringStore id for which the modifier group is created.
ownedBybson.StringAccount id related to the Store by whom the modifier group is created.
curl -X PUT \
-H "apikey: generated-api-key" \
-H "Content-Type: application/json" \
-d '{"activeStatus: true
alignType: "Z-A"
id: "5e1367b36581de00016f06da"
imageAvailable: false
imageExtension: ""
imageUrl: "/modifierGroup/5e1367b36581de00016f06da/image"
imageVersion: 1
meitoModifierGroup: false
meitoType: ""
modifiers: ["5c5981496bcf7500013afee8", "5c5981496bcf7500013afee5"]
modifiersAlignment: {}
name: "Test_MG1"
pizzaTopping: true
priority: 1
servingSizeLevels: []
setPriceHere: false
createdAt: 2
createdFor: "5c5981496bcf7500013afeb0"
ownedBy: "5c5981496bcf7500013afeb2""}' \
"https://api.lingaros.com/v1/lingapos/modifierGroup/{modifier-group-id}" \

Getting active modifiers of a store.#

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

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

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"