Olo Promo Specs 2.0: Supported APIs

Overview

Olo's Promo Specs 2.0 (PS 2.0) define the API specifications for the ordering experience. These API specs will work as a standard across all loyalty vendors for Olo. Loyalty vendors need to send the data in Olo-expected API specification for integration with the online ordering channel.

Punchh Redemptions 2.0 APIs (R2.0 APIs) have been integrated with Olo PS 2.0 to support the adoption of R2.0 across online ordering channels. Thus, Punchh built a middleware to integrate R2.0 APIs with Olo PS 2.0. This middleware layer will act as a bridge between Punchh's redemptions engine and Olo's updated promo framework, enabling smoother, more scalable implementations of the latest redemptions logic. This middleware not only ensures future readiness for R2.0 standards, but also simplifies partner integrations, accelerates deployment timelines, and enhances offer accuracy in the digital ordering experience.

Supported Olo APIs

Below are the supported Olo APIs. Refer to the Olo Developer Portal links for endpoint information (Olo login is required).

  • Create Account: Used to create a loyalty account in Punchh using user-level information.
  • Find Account: Used to find a loyalty account in Punchh using a customer's user_id.
  • Get Account: Used to retrieve available rewards from a guest's loyalty account.
  • Validate Promotions: Used to validate the Olo basket or order with Punchh to determine a discount amount. Equivalent to Possible Redemption Punchh API.
  • Redeem Promotions: Used to redeem all applied offers in an order with Punchh. Equivalent to Honor Redemption Punchh API.
  • Void Redemption: Used to reverse a previously successful redemption. This endpoint will be invoked when an order fails, is cancelled, or refunded.
  • Accrue Points: Used to accrue points for the user's order with Punchh. This endpoint will be invoked when the order is closed. Equivalent to Create Check-in Punchh API.
  • Void Accrual: Used to reverse a previously successful accrual. This endpoint will be invoked when an order is refunded after the order has been closed. Equivalent to Void Check-in Punchh API.

For additional information, please refer to the Olo Developer Portal and the Olo Promo Specs 2.0 Implementation Guide on the Punchh Support Portal.

Note: To view the Punchh product documentation on the Punchh Support Portal, you must log in to a Punchh platform production environment. If you already have access to a production environment, follow the instructions here to access the Punchh Support Portal. If you do not have access to a Punchh production environment, your PAR Punchh representative can provide you with temporary access to a Punchh test environment. For more information, see Getting Started With PAR Integrations.