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

Method	Type	Description
store	bson.ObjectId	Store id.
imageAvailable(Optional)	Bool	True if image available for category.
servingSizeLevels	[]ServingSizePrice	Modifier price for it’s serving size.
taxes	[]bson.ObjectId	Taxes that are applicable for that category.
optionalModifierGroups	[]optionalModifierGroup	Optional modifier groups.
mandatoryModifierGroups	[]mandatoryModifierGroup	Mandatory modifier groups.
timeApplicableType	String	Time 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.
overrideFreeNToppings	Bool	True if price overriding after N toppings
buttonColor(Optional)	String	Button color selection for the category.
isConventional(Conversational)	Bool	True if category is conversational.
level	String	Category level-1: Category, Category level-2: SubCategory.
restrictPrinters(Optional)	[]String	Printer restrictions for that category.
kitchenPrinters(Optional)	[]bson.ObjectId	List of kitchen printers attached to this category.
labelPrinters(Optional)	[]bson.ObjectId	List of label printers attached to this category.
name	String	Name of the category.
department	bson.ObjectId	Department under which the category belongs to.
course	bson.ObjectId	Coursing under which the category belongs to..
sslLength	Int	SSL length.
hideInZenpepper	Bool	Denotes if category is hidden or not in Zenpepper.
hideInPos	Bool	Denotes if category is hidden or not in POS.
hideMenuItemInZenpepper	Bool	Denotes if menu item is hidden or not in Zenpepper.
createdAt	Int	Which store created the categories.
createdFor	bson.String	Store id for which the category is categories.
ownedBy	bson.String	Account 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}

Method	Type	Description
activeStatus	Bool	Category activity status.
buttonColor	String	Category button color.
course	bson.ObjectId	Course id, under which the category belongs to.
defaultTare	bson.ObjectId	Tare group id.
department	bson.ObjectId	Department which the category belongs to.
firstFreeNToppings	Int	First free N toppings.
hideInPOS	Bool	Denotes if category is hidden or not in POS.
hideMenuItemInKiosk	Bool	Denotes if category is hidden or not in kiosk.
hideMenuItemInZenpepper	Bool	Denotes if category is hidden or not in Zenpepper.
id	[]bson.ObjectId	Category id.
imageAvailable	Bool	True if an image is available for the category.
imageExtension	String	Image extension type.
imageUrl	String	URL of the image.
imageVersion	Int64	Category image version.
includedModifiers	[]IncludedModifiers	Included modifier groups.
isConventional	Bool	True if the category is conversational.
kitchenPrinters(Optional)	[]bson.ObjectId	List of printers attached to this category.
labelPrinters(Optional)	[]bson.ObjectId	List of label printers attached to this category.
level	String	Category level-1: Category, Category level-2: SubCategory.
mandatoryModifierGroups	[]MandatoryModifierGroup	Mandatory modifier groups.
menuItemSort	String	Sorting criteria.
name	String	Category name.
optionalModifierGroups	[]OptionalModifierGroup	Optional modifier groups.
originalID	bson.ObjectId	Category original id.
restrictPrinters(Optional)	[]String	Printer restrictions for that category.
roles	[]Role	Employee roles.
servingSizeLevels	[]ServingSizePrice	Modifier price for it’s serving size.
subCategorySort	String	Sub category sorting criteria.
tareGroup	[]bson.ObjectId	Tare group id.
taxes	[]bson.ObjectId	Taxes that are applicable for that category.
timeApplicableType	String	Time 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.
sslLength	Int	SSL length.
startTime	Time	If a restriction in time is set, when the category restriction starts.
endTime	Time	If a restriction in time is set, when the category restriction ends.
store	[]bson.ObjectId	Unique store id.
createdAt	Int	Which store created the category.
createdFor	bson.String	Store id for which the category is created.
ownedBy	bson.String	Account 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

Method	Type	Description
entity	String	Name of the entity.
id	String	Category 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"