Punchh · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mobile Single Scan Code API

2 actions 2 updates phrasing extends openapi/punchh-single-scan-code-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Punchh's API. It is a proposal applied on top of the contract, not a document Punchh publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/api2/mobile/single_scan_tokens'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Mobile Single Scan Code API
  version: 1.0.0
extends: openapi/punchh-single-scan-code-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/api2/mobile/single_scan_tokens'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate a single scan code for checkout
      effect: write
      questions:
      - Can a guest pay, redeem a reward and tip with one scan at the register?
      - Is there a short code option instead of a full single scan code?
      instructions:
      - text: Generate a single scan code to pay with {payment_type}.
        slots:
          payment_type: requestBody.payment_type
      - text: Create a scan code that redeems reward {reward_id} and adds a {tip} tip.
        slots:
          reward_id: requestBody.reward_id
          tip: requestBody.tip
      - text: Make a short code for paying with gift card {gift_card_uuid}.
        slots:
          gift_card_uuid: requestBody.gift_card_uuid
      method: generated
      generated: '2026-10-01'