Skip to main content

Categories

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

Store_id: 5c5981496bcf7500013afeb0

API Key: rna4etAXd11XRqbMTcNnWca216daxiFE

Getting categories of a store.#

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

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

Creating a new category.#

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

MethodTypeDescription
storebson.ObjectIdStore id.
imageAvailable(Optional)BoolTrue if image available for category.
servingSizeLevels[]ServingSizePriceModifier price for it’s serving size.
taxes[]bson.ObjectIdTaxes that are applicable for that category.
optionalModifierGroups[]optionalModifierGroupOptional modifier groups.
mandatoryModifierGroups[]mandatoryModifierGroupMandatory modifier groups.
timeApplicableTypeStringTime for which the category 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 category.
isConventional(Conversational)BoolTrue if category is conversational.
levelStringCategory level-1: Category, Category level-2: SubCategory.
restrictPrinters(Optional)[]StringPrinter restrictions for that category.
kitchenPrinters(Optional)[]bson.ObjectIdList of kitchen printers attached to this category.
labelPrinters(Optional)[]bson.ObjectIdList of label printers attached to this category.
nameStringName of the category.
departmentbson.ObjectIdDepartment under which the category belongs to.
coursebson.ObjectIdCoursing under which the category belongs to..
sslLengthIntSSL length.
hideInZenpepperBoolDenotes if category is hidden or not in Zenpepper.
hideInPosBoolDenotes if category is hidden or not in POS.
hideMenuItemInZenpepperBoolDenotes if menu item is hidden or not in Zenpepper.
createdAtIntWhich store created the categories.
createdForbson.StringStore id for which the category is categories.
ownedBybson.StringAccount id related to the Store by whom the categories is created.
curl -X POST \
-H "apikey: generated-api-key" \
-H "Content-Type: application/json" \
-d '{"store":"5c5981496bcf7500013afeb0",
"imageAvailable":false,
"servingSizeLevels":["5c5981496bcf7500013afedf","5c5981496bcf7500013afede","5c5981496bcf7500013afedd"],
"taxes":["5c5981496bcf7500013afee4"],
"optionalModifierGroups":[],
"mandatoryModifierGroups":[],
"timeApplicableType":"Always",
"overrideFreeNToppings":false,
"buttonColor":"#000",
"isConventional":true,
"level":1,
"restrictPrinters":["ToGo"],
"kitchenPrinters":["5dcba98a25bb6b0001dc3257","5dfa27586c38720001829f23"],
"labelPrinters":[],
"name":"Fishes",
"department":"5c5981496bcf7500013afed6",
"course":"5c5981496bcf7500013afed4",
"sslLength":3,
"hideInZenPepper":true,
"hideInPos":true,
"hideMenuItemInKiosk":true,
"createdAt":2,
"createdFor":"5c5981496bcf7500013afeb0",
"ownedBy":"5c5981496bcf7500013afeb2"}' \
"https://api.lingaros.com/v1/lingapos/category" \

Updating a category.#

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

MethodTypeDescription
activeStatusBoolCategory activity status.
buttonColorStringCategory button color.
coursebson.ObjectIdCourse id, under which the category belongs to.
defaultTarebson.ObjectIdTare group id.
departmentbson.ObjectIdDepartment which the category belongs to.
firstFreeNToppingsIntFirst free N toppings.
hideInPOSBoolDenotes if category is hidden or not in POS.
hideMenuItemInKioskBoolDenotes if category is hidden or not in kiosk.
hideMenuItemInZenpepperBoolDenotes if category is hidden or not in Zenpepper.
id[]bson.ObjectIdCategory id.
imageAvailableBoolTrue if an image is available for the category.
imageExtensionStringImage extension type.
imageUrlStringURL of the image.
imageVersionInt64Category image version.
includedModifiers[]IncludedModifiersIncluded modifier groups.
isConventionalBoolTrue if the category is conversational.
kitchenPrinters(Optional)[]bson.ObjectIdList of printers attached to this category.
labelPrinters(Optional)[]bson.ObjectIdList of label printers attached to this category.
levelStringCategory level-1: Category, Category level-2: SubCategory.
mandatoryModifierGroups[]MandatoryModifierGroupMandatory modifier groups.
menuItemSortStringSorting criteria.
nameStringCategory name.
optionalModifierGroups[]OptionalModifierGroupOptional modifier groups.
originalIDbson.ObjectIdCategory original id.
restrictPrinters(Optional)[]StringPrinter restrictions for that category.
roles[]RoleEmployee roles.
servingSizeLevels[]ServingSizePriceModifier price for it’s serving size.
subCategorySortStringSub category sorting criteria.
tareGroup[]bson.ObjectIdTare group id.
taxes[]bson.ObjectIdTaxes that are applicable for that category.
timeApplicableTypeStringTime for which the category 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 category restriction starts.
endTimeTimeIf a restriction in time is set, when the category restriction ends.
store[]bson.ObjectIdUnique store id.
createdAtIntWhich store created the category.
createdForbson.StringStore id for which the category is created.
ownedBybson.StringAccount id related to the Store by whom the category is created.
curl -X PUT \
-H "apikey: generated-api-key" \
-H "Content-Type: application/json" \
-d '{activeStatus: true
buttonColor: "#000"
course: "5c5981496bcf7500013afed4"
defaultTare: ""
department: "5c5981496bcf7500013afed6"
firstFreeNToppings: 0
hideInPos: true
hideInZenPepper: true
hideMenuItemInKiosk: true
id: "5dfce192fe7e0f00018c864a"
imageAvailable: false
imageExtension: ""
imageUrl: "/category/5dfce192fe7e0f00018c864a/image"
imageVersion: 0
isConventional: true
itemServiceCharge: ""
kitchenPrinters: ["5dcba98a25bb6b0001dc3257", "5dfa27586c38720001829f23"]
labelPrinters: []
level: 1
mandatoryModifierGroups: []
menuItemSort: "A-Z"
name: "FISHES"
optionalModifierGroups: []
originalID: "5dfce192fe7e0f00018c864a"
restrictPrinters: ["ToGo"]
roles: null
servingSizeLevels: ["5c5981496bcf7500013afedf", "5c5981496bcf7500013afede", "5c5981496bcf7500013afedd"]
subCategorySort: "A-Z"
tareGroup: ""
taxes: ["5c5981496bcf7500013afee4"]
timeApplicableType: "Always"
sslLength: 3
startTime: ""
endTime: ""
store: "5c5981496bcf7500013afeb0"
createdAt: 2
createdFor: "5c5981496bcf7500013afeb0"
ownedBy: "5c5981496bcf7500013afeb2"}' \
"https://api.lingaros.com/v1/lingapos/category" \

Inactivating a category.#

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

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

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

Getting active departments by store.#

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

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

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 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 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"