Ordering API

API Changelog

The API Changelog documents all breaking changes from one API version to another. Please consult the changelog when upgrading your integration to a newer API version.

January v4.58

What's new

Web App

  • Serving Time Logic Update: Items will now be marked unavailable for scheduled orders where the promise time is less or equal to the start of the serving time. This update prevents order failures due to preparation time conflicts. Kiosk
  • Gift Card Payment Support: Users can now pay for their orders using physical gift cards at kiosks.
  • Kiosk SSO Flow with Punchh: Users can sign in or sign up at the kiosk using their phone or email, ensuring seamless account access.
  • Punchh SSF QR Code Sign-In: Users can log in to the kiosk using a QR code generated from the Punchh mobile app. Link
  • Support for Grubhub Tax Exemptions: Integrated support for Grubhub's exempted_taxes object to ensure accurate tax handling. POS
  • Support for DoorDash-Funded Promotions on Brink (MPF Logic): Orders with DoorDash-funded promos now properly account for tax remittance, ensuring they fall within the acceptable tolerance threshold and preventing order failures. Payments
  • Improved Error Messaging: Users will receive clearer error messages when CVV or AVS validation fails during payment.

Fixes & Improvements

Payments

  • Toast Payments Bug: Resolved issues with storing payment methods on Toast Payments.

February v4.59

What's New

Web App

Checkout Experience Enhancements:

  • Menu Customization: A new hideUnavailableItems property has been added to branding_config.json, enabling the option to hide unavailable menu items.
  • Punchh Promo Code Redemption on Checkout: Both registered and guest users can now add and redeem Punchh promo codes on the checkout screen.
  • Cross-Selling Enhancements: A new cross-selling dialog will appear before checkout, displaying recommended items to prompt online guests to add to their cart. Note: This dialog will only appear if the cross-selling placement is set to “Dialog” in the management center. Otherwise, cross-selling will default to the cart. Here is a step-by-step guide to set up cross-selling. Management Center
  • Enhanced Search by Store Code: The search functionality in the Management Center (MC) has been aligned with the Content Management System (CMS), allowing MC users to search by store code.

Fixes & Improvements

Web App

  • Streamlined Checkout Process: Customers will no longer need to re-enter their phone number after registration.
  • Mastercard typo correction: Correct a typo in the Mastercard brand name within the payment methods list—changing "Master Card" to "Mastercard".

March v4.60

What's New

  • Menu Version 2.0 The first general availability release of Menu Version 2.0 introduces new capabilities for greater menu customisation while simplifying complexity. It combines deep menu customisation with enhanced user journeys and cart innovations.

Key Benefits:

Simplified Menu Management: POS system as the "source of truth" for automatic updates. Multiple Menus: Create custom menus for breakfast, lunch, delivery, and more, assigned to individual stores or groups of stores, allowing you to test menus in select locations.

Endless Flexibility:

Nested Modifier Groups: Ability to create a complex menu with unlimited nested options to enhance customer choice, drive upsells, and boost profits. Quantity Modifiers: Give your guests the flexibility to select multiple modifiers within predefined rules, enhancing their dining experience with more personalized options.

  • Web App 2.0 Achieves feature parity between the web and native apps, ensuring a seamless user experience across platforms. Delivers a more consistent and improved experience across channels, enabling faster updates and enhancements since changes are made in one place.

  • Order Throttling Feature designed to help manage kitchen capacity effortlessly, by regulating order flow.

Key Benefits:

Maximum Time Control: Set maximum preparation time per time slot. Precision Order Limits: Control the maximum amount of orders within 15-minute intervals.

Fixes & Improvements

  • Missing Venue on the Brand Order Feedback Report: Resolved a bug where the location details were missing from the "Venue" column in the Brand Order Feedback report within CMS.

April v4.61

What's New

  • AI Cross-Sell: Personalized Recommendations for Every Guest Our AI-powered cross-sell tool is now generally available. By analyzing guest behavior in real time, it delivers smart, personalized suggestions. Whether it’s a side, drink, or dessert - at just the right time in the ordering flow.

Key Benefits:

Boosts average order value Enhances guest experience with relevant recommendations Works automatically without extra setup

  • POS Importing We are introducing a new feature designed to streamline the menu importing process. Brands can now select menus, categories, product groups, and products from a POS checklist and once selected, these items are automatically imported into the system. This improvement significantly reduces manual effort.

  • Web App Logo URL Brands can now define a custom URL for the logo on the Web App Home screen. When users click the logo, they’ll be redirected to the specified URL. On all other pages, the logo will continue to return users to the Home screen.

  • Curbside Enhancements Curbside on the Web App The Curbside Pickup order type, previously exclusive to Mobile Apps, is now available on the Web App! This expansion allows customers to enjoy the same convenient pickup experience from their desktop or mobile browser, offering more flexibility and improving order accessibility across all platforms.

  • Curbside SMS Notifications Guests and logged-in users can now access their curbside orders directly through an SMS link.

  • Flexible Serving Times Brands can now customize their serving time cut-off windows, allowing for greater flexibility and control over menu item availability.

  • Dynamic DSP Fees Now we are supporting pass-through DSP fees to customers at checkout. Brands can choose to transparently pass along delivery service provider fees.

Fixes & Improvements

Kiosk Enhancements

  • Orders Outside Store Hours: Kiosk orders will now skip the "pickup at" time validation, preventing failures when stores are technically closed.

  • Kiosk Back Button: The back button now correctly returns users to the checkout page for a smoother user journey.

  • Promo Code Redemption at Checkout: Promo code redemption is now available on the Kiosk checkout screen, complete with an on-screen keyboard for ease of use, bringing the kiosk experience in line with the web platform.

  • Combo Meal Tax Rates on Brink POS: Fixed an issue where tax rates were not properly populated for combo meals. Our system now retrieves tax values from the combo meal level, not just the individual combo items.

  • Dynamic Prep Time for External Channels: Fixed an issue where dynamic prep time for third-party orders resulted in pickup times earlier than expected. Pickup time now properly reflects the send time + prep time.

  • Reward Redemption Not Voided on Order Failure: Fixed an issue where rewards were not returned to customers when an order failed due to payment or POS errors. Rewards will now be automatically reinstated, ensuring customers retain their benefits in case of technical issues.

May v4.62

What's New

  • Split Payments Brands can now enable split payments across multiple methods for registered users, creating a smoother and more convenient experience.

Key Benefits:

Prioritizes gift cards before credit/debit cards. Automatically splits amounts across cards, with manual adjustment options. Smart validation ensures a seamless and error-free experience.

  • Custom Fees Brands can now apply configurable custom fees (e.g., Tech Fee, Service Fee) directly to Takeout and Delivery orders.

Key Benefits:

Filter by store, time period, and ordering channel for tailored insights. Compare current sales to previous periods and spot top-performing items instantly. Download raw data in CSV format to dive deeper into trends. Want to learn more? Click here for brand-level details and here for store-level details. Parent Product Groups Brands can now create and reuse a single modifier group across multiple products, while still customizing which options are shown for each product.

  • Reordering 2.0 Enhance customer loyalty and reduce time-to-order with our upgraded reordering experience.

Key Benefits:

“Reorder” button on Home and Order History. Customize before placing the order. Real-time availability checks and smart replacements ensure no dead ends.

  • Multiple Radiuses for Delivery Zones Brands can now define multiple delivery radiuses per store, assign tiered fees for each zone, and combine these with custom polygon zones for even greater precision. A built-in visual editor makes setup intuitive and ensures accurate zone validation.

  • POS Enhancements (PAR POS) Delivery Fee as Item: We now support processing delivery fees as an item, not a surcharge.

Fixes & Improvements

  • Kiosk NMG User Experience Product groups now open when users tap anywhere on the product card, making item selection more intuitive and seamless.

June v4.63

What's New

Limited Time Products Brands can now define availability windows for products, allowing for easy rollout of seasonal or promotional items.

Set specific start and end dates to control when a product is available for ordering and pickup. Products are automatically hidden from all ordering channels once the end date passes. Built-in validations help prevent setup errors (e.g., start date must be in the future). Easily configure and manage availability windows directly in the Management Center.

  • Favorite Items Users can now mark products and configurations as favorites for easy reordering.

Key Benefits:

Registered users can save and manage favorite items. Saved favorites are accessible from the home screen or account page. Guest users are prompted to sign up to use the feature.

  • Pre-Ordering Brands can now configure pre-ordering availability, enabling orders to be placed in advance for specific products.

Key Benefits:

Set an order window: Define when customers can add the item to their cart Set a fulfillment window: Specify when the item is available for pickup or delivery Display smart in-app messaging, such as “Preorder for pickup starting June 15” Support date-based logic that adapts to future availability without manual intervention

  • Order Throttling V2 - Order Count Strategy We’re expanding our kitchen capacity management tools with the new Order Count Strategy. This throttling approach allows brands to limit the number of orders accepted per time slot, ensuring smoother operations during high-demand periods.

Key Benefits:

Define a maximum number of orders per 15-minute window. Customize limits for rush hours, holidays, and other key times. Kiosk orders remain exempt from throttling but are still factored into capacity calculations. Track availability in real time with the enhanced Slot Occupancy Dashboard.

  • Tablet V2 – Order Management for NMG Brands using NMG can now manage kitchen orders directly via the in-store tablet, improving operational flexibility.

  • Partial Refunds (NMG) We’ve expanded our Menu v2 refund capabilities with partial refunds support across all order types, including those involving loyalty rewards or redemptions.

Fixes & Improvements

  • POS API V2 Releasing a new version of our external POS API, enabling POS partners to integrate directly with our V2 platform for more robust and scalable support.

  • Marketplace Store Availability Toggle Brands can now manage store availability on marketplaces (e.g., DoorDash, Uber Eats) directly from the Link connectivity dashboard.

  • SkipTheDishes Multi-Store Support Added support for multiple delivery options through SkipTheDishes, including robo-delivery and future ghost kitchen operations.

  • Enhanced Web App Logo URL Behavior We’ve improved the homepage logo functionality. If a URL is configured, clicking the logo on the homepage will now open the specified marketing site in a new browser tab. If no URL is configured, the logo will no longer perform any action, ensuring a clean and predictable user experience.

July v4.64

What's New

  • AI Cross-Sell Available for Menu v2 Our AI-powered cross-sell tool, designed to surface personalized item recommendations in real time, is now fully compatible with Menu v2. This update enables brands using the latest menu structure to activate Smart Cross-Sell.

  • Distribute & Publish by Store Brands now have the ability to distribute and publish menus at the individual store level, rather than only by store groups.

  • Parent Category Building on the same principle as Parent Product Groups, Parent Categories allow brands to reuse a single category across multiple menus.

  • Parent Category & Product Group for PAR Link Now supporting parent category and product group visibility on third-party marketplaces via PAR Link.

  • Pickup Time Filter Enhancements We’ve refined how pickup times are filtered by aligning them with menu serving times rather than general store opening hours.

August v4.65

What's New

  • Drive-Thru We’re introducing a dedicated Drive-Thru order type within the PAR Ordering Ecosystem. With Drive-Thru, users can place their order through the web app or mobile app and pick it up at a designated drive-thru window with no need to leave their car. The ordering flow is optimized for speed and convenience, making it an ideal choice for on-the-go users.

  • Loyalty in Checkout Users can now view and apply offers and rewards directly from the checkout page, making it easier to redeem loyalty benefits without leaving the ordering flow.

  • Store Finder 2.0 We’ve redesigned the Store Finder to make selecting the right location and order type faster and more intuitive. Users can now seamlessly switch between Pickup, Delivery, and Catering while browsing.

The experience includes persistent store and order type selection throughout the session, real-time filtering by order type and proximity, and a toggle between map and list views on mobile.

Store Finder is now accessible from multiple points in the app, including the home screen, menu page, and rewards page, making it easier than ever to find and select your preferred store whenever you need it.

  • Order Type, Store & Pickup Time UX Enhancements We’ve streamlined the Menu page experience, making it faster and more intuitive for users to adjust store, order type, and pickup time without leaving the menu.

  • Off-Screen Cart Users can now view and access their cart from any page, ensuring a smoother browsing and checkout experience.

  • PAR POS - Simple Combo Pricing Added support for PAR POS’s container-level combo pricing.

  • Kiosk - Peripheral Plug-and-Play Removed unnecessary certification requirements for peripherals, enabling faster, plug-and-play support for kiosk hardware.

  • Catering Tax Exceptions: Apply tax exemptions to eligible catering orders based on order details, improving accuracy and the customer experience.

  • Catering Serving Time Headcounts: Portions now automatically scale based on the selected headcount and serving time, streamlining preparation and reducing waste.

Fixes & Improvements

  • LTO & Pre-Order Logic Improvements Products with limited-time or pre-order availability are now automatically marked unavailable once their defined windows have passed, ensuring users only see valid items. This update applies to both main and nested products, and LTO logic has been extended to the off-screen cart for consistent behavior across all ordering flows.

Automatic unavailability of products after LTO or pre-order windows expire. Applies to main and nested products. LTO logic integrated into the off-screen cart for consistent guest experience.

Previous
API Roadmap
Next
Application Initialization