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

Method	Type	Description
store	bson.ObjectId	Store id.
imageAvailable(Optional)	Bool	True if image available for subcategory.
servingSizeLevels	[]ServingSizePrice	Modifier price for it’s serving size.
taxes	[]bson.ObjectId	Taxes that are applicable for the subcategory.
optionalModifierGroups	[]optionalModifierGroup	Optional modifier groups.
mandatoryModifierGroups	[]mandatoryModifierGroup	Mandatory modifier groups.
timeApplicableType	String	Time 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.
overrideFreeNToppings	Bool	True if price overriding after N toppings
buttonColor(Optional)	String	Button color selection for the subcategory.
isConventional(Conversational)	Bool	True if subcategory is conversational.
level	String	Category level-1: Category, Category level-2: SubCategory.
parent	bson.ObjectId	Parent category (id) of the subcategory.
name	String	Name of the subcategory.
course	bson.ObjectId	Coursing under which the category belongs to.
kitchenPrinters(Optional)	[]bson.ObjectId	List of kitchen printers attached to this subcategory.
labelPrinters(Optional)	[]bson.ObjectId	List of label printers attached to this subcategory.
restrictPrinters(Optional)	[]String	Printer restrictions for that subcategory.
tareGroup	bson.ObjectId	Tare group id.
defaultTare	bson.ObjectId	Default tare id.
sslLength	Int	SSL length.
firstFreeNToppings	Int	First free N toppings.
createdAt	Int	Which store created the subcategory.
createdFor	bson.String	Store id for which the subcategory is created.
ownedBy	bson.String	Account 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}

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

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