{"openapi":"3.1.0","info":{"title":"POS API","description":"Our POS API provides endpoints for synchronizing product data, webhooks for receiving orders from digital sales channels in real time and APIs to manage the order lifecycle including preparation updates which are routed directly onwards to all integrated ordering platforms.","version":"1.0.0"},"servers":[{"url":"https://api.staging.deliverect.com","description":"Staging"},{"url":"https://api.deliverect.com","description":"Production"}],"security":[{"oauth2ClientCredentials":[]}],"components":{"securitySchemes":{"oauth2ClientCredentials":{"type":"oauth2","description":"Obtain an access token using the partner client ID and client secret. Send the returned token with each API request in the Authorization header as a Bearer token.","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}}}}}},"x-readme":{"headers":[],"explorer-enabled":true,"proxy-enabled":true,"oauth-options":{"useInsecureClientAuthentication":true}},"x-readme-fauxas":true,"tags":[{"name":"Endpoints","description":"Deliverect Endpoints. Use `https://api.staging.deliverect.com` for testing and `https://api.deliverect.com` in production."},{"name":"Webhooks","description":"Deliverect Webhooks. Requests are signed with HMAC-SHA256 using a pre-shared secret configured on your integration, so you can verify they came from Deliverect and weren't altered in transit (see HMAC Authentication Guide here)."}],"paths":{"/updatePreparationTime":{"post":{"responses":{"200":{"description":"","content":{"application/json":{"examples":{"OK":{"summary":"OK","value":"{}"}}}}},"400":{"content":{"application/json":{"schema":{"type":"object","properties":{}},"examples":{"Bad Request":{"summary":"Bad Request","value":"{}"}}}},"description":"Bad Request"}},"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"order":{"type":"string"},"minutes":{"type":"integer"}},"required":["minutes","order"]},"examples":{"Example":{"summary":"Example","value":{"order":"{orderId}","minutes":15}}}}}},"operationId":"post_updatepreparationtime","summary":"Update Order Preparation Time","tags":["Endpoints"]}},"/updateBill/{locationId}":{"post":{"tags":["Endpoints"],"summary":"Update Bill","operationId":"updateBill","parameters":[{"name":"locationId","in":"path","required":true,"schema":{"type":"string"},"description":"Deliverect location ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Closed bill payload from the POS.","properties":{"id":{"type":"string"},"status":{"type":"integer"},"tableId":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"},"closedAt":{"type":"string","format":"date-time"},"decimalDigits":{"type":"integer"},"discountTotal":{"type":"integer"},"discounts":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"total":{"type":"integer"}}}},"surchargesTotal":{"type":"integer"},"surcharges":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"total":{"type":"integer"}}}},"taxTotal":{"type":"integer"},"taxes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"total":{"type":"integer"}}}},"total":{"type":"integer"},"totalDue":{"type":"integer"},"items":{"type":"array","items":{"type":"object","properties":{"plu":{"type":"string"},"name":{"type":"string"},"quantity":{"type":"integer"},"price":{"type":"integer"},"subItems":{"type":"array","items":{"type":"object","properties":{"plu":{"type":"string"},"name":{"type":"string"},"quantity":{"type":"integer"},"price":{"type":"integer"}}}}}}},"payments":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"total":{"type":"integer"}}}}},"example":{"id":"R29532LF","status":20,"tableId":"T1","createdAt":"2023-08-18T14:49:39.379000Z","lastUpdated":"2023-08-18T14:49:39.379000Z","closedAt":"2023-08-18T14:49:39.379000Z","decimalDigits":2,"discountTotal":100,"discounts":[{"name":"Our company birthday discount","total":100}],"surchargesTotal":200,"surcharges":[{"name":"Take-away","total":200}],"taxTotal":48,"taxes":[{"name":"6% VAT","total":48}],"total":800,"totalDue":400,"items":[{"plu":"PLU-01","name":"My first product","quantity":1,"price":300},{"plu":"PLU-02","name":"My second product","quantity":1,"price":400,"subItems":[{"plu":"PLU-03","name":"My modifier","quantity":1,"price":0}]}],"payments":[{"name":"Cash","total":400}]}},"examples":{"Bill Example":{"summary":"Bill Example","value":{"id":"R29532LF","status":20,"tableId":"T1","createdAt":"2023-08-18T14:49:39.379000Z","lastUpdated":"2023-08-18T14:49:39.379000Z","closedAt":"2023-08-18T14:49:39.379000Z","decimalDigits":2,"discountTotal":100,"discounts":[{"name":"Our company birthday discount","total":100}],"surchargesTotal":200,"surcharges":[{"name":"Take-away","total":200}],"taxTotal":48,"taxes":[{"name":"6% VAT","total":48}],"total":800,"totalDue":400,"items":[{"plu":"PLU-01","name":"My first product","quantity":1,"price":300},{"plu":"PLU-02","name":"My second product","quantity":1,"price":400,"subItems":[{"plu":"PLU-03","name":"My modifier","quantity":1,"price":0}]}],"payments":[{"name":"Cash","total":400}]}}}}}},"responses":{"200":{"description":"Bill queued for processing","content":{"application/json":{"schema":{"type":"string","example":"Bill queued for processing"},"examples":{"OK":{"summary":"OK","value":"{}"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"string","example":"Please provide a JSON format as specified in the API docs"}}}}}}},"/orderStatus/{orderId}":{"post":{"responses":{"200":{"description":"","content":{"application/json":{"examples":{"OK":{"summary":"OK","value":{"result":"OK"}},"Status Updated + Pickup time changed":{"summary":"Status Updated + Pickup time changed","value":{"result":"OK","pickupTime":"2023-02-09T13:00:38.006000Z","deliveryTime":"yyyy-MM-ddTHH:mm:ss.SSSSSSZ"}}}}}},"400":{"content":{"application/json":{"schema":{"type":"object","properties":{}},"examples":{"Bad Request":{"summary":"Bad Request","value":"{}"}}}},"description":"Bad Request"}},"parameters":[{"in":"path","name":"orderId","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["orderId","receiptId","status"],"properties":{"orderId":{"type":"string","description":"The original _id that was sent to the POS order webhook"},"receiptId":{"type":"string","description":"Internal ID assigned by the POS, typically in a human-readable format for printed receipts."},"status":{"type":"integer","description":"Status to update"},"pickupTime":{"type":"string","format":"date-time","description":"Updated pickupTime is in UTC yyyy-MM-ddTHH:mm:ssZ"},"reason":{"type":"string","description":"Reason for a status change e.g. 'ITEM OUT OF STOCK'"},"timeStamp":{"type":"string","format":"date-time","description":"Timestamp when the status was applied"}}},"examples":{"Failed Order":{"summary":"Failed Order","value":{"orderId":"63********************a7","status":120,"reason":"Invalid PLU","timeStamp":"yyyy-MM-ddTHH:mm:ss.SSSSSSZ","receiptId":""}},"Order Cancelled":{"summary":"Order Cancelled","value":{"orderId":"63********************a7","status":110,"reason":"cancellation","timeStamp":"yyyy-MM-ddTHH:mm:ss.SSSSSSZ","receiptId":""}},"Order Accepted + Pickup Time Updated":{"summary":"Order Accepted + Pickup Time Updated","value":{"orderId":"63********************a7","status":20,"receiptId":"T3651A85-1","pickupTime":"yyyy-MM-ddTHH:mm:ss.SSSSSSZ","timeStamp":"yyyy-MM-ddTHH:mm:ss.SSSSSSZ"}}}}}},"operationId":"post_orderstatus-orderid","summary":"Update Order Status","tags":["Endpoints"]}},"/productAndCategories":{"post":{"tags":["Endpoints"],"summary":"Insert Products","operationId":"insertUpdateProductsAndCategories","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","locationId","products","categories"],"properties":{"accountId":{"type":"string","description":"accountId is the unique identifier of the customer account in Deliverect (obtained during onboarding via the [Register POS](https://developers.deliverect.com/v1.1-restaurants/reference/pos_register) webhook)"},"locationId":{"type":"string","description":"locationId is the unique identifier of a physical restaurant location, store, or kitchen (obtained during onboarding via the [Register POS](https://developers.deliverect.com/v1.1-restaurants/reference/pos_register) webhook)"},"products":{"type":"array","items":{"properties":{"name":{"type":"string","description":"Name for the product"},"plu":{"type":"string","description":"Unique identifier for a product."},"price":{"type":"integer","format":"int32","description":"Defined by an integer with 2 decimal digits, e.g. $5.00 is stored as 500."},"description":{"type":"string","description":"Product description"},"productType":{"type":"integer","format":"int32","description":"Specifies the product type being inserted:\n- `1` – **Product**: a 'top level' item on a menu (can also be grouped within a modifier group or bundle)\n- `2` – **Modifier**: options selectable when ordering a product, typically modifications of the product\n- `3` – **Modifier Group**: a grouping of modifiers (can also group products)\n- `4` – **Bundle**: can only contain products offered as part of a 'Meal Deal', which Deliverect will set to zero value (exception: where Overloads are set)\n\nSee the product types guide for more details.","enum":[1,2,3,4]},"gtin":{"type":"array","description":"GTIN (Global Trade Item Number) for product, which could be EAN code","default":[],"items":{"type":"string"}},"isVariant":{"type":"boolean","description":"Indicates a product is a variant. See the variant products guide for more details."},"isCombo":{"type":"boolean","description":"Indicates product is a combo."},"deliveryTax":{"type":"integer","format":"int32","description":"Tax rate for delivery order, integer with 3 decimal digits. See the product configurations guide for more details."},"takeawayTax":{"type":"integer","format":"int32","description":"Tax rate for pickup order, integer with 3 decimal digits. See the product configurations guide for more details."},"eatInTax":{"type":"integer","format":"int32","description":"Tax rate for Eat-in order, integer with 3 decimal digits. See the product configurations guide for more details."},"priceLevels":{"type":"object","properties":{"TA":{"type":"integer","format":"int32"},"DL":{"type":"integer","format":"int32"},"UE":{"type":"integer","format":"int32"}},"description":"Object containing the `priceLevels.posId` specified on the `priceLevels` array, and the corresponding price. Example: { \"UE\": 900, \"DL\": 850, \"TA\": 825 }. See the price levels guide for more details."},"overloads":{"type":"array","items":{"properties":{"scopes":{"type":"array","default":[],"items":{"type":"string"},"description":"Define surcharges applied to the specific modifier group or bundle. See the overloads guide for more details."},"bundlePrice":{"type":"integer","format":"int32","description":"Determines the price for the overload when the grouping is a bundle. See the overloads guide for more details."},"price":{"type":"integer","format":"int32","description":"Determines the price for the overload. See the overloads guide for more details."},"name":{"type":"string"},"defaultQuantity":{"type":"integer","format":"int32","description":"Overrides `defaultQuantity` for this specific scope — specify '1' to 'pre-select' the item only within that scope (compatible with only a few channels)."},"maxFree":{"type":"integer","format":"int32","description":"Overrides `maxFree` for this specific scope — specifies how many sub products can be ordered at zero value within that scope, normal pricing applying after the set limit."}},"type":"object"},"description":"Specifies price variances from the 'base' price dependant on where the option is offered."},"posProductId":{"type":"string","description":"Internal reference ID for the product coming from the POS. Optional use."},"posCategoryIds":{"type":"array","default":[],"items":{"type":"string"},"description":"Products should belong to at least one category; each Id listed corresponds to a lookup table which you will provide along with the customer facing category name — see `categories.posCategoryId`."},"imageUrl":{"type":"string","description":"Cloud hosted image URL. See the product images guide for more details."},"nameTranslations":{"type":"object","properties":{"en":{"type":"string"},"es":{"type":"string"},"fr":{"type":"string"},"nl":{"type":"string"},"ar":{"type":"string"},"el":{"type":"string"}},"description":"Object containing name translations. See the translations guide for more information."},"productTags":{"type":"array","default":[],"items":{"type":"integer","format":"int32"},"description":"e.g. `108` = mustard. See the product tags guide for the full guide."},"multiMax":{"type":"integer","description":"sets the maximum quantity orderable of any one item in a group, can also set the maximum quantity of a product to be ordered in a basket","format":"int32"},"defaultQuantity":{"type":"integer","description":"applicable to modifiers (productType: 2) to 'pre-select' an option","format":"int32"},"nutritionalInfo":{"type":"object","properties":{"fat":{"type":"integer","format":"int32"},"protein":{"type":"integer","format":"int32"},"sugar":{"type":"integer","format":"int32"},"addedSugar":{"type":"integer","format":"int32"},"saturatedFat":{"type":"integer","format":"int32"},"carbohydrates":{"type":"integer","format":"int32"},"salt":{"type":"integer","format":"int32"},"transFat":{"type":"integer","format":"int32"},"monoUnsaturatedFat":{"type":"integer","format":"int32"},"polyUnsaturatedFat":{"type":"integer","format":"int32"},"cholesterol":{"type":"integer","format":"int32"},"starch":{"type":"integer","format":"int32"},"sodium":{"type":"integer","format":"int32"},"fiber":{"type":"integer","format":"int32"},"vitaminC":{"type":"integer","format":"int32"},"calcium":{"type":"integer","format":"int32"},"magnesium":{"type":"integer","format":"int32"},"chloride":{"type":"integer","format":"int32"},"fluoride":{"type":"integer","format":"int32"},"potassium":{"type":"integer","format":"int32"},"polyols":{"type":"integer","format":"int32"},"servingSize":{"type":"object","properties":{"amount":{"type":"integer","format":"int32","description":"the serving size amount"},"unitType":{"type":"integer","format":"int32","description":"the unit of the serving size amount. unitType: 1 = Weight (in grams), 2 = Volume (in milliliter), 3 = Count (i.e. piece, slice, tablet, capsule, cookie, etc)"},"countUnitDescription":{"type":"string","description":"the serving size unit"}}},"netQuantity":{"type":"object","properties":{"amount":{"type":"integer","format":"int32","description":"value of the quantity amount"},"unitType":{"type":"integer","format":"int32"},"countUnitDescription":{"type":"string","description":"the unit of the quantity amount"}}}},"description":"An object containing the nutritional values for the product, including flat numeric fields expressed in grams (e.g. fat, protein, salt) as well as `servingSize` and `netQuantity`, each an object specifying an `amount`, `unitType`, and `countUnitDescription`. See the nutritional & supplemental info guide for more details."},"supplementalInfo":{"type":"object","properties":{"instructionsForUse":{"type":"string","description":"Instructions for the use e.g. \"Cool before drink.\" See the nutritional & supplemental info guide for more information."},"ingredients":{"type":"array","items":{"type":"string"},"description":"e.g. \"Water\""},"additives":{"type":"array","items":{"type":"string"},"description":"e.g. [\"Artificial Food Coloring\", \"PRESERVATIVES_NITRATE\"]"},"prepackaged":{"type":"boolean","description":"Indicates if the item is prepackaged."},"deposit":{"type":"integer","format":"int32","description":"Value of the deposit if applicable."},"fbo":{"type":"object","properties":{"name":{"type":"string","description":"Food business operator name"},"address":{"type":"string","description":"Food business operator address"},"brand":{"type":"string","description":"Food business operator brand name"},"countryOfOrigin":{"type":"string","description":"Food business operator country of origin"}}},"legalName":{"type":"string","description":"The legal name of the product"}}},"bottleDepositPrice":{"type":"integer","format":"int32","description":"Legacy attribute. For correct format see `supplementalInfo.deposit` and the deposits guide."},"visible":{"type":"boolean","description":"This specifies if the item is enabled or disabled within a location"},"subProducts":{"type":"array","default":[],"items":{"type":"string"},"description":"A product can contain additional options — see the modifier groups guide."},"kitchenName":{"type":"string","description":"An optional additional name for the product that will be sent through with the order"},"stock":{"type":"integer","format":"int32","description":"The current level of stock for this item (relevant in retail accounts)"},"channelOverrides":{"type":"object","description":"Allows the `visible` flag to apply differently per channel. See the guide here. Each key represents the ID of a channel (obtained via GET Integrated Channels). For example channel ID `\"7\"` (Uber Eats) marked as `\"visible\": false`, while `\"12\"` (DoorDash) marked as `\"visible\": true`.","example":{"7":{"visible":false},"12":{"visible":true}}},"descriptionTranslations":{"type":"object","description":"Object containing the translations for the descriptions. See the translations guide for more details.","properties":{"en":{"type":"string"},"es":{"type":"string"},"fr":{"type":"string"},"nl":{"type":"string"},"ar":{"type":"string"},"el":{"type":"string"}}},"isVariantGroup":{"type":"boolean","description":"Indicates the group contains variants. See the variant products guide for more details."},"min":{"type":"integer","format":"int32","description":"Minimum quantity for a modifier."},"max":{"type":"integer","format":"int32","description":"Maximum quantity for a modifier."},"maxFree":{"type":"integer","format":"int32","description":"Specifies how many sub products can be ordered at zero value, normal pricing applying after the set limit."},"minUniqueOptions":{"type":"integer","format":"int32","description":"Minimum unique options that can be selected in any one modifier group."},"maxUniqueOptions":{"type":"integer","format":"int32","description":"Maximum unique options that can be selected in any one modifier group."},"autoApply":{"type":"array","items":{"type":"object","properties":{"plu":{"type":"string","description":"A predefined set of zero-priced items applied to an order by Deliverect. See the auto-apply modifiers guide for more details."}}}},"sortOrder":{"type":"integer","format":"int32","description":"Defines the order in which an item will appear when auto-applied. See the auto-apply modifiers guide for more details."},"beverageInfo":{"type":"object","properties":{"caffeine":{"type":"integer","format":"int32","description":"Caffeine content of the beverage, expressed in milligrams (mg).","example":95},"alcohol":{"type":"integer","format":"int32","description":"Alcohol percentage, sent as an integer in E2 format (the percentage multiplied by 100) so that decimal values can be represented. For example, `1250` represents 12.5% and `475` represents 4.75%.","example":1250}}},"calories":{"type":"integer","format":"int32","description":"kcal / Cals"},"caloriesRangeHigh":{"type":"integer","format":"int32","description":"Where a range of calories applies to a variable option e.g. a 'Sandwich Deal' where selections are required. To apply this, the format would be: Minimum = `calories`, Maximum = `caloriesRangeHigh`."},"packaging":{"type":"object","properties":{"reusable":{"type":"boolean","description":"Whether packaging is reusable"},"storageInstructions":{"type":"string","description":"How to store an item"},"count":{"type":"integer","format":"int32"}}},"isIngredientGroup":{"type":"boolean","description":"Indicates the group contains ingredients (e.g. toppings) rather than variants or standard modifiers."},"isUpsell":{"type":"boolean","description":"Indicates whether this product is an upsell item."}},"required":["name","plu","price","productType","deliveryTax"],"type":"object"}},"categories":{"type":"array","items":{"properties":{"name":{"type":"string","default":"Build your own Pizza","description":"Name for the category."},"posCategoryId":{"type":"string","default":"PZ","description":"Id assigned to the category."},"imageUrl":{"type":"string","description":"Image for the category"},"description":{"type":"string","description":"Description of the category"}},"type":"object"},"description":"This is the lookup table for every product which specifies `posCategoryIds`. It sets the categories which would form a menu when imported, and also provides a reference when products are added to menus in Deliverect."},"priceLevels":{"type":"array","items":{"properties":{"name":{"type":"string","default":"Takeaway","description":"Name for the priceLevel"},"posId":{"type":"string","default":"TA","description":"Id for the priceLevel. Value used inside the array `products.priceLevels`"}},"type":"object"},"description":"See the price levels guide for more information. This is mandatory when using Price Levels, otherwise the Price Level will not work."}}},"examples":{"1. Single Product + Price Levels + Supplemental Info":{"summary":"1. Single Product + Price Levels + Supplemental Info","value":{"accountId":"{{accountId}}","locationId":"{{locationId}}","products":[{"name":"Ginger Beer","description":"Made with locally grown ginger and sugarcane","productType":1,"plu":"DRNK-03","price":380,"priceLevels":{"DL":420,"TA":410,"1PO":400},"productTags":[10],"imageUrl":"https://storage.googleapis.com/ikona-bucket-staging/images/5ff6ee089328c8aefeeabe33/gingerbeer-62285548db5986001ebf58d1.jpg","deliveryTax":1200,"takeawayTax":1200,"eatInTax":1200,"gtin":["8712345000103","74993001078"],"beverageInfo":{"caffeine":0,"alcohol":450},"supplementalInfo":{"instructionsForUse":"Best served chilled","ingredients":["Water","Sugar"],"additives":["Artificial Food Coloring","Sodium Nitrite"],"prepackaged":true,"deposit":100},"calories":500,"packaging":{"count":1,"reusable":true,"storageInstructions":"Keep cool"},"caloriesRangeHigh":750,"nutritionalInfo":{"fat":2,"sugar":2,"saturatedFat":1.5,"carbohydrates":1.5,"protein":2,"salt":2,"servingSize":{"amount":3,"unitType":3,"countUnitDescription":"g"},"netQuantity":{"amount":12,"unitType":1,"countUnitDescription":"g"}},"posCategoryIds":["DRK"]}],"categories":[{"posCategoryId":"DRK","name":"Drinks","imageUrl":"https://storage.googleapis.com/ikona-bucket-staging/images/618a2c5306a6208df4e9d061/Drinks-6772a0cd6448d47caa95c689.jpg"}],"priceLevels":[{"name":"Takeaway","posId":"TA"},{"name":"Delivery","posId":"DL"},{"name":"FirstParty","posId":"1PO"}]}},"2. Product + Modifier Group":{"summary":"2. Product + Modifier Group","value":{"accountId":"{{accountId}}","locationId":"{{locationId}}","products":[{"name":"Delicious Steak Frites","description":"Product with Modifier groups, min/max, defaultQuantity, translations","nameTranslations":{"es":"Deliciosos Bistecs Fritos","fr":"Steak Frites Delicieux","nl":"Heerlijke Biefstuk Frites","ar":"شريحة لحم فريتس"},"descriptionTranslations":{"es":"Deliciosos Bistecs Fritos","fr":"Steak Frites Délicieux","nl":"Heerlijke Biefstuk Frites","ar":"شريحة لحم فريتس"},"productType":1,"plu":"STK-01","price":1500,"imageUrl":"https://storage.googleapis.com/ikona-bucket-staging/images/5ff6ee089328c8aefeeabe33/steak-622862588c506f015be6018e.jpeg","subProducts":["MOD-01","MOD-02","AUTO-01"],"deliveryTax":1200,"takeawayTax":1200,"eatInTax":1200,"kitchenName":"Steak","posCategoryIds":["STK"]},{"name":"Cooking instructions","nameTranslations":{"es":"Cocinado","fr":"Cuisson","nl":"Kook instructies","ar":"تعليمات الطبخ"},"productType":3,"plu":"MOD-01","min":1,"max":1,"subProducts":["COOK-01","COOK-02","COOK-03"]},{"name":"Rare","nameTranslations":{"es":"Poco hecho","fr":"Saignant","nl":"Rood","ar":"غير ناضج جيدا"},"productType":2,"plu":"COOK-01"},{"name":"Medium Rare","nameTranslations":{"es":"Al punto","fr":"À point","nl":"Half doorbakken","ar":"مُتَوَسِّط النُضْجِ"},"productType":2,"plu":"COOK-02"},{"name":"Well Done","nameTranslations":{"es":"Muy hecho","fr":"Bien cuit","nl":"Doorbakken","ar":"مطبوخ جيدا"},"productType":2,"plu":"COOK-03"},{"name":"Add a side","nameTranslations":{"es":"Elige tu acompañamiento","fr":"Choisissez votre garniture","nl":"Kies je bijgerecht","ar":"اختر طبقك الجانبي"},"productType":3,"plu":"MOD-02","imageUrl":"https://storage.googleapis.com/ikona-bucket-staging/images/5ff6ee089328c8aefeeabe33/pizza-6228525eb303fc03a148de46.jpeg","min":0,"max":0,"multiMax":3,"subProducts":["SI-01","SI-02","SI-03"]},{"name":"Fries","description":"Fries","nameTranslations":{"es":"Patatas fritas","fr":"Frites","nl":"Frietjes","ar":"بطاطس مقلية"},"productType":2,"plu":"SI-01","price":0,"defaultQuantity":1,"deliveryTax":1200,"takeawayTax":1200,"eatInTax":1200},{"name":"Salad","description":"Salad","nameTranslations":{"es":"Ensalada","fr":"Salade","nl":"Salade","ar":"سلطة"},"productType":2,"plu":"SI-02","price":200,"deliveryTax":1200,"takeawayTax":1200,"eatInTax":1200},{"name":"Mashed Potato","description":"Mashed Potato","nameTranslations":{"es":"Puré de patata","fr":"Purée de pommes de terre","nl":"Aardappelpuree","ar":"البطاطا المهروسة"},"productType":2,"plu":"SI-03","price":100,"deliveryTax":1200,"takeawayTax":1200,"eatInTax":1200,"kitchenName":"Mash"},{"name":"Garnishes","productType":3,"plu":"AUTO-01","autoApply":[{"plu":"PR1"}],"subProducts":["PR1","PR2"]},{"name":"Parsley","productType":2,"plu":"PR1","defaultQuantity":2}],"categories":[{"posCategoryId":"STK","name":"Steak & Burgers","imageUrl":"https://storage.googleapis.com/ikona-bucket-staging/images/618a2c5306a6208df4e9d061/Steaks%20and%20Burgers-6772a08c467817883c7ae27d.jpg"}]}},"3. Product + Nested Modifiers":{"summary":"3. Product + Nested Modifiers","value":{"accountId":"{{accountId}}","locationId":"{{locationId}}","products":[{"name":"Chicken Sate","description":"Product with Nested Modifiers - Multimax variables - Allergens (tags)","productType":1,"plu":"P-SATE","price":450,"productTags":[104,108,109],"imageUrl":"https://storage.googleapis.com/ikona-bucket-staging/images/5ff6ee089328c8aefeeabe33/satay-62284e3c8c506f015be60184.jpeg","subProducts":["MG-RICE"],"deliveryTax":1200,"takeawayTax":1200,"eatInTax":1200,"posCategoryIds":["CHK"]},{"name":"Rice Selection","productType":3,"plu":"MG-RICE","min":1,"max":1,"subProducts":["RICE-01"]},{"name":"White Rice","description":"White coloured rice","productType":1,"plu":"RICE-01","price":450,"imageUrl":"https://storage.googleapis.com/ikona-bucket-staging/images/5ff6ee089328c8aefeeabe33/nasiputi-1610290140494.jpg","subProducts":["MG-SAUCES"],"deliveryTax":1200,"takeawayTax":1200,"eatInTax":1200,"posCategoryIds":["SD"]},{"name":"Choose a sauce","productType":3,"plu":"MG-SAUCES","min":0,"max":1,"subProducts":["SAUCE-01","SAUCE-02"]},{"name":"Sate Sauce","productType":2,"plu":"SAUCE-01","price":50,"deliveryTax":1200,"takeawayTax":1200,"eatInTax":1200},{"name":"Hot Sauce","productType":2,"plu":"SAUCE-02","price":50,"deliveryTax":1200,"takeawayTax":1200,"eatInTax":1200}],"categories":[{"posCategoryId":"CHK","name":"Chicken","imageUrl":"https://storage.googleapis.com/ikona-bucket-staging/images/618a2c5306a6208df4e9d061/Chicken-6772a111d6ff7c6facadf7ea.jpeg"},{"posCategoryId":"SD","name":"Side Dishes","imageUrl":"https://storage.googleapis.com/ikona-bucket-staging/images/618a2c5306a6208df4e9d061/Sides-6772a0ade9c10b3d77b489a4.jpg"}]}},"4. Variant Product (sizes)":{"summary":"4. Variant Product (sizes)","value":{"accountId":"{{accountId}}","locationId":"{{locationId}}","products":[{"name":"Chicken Tenders","description":"Variant prices for different sizes will show cheapaest on top level product","productType":1,"isVariant":true,"plu":"VAR-PROD-1","price":0,"imageUrl":"https://storage.googleapis.com/ikona-bucket-staging/images/5ff6ee089328c8aefeeabe33/chicken-62285f90db5986001ebf58d5.jpg","subProducts":["MG-VAR-1"],"deliveryTax":1200,"takeawayTax":1200,"eatInTax":1200,"posCategoryIds":["CHK"]},{"name":"How many pieces?","productType":3,"isVariantGroup":true,"plu":"MG-VAR-1","min":1,"max":1,"subProducts":["VAR-1","VAR-2"]},{"name":"3 Pieces","productType":1,"plu":"VAR-1","price":800,"imageUrl":"https://resizer.staging.deliverect.com/xjen-2xRW9YzpXuWWG0brT-rs9z4W41LGVS36PELDzw/rt:fill/g:ce/el:0/aHR0cHM6Ly9zdG9yYWdlLmdvb2dsZWFwaXMuY29tL2lrb25hLWJ1Y2tldC1zdGFnaW5nL2ltYWdlcy82NmIzNTJlZjBjZDU3OTkyMTU0M2IzODAvMy1waWVjZS1jaGlja2VuLXRlbmRlcnMtNjcyMGYxNTRmMTgxNTI2ZjIzZTI3MGQ2LmpwZw==.jpg","deliveryTax":1200,"takeawayTax":1200,"eatInTax":1200},{"name":"6 Pieces","productType":1,"plu":"VAR-2","price":1100,"deliveryTax":1200,"takeawayTax":1200,"eatInTax":1200}],"categories":[{"posCategoryId":"CHK","name":"Chicken","imageUrl":"https://storage.googleapis.com/ikona-bucket-staging/images/618a2c5306a6208df4e9d061/Chicken-6772a111d6ff7c6facadf7ea.jpeg"}]}},"5. Meal Deal / Combo + Upsell":{"summary":"5. Meal Deal / Combo + Upsell","value":{"accountId":"{{accountId}}","locationId":"{{locationId}}","products":[{"name":"Burger Combo (Drink not Included)","description":"Combo with Bundles - Modifier Groups as Upsell","productType":1,"isCombo":true,"plu":"P-BRGR","price":950,"imageUrl":"https://storage.googleapis.com/ikona-bucket-staging/images/5ff6ee089328c8aefeeabe33/burger-62286be78c506f015be60190.jpeg","subProducts":["BNDL-BRG","UPSLL-01"],"deliveryTax":1200,"takeawayTax":1200,"eatInTax":1200,"posCategoryIds":["STK"]},{"name":"Burger Selection","productType":4,"plu":"BNDL-BRG","min":1,"max":1,"subProducts":["P-BURG-CHK","P-BURG-CHE","P-BURG-VEG"]},{"name":"Chicken Burger","description":"Crispy coated chicken thigh, iceberg lettuce, pickles, slice of cheese & mayo, all in a toasted brioche bun.","productType":1,"isVariant":true,"plu":"P-BURG-CHK","price":800,"imageUrl":"https://storage.googleapis.com/ikona-bucket-staging/images/5ff6ee089328c8aefeeabe33/chkburger-6228c1dcdb5986001ebf58df.jpeg","subProducts":["MG-FRS","UPSLL-01"],"deliveryTax":1200,"takeawayTax":1200,"eatInTax":1200,"posCategoryIds":["STK"]},{"name":"Fries Selection","productType":3,"isVariantGroup":true,"plu":"MG-FRS","min":1,"max":1,"subProducts":["P-FRS-S","P-FRS-M"]},{"name":"French Fries","description":"Plain fries from France","productType":1,"plu":"P-FRS-S","price":200,"imageUrl":"https://res.cloudinary.com/dyjxkus2h/image/upload/v1774957023/u9rr1srf6q6mapnsbg3k.jpg","deliveryTax":1200,"takeawayTax":1200,"eatInTax":1200,"posCategoryIds":["SD"]},{"name":"Curly Fries","description":"Spiralised potatoes, fried","productType":1,"plu":"P-FRS-M","price":200,"imageUrl":"https://res.cloudinary.com/dyjxkus2h/image/upload/v1774956887/eljk574rb3mwagajyrau.jpg","deliveryTax":1200,"takeawayTax":1200,"eatInTax":1200,"posCategoryIds":["SD"]},{"name":"Add a Drink?","productType":3,"plu":"UPSLL-01","min":0,"max":0,"multiMax":99,"overloads":[{"scopes":["P-BRGR"],"name":"Add a Drink? (not included)"}],"subProducts":["DRNK-01","DRNK-03"],"isUpsell":true},{"name":"Coca Cola","description":"Cola flavoured sugar and caffeine.","productType":1,"plu":"DRNK-01","price":400,"productTags":[10],"imageUrl":"https://storage.googleapis.com/ikona-bucket-staging/images/5ff6ee089328c8aefeeabe33/cocacola-622854a78c506f015be6018a.jpeg","deliveryTax":1200,"takeawayTax":1200,"eatInTax":1200,"posCategoryIds":["DRK"]},{"name":"Ginger Beer","description":"Made with locally grown ginger and sugarcane","productType":1,"plu":"DRNK-03","price":400,"productTags":[10],"imageUrl":"https://storage.googleapis.com/ikona-bucket-staging/images/5ff6ee089328c8aefeeabe33/gingerbeer-62285548db5986001ebf58d1.jpg","deliveryTax":1200,"takeawayTax":1200,"eatInTax":1200,"gtin":["8712345000103","74993001078"],"beverageInfo":{"caffeine":0,"alcohol":450},"supplementalInfo":{"instructionsForUse":"Best served chilled","ingredients":["Water","Sugar"],"additives":["Artificial Food Coloring","Sodium Nitrite"],"prepackaged":true,"deposit":100},"calories":500,"packaging":{"count":1,"reusable":true,"storageInstructions":"Keep cool"},"caloriesRangeHigh":750,"nutritionalInfo":{"fat":2,"sugar":2,"saturatedFat":1.5,"carbohydrates":1.5,"protein":2,"salt":2,"servingSize":{"amount":3,"unitType":3,"countUnitDescription":"g"},"netQuantity":{"amount":12,"unitType":1,"countUnitDescription":"g"}},"posCategoryIds":["DRK"]},{"name":"Cheeseburger","description":"100% beef patty, cheddar, caramelized onions, mayonnaise, pickles in a Pretzel bun","productType":1,"plu":"P-BURG-CHE","price":850,"imageUrl":"https://storage.googleapis.com/ikona-bucket-staging/images/5ff6ee089328c8aefeeabe33/cheeseburger-62286e26db5986001ebf58d7.jpg","subProducts":["MG-FRS","UPSLL-01"],"deliveryTax":1200,"takeawayTax":1200,"eatInTax":1200,"posCategoryIds":["STK"]},{"name":"Veggie Burger","description":"Black bean burgers with sweet potato, mushrooms, quinoa, and pecans.","productType":1,"plu":"P-BURG-VEG","price":750,"imageUrl":"https://storage.googleapis.com/ikona-bucket-staging/images/5ff6ee089328c8aefeeabe33/veggieburger-62286cbac715b403b0eb7294.jpeg","subProducts":["MG-FRS","UPSLL-01"],"deliveryTax":1200,"takeawayTax":1200,"eatInTax":1200,"posCategoryIds":["STK"]}],"categories":[{"posCategoryId":"STK","name":"Steak & Burgers","imageUrl":"https://storage.googleapis.com/ikona-bucket-staging/images/618a2c5306a6208df4e9d061/Steaks%20and%20Burgers-6772a08c467817883c7ae27d.jpg"},{"posCategoryId":"SD","name":"Side Dishes","imageUrl":"https://storage.googleapis.com/ikona-bucket-staging/images/618a2c5306a6208df4e9d061/Sides-6772a0ade9c10b3d77b489a4.jpg"},{"posCategoryId":"DRK","name":"Drinks","imageUrl":"https://storage.googleapis.com/ikona-bucket-staging/images/618a2c5306a6208df4e9d061/Drinks-6772a0cd6448d47caa95c689.jpg"}]}},"6. Price Overloads":{"summary":"6. Price Overloads","value":{"accountId":"{{accountId}}","locationId":"{{locationId}}","products":[{"name":"Build a Poke Bowl","description":"Select a size then choose your ingredients","productType":1,"isCombo":true,"plu":"P-PB-01","price":1000,"imageUrl":"https://storage.googleapis.com/ikona-bucket-staging/images/5ff6ee089328c8aefeeabe33/poke-622850c8b303fc03a148de44.jpg","subProducts":["POKE-SZ","BNDL-01","BNDL-02"],"deliveryTax":1200,"takeawayTax":1200,"eatInTax":1200,"posCategoryIds":["POKB"]},{"name":"Choose your size","productType":3,"plu":"POKE-SZ","min":1,"max":1,"subProducts":["SZ-01"]},{"name":"Mini Poke Bowl","description":"A little bowl of Poke","productType":1,"plu":"SZ-01","price":800,"subProducts":["BNDL-01-SML"],"deliveryTax":1200,"takeawayTax":1200,"eatInTax":1200},{"name":"Choose Your Protein","productType":4,"plu":"BNDL-01-SML","price":0,"min":1,"max":1,"subProducts":["PRT-01","PRT-02"]},{"name":"Yuzu Salmon","productType":1,"plu":"PRT-01","price":0,"overloads":[{"scopes":["BNDL-01-SML"],"bundlePrice":180},{"scopes":["BNDL-LG"],"bundlePrice":250}],"deliveryTax":1200,"takeawayTax":1200,"eatInTax":1200},{"name":"Spicy Tuna","productType":1,"plu":"PRT-02","price":0,"deliveryTax":1200,"takeawayTax":1200,"eatInTax":1200},{"name":"Choose Your Base","productType":4,"plu":"BNDL-01","min":1,"max":1,"subProducts":["BS-01","BS-02"]},{"name":"Sushi Rice","productType":1,"plu":"BS-01","price":0,"deliveryTax":1200,"takeawayTax":1200,"eatInTax":1200},{"name":"Cruncy Cabbage Slaw","productType":1,"plu":"BS-02","price":0,"deliveryTax":1200,"takeawayTax":1200,"eatInTax":1200},{"name":"Add Extras","productType":3,"plu":"BNDL-02","min":0,"max":3,"multiMax":3,"subProducts":["XTRA-TOF","PRT-03"],"isUpsell":true},{"name":"Spicy Tofu","productType":1,"plu":"XTRA-TOF","price":0,"deliveryTax":1200,"takeawayTax":1200,"eatInTax":1200},{"name":"Teriyaki Chicken","productType":1,"plu":"PRT-03","price":0,"deliveryTax":1200,"takeawayTax":1200,"eatInTax":1200}],"categories":[{"posCategoryId":"POKB","name":"Poke Bowls","imageUrl":"https://storage.googleapis.com/ikona-bucket-staging/images/618a2c5306a6208df4e9d061/Poke%20Bowls-6772a0e28d35e1e63aa25a50.jpg"}]}},"7. Ingredient Groups (Delta Modifiers)":{"summary":"7. Ingredient Groups (Delta Modifiers)","value":{"accountId":"{{accountId}}","locationId":"{{locationId}}","products":[{"name":"The Hawaiian","description":"Italys favourite Pizza!","productType":1,"plu":"PIZZ-01","price":800,"imageUrl":"https://storage.googleapis.com/ikona-bucket-staging/images/5ff6ee089328c8aefeeabe33/hawaiian-622855c7b303fc03a148de48.jpeg","deliveryTax":1200,"takeawayTax":1200,"eatInTax":1200,"subProducts":["Pick-HAW-Size"],"posCategoryIds":["PZ"]},{"name":"Select Size","plu":"Pick-HAW-Size","isVariantGroup":true,"min":1,"max":1,"productType":3,"subProducts":["PIZZ-01_MED","PIZZ-01_LG"]},{"name":"Medium","plu":"PIZZ-01_MED","price":1700,"deliveryTax":1200,"productType":1,"subProducts":["Pick-PIZZA-Base","PIZZ-01-TOP","Pick-PIZZA-Extras"]},{"name":"Select Base","plu":"Pick-PIZZA-Base","min":1,"max":1,"productType":3,"subProducts":["B-AMERIC","B-ITAL"]},{"name":"American","plu":"B-AMERIC","defaultQuantity":1,"productType":2},{"name":"Italian","plu":"B-ITAL","defaultQuantity":1,"productType":2},{"name":"Toppings","plu":"PIZZ-01-TOP","isIngredientGroup":true,"min":0,"max":4,"multiMax":1,"productType":3,"subProducts":["HAM","PINE","MOZ","SAU","OREG","CH-FL"]},{"name":"Ham","deliveryTax":1200,"plu":"HAM","price":0,"productType":2,"overloads":[{"scopes":["PIZZ-01_MED-->>PIZZ-01-TOP","PIZZ-01_LG-->>PIZZ-01-TOP"],"defaultQuantity":1},{"scopes":["Pick-PIZZA-Extras"],"price":200}]},{"name":"Pineapple","deliveryTax":1200,"plu":"PINE","price":0,"productType":2,"overloads":[{"scopes":["PIZZ-01_MED-->>PIZZ-01-TOP","PIZZ-01_LG-->>PIZZ-01-TOP"],"defaultQuantity":1},{"scopes":["Pick-PIZZA-Extras"],"price":180}]},{"name":"Mozzarella cheese","deliveryTax":1200,"plu":"MOZ","price":0,"productType":2,"overloads":[{"scopes":["PIZZ-01_MED-->>PIZZ-01-TOP","PIZZ-01_LG-->>PIZZ-01-TOP","BYOP-00-->>BYOP-TOP"],"defaultQuantity":1},{"scopes":["Pick-PIZZA-Extras"],"price":150}]},{"name":"Pizza Sauce","deliveryTax":1200,"plu":"SAU","price":0,"productType":2,"overloads":[{"scopes":["PIZZ-01_MED-->>PIZZ-01-TOP","PIZZ-01_LG-->>PIZZ-01-TOP","BYOP-00-->>BYOP-TOP"],"defaultQuantity":1},{"scopes":["Pick-PIZZA-Extras"],"price":180}]},{"name":"Oregano","deliveryTax":1200,"plu":"OREG","price":0,"productType":2},{"name":"Chili Flakes","deliveryTax":1200,"plu":"CH-FL","price":0,"productType":2},{"name":"Extra Toppings","plu":"Pick-PIZZA-Extras","max":0,"min":10,"multiMax":10,"overloads":[{"scopes":["BYOP-00"],"maxFree":1}],"productType":3,"subProducts":["HAM","PEPP","JAL","PINE"]},{"name":"Pepperoni","deliveryTax":1200,"plu":"PEPP","price":150,"productType":2},{"name":"Jalapeños","deliveryTax":1200,"plu":"JAL","price":100,"productType":2},{"name":"Large","plu":"PIZZ-01_LG","defaultQuantity":1,"price":2000,"deliveryTax":1200,"productType":1,"subProducts":["Pick-PIZZA-Base","PIZZ-01-TOP","Pick-PIZZA-Extras"]}],"categories":[{"posCategoryId":"PZ","name":"Pizzas","imageUrl":"https://storage.googleapis.com/ikona-bucket-staging/images/618a2c5306a6208df4e9d061/Pizza-6772a0fb8d35e1e63aa25a53.jpg"}]}}}}}},"responses":{"200":{"description":"Synchronous","content":{"application/json":{"schema":{"type":"object","properties":{"products":{"type":"object","properties":{"inserted":{"type":"integer","example":1,"default":0},"updated":{"type":"integer","example":0,"default":0},"deleted":{"type":"integer","example":0,"default":0},"ignored":{"type":"integer","example":0,"default":0}}},"modifiers":{"type":"object","properties":{"inserted":{"type":"integer","example":6,"default":0},"updated":{"type":"integer","example":0,"default":0},"deleted":{"type":"integer","example":0,"default":0},"ignored":{"type":"integer","example":0,"default":0}}},"modifierGroups":{"type":"object","properties":{"inserted":{"type":"integer","example":2,"default":0},"updated":{"type":"integer","example":0,"default":0},"deleted":{"type":"integer","example":0,"default":0},"ignored":{"type":"integer","example":0,"default":0}}},"bundles":{"type":"object","properties":{"inserted":{"type":"integer","example":0,"default":0},"updated":{"type":"integer","example":0,"default":0},"deleted":{"type":"integer","example":0,"default":0},"ignored":{"type":"integer","example":0,"default":0}}},"priceLevels":{"type":"integer","example":0,"default":0},"warnings":{"type":"integer","example":0,"default":0},"errors":{"type":"integer","example":0,"default":0}}},"examples":{"OK":{"summary":"OK","value":{"products":{"inserted":1,"updated":0,"deleted":0,"ignored":0},"modifiers":{"inserted":6,"updated":0,"deleted":0,"ignored":0},"modifierGroups":{"inserted":2,"updated":0,"deleted":0,"ignored":0},"bundles":{"inserted":0,"updated":0,"deleted":0,"ignored":0},"priceLevels":0,"warnings":0,"errors":0}}}}}},"202":{"description":"Asynchronous"},"403":{"description":"403","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","example":"Authorization error"},"description":{"type":"string","example":"Not allowed access to this account."}},"example":"{\n \"code\": \"Authorization error\",\n \"description\": \"Not allowed access to this account.\"\n}"},"examples":{"Forbidden":{"summary":"Forbidden","value":{"code":"Authorization error","description":"Not allowed access to this account."}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}},"examples":{"accountNotFound":{"summary":"Account not found","value":{"error":"Account 5b****71c6489f0029****d4 not found"}},"locationNotFound":{"summary":"Location not found","value":{"error":"Location 5c****ecc6489f0001****b8 was not found in this account."}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{}},"examples":{"Invalid Location":{"summary":"Invalid Location","value":{"location":"Invalid Location"}},"Invalid Account":{"summary":"Invalid Account","value":{"account":"Invalid Account."}}}}},"description":"Unprocessable Entity"}}}},"/locations/{locationId}/readiness/pos":{"put":{"responses":{"200":{"description":"Accepted. Check \"recorded\" to confirm it was processed.","content":{"application/json":{"examples":{"OK":{"summary":"OK","value":{"component":"pos","status":"online","recorded":true}}}}}},"400":{"description":"\"status\" is not \"online\" or \"offline\"","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]}}}},"401":{"description":"Missing or invalid Authorization","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]}}}},"403":{"description":"Not allowed to access this location","content":{}},"404":{"description":" Unknown locationId","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"parameters":[{"in":"path","name":"locationId","schema":{"type":"string"},"required":true}],"operationId":"put_locations-locationid-readiness-pos","summary":"POS Health check ","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]},"examples":{"POS Online":{"summary":"POS Online","value":{"status":"online"}}}}}},"tags":["Endpoints"]}},"/orderValidation/{validationId}":{"post":{"responses":{"200":{"description":"Validation recorded","content":{"application/json":{"examples":{"Validation recorded. Body contains the normalized `OrderValidationResult`":{"summary":"Validation recorded. Body contains the normalized `OrderValidationResult`","value":"{}"}}}}},"400":{"content":{"application/json":{"schema":{"type":"object","properties":{}},"examples":{"Invalid JSON or non-object body.":{"summary":"Invalid JSON or non-object body.","value":"{}"},"Unknown or expired `validationId` (TTL is 15 minutes).":{"summary":"Unknown or expired `validationId` (TTL is 15 minutes).","value":"{}"}}}},"description":"Unknown or expired validationId (TTL is 15 min) or Invalid JSON or non-object body"}},"parameters":[{"in":"path","name":"validationId","schema":{"type":"string"},"required":true}],"summary":"Validation Response Async","operationId":"post_ordervalidation-validationid","tags":["Endpoints"]}}},"webhooks":{"https://yourwebhook.com/register":{"post":{"tags":["Webhooks"],"summary":"Register POS","operationId":"pos_register","parameters":[{"name":"Content-Type","in":"header","description":"application/json","schema":{"type":"string","default":"application/json"}},{"name":"Accept","in":"header","description":"application/json","schema":{"type":"string","default":"application/json"}},{"name":"User-Agent","in":"header","required":true,"description":"Identifies Deliverect as the sender, in the format `Deliverect/{version}`.","schema":{"type":"string"}},{"name":"X-Server-Authorization-HMAC-SHA256","in":"header","required":true,"description":"Signature of the raw request body using your shared secret; recompute it on receipt to verify the request came from Deliverect (see HMAC authentication guide).","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Sent by Deliverect as a JSON payload.","content":{"application/json":{"schema":{"type":"object","properties":{"accountId":{"type":"string","description":"accountId is the unique identifier of the customer account in Deliverect"},"locationId":{"type":"string","description":"locationId is Deliverect's unique identifier of a physical restaurant location, store, or kitchen."},"externalLocationId":{"type":"string","description":"externalLocationId is an identifier of the location known on the POS side, it is stored within the POS config in Deliverect"},"locationName":{"type":"string","description":"Name of the location set in Deliverect."}}},"examples":{"registerEvent":{"summary":"Register Event Example","value":{"accountId":"63********************a7","locationId":"62********************e4","externalLocationId":"61********************r5","locationName":"Test Store"}}}}}},"responses":{"200":{"description":"Return the integration URLs.","content":{"application/json":{"schema":{"type":"object","description":"When below URLs are returned as response, they will be automatically set in the location settings.\n\n{`\n\n
\n
For any webhooks not supported, an empty string can be set\n
\n
\n
\n
\n\n Please note any Deprecated parameters should be ignored\n
\n
\n
\n
\n\n Please note any Deprecated parameters should be ignored\n
\n
\n
\n
\n Use this flow when validation requires a round trip to in-store systems and cannot complete within a few seconds.\n
\n
\n
\n
15-minute validation window
\nDeliverect stores pending validations for 15 minutes When responding with a 202 (or an empty 200), the completed result must be posted to the provided callbackUrl within this window. After expiry the validationId is unknown and the callback will return a 400
\n
\n
\n
\n\n Please note any Deprecated parameters should be ignored\n
\n