"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"orderId\": \"5d****e3448c290010****53\",\n \"status\": 10,\n \"reason\": \"new order\",\n \"timeStamp\": \"2019-09-05 07:44:15.000Z\",\n \"receiptId\": \"1234\"\n}"},"url":"http://api.brain.io/orderStatus/5d08c4e3448c290010c84453","description":"This allows a POS to update the status of an order.
\nWhen sending an order status update, make sure to always include three things: orderId, receiptID, and status.\nSome POS systems use a separate id for the order (orderId) and the receipt that was printed for it (receiptId). The latter is usually something human-friendly, while the former can be a long internal ID.\nIf a separate receiptId does not apply, it's a good practice to default the value for it to that of orderId.
\n The table below lists statuses and their corresponding integer value.
\n\n\n\n| Foodstack status tag | \nDescription | \nInteger value | \n
\n\n\n\nPARSED | \nreceived and parsed by Foodstack | \n1 | \n
\n\nRECEIVED | \nreceived by POS | \n2 | \n
\n\nNEW | \nreceived by POS and receipt is created | \n10 | \n
\n\nACCEPTED | \naccepted/confirmed | \n20 | \n
\n\nREJECTED | \nrejected | \n30 | \n
\n\nPRINTED | \nprinted | \n40 | \n
\n\nPREPARING | \nin preparation | \n50 | \n
\n\nPREPARED | \nis prepared | \n60 | \n
\n\nREADY FOR PICKUP | \nready for pickup | \n70 | \n
\n\nIN DELIVERY | \nen route to customer | \n80 | \n
\n\nFINALIZED | \nfinalized, order is fully handled and no further status updates are coming | \n90 | \n
\n\nAUTO FINALIZED | \naccepted by POS, but any other status updates unsupported by POS (to be avoided at all costs!) | \n95 | \n
\n\nCANCEL | \nshould be voided | \n100 | \n
\n\nCANCELED | \nhas been voided on POS | \n110 | \n
\n\nFAILED | \nfailed | \n120 | \n
\n\nPOS RECEIVED FAILED | \nnot received by POS | \n121 | \n
\n\nPARSE FAILED | \nparsing failed | \n124 | \n
\n\n
\n
REJECTED should only be used if the order is already in the POS and was (accidentally) submitted a second time.
\nFINALIZED means that the order is finalised in the POS. Note that this doesn't necessarily mean that the food has also already been delivered to the end customer!
\n
\nCANCEL vs CANCELED
\nCANCEL
\nThis is a status sent to the POS when we ask it to cancel an order.
\nSuch a request comes in at the orders webhook endpoint, as an order with the CANCEL status.
\nYour POS should never send an order status update request with this status to Foodstack.
\nCANCELED
\nMeans the order was indeed canceled by the POS.
\nIn the case of an order with status CANCEL, Foodstack will resend that order to the POS, with the same channelOrderId and channelOrderDisplayId (again, see the link above for more information).
\nAn example of an order status update request to Foodstack to confirm cancellation by the POS can be seen on the right. Select the example from the drop-down box.
\nHow should your POS handle this?
\n\n- On the POS side, it should be made very clear to the user that the order needs to be canceled. Printing new tickets for orders, that indicate the order was canceled (so the kitchen knows they don't need to prepare the order) is a right way of doing this. Whether a canceled order should be voided or not is up to the logic of the POS.
\n- The POS should send Foodstack a status
CANCELED (110) back, so Foodstack knows the order has been canceled in the POS. \n
\n
\nFAILED is a status that should be used when the POS could not be reached, or when an order could not be processed correctly, for example when a product is available on the merchant's online store, but deleted in his POS account.
\nWhen a status is not supported, it can be skipped. It is however very important that statuses are synced back. Some channels will only mark the order successful when the status is ACCEPTED or higher, and some channels take the PREPARING state into account. The more data you can provide, the better the experience for the customer.
\n(For some channels, such as Takeaway for instance, orders will not be retrieved if they aren't put to status PRINTED. In this case, their support will call the restaurant if it takes more than five minutes to reach this status)
\nIf you want to specify a reason for a status change (for instance when it failed) you can set the reason property.
\n","urlObject":{"path":["5d08c4e3448c290010c84453"],"host":["http://api.brain.io/orderStatus"],"query":[],"variable":[]}},"response":[{"id":"522a5a71-9c26-4f5e-a6af-005388963122","name":"NEW order","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"orderId\": \"5d****e3448c290010****53\",\n \"status\": 10,\n \"reason\": \"new order\",\n \"timeStamp\": \"2019-09-05 07:44:15.000Z\",\n \"receiptId\": \"1234\"\n}","options":{"raw":{"language":"json"}}},"url":"http://api.brain.io/orderStatus/5d08c4e3448c290010c84453"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"OK"},{"id":"ca699030-187c-420c-ad12-bef4bd59a455","name":"Order CANCELED","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"orderId\": \"5d****e3448c290010****53\",\n \"status\": 110,\n \"reason\": \"cancellation\",\n \"timeStamp\": \"2019-09-05 07:44:15.000Z\",\n \"receiptId\": \"1234\"\n}","options":{"raw":{"language":"json"}}},"url":"http://api.brain.io/orderStatus/5d08c4e3448c290010c84453"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"OK"}],"_postman_id":"b9c4dd6a-8856-4da5-93c2-3c7408bbb9d1"},{"name":"Retry order","id":"e0a5a379-9d72-47ec-b6fd-0fb97d3ae3d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{PARTNERTOKEN}}"}]},"isInherited":false},"method":"GET","header":[],"url":"http://api.brain.io/retry/{orderId}","description":"Use this request to force a retry of an order.\nNote: this should only be used to retry failed orders
\nEndpoint parameters
\n\n\n\n| Parameter | \nMeaning | \n
\n\n\n\norderId | \nThe channelOrderId of the order | \n
\n\n
\n
Products and categories of the POS should be pushed to Foodstack. We will map the incoming order items to the products.
\nIdeally all products that can at one point be ordered online are pushed here.
\nRestaurant owners can customise their online menu's by using these products coming from the POS. They can overwrite name, price and images if necessary. Everything that is not overwritten will automatically be pushed online when updates from the POS are pushed
\nPrice is stored as an int with 2 decimal digits, so 100.00 S.R. is stored as 100 S.R. It will later be possible to overwrite this on account level.
\nProduct types
\nWe currently support 4 types of products: Products, ModifierGroups, Modifiers, and Bundles. Modifiers are options that can be selected when ordering a product. They are organised in ModifierGroups that can be assigned to one or more products. Bundles group together products for a customer to choose out of, and are used for creating meal deals.\nWhen pushing products to us you can use the values for product types as displayed in the table below.
\n\n\n\n| Product type | \nInteger value | \n
\n\n\n\n| Product | \n1 | \n
\n\n| Modifier | \n2 | \n
\n\n| Modifier group | \n3 | \n
\n\n| Bundle | \n4 | \n
\n\n
\n
A product can be in one or more categories. posCategoryIds are the references to those categories. It's important to have at least 1 and link every product to it.
\nThe PLU is normally something that's easier for the customer to use, and it should be the same across all locations for the same product. The PLU (Price Look-up Code) is what will be used for mapping orders coming from the channels. This means this is mandatory.
\nDeleting products
\nThere is currently no way to directly delete a product. To achieve the desired effect, a list of products can be pushed again, in which products \"to be deleted\" are omitted or de-activated depending on the POS.
\nMulti-select modifiers
\nYou can indicate that it must be possible for modifiers in a certain modifier group to be selected more than once.
\nThis request is almost identical to the previous. The only difference is that the modifier group (with PLU) has two fields added: max, and multiMax.
\n\nThe max field gets a value of two. This limits the maximum number of modifiers that can be selected to two. As there are only two modifiers in the group, this in itself wouldn't make much of a difference when modifiers can only be selected once.
\nAdding multiMax makes it so that modifiers in this modifier group can be selected more than once. Because it has a value of two, each modifier can be selected at most two times.
\n
\nThe net effect of these added attributes is as follows: a customer will be able to select up to two sauce modifiers as an example from this modifier group. It doesn't have to be one of each anymore.
\nSelected by default
\nIt's possible to set a default quantity for modifiers and meal deal items. With a default quantity of 1, the item is selected by default in the channel menu.
\nThis is shown in the fifth meal deal example, where the sauce modifier has a field defaultQuantity, with a value of 1. Because of this, the sauce modifier will be selected by default.
\nProduct translations
\nTranslations of product names and descriptions can be provided in the JSON.\nA base name (field name) is always required and translations are optional (field nameTranslations). Translations are supported for all product types.
\nThe translations are passed as a nested JSON object where the property names are language tags and the values are the translations temselves.
\nExample:
\n{\n \"productType\": 1,\n \"plu\": \"MEAT-02\",\n \"price\": 200,\n \"name\": \"Chicken\",\n \"nameTranslations\": {\n \"ar\": \"دجاج\",\n \"en\": \"Chicken\"\n }, \n \"description\": \"Grilled chicken\",\n \"descriptionTranslations\": {\n \"ar\": \"دجاج مشوي\",\n \"en\": \"Grilled chicken.\"\n }\n}\n
The language tags are ISO 639-1 (https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. They can be complemented by a lowercase ISO 3166-1 (https://en.wikipedia.org/wiki/ISO_3166-1) country code.
\nList of common language tags:
\n\n\n\n| name | \nlanguage tag | \n
\n\n\n\n| Arabic | \nar | \n
\n\n| English | \nUS | \n
\n\n
\n
These are endpoints hosted on the foodstack.brain.io domain.\nThere is a staging environment: https://api.staging.foodstack.brain.io and a production environment https://api.foodstack.brain.io
\n","_postman_id":"a5b297d0-93c2-4ae2-b18a-5b955d2f0ede","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{integratorToken}}"}],"advancedConfig":[{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"ec7259bd-82f3-4a09-a170-39a4e647fd84","id":"ec7259bd-82f3-4a09-a170-39a4e647fd84","name":"Foodstack Public API","type":"collection"}}},{"name":"Webhooks","item":[{"name":"Orders webhook","id":"baf6ba63-5ec6-4ad1-b725-36757e9f5a7d","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"_id\": \"5c6d830a0182d6000e******\",\n \"_created\": \"2019-02-20T16:40:44.000000Z\",\n \"_updated\": \"2019-02-20T16:40:52.000000Z\",\n \"channelOrderId\": \"******-1527\",\n \"channelOrderDisplayId\": \"1527\",\n \"posLocationId\": \"30458\",\n \"location\": \"5bf02f38c6489f002c******\",\n \"channelLink\": \"5bf02f38c6489f002c******\",\n \"status\": 1,\n \"statusHistory\": [\n {\n \"_created\": \"2019-02-20T16:40:42.703000Z\",\n \"response\": \"\",\n \"timeStamp\": \"2019-02-20T16:40:42.703000Z\",\n \"status\": 4\n },\n {\n \"_created\": \"2019-02-20T16:40:42.726000Z\",\n \"response\": \"\",\n \"timeStamp\": \"2019-02-20T16:40:42.726000Z\",\n \"status\": 1\n }\n ],\n \"by\": \"\",\n \"orderType\": 2,\n \"channel\": 2,\n \"table\": \"table 4\",\n \"pickupTime\": \"2019-02-20T16:40:42.000000Z\",\n \"deliveryIsAsap\": false,\n \"courier\": {\n \"firstName\": \"Delivery\",\n \"lastName\": \"Rider\",\n \"phoneNumber\": \"0032494112233\",\n \"deliveryBy\": \"UberEats\"\n },\n \"customer\": {\n \"name\": \"Customer name\",\n \"companyName\": \"Foodstack\",\n \"phoneNumber\": \"0123456789\",\n \"email\": \"customer@foodstack.brain.io\"\n },\n \"deliveryAddress\": {\n \"street\": \"\",\n \"streetNumber\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"extraAddressInfo\": \"\"\n },\n \"orderIsAlreadyPaid\": true,\n \"payment\": {\n \"amount\": 400,\n \"type\": 0\n },\n \"note\": \"\",\n \"items\": [\n {\n \"plu\": \"P1\",\n \"name\": \"Product 1\",\n \"price\": 200,\n \"quantity\": 1,\n \"productType\": 1,\n \"remark\": \"\",\n \"subItems\": [\n {\n \"plu\": \"O1\",\n \"name\": \"Modifier 1/ Option 1\",\n \"price\": 0,\n \"quantity\": 1,\n \"productType\": 2,\n \"remark\": \"\",\n \"isInternal\": false,\n \"subItems\": []\n },\n {\n \"plu\": \"O2\",\n \"name\": \"Modifier 2/ Option 2\",\n \"price\": 200,\n \"quantity\": 1,\n \"productType\": 2,\n \"remark\": \"\",\n \"isInternal\": false,\n \"subItems\": []\n }\n ]\n },\n {\n \"plu\": \"P2\",\n \"name\": \"Product 2\",\n \"price\": 200,\n \"quantity\": 1,\n \"productType\": 1,\n \"remark\": \"\",\n \"subItems\": [\n {\n \"plu\": \"O1\",\n \"name\": \"Modifier 1/ Option 1\",\n \"price\": 0,\n \"quantity\": 1,\n \"productType\": 2,\n \"remark\": \"\",\n \"isInternal\": false,\n \"subItems\": []\n }\n ]\n }\n ],\n \"decimalDigits\": 2,\n \"numberOfCustomers\": 1,\n \"deliveryCost\": 0,\n \"serviceCharge\": 0,\n \"discountTotal\": 0,\n \"posCustomerId\": \"256706\",\n \"account\": \"5be9c971c6489f0029******\",\n \"posReceiptId\": \"\",\n \"tags\": [\n \"Brand X\",\n \"Brand Y\"\n ]\n}"},"url":"{{webhookUrl}}orders","description":"An order represents what a customer ordered using a channel. It contains the products, prices and payment information.
\nDepending on the channel we also get customer info.
\nIt also contains whether this is a takeout or delivery order. If the customer does the delivery himself, then a delivery address will also be available
\nA POS that has a cloud API should put an endpoint online that accepts orders like shown here.
\nThe orderType can be interpreted as follows:
\n\n\n\n| Type | \nInteger value | \n
\n\n\n\n| pickup | \n1 | \n
\n\n| delivery | \n2 | \n
\n\n| eat in | \n3 | \n
\n\n
\n
We assume this endpoint responds quickly. You are encouraged to do things asynchronously. When everything has been done, just call the update order status endpoint to let us know. When you receive an order successfully we expect a HTTP 200 or 201 status response back. Any other HTTP status will cause the order to be retried after a couple of seconds. After a couple of failed retries we will mark the order as failed.
\nThe return value should be the posOrderId. This can be used by support/customers to reference an order when things go wrong
\nRequest parameters
\nThis table explains the difference between channelOrderId, channelOrderDisplayId, and channelOrderRawId. It also provides an explanation for some other fields.
\n\n\n\n| Parameter | \nMeaning | \n
\n\n\n\nchannelOrderId | \nthe full unique ID from the delivery Channel | \n
\n\nchannelOrderDisplayId | \nthe more human-readable ID from the channel (only unique in a certain duration, like a day) | \n
\n\nchannelOrderRawId | \nan internal ID you don't need to store or use | \n
\n\nby | \nWhen filled in, this field contains information about the subchannel through which the end customer ordered. This can be for example 'app' or 'mobile', 'web', 'unknown', or a third party. Most of the time, this field will be empty. | \n
\n\n(courier).deliveryBy | \nThe courier field contains information about the courier (the person making the delivery). It has an attribute deliveryBy which can contain the delivery channel name, but can also be 'restaurant'. This field can also be empty. | \n
\n\n
\n
Example: meal deals
\nFrom the drop-down on the right, you can select examples of how meal deal orders will be sent to your POS.
\nClick here to see examples of how your POS should sync products as a meal deal to Foodstack.
\n
\nCancels and rejects
\nThere are two flows for incoming orders. One in which orders are autoaccepted, and another one where they need to manually be accepted. This can be done through your POS. Alternatively, our app can be used for this if you do not support this feature.
\nSome channels support canceling orders. When a channel requests for an order to be canceled (which we call a cancel), your POS will receive a request from Foodstack on the same endpoint that is used for new orders.
\nAgain, not all channels support sending cancellation requests. Furthermore, it's important to know that you should only expect cancellation requests for orders that just came in.
\nWhen a new order comes in, your POS API can reject it (if it supports this). A reason for this can be that the order is undesired, that some required ingredient is not in stock, or that there is no time to prepare the order.
\nOnce your POS API has accepted an order, it should no longer be possible for that order to be canceled (in other words, your POS API cannot reject orders once accepted).
\nAn order that is to be canceled by the POS will have the same data as the original order, except for its status. Most notably, the order will have the same channelOrderId. This ID can be used to trace back the original order.
\nAn order to be canceled will have the CANCEL (100) status. When you get such an order, make sure to handle the cancellation correctly by sending an order status update request to Foodstack.
\nNote
\nIf you receive a status that is not documented here, these can safely be ignored in most cases. Contact Foodstack to get the meaning of this status.
\nIn no case should an unknown status hinder your flow of processing orders.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{integratorToken}}"}],"advancedConfig":[{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"ec7259bd-82f3-4a09-a170-39a4e647fd84","id":"ec7259bd-82f3-4a09-a170-39a4e647fd84","name":"Foodstack Public API","type":"collection"}},"urlObject":{"host":["{{webhookUrl}}orders"],"query":[],"variable":[]}},"response":[{"id":"2134965b-e431-4681-b0fb-bbae61cebdec","name":"Meal deal example 2: Kid Fun Meal Box - drink as upsell","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"_id\": \"5f****9e05df90810d****b7\",\n \"_created\": \"2020-08-20T10:04:13.987000Z\",\n \"_updated\": \"2020-08-20T10:04:14.092000Z\",\n \"_etag\": \"\",\n \"account\": \"5f****04e9a87394fa****99\",\n \"channelOrderId\": \"TEST1597917853\",\n \"channelOrderDisplayId\": \"TEST1597917853\",\n \"posId\": \"\",\n \"posReceiptId\": \"\",\n \"posLocationId\": \"TEST\",\n \"location\": \"5f****64e9a87394fa****9d\",\n \"channelLink\": \"5f****e4d9311f40d2****f4\",\n \"status\": 1,\n \"statusHistory\": [\n {\n \"timeStamp\": \"2020-08-20T10:04:14.143000Z\",\n \"status\": 4,\n \"response\": \"\",\n \"source\": 5\n },\n {\n \"timeStamp\": \"2020-08-20T10:04:14.165000Z\",\n \"status\": 1,\n \"response\": \"\",\n \"source\": 2\n }\n ],\n \"channelStatusHistory\": [],\n \"by\": \"Foodstack\",\n \"orderType\": 2,\n \"channel\": 1,\n \"pos\": 10000,\n \"pickupTime\": \"2020-08-20T10:04:13.000000Z\",\n \"deliveryTime\": \"2020-08-20T10:04:13.000000Z\",\n \"deliveryIsAsap\": true,\n \"courier\": {\n \"deliveryBy\": \"restaurant\"\n },\n \"customer\": {\n \"name\": \"\",\n \"companyName\": \"\",\n \"phoneNumber\": \"\",\n \"email\": \"\"\n },\n \"deliveryAddress\": {\n \"street\": \"The Krook\",\n \"streetNumber\": \"4\",\n \"postalCode\": \"8888KL\",\n \"city\": \"Gent\",\n \"extraAddressInfo\": \"\"\n },\n \"orderIsAlreadyPaid\": true,\n \"payment\": {\n \"amount\": 950,\n \"type\": 0\n },\n \"note\": \"This is a test order\",\n \"items\": [\n {\n \"plu\": \"CMB-01\",\n \"name\": \"Kid Fun Meal Box\",\n \"sortOrder\": 0,\n \"price\": 500,\n \"quantity\": 1,\n \"productType\": 1,\n \"isInternal\": false,\n \"isCombo\": true,\n \"subItems\": [\n {\n \"plu\": \"BRGR-02\",\n \"name\": \"Cheese Burger\",\n \"sortOrder\": 0,\n \"price\": 0,\n \"quantity\": 1,\n \"productType\": 1,\n \"isInternal\": false,\n \"subItems\": []\n },\n {\n \"plu\": \"FRS-02\",\n \"name\": \"Medium Fries\",\n \"sortOrder\": 0,\n \"price\": 0,\n \"quantity\": 1,\n \"productType\": 1,\n \"isInternal\": false,\n \"subItems\": [\n {\n \"plu\": \"SC-02\",\n \"name\": \"Ketchup\",\n \"sortOrder\": 0,\n \"price\": 50,\n \"quantity\": 1,\n \"productType\": 2,\n \"isInternal\": false,\n \"subItems\": []\n }\n ]\n },\n {\n \"plu\": \"DRNK-02\",\n \"name\": \"Iced Tea\",\n \"sortOrder\": 0,\n \"price\": 400,\n \"quantity\": 1,\n \"productType\": 1,\n \"isInternal\": false,\n \"subItems\": []\n }\n ]\n }\n ],\n \"decimalDigits\": 2,\n \"numberOfCustomers\": 1,\n \"channelOrderRawId\": \"5f****9da850c18614****8c\",\n \"serviceCharge\": 0,\n \"deliveryCost\": 0,\n \"discountTotal\": 0,\n \"historyDriverUpdates\": [],\n \"capacityUsages\": []\n}","options":{"raw":{"language":"json"}}},"url":"{{webhookUrl}}orders"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"4e178097-2dea-4a32-b848-210b828ab401","name":"Meal deal example 4: Healthy Snack Bowl","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"_id\": \"5f****b56c275c2cfe****b7\",\n \"_created\": \"2020-08-20T11:00:05.362000Z\",\n \"_updated\": \"2020-08-20T11:00:05.746000Z\",\n \"_etag\": \"\",\n \"account\": \"5f****8ba850c18614****94\",\n \"channelOrderId\": \"TEST1597921205\",\n \"channelOrderDisplayId\": \"TEST1597921205\",\n \"posId\": \"\",\n \"posReceiptId\": \"\",\n \"posLocationId\": \"TEST-0001\",\n \"location\": \"5f****aea850c18614****55\",\n \"channelLink\": \"5f****30a850c18614****7d\",\n \"status\": 1,\n \"statusHistory\": [\n {\n \"timeStamp\": \"2020-08-20T11:00:05.994000Z\",\n \"status\": 4,\n \"response\": \"\",\n \"source\": 5\n },\n {\n \"timeStamp\": \"2020-08-20T11:00:06.057000Z\",\n \"status\": 1,\n \"response\": \"\",\n \"source\": 2\n }\n ],\n \"channelStatusHistory\": [],\n \"by\": \"Foodstack\",\n \"orderType\": 2,\n \"channel\": 1,\n \"pos\": 10000,\n \"pickupTime\": \"2020-08-20T11:00:05.000000Z\",\n \"deliveryTime\": \"2020-08-20T11:00:05.000000Z\",\n \"deliveryIsAsap\": true,\n \"courier\": {\n \"deliveryBy\": \"restaurant\"\n },\n \"customer\": {\n \"name\": \"\",\n \"companyName\": \"\",\n \"phoneNumber\": \"\",\n \"email\": \"\"\n },\n \"deliveryAddress\": {\n \"street\": \"The Krook\",\n \"streetNumber\": \"4\",\n \"postalCode\": \"8888KL\",\n \"city\": \"Gent\",\n \"extraAddressInfo\": \"\"\n },\n \"orderIsAlreadyPaid\": true,\n \"payment\": {\n \"amount\": 1000,\n \"type\": 0\n },\n \"note\": \"This is a test order\",\n \"items\": [\n {\n \"plu\": \"CMB-01\",\n \"name\": \"Healthy Snack Bowl\",\n \"sortOrder\": 0,\n \"price\": 1000,\n \"quantity\": 1,\n \"productType\": 1,\n \"isInternal\": false,\n \"isCombo\": true,\n \"subItems\": [\n {\n \"plu\": \"RICE-01\",\n \"name\": \"Brown Rice\",\n \"sortOrder\": 0,\n \"price\": 0,\n \"quantity\": 1,\n \"productType\": 1,\n \"isInternal\": false,\n \"subItems\": []\n },\n {\n \"plu\": \"VEG-03\",\n \"name\": \"Avocado\",\n \"sortOrder\": 0,\n \"price\": 0,\n \"quantity\": 1,\n \"productType\": 1,\n \"isInternal\": false,\n \"subItems\": []\n },\n {\n \"plu\": \"MEAT-02\",\n \"name\": \"Chicken\",\n \"sortOrder\": 0,\n \"price\": 0,\n \"quantity\": 1,\n \"productType\": 1,\n \"isInternal\": false,\n \"subItems\": []\n },\n {\n \"plu\": \"XTRA-01\",\n \"name\": \"Nuts\",\n \"sortOrder\": 0,\n \"price\": 0,\n \"quantity\": 1,\n \"productType\": 1,\n \"isInternal\": false,\n \"subItems\": []\n },\n {\n \"plu\": \"SAUC-02\",\n \"name\": \"Spicy Chili\",\n \"sortOrder\": 0,\n \"price\": 0,\n \"quantity\": 1,\n \"productType\": 1,\n \"isInternal\": false,\n \"subItems\": []\n }\n ]\n }\n ],\n \"decimalDigits\": 2,\n \"numberOfCustomers\": 1,\n \"channelOrderRawId\": \"5f****b5a850c18614****d3\",\n \"serviceCharge\": 0,\n \"deliveryCost\": 0,\n \"discountTotal\": 0,\n \"historyDriverUpdates\": [],\n \"capacityUsages\": []\n}","options":{"raw":{"language":"json"}}},"url":"{{webhookUrl}}orders"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"673da503-ed82-48ff-bfb0-23ce2bfa5765","name":"Order canceled by channel, to be canceled by POS","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"_id\": \"5c6d830a0182d6000e******\",\n \"_created\": \"2019-02-20T16:40:44.000000Z\",\n \"_updated\": \"2019-02-20T16:40:52.000000Z\",\n \"channelOrderId\": \"******-1527\",\n \"channelOrderDisplayId\": \"1527\",\n \"posLocationId\": \"30458\",\n \"location\": \"5bf02f38c6489f002c******\",\n \"channelLink\": \"5bf02f38c6489f002c******\",\n \"status\": 100,\n \"statusHistory\": [\n {\n \"_created\": \"2019-02-20T16:40:42.703000Z\",\n \"response\": \"\",\n \"timeStamp\": \"2019-02-20T16:40:42.703000Z\",\n \"status\": 4\n },\n {\n \"_created\": \"2019-02-20T16:40:42.726000Z\",\n \"response\": \"\",\n \"timeStamp\": \"2019-02-20T16:40:42.726000Z\",\n \"status\": 1\n }\n ],\n \"by\": \"\",\n \"orderType\": 2,\n \"channel\": 2,\n \"pickupTime\": \"2019-02-20T16:40:42.000000Z\",\n \"deliveryIsAsap\": false,\n \"courier\": {\n \"firstName\": \"Delivery\",\n \"lastName\": \"Rider\",\n \"phoneNumber\": \"0032494112233\",\n \"deliveryBy\": \"UberEats\"\n },\n \"customer\": {\n \"name\": \"Customer name\",\n \"companyName\": \"Foodstack\",\n \"phoneNumber\": \"0123456789\",\n \"email\": \"customer@foodstack.brain.io\"\n },\n \"deliveryAddress\": {\n \"street\": \"\",\n \"streetNumber\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"extraAddressInfo\": \"\"\n },\n \"orderIsAlreadyPaid\": true,\n \"payment\": {\n \"amount\": 400,\n \"type\": 0\n },\n \"note\": \"\",\n \"items\": [\n {\n \"plu\": \"P1\",\n \"name\": \"Product 1\",\n \"price\": 200,\n \"quantity\": 1,\n \"productType\": 1,\n \"subItems\": [\n {\n \"plu\": \"O1\",\n \"name\": \"Modifier 1/ Option 1\",\n \"price\": 0,\n \"quantity\": 1,\n \"productType\": 2,\n \"isInternal\": false,\n \"subItems\": []\n },\n {\n \"plu\": \"O2\",\n \"name\": \"Modifier 2/ Option 2\",\n \"price\": 200,\n \"quantity\": 1,\n \"productType\": 2,\n \"isInternal\": false,\n \"subItems\": []\n }\n ]\n },\n {\n \"plu\": \"P2\",\n \"name\": \"Product 2\",\n \"price\": 200,\n \"quantity\": 1,\n \"productType\": 1,\n \"subItems\": [\n {\n \"plu\": \"O1\",\n \"name\": \"Modifier 1/ Option 1\",\n \"price\": 0,\n \"quantity\": 1,\n \"productType\": 2,\n \"isInternal\": false,\n \"subItems\": []\n }\n ]\n }\n ],\n \"decimalDigits\": 2,\n \"numberOfCustomers\": 1,\n \"deliveryCost\": 0,\n \"serviceCharge\": 0,\n \"discountTotal\": 0,\n \"posCustomerId\": \"256706\",\n \"account\": \"5be9c971c6489f0029******\",\n \"posReceiptId\": \"\",\n \"tags\": [\n \"Brand X\",\n \"Brand Y\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{webhookUrl}}orders"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"posOrderId\": \"302105\",\n \"posReceiptId\": \"41253185\"\n}"},{"id":"72d8ae63-dc5d-4ed8-b4d8-6ff56e0e0b74","name":"Meal deal example 3: Kid Fun Meal Box - burgers available separately","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"_id\": \"5f****1a8f32c70edf****b7\",\n \"_created\": \"2020-08-20T10:53:14.063000Z\",\n \"_updated\": \"2020-08-20T10:53:14.684000Z\",\n \"_etag\": \"\",\n \"account\": \"5f****78a850c18614****8f\",\n \"channelOrderId\": \"TEST1597920794\",\n \"channelOrderDisplayId\": \"TEST1597920794\",\n \"posId\": \"\",\n \"posReceiptId\": \"\",\n \"posLocationId\": \"TEST-0001\",\n \"location\": \"5f****c1a850c18614****98\",\n \"channelLink\": \"5f****d6a850c18614****9b\",\n \"status\": 1,\n \"statusHistory\": [\n {\n \"timeStamp\": \"2020-08-20T10:53:14.994000Z\",\n \"status\": 4,\n \"response\": \"\",\n \"source\": 5\n },\n {\n \"timeStamp\": \"2020-08-20T10:53:15.068000Z\",\n \"status\": 1,\n \"response\": \"\",\n \"source\": 2\n }\n ],\n \"channelStatusHistory\": [],\n \"by\": \"Foodstack\",\n \"orderType\": 2,\n \"channel\": 1,\n \"pos\": 10000,\n \"pickupTime\": \"2020-08-20T10:53:14.000000Z\",\n \"deliveryTime\": \"2020-08-20T10:53:14.000000Z\",\n \"deliveryIsAsap\": true,\n \"courier\": {\n \"deliveryBy\": \"restaurant\"\n },\n \"customer\": {\n \"name\": \"\",\n \"companyName\": \"\",\n \"phoneNumber\": \"\",\n \"email\": \"\"\n },\n \"deliveryAddress\": {\n \"street\": \"The Krook\",\n \"streetNumber\": \"4\",\n \"postalCode\": \"8888KL\",\n \"city\": \"Gent\",\n \"extraAddressInfo\": \"\"\n },\n \"orderIsAlreadyPaid\": true,\n \"payment\": {\n \"amount\": 1200,\n \"type\": 0\n },\n \"note\": \"This is a test order\",\n \"items\": [\n {\n \"plu\": \"CMB-01\",\n \"name\": \"Kid Fun Meal Box\",\n \"sortOrder\": 0,\n \"price\": 800,\n \"quantity\": 1,\n \"productType\": 1,\n \"isInternal\": false,\n \"isCombo\": true,\n \"subItems\": [\n {\n \"plu\": \"BNDL-BRGR-02\",\n \"name\": \"Cheese Burger\",\n \"sortOrder\": 0,\n \"price\": 0,\n \"quantity\": 1,\n \"productType\": 1,\n \"isInternal\": false,\n \"subItems\": []\n },\n {\n \"plu\": \"FRS-02\",\n \"name\": \"Medium Fries\",\n \"sortOrder\": 0,\n \"price\": 0,\n \"quantity\": 1,\n \"productType\": 1,\n \"isInternal\": false,\n \"subItems\": [\n {\n \"plu\": \"SC-02\",\n \"name\": \"Ketchup\",\n \"sortOrder\": 0,\n \"price\": 50,\n \"quantity\": 1,\n \"productType\": 2,\n \"isInternal\": false,\n \"subItems\": []\n }\n ]\n },\n {\n \"plu\": \"DRNK-02\",\n \"name\": \"Iced Tea\",\n \"sortOrder\": 0,\n \"price\": 0,\n \"quantity\": 1,\n \"productType\": 1,\n \"isInternal\": false,\n \"subItems\": []\n }\n ]\n },\n {\n \"plu\": \"BRGR-02\",\n \"name\": \"Cheese Burger\",\n \"sortOrder\": 0,\n \"price\": 350,\n \"quantity\": 1,\n \"productType\": 1,\n \"isInternal\": false,\n \"subItems\": []\n }\n ],\n \"decimalDigits\": 2,\n \"numberOfCustomers\": 1,\n \"channelOrderRawId\": \"5f****1aa850c18614****53\",\n \"serviceCharge\": 0,\n \"deliveryCost\": 0,\n \"discountTotal\": 0,\n \"historyDriverUpdates\": [],\n \"capacityUsages\": []\n}","options":{"raw":{"language":"json"}}},"url":"{{webhookUrl}}orders"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"a340ba6f-69bc-46a4-b825-caa6c1107f0c","name":"Order parsed by Foodstack","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"_id\": \"5c6d830a0182d6000e******\",\n \"_created\": \"2019-02-20T16:40:44.000000Z\",\n \"_updated\": \"2019-02-20T16:40:52.000000Z\",\n \"channelOrderId\": \"******-1527\",\n \"channelOrderDisplayId\": \"1527\",\n \"posLocationId\": \"30458\",\n \"location\": \"5bf02f38c6489f002c******\",\n \"channelLink\": \"5bf02f38c6489f002c******\",\n \"status\": 1,\n \"statusHistory\": [\n {\n \"_created\": \"2019-02-20T16:40:42.703000Z\",\n \"response\": \"\",\n \"timeStamp\": \"2019-02-20T16:40:42.703000Z\",\n \"status\": 4\n },\n {\n \"_created\": \"2019-02-20T16:40:42.726000Z\",\n \"response\": \"\",\n \"timeStamp\": \"2019-02-20T16:40:42.726000Z\",\n \"status\": 1\n }\n ],\n \"by\": \"web\",\n \"orderType\": 2,\n \"channel\": 2,\n \"table\": \"table 3\",\n \"pickupTime\": \"2019-02-20T16:40:42.000000Z\",\n \"deliveryIsAsap\": false,\n \"courier\": {\n \"firstName\": \"Delivery\",\n \"lastName\": \"Rider\",\n \"phoneNumber\": \"0032494112233\",\n \"deliveryBy\": \"UberEats\"\n },\n \"customer\": {\n \"name\": \"James Bond\",\n \"companyName\": \"MI6\",\n \"phoneNumber\": \"0032494000007\",\n \"email\": \"james.bond@mi6.uk.gov\"\n },\n \"deliveryAddress\": {\n \"street\": \"Albert Embankment\",\n \"streetNumber\": \"85\",\n \"postalCode\": \"SE, SW\",\n \"city\": \"Vauxhall, Lambeth\",\n \"extraAddressInfo\": \"\"\n },\n \"orderIsAlreadyPaid\": true,\n \"payment\": {\n \"amount\": 400,\n \"type\": 0\n },\n \"note\": \"\",\n \"items\": [\n {\n \"plu\": \"P1\",\n \"name\": \"Product 1\",\n \"price\": 200,\n \"quantity\": 1,\n \"productType\": 1,\n \"subItems\": [\n {\n \"plu\": \"O1\",\n \"name\": \"Modifier 1/ Option 1\",\n \"price\": 0,\n \"quantity\": 1,\n \"productType\": 2,\n \"isInternal\": false,\n \"subItems\": []\n },\n {\n \"plu\": \"O2\",\n \"name\": \"Modifier 2/ Option 2\",\n \"price\": 200,\n \"quantity\": 1,\n \"productType\": 2,\n \"isInternal\": false,\n \"subItems\": []\n }\n ]\n },\n {\n \"plu\": \"P2\",\n \"name\": \"Product 2\",\n \"price\": 200,\n \"quantity\": 1,\n \"productType\": 1,\n \"subItems\": [\n {\n \"plu\": \"O1\",\n \"name\": \"Modifier 1/ Option 1\",\n \"price\": 0,\n \"quantity\": 1,\n \"productType\": 2,\n \"isInternal\": false,\n \"subItems\": []\n }\n ]\n }\n ],\n \"decimalDigits\": 2,\n \"numberOfCustomers\": 1,\n \"deliveryCost\": 0,\n \"serviceCharge\": 0,\n \"discountTotal\": 0,\n \"posCustomerId\": \"256706\",\n \"account\": \"5be9c971c6489f0029******\",\n \"posReceiptId\": \"\",\n \"tags\": [\n \"Brand X\",\n \"Brand Y\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{webhookUrl}}orders"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"posOrderId\": \"302105\",\n \"posReceiptId\": \"41253185\"\n}"},{"id":"dd0d2259-70ca-4017-895d-7b133192deb5","name":"Meal deal example 1: Kid Fun Meal Box - drink included","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"_id\": \"5f****ea3458774497****41\",\n \"_created\": \"2020-08-20T09:44:10.792000Z\",\n \"_updated\": \"2020-08-20T09:44:10.863000Z\",\n \"_etag\": \"\",\n \"account\": \"5f****1e953d3a40ec****4f\",\n \"channelOrderId\": \"TEST1597916650\",\n \"channelOrderDisplayId\": \"TEST1597916650\",\n \"posId\": \"\",\n \"posReceiptId\": \"\",\n \"posLocationId\": \"TEST-0001\",\n \"location\": \"5f****59953d3a40ec****53\",\n \"channelLink\": \"5f****92953d3a40ec****56\",\n \"status\": 1,\n \"statusHistory\": [\n {\n \"timeStamp\": \"2020-08-20T09:44:10.887000Z\",\n \"status\": 4,\n \"response\": \"\",\n \"source\": 5\n },\n {\n \"timeStamp\": \"2020-08-20T09:44:10.899000Z\",\n \"status\": 1,\n \"response\": \"\",\n \"source\": 2\n }\n ],\n \"channelStatusHistory\": [],\n \"by\": \"Foodstack\",\n \"orderType\": 2,\n \"channel\": 1,\n \"pos\": 10000,\n \"pickupTime\": \"2020-08-20T09:44:10.000000Z\",\n \"deliveryTime\": \"2020-08-20T09:44:10.000000Z\",\n \"deliveryIsAsap\": true,\n \"courier\": {\n \"deliveryBy\": \"restaurant\"\n },\n \"customer\": {\n \"name\": \"\",\n \"companyName\": \"\",\n \"phoneNumber\": \"\",\n \"email\": \"\"\n },\n \"deliveryAddress\": {\n \"street\": \"The Krook\",\n \"streetNumber\": \"4\",\n \"postalCode\": \"8888KL\",\n \"city\": \"Gent\",\n \"extraAddressInfo\": \"\"\n },\n \"orderIsAlreadyPaid\": true,\n \"payment\": {\n \"amount\": 850,\n \"type\": 0\n },\n \"note\": \"This is a test order\",\n \"items\": [\n {\n \"plu\": \"CMB-01\",\n \"name\": \"Kid Fun Meal Box\",\n \"sortOrder\": 0,\n \"price\": 800,\n \"quantity\": 1,\n \"productType\": 1,\n \"isInternal\": false,\n \"isCombo\": true,\n \"subItems\": [\n {\n \"plu\": \"BRGR-02\",\n \"name\": \"Cheese Burger\",\n \"sortOrder\": 0,\n \"price\": 0,\n \"quantity\": 1,\n \"productType\": 1,\n \"isInternal\": false,\n \"subItems\": []\n },\n {\n \"plu\": \"FRS-02\",\n \"name\": \"Medium Fries\",\n \"sortOrder\": 0,\n \"price\": 0,\n \"quantity\": 1,\n \"productType\": 1,\n \"isInternal\": false,\n \"subItems\": [\n {\n \"plu\": \"SC-02\",\n \"name\": \"Ketchup\",\n \"sortOrder\": 0,\n \"price\": 50,\n \"quantity\": 1,\n \"productType\": 2,\n \"isInternal\": false,\n \"subItems\": []\n }\n ]\n },\n {\n \"plu\": \"DRNK-02\",\n \"name\": \"Iced Tea\",\n \"sortOrder\": 0,\n \"price\": 0,\n \"quantity\": 1,\n \"productType\": 1,\n \"isInternal\": false,\n \"subItems\": []\n }\n ]\n }\n ],\n \"decimalDigits\": 2,\n \"numberOfCustomers\": 1,\n \"channelOrderRawId\": \"5f****ea90efcf106b****1a\",\n \"serviceCharge\": 0,\n \"deliveryCost\": 0,\n \"discountTotal\": 0,\n \"historyDriverUpdates\": [],\n \"capacityUsages\": []\n}","options":{"raw":{"language":"json"}}},"url":"{{webhookUrl}}orders"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"f30943a0-e96f-4c16-b38c-5912ecb26a81","name":"Meal deal example 6: Hamburger combo","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"_id\": \"5f****f1fe54f0048****0f\",\n \"_created\": \"2020-10-06T14:41:19.402000Z\",\n \"_updated\": \"2020-10-06T14:41:19.423000Z\",\n \"_etag\": \"\",\n \"account\": \"5f****e60f73e82f26****22\",\n \"channelOrderId\": \"TEST1601995279\",\n \"channelOrderDisplayId\": \"TEST1601995279\",\n \"posId\": \"\",\n \"posReceiptId\": \"\",\n \"posLocationId\": \"GP-0002\",\n \"location\": \"5f****150f73e82f26****27\",\n \"channelLink\": \"5f****290f73e82f26****2b\",\n \"status\": 1,\n \"statusHistory\": [\n {\n \"timeStamp\": \"2020-10-06T14:41:19.428000Z\",\n \"status\": 4,\n \"response\": \"\",\n \"source\": 5\n },\n {\n \"timeStamp\": \"2020-10-06T14:41:19.435000Z\",\n \"status\": 1,\n \"response\": \"\",\n \"source\": 2\n }\n ],\n \"channelStatusHistory\": [],\n \"by\": \"Foodstack\",\n \"orderType\": 2,\n \"channel\": 1,\n \"pos\": 10000,\n \"pickupTime\": \"2020-10-06T14:41:19.000000Z\",\n \"deliveryTime\": \"2020-10-06T14:41:19.000000Z\",\n \"deliveryIsAsap\": true,\n \"courier\": {\n \"deliveryBy\": \"restaurant\"\n },\n \"customer\": {\n \"name\": \"\",\n \"companyName\": \"\",\n \"phoneNumber\": \"\",\n \"email\": \"\"\n },\n \"deliveryAddress\": {\n \"street\": \"The Krook\",\n \"streetNumber\": \"4\",\n \"postalCode\": \"8888KL\",\n \"city\": \"Gent\",\n \"extraAddressInfo\": \"\"\n },\n \"orderIsAlreadyPaid\": true,\n \"payment\": {\n \"amount\": 200,\n \"type\": 0\n },\n \"note\": \"This is a test order\",\n \"items\": [\n {\n \"plu\": \"P-BRGR\",\n \"name\": \"Hamburger\",\n \"sortOrder\": 0,\n \"price\": 0,\n \"quantity\": 1,\n \"productType\": 1,\n \"isInternal\": false,\n \"isCombo\": true,\n \"subItems\": [\n {\n \"plu\": \"M-FRS-M\",\n \"name\": \"Medium Fries\",\n \"sortOrder\": 0,\n \"price\": 150,\n \"quantity\": 1,\n \"productType\": 1,\n \"isInternal\": false,\n \"subItems\": [\n {\n \"plu\": \"M-SC-KE\",\n \"name\": \"Ketchup\",\n \"sortOrder\": 0,\n \"price\": 50,\n \"quantity\": 1,\n \"productType\": 2,\n \"isInternal\": false,\n \"subItems\": []\n }\n ]\n }\n ]\n }\n ],\n \"decimalDigits\": 2,\n \"numberOfCustomers\": 1,\n \"channelOrderRawId\": \"5f****0f700242957f****ba\",\n \"serviceCharge\": 0,\n \"deliveryCost\": 0,\n \"discountTotal\": 0,\n \"historyDriverUpdates\": [],\n \"capacityUsages\": []\n}","options":{"raw":{"language":"json"}}},"url":"{{webhookUrl}}orders"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"baf6ba63-5ec6-4ad1-b725-36757e9f5a7d"}],"id":"abc2294e-7872-4ab2-b32b-6fabbf03d958","description":"Webhooks are endpoints Foodstack will call. It's up to the integrator to make sure these are hosted on their domain. This URL can be configured per location in Foodstack.
\nWe also send an HMAC header so that you can verify that orders are indeed coming form Foodstack.\nThe HMAC secret is configured for every integration partner and will be communicated to you in a secure way. Before an HMAC secret is assigned to you, the request is signed using the channelLinkId as HMAC secret. Before certifying the integration, a secure HMAC secret should be set.
\nMore than one reporting endpoint can be configured. This way the data can be sent to multiple systems, so for instance the POS, but also the accounting system. Atm we only support one secret key per customer, not per reporting endpoint.
\n","event":[{"listen":"prerequest","script":{"id":"290710e4-2585-466c-a7fd-3ef0d465ad48","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e3a3ac3b-bca3-4dff-bd29-aa2fb7c24493","type":"text/javascript","exec":[""]}}],"_postman_id":"abc2294e-7872-4ab2-b32b-6fabbf03d958","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{integratorToken}}"}],"advancedConfig":[{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"ec7259bd-82f3-4a09-a170-39a4e647fd84","id":"ec7259bd-82f3-4a09-a170-39a4e647fd84","name":"Foodstack Public API","type":"collection"}}}],"id":"092d6392-91fb-4bbe-be81-e71988c302d1","description":"As a POS you can find all the methods to integrate with us here. They all require a token in order to work.
\nYou can login to our backoffice to see your orders, and go to the test orders page to create orders using your current menu. This allows you to test all components of the integration.
\nThe webhook part of this API can also be used for simple integrations that only require the orders. To receive these webhooks it's enough to add a Reporting endpoint to the channelLink.
\nThe polling of orders should only be used when your system goes offline and you want to get the missed orders for a short time frame. This should not be used for the constant polling of orders. To receive orders you should have an endpoint publicly available that can be used.
\n","event":[{"listen":"prerequest","script":{"id":"ca0443d3-2e85-4837-90fd-49de7f0b5b11","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4ce8ca22-db25-44ee-9e1a-0a5bc9925003","type":"text/javascript","exec":[""]}}],"_postman_id":"092d6392-91fb-4bbe-be81-e71988c302d1","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{integratorToken}}"}],"advancedConfig":[{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"ec7259bd-82f3-4a09-a170-39a4e647fd84","id":"ec7259bd-82f3-4a09-a170-39a4e647fd84","name":"Foodstack Public API","type":"collection"}}},{"name":"Channel API","item":[{"name":"Webhooks","item":[{"name":"Channel status","id":"a0b62eb0-83e9-4544-a425-dc618d4a4869","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"status\": \"active\",\n \"channelLocationId\": \"{{externalChannelLocationId}}\",\n \"channelLinkId\": \"{{channelLinkId}}\"\n}"},"url":"{{YourSetwebhookUrl}}","description":"Gets called when the status of a channel changes.\nFor instance when a new customer adds a channel you will receive the \"register\" event. After this event it should be possible to push the menu to the channel.
\nThis endpoint gets called when :
\n\n- a customer registers a location for this channel (register)
\n- a customer wants to start receiving orders for this location (active)
\n- a customer wants to stop receiving orders for this location (inactive)
\n
\nWe always expect a JSON result which contains the endpoints to:
\n\n- receive status updates (statusUpdateURL)
\n- receive menus (menuUpdateURL)
\n- receive disabled products (disabledProductsURL)
\n- stop sending orders to foodstack.brain.io (disableURL)
\n- snooze or unsnooze (snoozeUnsnoozeURL)
\n- enable or disable busy mode (busyModeURL)
\n
\nIf an endpoint is empty or not included in this response we will not use it.\nFor instance if you choose not to set the receive status update endpoint we will not try to send status updates to you.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{integratorToken}}"}],"advancedConfig":[{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"ec7259bd-82f3-4a09-a170-39a4e647fd84","id":"ec7259bd-82f3-4a09-a170-39a4e647fd84","name":"Foodstack Public API","type":"collection"}},"urlObject":{"host":["{{YourSetwebhookUrl}}"],"query":[],"variable":[]}},"response":[{"id":"9073ebb6-ee7c-4ea2-9652-7744da935bd4","name":"Enable channel","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"status\": \"active\",\n \"channelLocationId\": \"{{externalChannelLocationId}}\",\n \"channelLinkId\": \"{{channelLinkId}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{YourSetwebhookUrl}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":""},{"key":"Access-Control-Allow-Headers","value":""},{"key":"Access-Control-Allow-Methods","value":""},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":""},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 10 Apr 2019 07:36:16 GMT"},{"key":"ETag","value":"W/\"a8-eH6f7zXW/epV8Ovh5IJkkw\""},{"key":"Server","value":"nginx"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Length","value":"145"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"statusUpdateURL\": \"https://integrator.com/statusUpdate\",\n \"menuUpdateURL\": \"https://integrator.com/menuUpdate\",\n \"disabledProductsURL\": \"https://integrator.com/disableProducts\",\n \"snoozeUnsnoozeURL\": \"https://integrator.com/snoozeUnsnooze\",\n \"busyModeURL\": \"https://integrator.com/busyMode\"\n}"}],"_postman_id":"a0b62eb0-83e9-4544-a425-dc618d4a4869"},{"name":"Menu push","id":"51853b24-a92c-4b66-89bd-9daf68a2eef8","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"menu\": \"Foodstack Special menu\",\n \"availabilities\": [\n {\n \"dayOfWeek\": \"1\",\n \"startTime\": \"13:00\",\n \"endTime\": \"21:30\"\n },\n {\n \"dayOfWeek\": \"3\",\n \"startTime\": \"09:30\",\n \"endTime\": \"21:30\"\n },\n {\n \"dayOfWeek\": \"4\",\n \"startTime\": \"09:30\",\n \"endTime\": \"21:30\"\n },\n {\n \"dayOfWeek\": \"5\",\n \"startTime\": \"09:30\",\n \"endTime\": \"21:30\"\n },\n {\n \"dayOfWeek\": \"6\",\n \"startTime\": \"09:30\",\n \"endTime\": \"21:30\"\n }\n ],\n \"categories\": [\n {\n \"_id\": \"5c7d12a4c6489f0001af499a\",\n \"account\": \"5bf689b0c6489f002f1276dc\",\n \"name\": \"Burgers\",\n \"nameTranslations\": {},\n \"description\": \"\",\n \"descriptionTranslations\": {}, \n \"availabilities\": [],\n \"imageUrl\": \"http://bookmarkurl.info/images/product-unknown/product-unknown-8.jpg\",\n \"products\": [\n \"5c4efd43c6489f0001498a53\",\n \"5c4efd43c6489f0001498a54\",\n \"5c4efd43c6489f0001498a5d\"\n ],\n \"menu\": \"5c7d1287c6489f0001af4999\"\n },\n {\n \"_id\": \"5cade196c6489f00019c80ad\",\n \"account\": \"5bf689b0c6489f002f1276dc\",\n \"name\": \"Salads\",\n \"nameTranslations\": {},\n \"description\": \"\",\n \"descriptionTranslations\": {},\n \"availabilities\": [],\n \"imageUrl\": \"http://bookmarkurl.info/images/product-unknown/product-unknown-8.jpg\",\n \"products\": [\n \"5c4efd43c6489f0001498a63\",\n \"5c4efd43c6489f0001498a64\"\n ],\n \"menu\": \"5c7d1287c6489f0001af4999\"\n },\n {\n \"_id\": \"5cade247c6489f00019c80b4\",\n \"account\": \"5bf689b0c6489f002f1276dc\",\n \"name\": \"Deserts\",\n \"nameTranslations\": {},\n \"description\": \"\",\n \"descriptionTranslations\": {},\n \"availabilities\": [],\n \"imageUrl\": \"http://bookmarkurl.info/images/product-unknown/product-unknown-8.jpg\",\n \"products\": [\n \"5c4efd43c6489f0001498a65\"\n ],\n \"menu\": \"5c7d1287c6489f0001af4999\"\n },\n {\n \"_id\": \"5cade261c6489f00019c80b6\",\n \"account\": \"5bf689b0c6489f002f1276dc\",\n \"name\": \"Drinks\",\n \"nameTranslations\": {},\n \"description\": \"\",\n \"descriptionTranslations\": {},\n \"availabilities\": [],\n \"imageUrl\": \"http://bookmarkurl.info/images/product-unknown/product-unknown-8.jpg\",\n \"products\": [\n \"5c4efd43c6489f0001498ab2\",\n \"5c4efd43c6489f0001498ab3\"\n ],\n \"menu\": \"5c7d1287c6489f0001af4999\",\n \"level\": 1\n }\n ],\n \"products\": {\n \"5c4efd43c6489f0001498a53\": {\n \"_id\": \"5c4efd43c6489f0001498a53\",\n \"account\": \"5bf689b0c6489f002f1276dc\",\n \"location\": \"5bf689d0c6489f002f1276dd\",\n \"productType\": 1,\n \"plu\": \"AAB12\",\n \"price\": 1250,\n \"name\": \"Cheese bacon\",\n \"deliveryTax\": 15,\n \"subProducts\": [\n \"5c4efd43c6489f0001498a3f\"\n ],\n \"productTags\": [\n 106\n ],\n \"imageUrl\": \"https://www.rachaelraymag.com/.image/t_share/MTQ3MTUxMjMxNzM3OTMxNTAz/two-cheese-bacon-burger-creamy-caramelized-onion-sauce-0617-103010848.jpg\",\n \"description\": \"\",\n \"max\": \"0\",\n \"min\": \"0\",\n \"channel\": -1\n },\n \"5c4efd43c6489f0001498a54\": {\n \"_id\": \"5c4efd43c6489f0001498a54\",\n \"account\": \"5bf689b0c6489f002f1276dc\",\n \"location\": \"5bf689d0c6489f002f1276dd\",\n \"productType\": 1,\n \"plu\": \"AAB13\",\n \"price\": 1150,\n \"name\": \"Crispy Chicken\",\n \"deliveryTax\": 15,\n \"subProducts\": [],\n \"imageUrl\": \"https://thecozyapron.com/wp-content/uploads/2014/03/spicy-caesar-chix-sand_02-23-14_1_ca.jpg\",\n \"description\": \"\",\n \"max\": \"0\",\n \"min\": \"0\",\n \"channel\": -1\n },\n \"5c4efd43c6489f0001498a5d\": {\n \"_id\": \"5c4efd43c6489f0001498a5d\",\n \"account\": \"5bf689b0c6489f002f1276dc\",\n \"location\": \"5bf689d0c6489f002f1276dd\",\n \"productType\": 1,\n \"plu\": \"BUR002\",\n \"price\": 2000,\n \"name\": \"Cheese Burger\",\n \"deliveryTax\": 15,\n \"subProducts\": [],\n \"imageUrl\": \"https://www.sbs.com.au/food/sites/sbs.com.au.food/files/lotus-burger-lead.jpg\",\n \"description\": \"\",\n \"max\": \"0\",\n \"min\": \"0\",\n \"channel\": -1\n },\n \"5c4efd43c6489f0001498a63\": {\n \"_id\": \"5c4efd43c6489f0001498a63\",\n \"account\": \"5bf689b0c6489f002f1276dc\",\n \"location\": \"5bf689d0c6489f002f1276dd\",\n \"productType\": 1,\n \"plu\": \"ABFs1\",\n \"price\": 1250,\n \"name\": \"Caesar\",\n \"deliveryTax\": 15,\n \"subProducts\": [],\n \"imageUrl\": \"\",\n \"description\": \"\",\n \"max\": \"0\",\n \"min\": \"0\",\n \"channel\": -1\n },\n \"5c4efd43c6489f0001498a64\": {\n \"_id\": \"5c4efd43c6489f0001498a64\",\n \"account\": \"5bf689b0c6489f002f1276dc\",\n \"location\": \"5bf689d0c6489f002f1276dd\",\n \"productType\": 1,\n \"plu\": \"ABFs2\",\n \"price\": 950,\n \"name\": \"Quinoa & lgumes croquants\",\n \"deliveryTax\": 15,\n \"subProducts\": [],\n \"imageUrl\": \"\",\n \"description\": \"\",\n \"max\": \"0\",\n \"min\": \"0\",\n \"channel\": -1\n },\n \"5c4efd43c6489f0001498a65\": {\n \"_id\": \"5c4efd43c6489f0001498a65\",\n \"account\": \"5bf689b0c6489f002f1276dc\",\n \"location\": \"5bf689d0c6489f002f1276dd\",\n \"productType\": 1,\n \"plu\": \"PIE1\",\n \"price\": 800,\n \"name\": \"Cherry Pie\",\n \"deliveryTax\": 15,\n \"subProducts\": [],\n \"imageUrl\": \"\",\n \"description\": \"\",\n \"max\": \"0\",\n \"min\": \"0\",\n \"channel\": -1\n },\n \"5c4efd43c6489f0001498ab2\": {\n \"_id\": \"5c4efd43c6489f0001498ab2\",\n \"account\": \"5bf689b0c6489f002f1276dc\",\n \"location\": \"5bf689d0c6489f002f1276dd\",\n \"productType\": 1,\n \"plu\": \"MSB1\",\n \"price\": 580,\n \"name\": \"Milkshake\",\n \"deliveryTax\": 15,\n \"subProducts\": [],\n \"imageUrl\": \"\",\n \"description\": \"\",\n \"max\": \"0\",\n \"min\": \"0\",\n \"channel\": -1\n },\n \"5c4efd43c6489f0001498ab3\": {\n \"_id\": \"5c4efd43c6489f0001498ab3\",\n \"account\": \"5bf689b0c6489f002f1276dc\",\n \"location\": \"5bf689d0c6489f002f1276dd\",\n \"productType\": 1,\n \"plu\": \"YGB1\",\n \"price\": 430,\n \"name\": \"Yoghurt\",\n \"deliveryTax\": 15,\n \"subProducts\": [],\n \"imageUrl\": \"\",\n \"uniqueKey\": \"139442\",\n \"description\": \"\",\n \"max\": \"0\",\n \"min\": \"0\",\n \"channel\": -1\n }\n },\n \"modifierGroups\": {\n \"5c4efd43c6489f0001498a3f\": {\n \"_id\": \"5c4efd43c6489f0001498a3f\",\n \"account\": \"5bf689b0c6489f002f1276dc\",\n \"location\": \"5bf689d0c6489f002f1276dd\",\n \"productType\": 3,\n \"plu\": \"2744\",\n \"price\": 0,\n \"name\": \"Curry\",\n \"deliveryTax\": 15,\n \"subProducts\": [\n \"5c5480b9c6489f0001950c8b\",\n \"5c5480b9c6489f0001950c8c\"\n ],\n \"imageUrl\": \"http://bookmarkurl.info/images/product-unknown/product-unknown-8.jpg\",\n \"description\": \"\",\n \"max\": 2,\n \"min\": 0,\n \"multiMax\": 2,\n \"channel\": -1\n }\n },\n \"modifiers\": {\n \"5c5480b9c6489f0001950c8b\": {\n \"_id\": \"5c5480b9c6489f0001950c8b\",\n \"account\": \"5bf689b0c6489f002f1276dc\",\n \"location\": \"5bf689d0c6489f002f1276dd\",\n \"productType\": 2,\n \"plu\": \"S2\",\n \"price\": 100,\n \"name\": \"Thai\",\n \"deliveryTax\": 15,\n \"subProducts\": [],\n \"imageUrl\": \"http://bookmarkurl.info/images/product-unknown/product-unknown-8.jpg\",\n \"description\": \"\",\n \"max\": \"0\",\n \"min\": \"0\",\n \"channel\": -1\n },\n \"5c5480b9c6489f0001950c8c\": {\n \"_id\": \"5c5480b9c6489f0001950c8c\",\n \"account\": \"5bf689b0c6489f002f1276dc\",\n \"location\": \"5bf689d0c6489f002f1276dd\",\n \"productType\": 2,\n \"plu\": \"S1\",\n \"price\": 430,\n \"name\": \"Curry\",\n \"deliveryTax\": 15,\n \"subProducts\": [],\n \"imageUrl\": \"http://bookmarkurl.info/images/product-unknown/product-unknown-8.jpg\",\n \"description\": \"Chicken Curry\",\n \"max\": \"0\",\n \"min\": \"0\",\n \"channel\": -1\n }\n },\n \"snoozedProducts\": {\n \"5c4efd43c6489f0001498a54\": {\n \"location\": \"5bf689d0c6489f002f1276dd\",\n \"plu\": \"AAB13\",\n \"name\": \"Crispy Chicken\",\n \"snoozeStart\": \"2020-05-07 07:51:01.195000+00:00\",\n \"snoozeEnd\": \"2020-05-07 13:51:01.195000+00:00\"\n }\n },\n \"channelLinkId\": \"5bfd9c52c11dec000122474d\"\n }\n]"},"url":"{{YourSetwebhookUrl}}","description":"Your channel will receive this type of request every time a user pushes a menu from within Foodstack.
\nModifiers and modifier groups
\nTo explain what modifiers and modifier groups are, consider the following example.
\nSay that a restaurant sells a range of delicious pizzas. For the sake of simplicity, suppose they only sell them in a single size, \"Normal\". Despite the variety of pizzas, the restaurant wants to offer customers the ability to add extra toppings of their choosing to the pizza they order.
\nIn Foodstack, this will be modeled using modifiers and modifier groups. Each topping is a modifier, which will end up looking like this in the JSON that will be sent in the menu push request:
\n...\n\"modifiers\" : {\n \"ef4480b9c6489f0001722567\" : {\n \"_id\" : \"ef4480b9c6489f0001722567\",\n ...\n \"name\" : \"Pepperoni\",\n \"price\" : 300,\n ...\n },\n \"ef4480b9c6489f0001722568\" : {\n \"_id\" : \"ef4480b9c6489f0001722568\",\n ...\n \"name\" : \"Cheese\",\n \"price\" : 200,\n ...\n },\n \"ef4480b9c6489f0001722569\" : {\n \"_id\" : \"ef4480b9c6489f0001722569\",\n ...\n \"name\" : \"Olives\",\n \"price\" : 300,\n ...\n },\n ...\n},\n...\n
\nTo group the different choices (modifiers) together, we create a modifier group. The group should have a customer facing name (e.g. \"Choose Toppings\") and minimum and maximum quantity constraints.\nAgain, this is what the JSON for this would look like:
\n...\n\"modifierGroups\": {\n \"ef4480b9c6489014aa26183f\" : {\n \"_id\" : \"ef4480b9c6489014aa26183f\",\n ...\n \"name\" : \"Choose Toppings\"\n \"subProducts\" : [\n \"ef4480b9c6489f0001722567\",\n \"ef4480b9c6489f0001722568\",\n \"ef4480b9c6489f0001722569\",\n ...\n ],\n ...\n \"max\" : 5,\n \"min\" : 0,\n ...\n }\n},\n...\n
\nFirst off, notice that the IDs of the modifiers corresponding to each topping are in the subProducts in the dictionary describing the modifier group.
\nAlso have a look at max and min in the JSON above. They're used to indicate the maximum and minimum amount of modifiers customers can select from this modifier group.
\nIn our example case, we use the modifiers to have a customer select extra toppings to put on top of their pizza. If we say that someone ordering pizza shouldn't have to select even a single extra topping, then we have \"min\" : 0. If, say, for practical reasons, we also want to limit the amount of extra toppings to five, we get \"max\" : 5. Those values correspond with what's in the JSON above.
\nModifiers could also be used for a different purpose. Suppose the restaurant in our example wants to add a new pizza size, \"Large\". In that case, each size would be a modifier. The default size, \"Normal\", could be modeled as a modifier with price zero. The new \"Large\" size could then have a price that reflects the corresponding supplement.\nIf we use the modifiers to have a customer choose the size of their pizza, it makes sense that we only allow selecting exactly one modifier. In that case, the values for max and min would be:
\n...\n\"max\": 1,\n\"min\": 1,\n...\n
\nLastly, have a look at the request to the right, as this also gives an example of how modifiers and modifier groups are used, and what they look like in a complete menu push request.
\nMulti-select modifiers
\nIn some cases, it must be possible for modifiers in a certain modifier group to be selected more than once.
\nHave a look at the JSON menu push example. Look for the modifier group with PLU 2744, more specifically how max and multiMax are used.
\n\nThe max field gets a value of two. This indicates the maximal number of modifiers that can be selected should be limited to two. As there are only two modifiers in the group, this in itself wouldn't make much of a difference when modifiers can only be selected once.
\nAdding multiMax indicates that modifiers in this modifier group should be selectable more than once. Because it has a value of two, each modifier should be selectable at most two times.
\n
\n\nA product can have one or more product tags. For each product in products, those tags are contained in a list with key productTags. Product tags can be used to indicate consumable types, which your channel should indicate to end users on menus.
\nAvailabilities
\nWith every menu that is pushed, there will be a list of availabilities, which indicate when customers ordering food should be able to order from that menu online. Ideally, your channel API makes it so this doesn't close the store outside of those hours, but limits when food can be picked up/delivered (see also the note near the end of this subsection).
\nA single entry in this list of availabilities looks like the code snippet below.
\n{\n \"dayOfWeek\": \"1\",\n \"startTime\": \"13:00\",\n \"endTime\": \"21:30\"\n}\n
\nFor a single entry, its fields are dayOfWeek, startTime, and endTime. Please find a brief explanation of their use in the table below.
\n\n\n\n| Field | \nUse | \n
\n\n\n\ndayOfWeek | \nan integer value that indicates the day of the week for this availability (starting at 1 for Sunday) | \n
\n\nstartTime | \na 24-hour HH:MM format notation of the start time of an availability | \n
\n\nendTime | \na 24-hour HH:MM format notation of the end time of an availability | \n
\n\n
\n
Note that the availabilities of a menu are not indicative of whether a store is open or closed. Ordering from a menu should only be possible when the store is open and the current time corresponds with an availability of the menu. Likewise, it should be clear to a customer ordering food whether they are unable to do so because the menu is not currently available to them, or because the store is closed.
\nHave a look at the example request on the right, which shows what a list of availabilities tied to a menu looks like in a complete menu push request.
\nSnoozed products
\nEach menu can have a list of snoozed products (called snoozedProducts). These contain the PLUs of products and modifiers that are currently snoozed and should be unavailable on the menu. The end date of each product snooze is contained within this list in the snoozeEnd field.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{integratorToken}}"}],"advancedConfig":[{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"ec7259bd-82f3-4a09-a170-39a4e647fd84","id":"ec7259bd-82f3-4a09-a170-39a4e647fd84","name":"Foodstack Public API","type":"collection"}},"urlObject":{"host":["{{YourSetwebhookUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"51853b24-a92c-4b66-89bd-9daf68a2eef8"},{"name":"Order status update","id":"1fa463ea-3ee4-4185-878d-c42ddded0244","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"channelOrderId\": \"X7CESD\",\n \"orderId\": \"<>\",\n \"location\": \"<>\",\n \"status\": 2,\n \"timeStamp\": \"2019-05-15 11:45:36.332906\"\n}"},"url":"{{YourSetwebhookUrl}}","description":"A status update for an order happens when a POS performs an action on that order.
\nEach incoming status update should be confirmed with at HTTP status 200.
\nThe table below lists statuses and their corresponding integer value.
\n\n\n\n| Foodstack status tag | \nDescription | \nInteger value | \n
\n\n\n\nPARSED | \nreceived and parsed by Foodstack | \n1 | \n
\n\nRECEIVED | \nreceived by POS | \n2 | \n
\n\nNEW | \nreceived by POS and receipt is created | \n10 | \n
\n\nACCEPTED | \naccepted/confirmed | \n20 | \n
\n\nREJECTED | \nrejected | \n30 | \n
\n\nPRINTED | \nprinted | \n40 | \n
\n\nPREPARING | \nin preparation | \n50 | \n
\n\nPREPARED | \nis prepared | \n60 | \n
\n\nREADY FOR PICKUP | \nready for pickup | \n70 | \n
\n\nIN DELIVERY | \nen route to customer | \n80 | \n
\n\nFINALIZED | \nfinalized, order has been fully completed | \n90 | \n
\n\nCANCEL | \nshould be voided | \n100 | \n
\n\nCANCELED | \nhas been voided on POS | \n110 | \n
\n\nFAILED | \nfailed | \n120 | \n
\n\nPOS RECEIVED FAILED | \nnot received by POS | \n121 | \n
\n\nPARSE FAILED | \nparsing failed | \n124 | \n
\n\n
\n
REJECTED should only be used if the order is already in the POS and was (accidentally) submitted a second time.
\nFINALIZED means that the order is finalised in the POS. Note that this doesn't necessarily mean that the food has also already been delivered to the end customer!
\n
\nCANCEL vs CANCELED
\nCANCEL
\nThis is a status your channel should send for an order you want to be canceled by the POS (for example when an end customer places an order, but then immediately changes their mind and cancels the order).
\nCANCELED
\nMeans the order was canceled by the POS. When you receive this status, you can confirm that the order was canceled by the restaurant. As long as you did not receive this status, your channel should not yet assume the cancellation was successful.
\nIn this case, Foodstack will resend the order to the POS, with the same channelOrderId and channelOrderDisplayId.
\nAn example of a status update for a CANCELED order can be selected from the drop-down on the right.
\nNote: Your channel is not yet required to support order cancellation in order to become or remain certified.
\n
\nFAILED is a status that should be used when the POS could not be reached, or when an order could not be processed correctly, for example when a product is available on the merchant's online store, but deleted in his POS account.
\nNote
\nIf you receive a status that is not documented above, these can safely be ignored in most cases. Contact Foodstack to get the meaning of this status.
\nIn no case should an unknown status hinder your flow of processing orders.
\nWhen sending a status update for an order, make sure to include the channelOrderId. The value for this corresponds to the _id field from the order that was originally sent.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{integratorToken}}"}],"advancedConfig":[{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"ec7259bd-82f3-4a09-a170-39a4e647fd84","id":"ec7259bd-82f3-4a09-a170-39a4e647fd84","name":"Foodstack Public API","type":"collection"}},"urlObject":{"host":["{{YourSetwebhookUrl}}"],"query":[],"variable":[]}},"response":[{"id":"880b00c6-1045-4af6-86cc-e0a8a5239e5e","name":"Order CANCELED","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"channelOrderId\": \"X7CESD\",\n \"orderId\": \"<>\",\n \"location\": \"<>\",\n \"status\": 110,\n \"timeStamp\": \"2019-05-15 11:45:36.332906\"\n}","options":{"raw":{"language":"json"}}},"url":"{{YourSetwebhookUrl}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"channelOrderId\": \"X7CESD\",\n \"orderId\": \"<>\",\n \"location\": \"<>\",\n \"status\": 110,\n \"timeStamp\": \"2019-05-15 11:45:37.790214\"\n}"},{"id":"9145a6f6-766f-45ab-938f-58b0810abfd1","name":"Update status to RECEIVED","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"channelOrderId\": \"X7CESD\",\n \"orderId\": \"<>\",\n \"location\": \"<>\",\n \"status\": 2,\n \"timeStamp\": \"2019-05-15 11:45:36.332906\"\n}","options":{"raw":{"language":"json"}}},"url":"{{YourSetwebhookUrl}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"channelOrderId\": \"X7CESD\",\n \"orderId\": \"<>\",\n \"location\": \"<>\",\n \"status\": 2,\n \"timeStamp\": \"2019-05-15 11:45:37.790214\"\n}"}],"_postman_id":"1fa463ea-3ee4-4185-878d-c42ddded0244"},{"name":"Snooze products","id":"089b98aa-631a-4b53-bee5-bfd48b5adc69","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"accountId\": \"5b****71c6489f0029****d4\",\n \"locationId\": \"5c****ecc6489f0001****b8\",\n \"channelLinkId\": \"5e****abc11dec0001****9b\",\n \"operations\": [\n {\n \"action\": \"snooze\",\n \"data\": {\n \"items\": [\n {\n \"_id\": \"5c****43c6489f0001****65\",\n \"plu\": \"PIE1\",\n \"snoozeStart\": \"2020-03-24T16:21:54.955000Z\",\n \"snoozeEnd\": \"2020-03-24T22:21:54.955000Z\"\n },\n {\n \"_id\": \"5c****43c6489f0001****3b\",\n \"plu\": \"MSB1\",\n \"snoozeStart\": \"2020-03-24T16:21:54.955000Z\",\n \"snoozeEnd\": \"2020-03-24T22:21:54.955000Z\"\n }\n ]\n }\n }\n ]\n}"},"url":"{{YourSetwebhookUrl}}","description":"Temporarily marking one or more products as unavailable (e.g. because they are out of stock, or some of the ingredients to make them are), is called snoozing.
\n
\nWhat should a snoozed product look like on my channel?
\nThe desired effect of a product being snoozed is that the product remains visible in the target store, but that it is visually clear that the product is currently unavailable. This can be done by e.g. greying out a product's entry, and making it so it cannot be selected in the store. As a snooze request also contains the amount of time for which each product is snoozed, it is possible to show an estimate of when a snoozed product will become available again.\nIf your channel cannot support this way of handling snoozed products, the next best thing is to temporarily not display snoozed products on the target store. However, note that this is less clear to customers ordering food online: if they cannot see the snoozed product, they may not understand when, if ever, it will become available again. And that is only if they were even aware of the product's existence in the first place.
\n
\n\nTo snooze one or more products, your channel API will receive requests in the format shown in the request on the right. For a combination of accountId, locationId and channelLinkId, the request will contain a list of actions. In this case, the action is snooze.
\nIn general, an action also has a data field. For the snooze action, the data contains items, which is a list of items that have to be snoozed.\nNote that, for each item in items, you can see the period during which it should be snoozed, with start and end times stored as snoozeStart and snoozeEnd, respectively. The example on the right shows what timestamp format is used for these values.
\nBy default, the list of items you will receive in a snooze request from Foodstack will contain only additional items to snooze. If your channel cannot support this, you can change this setting for the channel link for your channel within Foodstack, so that every time you receive a snooze request for your channel, you will also receive a full list allSnoozedItems of all items that should be snoozed (including items that should already have been snoozed).
\n\nThe response should indicate snoozing was successful with a 200 OK status code, and the (JSON) body should consist of a list of results that correspond to the required actions in the request. Each result should repeat the snooze action, for confirmation. Like an action, a result also has a data field. For the snooze action, the data should contain the ID of the location for which items were snoozed, as well as a list with the PLUs of all items that are currently snoozed (including products that were already snoozed). This is also for confirmation.\nOnly use a 200 OK response to indicate that all items listed in the request were successfully snoozed. Also make sure to only send this response after having snoozed all items; the moment your channel sends this response, items must already be snoozed in the targeted store.
\nIf the desired snooze action cannot be performed, send back an appropriate response and corresponding status. If any of the issues below manifest themselves, make sure to indicate each of them in an array in your response.
\n
\nNotice: Work in progress
\nBefore this functionality goes live, we will rework the format of how you should report issues to us. However, in any case we will still require you to send back a list of all products that are currently snoozed.
\n
\n\n\n\n| Issue | \nWhat to do | \n
\n\n\n\n| One or more product(s) used in the request do(es) not exist on your end | \nSnooze all products that can be snoozed, but send back a failure status (as not all products could be snoozed) | \n
\n\n| One or more product(s) used in the request do(es) not exist on your end | \nNothing needs to be done, as the desired effect is already achieved. If this is the only type of issue, you can still send back a success status. | \n
\n\n
\n
For each product that causes one of these issue, send back its ID and its PLU.
\nHave a look at the example responses on the right to see what format you should use to communicate issues back.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{integratorToken}}"}],"advancedConfig":[{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"ec7259bd-82f3-4a09-a170-39a4e647fd84","id":"ec7259bd-82f3-4a09-a170-39a4e647fd84","name":"Foodstack Public API","type":"collection"}},"urlObject":{"host":["{{YourSetwebhookUrl}}"],"query":[],"variable":[]}},"response":[{"id":"8d6f5327-ab5d-465f-b64f-d109a09c7e4e","name":"Product already snoozed","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"accountId\": \"5b****71c6489f0029****d4\",\n \"locationId\": \"5c****ecc6489f0001****b8\",\n \"channelLinkId\": \"5e****abc11dec0001****9b\",\n \"operations\": [\n {\n \"action\": \"snooze\",\n \"data\": {\n \"items\": [\n {\n \"_id\": \"5c****43c6489f0001****65\",\n \"plu\": \"PIE1\",\n \"snoozeStart\": \"2020-03-24T16:21:54.955000Z\",\n \"snoozeEnd\": \"2020-03-24T22:21:54.955000Z\"\n },\n {\n \"_id\": \"5c****43c6489f0001****3b\",\n \"plu\": \"MSB1\",\n \"snoozeStart\": \"2020-03-24T16:21:54.955000Z\",\n \"snoozeEnd\": \"2020-03-24T22:21:54.955000Z\"\n }\n ]\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{YourSetwebhookUrl}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"action\": \"snooze\",\n \"data\": {\n \"locationId\": \"5c****ecc6489f0001****b8\",\n \"allSnoozedItems\": [\n \"PIE1\",\n \"MSB1\"\n ]\n },\n \"issues\": [\n {\n \"description\": \"Product already snoozed\",\n \"data\": {\n \"_id\": \"5c****43c6489f0001****65\",\n \"plu\": \"PIE1\"\n }\n }\n ]\n }\n ]\n}"},{"id":"96c14596-3c74-4234-900e-c76422015bcd","name":"Everything okay","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"accountId\": \"5b****71c6489f0029****d4\",\n \"locationId\": \"5c****ecc6489f0001****b8\",\n \"channelLinkId\": \"5e****abc11dec0001****9b\",\n \"operations\": [\n {\n \"action\": \"snooze\",\n \"data\": {\n \"items\": [\n {\n \"_id\": \"5c****43c6489f0001****65\",\n \"plu\": \"PIE1\",\n \"snoozeStart\": \"2020-03-24T16:21:54.955000Z\",\n \"snoozeEnd\": \"2020-03-24T22:21:54.955000Z\"\n },\n {\n \"_id\": \"5c****43c6489f0001****3b\",\n \"plu\": \"MSB1\",\n \"snoozeStart\": \"2020-03-24T16:21:54.955000Z\",\n \"snoozeEnd\": \"2020-03-24T22:21:54.955000Z\"\n }\n ]\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{YourSetwebhookUrl}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"action\": \"snooze\",\n \"data\": {\n \"locationId\": \"5c****ecc6489f0001****b8\",\n \"allSnoozedItems\": [\n \"PIE1\",\n \"MSB1\"\n ]\n }\n }\n ]\n}"},{"id":"e3f30e66-61eb-4311-86fc-0b9d3803030f","name":"All snoozed products required","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"accountId\": \"5b****71c6489f0029****d4\",\n \"locationId\": \"5c****ecc6489f0001****b8\",\n \"channelLinkId\": \"5e****abc11dec0001****9b\",\n \"operations\": [\n {\n \"action\": \"snooze\",\n \"data\": {\n \"items\": [\n {\n \"_id\": \"5c****43c6489f0001****65\",\n \"plu\": \"PIE1\",\n \"snoozeStart\": \"2020-03-24T16:21:54.955000Z\",\n \"snoozeEnd\": \"2020-03-24T22:21:54.955000Z\"\n }\n ],\n \"allSnoozedItems\": [\n {\n \"_id\": \"5c****43c6489f0001****65\",\n \"plu\": \"PIE1\",\n \"snoozeStart\": \"2020-03-24T16:21:54.955000Z\",\n \"snoozeEnd\": \"2020-03-24T22:21:54.955000Z\"\n },\n {\n \"_id\": \"5c****43c6489f0001****3b\",\n \"plu\": \"MSB1\",\n \"snoozeStart\": \"2020-03-24T16:21:54.955000Z\",\n \"snoozeEnd\": \"2020-03-24T22:21:54.955000Z\"\n }\n ]\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{YourSetwebhookUrl}}"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"fa97a56c-714f-492a-95c0-2b9233fa6b8e","name":"Unknown product","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"accountId\": \"5b****71c6489f0029****d4\",\n \"locationId\": \"5c****ecc6489f0001****b8\",\n \"channelLinkId\": \"5e****abc11dec0001****9b\",\n \"operations\": [\n {\n \"action\": \"snooze\",\n \"data\": {\n \"items\": [\n {\n \"_id\": \"5c****43c6489f0001****65\",\n \"plu\": \"PIE1\",\n \"snoozeStart\": \"2020-03-24T16:21:54.955000Z\",\n \"snoozeEnd\": \"2020-03-24T22:21:54.955000Z\"\n },\n {\n \"_id\": \"5c****43c6489f0001****3b\",\n \"plu\": \"MSB1\",\n \"snoozeStart\": \"2020-03-24T16:21:54.955000Z\",\n \"snoozeEnd\": \"2020-03-24T22:21:54.955000Z\"\n }\n ]\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{YourSetwebhookUrl}}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"action\": \"snooze\",\n \"data\": {\n \"locationId\": \"5c****ecc6489f0001****b8\",\n \"allSnoozedItems\": [\n \"PIE1\",\n \"MSB1\"\n ]\n },\n \"issues\": [\n {\n \"description\": \"Unknown product\",\n \"data\": {\n \"_id\": \"5c****43c6489f0001****3b\",\n \"plu\": \"MSB1\"\n }\n }\n ]\n }\n ]\n}"}],"_postman_id":"089b98aa-631a-4b53-bee5-bfd48b5adc69"},{"name":"Unsnooze products","id":"2c39dc2f-1354-4bef-be1e-21718de51484","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"accountId\": \"5b****71c6489f0029****d4\",\n \"locationId\": \"5c****ecc6489f0001****b8\",\n \"channelLinkId\": \"5e****abc11dec0001****9b\",\n \"operations\": [\n {\n \"action\": \"unsnooze\",\n \"data\": {\n \"items\": [\n {\n \"_id\": \"5c****43c6489f0001****65\",\n \"plu\": \"PIE1\",\n \"snoozeStart\": \"2020-03-24T16:21:54.955000Z\",\n \"snoozeEnd\": \"2020-03-24T22:21:54.955000Z\"\n },\n {\n \"_id\": \"5c****43c6489f0001****3b\",\n \"plu\": \"MSB1\",\n \"snoozeStart\": \"2020-03-24T16:21:54.955000Z\",\n \"snoozeEnd\": \"2020-03-24T22:21:54.955000Z\"\n }\n ]\n }\n }\n ]\n}"},"url":"{{YourSetwebhookUrl}}","description":"When a product or one of its ingredients becomes available once more, the product that was snoozed before should now be unsnoozed.
\n
\nWho keeps track of when to unsnooze?
\nBy default, even though you will receive the time when a product should be unsnoozed in a snooze request, Foodstack will send you an unsnooze request when that time expires. If your channel can take care of keeping track of when products should be unsnoozed, you can change this setting for the channel link for your channel within Foodstack, so that Foodstack will no longer send unsnooze requests for products for which the snooze period has expired. It is important to note, however, that, even if your channel keeps track of this information, it must still support unsnoozing on-demand, before the intended snooze period expires.
\n
\n\nThe request that will be sent to your channel API when one or more products should be unsnoozed, is quite similar in format to the request you will receive when products should be snoozed. The most important difference is that the action should be unsnooze instead of snooze.
\nTo unsnooze one or more products, your channel API will receive requests in the format shown in the request on the right. For a combination of accountId, locationId and channelLinkId, the request will contain a list of actions. In this case, the action is unsnooze.
\nFor the unsnooze action, the data contains items, which is a list of items that have to be unsnoozed.
\nBy default, the list of items you will receive in an unsnooze request from Foodstack will contain only additional items to unsnooze. If your channel cannot support this, you can change this setting for the channel link for your channel within Foodstack, so that every time you receive an unsnooze request for your channel, you will also receive a full list allSnoozedItems of all items that should be unsnoozed (including items that should already have been unsnoozed).
\n\nThe response should indicate unsnoozing was successful with a 200 OK status code, and the (JSON) body should consist of a list of results that correspond to the required actions in the request. Each result should repeat the unsnooze action, for confirmation. Like an action, a result also has a data field. For the unsnooze action, the data should contain the ID of the location for which items were unsnoozed, as well as a list with the PLUs of all items that are currently snoozed. This is also for confirmation.\nOnly use a 200 OK response to indicate that all items listed in the request were successfully unsnoozed. Also make sure to only send this response after having unsnoozed all items; the moment your channel sends this response, items must already be unsnoozed in the targeted store.
\nIf the desired unsnooze action cannot be performed, send back an appropriate response and corresponding status. If any of the issues below manifest themselves, make sure to indicate each of them in an array in your response.
\n
\nNotice: Work in progress
\nBefore this functionality goes live, we will rework the format of how you should report issues to us. However, in any case we will still require you to send back a list of all products that are currently snoozed.
\n
\n\n\n\n| Issue | \nWhat to do | \n
\n\n\n\n| One or more product(s) used in the request do(es) not exist on your end | \nUnsnooze all products that can be unsnoozed, but send back a failure status (as not all products could be unsnoozed) | \n
\n\n| One or more product(s) used in the request do(es) not exist on your end | \nNothing needs to be done, as the desired effect is already achieved. If this is the only type of issue, you can still send back a success status. | \n
\n\n
\n
For each product that causes one of these issue, send back its ID and its PLU.
\nHave a look at the example responses on the right to see what format you should use to communicate issues back.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{integratorToken}}"}],"advancedConfig":[{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"ec7259bd-82f3-4a09-a170-39a4e647fd84","id":"ec7259bd-82f3-4a09-a170-39a4e647fd84","name":"Foodstack Public API","type":"collection"}},"urlObject":{"host":["{{YourSetwebhookUrl}}"],"query":[],"variable":[]}},"response":[{"id":"695d13ff-1d4a-4c47-b73e-3224332711f6","name":"Unknown product","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"accountId\": \"5b****71c6489f0029****d4\",\n \"locationId\": \"5c****ecc6489f0001****b8\",\n \"channelLinkId\": \"5e****abc11dec0001****9b\",\n \"operations\": [\n {\n \"action\": \"unsnooze\",\n \"data\": {\n \"items\": [\n {\n \"_id\": \"5c****43c6489f0001****65\",\n \"plu\": \"PIE1\",\n \"snoozeStart\": \"2020-03-24T16:21:54.955000Z\",\n \"snoozeEnd\": \"2020-03-24T22:21:54.955000Z\"\n },\n {\n \"_id\": \"5c****43c6489f0001****3b\",\n \"plu\": \"MSB1\",\n \"snoozeStart\": \"2020-03-24T16:21:54.955000Z\",\n \"snoozeEnd\": \"2020-03-24T22:21:54.955000Z\"\n }\n ]\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{YourSetwebhookUrl}}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"action\": \"unsnooze\",\n \"data\": {\n \"locationId\": \"5c****ecc6489f0001****b8\",\n \"allSnoozedItems\": [\n \"PIE1\",\n \"MSB1\"\n ]\n },\n \"issues\": [\n {\n \"description\": \"Unknown product\",\n \"data\": {\n \"_id\": \"5c****43c6489f0001****3b\",\n \"plu\": \"MSB1\"\n }\n }\n ]\n }\n ]\n}"},{"id":"9fd422ee-8cf2-412f-a09e-0521759ce452","name":"All snoozed products required","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"accountId\": \"5b****71c6489f0029****d4\",\n \"locationId\": \"5c****ecc6489f0001****b8\",\n \"channelLinkId\": \"5e****abc11dec0001****9b\",\n \"operations\": [\n {\n \"action\": \"unsnooze\",\n \"data\": {\n \"items\": [\n {\n \"_id\": \"5c****43c6489f0001****65\",\n \"plu\": \"PIE1\",\n \"snoozeStart\": \"2020-03-24T16:21:54.955000Z\",\n \"snoozeEnd\": \"2020-03-24T22:21:54.955000Z\"\n },\n {\n \"_id\": \"5c****43c6489f0001****3b\",\n \"plu\": \"MSB1\",\n \"snoozeStart\": \"2020-03-24T16:21:54.955000Z\",\n \"snoozeEnd\": \"2020-03-24T22:21:54.955000Z\"\n }\n ],\n \"allSnoozedItems\": []\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{YourSetwebhookUrl}}"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"ad5ffa9c-729e-4d9e-a389-3a6654f35abc","name":"Product already unsnoozed","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"accountId\": \"5b****71c6489f0029****d4\",\n \"locationId\": \"5c****ecc6489f0001****b8\",\n \"channelLinkId\": \"5e****abc11dec0001****9b\",\n \"operations\": [\n {\n \"action\": \"unsnooze\",\n \"data\": {\n \"items\": [\n {\n \"_id\": \"5c****43c6489f0001****65\",\n \"plu\": \"PIE1\",\n \"snoozeStart\": \"2020-03-24T16:21:54.955000Z\",\n \"snoozeEnd\": \"2020-03-24T22:21:54.955000Z\"\n },\n {\n \"_id\": \"5c****43c6489f0001****3b\",\n \"plu\": \"MSB1\",\n \"snoozeStart\": \"2020-03-24T16:21:54.955000Z\",\n \"snoozeEnd\": \"2020-03-24T22:21:54.955000Z\"\n }\n ]\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{YourSetwebhookUrl}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"action\": \"unsnooze\",\n \"data\": {\n \"locationId\": \"5c****ecc6489f0001****b8\",\n \"allSnoozedItems\": [\n \"PIE1\",\n \"MSB1\"\n ]\n },\n \"issues\": [\n {\n \"description\": \"Product not snoozed to begin with\",\n \"data\": {\n \"_id\": \"5c****43c6489f0001****65\",\n \"plu\": \"PIE1\"\n }\n }\n ]\n }\n ]\n}"},{"id":"c6f7d3bc-8a63-4cec-8575-ec7dbea7415c","name":"Everything okay","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"accountId\": \"5b****71c6489f0029****d4\",\n \"locationId\": \"5c****ecc6489f0001****b8\",\n \"channelLinkId\": \"5e****abc11dec0001****9b\",\n \"operations\": [\n {\n \"action\": \"unsnooze\",\n \"data\": {\n \"items\": [\n {\n \"_id\": \"5c****43c6489f0001****65\",\n \"plu\": \"PIE1\",\n \"snoozeStart\": \"2020-03-24T16:21:54.955000Z\",\n \"snoozeEnd\": \"2020-03-24T22:21:54.955000Z\"\n },\n {\n \"_id\": \"5c****43c6489f0001****3b\",\n \"plu\": \"MSB1\",\n \"snoozeStart\": \"2020-03-24T16:21:54.955000Z\",\n \"snoozeEnd\": \"2020-03-24T22:21:54.955000Z\"\n }\n ]\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{YourSetwebhookUrl}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"action\": \"unsnooze\",\n \"data\": {\n \"locationId\": \"5c****ecc6489f0001****b8\",\n \"allSnoozedItems\": [\n \"PIE1\",\n \"MSB1\"\n ]\n }\n }\n ]\n}"}],"_postman_id":"2c39dc2f-1354-4bef-be1e-21718de51484"},{"name":"Busy mode","id":"57e0cd78-ed99-4b9e-b0b9-ad93bc42d855","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"accountId\": \"5b****71c6489f0029****d4\",\n \"locationId\": \"5c****ecc6489f0001****b8\",\n \"channelLinkId\": \"5e****abc11dec0001****9b\",\n \"status\": \"PAUSED\"\n}"},"url":"{{YourSetwebhookUrl}}","description":"When a restaurant is very busy, it may have to temporarily halt accepting orders. When this happens, your channel will receive so-called 'busy mode' requests from Foodstack.
\n\nHave a look at an example request on the right. Busy mode requests contain accountId, locationId, and channelLinkId to point out the target store. There's also a status entry, which can take two (string) values, outlined in the table below.
\n\n\n\n| Status | \nMeaning | \n
\n\n\n\n| PAUSED | \nThis is a request to enable busy mode. The store should be 'paused', or closed temporarily, indicating this is because the restaurant is busy. | \n
\n\n| ONLINE | \nThis is a request to disable busy mode. The store should be open as normal. | \n
\n\n
\n
The response should indicate pausing or unpausing the store was successful with a 200 OK status code. The body of the response should echo the current status of the store, after having made the change. (so \"PAUSED\" or \"ONLINE\"). This is shown in the example responses on the right.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{integratorToken}}"}],"advancedConfig":[{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"ec7259bd-82f3-4a09-a170-39a4e647fd84","id":"ec7259bd-82f3-4a09-a170-39a4e647fd84","name":"Foodstack Public API","type":"collection"}},"urlObject":{"host":["{{YourSetwebhookUrl}}"],"query":[],"variable":[]}},"response":[{"id":"367239bb-827a-4360-b446-cf45766d7d16","name":"Enable busy mode","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"accountId\": \"5b****71c6489f0029****d4\",\n \"locationId\": \"5c****ecc6489f0001****b8\",\n \"channelLinkId\": \"5e****abc11dec0001****9b\",\n \"status\": \"PAUSED\"\n}","options":{"raw":{"language":"json"}}},"url":"{{YourSetwebhookUrl}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"PAUSED\"\n}"},{"id":"387e9f98-5854-450a-b950-3b95b6b8ffbf","name":"Disable busy mode","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"accountId\": \"5b****71c6489f0029****d4\",\n \"locationId\": \"5c****ecc6489f0001****b8\",\n \"channelLinkId\": \"5e****abc11dec0001****9b\",\n \"status\": \"ONLINE\"\n}","options":{"raw":{"language":"json"}}},"url":"{{YourSetwebhookUrl}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ONLINE\"\n}"}],"_postman_id":"57e0cd78-ed99-4b9e-b0b9-ad93bc42d855"}],"id":"28f44275-b439-4aa7-bfa4-f70d90e39f08","description":"Before orders can be sent to Foodstack, the right PLU's and menu's should be available on the Channel.\nThis could of course be done maually, but this is prone to mistakes and menu's often change. (additional products, new prices, etc.)
\nTherefore the better way is to implement the menu push webhook so that the online menu can be updated with new information from the POS and/or Foodstack
\nBesides the menu, there's also an endpoint where you can receive status updates on orders that were pushed to Foodstack. This info can be used to optimize when drivers are sent to pick up the food.
\n","event":[{"listen":"prerequest","script":{"id":"89a61696-72fb-4310-b585-afa8ee5f4d2e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b86137fe-574a-4c6a-b32e-95e436030779","type":"text/javascript","exec":[""]}}],"_postman_id":"28f44275-b439-4aa7-bfa4-f70d90e39f08","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{integratorToken}}"}],"advancedConfig":[{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"ec7259bd-82f3-4a09-a170-39a4e647fd84","id":"ec7259bd-82f3-4a09-a170-39a4e647fd84","name":"Foodstack Public API","type":"collection"}}}],"id":"c79906f6-88ee-47dc-b56b-2aeb69b2473a","description":"If you're a channel and you want to integrate with us, this is the API you can use.
\nThere are 2 parts, everything under Foodstack are methods that need to be called on our servers.\nEverything under Webhooks are methods that need to be available on your server and that Foodstack will call.
\nWARNING This API hasn't been finalised but the info here can already be used to start integrating
\n","event":[{"listen":"prerequest","script":{"id":"5592752f-0bf3-45fd-aa2f-f073a61d613a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f7f31740-3e88-4b8c-b601-ff7d0df323c0","type":"text/javascript","exec":[""]}}],"_postman_id":"c79906f6-88ee-47dc-b56b-2aeb69b2473a","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{integratorToken}}"}],"advancedConfig":[{"key":"useBrowser","value":""}]},"isInherited":true,"source":{"_postman_id":"ec7259bd-82f3-4a09-a170-39a4e647fd84","id":"ec7259bd-82f3-4a09-a170-39a4e647fd84","name":"Foodstack Public API","type":"collection"}}}],"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{integratorToken}}"}],"advancedConfig":[{"key":"useBrowser","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"5ec41c34-7aaf-4d68-a5b7-64c990532b49","type":"text/javascript","exec":["postman.setGlobalVariable(\"now\", new Date().toISOString().split('.')[0] + \"Z\");","","var foodstackOrderCounter = Number(postman.getGlobalVariable(\"foodstackOrderCounter\"));","if (!foodstackOrderCounter)"," foodstackOrderCounter = 1000;","foodstackOrderCounter += 1;","","postman.setGlobalVariable(\"foodstackOrderCounter\", foodstackOrderCounter);"]}},{"listen":"test","script":{"id":"1acaf1e2-9151-4b74-80e6-3df4eef2fa3a","type":"text/javascript","exec":[""]}}],"variable":[{"key":"restUrl","value":"api.brain.io"}]}