# Deliverect Documentation ## Guides - [Bottle Deposits](https://developers.deliverect.com/docs/bottle-deposit-in-the-menu-push.md): Certain regions require deposits to apply for purchases of bottled drinks. - [Overview](https://developers.deliverect.com/docs/building-a-channel-integration-overview.md) - [Courier Status Updates](https://developers.deliverect.com/docs/courier-status-update-webhook.md) - [Creating Buy One Get One promo in the menu](https://developers.deliverect.com/docs/creating-buy-one-get-one-promo.md) - [Using the Dummy POS](https://developers.deliverect.com/docs/default-order-status-for-dummy-pos.md) - [Activate a Channel](https://developers.deliverect.com/docs/how-do-i-activate-my-channel.md) - [Category Images on the Menu Push](https://developers.deliverect.com/docs/category-images.md) - [Sorting of Products and Categories in a Pushed Menu](https://developers.deliverect.com/docs/how-can-the-correct-sorting-of-products-and-categories-be-seen-in-the-menu-pushed.md) - [How to Receive Menus](https://developers.deliverect.com/docs/how-do-i-receive-a-customer-menu.md) - [PLUs with Suffixes # in Menu Payload](https://developers.deliverect.com/docs/menu-push-plus-with.md) - [Nutritional & Supplemental Info](https://developers.deliverect.com/docs/nutritional-supplemental-info-menu.md): There is an extensive amount of additional info which can be associated with a product to enhance the details shown online or comply with legislation - [Sub-Categories via Menu Grouping](https://developers.deliverect.com/docs/understanding-sub-categories-via-menu-grouping.md) - [Test Busy Mode](https://developers.deliverect.com/docs/how-do-i-test-busy-mode.md) - [Validate Requests](https://developers.deliverect.com/docs/how-do-i-validate-requests-from-deliverect.md) - [Create Orders for Eat-in With a Table Number](https://developers.deliverect.com/docs/how-do-i-create-orders-for-eat-in-with-table-number.md) - [Send Discounts](https://developers.deliverect.com/docs/how-should-i-send-discounts.md) - [Create Orders](https://developers.deliverect.com/docs/how-to-create-orders.md) - [Orders Not Showing in Deliverect](https://developers.deliverect.com/docs/orders-not-showing-in-deliverect-account.md) - [Get a Channel Link ID](https://developers.deliverect.com/docs/how-to-get-your-channel-link-id.md) - [How to Receive Order Status Updates](https://developers.deliverect.com/docs/how-to-receive-order-status-updates-and-test-with-deliverect-ipad-app.md) - [Update Preparation Time of an Order](https://developers.deliverect.com/docs/how-to-update-the-preparationtime-when-you-receive-an-order.md) - [Release an Order to the POS After a Courier Is Assigned](https://developers.deliverect.com/docs/releasing-the-order-to-the-pos-after-courier-has-been-assigned-by-the-delivery-channel.md) - [Validate Dispatch Availability](https://developers.deliverect.com/docs/validating-dispatch-partner-availability.md) - [How to Checkout a Basket](https://developers.deliverect.com/docs/checkout-basket-1.md): Creates a checkout session from a basket, leading to a payment intent based on the provided method. - [How to Create / Update a Basket](https://developers.deliverect.com/docs/create-basket.md): This API lets you create and manage baskets by defining the order type and adding menu items. Baskets can be updated with customer details, items, discounts, or fulfillment before checkout. - [How to Handle Multiple Menus](https://developers.deliverect.com/docs/multiple-menus.md): How to support multiple menus being retrieved from the GET Store Menu(s) endpoint - [Overview](https://developers.deliverect.com/docs/overview-2.md) - [How to Request a Payment](https://developers.deliverect.com/docs/request-payments.md): Before checking out a basket using Deliverect Pay (DPay), the commerce platform must first initiate a payment request to the payment provider. - [How to Retrieve a Menu(s)](https://developers.deliverect.com/docs/retrieving-menus.md) - [How to Retrieve Store Details](https://developers.deliverect.com/docs/setting-up-a-store.md): Prior to basket creation, the ordering platform must retrieve storeIds & menuIds - [Overview](https://developers.deliverect.com/docs/building-dispatch-integration.md) - [Configure Webhooks](https://developers.deliverect.com/docs/dispatch-webhooks-configuration.md) - [Receive Orders](https://developers.deliverect.com/docs/how-do-i-receive-orders-for-delivery.md) - [Create Test Orders](https://developers.deliverect.com/docs/how-to-create-test-orders.md) - [Update Orders](https://developers.deliverect.com/docs/how-to-update-an-order.md) - [Order Flow](https://developers.deliverect.com/docs/order-flow.md) - [Using DMA](https://developers.deliverect.com/docs/using-dma-with-deliverect-dispatch-aka-fulfilment.md) - [Certification Process](https://developers.deliverect.com/docs/certification-process.md) - [Deprecation Policy](https://developers.deliverect.com/docs/deprecation-policy.md) - [Querying API Results with Parameters](https://developers.deliverect.com/docs/how-to-query-results.md): Use GET parameters to query and refine data returned from the API - [Install the Delivery Manager App](https://developers.deliverect.com/docs/installing-the-deliverect-app.md) - [Staging and Production Environments](https://developers.deliverect.com/docs/staging-and-production-environment.md) - [MCP](https://developers.deliverect.com/docs/mcp.md) - [Allow tax exclusive calculation on Generic POS](https://developers.deliverect.com/docs/allow-tax-exclusive-calculation-on-generic-pos.md) - [Bag Fee](https://developers.deliverect.com/docs/bag-fee.md) - [Deposits](https://developers.deliverect.com/docs/bottle-deposit.md): Certain regions require deposits to apply for purchases of bottled drinks. - [Buffer Orders](https://developers.deliverect.com/docs/buffer-orders-to-your-pos.md) - [Overview](https://developers.deliverect.com/docs/building-a-pos-integration.md) - [Create Menus](https://developers.deliverect.com/docs/create-a-menu.md) - [Service Charges, Delivery Costs, and Tips](https://developers.deliverect.com/docs/how-are-service-charge-delivery-cost-and-tip-sent.md) - [Retrieve Account Brands](https://developers.deliverect.com/docs/how-do-i-get-account-brands.md) - [Create Test Orders](https://developers.deliverect.com/docs/how-do-i-make-test-orders.md) - [Discounts](https://developers.deliverect.com/docs/how-are-discounts-sent.md) - [Find the Channel That Placed an Order](https://developers.deliverect.com/docs/how-do-i-know-which-channel-an-order-comes-from.md) - [Find the Location of an Order](https://developers.deliverect.com/docs/how-do-i-know-which-location-an-order-comes-from.md) - [Taxes](https://developers.deliverect.com/docs/how-to-calculate-taxes.md) - [Verify Orders Received by a Webhook](https://developers.deliverect.com/docs/how-to-i-verify-orders-received-to-webhook.md) - [Modifiers and Quantities](https://developers.deliverect.com/docs/how-to-interpret-modifiers-and-the-quantity-ordered.md) - [Receive Orders](https://developers.deliverect.com/docs/how-do-i-receive-orders.md) - [Validate Orders](https://developers.deliverect.com/docs/validating-orders-in-pos-using-hmac.md) - [Update Order Statuses](https://developers.deliverect.com/docs/how-to-match-order-statuses.md) - [Nutritional & Supplemental Info](https://developers.deliverect.com/docs/nutritional-information-additives-and-ingredients.md): There is an extensive amount of additional info which can be associated with a product to enhance the details shown online or comply with legislation - [Price Levels](https://developers.deliverect.com/docs/price-level-configuration.md) - [Implement the Register Webhook URL](https://developers.deliverect.com/docs/register-pos-webhook-url-how-to-register-a-location.md) - [About Main Locations](https://developers.deliverect.com/docs/use-master-location.md) - [Variants](https://developers.deliverect.com/docs/variants.md) - [Reporting Webhooks](https://developers.deliverect.com/docs/reporting-endpoints.md): A service is available to deliver various types of order data typically for reporting purposes - [Overview](https://developers.deliverect.com/docs/building-store-integration.md) - [Opening Hours API Overview](https://developers.deliverect.com/docs/opening-hours-api.md) ## API Reference - [HMAC Authentication](https://developers.deliverect.com/reference/hmac-authentication.md): This guide explains how to use HMAC-SHA256 with a pre-shared secret to verify API request authenticity - [IP Whitelisting](https://developers.deliverect.com/reference/ip-whitelisting.md) - [Access Token](https://developers.deliverect.com/reference/machine-2-machine-access-token-1.md): Set up the welcome page for your API to help users make their first call. - [Create / Cancel Order](https://developers.deliverect.com/reference/create-channel-order.md): Create a new order for a linked location. - [Allergens and tags](https://developers.deliverect.com/reference/get_allallegens.md): Get allergens and tags existing in Deliverect. - [Tables and Floors](https://developers.deliverect.com/reference/get_tables-locationid.md): Retrieve tables and floors for a location. - [Deliverect Endpoints](https://developers.deliverect.com/reference/channel_endpoints.md): These are the base URLs for endpoints hosted on the Deliverect domain. - [Order Delivery Update](https://developers.deliverect.com/reference/order-delivery-update-1.md) - [Update Courier / Guest Status](https://developers.deliverect.com/reference/post_channelname-courierupdate-channellinkid.md): Update courier or guest delivery status. - [Menu Update (Async)](https://developers.deliverect.com/reference/post_channelname-menustatus-id.md): Receive menu update callback status. - [Order Rating Update](https://developers.deliverect.com/reference/post_channelname-updaterating.md): Update rating for a previously placed order. - [Update Store Status](https://developers.deliverect.com/reference/post_channelname-updatestorestatus-channellinkid.md): Update the status of a store. - [Dispatch Availability](https://developers.deliverect.com/reference/post_fulfillment-validate.md): Validate dispatch availability for a delivery location. - [Amendments (retail only)](https://developers.deliverect.com/reference/channel_amendments.md): When a store processes amendments for one or more items within an order, this webhook will deliver the amendment details - [Busy mode](https://developers.deliverect.com/reference/channel_busy_mode.md): When a store status changes to open or closed, a webhook event will be sent - [Courier Update](https://developers.deliverect.com/reference/channel_courier_update.md): This webhook delivers real-time updates on each delivery, based on information provided by the integrated Dispatch partner. - [Menu Update](https://developers.deliverect.com/reference/channel_menu_update.md): Customers will publish their menu to a provided webhook URL. This delivers JSON containing all the necessary attributes to display their menu as intended - [Order Status Update](https://developers.deliverect.com/reference/channel_order_status.md) - [Substitutes (retail only)](https://developers.deliverect.com/reference/channel_orders_channelorderid_substitute_plu.md): This is a GET webhook provided by the channel, which returns valid substitute item PLUs for any requested substitution - [Payment update](https://developers.deliverect.com/reference/channel_payment_update.md) - [Preparation time update](https://developers.deliverect.com/reference/channel_prep_time.md): {{YourSetwebhookUrl}} - [Channel Registration](https://developers.deliverect.com/reference/channel_register.md) - [Picking Status Update (retail only)](https://developers.deliverect.com/reference/channel_retailevents.md): When a store process order picking status updates, this webhook can be set to receive these events - [Snooze / Unsnooze Products](https://developers.deliverect.com/reference/channel_snooze.md): Webhook events will be sent when items are snoozed or unsnoozed - [Partner Webhooks](https://developers.deliverect.com/reference/channel_webhooks.md) - [Commerce API - Overview](https://developers.deliverect.com/reference/commerce-api-overview.md): Our Commerce API powers digital ordering via endpoints that provide store details, menu data, basket calculation and validation and provides a checkout flow to handle POS order injection. - [Get Basket](https://developers.deliverect.com/reference/commerce-channel-api-baskets-get-basket-1.md) - [Update Basket - Charges](https://developers.deliverect.com/reference/commerce-channel-api-baskets-update-basket-charges-1.md) - [Update Basket - Customer](https://developers.deliverect.com/reference/commerce-channel-api-baskets-update-basket-customer-1.md) - [Update Basket - Group Customers](https://developers.deliverect.com/reference/commerce-channel-api-baskets-update-basket-customers-group.md) - [Update Basket - Fulfillment Details](https://developers.deliverect.com/reference/commerce-channel-api-baskets-update-basket-fulfillment-1.md) - [Update Basket - Item(s)](https://developers.deliverect.com/reference/commerce-channel-api-baskets-update-basket-items-1.md) - [Update Basket - Policies](https://developers.deliverect.com/reference/commerce-channel-api-baskets-update-basket-policies-group.md) - [Get Root Menu(s)](https://developers.deliverect.com/reference/commerce-channel-api-menus-get-root-menus1.md): This endpoint returns a list of menus associated with the account's master location. These menus are store agnostic and typically hold enough data to display as first entry experience. - [Get Store](https://developers.deliverect.com/reference/commerce-channel-api-stores-get-store-1.md): A store represents a unique ordering experience from a specific location. - [Checkout Basket](https://developers.deliverect.com/reference/commerce-checkout.md): Creates a checkout session from a basket, leading to a payment intent based on the provided gateway. - [Create Basket](https://developers.deliverect.com/reference/commerce-create-basket.md): This endpoint creates a Basket for the store. - [Get Checkout](https://developers.deliverect.com/reference/commerce-get-checkout.md): Returns a checkout session by ID. This can be used to poll the status of a checkout session providing order placement details. - [Get Store Menu(s)](https://developers.deliverect.com/reference/commerce-get-menus.md): Returns the menus available for a specific store. - [Get Stores](https://developers.deliverect.com/reference/commerce-get-stores.md): Returns the list of stores. A store represents a unique ordering experience from a specific location. - [Update Basket - Discount(s)](https://developers.deliverect.com/reference/commerce-update-basket-discounts.md) - [Deliverect Endpoints](https://developers.deliverect.com/reference/commerce-channel-api.md): Our Commerce API powers digital ordering via endpoints that provide store details, menu data, basket calculation and validation and provides a checkout flow to handle POS order injection. - [Recreate Basket](https://developers.deliverect.com/reference/recreate.md) - [Update Basket - Payments](https://developers.deliverect.com/reference/update-basket-payments.md): Add payment of 'tips' to the basket - [Update Basket - Store](https://developers.deliverect.com/reference/update-basket-store.md) - [Update Basket - Donations](https://developers.deliverect.com/reference/update-donations.md): Add a donation to the basket - [Validate Basket](https://developers.deliverect.com/reference/validate-basket.md) - [Busy Mode](https://developers.deliverect.com/reference/commerce_busymode.md): When a store status changes to open or closed, a webhook event will be sent - [Menu Update](https://developers.deliverect.com/reference/commerce_menu_publish.md): This webhook will be called whenever a menu updates are published - [Courier Status Update](https://developers.deliverect.com/reference/commerce_order_update_1.md): This webhook delivers real-time updates on each delivery, based on information provided by the integrated Dispatch partner. - [Order Status Update](https://developers.deliverect.com/reference/commerce_order_update.md) - [Snoozed / Unsnoozed Products](https://developers.deliverect.com/reference/commerce_snoozedproducts.md): Webhook events will be sent when items are snoozed or unsnoozed - [Partner Webhooks](https://developers.deliverect.com/reference/commerce-webhooks.md): Receive real-time event notifications for key order, menu, and store updates via below webhooks; - [Checkout Update](https://developers.deliverect.com/reference/post_checkout-update.md) - [Get Coupons](https://developers.deliverect.com/reference/get_couponsadminaccountidcouponscouponid-1.md) - [Validate Coupon](https://developers.deliverect.com/reference/get_new-endpoint.md) - [Deliverect Endpoints](https://developers.deliverect.com/reference/coupons_endpoints.md) - [Lookup Customer by Email](https://developers.deliverect.com/reference/customer_by_email.md) - [Customer Profile](https://developers.deliverect.com/reference/customer_by_id.md) - [Customer Order History](https://developers.deliverect.com/reference/customer_order_history.md) - [Customer Favorite Orders](https://developers.deliverect.com/reference/favorite_orders.md) - [Deliverect Endpoints](https://developers.deliverect.com/reference/crm_endpoints.md): This documentation covers all capabilities of our CRM API - [CRM Order](https://developers.deliverect.com/reference/order_by_id.md) - [Update Customer Favorites](https://developers.deliverect.com/reference/update_customer_favorites.md): Update a customer's favorites - [Update Customer Profile](https://developers.deliverect.com/reference/update_customer.md) - [Update Customer Delivery Addresses](https://developers.deliverect.com/reference/update_deliveryaddresses.md): Update the addresses stored on a customer's profile - [Update Customer Vehicles](https://developers.deliverect.com/reference/update_vehicles.md): Update the addresses stored on a customer's profile - [Deliverect Endpoints](https://developers.deliverect.com/reference/dispatch_endpoints.md): These are the base URLs for Dispatch endpoints hosted on the Deliverect domain. - [Cancel Delivery](https://developers.deliverect.com/reference/post_fulfillment-cancel.md) - [Update delivery](https://developers.deliverect.com/reference/post_fulfillment-generic-events.md) - [Cancel Delivery Job](https://developers.deliverect.com/reference/dispatch_cancel_job.md): A merchant or ordering channel may cancel the order, which in turn will cancel the delivery job - [Create Delivery Job](https://developers.deliverect.com/reference/dispatch_create_job.md): Once a delivery job is validated a second webhook event will be sent to confirm the full details - [Update Delivery Job](https://developers.deliverect.com/reference/dispatch_updatejob.md): A merchant or ordering channel may cancel the order, which in turn will cancel the delivery job - [Validate Delivery Job](https://developers.deliverect.com/reference/dispatch_validate_job.md): The initial dispatch notification that a new job is available which needs validated as being deliverable - [Partner Webhooks](https://developers.deliverect.com/reference/dispatch_webhooks.md) - [Get profile links](https://developers.deliverect.com/reference/get_giftcards-channel-channellinkid-providerprofilelinks.md) - [Apply gift card](https://developers.deliverect.com/reference/giftcards_apply_gift_card.md) - [Get balance](https://developers.deliverect.com/reference/giftcards_get_balance.md) - [Deliverect Endpoints](https://developers.deliverect.com/reference/giftcards.md) - [Redeem Gift Card](https://developers.deliverect.com/reference/giftcards_redeem.md) - [Register Gift Card Provider](https://developers.deliverect.com/reference/giftcards_registerprofile.md) - [Reverse Redemption](https://developers.deliverect.com/reference/giftcards_reverse.md) - [Partner Webhooks](https://developers.deliverect.com/reference/partner-webhooks-3.md) - [Deliverect Endpoints](https://developers.deliverect.com/reference/kds_endpoints.md) - [Update Order Status](https://developers.deliverect.com/reference/post_kds-orderstatus-orderid.md) - [Order Notification](https://developers.deliverect.com/reference/kds_order_notification-1.md) - [Order Status Update](https://developers.deliverect.com/reference/kds_order_status_update.md) - [Product Update](https://developers.deliverect.com/reference/kds_productupdate.md) - [Register KDS](https://developers.deliverect.com/reference/kds_register_kds.md) - [Get Loyalty Customer Wallet](https://developers.deliverect.com/reference/get-loyalty-customer-wallet.md): Retrieve the loyalty points and cash amounts for a customer. - [Get Loyalty Tiers](https://developers.deliverect.com/reference/get-loyalty-tiers.md): The tiers returned are sorted by lowest to highest - [Loyalty Channel Endpoints](https://developers.deliverect.com/reference/loyalty-channel.md) - [Create Loyalty Customer](https://developers.deliverect.com/reference/loyalty-channel-create-loyalty-customer.md) - [Get Loyalty Configuration](https://developers.deliverect.com/reference/loyalty-channel-get-configuration.md): This endpoint provides information such as settings, features and requirements based on the account's configuration. - [Get Loyalty Customer](https://developers.deliverect.com/reference/loyalty-channel-get-customer.md) - [Get Loyalty Programs](https://developers.deliverect.com/reference/loyalty-channel-get-programs.md) - [Validate Compensation Cards](https://developers.deliverect.com/reference/loyalty-channel-validate-compensation-cards.md): This endpoint allows partners to validate one or more compensation cards against a specific order/basket. It determines if a card is applicable, calculates the associated discounts, or identifies specific validation errors (e.g., expired, invalid). - [Validate Loyalty Programs](https://developers.deliverect.com/reference/loyalty-channel-validate-loyalty-programs.md) - [Loyalty Partner Webhooks](https://developers.deliverect.com/reference/loyalty-partner.md) - [Cancel Loyalty Order](https://developers.deliverect.com/reference/loyalty_cancelorder.md) - [Create Loyalty Customer](https://developers.deliverect.com/reference/loyalty_customer.md) - [Get Loyalty Customer](https://developers.deliverect.com/reference/loyalty_get_customer.md) - [Get Loyalty Customer Wallet](https://developers.deliverect.com/reference/loyalty_get_wallet.md) - [Create Loyalty Order](https://developers.deliverect.com/reference/loyalty_order.md) - [Get Loyalty Programs](https://developers.deliverect.com/reference/loyalty_programs_loyalty.md) - [Register Loyalty Partner](https://developers.deliverect.com/reference/loyalty_registration.md) - [Get Loyalty Tiers](https://developers.deliverect.com/reference/loyalty_tiers.md) - [Validate Programs](https://developers.deliverect.com/reference/loyalty_validateprogram.md) - [Loyalty Discounts Schema](https://developers.deliverect.com/reference/loyalty-discounts.md): Loyalty Discount Schemas And Examples - [Loyalty Order Schema](https://developers.deliverect.com/reference/loyalty-order-schema.md) - [Loyalty Single Sign On (SSO)](https://developers.deliverect.com/reference/loyalty-partner-sso.md) - [Loyalty SSO - OAuth token exchange](https://developers.deliverect.com/reference/loyalty_token.md): https://integrator.com/auth/token - [Loyalty SSO - redirect to ordering channel](https://developers.deliverect.com/reference/loyalty-partner-sso-redirect.md) - [MCP](https://developers.deliverect.com/reference/mcp.md) - [Partner Webhooks](https://developers.deliverect.com/reference/copy-of-pay-api-endpoints.md) - [Payment Update ](https://developers.deliverect.com/reference/payapi_payment_update.md) - [Deliverect Endpoints](https://developers.deliverect.com/reference/pay_endpoints.md) - [Get Payment](https://developers.deliverect.com/reference/pay_endpoints-get-payment-1.md) - [Get Payment Gateways](https://developers.deliverect.com/reference/pay_endpoints-get-payment-gateways-1.md) - [Refund Payment](https://developers.deliverect.com/reference/pay_endpoints-refund-payment.md) - [Request Payment](https://developers.deliverect.com/reference/pay_endpoints-request-payment-2.md) - [Pay API - Overview](https://developers.deliverect.com/reference/pay_webhooks.md) - [Payment Events](https://developers.deliverect.com/reference/payment-events.md) - [Register Profile](https://developers.deliverect.com/reference/payplatform_payments_profile_register.md) - [Refund Payment](https://developers.deliverect.com/reference/payplatform_payments_refund.md) - [Request Payment](https://developers.deliverect.com/reference/payplatform_payments_request.md) - [Unregister Profile Event](https://developers.deliverect.com/reference/payplatform_payments_unregister_profile.md): When the gateway profile is uninstalled, the partner is expected to handle the unregistered event so that the profile can be uninstalled and disabled. - [Deliverect Endpoints](https://developers.deliverect.com/reference/pos_endpoints.md): These are the base URLs for endpoints hosted on the Deliverect domain. - [Products & Categories](https://developers.deliverect.com/reference/insertupdateproductsandcategories.md) - [Inventory Update (Retail)](https://developers.deliverect.com/reference/inventory-update-1.md): To support changes to item availability, Deliverect can receive an inventory file. - [Item Upload (Retail)](https://developers.deliverect.com/reference/item-upload-retail.md): To support large product ranges common to the retail sector, Deliverect can receive an Item file for upload. - [Update Order Preparation Time](https://developers.deliverect.com/reference/update-order-preparation-time.md) - [Update Order Status](https://developers.deliverect.com/reference/update-order-status-1.md) - [Bill update](https://developers.deliverect.com/reference/updatebill.md): Deliver the details of a bill closed on the POS to Deliverect. - [Partner Webhooks](https://developers.deliverect.com/reference/pos_webhooks.md) - [Product Update Callback (async)](https://developers.deliverect.com/reference/pos_api_product_sync_callback.md): The webhook will be delivered to a specified endpoint, and the response will include the **`operationReportId`** and the summary of products synced as per below example. - [Sync Floors](https://developers.deliverect.com/reference/pos_floors_locationid.md): *This is a GET webhook set by the POS - [Order Notification](https://developers.deliverect.com/reference/pos_ordercancel.md): *This will be the same webhook endpoint set by the POS for Order Notifications - [Register POS](https://developers.deliverect.com/reference/pos_register.md): *This is a webhook set by the POS - [Sync Products](https://developers.deliverect.com/reference/pos_syncproducts.md): *This is a GET webhook set by the POS - [Sync Tables](https://developers.deliverect.com/reference/pos_tables_locationid.md): *This is a GET webhook set by the POS - [Tax Calculation](https://developers.deliverect.com/reference/tax-calculation-2.md) - [Allergens and Tags](https://developers.deliverect.com/reference/allergens-and-tags.md) - [Channel Holiday](https://developers.deliverect.com/reference/channel-holiday.md) - [Channel Integrators](https://developers.deliverect.com/reference/channel-integrators.md) - [Channel Links](https://developers.deliverect.com/reference/channel-links.md) - [Account Opening Hours](https://developers.deliverect.com/reference/get_account-accountid-openinghours.md) - [Snoozed Products](https://developers.deliverect.com/reference/get_channeldisabledproducts.md): Get products marked out of stock. - [Location Holiday Hours](https://developers.deliverect.com/reference/get_location-locationid-holidays.md) - [Location Opening Hours](https://developers.deliverect.com/reference/get_location-locationid-openinghours.md) - [Account Brands](https://developers.deliverect.com/reference/get-accounts-brands-2.md) - [Accounts](https://developers.deliverect.com/reference/get-linked-accounts.md): Retrieve all accounts linked to your API users - [Locations](https://developers.deliverect.com/reference/get-locations.md): Per physical restaurant location, there will be a *Location*. This endpoint can be used to query them. You can have to specify an account, otherwise the locations of your own account will be returned - [POS Products](https://developers.deliverect.com/reference/get-products-for-account.md) - [Deliverect Endpoints](https://developers.deliverect.com/reference/store_endpoints.md): The store API allows multiple functions to query and update the availability of customer's stores and the products in their account - [Snooze Product by Tag](https://developers.deliverect.com/reference/mark-products-out-of-stock-by-tag.md): Mark products out of stock for a certain amount of time based on their tag and location. You can use the same call to unsnooze product passing `snoozeEnd` time in the past. ##### NOTE Please note, that here and later all dates and times, coming from/to Deliverect are UTC. - [Orders](https://developers.deliverect.com/reference/orders.md) - [Update Channel Holiday Hours](https://developers.deliverect.com/reference/post_locations-channels-holidays.md) - [Update Location Holiday Hours](https://developers.deliverect.com/reference/post_locations-holidays.md) - [Update Opening Hours](https://developers.deliverect.com/reference/post_locations-openinghours.md) - [Snooze Product by PLU](https://developers.deliverect.com/reference/snooze-by-plu.md): Mark products out of stock for a certain amount of time based on their PLU and location. You can use the same call to unsnooze product passing `snoozeEnd` time in the past. - [Request Product Sync](https://developers.deliverect.com/reference/sync-pos-products.md): This endpoint initiates the product sync request for a specified location. When called, Deliverect will trigger a product sync from the connected POS system for the given location. - [Busy Mode](https://developers.deliverect.com/reference/update-store-status.md): This endpoint allows a POS to update store status. One, several or all channel links can be put in busy/online mode(should be supported by channels as well) by calling this endpoint. When sending a call to the endpoint make sure it includes `isActive` flag which indicates if store busy/online. Optional parameter `channelLinks` allwos you to specify a list of channel links to be put in busy/online mode. Otherwise all location channel links will be put in busy/online mode. As a payload we always expect a JSON that contains: * Flag that indicates if store is busy/online (`isActive`) * [Optional] Array of channel link ids to be put in busy/online more (`channelLink`) - [Order Events](https://developers.deliverect.com/reference/reportingendpoint_orders.md): A service is available to deliver various types of order data typically for reporting purposes - [Store Status](https://developers.deliverect.com/reference/store_store_status.md) - [Get Upsell Items](https://developers.deliverect.com/reference/getupsellitems.md) ## Pages - [Allergens and Tags](https://developers.deliverect.com/allergens-and-tags.md) - [Basket Model](https://developers.deliverect.com/basket-model.md) - [Managing your Partner Credentials](https://developers.deliverect.com/c.md) - [Channel Order Model](https://developers.deliverect.com/channel-orders.md) - [ChannelAPI.json](https://developers.deliverect.com/channelapijson.md) - [Courier Status Update Model](https://developers.deliverect.com/courier-status-update-model.md) - [Creating orders for Dispatch / Last Mile Delivery](https://developers.deliverect.com/creating-orders-for-restaurant-delivery-dispatch-service.md) - [Custom Tags and Allergens](https://developers.deliverect.com/custom-tags-and-allergens.md) - [Discount Provider Type](https://developers.deliverect.com/discount-provider-type.md) - [Dispatch - Delivery Job Model](https://developers.deliverect.com/dispatch-delivery-job-model.md) - [Dispatch - Error Codes](https://developers.deliverect.com/dispatch-error-codes.md) - [DispatchAPI.json](https://developers.deliverect.com/dispatchapijson.md) - [Eat-in Orders](https://developers.deliverect.com/eat-in-orders.md) - [Frequently Asked Questions -old-](https://developers.deliverect.com/faq.md) - [Flatten Nested Modifiers](https://developers.deliverect.com/flatten-nested-modifiers.md) - [Glossary - Channel Orders](https://developers.deliverect.com/glossary-channel-orders.md) - [Glossary - Dispatch Availability](https://developers.deliverect.com/glossary-dispatch-availability.md) - [Glossary - Payment API](https://developers.deliverect.com/glossary-payment-api.md) - [Glossary - POS Orders](https://developers.deliverect.com/glossary-pos-orders.md) - [Glossary - Product Insert / Update](https://developers.deliverect.com/glossary-product-insert-with-supplement-nutrition-info.md) - [Glossary - Menus](https://developers.deliverect.com/glossary.md) - [Images - Menu Payload](https://developers.deliverect.com/images-menu.md) - [Images - POS Products](https://developers.deliverect.com/images.md) - [KDS_API.json](https://developers.deliverect.com/kds_apijson.md) - [Translation Language Codes](https://developers.deliverect.com/language-codes.md) - [Set Visible Status (per Channel or Menu)](https://developers.deliverect.com/lce-set-visible-status-per-menu.md) - [List of currencies](https://developers.deliverect.com/list-of-currencies.md) - [List of Discount Types](https://developers.deliverect.com/list-of-discount-types.md) - [Store Opening Times](https://developers.deliverect.com/menu-availabilities.md) - [Menu Push - Protection against missing products at location](https://developers.deliverect.com/menu-push-protection-against-missing-products-at-location.md) - [Home](https://developers.deliverect.com/new-layout.md) - [Order and Courier Statuses](https://developers.deliverect.com/order-status.md) - [Payments and Additional Charges](https://developers.deliverect.com/payment-types.md) - [POS_API](https://developers.deliverect.com/pos_api.md) - [POS - Direct Table Ordering](https://developers.deliverect.com/pos-direct-table-ordering.md) - [POS - Order Cancellations](https://developers.deliverect.com/pos-order-cancellations.md) - [POS Order Webhook - Failover Flow](https://developers.deliverect.com/pos-order-webhook-failover-flow.md) - [POS - Payments, Taxes, Discount & other Charges](https://developers.deliverect.com/pos-payments-taxes-discount-other-charges.md) - [Product Availability](https://developers.deliverect.com/product-availability.md) - [POS Product Configuration](https://developers.deliverect.com/product-configuration.md) - [Menu Product Configuration](https://developers.deliverect.com/product-types.md) - [Deliverect Endpoints](https://developers.deliverect.com/retail-api.md) - [Retail Orders - Item Unavailable Actions](https://developers.deliverect.com/retail-orders-item-unavailable-actions.md) - [Set 'visible' status per channel](https://developers.deliverect.com/set-visible-status-per-channel.md) - [Store Model](https://developers.deliverect.com/store-model.md) - [StoreAPI.json](https://developers.deliverect.com/storeapijson.md) - [Stores - Glossary](https://developers.deliverect.com/stores-glossary.md) - [Tax Exclusive Orders](https://developers.deliverect.com/tax-exclusive-orders.md) - [Translatable Elements and Language Codes](https://developers.deliverect.com/translatable-elements-and-codes.md) - [Tutorials](https://developers.deliverect.com/tutorials.md) ## Changelog - [New "Display Labels" attribute](https://developers.deliverect.com/changelog/new-display-labels-attribute.md) - [Small Order Fee](https://developers.deliverect.com/changelog/small-order-fee.md) - [Optional "placedTime" Attribute for Order Assignment](https://developers.deliverect.com/changelog/optional-placedtime-attribute-for-order-assignment.md) - [Multiple Couriers for Split Orders](https://developers.deliverect.com/changelog/courier-status-update.md) - [Dispatch Availability - Co-ordinates format change](https://developers.deliverect.com/changelog/dispatch-availability-co-ordinates-format-change.md)