This GET request retrieves bill information from a specific resource endpoint in the API. The request includes compulsory query parameters such as:
\n- \n
- \"from\": the starting timestamp (in milliseconds since Unix epoch) for the bill search. \n
- \"to\": the ending timestamp (in milliseconds since Unix epoch) for the bill search. \n
- \"page\": the page number of the results to return. \n
- \"customer_key\": a unique identifier for the customer associated with the request. \n
The response includes a nested object with details about the bill, including:
\n- \n
- Customer information \n
- Charges \n
- Payments \n
- Discounts \n
The response also includes an array of KOTs (Kitchen Order Tickets) with details about the items ordered, their categories, and taxes.
\nAuthorization for the request is achieved using an API Key. An example request is provided.
\nRequest Format
\nHere's a breakdown of each of the query parameters:
\nResponse format
\nPlease note that the _kots key contains an array of KOTs, and each KOT has a list of items with their details. The items contain information about their category, taxes, and other properties.
For the nested items key in the _kots, the structure is as follows:
The category key in the items array has the following structure:
The superCategory key in the category object has the following structure:
The section key in the category object has the following structure:
The taxes key in the items array has the following structure:
This covers the _kots key along with its nested keys and their respective types, descriptions, and examples.
This GET request retrieves all invoices from a specific resource endpoint in the API. The request includes optional query parameters such as:
\n- \n
- \"customer_key\": a unique identifier for the customer associated with the request. \n
- \"partner\": the partner name associated with the request. \n
- \"apiKey\": the API key used to authenticate the request. \n
- \"StartDate\": the start date for the range of invoices to retrieve. \n
- \"EndDate\": the end date for the range of invoices to retrieve. \n
The response includes a list of invoices, each with the following details:
\n- \n
- \"InvoiceNumber\": the unique identifier for the invoice. \n
- \"ReportedOn\": the date and time the invoice was reported. \n
- \"NetSales\": the net amount of the invoice's sales. \n
- \"TotalTax\": the total tax amount for the invoice. \n
- \"GrossSales\": the gross amount of the invoice's sales (before discounts or returns). \n
- \"Discount\": the total amount of discounts applied to the invoice. \n
- \"ReturnValue\": the total amount returned for the invoice. \n
Authorization for the request is achieved using an API Key.
\nRequest Params
\nHere's a breakdown of each of the query parameters:
\nResponse
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"The Restroworks Data Integration API is a comprehensive and user-friendly solution tailored for the restaurant industry, simplifying the process of integrating, consolidating, and managing data from various sources The API enables streamlined data ingestion, transformation, and synchronization, empowering businesses to harness insights and improve efficiency.
\nKey Features:
\n- \n
Restaurant-centric data formats: Seamlessly integrate data from diverse sources
\n \nData transformation and enrichment: Clean, normalize, and enhance data with industry-specific functions, including menu categorization, sales aggregation, and customer segmentation.
\n \n
To fetch the live menu from Restroworks first we have to get the tab type (Tab means Order Type Dine In / Takeaway / Delivery).
\nRestroworks customers have the provision that they can keep a different menu for takeaway and delivery as well. For that to fetch the menu first you have to identify the available tab type for the outlets. Once you get the details, only fetch the menu for Takeaway and Delivery. Sample Request and Response is shown below.
\nAPI Request to get tabs-
\nStaging URL :
\nGET http://18.140.214.202:9010/api/v1/online_order/deployment_tabs?customer_key=
Production URL :
\nGET http://posistapi.com/api/v1/online_order/deployment_tabs?customer_key=
Unqiue External Deployment Id (String)
\n","type":"text/plain"},"key":"customer_key","value":"<Now to fetch the live menu for Outlets users can follow the below request and can get the response for the same according to that they can make the menu live on their online ordering platform.
Response Parameters
\nTable 1: configuration > rules
\nTable 2: configuration > entities
\nTable 3: configuration > entities > levels
\nTable 4: configuration > entities > levels > categories
\nTable 5: configuration > entities > levels > categories > items
\nTable 6: configuration > rules > date
\nTable 7: configuration > rules > time
\nTable 8: configuration > rules > days
\nRestroworks supports four types of menu items:
\n- \n
- Normal Items \n
- Modifiers / Add-ons \n
- Variant Items \n
- Combo Items \n
Normal Items
\nNormal items, also known as basic items, are standalone items that do not have any modifiers or variants attached to them. These items can be ordered directly from the ordering platform and are not customizable.
\nModifiers / Add-ons
\nModifiers or add-ons refer to items that are offered as additional enhancements to the main items. Examples include extra cheese on a burger or extra toppings on a pizza.
\nVariant Items
\nVariant items are items that have specific sizes mapped to them. For example, a pizza may be available in three different sizes: regular, medium, and large. In this case, regular, medium, and large are the variant items for the pizza. The field hasVariant in the payload helps you identify the item as a variant item, and mapVariantItems provides the list of items mapped to the main item.
Combo Items
\nCombo items are a group of categories combined together and sold at a discounted price compared to the added amount of those items individually.
\nTypes of Combos Supported by Restroworks
\nRestroworks supports two types of combos: Basic Combos and Combos with an Upgrade Option.
\nBasic Combos: Basic combos refer to combo items in which multiple categories are clubbed together with different groups. For example, a combo named \"Value Meal\" offers a customer the option to choose from three groups: Burgers, Sides, and Beverages.
\nRefer to the following flow for a detailed understanding of basic combos:
\nIn the above example:
\n- \n
- Value Meal: This is the name of the combo item. \n
- Burger, Sides, Beverages: These are the groups that the customer will choose from. \n
- Classic burgers…soft drinks: These are the categories from the respective group to select from. \n
- Below categories, we have the items. \n
A possible combo item here can be: Egg Fry Burger + Crinkle Fries + Pepsi. There can be different permutations and combinations based on the available items.
\nCombos with Upgrade Functionality
\nCombos with upgrade functionality are items that offer the possibility to upgrade some of the items to a different category while still providing the customer with a profitable deal. This allows for more customization within the combo and an enhanced customer experience.
\nIn the above example, suppose the customer is offered the option to upgrade the combo from Beverages to Shakes:
\nThe possible combo in this case would be:
\n- \n
- Egg Fry Burger + Crinkle Fries + Shake \n
How Does Upgrade Affect the Price of the Combo?
\nWhen a merchant offers an upgrade to the customer, it affects the main price of the item. This could be a fixed change or a proportionate change.
\nHow does Restroworks handle this price change?
\nRestroworks offers two functionalities:
\n- \n
- Price Change \n
- Differential Price \n
What is Price Change?
\nPrice Change occurs when the price of the combo changes by a fixed amount over the main combo price. For example, in the first example, the price of the combo was:
\n- \n
- Egg Fry Burger + Crinkle Fries + Pepsi - Rs. 400 (If the combo is upgraded, then the price will change by Rs. 50) \n
When the combo is upgraded to:
\n- \n
- Egg Fry Burger + Crinkle Fries + Shake \n
With the Price Change functionality enabled, the updated price will be Rs. 450, which will be sent by the partner.
\nWhat is Differential Price?
\nDifferential Price refers to the price change where the base price of the combo changes with respect to the upgraded item. Instead of a fixed amount, the price adjustment is based on the difference in price between the original and upgraded items, allowing for more flexibility in pricing when offering upgrades.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Tab Type (String)
\n","type":"text/plain"},"key":"tabtype","value":"delivery"},{"description":{"content":"Unqiue External Deployment Id (String)
\n","type":"text/plain"},"key":"customer_key","value":"<The last date-time when you synced the menu items.
\n","type":"text/plain"},"key":"lastSyncTime","value":"Epoch Timestamp"},{"description":{"content":"The current date-time of your server. Only items that have been updated, added or deleted before currentSyncTime and after lastSyncTime will be returned. Deleted items will also have a flag isDeleted:true.
\n","type":"text/plain"},"key":"currentSyncTime","value":"Epoch Timestamp"},{"description":{"content":"ID of the tab from outlet tabs API
\n","type":"text/plain"},"key":"tabId","value":"REQUEST
\nResponse
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"This API Is used to push an Online Order into Restroworks System
\nREQUEST FORMAT
\nITEMS TABLE
\nNested Keys for AddOns (both in \"items\" and \"mapComboItems\"):
\nNote that the \"addOns\" structure is the same for both \"items\" and \"mapComboItems\".
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Unqiue External Deployment Id (String)
\n","type":"text/plain"},"key":"customer_key","value":"<REQUEST
\nHere's a breakdown of each of the query parameters:
\nJSON BODY
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"New Menu Structure with new entities.
\nTable: categories
\nTable: extra (within categories)
\nTable: subCategories
\nTable: extra (within subCategories)
\nTable: entities
\n![https://itemsposistnet.s3.ap-south-1.amazonaws.com/common_image/image_jpg.jpeg](\"https://itemsposistnet.s3.ap-south-1.amazonaws.com/common_image/image_jpg.jpeg\"){kind=link}
![https://itemsposistnet.s3.ap-south-1.amazonaws.com/common_image/image_png.png](\"https://itemsposistnet.s3.ap-south-1.amazonaws.com/common_image/image_png.png\"){kind=link}
Table: nutritionalInfo (within entities)
\nTable: taxes (within entities)
\nTable: tableTab (within entities)
\nTable: _extra (within entities)
\nTable: swiggyNutritionInfo (within entities)
\nTable: servingSize (within entities)
\nTable: shelfLife (within entities)
\nTable: piecesPerKg (within entities)
\nTable: modifiers (main level)
\nTable: constituentItems (within modifiers)
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"For customers to order on any web ordering platform (Restroworks Online ordering partners), Restroworks provides API’s to be integrated with POS backend for seamless customer and cashier experience. The API’s allows the retailer to directly accept the order on POS and no need to visit any third-party application to accept the orders. It can also provide the status of events like order acceptance, food in preparation, food ready, food delivered etc back to the customer as well. The API details is explained in the document below. The document also provides best practices to be followed for ideal customer and cashier experience.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"This hook will notify the integrated partner whenever a delivery order is assigned to a delivery boy from POS.
\n{\n customer_key: \"Uzxcvbnmlkjhgfdsa123456789\",\n merchant_id: \"(if specified) 123456789poiuytrewq\",\n customer_mobile: \"8586936365\",\n customer_address: \"63/12 Kirti Nagar\",\n customer_locality: \"Rama Road\",\n customer_name: \"Rajat Sharma\",\n order_id: \"bcba78b6-b620-688c-1d75-da3bb2ab1ab6-74f26dbe-049e-4547d2fed033-3\",\n bill_amount: 800,\n order_number: 12,\n restaurant_name: \"Starvin Marvin\",\n restaurant_address: \"23 Gurgaon\",\n delivery_boy_name: \"Kshitij\",\n delivery_boy_mobile: \"8586053807\" \n}\n\nThis api is used to assgin delviery person to an order.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"This api is used to update order status when delivery gets accepted by delviery person.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"This api is used to update order when it is rejected by delivery person.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"This api is used to update order status when delivery person picks up the order
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"This api used to send a tracking url to order dashboard in POS.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"The Delivery Integration API is a robust and adaptable solution designed to optimize delivery operations for businesses in the restaurant industry. By connecting with multiple delivery service providers, this API streamlines order dispatching, real-time tracking, and delivery management, enhancing overall customer satisfaction and operational efficiency.
\nKey Features:
\n- \n
- Multi-provider support: Integrate with various delivery service providers, enabling centralized management of all delivery operations from a single platform. \n
- Real-time tracking: Monitor delivery progress with live updates, providing accurate and timely information to both your team and your customers. \n
This API is called to fetch the customer loyalty point / coupons informations associated with that mobile number
\nRequest Payload
\n{\n \"customer_key\": \"<customer key>\",\n \"customer_mobile\": \"9999999999\",\n \"customer_loyalty_id\": \"\",\n \"country_code\": \"+91\",\n \"countrycode\": \"+91\",\n \"table_number\": 3,\n \"customerMetaData\": {\n \"firstname\": \"kshitij\",\n \"lastname\": \"agrawal\",\n \"email\": \"kshitij@restroworks.com\",\n \"customer_loyalty_id\":\"19846464\",\n \"mobile\":\"8586053807\"\n }\n}\n\nPayload Mapping
\nSupported Success Response
\n{\n \"status_code\": 200,\n \"response\": {\n \"customerMetaData\": {\n \"firstname\": \"KSHITIJ\",\n \"lastname\": \"AGRAWAL\",\n \"email\": \"kshitij@restroworks.com\"\n },\n \"loyalty_points\": 10000,\n \"allow_redemption_today\": true,\n \"min_bill_for_redemption\": 100,\n \"redemption_cap_on_max_bill_percentage\": 30,\n \"coupons\": [\n {\n \"coupon_name\": \"Act now & save Rs.300 on your Valentine’s Day Dinner\",\n \"coupon_code\": \"300OFF\",\n \"discount_on\": \"bill\",\n \"discount_type\": \"percentage\",\n \"discount_value\": 80,\n \"max_discount\": \"100\",\n \"special_offer\": false,\n \"extra_fields\": [\n {\n \"name\": \"Reward Type\",\n \"value\": \"Promotion\"\n }\n ]\n },\n {\n \"coupon_name\": \"200₹ off on entire purchase\",\n \"coupon_code\": \"200OFF\",\n \"discount_on\": \"bill\",\n \"discount_type\": \"fixed\",\n \"min_bill_amount_for_redemption\": \"\",\n \"discount_value\": 200,\n \"special_offer\": false,\n \"extra_fields\": [\n {\n \"name\": \"Points Value\",\n \"value\": 1000\n },\n {\n \"name\": \"Reward Type\",\n \"value\": \"LoyaltyPointTier\"\n }\n ]\n },\n {\n \"coupon_name\": \"10% off on entire purchase\",\n \"coupon_code\": \"10PERCENT\",\n \"discount_on\": \"bill\",\n \"discount_type\": \"percentage\",\n \"discount_value\": 10,\n \"special_offer\": false,\n \"max_discount\": 100,\n \"extra_fields\": [\n {\n \"name\": \"Points Value\",\n \"value\": 5000\n },\n {\n \"name\": \"Reward Type\",\n \"value\": \"LoyaltyPointTier\"\n }\n ]\n },\n {\n \"coupon_name\": \"10 OFF\",\n \"coupon_code\": \"10OFF\",\n \"discount_type\": \"offer\",\n \"offer_name\": \"15% discount on Burgers\",\n \"special_offer\": false,\n \"authentication\": false,\n \"extra_fields\": [\n {\n \"name\": \"Points Value\",\n \"value\": 1000\n },\n {\n \"name\": \"Reward Type\",\n \"value\": \"LoyaltyPointTier\"\n }\n ]\n },\n {\n \"coupon_name\": \"10 OFF\",\n \"coupon_code\": \"10OFF\",\n \"discount_type\": \"offer\",\n \"offer_loyalty_id\": \"vtg562ndgakfye\",\n \"special_offer\": false,\n \"authentication\": false,\n \"extra_fields\": [\n {\n \"name\": \"Points Value\",\n \"value\": 1000\n },\n {\n \"name\": \"Reward Type\",\n \"value\": \"LoyaltyPointTier\"\n }\n ]\n }\n ]\n }\n}\n\nSuccess Response Mapping
\nSupported Failure Response
\njsonCopy code{\n \"status_code\": 400,\n \"response\": {\n \"message\": \"Cannot find customer for provided mobile/external-id/e-mail/id\"\n }\n}\n\nFailure Response Mapping
\n","urlObject":{"protocol":"http","host":["yourapi","endpoint","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"fe41d47e-fecf-47b8-993e-7cbd4c96d051"},{"name":"POS customer Details","id":"f18ee21f-1b4f-41cc-9561-d1ab773f4594","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"customer\": {\n \"name\": \"Rajat\",\n \"mobile\": \"8586936365\",\n \"address\": \"test1test2\",\n \"email\": \"\",\n \"city\": \"Jgd\",\n \"dob\": \"\"\n },\n \"merchant_id\": \"partner side merchant id\",\n \"customer_key\": \"your cutsomer key\"\n}","options":{"raw":{"language":"json"}}},"url":"http://yourapi.endpoint.url","description":"Need to develop web-hook for POSSIT POS customer Add events which will call Partner’s Customer Add API and get the required fields from API response to send the response back to POS.
\nRequest Payload
\n{\n \"customer\": {\n \"name\": \"Customer name\",\n \"mobile\": \"9999999999\",\n \"address\": \"test1test2\",\n \"email\": \"\",\n \"city\": \"Jgd\",\n \"dob\": \"\"\n },\n \"merchant_id\": \"partner side merchant id\",\n \"customer_key\": \"your customer key\"\n}\n\nPayload Mapping
\nSupported Success Response
\n{\n \"status_code\": 200,\n \"response\": {\n \"message\": \"Customer successfully captured\"\n }\n}\n\nSupported Failure Response
\n{\n \"status_code\": 400,\n \"response\": {\n \"message\": \"Message explaining the error\"\n }\n}\n\nFailure Response Mapping
\n","urlObject":{"protocol":"http","host":["yourapi","endpoint","url"],"query":[],"variable":[]}},"response":[],"_postman_id":"f18ee21f-1b4f-41cc-9561-d1ab773f4594"},{"name":"Authenticate points redemption","id":"2a42219e-dc64-4030-9a6a-90cef641313c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"customer_mobile\": \"8586936365\",\n \"points\": 10,\n \"purpose\": \"redeem_loyalty_points\",\n\t\"transaction\": {\n \"id\": \"52300058-216e-b9ba-cca5-d1c91bc7c5ac-edc6423c-be4e-61df9ac942e8-128\",\n \"items\": [\n {\n \"name\": \"Oats Crusted Baked Chicken\",\n \"id\": \"598af2379165e15030b7ca13\",\n \"rate\": 200,\n \"quantity\": 1,\n \"subtotal\": 200,\n \"category\": \"SINGLE TACO\"\n },\n {\n \"name\": \"PULLED PORK\",\n \"id\": \"594128886f2367ec00e8343c\",\n \"rate\": 150,\n \"quantity\": 1,\n \"subtotal\": 150,\n \"category\": \"SINGLE TACO\"\n }\n ],\n \"gross_amount\": 434,\n \"amount\": 434,\n \"type\": \"DINE-IN\",\n \"number\": \"T1-128\"\n },\n\t\"merchant_id\": \"partner side merchant id\",\n\t\"customer_key\": \"partner customer key\"\n}","options":{"raw":{"language":"json"}}},"url":"http://yourapi.endpoint.com","description":"Request Payload
\n{\n \"customer_mobile\": \"8586936365\",\n \"points\": 10,\n \"purpose\": \"redeem_loyalty_points\",\n \"transaction\": {\n \"id\": \"52300058-216e-b9ba-cca5-d1c91bc7c5ac-edc6423c-be4e-61df9ac942e8-128\",\n \"items\": [\n {\n \"name\": \"Oats Crusted Baked Chicken\",\n \"id\": \"598af2379165e15030b7ca13\",\n \"rate\": 200,\n \"quantity\": 1,\n \"subtotal\": 200,\n \"category\": \"SINGLE TACO\"\n },\n {\n \"name\": \"PULLED PORK\",\n \"id\": \"594128886f2367ec00e8343c\",\n \"rate\": 150,\n \"quantity\": 1,\n \"subtotal\": 150,\n \"category\": \"SINGLE TACO\"\n }\n ],\n \"gross_amount\": 434,\n \"amount\": 434,\n \"type\": \"DINE-IN\",\n \"number\": \"T1-128\"\n },\n \"merchant_id\": \"partner side merchant id\",\n \"customer_key\": \"partner customer key\"\n}\n\nSuccess Response
\n{\n \"status_code\": 200,\n \"response\": {\n \"points_value\": 10\n }\n}\n\nSuccess Response If the OTP is not required for the redemption request
\n{\n \"status_code\": 200,\n \"response\": {\n \"points_value\": 10,\n \"authentication\":false\n }\n}\n\nError Response
\n{\n \"status_code\": 400,\n \"response\": {\n \"message\": \"Customer does not have sufficient points\"\n }\n}\n\nRequest Payload
\n{\n \"customer_mobile\": \"8586936365\",\n \"points\": 10,\n \"otp\": \"123456\",\n \"transaction\": {\n \"id\": \"52300058-216e-b9ba-cca5-d1c91bc7c5ac-edc6423c-be4e-61df9ac942e8-128\",\n \"items\": [\n {\n \"name\": \"Oats Crusted Baked Chicken\",\n \"id\": \"598af2379165e15030b7ca13\",\n \"rate\": 200,\n \"quantity\": 1,\n \"subtotal\": 200,\n \"category\": \"SINGLE TACO\"\n },\n {\n \"name\": \"PULLED PORK\",\n \"id\": \"594128886f2367ec00e8343c\",\n \"rate\": 150,\n \"quantity\": 1,\n \"subtotal\": 150,\n \"category\": \"SINGLE TACO\"\n }\n ],\n \"gross_amount\": 434,\n \"amount\": 434,\n \"type\": \"DINE-IN\",\n \"number\": \"T1-128\"\n },\n \"merchant_id\": \"partner side merchant id\",\n \"customer_key\": \"partner customer key\"\n}\n\nSuccess Response
\n{\n \"status_code\": 200,\n \"response\": {\n \"points_value\": 10\n }\n}\n\nError Response
\n{\n status_code:400, //any status code other than 200\n response:{\n message:\"Customer does not have sufficient points\" //Message explaining error\n }\n\nThe supported payload for this API request includes a JSON object with the following fields:
\n- \n
\nmerchant_id(string): A unique identifier for the merchant associated with the transaction. \n
\nmerchant_username(string): The login ID of the merchant associated with the transaction. \n
\ncustomer_key(string): A unique key that identifies the customer associated with the transaction. \n
\ncustomer(object): An object containing details about the customer associated with the transaction, including name, mobile, address, email, city, state, and dob. \n
\ntransaction(object): An object containing details about the transaction, including the transaction ID, transaction number, bill link (URL to bill pdf), transaction type, payment type, gross amount, net amount, amount, discount, order time, online bill source, redemption details (redeemed amount and reward ID), items (an array of objects containing details about each item in the transaction, including name, ID, rate, quantity, subtotal, and category), taxes (an array of objects containing details about each tax applied to the transaction, including name and amount), and charges (an array of objects containing details about each additional charge applied to the transaction, including name and amount). \n
1. Top-Level Keys
\n\n
2. customer Object
\n\n
3. transaction Object
\n\n
3.1 transaction.redemption Object
\n\n
3.2 transaction.items (Array of Objects)
\nEach item:
\n\n
3.3 transaction.taxes (Array of Objects)
\n\n
3.4 transaction.charges (Array of Objects)
\n\n
4. transaction.payments Object
\n4.1 transaction.payments.cards (Array of Objects)
\n4.1.1 cards[].detail (Array of Objects)
\n- \n
For DebitCard/CreditCard:
\n- \n
\namount(number) \n
\nbankName(string) \n
\nbankType(string) \n
\nFor Other:
\n- \n
\namount(number) \n
\notherName(string) \n
\nFor Coupon:
\n- \n
\namount(number) \n
\ncouponName(string) \n
\n
Sample Request
\n{\n \"customer_key\": \"YOUR_CUSTOMER_KEY\",\n \"merchant_id\": \"132\",\n \"merchant_username\": \".\",\n \"coupon_code\": \"\",\n \"country_code\": \"+91\",\n \"countrycode\": \"+91\",\n \"customer\": {\n \"name\": \"kshitij\",\n \"countrycode\": \"+91\",\n \"mobile\": \"9898989898\",\n \"address\": \" \",\n \"email\": \"kshitij@posist.com\",\n \"city\": \"Chandigarh Region 5\",\n \"dob\": \"\",\n \"anniversary_date\": \"\",\n \"state\": \"Chandigarh\"\n },\n \"transaction\": {\n \"id\": \"c079735c-4f2e-2145-425e-c9e72d679548-26ad8ce8-efca-fa696a95077e-22\",\n \"number\": \"FUDR--22\",\n \"type\": \"Dine In\",\n \"tabName\": \"TAKE AWAY\",\n \"payment_type\": \"Cash,DebitCard,CreditCard,Quick Wallet,Sodexo\",\n \"coupon_code\": \"\",\n \"bill_tender_type\": [\n \"Cash\",\n \"DebitCard\",\n \"CreditCard\",\n \"Quick Wallet\",\n \"Sodexo\"\n ],\n \"gross_amount\": 348,\n \"net_amount\": 316,\n \"amount\": 348,\n \"discount\": 0,\n \"redemption\": {\n \"redeemed_amount\": 0,\n \"reward_id\": \"\"\n },\n \"order_time\": \"2025-02-14 13:37:51\",\n \"items\": [\n {\n \"name\": \"ST Paneer Hot\",\n \"id\": \"5f1ac4f79f9adca6122a576b\",\n \"_id\": \"5f1ac9ca9f9adca6122a5a5d\",\n \"rate\": 79,\n \"quantity\": 1,\n \"subtotal\": 79,\n \"discount\": 0,\n \"billDiscountAmount\": 0,\n \"category\": \"SOFT TACOS VEG\",\n \"superCategory\": \"TACO\",\n \"addOns\": []\n },\n {\n \"name\": \"Soft Panner Med\",\n \"id\": \"5f1ac4f79f9adca6122a576a\",\n \"_id\": \"5f1ac9ca9f9adca6122a5a61\",\n \"rate\": 79,\n \"quantity\": 1,\n \"subtotal\": 79,\n \"discount\": 0,\n \"billDiscountAmount\": 0,\n \"category\": \"SOFT TACOS VEG\",\n \"superCategory\": \"TACO\",\n \"addOns\": []\n },\n {\n \"name\": \"Soft Bean Hot\",\n \"id\": \"5f1ac4f69f9adca6122a5765\",\n \"_id\": \"5f1ac9ca9f9adca6122a5a5e\",\n \"rate\": 79,\n \"quantity\": 1,\n \"subtotal\": 79,\n \"discount\": 0,\n \"billDiscountAmount\": 0,\n \"category\": \"SOFT TACOS VEG\",\n \"superCategory\": \"TACO\",\n \"addOns\": []\n },\n {\n \"name\": \"Soft Bean Med\",\n \"id\": \"5f1ac4f69f9adca6122a5763\",\n \"_id\": \"5f1ac9ca9f9adca6122a5a60\",\n \"rate\": 79,\n \"quantity\": 1,\n \"subtotal\": 79,\n \"discount\": 0,\n \"billDiscountAmount\": 0,\n \"category\": \"SOFT TACOS VEG\",\n \"superCategory\": \"TACO\",\n \"addOns\": []\n }\n ],\n \"addOns\": [],\n \"comboItems\": [],\n \"taxes\": [\n {\n \"name\": \"GST@5%\",\n \"amount\": 15.8\n }\n ],\n \"charges\": [\n {\n \"name\": \"Packing Charges\",\n \"amount\": 15.8\n }\n ],\n \"points_redeemed\": 0,\n \"online_bill_source\": \"\",\n \"source_order_id\": \"\",\n \"table_number\": null,\n \"waiter\": null,\n \"delivery_boy\": null,\n \"covers\": null,\n \"do_not_award_points\": false,\n \"payments\": {\n \"cash\": [\n 45\n ],\n \"cards\": [\n {\n \"cardType\": \"DebitCard\",\n \"totalAmount\": 80,\n \"detail\": [\n {\n \"amount\": 35,\n \"bankName\": \"Axis Bank\",\n \"bankType\": \"VISA\"\n },\n {\n \"amount\": 45,\n \"bankName\": \"Axis Bank\",\n \"bankType\": \"MASTER\"\n }\n ]\n },\n {\n \"cardType\": \"CreditCard\",\n \"totalAmount\": 23,\n \"detail\": [\n {\n \"amount\": 23,\n \"bankName\": \"Axis Bank\",\n \"bankType\": \"VISA\"\n }\n ]\n },\n {\n \"cardType\": \"Other\",\n \"totalAmount\": 162,\n \"detail\": [\n {\n \"amount\": 162,\n \"otherName\": \"Quick Wallet\"\n }\n ]\n },\n {\n \"cardType\": \"Online\",\n \"totalAmount\": 0,\n \"detail\": []\n },\n {\n \"cardType\": \"Coupon\",\n \"totalAmount\": 38,\n \"detail\": [\n {\n \"amount\": 38,\n \"couponName\": \"Sodexo\"\n }\n ]\n },\n {\n \"cardType\": \"BTC\",\n \"totalAmount\": 0,\n \"detail\": []\n },\n {\n \"cardType\": \"SmartCard\",\n \"totalAmount\": 0,\n \"detail\": []\n }\n ]\n }\n }\n}\n\nExpected Response
\n{\n \"status_code\": 200,\n \"response\": {\n \"message\":\"Bill successfully captured\"\n }\n}\n\nSupported Payload
\nThe supported payload for this API request includes a JSON object with the following fields:
\n- \n
\ncustomer_key(string): A unique key that identifies the customer associated with the coupon. \n
\nmerchant_id(string): A unique identifier for the merchant associated with the coupon. \n
\ncoupon_code(string): The code of the coupon being applied. \n
\ncustomer_mobile(string): The mobile number of the customer associated with the coupon. \n
Sample Request
\n{\n \"customer_key\": \"e3ea9dda396ef774f976bd61ec4e99983\",\n \"merchant_id\": \"abcd\",\n \"coupon_code\": \"1234\",\n \"customer_mobile\": \"8586936365\"\n}\n\nExpected Response
\nFor Percentage based coupon:
\n{\n \"status_code\":200,\n \"response\":{\n \"coupon_name\": \"10%OFF\",\n \"coupon_code\": \"10OFF\",\n \"discount_on\":\"bill\", \n \"discount_type\":\"percent\", \n \"discount_value\":10, \n \"comment\":\"10 % discount on bill applied\"\n }\n}\n\nFor Amount based coupon:
\n{\n \"status_code\":200,\n \"response\":{\n \"coupon_name\": \"10 OFF\",\n \"coupon_code\": \"10OFF\",\n \"discount_on\":\"bill\", \n \"discount_type\":\"fixed\", \n \"discount_value\":10, \n \"comment\":\"10 % discount on bill applied\"\n }\n}\n\nFor conditions based coupon (By name):
\n{\n \"status_code\":200,\n \"response\":{\n \"coupon_name\": \"10 OFF\",\n \"coupon_code\": \"10OFF\",\n \"discount_type\":\"offer\", \n \"offer_name\":\"15% discount on Burgers\", \n \"special_offer\":false, \n \"authentication\":false\n }\n}\n\nFor conditions based coupon (By loyalty id):
\n{\n \"status_code\":200,\n \"response\":{\n \"coupon_name\": \"10 OFF\",\n \"coupon_code\": \"10OFF\",\n \"discount_type\":\"offer\", \n \"offer_loyalty_id\":\"vtg562ndgakfye\", \n \"special_offer\":false, \n \"authentication\":false\n }\n}\n\nExpected Error Response
\nIf the coupon code is invalid or the customer is not eligible for the coupon, the API will return an error response with an appropriate status code and error message. The format of the error response will be similar to the following:
\n{\n \"status_code\":400,\n \"response\":{\n \"message\":\"Invalid coupon code\"\n }\n}\n\nSupported Payload
\nThe supported payload for this API request includes a JSON object with the following fields:
\n- \n
customer_key(string): A unique key that identifies the customer associated with the coupon. \nmerchant_id(string): A unique identifier for the merchant associated with the coupon. \ncoupon_code(string): The code of the coupon being applied. \ncustomer_mobile(string): The mobile number of the customer associated with the coupon. \nbill_number(string): The number of the bill to which the coupon is being applied. \n
Sample Request
\n{\n \"customer_key\": \"e3ea9dda396ef774f976bd61ec4e9998\",\n \"merchant_id\": \"abcd\",\n \"coupon_code\": \"1234\",\n \"customer_mobile\": \"8586936365\",\n \"bill_number\":\"T1-240\"\n}\n\nExpected Success Response
\n{\n \"status_code\": 200,\n \"response\": {\n \"message\":\"Coupon successfully redeemed.\"\n }\n}\n\nExpected Error Response
\nIf the coupon code is invalid, the customer is not eligible for the coupon, or the coupon has already been redeemed for the specified bill, the API will return an error response with an appropriate status code and error message. The format of the error response will be similar to the following:
\n{\n \"status_code\":400,\n \"response\":{\n \"message\":\"Invalid coupon code\"\n }\n}\n\nFor end customers to avail the loyalty benefits – Posist customers or users or any third-party
application can be integrated with Posist for that Posist provides the API’s to be integrated with
POS backend for seamless customer and cashier experience. The API’s allows the retailer or
user to register customers as a loyalty customer, redeem their loyalty points, provide loyalty
benefits to the end user or in some cases redeem the coupon from loyalty partners as well.
Screeshot of the POS Portal how Loyalty Coupon & Points will be visible
\nHTTP/1.1 200 OK\n[\n {\n \"_id\": \"5c654f04a9a18e37a1cfaeaa\",\n \"category\": {\n \"superCategory\": {\n \"superCategoryName\": \"Lebanese Food\",\n \"_id\": \"5c4d74dadce7800b7ef789b6\"\n },\n \"categoryName\": \"Drinks\",\n \"_id\": \"5c4c6a7c956181237ef47586\"\n },\n \"isAddOn\": false,\n \"isCombo\": false,\n \"taxes\": [\n {\n \"_id\": \"5c65059921b8a5b624ae3c48\",\n \"name\": \"VAT\",\n \"value\": 5,\n \"type\": \"percent\",\n \"cascadingTaxes\": []\n },\n {\n \"_id\": \"5c65059921b8a5b624ae3c49\",\n \"name\": \"Cess\",\n \"value\": 1,\n \"type\": \"percent\",\n \"cascadingTaxes\": [\n {\n \"_id\": \"5c65059921b8a5b624ae3c48\",\n \"name\": \"VAT\",\n \"value\": 5,\n \"type\": \"percent\",\n }\n ]\n }\n ],\n \"preparationTime\": {\n \"time\": 1\n },\n \"mapItems\": [\n {\n _id: \"5c4dd057dce7800b7ef78a2d\"\n }\n ],\n \"itemVariants\": [\n {\n _id: \"5c6648450df8c5e4099488bd\",\n name: \"Small\"\n },\n {\n _id: \"5c6648450df8c5e4099488bg\",\n name: \"Large\"\n }\n ],\n \"status\": \"ACTIVE\",\n \"rate\": 6.67,\n \"name\": \"7Up\"\n },\n {\n \"_id\": \"5c65449b21b8a5b624ae3c9a\",\n \"preparationTime\": {\n \"time\": 1\n },\n \"rate\": 42.86,\n \"description\": \"Our delicious Tawook marinated chicken breast, melted cheddar cheese, pickles with buffalo sauce and mayo in a french baguette with fries and beverage.\",\n \"configuration\": {\n \"entities\": [\n {\n \"levels\": [\n {\n \"categories\": [\n {\n \"items\": [\n {\n \"category_id\": \"5c4c6a7c956181237ef47586\",\n \"_id\": \"5c4d4dd9d99017117e5652c7\",\n \"name\": \"Sprite\"\n },\n {\n \"category_id\": \"5c4c6a7c956181237ef47586\",\n \"_id\": \"5c4d4dccdce7800b7ef78942\",\n \"name\": \"Coca Cola\"\n },\n {\n \"category_id\": \"5c4c6a7c956181237ef47586\",\n \"_id\": \"5c4c6a9adce7800b7ef78928\",\n \"name\": \"Diet Coke\"\n },\n {\n \"category_id\": \"5c4c6a7c956181237ef47586\",\n \"_id\": \"5c4c6a87d99017117e5652b6\",\n \"name\": \"Coke Zero\"\n },\n {\n \"category_id\": \"5c4c6a7c956181237ef47586\",\n \"_id\": \"5c51b34ec30ce87b75a556a2\",\n \"name\": \"Water\"\n },\n {\n \"category_id\": \"5c4c6a7c956181237ef47586\",\n \"_id\": \"5c654e1321b8a5b624ae3cb0\",\n \"name\": \"Pepsi\"\n },\n {\n \"category_id\": \"5c4c6a7c956181237ef47586\",\n \"_id\": \"5c654e1d93721ea424871770\",\n \"name\": \"Diet Pepsi\"\n },\n {\n \"category_id\": \"5c4c6a7c956181237ef47586\",\n \"_id\": \"5c654e28d1b664b02457e2f7\",\n \"name\": \"7Up\"\n },\n {\n \"category_id\": \"5c4c6a7c956181237ef47586\",\n \"_id\": \"5c654e3093721ea424871771\",\n \"name\": \"Diet 7Up\"\n },\n {\n \"category_id\": \"5c4c6a7c956181237ef47586\",\n \"_id\": \"5c654e3a21b8a5b624ae3cb1\",\n \"name\": \"Mirinda\"\n }\n ],\n \"categoryName\": \"Drinks\",\n \"_id\": \"5c4c6a7c956181237ef47586\"\n }\n ],\n \"priceChange\": 0,\n \"name\": \"base\"\n }\n ],\n \"minQuantity\": 1,\n \"maxQuantity\": 1,\n \"name\": \"Choose Drinks\"\n },\n {\n \"levels\": [\n {\n \"categories\": [\n {\n \"items\": [\n {\n \"category_id\": \"5c4c3a2483e40a1d7ebc97dd\",\n \"_id\": \"5c4c6021dce7800b7ef788e7\",\n \"name\": \"French fries\"\n }\n ],\n \"categoryName\": \"Appetizers\",\n \"_id\": \"5c4c3a2483e40a1d7ebc97dd\"\n }\n ],\n \"priceChange\": 0,\n \"name\": \"base\"\n }\n ],\n \"minQuantity\": 0,\n \"maxQuantity\": 5,\n \"name\": \"Choose Appetizers\"\n },\n {\n \"levels\": [\n {\n \"categories\": [\n {\n \"items\": [\n {\n \"category_id\": \"5c4d756f956181237ef4761d\",\n \"_id\": \"5c4d75d6dce7800b7ef789bc\",\n \"name\": \"Dynamite Dip\"\n },\n {\n \"category_id\": \"5c4d756f956181237ef4761d\",\n \"_id\": \"5c4d75c983e40a1d7ebc98c1\",\n \"name\": \"Buffalo Dip\"\n },\n {\n \"category_id\": \"5c4d756f956181237ef4761d\",\n \"_id\": \"5c4d75bed99017117e56533c\",\n \"name\": \"BBQ Dip\"\n },\n {\n \"category_id\": \"5c4d756f956181237ef4761d\",\n \"_id\": \"5c4d75b5dce7800b7ef789b9\",\n \"name\": \"Cheddar Cheese\"\n },\n {\n \"category_id\": \"5c4d756f956181237ef4761d\",\n \"_id\": \"5c4d75a783e40a1d7ebc98c0\",\n \"name\": \"Chilli Paste\"\n },\n {\n \"category_id\": \"5c4d756f956181237ef4761d\",\n \"_id\": \"5c4d759e956181237ef4761f\",\n \"name\": \"Garlic Dip\"\n }\n ],\n \"categoryName\": \"Add A Dip\",\n \"_id\": \"5c4d756f956181237ef4761d\"\n }\n ],\n \"priceChange\": 0,\n \"name\": \"base\"\n }\n ],\n \"differentialPrice\": true,\n \"minQuantity\": 0,\n \"maxQuantity\": 100,\n \"name\": \"Choose Dips\"\n },\n {\n \"levels\": [\n {\n \"categories\": [\n {\n \"items\": [\n {\n \"category_id\": \"5c4d7f46d99017117e565352\",\n \"_id\": \"5c4da114956181237ef47652\",\n \"name\": \"Coleslaw on Side\"\n },\n {\n \"category_id\": \"5c4d7f46d99017117e565352\",\n \"_id\": \"5c4da0f083e40a1d7ebc98fd\",\n \"name\": \"Onion Rings on Side\"\n },\n {\n \"category_id\": \"5c4d7f46d99017117e565352\",\n \"_id\": \"5c4da0dbd99017117e565367\",\n \"name\": \"Hummus on Side\"\n },\n {\n \"category_id\": \"5c4d7f46d99017117e565352\",\n \"_id\": \"5c6555674533829e24a46a8e\",\n \"name\": \"Pickles\"\n }\n ],\n \"categoryName\": \"Goes Well With\",\n \"_id\": \"5c4d7f46d99017117e565352\"\n },\n {\n \"items\": [\n {\n \"category_id\": \"5c4c3a2483e40a1d7ebc97dd\",\n \"_id\": \"5c65474521b8a5b624ae3ca9\",\n \"name\": \"Tawook Poppers\"\n },\n {\n \"category_id\": \"5c4c3a2483e40a1d7ebc97dd\",\n \"_id\": \"5c4c3a5883e40a1d7ebc97de\",\n \"name\": \"Hummus\"\n },\n {\n \"category_id\": \"5c4c3a2483e40a1d7ebc97dd\",\n \"_id\": \"5c65475c21b8a5b624ae3caa\",\n \"name\": \"Cheese Rolls\"\n },\n {\n \"category_id\": \"5c4c3a2483e40a1d7ebc97dd\",\n \"_id\": \"5c4c605083e40a1d7ebc9801\",\n \"name\": \"Onion Rings\"\n }\n ],\n \"categoryName\": \"Appetizers\",\n \"_id\": \"5c4c3a2483e40a1d7ebc97dd\"\n },\n {\n \"items\": [\n {\n \"category_id\": \"5c4c67f683e40a1d7ebc9820\",\n \"_id\": \"5c654de821b8a5b624ae3caf\",\n \"name\": \"Oreo Cheese Cake\"\n },\n {\n \"category_id\": \"5c4c67f683e40a1d7ebc9820\",\n \"_id\": \"5c654df5d1b664b02457e2f6\",\n \"name\": \"Nutella Eclair\"\n }\n ],\n \"categoryName\": \"Desserts\",\n \"_id\": \"5c4c67f683e40a1d7ebc9820\"\n }\n ],\n \"priceChange\": 0,\n \"name\": \"base\"\n }\n ],\n \"differentialPrice\": true,\n \"minQuantity\": 0,\n \"maxQuantity\": 100,\n \"name\": \"Choose Sides\"\n },\n {\n \"levels\": [\n {\n \"categories\": [\n {\n \"items\": [\n {\n \"category_id\": \"5c4c3a2483e40a1d7ebc97dd\",\n \"_id\": \"5c556e13989ce1a0633f6b4e\",\n \"name\": \"Upsize Fries\"\n }\n ],\n \"categoryName\": \"Appetizers\",\n \"_id\": \"5c4c3a2483e40a1d7ebc97dd\"\n }\n ],\n \"priceChange\": 0,\n \"name\": \"base\"\n }\n ],\n \"differentialPrice\": true,\n \"minQuantity\": 0,\n \"maxQuantity\": 5,\n \"name\": \"Upsize Fries\"\n }\n ],\n \"rules\": {\n \"date\": {\n \"noRange\": true\n },\n \"time\": {\n \"noRange\": true\n },\n \"days\": [\n 0,\n 1,\n 2,\n 3,\n 4,\n 5,\n 6\n ],\n \"allDaysValid\": true,\n \"applyAddonsPrice\": true\n }\n },\n \"category\": {\n \"_id\": \"5c4c45b083e40a1d7ebc97e4\",\n \"categoryName\": \"Platters\",\n \"superCategory\": {\n \"superCategoryName\": \"Lebanese Food\",\n \"_id\": \"5c4d74dadce7800b7ef789b6\"\n }\n },\n \"isAddOn\": false,\n \"isCombo\": true,\n \"itemVariants\": [],\n \"itemNumber\": \"M000001\",\n \"name\": \"American Tawook Meal\",\n \"status\": \"ACTIVE\",\n \"taxes\": [\n {\n \"_id\": \"5c65059921b8a5b624ae3c48\",\n \"name\": \"VAT\",\n \"value\": 5,\n \"type\": \"percent\",\n \"cascadingTaxes\": []\n }\n ]\n }\n]\nUnique POS Id of a brand served by a particular kitchen.
\n","type":"text/plain"},"key":"customer_key","value":"HTTP/1.1 200 Created\n{\n \"__v\": 0,\n \"_id\": \"57a9756ccfa4221018e5193f\"\n} \n \n\nBODY
\n","urlObject":{"protocol":"http","port":"9010","path":["api","v1","online_order_cloud","update_order"],"host":["18","140","214","202"],"query":[{"key":"customer_key","value":"These are the online order APIs for our cloud kitchen product.
\n","_postman_id":"e0b8ff39-8136-451b-b7f9-ab10e029915b"},{"name":"Stock","item":[{"name":"Fetch Inventory Data","id":"ff674a74-126c-4d31-b3e1-a5a24428ba69","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"This API allows clients to fetch inventory data for a specific customer within a given date range, filtered by transaction types and entities such as purchase orders (PO) or stock transactions.
\nURL
\nGET http://18.140.214.202:9010/api/v1/pos/fetch_Inventory_data\n\nMethod
\nGET
Authentication
\nThis API requires Basic Authentication.
\n- \n
- Authorization header:
- \n
Authorization: Basic\n
\n
Query Parameters
\nRequest Headers
\nQuery Parameter Descriptions
\n- \n
customer_key:
\n- \n
This is required to authenticate the customer and identify which data should be fetched.
\n \nExample:
\nabc123. \n
\nentity:
\n- \n
Defines the type of data you are querying:
\n- \n
\ntransaction: For inventory transactions like stock entries, sales, etc. \n
\npo: For purchase orders. \n
\nExample:
\ntransaction. \n
\nfromDate / toDate:
\n- \n
These parameters define the date range for querying data.
\n \nExample:
\nfromDate=2024-09-01&toDate=2024-09-20. \n
\ntransactionType (Required if entity is
\ntransaction):- \n
This defines the type of transaction to fetch. Valid values are:
\n- \n
\nstock_entry\n
\nphysical_stock\n
\nvendor_return\n
\nwastage_entry\n
\nstock_opening\n
\nstock_transfer (upcoming)\n
\nfinished_entry (upcoming)\n
\nsemi_entry (upcoming)\n
\nstock_sale\n
\nExample:
\ntransactionType=stock_entry. \n
\nonlyLocalGRNs (Optional):
\n- \n
When set to
\ntrue, it only returns non-erp vendor transactions \nThis is relevant when
\ntransactionTypeisstock_entry. \nExample:
\nonlyLocalGRNs=true. \n
\n
Example Request
\ncurl --location 'http://18.140.214.202:9010/api/v1/pos/fetch_Inventory_data?customer_key=abc123&entity=transaction&fromDate=2024-09-01&toDate=2024-09-20&transactionType=stock_entry&onlyLocalGRNs=true' \\\n--header 'Authorization: Basic dG9rZW5IZXJl'\n\nResponses
\n1. Response for entity = transaction
\n{\n \"storeKitchen\": {\n \"type\": \"store\",\n \"name\": \"Main Store\",\n \"storeUID\": \"\"\n },\n \"actualDate\": \"2024-09-01T06:50:52.094Z\",\n \"batchNumber\": \"\",\n \"challan_id\": \"SE-254\",\n \"charges\": [],\n \"chargesTotal\": 0,\n \"daySerialNumber\": 1,\n \"deployment\": {\n \"isBaseKitchen\": false,\n \"name\": \"Test Outlet\"\n },\n \"discount\": {\n \"discountAmount\": 0,\n \"value\": 0,\n \"type\": \"percent\"\n },\n \"invoiceDate\": \"2024-08-31T23:19:21.000Z\",\n \"invoiceNumber\": \"9601238906\",\n \"isDirectIssue\": true,\n \"items\": [\n {\n \"subTotal\": 28.321,\n \"unitPrice\": 217.85,\n \"quantity\": 0.13,\n \"baseQuantity\": 130,\n \"type\": 1,\n \"basePrice\": 0.21785,\n \"itemName\": \"Spanish Corn & Mushroom Filling\",\n \"itemCode\": \"20077295\",\n \"unit\": {\n \"unitName\": \"KG\",\n \"conversionFactor\": 1000,\n \"baseUnit\": {\n \"name\": \"GRAM\",\n \"id\": 1\n }\n },\n \"category\": {\n \"categoryName\": \"Semi Proc\",\n \"supercategory\": {\n \"supercategoryName\": \"Semi Proc\"\n }\n },\n \"taxes\": []\n }\n ],\n \"subTotal\": 31952.471,\n \"totalTax\": 0,\n \"transactionDate\": \"2024-09-01T06:50:22.263Z\",\n \"transactionType\": 1,\n \"updated\": \"2024-09-01T06:50:52.383Z\",\n \"user\": {\n \"lastname\": \".\",\n \"firstname\": \"Manager\",\n \"username\": \"test_manager\"\n },\n \"vendor\": {\n \"isEnterpriseVendor\": true,\n \"vendorName\": \"Test Vendor\",\n \"vendorCode\": \"P8001\",\n \"state\": {\n \"name\": \"Haryana\",\n \"code\": \"in_hr\"\n }\n },\n \"storeCode\": \"8603\"\n}\n\n2. Response for entity = po
\n{\n \"_id\": \"36d38669exe9455b1b232v60\",\n \"charges\": [],\n \"chargesTotal\": 0,\n \"created\": \"2024-08-31T21:08:57.562Z\",\n \"deliveryAddress\": {\n \"same\": true,\n \"value\": \"Test address,\"\n },\n \"deployment\": {\n \"_id\": \"r607ae3389dc8ce31b78b1d2\",\n \"name\": \"Test Outlet\",\n \"gstin\": \"\",\n \"isBaseKitchen\": false\n },\n \"discountAmount\": 0,\n \"expectedDelivery\": \"2024-09-02T05:30:00.000Z\",\n \"isDeleted\": false,\n \"items\": [\n {\n \"totalReceiveTax\": 0,\n \"receiveSubtotal\": 120.14,\n \"baseReceiveQty\": 500,\n \"itemCode\": \"20077176\",\n \"itemName\": \"Thousand Dip-SFG\",\n \"category\": {\n \"categoryName\": \"Semi Proc\",\n \"supercategory\": {\n \"supercategoryName\": \"Semi Proc\"\n }\n },\n \"subtotal\": 120.14,\n \"baseQty\": 500,\n \"unit\": {\n \"conversionFactor\": 1000,\n \"unitName\": \"KG\",\n \"baseUnit\": {\n \"id\": 1,\n \"name\": \"GRAM\"\n }\n }\n }\n ],\n \"subtotal\": 37197.19,\n \"receiveSubtotal\": 30483.136,\n \"receiveDate\": \"2024-09-02T06:45:19.153Z\",\n \"poNumber\": 383,\n \"state\": {\n \"name\": \"Haryana\",\n \"code\": \"in_hr\"\n },\n \"vendor\":\n {\n \"vendorName\": \"Test Vendor\",\n \"vendorCode\": \"P8001\",\n \"state\": {\n \"name\": \"Haryana\",\n \"code\": \"in_hr\"\n }\n },\n \"storeCode\": \"8603\"\n}\n\nResponse Fields for transaction
\nResponse Fields for po
\nExample Error Responses
\nMissing or Invalid Parameters (400 Bad Request)
\n{\n \"status\": \"error\",\n \"message\": \"customer_key has not been provided\"\n}\n\nInvalid Transaction Type (400 Bad Request)
\n{\n \"status\": \"error\",\n \"message\": \"invalid transaction type\"\n}\n\nError Codes
\n\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"bcb56670-b28b-4bb3-8454-62209dcff1fd","name":"Transaction","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic dG9rZW5IZXJl"}],"url":{"raw":"http://18.140.214.202:9010/api/v1/pos/fetch_Inventory_data?customer_key=abc123&entity=transaction&fromDate=2024-09-01&toDate=2024-09-20&transactionType=stock_entry&onlyLocalGRNs=true","protocol":"http","host":["18","140","214","202"],"port":"9010","path":["api","v1","pos","fetch_Inventory_data"],"query":[{"key":"customer_key","value":"abc123"},{"key":"entity","value":"transaction"},{"key":"fromDate","value":"2024-09-01"},{"key":"toDate","value":"2024-09-20"},{"key":"transactionType","value":"stock_entry"},{"key":"onlyLocalGRNs","value":"true"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"storeKitchen\": {\n \"type\": \"store\",\n \"name\": \"Main Store\",\n \"storeUID\": \"\"\n },\n \"actualDate\": \"2024-09-01T06:50:52.094Z\",\n \"batchNumber\": \"\",\n \"challan_id\": \"SE-254\",\n \"charges\": [],\n \"chargesTotal\": 0,\n \"daySerialNumber\": 1,\n \"deployment\": {\n \"isBaseKitchen\": false,\n \"name\": \"Test Outlet\"\n },\n \"discount\": {\n \"discountAmount\": 0,\n \"value\": 0,\n \"type\": \"percent\"\n },\n \"invoiceDate\": \"2024-08-31T23:19:21.000Z\",\n \"invoiceNumber\": \"9601238906\",\n \"isDirectIssue\": true,\n \"items\": [\n {\n \"subTotal\": 28.321,\n \"unitPrice\": 217.85,\n \"quantity\": 0.13,\n \"baseQuantity\": 130,\n \"type\": 1,\n \"basePrice\": 0.21785,\n \"itemName\": \"Spanish Corn & Mushroom Filling\",\n \"itemCode\": \"20077295\",\n \"unit\": {\n \"unitName\": \"KG\",\n \"conversionFactor\": 1000,\n \"baseUnit\": {\n \"name\": \"GRAM\",\n \"id\": 1\n }\n },\n \"category\": {\n \"categoryName\": \"Semi Proc\",\n \"supercategory\": {\n \"supercategoryName\": \"Semi Proc\"\n }\n },\n \"taxes\": []\n }\n ],\n \"subTotal\": 31952.471,\n \"totalTax\": 0,\n \"transactionDate\": \"2024-09-01T06:50:22.263Z\",\n \"transactionType\": 1,\n \"updated\": \"2024-09-01T06:50:52.383Z\",\n \"user\": {\n \"lastname\": \".\",\n \"firstname\": \"Manager\",\n \"username\": \"test_manager\"\n },\n \"vendor\": {\n \"isEnterpriseVendor\": true,\n \"vendorName\": \"Test Vendor\",\n \"vendorCode\": \"P8001\",\n \"state\": {\n \"name\": \"Haryana\",\n \"code\": \"in_hr\"\n }\n },\n \"storeCode\": \"8603\"\n}\n"},{"id":"2eef2592-9390-499e-a212-0338b8a4a52c","name":"Purchase Order","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic dG9rZW5IZXJl"}],"url":{"raw":"http://18.140.214.202:9010/api/v1/pos/fetch_Inventory_data?customer_key=abc123&entity=po&fromDate=2024-09-01&toDate=2024-09-20","protocol":"http","host":["18","140","214","202"],"port":"9010","path":["api","v1","pos","fetch_Inventory_data"],"query":[{"key":"customer_key","value":"abc123"},{"key":"entity","value":"po"},{"key":"fromDate","value":"2024-09-01"},{"key":"toDate","value":"2024-09-20"},{"key":"transactionType","value":"","disabled":true},{"key":"onlyLocalGRNs","value":"true","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"36d38669exe9455b1b232v60\",\n \"charges\": [],\n \"chargesTotal\": 0,\n \"created\": \"2024-08-31T21:08:57.562Z\",\n \"deliveryAddress\": {\n \"same\": true,\n \"value\": \"Test address,\"\n },\n \"deployment\": {\n \"_id\": \"r607ae3389dc8ce31b78b1d2\",\n \"name\": \"Test Outlet\",\n \"gstin\": \"\",\n \"isBaseKitchen\": false\n },\n \"discountAmount\": 0,\n \"expectedDelivery\": \"2024-09-02T05:30:00.000Z\",\n \"isDeleted\": false,\n \"items\": [\n {\n \"totalReceiveTax\": 0,\n \"receiveSubtotal\": 120.14,\n \"baseReceiveQty\": 500,\n \"itemCode\": \"20077176\",\n \"itemName\": \"Thousand Dip-SFG\",\n \"category\": {\n \"categoryName\": \"Semi Proc\",\n \"supercategory\": {\n \"supercategoryName\": \"Semi Proc\"\n }\n },\n \"subtotal\": 120.14,\n \"baseQty\": 500,\n \"unit\": {\n \"conversionFactor\": 1000,\n \"unitName\": \"KG\",\n \"baseUnit\": {\n \"id\": 1,\n \"name\": \"GRAM\"\n }\n }\n }\n ],\n \"subtotal\": 37197.19,\n \"receiveSubtotal\": 30483.136,\n \"receiveDate\": \"2024-09-02T06:45:19.153Z\",\n \"poNumber\": 383,\n \"state\": {\n \"name\": \"Haryana\",\n \"code\": \"in_hr\"\n },\n \"vendor\":\n\n {\n \"vendorName\": \"Test Vendor\",\n \"vendorCode\": \"P8001\",\n \"state\": {\n \"name\": \"Haryana\",\n \"code\": \"in_hr\"\n }\n },\n \"storeCode\": \"8603\"\n}\n"}],"_postman_id":"ff674a74-126c-4d31-b3e1-a5a24428ba69"},{"name":"Indent","id":"088672b3-24cd-4ba7-81f6-7cbbf6c32b68","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Basic AUTH_TOKEN"}],"url":"http://18.140.214.202:9010/api/v1/pos/get_indents?customer_key=213214&startDate=2024-06-30&endDate=2024-07-02&deploymentAs=supplier","description":"
This API allows you to fetch indents based on a customer key, date range, and the deployment's role as either a supplier or receiver. Indents are documents used in inventory systems to track the request and supply of goods between two entities (supplier and receiver). The API provides detailed information about the indent, including items, quantities, taxes, and the status of the indent.
\nURL
\nGET http://18.140.214.202:9010/api/v1/pos/get_indents\n\nMethod
\nGET
Authentication
\nThis API requires Basic Authentication.
\n- \n
- Authorization header:
- \n
Authorization: Basic\n
\n
Query Parameters
\nRequest Headers
\nQuery Parameter Descriptions
\n- \n
customer_key:
\n- \n
This is required to authenticate the customer and identify which data should be fetched.
\n \nExample:
\ncustomer_key=213214. \n
\nstartDate / endDate:
\n- \n
These parameters define the date range for fetching the indent data.
\n \nExample:
\nstartDate=2024-06-30&endDate=2024-07-02. \n
\ndeploymentAs:
\n- \n
Defines whether the deployment is acting as a
\nsupplierorreceiverin the context of the indents. \nExample:
\ndeploymentAs=supplier. \n
\nstatus (Upcoming):
\n- \n
This will allow to fetch indents based on their status e.g requested, partial supplied, partial received etc.
\n \nExample:
\nstatus=requested. \n
\n
Example Request
\ncurl --location 'http://18.140.214.202:9010/api/v1/pos/get_indents?customer_key=213214&startDate=2024-06-30&endDate=2024-07-02&deploymentAs=supplier' \\\n--header 'Authorization: Basic AUTH_TOKEN'\n\nResponses
\n1. Successful Response for deploymentAs = supplier
\n{\n \"deploymentName\": \"Test Outlet\",\n \"chargesTotal\": 0,\n \"totalSupplyTax\": 0,\n \"supplySubtotal\": 1.65,\n \"supplyDate\": \"2024-06-30T08:59:03.822Z\",\n \"prefix\": \"IN\",\n \"indentNumber\": 403,\n \"status\": \"received\",\n \"charges\": [],\n \"items\": [\n {\n \"receiveComment\": \"\",\n \"itemName\": \"Test Item\",\n \"itemCode\": \"3242ABC\",\n \"category\": {\n \"supercategory\": {\n \"_id\": \"6481cd621486886b0111ea89\",\n \"supercategoryName\": \"Test Super Category\",\n \"supercategoryCode\": \"4120\"\n },\n \"categoryCode\": \"G2300\",\n \"categoryName\": \"Test Category\",\n \"_id\": \"36d38669exe9455b1b232v60\"\n },\n \"supplyComment\": \"\",\n \"supplySubtotal\": 0.30,\n \"totalSupplyTax\": 0,\n \"unit\": {\n \"_id\": \"36d38669exe9455b1b232v60\",\n \"conversionFactor\": 1,\n \"unitName\": \"Each\",\n \"baseUnit\": {\n \"id\": 4,\n \"name\": \"PIECE\"\n }\n },\n \"supplyQty\": 1,\n \"price\": 0.30\n }\n ],\n \"supplierStoreCode\": \"3423\",\n \"receiverStoreCode\": \"3411\",\n \"supplierName\": \"Test Supplier\",\n \"receiverName\": \"Test Receiver\"\n}\n\nResponse Fields for deploymentAs = supplier
\nItem Fields in items Array
\n2. Error Responses
\nMissing Required Parameters (400 Bad Request)
\n{\n \"status\": \"error\",\n \"message\": \"customer_key has not been provided\"\n}\n\nInvalid deploymentAs Value (400 Bad Request)
\n{\n \"status\": \"error\",\n \"message\": \"Invalid value provided for 'deploymentAs'!\"\n}\n\nError Codes
\n\n","urlObject":{"protocol":"http","port":"9010","path":["api","v1","pos","get_indents"],"host":["18","140","214","202"],"query":[{"key":"customer_key","value":"213214"},{"key":"startDate","value":"2024-06-30"},{"key":"endDate","value":"2024-07-02"},{"key":"deploymentAs","value":"supplier"}],"variable":[]}},"response":[{"id":"9b2d72c0-1c13-4a34-ba1b-5b26fdf03a06","name":"Indent","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic AUTH_TOKEN"}],"url":{"raw":"http://18.140.214.202:9010/api/v1/pos/get_indents?customer_key=213214&startDate=2024-06-30&endDate=2024-07-02&deploymentAs=supplier","protocol":"http","host":["18","140","214","202"],"port":"9010","path":["api","v1","pos","get_indents"],"query":[{"key":"customer_key","value":"213214"},{"key":"startDate","value":"2024-06-30"},{"key":"endDate","value":"2024-07-02"},{"key":"deploymentAs","value":"supplier"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"deploymentName\": \"Test Outlet\",\n \"chargesTotal\": 0,\n \"totalSupplyTax\": 0,\n \"supplySubtotal\": 1.65,\n \"supplyDate\": \"2024-06-30T08:59:03.822Z\",\n \"prefix\": \"IN\",\n \"indentNumber\": 403,\n \"status\": \"received\",\n \"charges\": [],\n \"items\": [\n {\n \"receiveComment\": \"\",\n \"itemName\": \"Test Item\",\n \"itemCode\": \"3242ABC\",\n \"category\": {\n \"supercategory\": {\n \"_id\": \"6481cd621486886b0111ea89\",\n \"supercategoryName\": \"Test Super Category\",\n \"supercategoryCode\": \"4120\"\n },\n \"categoryCode\": \"G2300\",\n \"categoryName\": \"Test Category\",\n \"_id\": \"36d38669exe9455b1b232v60\"\n },\n \"supplyComment\": \"\",\n \"supplySubtotal\": 0.30,\n \"totalSupplyTax\": 0,\n \"unit\": {\n \"_id\": \"36d38669exe9455b1b232v60\",\n \"conversionFactor\": 1,\n \"unitName\": \"Each\",\n \"baseUnit\": {\n \"id\": 4,\n \"name\": \"PIECE\"\n }\n },\n \"supplyQty\": 1,\n \"price\": 0.30\n }\n ],\n \"supplierStoreCode\": \"3423\",\n \"receiverStoreCode\": \"3411\",\n \"supplierName\": \"Test Supplier\",\n \"receiverName\": \"Test Receiver\"\n}\n"}],"_postman_id":"088672b3-24cd-4ba7-81f6-7cbbf6c32b68"}],"id":"66e4359d-e8b2-45e3-b973-4fa7e08dfe4b","description":"
The Stock API provides seamless access to real-time inventory data and indent requests, enabling businesses to manage stock levels and monitor procurement efficiently.
\n","_postman_id":"66e4359d-e8b2-45e3-b973-4fa7e08dfe4b"},{"name":"FAQ","item":[{"name":"Online Order","id":"48300ce2-8866-4457-99d2-2f9a8af7b560","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"description":"FAQ's For Menu Sync:
\nQ: What is the purpose of the \"configuration\" key in the JSON data?
\nA: The \"configuration\" key in the JSON data serves as a container for information related to the rules and entities associated with a specific item. This includes details about date and time settings, the days when the item is considered valid, and the structure of entities within the item itself.
\nQ: What does the \"rules\" key represent within the \"configuration\" key?
\nA: Within the \"configuration\" key, the \"rules\" key represents a set of parameters that dictate the validity and applicability of the item based on date, time, and day constraints. This includes settings for date, time, and days, as well as a \"taxAsItem\" setting.
\nQ: What is the significance of the \"entities\" key within the \"configuration\" key?
\nA: The \"entities\" key plays an important role within the \"configuration\" key by providing information about the various levels and categories of items. This includes details about item names, as well as any associated price adjustments or maximum/minimum quantity constraints.
\nQ: How do I understand the \"days\" key under the \"rules\" key in the \"configuration\" object?
\nA: The \"days\" key, which is located under the \"rules\" key in the \"configuration\" object, contains an array of integers that correspond to days of the week. Here, 0 represents Sunday, 1 represents Monday, and so on. This key is used to determine on which days the item is valid or applicable.
\nQ: What does the \"allDaysValid\" key represent in the \"rules\" object?
\nA: In the \"rules\" object, the \"allDaysValid\" key is a boolean value that signifies whether the item is valid or applicable on all days of the week.
\nQ: What does the \"noRange\" key indicate within the \"date\" and \"time\" objects?
\nA: The \"noRange\" key, found within the \"date\" and \"time\" objects, is a boolean value that specifies whether there is no particular range for the date or time setting. If this key is set to true, it means the item is valid or applicable without any constraints related to date or time.
\nQ: How are different levels of items represented in the \"entities\" object?
\nA: In the \"entities\" object, various levels of items are represented as individual objects within the \"levels\" array. Each of these level objects contains information about the level's name, price adjustments, and any associated categories.
\nQ: How can I find information about the categories and their items within a level?
\nA: Within a level object, you can find information about the categories and their items by examining the \"categories\" array. This array contains category objects, which in turn hold information about the category name and the items that belong to that specific category.
\nQ: What is the purpose of the \"differentialPrice\" key within a level object?
\nA: The \"differentialPrice\" key, found within a level object, is a boolean value that determines whether the level's price adjustment should be applied as a differential price (true) or as an absolute price (false).
\nQ: What does the \"status\" key mean in the order payload?
\nA: The \"status\" key, located within the order payload, contains the current status of the order before the callback is called. To keep track of the order status, it's necessary to listen to the webhook that gets called on each status update. For example, the acceptURL is called when the order is accepted, and the rejectURL is called when the order is rejected. Possible values for the \"status\" key include \"synced,\" \"preparing,\" \"food prepared,\" \"food prepared and bill printed,\" \"out for delivery,\" \"delivered,\" \"payment received,\" \"void,\" and \"rejected.\" However, these status values represent the state of the order before the callback is called. The status moves to the next state when the callback is successful. Therefore, if you need to maintain the status of the order, it's important to listen to the webhook calls for each status update.
\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"48300ce2-8866-4457-99d2-2f9a8af7b560"},{"name":"Data integration","id":"fab4358b-313d-49e4-a34e-f574f75b4239","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"description":"FAQ for Bills API
\n- \n
- Q: What does the \"tab\" key represent in the JSON data?
A: The \"tab\" key represents the type of establishment, in this case, a \"Diner\". \n - Q: What is the purpose of the \"_currentUser\" key?
A: The \"_currentUser\" key contains information about the current user, such as their username, first name, and last name. \n - Q: How can I determine the total number of covers for this JSON data?
A: The \"_covers\" key holds the total number of covers, which is 1 in this example. \n - Q: What information does the \"_customer\" key provide?
A: The \"_customer\" key contains details about the customer, such as their first name and mobile number. \n - Q: How can I find out the total tax amount in the \"charges\" key?
A: The \"totalTax\" key within the \"charges\" object contains the total tax amount. \n - Q: How can I get the total amount paid by a particular card type in the \"payments\" key?
A: You can find the total amount for a specific card type by looking at the \"totalAmount\" key within the corresponding \"cards\" object. \n - Q: What is the purpose of the \"aggregation\" key?
A: The \"aggregation\" key holds various aggregated data related to the bill, such as net rounded amount, total tax, and total amount. \n - Q: Can I find the timestamp when the bill was settled?
A: Yes, the \"_closetime\" key contains a \"timestamp\" that provides the time when the bill was settled. \n - Q: What information does the \"_kots\" key provide?
A: The \"_kots\" key contains an array of KOT (Kitchen Order Token) objects, including details about the items ordered, taxes, and discounts. \n - Q: How can I determine the total number of items ordered from a specific category?
A: You can loop through the \"_kots\" array and access the \"items\" array within each KOT object. Then, you can filter the items based on the \"category\" key to count the items in a specific category. \n
Menu & 86'n
\n- \n
Menu updates via webhook
\n \nMenu pull on webhook asynchronously
\n \nSorting of all levels
\n \nImages for items
\n \nVariations and addons on top of variations along with pricing calculation
\n \nActive / In - Active items / Modifiers
\n \nveg / non veg tagging
\n \ncharges item wise and order level
\n \nSchedulers for items and categories
\n \nOOS an item and modification
\n \n
Ordering
\n- \n
Accepting an order using accept url
\n \nMFR using BPU
\n \nOrder cancellation via order cancel API
\n \nDiscounts item wise and order wise
\n \nDelivery updates
\n \nRejection of order using RU
\n \nMX Cancellation using VOID URL
\n \n
- \n
Creating new customer : Event name : POS customer details
\n \nFetching customer details with points and coupons (if applicable) : Event name : Get Loyalty Customer Details
\n \nRedeeming of points as Discount - Event name - Loyalty Points Redemption
\n \nOTP flow (if applicable)
\n \nFInal Points redeem - Event name - Authenticate Points Redemption
\n \nCoupon info - Event name - Coupon/Reward Details
\n \nRedeem Coupon - Event name - Redeem Coupon
\n
7.1 Bill wise percentage discount
7.2 Bill wise fixed discount
7.3 Pre defined offer flow \nCapture the bill details - Event Name - Get POS Bill Details
\n \n