API Changelog

What changed in each API version, with the entries that affect an integration first. Read the section for every version between the one you are on and the one you are moving to.

The entries below run up to v4.66 and resume at v4.79. For the releases in between, see the Release Notes, or ask your Integration Manager about the specific version you are upgrading to.

One change is worth calling out for anyone upgrading an older integration. Ordering is now built on the NMG product structure and the Cart 2.0 flow — orders are created with POST /cart/{cart_id}/order rather than POST /orders, and there is no separate order-calculation call.

November v4.79

What's new

PAR Pay (payment_processor_type_id 38)

PAR Pay handles cards, Apple Pay, Google Pay and gift cards on a single payment processor. Brands onboarded on PAR Pay report 38 from POST /cart/{cart_id}/payments/init and from POST /payment-processors/generate-tokens, and the contract differs from the earlier Aurus integration (32 and 35):

  • A new card comes with no action; the hosted card form is in additional_info.iframeUrl and posts a transaction:success message with the one_time_token and billing_zip_code to send on order creation.
  • Apple Pay and Google Pay payloads go under payment_info.additional_info.wallet_pay.applePay and wallet_pay.googlePay; there is no sessionId or requestId.
  • Gift cards use the same processor, with BIN ranges in additional_info.bin_ranges. A card that cannot cover the amount fails with GIFTCARD: Insufficient funds.
  • Storing a card needs only one_time_token; the generate-tokens response has no token.

Brands onboarded earlier keep answering with 32 and 35, so read payment_processor_type_id from every initialization. The PAR Pay guide covers both, and Make a Payment and Store a Payment Method now lead with 38.

Cart validation. POST /cart/{cart_id}/validate runs the checkout checks — cart, order amount limits and, with check_house_account_credit=1, house account credit — without changing the cart. The response is the recalculated cart plus is_valid, a checks object and an issues array. A failed check is still 200, with is_valid: false.

Resend a receipt. POST /orders/{order_uuid}/receipt/resend sends the receipt again to the address on the order and returns that address. It needs the customer's token, answers 422 for a canceled or marketplace order, and is limited to 3 per hour per order and 10 per hour per customer. Orders and receipts carry can_resend_receipt.

Order tracking stages. GET /orders/{order_uuid}/tracking returns current_stage_id, is_terminal and the brand's stages for an order. brand.is_order_tracking_enabled on Init application says whether a brand has it; a brand without a configured journey answers 404.

Lazy menu loading. On a brand with is_lazy_product_tree_enabled, lazy_load=1 on Get Category Product Details returns the first two modifier levels. has_product_groups and subtree_token mark where the tree was cut, and sending subtree_token back loads the next two levels. See Loading a large product in stages.

Rate limits and the guest payment lock. Payment initialization is capped at 10 per minute per cart, Cart Init at 60 per minute per customer or 5 per guest device, receipt resend as above, and guest checkout at 5 payment initializations and 3 orders per 10 minutes per email address. Guest payments for an email address pause for two hours after three card declines in 10 minutes. All of these answer 429; see Rate limits.

New response fields. payment_init on the cart and group cart, is_connector_order on orders and receipts, is_lazy_product_tree_enabled and is_order_tracking_enabled on the brand.

Personalized product details. Get Category Product Details now accepts the customer's token, so secret menu items and the rest of what a signed-in customer sees on the menu apply to a product detail as well.

Deprecations

Documentation

  • Courier tracking for delivery orders, GET /dispatch-service/orders/{dispatch_order_uuid}/driver-tracking, is now covered in Place an order for Delivery.
  • Retrying safely documents X-MT-Idempotency-Key, the header that makes order creation idempotent. Earlier guides named X-Request-ID, which only identifies a request in our logs.
  • Referral code check now lists the Device-UUID header it requires; it was missing from the reference, and a device_uuid in the body is ignored.
  • The Menu v2 reference showed min_quantity, max_quantity, max_single_quantity and preselected_quantity under an attributes object; the API returns them directly on the product group and product, as the menu guide shows.
  • The payment reference and the Ordering API models now cover only the processors offered to integrations: PAR Pay and Aurus, with cash and house account. PayPal, FreedomPay and other processors from earlier markets are no longer documented, nor are POST /payment-processors/auth-setup and POST /payment-processors/auth-tokenization, which only those processors used.

September v4.66

What's new

  • Allergen filtering in the customer profile. Customers can save allergens and preferred food types to their profile; menu items that conflict with them are flagged.
  • Catering deposits. An additional payment flow collects a deposit on a catering order.
  • Catering cancellation and refund policies. Brands can configure free-cancellation windows and penalty periods, with or without a deposit.
  • Free delivery. Brands can offer free delivery above a minimum order amount, optionally only to a Punchh customer segment.
  • Secret menus. Menu items visible only to selected customers on online ordering channels. See Secret Menus.
  • Pay by SMS or by link. Order-desk payments can be completed through a link sent by SMS or notification.
  • Punchh Redemptions 2.0. Multiple discounts on one order and more flexible reward structures.

August v4.65

What's new

  • Drive-thru order type. Customers order in the web or mobile app and pick up at the drive-thru window. See Place an order for Drive-thru.
  • Loyalty in checkout. Offers and rewards can be viewed and applied from the checkout page.
  • Store Finder 2.0. Switch between Pickup, Delivery and Catering while browsing; store and order type persist through the session; map and list views on mobile.
  • Order type, store and pickup time from the menu page. These can be changed without leaving the menu.
  • Off-screen cart. The cart is reachable from any page.
  • PAR POS simple combo pricing. Container-level combo pricing is supported.
  • Kiosk peripherals. Certification requirements for peripherals were removed.
  • Catering tax exemptions. Eligible catering orders can be tax exempt based on order details.
  • Catering serving-time headcounts. Portions scale with the selected headcount and serving time.

Fixes and improvements

  • LTO and pre-order windows. Products are marked unavailable once their limited-time or pre-order window has passed, for main and nested products alike, including in the off-screen cart.

July v4.64

What's new

  • AI cross-sell on Menu v2. Smart Cross-Sell can be enabled on brands using Menu v2.
  • Distribute and publish by store. Menus can be distributed and published to a single store, not only to a store group.
  • Parent categories. One category can be reused across menus, in the same way as parent product groups.
  • Parent categories and product groups on PAR Link. Both are visible on third-party marketplaces.
  • Pickup time filtering. Pickup times are filtered by menu serving times rather than general store hours.

June v4.63

What's new

  • Limited time products. A product can carry an availability window; it is hidden from every ordering channel once the window ends. See Limited Time Products.
  • Pre-ordering. A product can carry an ordering window and a separate fulfillment window for pickup or delivery. See Pre-Ordering.
  • Favorite items. Signed-in customers can save products, with their configuration, as favorites. See Get Customer Favorite Items.
  • Order throttling — order count strategy. Brands can cap the number of orders accepted per 15-minute slot. Kiosk orders are exempt from the cap but count toward it.
  • Tablet V2. Kitchen orders on NMG brands can be managed from the in-store tablet.
  • Partial refunds on NMG. Partial refunds are supported across all order types, including orders with loyalty rewards or redemptions.

Fixes and improvements

  • POS API V2. A new version of the external POS API for POS partners integrating with the V2 platform.
  • Marketplace store availability. Store availability on DoorDash, Uber Eats and other marketplaces is managed from the Link connectivity dashboard.
  • SkipTheDishes multi-store support. Multiple delivery options, including robo-delivery and ghost kitchens.
  • Web app logo URL. When a URL is configured, the logo opens it in a new tab; when none is, the logo does nothing.

May v4.62

What's new

  • Split payments. Signed-in customers can pay with several payment methods on one order. Gift cards are applied before credit or debit cards, and the split can be adjusted manually.
  • Custom fees. Configurable fees (for example a service fee) on Takeout and Delivery orders. They appear as separate lines in the priced cart.
  • Parent product groups. One modifier group can be reused across products, with the options shown per product.
  • Reordering 2.0. Reorder from the home page or order history, customize before placing, with availability checks and replacements for items that are no longer available. See POST /orders/{order_uuid}/reorder.
  • Multiple delivery radiuses. A store can have several delivery radiuses with tiered fees, combined with polygon zones.
  • PAR POS delivery fee as item. Delivery fees can be sent to the POS as an item rather than a surcharge.

Fixes and improvements

  • Kiosk NMG. Product groups open when the customer taps anywhere on the product card.

April v4.61

What's new

  • AI cross-sell. Personalized cross-sell suggestions are generally available.
  • POS importing. Menus, categories, product groups and products can be selected from a POS checklist and imported.
  • Web app logo URL. Brands can set a URL for the logo on the home page.
  • Curbside on the web app. The Curbside Pickup order type, previously mobile only, is available on the web app.
  • Curbside SMS notifications. Guests and signed-in customers can open their curbside order from an SMS link.
  • Flexible serving times. Brands can customize serving-time cutoff windows.
  • Dynamic DSP fees. Delivery service provider fees can be passed through to the customer at checkout.

Fixes and improvements

  • Kiosk. Orders outside store hours skip the pickup-time validation; the back button returns to checkout; promo codes can be redeemed at checkout with an on-screen keyboard.
  • Combo meal tax rates on Brink. Tax values are read from the combo meal, not only from the individual items.
  • Dynamic prep time for external channels. Pickup time is the send time plus prep time.
  • Rewards on failed orders. Rewards are returned to the customer when an order fails on payment or at the POS.

March v4.60

What's new

  • Menu v2. First general-availability release of the new menu structure: the POS as the source of truth, multiple menus per brand assigned to stores or store groups, nested modifier groups, and quantity modifiers. See Menu v2 Concept.
  • Web App 2.0. Feature parity between the web and native apps.
  • Order throttling. Brands can set a maximum preparation time per slot and a maximum number of orders per 15-minute interval.

Fixes and improvements

  • Brand Order Feedback report. The Venue column is populated again.

February v4.59

What's new

  • Web app checkout. A hideUnavailableItems option in branding_config.json hides unavailable menu items; Punchh promo codes can be redeemed at checkout by guests and signed-in customers; a cross-sell dialog can be shown before checkout when the brand's cross-sell placement is set to Dialog.
  • Management Center. Search by store code.

Fixes and improvements

  • Web app. Customers no longer re-enter their phone number after registering; "Master Card" is spelled "Mastercard" in the payment method list.

January v4.58

What's new

  • Web app serving times. Items are marked unavailable for a scheduled order whose promise time is at or before the start of the item's serving time.
  • Kiosk. Payment with physical gift cards; sign in or sign up with phone or email through Punchh SSO; sign in with a QR code from the Punchh mobile app.
  • Link. Grubhub exempted_taxes is supported.
  • POS. DoorDash-funded promotions on Brink account for tax remittance so the order stays within the price tolerance.
  • Payments. Clearer error messages when CVV or AVS validation fails.

Fixes and improvements

  • Toast Payments. Storing a payment method works again.