Skip to main content

Subcategories

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

Store_id: 5c5981496bcf7500013afeb0

API Key: rna4etAXd11XRqbMTcNnWca216daxiFE

Getting subcategories of a store.#

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

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

Getting a subcategory by id.#

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

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

Creating a new subcategory.#

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

MethodTypeDescription
storebson.ObjectIdStore id.
imageAvailable(Optional)BoolTrue if image available for subcategory.
servingSizeLevels[]ServingSizePriceModifier price for it’s serving size.
taxes[]bson.ObjectIdTaxes that are applicable for the subcategory.
optionalModifierGroups[]optionalModifierGroupOptional modifier groups.
mandatoryModifierGroups[]mandatoryModifierGroupMandatory modifier groups.
timeApplicableTypeStringTime for which the subcategory is applicable: Always, Days of the week, Days of the month, Date range, Specific date or start date time & end date time will be specified.
overrideFreeNToppingsBoolTrue if price overriding after N toppings
buttonColor(Optional)StringButton color selection for the subcategory.
isConventional(Conversational)BoolTrue if subcategory is conversational.
levelStringCategory level-1: Category, Category level-2: SubCategory.
parentbson.ObjectIdParent category (id) of the subcategory.
nameStringName of the subcategory.
coursebson.ObjectIdCoursing under which the category belongs to.
kitchenPrinters(Optional)[]bson.ObjectIdList of kitchen printers attached to this subcategory.
labelPrinters(Optional)[]bson.ObjectIdList of label printers attached to this subcategory.
restrictPrinters(Optional)[]StringPrinter restrictions for that subcategory.
tareGroupbson.ObjectIdTare group id.
defaultTarebson.ObjectIdDefault tare id.
sslLengthIntSSL length.
firstFreeNToppingsIntFirst free N toppings.
createdAtIntWhich store created the subcategory.
createdForbson.StringStore id for which the subcategory is created.
ownedBybson.StringAccount id related to the Store by whom the subcategory is created.
curl -X POST \
-H "apikey: generated-api-key" \
-H "Content-Type: application/json" \
-d '{{"store":"5c5981496bcf7500013afeb0",
"imageAvailable":false,
"servingSizeLevels":["5c5981496bcf7500013afedc","5c5981496bcf7500013afedf","5c5981496bcf7500013afede","5c5981496bcf7500013afedd"],
"taxes":["5c5981496bcf7500013afee4","5e18e327b5e75d0001be14da"],
"optionalModifierGroups":[],
"mandatoryModifierGroups":[],
"timeApplicableType":"Always",
"overrideFreeNToppings":false,
"buttonColor":"#E67E22",
"isConventional":true,
"level":2,
"parent":"5df899788e742c00014a839e",
"name":"Hamburger_Subs",
"course":"5e0f058cd7dac90001760147",
"kitchenPrinters":["5dcba98a25bb6b0001dc3257","5dfa27586c38720001829f23"],
"labelPrinters":[],
"restrictPrinters":[],
"tareGroup":"",
"defaultTare":"",
"sslLength":4,
"firstFreeNToppings":0,
"createdAt":2,
"createdFor":"5c5981496bcf7500013afeb0",
"ownedBy":"5c5981496bcf7500013afeb2"}' \
"https://api.lingaros.com/v1/lingapos/category" \

Updating a subcategory.#

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

MethodTypeDescription
activeStatusBoolSubcategory activity status.
buttonColorStringSubcategory button color.
coursebson.ObjectIdCourse id, to which the category belongs.
defaultTarebson.ObjectIdTare group id.
departmentbson.ObjectIdDepartment to which the subcategory belongs.
firstFreeNToppingsIntFirst free N toppings.
hideInPOSBoolDenotes if subcategory is hidden or not in POS.
hideMenuItemInKioskBoolDenotes if subcategory is hidden or not in kiosk.
hideInZenpepperBoolDenotes if subcategory is hidden or not in Zenpepper.
id[]bson.ObjectIdCategory id.
imageAvailableBoolTrue if an image is available for the subcategory.
imageExtensionStringImage extension type.
imageUrlStringURL of the image.
imageVersionInt64Subcategory image version.
isConventionalBoolTrue if the category is conventional.
kitchenPrinters(Optional)[]bson.ObjectIdList of printers attached to this subcategory.
labelPrinters(Optional)[]bson.ObjectIdList of label printers attached to this subcategory.
levelStringCategory level-1: Category, Category level-2: SubCategory.
mandatoryModifierGroups[]MandatoryModifierGroupMandatory modifier groups.
menuItemSortStringSorting criteria.
nameStringName of the subcategory.
optionalModifierGroups[]OptionalModifierGroupOptional modifier groups.
originalIDbson.ObjectIdSubcategory original id.
restrictPrinters(Optional)[]StringPrinter restrictions for that subcategory.
roles[]RoleEmployee roles.
servingSizeLevels[]ServingSizePriceModifier price for it’s serving size.
subCategorySortStringSubcategory sorting criteria.
tareGroup[]bson.ObjectIdSubcategory name.
taxes[]bson.ObjectIdTaxes that are applicable for the subcategory.
timeApplicableTypeStringTime for which the subcategory is applicable: Always, Days of the week, Days of the month, Date range, Specific date or start date time & end date time will be specified.
sslLengthIntSSL length.
startTimeTimeIf a restriction in time is set, when the subcategory restriction starts.
endTimeTimeIf a restriction in time is set, when the subcategory restriction ends.
store[]bson.ObjectIdUnique store id.
createdAtIntWhich store created the subcategories.
createdForbson.StringStore id for which the subcategories is created.
ownedBybson.StringAccount id related to the Store by whom the subcategories is created.
curl -X PUT \
-H "apikey: generated-api-key" \
-H "Content-Type: application/json" \
-d '{
"activeStatus":true,
"buttonColor":"#E67E22",
"course":"5e0f058cd7dac90001760147",
"defaultTare":"",
"firstFreeNToppings":0,
"hideInPos":false,
"hideInZenPepper":false,
"hideMenuItemInKiosk":false,
"id":"5e1c6e1738a6330001e6be0f",
"imageAvailable":false,
"imageExtension":"",
"imageUrl":"/category/5e1c6e1738a6330001e6be0f/image",
"imageVersion":0,
"isConventional":false,
"itemServiceCharge":"",
"kitchenPrinters":["5dcba98a25bb6b0001dc3257","5dfa27586c38720001829f23"],
"labelPrinters":[],
"level":2,
"mandatoryModifierGroups":[],
"menuItemSort":"A-Z",
"name":"Hamburger_Subs",
"optionalModifierGroups":[],
"originalID":"5e1c6e1738a6330001e6be0f",
"overrideFreeNToppings":false,
"parent":"5df899788e742c00014a839e",
"restrictPrinters":[],
"roles":null,
"servingSizeLevels":["5c5981496bcf7500013afedc","5c5981496bcf7500013afedf","5c5981496bcf7500013afede","5c5981496bcf7500013afedd"],
"tareGroup":"",
"taxes":["5c5981496bcf7500013afee4","5e18e327b5e75d0001be14da"],
"timeApplicableType":"Always",
"sslLength":4,
"startTime":"",
"endTime":"",
"store":"5c5981496bcf7500013afeb0",
"createdAt":2,
"createdFor":"5c5981496bcf7500013afeb0",
"ownedBy":"5c5981496bcf7500013afeb2"}' \
"https://api.lingaros.com/v1/lingapos/category/{category-id}" \

Inactivating a subcategory.#

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

MethodTypeDescription
entityStringName of the entity.
idStringCategory id.
curl -X PUT \
-H "apikey: generated-api-key" \
-H "Content-Type: application/json" \
-d '{"entity":"category",
"id":"5dfce192fe7e0f00018c864a"}' \
"https://api.lingaros.com/v1/lingapos/category/{category-id}/inactivate" \

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"

Getting tares by store.#

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

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

Getting active categories by store.#

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

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

Getting active courses by store.#

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

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

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 label printers by store.#

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

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

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 active item service charges by store.#

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

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