Discounts
API Key and Store id that can be used in staging environment.
Store_id: 5c5981496bcf7500013afeb0
API Key: rna4etAXd11XRqbMTcNnWca216daxiFE
Creating an item based discount.
| Method | Type | Description |
|---|---|---|
| store{id:} | bson.ObjectId | Unique store id. |
| level | String | Level for which the discount will be applied(1:Category, 2:Subcategory, 3:MenuItem). |
| offerIn | String | Discount offer type (amount, percentage, set price, free item). |
| discountCouponType(Optional) | String | Discount coupon type (Promo, Comp, Donation). |
| category | String | Category for which the discount is applied. |
| subCategory | String | Subcategory for which the discount is applied. |
| menuItem | String | Menu item for which the discount is applied. |
| servingSizes | []ServingSizes | Serving sizes for which the discount can be applied. |
| freeItems(Optional) | []freeItems | Free items that discount offers in. |
| isForAllSSL | Bool | True if the discount is applied for all serving sizes in category. If false, then serving size(s) must be selected |
| combineWithOtherDiscounts(Optional) | Bool | True if combined with other discounts. |
| includeAdditionalModifiers(Optional) | Bool | True if additional modifiers are included. |
| isRestrictToTime(Optional) | Bool | True if there is a restriction time setting. |
| offers | []bson.ObjectId | Offers (for check based discount). |
| isRestrictToDays(Optional) | Bool | True if the discount is restricted for some day. |
| daysOfWeek(Optional) | []DaysOfWeek | Which day(s) of the week the discount is restricted. |
| daysOfMonth(Optional) | []DaysOfMonth | Which day(s) of the month the discount is restricted. |
| isRestrictToMonths(Optional) | Bool | True if the discount is restricted for a month. |
| months(Optional) | String | Restriction month(s). |
| applyToDiscountedPrice | Bool | True if the discount is applied to discounted price. |
| excludeCategories(Optional) | String | Excluded categories for which the discount will not be applied. (Check based discounts) |
| excludeMenuItems(Optional) | String | Excluded menu items for which the discount will not be applied. (Check based discounts) |
| isFree(Optional) | Bool | True if an item is offered for free as a discount. |
| timeApplicableType | String | Time for which the discount 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. |
| buttonColor | String | Button color selection for the discount. |
| couponOnly(Optional) | Bool | True if coupon only option is selected. |
| menuItems | []MenuItems | Menu item ids for which the discount will be applied. |
| categories | []Categories | Category ids for which the discount will be applied. |
| subCategories | []SubCategories | Sub category ids for which the discount will be applied. |
| autoDiscount(Optional) | Bool | True if auto discount option is selected. |
| setPrice | Bool | True if set price option is selected.(One of the following options have to be selected for 'mix and match' type of discount:Price, percentage or set price for each item). |
| setPercentage | Bool | True if set percentage option is selected.((One of the following options have to be set for 'mix and match' type of discount:Price, percentage or set price for each item). |
| isSetEachItemPrice | Bool | True if set each item price option is selected.((One of the following options have to be set for 'mix and match' type of discount:Price, percentage or set price for each item). |
| leastExpensive | Bool | True if (discount for) least expensive item option is selected((One of the following options have to be set for 'mix and match' type of discount:Least expensive, most expensive). |
| mostExpensive | Bool | True if (discount for) most expensive item option is selected((One of the following options have to be set for 'mix and match' type of discount:Least expensive, most expensive. |
| name | String | Name of the discount. |
| discountCode | String | Code of the discount. |
| minQuantity | String | Minimum quantity of items set for the discount can be applied. |
| offerStr | String | Amount offered by the discount. |
| offPerErr | String | |
| adjustAmount | String | Sets if the discount will be applied before or after the taxes. |
| priority | Int | Priority of the discount. |
| roles(Optional) | String | Role id by whom the discount will be applied. |
| discountType | String | Type of the discount. |
| createdAt | Int | Where the discount is created. |
| createdFor | bson.ObjectId | Store id for which the discount is created. |
| ownedBy | bson.ObjectId | Account id related to the Store by whom the discount is created. |
| createdFor | bson.ObjectId | Store id for which the discount is created. |
| discountCode | String | Discount code. |
| memberShipPlan | bson.ObjectID | Id of membership plan |
Free Items(Optional) [freeItems]
| Method | Type | Description |
|---|---|---|
| menuItem | String | Menu item id. |
| itemName | String | Item name. |
| servingSize | []servingSizes | Serving size id. |
| sizeName | String | Serving size name. |
| quantity | Int | Category for which the discount is applied. |
| offerIn | String | Discount offer type (amount, percentage, set price, free item). |
| offer | String | Discount amount of the offer. |
| displayOffer | String | Discount amount of the offer displayed with currency. |
curl -X POST \
-H "apikey: generated-api-key" \
-H "Content-Type: application/json" \
-d '{
"store":{"id":"5c5981496bcf7500013afeb0"},
"level":1,
"offerIn":"percentage",
"discountCouponType":"Promo",
"category":"",
"subCategory":"",
"menuItem":"",
"servingSizes":["5c5981496bcf7500013afedc",
"5c5981496bcf7500013afedd",
"5c5981496bcf7500013afede",
"5c5981496bcf7500013afedf",
"5c5981496bcf7500013afee0",
"5c5981496bcf7500013afee1",
"5c5981496bcf7500013afee2",
"5c5981496bcf7500013afee3",
"5c5981496bcf7500013afedc"],
"freeItems":[],
"isForAllSSL":true,
"combineWithOtherDiscounts":true,
"includeAdditionalModifiers":false,
"isRestrictToTime":false,
"offers":[],
"isRestrictToDays":false,
"daysOfWeek":[],
"daysOfMonth":[],
"isRestrictToMonths":false,
"months":[],
"applyToDiscountedPrice":true,
"excludeCategories":[],
"excludeMenuItems":[],
"isFree":false,
"timeApplicableType":"Always",
"buttonColor":"#2980B9",
"couponOnly":false,
"menuItems":[],
"categories":["5c5981496bcf7500013afeed"],
"subCategories":[],
"autoDiscount":false,
"setPrice":true,
"setPercentage":false,
"isSetEachItemPrice":false,
"leastExpensive":false,
"mostExpensive":false,
"name":"NewItemBasedDiscount",
"minQuantity":5,
"offerStr":"12.00",
"offPerErr":1,
"adjustAmount":"After Tax",
"priority":0,
"discountType":"Item Based",
"createdAt":2,
"createdFor":"5c5981496bcf7500013afeb0",
"ownedBy":"5c5981496bcf7500013afeb2",
"discountCode":""}' \
"https://api.lingaros.com/v1/lingapos/discount" \
Updating an item based discount.
URL:http://api.lingaros.com/v1/lingapos/discount/{discount_id}
| Method | Type | Description |
|---|---|---|
| activeStatus | Bool | True if the discount is active. |
| adjustAmount | String | Sets if discount will be applied before or after update. |
| applicableTo | String | Discount is applicable for an Item, a Check or as a Combo. |
| applyToDiscountedPrice | Bool | True if the discount will be applied to discounted price. |
| autoDiscount | Bool | True if the discount is applied automatically. |
| buttonColor | String | Color of the discount button. |
| combineWithOtherDiscounts(Optional) | Bool | True if combined with other discounts. |
| categories | String | Category id. |
| couponOnly | Bool | True if coupon-only discount. |
| discountCode | String | Discount code. |
| discountCouponType | String | Discount coupon type. |
| discountType | String | Discount type (Item based, Check based, Open Item, Open Check...) |
| displayOffer | String | Display offer. |
| freeItems(Optional) | []MenuItems | List of free items offered with the discount. |
| id | bson.ObjectId | Discount id. |
| isCustomerAttach | Bool | True if a customer is attached to discount. |
| isForAllSSL | Bool | True if the discount is applied for all serving sizes in category. |
| isRestrictToTime(Optional) | Bool | True if the discount is restricted in time. |
| level | Int | Level for which the discount will be applied in the product/item hierarchy(1:Category, 2:Subcategory, 3:MenuItem). |
| menuItems | []MenuItems | Menu item ids for which the discount will be applied. |
| minQuantity | Int | Minimum quantity of items for the discount to be applied. |
| name | String | Name of the discount. |
| offer | Int | Amount of the offer. |
| offerIn | String | Discount offer type (amount, percentage, set price, free item). |
| offerStr | String | Amount of the offer in String. |
| originalID | String | Discount original id. |
| priority | Int | Priority of the discount. |
| roles(Optional) | []Roles | Role ids by which the discount will be applied. |
| servingSizes | []ServingSizes | Serving sizes for which the discount can be applicable. |
| setPrice | Bool | True if set price option is selected. |
| timeApplicableType | String | The time (period) for which the discount 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. |
| role | []Roles | Role id. |
| startTime | Time | If a restriction in time is set, when the discount restriction starts. |
| endTime | Time | If a restriction in time is set, when the discount restriction ends. |
| createdAt | Int | Where the discount is created. |
| createdFor | bson.ObjectId | Store id for which the discount is created. |
| ownedBy | bson.ObjectId | Account id related to the Store by whom the discount is created. |
Free Items(Optional) [freeItems]
| Method | Type | Description |
|---|---|---|
| menuItem | String | Menu item id. |
| itemName | String | Item name. |
| servingSize | []servingSizes | Serving size id. |
| sizeName | String | Serving size name. |
| quantity | Int | Category for which the discount is applied. |
| offerIn | String | Discount offer type (amount, percentage, set price, free item). |
| offer | String | Discount amount of the offer. |
| displayOffer | String | Discount amount of the offer displayed with currency. |
curl -X PUT \
-H "apikey: generated-api-key" \
-H "Content-Type: application/json" \
-d '{
"activeStatus":true,
"adjustAmount":"Before Tax",
"applicableTo":"",
"applyToDiscountedPrice":true,
"autoDiscount":false,
"buttonColor":"#2980B9",
"combineWithOtherDiscounts":true,
"categories":["5dd3d7ee0493b900013a160b"],
"couponOnly":false,
"discountCode":"",
"discountCouponType":"Promo",
"discountType":"Item Based",
"displayOffer":"15.00",
"freeItems":[],
"id":"5ddb9c7e0d3bb9000126509a",
"isCustomerAttach":false,
"isForAllSSL":true,
"isRestrictToTime":false,
"level":1,
"menuItems":[],
"minQuantity":3,
"name":"ItemBased25_11",
"offer":15,
"offerIn":"percentage",
"offerStr":"15.00",
"originalID":"5dd4fbf3d5c72b0001022968",
"priority":23,
"roles":[],
"servingSizes":["5dd3d7ee0493b900013a15f8","5dd3d7ee0493b900013a15f9",
"5dd3d7ee0493b900013a15fa","5dd3d7ee0493b900013a15fb","5dd3d7ee0493b900013a15fc",
"5dd3d7ee0493b900013a15fd","5dd3d7ee0493b900013a15fe","5dd3d7ee0493b900013a15ff",
"5dd3d7ee0493b900013a15f8","5dd3d7ee0493b900013a15f9","5dd3d7ee0493b900013a15fa",
"5dd3d7ee0493b900013a15fb","5dd3d7ee0493b900013a15f9","5dd3d7ee0493b900013a15fa",
"5dd3d7ee0493b900013a15fb","5dd3d7ee0493b900013a15f9","5dd3d7ee0493b900013a15fa",
"5dd3d7ee0493b900013a15fb"],
"setPrice":true,
"timeApplicableType":"Always",
"role":[],
"startTime":"",
"endTime":"",
"createdAt":2,
"createdFor":"5c5981496bcf7500013afeb0",
"ownedBy":"5c5981496bcf7500013afeb2"}' \
"https://api.lingaros.com/v1/lingapos/discount/{discount_id}" \
Creating a check based discount.
| Method | Type | Description |
|---|---|---|
| store{id:} | bson.ObjectId | Unique store id. |
| level | String | Level for which the discount will be applied(1:Category, 2:Subcategory, 3:MenuItem). |
| offerIn | String | Discount offer type (amount, percentage, set price, free item). |
| discountCouponType | String | Discount coupon type (Promo, Comp, Donation). |
| category | String | Category for which the discount is applied. |
| subCategory | String | Subcategory for which the discount is applied. |
| menuItem | String | Menu item for which the discount is applied. |
| servingSizes | []ServingSizes | Serving sizes for which the discount can be applied. |
| freeItems(Optional) | String | Free items that discount offers in. |
| isForAllSSL | Bool | True if the discount is applied for all serving sizes in category. |
| combineWithOtherDiscounts(Optional) | Bool | True if combined with other discounts. |
| includeAdditionalModifiers(Optional) | Bool | True if additional modifiers are included. |
| isRestrictToTime(Optional) | Bool | True if there is a restriction time setting. |
| offers | []bson.ObjectId | Offers for check based discount. |
| isRestrictToDays | Bool | True if the discount is restricted for some day. |
| daysOfWeek(Optional) | []DaysOfWeek | The discount is restricted for which day(s) of the week. |
| daysOfMonth(Optional) | []DaysOfMonth | The discount is restricted for which day(s) of the month. |
| isRestrictToMonths(Optional) | Bool | True if the discount is restricted for a month. |
| months(Optional) | String | Restriction month(s). |
| applyToDiscountedPrice | Bool | True if the discount is applied to discounted price. |
| excludeCategories(Optional) | String | Excluded categories for which the discount will not be applied. |
| excludeMenuItems(Optional) | String | Excluded menu items for which the discount will not be applied. |
| isFree | Bool | True if an item is offered for free as a discount. |
| timeApplicableType | String | The time for which the discount 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. |
| buttonColor | String | Button color selection for the discount. |
| couponOnly | Bool | True if coupon only option is selected. |
| menuItems | []MenuItems | Menu item ids for which the discount will be applied. |
| categories | []Categories | Category ids for which the discount will be applied. |
| subCategories | []SubCategories | Sub category ids for which the discount will be applied. |
| autoDiscount | Bool | True if auto discount option is selected. |
| setPrice | Bool | True if set price option is selected. |
| setPercentage | Bool | True if set percentage option is selected. |
| isSetEachItemPrice | Bool | True if set set each item price option is selected. |
| leastExpensive | Bool | True if (discount for) least expensive item option is selected. |
| mostExpensive | Bool | True if (discount for) most expensive item option is selected. |
| name | String | Name of the discount. |
| discountCode | String | Code of the discount. |
| minQuantity | String | Minimum quantity set for the discount. |
| offerStr | String | Amount offered by the discount. |
| offPerErr | String | |
| adjustAmount | String | Sets if the discount will be applied before or after the taxes. |
| priority | Int | Priority of the discount. |
| roles(Optional) | []Roles | Role id by whom the discount will be applied. |
| discountType | String | Discount type (Item based, Check based, Open Item, Open Check...) |
| createdAt | Int | Where the discount is created. |
| createdFor | bson.ObjectId | Store id for which the discount is created. |
| ownedBy | bson.ObjectId | Account id related to the Store by whom the discount is created. |
Offers [Offers]
| Method | Type | Description |
|---|---|---|
| minAmount | Int | Minimum amount for the discount to be applied. |
| minAmountStr | String | Minimum amount for the discount to be applied in string (without currency symbol). |
| discount | Int | Amount of the discount. |
| offerIn | Int | Discount offer type (amount, percentage, set price, free item). |
| disPerErr | Int | |
| freeItems(Optional) | []MenuItems | Free items. |
| showFreeItems | Bool | Denotes if free items are shown. |
| discountStr | String | Minimum amount for the discount to be applied in string. |
Free Items(Optional) [FreeItems]
| Method | Type | Description |
|---|---|---|
| menuItem | MenuItems | Menu Item id. |
| servingSize | []servingSizes | Serving size for which the discount is applied. |
| quantity | Int | Quantity of items for which the discount is applied. |
| servingSize | []servingSizes | Serving sizes for which the discount is applied. |
| offerStr | Int | Offer amount in string. |
Serving Sizes [ServingSizes]
| Method | Type | Description |
|---|---|---|
| activeStatus | Bool | Denotes if the service size is active. |
| conversions | []Conversions | |
| default | Bool | Denotes if it's default serving size. |
| id | String | Serving size id. |
| name | String | Serving size name. |
| originalID | String | Serving size original ID. |
| type | Int | Serving size type. |
curl -X POST \
-H "apikey: generated-api-key" \
-H "Content-Type: application/json" \
-d '{"store":{"id":"5dd3d7ee0493b900013a15cc"},
"level":1,
"offerIn":"percentage",
"discountCouponType":"Donation",
"category":"",
"subCategory":"",
"menuItem":"",
"servingSizes":["5dd3d7ee0493b900013a15f8","5dd3d7ee0493b900013a15f9","5dd3d7ee0493b900013a15fa","5dd3d7ee0493b900013a15fb","5dd3d7ee0493b900013a15fc","5dd3d7ee0493b900013a15fd","5dd3d7ee0493b900013a15fe","5dd3d7ee0493b900013a15ff"],
"freeItems":[],
"isForAllSSL":true,
"combineWithOtherDiscounts":true,
"includeAdditionalModifiers":false,
"isRestrictToTime":false,
"offers":[
{"minAmount":"",
"minAmountStr":"15.00",
"discount":"",
"offer":"Checktotal",
"offerIn":"free item",
"disPerErr":1,
"freeItems":[{"menuItem":"5dd3d7ee0493b900013a160d",
"servingSize":"5dd3d7ee0493b900013a15f8",
"quantity":3,
"servingSizes":[{"activeStatus":true,
"conversions":[],
"default":false,
"description":"",
"id":"5dd3d7ee0493b900013a15f8",
"name":"EACH",
"originalID":"5dd3d7ee0493b900013a15f8","type":0}],
"offerStr":"0.50"}],
"showFreeItems":false,
"discountStr":""}],
"isRestrictToDays":false,
"daysOfWeek":[],
"daysOfMonth":[],
"isRestrictToMonths":false,
"months":[],
"applyToDiscountedPrice":true,
"excludeCategories":["5dd3d7ee0493b900013a1608"],
"excludeMenuItems":["5dd3d7ee0493b900013a160c"],
"isFree":false,
"timeApplicableType":"Always",
"buttonColor":"#2980B9",
"couponOnly":true,
"menuItems":[],
"categories":[],
"subCategories":[],
"autoDiscount":false,
"setPrice":true,
"setPercentage":false,
"isSetEachItemPrice":false,
"leastExpensive":false,
"mostExpensive":false,
"name":"Discount_2911",
"priority":2,
"roles":["5dd3d7ee0493b900013a15d3"],
"adjustAmount":"After Tax",
"discountType":"Check Based",
"createdAt":2,
"createdFor":"5dd3d7ee0493b900013a15cc",
"ownedBy":"5dd3d7ee0493b900013a15ce"}' \
"https://api.lingaros.com/v1/lingapos/discount" \
Updating an check based discount.
URL:http://api.lingaros.com/v1/lingapos/discount/{discount_id}
| Method | Type | Description |
|---|---|---|
| activeStatus | Bool | True if the discount is active. |
| adjustAmount | String | Sets if discount will be applied before or after update. |
| applicableTo | String | Discount is applicable for an Item, a Check or as a Combo. |
| applyToDiscountedPrice | Bool | True if the discount will be applied to discounted price. |
| autoDiscount | Bool | True if the discount is applied automatically. |
| buttonColor | String | Color of the discount button. |
| combineWithOtherDiscounts(Optional) | Bool | True if combined with other discounts. |
| categories | String | Category id. |
| couponOnly | Bool | True if coupon-only discount. |
| discountCode | String | Discount code. |
| discountCouponType | String | Discount coupon type. |
| discountType | String | Discount type (Item based, Check based, Open Item, Open Check...) |
| excludeCategories(Optional) | []Categories | Categories to be excluded. |
| excludeMenuItems(Optional) | []MenuItems | Menu Items to be excluded. |
| id | bson.ObjectId | Discount id. |
| isCustomerAttach(Optional) | Bool | True if a customer is attached to discount. |
| isRestrictToTime(Optional) | Bool | True if the discount is restricted in time. |
| name | String | Name of the discount. |
| offers | []bson.ObjectId | Offers. |
| originalID | String | Discount original id. |
| priority | Int | Priority of the discount. |
| roles(Optional) | []Roles | Role ids by which the discount will be applied. |
| setPrice | Bool | True if set price option is selected. |
| timeApplicableType | String | The time (period) for which the discount 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. |
| role | []Roles | Role id. |
| freeItems(Optional) | []MenuItems | List of free items offered with the discount. |
| startTime | Time | If a restriction in time is set, when the discount restriction starts. |
| endTime | Time | If a restriction in time is set, when the discount restriction ends. |
| createdAt | Int | Where the discount is created. |
| createdFor | bson.ObjectId | Store id for which the discount is created. |
| ownedBy | bson.ObjectId | Account id related to the Store by whom the discount is created. |
Offers [Offers]
| Method | Type | Description |
|---|---|---|
| discount | Int | Amount of the discount. |
| discountStr | String | Minimum amount for the discount to be applied in string. |
| displayDiscount | String | Amount of the discount in string. |
| displayMinAmount | String | Display minimum amount for the discount to be applied in string (with currency symbol). |
| id | String | Offer id. |
| minAmount | Int | Minimum amount for the discount to be applied. |
| minAmountStr | String | Minimum amount for the discount to be applied in string (without currency symbol). |
| offerIn | Int | Discount offer type (amount, percentage, set price, free item). |
| disPerErr | Int |
curl -X PUT \
-H "apikey: generated-api-key" \
-H "Content-Type: application/json" \
-d '{"activeStatus":true,
"adjustAmount":"Before Tax",
"applicableTo":"",
"applyToDiscountedPrice":true,
"autoDiscount":false,
"buttonColor":"#2980B9",
"combineWithOtherDiscounts":true,
"couponOnly":false,
"discountCode":"",
"discountCouponType":"Promo",
"discountType":"Check Based",
"excludeCategories":["5c5981496bcf7500013afeed"],
"excludeMenuItems":["5c5981496bcf7500013afef1"],
"id":"5dd3f6c0d5c72b00019298d0",
"isCustomerAttach":false,
"isRestrictToTime":false,
"name":"checkbasedtestdiscount",
"offers":[{"discount":5,
"discountStr":"10.00",
"displayDiscount":"5.00",
"displayMinAmount":"₹10.00",
"id":"5dd3f6c0d5c72b00019298cf",
"minAmount":1000,
"minAmountStr":"10.00",
"offerIn":"percentage",
"disPerErr":1}],
"originalID":"5dd3f6c0d5c72b00019298d0",
"priority":0,
"roles":[],
"setPrice":true,
"timeApplicableType":"Always",
"role":[],
"freeItems":[],
"startTime":"",
"endTime":"",
"createdAt":2,
"createdFor":"5c5981496bcf7500013afeb0",
"ownedBy":"5c5981496bcf7500013afeb2"}' \
"https://api.lingaros.com/v1/lingapos/discount/{discount_id}" \
Creating an open item discount.
| Method | Type | Description |
|---|---|---|
| isPercentage (Optional) | Bool | Denotes if the discount is percentage based. |
| isAmount (Optional) | Bool | Denotes if the discount is amount based. |
| includeAdditionalModifiers(Optional) | Bool | Denotes if additional modifiers are included. |
| combineWithOtherDiscounts(Optional) | Bool | Denotes if the discount is combined with other discounts. |
| applyToDiscountedPrice | Bool | Denotes if the discount is applied to discounted price. |
| discountCouponType | String | Coupon type of the discount. |
| couponOnly(Optional) | Bool | Denotes if the discount is coupon-only. |
| buttonColor | String | Discount button color. |
| name | String | Name of the discount. |
| adjustAmount | String | Discount is applied before or after tax. |
| priority | Int | Priority of the discount. |
| minPercentage | Int | Min percentage which can be applied with the discount. |
| maxPercentage | Int | Max percentage which can be applied with the discount. |
| minPercentageStr | String | Min percentage which can be applied with the discount (in string). |
| maxPercentageStr | String | Max percentage which can be applied with the discount (in string). |
| minPerErr | Int | |
| minPerMsg | String | |
| maxPerErr | Int | |
| maxPerMsg | String | |
| roles(Optional) | []Roles | Role ids by which the discount will be applied. |
| minAmount | Int | Minimum discount to be applied in amount. |
| maxAmount | Int | Maximum discount to be applied in amount. |
| minAmountStr | Int | Minimum discount to be applied in amount (in string). |
| maxAmountStr | Int | Maximum discount to be applied in amount (in string). |
| safetyLimitPercentage | Int | |
| safetyLimitPercentageStr | String | |
| maxAmtErr | Int | |
| maxAmtMsg | String | |
| safePerErr | Int | |
| safePerMsg | String | |
| createdAt | Int | Where the discount is created. |
| createdFor | bson.ObjectId | Store id for which the discount is created. |
| ownedBy | bson.ObjectId | Account id related to the Store by whom the discount is created. |
| discountType | String | Discount type: Item based, check based, open item, open check, mix and match . |
| store | bson.ObjectId | Store Id |
curl -X POST \
-H "apikey: generated-api-key" \
-H "Content-Type: application/json" \
-d '{"isPercentage":false,
"isAmount":true,
"includeAdditionalModifiers":false,
"combineWithOtherDiscounts":false,
"applyToDiscountedPrice":false,
"discountCouponType":"Donation",
"couponOnly":false,
"buttonColor":"#578c25",
"name":"OpenItem_5_12",
"adjustAmount":"After Tax",
"priority":6,
"minPercentage":0,
"maxPercentage":0,
"minPercentageStr":null,
"maxPercentageStr":null,
"minPerErr":1,
"minPerMsg":"",
"maxPerErr":1,
"maxPerMsg":"",
"roles":["5dc3b10226781d0001e21dbc"],
"minAmount":0,
"maxAmount":0,
"minAmountStr":"5.00",
"maxAmountStr":"10.00",
"safetyLimitPercentage":null,
"safetyLimitPercentageStr":"3",
"maxAmtErr":1,
"maxAmtMsg":"",
"safePerErr":1,
"safePerMsg":"",
"createdAt":2,
"createdFor":"5dc3b10126781d0001e21db2",
"ownedBy":"58eb27699230ca6124a586e5",
"discountType":"Open Item",
"store":"5dc3b10126781d0001e21db2"}' \
"https://api.lingaros.com/v1/lingapos/discount" \
Updating an open item discount.
URL:http://api.lingaros.com/v1/lingapos/discount/{discount_id}
| Method | Type | Description |
|---|---|---|
| activeStatus | Bool | True if the discount is active. |
| adjustAmount | String | Set if the discount will be applied before or after the taxes. |
| applicableTo | String | Discount is applicable for an Item, a Check or as a Combo. |
| applyToDiscountedPrice | Bool | Denotes if the discount is applied to discounted price. |
| autoDiscount | Bool | True if the discount is applied automatically. |
| buttonColor | String | Discount button color. |
| combineWithOtherDiscounts(Optional) | Bool | Denotes if the discount is combined with other discounts. |
| couponOnly(Optional) | Bool | Denotes if the discount is coupon-only. |
| discountCode | String | Discount code. |
| discountCouponType | String | Coupon type of the discount. |
| discountType | String | Discount type (Item based, Check based, Open Item, Open Check...) |
| id | bson.ObjectId | Discount id. |
| includeAdditionalModifiers(Optional) | Bool | Denotes if additional modifiers are included. |
| isAmount (Optional) | Bool | Denotes if the discount is amount based. |
| isCustomerAttach(Optional) | Bool | True if a customer is attached to discount. |
| isPercentage (Optional) | Bool | Denotes if the discount is percentage based. |
| maxPercentage | Int | Max percentage which can be applied with the discount. |
| maxPercentageStr | String | Max percentage which can be applied with the discount (in string). |
| minPercentage | Int | Min percentage which can be applied with the discount. |
| minPercentageStr | String | Min percentage which can be applied with the discount (in string). |
| name | String | Name of the discount. |
| originalID | String | Discount original id. |
| priority | Int | Priority of the discount. |
| roles(Optional) | []Role | Role ids by which the discount will be applied. |
| safetyLimitPercentage | Int | |
| safetyLimitPercentageStr | String | |
| setPrice | Bool | True if set price option is selected. |
| minPerErr | Int | |
| minPerMsg | String | |
| maxPerErr | Int | |
| maxPerMsg | String | |
| minAmount | Int | Minimum discount to be applied in amount. |
| maxAmount | Int | Maximum discount to be applied in amount. |
| createdAt | Int | Where the discount is created. |
| createdFor | bson.ObjectId | Store id for which the discount is created. |
| ownedBy | bson.ObjectId | Account id related to the Store by whom the discount is created. |
curl -X PUT \
-H "apikey: generated-api-key" \
-H "Content-Type: application/json" \
-d '{"activeStatus":true,
"adjustAmount":"After Tax",
"applicableTo":"",
"applyToDiscountedPrice":false,
"autoDiscount":false,
"buttonColor":"#2980B9",
"combineWithOtherDiscounts":false,
"couponOnly":true,
"discountCode":"",
"discountCouponType":"Donation",
"discountType":"Open Item",
"id":"5df26b86eb3df60001eb392e",
"includeAdditionalModifiers":true,
"isAmount":false,
"isCustomerAttach":true,
"isPercentage":true,
"maxPercentage":90,
"maxPercentageStr":"80.00",
"minPercentage":10,
"minPercentageStr":"10.00",
"name":"OpenItem_1212",
"originalID":"5df26b86eb3df60001eb392e",
"priority":2,
"roles":["5dd3d7ee0493b900013a15d2","5dd3d7ee0493b900013a15d3"],
"safetyLimitPercentage":0,
"safetyLimitPercentageStr":"",
"setPrice":false,
"minPerErr":1,
"minPerMsg":"",
"maxPerErr":1,
"maxPerMsg":"",
"minAmount":0,
"maxAmount":0,
"createdAt":2,
"createdFor":"5dd3d7ee0493b900013a15cc",
"ownedBy":"5dd3d7ee0493b900013a15ce"}' \
"https://api.lingaros.com/v1/lingapos/discount/{discount_id}" \
Creating an open check discount.
| Method | Type | Description |
|---|---|---|
| isPercentage (Optional) | Bool | Denotes if the discount is percentage based. |
| isAmount (Optional) | Bool | Denotes if the discount is amount based. |
| includeAdditionalModifiers(Optional) | Bool | Denotes if additional modifiers are included. |
| combineWithOtherDiscounts(Optional) | Bool | Denotes if the discount is combined with other discounts. |
| applyToDiscountedPrice | Bool | Denotes if the discount is applied to discounted price. |
| discountCouponType | String | Coupon type of the discount. |
| couponOnly(Optional) | Bool | Denotes if the discount is coupon-only. |
| buttonColor | String | Discount button color. |
| name | String | Name of the discount. |
| adjustAmount | String | Discount is applied before or after tax. |
| priority | Int | Priority of the discount. |
| minPercentage | Int | Min percentage which can be applied with the discount. |
| maxPercentage | Int | Max percentage which can be applied with the discount. |
| minPercentageStr | String | Min percentage which can be applied with the discount (in string). |
| maxPercentageStr | String | Max percentage which can be applied with the discount (in string). |
| minPerErr | Int | |
| minPerMsg | String | |
| maxPerErr | Int | |
| maxPerMsg | String | |
| roles(Optional) | []Roles | Role ids by which the discount will be applied. |
| minAmount | Int | Minimum discount to be applied in amount. |
| maxAmount | Int | Maximum discount to be applied in amount. |
| minAmountStr | Int | Minimum discount to be applied in amount (in string). |
| maxAmountStr | Int | Maximum discount to be applied in amount (in string). |
| safetyLimitPercentage | Int | |
| safetyLimitPercentageStr | String | |
| maxAmtErr | Int | |
| maxAmtMsg | String | |
| safePerErr | Int | |
| safePerMsg | String | |
| createdAt | Int | Where the discount is created. |
| createdFor | bson.ObjectId | Store id for which the discount is created. |
| ownedBy | bson.ObjectId | Account id related to the Store by whom the discount is created. |
| discountType | String | Discount type: Item based, check based, open item, open check, mix and match . |
| store | bson.ObjectId | Store Id |
curl -X POST \
-H "apikey: generated-api-key" \
-H "Content-Type: application/json" \
-d '{"isPercentage":true,
"isAmount":true,
"includeAdditionalModifiers":false,
"combineWithOtherDiscounts":false,
"applyToDiscountedPrice":false,
"discountCouponType":"Promo",
"couponOnly":true,
"buttonColor":"#2980B9",
"name":"Open Check 1612",
"minPercentage":0,
"maxPercentage":0,
"minPercentageStr":"5.00",
"maxPercentageStr":"10",
"minPerErr":1,"
minPerMsg":"",
"maxPerErr":1,"
maxPerMsg":"",
"minAmount":0,
"maxAmount":0,
"minAmountStr":"10.00",
"maxAmountStr":"20.00",
"safetyLimitPercentage":null,
"safetyLimitPercentageStr":"7",
"maxAmtErr":1,"maxAmtMsg":"",
"safePerErr":1,
"safePerMsg":"",
"adjustAmount":"Before Tax",
"priority":2,
"createdAt":2,
"createdFor":"5dd3d7ee0493b900013a15cc",
"ownedBy":"5dd3d7ee0493b900013a15ce",
"discountType":"Open Check",
"store":"5dd3d7ee0493b900013a15cc"}' \
"https://api.lingaros.com/v1/lingapos/discount" \
Updating an open check discount.
URL:http://api.lingaros.com/v1/lingapos/discount/{discount_id}
| Method | Type | Description |
|---|---|---|
| activeStatus | Bool | True if the discount is active. |
| adjustAmount | String | Set if the discount will be applied before or after the taxes. |
| applicableTo | String | Discount is applicable for an Item, a Check or as a Combo. |
| applyToDiscountedPrice | Bool | Denotes if the discount is applied to discounted price. |
| autoDiscount | Bool | True if the discount is applied automatically. |
| buttonColor | String | Discount button color. |
| combineWithOtherDiscounts(Optional) | Bool | Denotes if the discount is combined with other discounts. |
| couponOnly(Optional) | Bool | Denotes if the discount is coupon-only. |
| discountCode | String | Discount code. |
| discountCouponType | String | Coupon type of the discount. |
| discountType | String | Discount type (Item based, Check based, Open Item, Open Check...) |
| id | bson.ObjectId | Discount id. |
| includeAdditionalModifiers(Optional) | Bool | Denotes if additional modifiers are included. |
| isAmount (Optional) | Bool | Denotes if the discount is amount based. |
| isCustomerAttach(Optional) | Bool | True if a customer is attached to discount. |
| isPercentage (Optional) | Bool | Denotes if the discount is percentage based. |
| maxPercentage | Int | Max percentage which can be applied with the discount. |
| maxPercentageStr | String | Max percentage which can be applied with the discount (in string). |
| minPercentage | Int | Min percentage which can be applied with the discount. |
| minPercentageStr | String | Min percentage which can be applied with the discount (in string). |
| name | String | Name of the discount. |
| originalID | String | Discount original id. |
| priority | Int | Priority of the discount. |
| roles(Optional) | []Roles | Role ids by which the discount will be applied. |
| setPrice | Bool | True if set price option is selected. |
| minAmount | Int | Minimum discount to be applied in amount. |
| maxAmount | Int | Maximum discount to be applied in amount. |
| createdAt | Int | Where the discount is created. |
| createdFor | bson.ObjectId | Store id for which the discount is created. |
| ownedBy | bson.ObjectId | Account id related to the Store by whom the discount is created. |
curl -X PUT \
-H "apikey: generated-api-key" \
-H "Content-Type: application/json" \
-d '{"activeStatus":true,
"adjustAmount":"Before Tax",
"applicableTo":"",
"applyToDiscountedPrice":false,
"autoDiscount":false,
"buttonColor":"#2980B9",
"combineWithOtherDiscounts":false,
"couponOnly":true,
"discountCode":"",
"discountCouponType":"Promo",
"discountType":"Open Check",
"displayMaxAmount":"US$20.00",
"displayMinAmount":"US$10.00",
"id":"5df6a5c316fd03000161bebe",
"isAmount":true,
"isCustomerAttach":false,
"isPercentage":true,
"maxAmount":2000,
"maxAmountStr":"20.00",
"maxPercentage":0,
"maxPercentageStr":"10",
"minAmount":1000,
"minAmountStr":"10.00",
"minPercentage":5,
"minPercentageStr":"5.50",
"name":"Open Check 1612",
"originalID":"5df6a5c316fd03000161bebe",
"priority":2,
"roles":null,
"safetyLimitPercentage":7,
"safetyLimitPercentageStr":"7",
"setPrice":false,
"minPerErr":1,
"minPerMsg":"",
"maxPerErr":1,
"maxPerMsg":"",
"createdAt":2,
"createdFor":"5dd3d7ee0493b900013a15cc",
"ownedBy":"5dd3d7ee0493b900013a15ce"}' \
"https://api.lingaros.com/v1/lingapos/discount/{discount_id}" \
Creating an mix and match discount.
| Method | Type | Description |
|---|---|---|
| store{id:} | bson.ObjectId | Unique store id. |
| level | String | Level for which the discount will be applied(1:Category, 2:Subcategory, 3:MenuItem). |
| offerIn | String | Discount offer type (amount, percentage, set price, free item). |
| discountCouponType(Optional) | String | Discount coupon type (Promo, Comp, Donation). |
| category | String | Category for which the discount is applied. |
| subCategory | String | Subcategory for which the discount is applied. |
| menuItem | String | Menu item for which the discount is applied. |
| servingSizes | []ServingSizes | Serving sizes for which the discount can be applied. |
| freeItems(Optional) | []freeItems | Free items that discount offers in. |
| isForAllSSL | Bool | True if the discount is applied for all serving sizes in category. If false, then serving size(s) must be selected |
| combineWithOtherDiscounts(Optional) | Bool | True if combined with other discounts. |
| includeAdditionalModifiers(Optional) | Bool | True if additional modifiers are included. |
| isRestrictToTime(Optional) | Bool | True if there is a restriction time setting. |
| offers | []Offers | Offers (for check based discount). |
| isRestrictToDays(Optional) | Bool | True if the discount is restricted for some day. |
| daysOfWeek(Optional) | []DaysOfWeek | Which day(s) of the week the discount is restricted. |
| daysOfMonth(Optional) | []DaysOfMonth | Which day(s) of the month the discount is restricted. |
| isRestrictToMonths(Optional) | Bool | True if the discount is restricted for a month. |
| months(Optional) | String | Restriction month(s). |
| applyToDiscountedPrice | Bool | True if the discount is applied to discounted price. |
| excludeCategories(Optional) | String | Excluded categories for which the discount will not be applied. (Check based discounts) |
| excludeMenuItems(Optional) | String | Excluded menu items for which the discount will not be applied. (Check based discounts) |
| isFree(Optional) | Bool | True if an item is offered for free as a discount. |
| timeApplicableType | String | Time for which the discount 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. |
| buttonColor | String | Button color selection for the discount. |
| couponOnly(Optional) | Bool | True if coupon only option is selected. |
| menuItems | []MenuItems | Menu item ids for which the discount will be applied. |
| categories | []bson.ObjectId | Category ids for which the discount will be applied. |
| subCategories | map[String]Category | Sub category ids for which the discount will be applied. |
| autoDiscount(Optional) | Bool | True if auto discount option is selected. |
| setPrice | Bool | True if set price option is selected.(One of the following options have to be selected for 'mix and match' type of discount:Price, percentage or set price for each item). |
| setPercentage | Bool | True if set percentage option is selected.((One of the following options have to be set for 'mix and match' type of discount:Price, percentage or set price for each item). |
| isSetEachItemPrice | Bool | True if set each item price option is selected.((One of the following options have to be set for 'mix and match' type of discount:Price, percentage or set price for each item). |
| leastExpensive | Bool | True if (discount for) least expensive item option is selected((One of the following options have to be set for 'mix and match' type of discount:Least expensive, most expensive). |
| mostExpensive | Bool | True if (discount for) most expensive item option is selected((One of the following options have to be set for 'mix and match' type of discount:Least expensive, most expensive. |
| name | String | Name of the discount. |
| mixAndMatchOffer | []mixAndMatchOffer | Mix and match offer details. |
| comboLength | Int | Length of the combo to be discounted. |
| adjustAmount | String | Set if the discount will be applied before or after the taxes. |
| priority | Int | Priority of the discount. |
| discountType | String | Type of the discount. |
| createdAt | Int | Which store created the discount. |
| createdFor | bson.ObjectId | Store id for which the discount is created. |
| ownedBy | bson.ObjectId | Account id related to the Store by whom the discount is created. |
| discountCode | String | Discount code. |
Mix And Match Offer [mixAndMatchOffer]
| Method | Type | Description |
|---|---|---|
| quantity | Int | Quantity of menu items for which the discount is applied. |
| priceStr | String | Discounted price. |
curl -X POST \
-H "apikey: generated-api-key" \
-H "Content-Type: application/json" \
-d '{"store":{"id":"5dd3d7ee0493b900013a15cc"},
"level":1,
"offerIn":"set price",
"discountCouponType":"Promo",
"category":"",
"subCategory":"",
"menuItem":"",
"servingSizes":["5dd3d7ee0493b900013a15fc","5dd3d7ee0493b900013a15ff","5dd3d7ee0493b900013a15fd","5dd3d7ee0493b900013a15fe","5dd3d7ee0493b900013a15f9","5dd3d7ee0493b900013a15f8","5dd3d7ee0493b900013a15fa","5dd3d7ee0493b900013a15fb"],
"freeItems":[],
"isForAllSSL":true,
"combineWithOtherDiscounts":true,
"includeAdditionalModifiers":false,
"isRestrictToTime":false,
"offers":[],
"isRestrictToDays":false,
"daysOfWeek":[],
"daysOfMonth":[],
"isRestrictToMonths":false,
"months":[],
"applyToDiscountedPrice":true,
"excludeCategories":[],
"excludeMenuItems":[],
"isFree":false,
"timeApplicableType":"Always",
"buttonColor":"#2980B9",
"couponOnly":false,
"menuItems":["5dd3d7ee0493b900013a160e"],
"categories":["5dd3d7ee0493b900013a160b"],
"subCategories":[],
"autoDiscount":false,
"setPrice":false,
"setPercentage":false,
"isSetEachItemPrice":true,
"leastExpensive":false,
"mostExpensive":false,
"name":"MixAndMatch1612",
"mixAndMatchOffers":[{"quantity":3,"qtyErr":"","disQtyErr":"","priceStr":"4.00"}],
"comboLength":1,
"comboUnique":0,
"adjustAmount":"Before Tax",
"priority":4,
"discountType":"Mix And Match",
"createdAt":2,
"createdFor":"5dd3d7ee0493b900013a15cc",
"ownedBy":"5dd3d7ee0493b900013a15ce",
"discountCode":""}' \
"https://api.lingaros.com/v1/lingapos/discount" \
Updating a mix and match discount.
URL:http://api.lingaros.com/v1/lingapos/discount/{discount_id}
| Method | Type | Description |
|---|---|---|
| activeStatus | Bool | True if the discount is active. |
| adjustAmount | String | Set if the discount will be applied before or after the taxes. |
| applicableTo | String | Discount is applicable for an Item, a Check or as a Combo. |
| applyToDiscountedPrice | Bool | Denotes if the discount is applied to discounted price. |
| autoDiscount | Bool | True if the discount is applied automatically. |
| buttonColor | String | Discount button color. |
| categories | []Categories | Category ids for which the discount will be applied. |
| combineWithOtherDiscounts(Optional) | Bool | Denotes if the discount is combined with other discounts. |
| couponOnly(Optional) | Bool | Denotes if the discount is coupon-only. |
| discountCode | String | Discount code. |
| discountCouponType | String | Coupon type of the discount. |
| discountType | String | Discount type (Item based, Check based, Open Item, Open Check...) |
| id | String | Discount id. |
| isCustomerAttach(Optional) | Bool | True if a customer is attached to discount. |
| isRestrictToTime(Optional) | Bool | True if there is a restriction time setting. |
| isSetEachItemPrice | Bool | True if set each item price option is selected.((One of the following options have to be set for 'mix and match' type of discount:Price, percentage or set price for each item). |
| leastExpensive | Bool | True if (discount for) least expensive item option is selected((One of the following options have to be set for 'mix and match' type of discount:Least expensive, most expensive). |
| menuItems | []MenuItems | Menu item ids for which the discount will be applied. |
| mixAndMatchOffer | []mixAndMatchOffer | Mix and match offer details. |
| mostExpensive | Bool | True if (discount for) most expensive item option is selected((One of the following options have to be set for 'mix and match' type of discount:Least expensive, most expensive. |
| name | String | Name of the discount. |
| offer | Int | Amount of the offer. |
| offerIn | String | Discount offer type (amount, percentage, set price, free item). |
| offerStr | Int | Offer amount in string. |
| originalID | String | Discount original id. |
| priority | Int | Priority of the discount. |
| roles(Optional) | []Roles | Role ids by which the discount will be applied. |
| setPercentage | Bool | True if set percentage option is selected.((One of the following options have to be set for 'mix and match' type of discount:Price, percentage or set price for each item). |
| setPrice | Bool | True if set price option is selected. |
| timeApplicableType | String | Time for which the discount 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. |
| role | []Roles | Role id. |
| servingSizes | []ServingSizes | Serving sizes for which the discount can be applied. |
| comboLength | Int | Length of the combo to be discounted. |
| freeItems(Optional) | []freeItems | Free items that discount offers in. |
| startTime | Time | If a restriction in time is set, when the discount restriction starts. |
| endTime | Time | If a restriction in time is set, when the discount restriction ends. |
| createdAt | Int | Where the discount is created. |
| createdFor | bson.ObjectId | Store id for which the discount is created. |
| ownedBy | bson.ObjectId | Account id related to the Store by whom the discount is created. |
Mix And Match Offer [mixAndMatchOffer]
| Method | Type | Description |
|---|---|---|
| quantity | Int | Quantity of menu items for which the discount is applied. |
| priceStr | String | Discounted price. |
| discountQuantity | Int | Discounted quantity. |
curl -X PUT \
-H "apikey: generated-api-key" \
-H "Content-Type: application/json" \
-d '{"activeStatus":true,
"adjustAmount":"After Tax",
"applicableTo":"","
applyToDiscountedPrice":true,
"autoDiscount":false,
"buttonColor":"#2980B9",
"categories":["5dd3d7ee0493b900013a160b"],
"combineWithOtherDiscounts":true,
"couponOnly":false,"discountCode":"",
"discountCouponType":"Promo",
"discountType":"Mix And Match",
"displayOffer":"US$0.00",
"id":"5df6abcc16fd03000161bec2",
"isCustomerAttach":false,
"isRestrictToTime":false,
"isSetEachItemPrice":true,
"leastExpensive":false,
"menuItems":["5dd3d7ee0493b900013a160e"],
"mixAndMatchOffers":[{"_id":"5df6abcc16fd03000161bec1","quantity":3,"price":400,"priceStr":"4.00","discountQuantity":0}],
"mostExpensive":false,
"name":"MixAndMatch1612",
"offer":0,
"offerIn":"set price",
"offerStr":"0.00",
"originalID":"5df6abcc16fd03000161bec2",
"priority":4,
"roles":[],
"setPercentage":false,
"setPrice":false,
"timeApplicableType":"Always",
"role":[],
"servingSizes":[],
"comboLength":1,
"comboUnique":0,
"freeItems":[],
"startTime":"",
"endTime":"",
"createdAt":2,
"createdFor":"5dd3d7ee0493b900013a15cc",
"ownedBy":"5dd3d7ee0493b900013a15ce"}' \
"https://api.lingaros.com/v1/lingapos/discount/{discount_id}" \
Getting item based discounts of a store.
URL:https://api.lingaros.com/v1/lingapos/store/{store-id}/itemBasedDiscounts
curl -X GET -H "apikey: generated-api-key" \
"https://api.lingaros.com/v1/lingapos/store/{store-id}/itemBasedDiscounts"
queryParms
?page=1 => [paging no]
?search='' => [null]
?status=true => [active discount]
?status=false => [inactive discount]
Getting check based discounts of a store.
URL:https://api.lingaros.com/v1/lingapos/store/{store-id}/checkBasedDiscounts
curl -X GET -H "apikey: generated-api-key" \
"https://api.lingaros.com/v1/lingapos/store/{store-id}/checkBasedDiscounts"
queryParms
?page=1 => [paging no]
?search='' => [null]
?status=true => [active discount]
?status=false => [inactive discount]
Getting open item discount of a store.
URL:https://api.lingaros.com/v1/lingapos/store/{store-id}/openItemDiscount
queryParms
curl -X GET -H "apikey: generated-api-key" \
"https://api.lingaros.com/v1/lingapos/store/{store-id}/openItemDiscount"
queryParms
?page=1 => [paging no]
?search='' => [null]
?status=true => [active discount]
?status=false => [inactive discount]
Getting open check discount of a store.
URL:https://api.lingaros.com/v1/lingapos/store/{store-id}/openCheckDiscount
curl -X GET -H "apikey: generated-api-key" \
"https://api.lingaros.com/v1/lingapos/store/{store-id}/openCheckDiscount"
queryParms
?page=1 => [paging no]
?search='' => [null]
?status=true => [active discount]
?status=false => [inactive discount]
Getting mixed and matched discounts of a store.
URL:https://api.lingaros.com/v1/lingapos/store/{store-id}/mixAndMatchDiscounts
queryParms
curl -X GET -H "apikey: generated-api-key" \
"https://api.lingaros.com/v1/lingapos/store/{store-id}/mixAndMatchDiscounts"
?page=1 => [paging no]
?search='Some discount' => [String to be searched]
?status=true => [active discount]
?status=false => [inactive discount]
Getting active categories.
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 subcategories.
URL:https://api.lingaros.com/v1/lingapos/store/{store-id}/activeSubCategories
curl -X GET -H "apikey: generated-api-key" \
"https://api.lingaros.com/v1/lingapos/store/{store-id}/activeSubCategories"
Getting active menu items.
URL:https://api.lingaros.com/v1/lingapos/store/{store-id}/activeMenuItems
curl -X GET -H "apikey: generated-api-key" \
"https://api.lingaros.com/v1/lingapos/store/{store-id}/activeMenuItems"
Getting active roles.
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"
Inactivating a discount.
URL:http://staging-linga.lingapos.com/discount/{discount-id}/inactivate
| Method | Type | Description |
|---|---|---|
| entity | String | Entity to be inactivated. |
| id | String | Discount id. |
curl -X PUT \
-H "apikey: generated-api-key" \
-H "Content-Type: application/json" \
-d '{
"entity":"discount",
"id":"5dd1ca2624f8e6000191fd63"
}' \
"https://api.lingaros.com/v1/lingapos/discount/{discount-id}/inactivate" \
Activating an inactive discount.
URL:http://staging-linga.lingapos.com/discount/{discount-id}/activate
| Method | Type | Description |
|---|---|---|
| entity | String | Entity to be inactivated. |
| id | String | Discount id. |
curl -X PUT \
-H "apikey: generated-api-key" \
-H "Content-Type: application/json" \
-d '{
"entity":"discount",
"id":"5dd1ca2624f8e6000191fd63"
}' \
"https://api.lingaros.com/v1/lingapos/discount/{discount-id}/activate" \
Publish a discount.
URL:http://api.lingaros.com/v1/lingapos/store/{store-id}/publish
curl -X PUT \
-H "apikey: generated-api-key" \
"https://api.lingaros.com/v1/lingapos/discount/store/{store-id}/publish" \