sso_applicable_offers

Applicable Offers (Redemptions 1.0)

​

Returns all applicable rewards available to the user per the items added to the check

Headers
  • x-pch-digest
    Type: string
    required

    The signature for the API call

  • Content-Type
    Type: string
    required

    Set this header to application/json.

  • Accept
    Type: string
    required

    Advertises which content types the client is able to understand

  • User-Agent
    Type: string
    required

    For details, see User Agent.

  • Authorization
    Type: string
    required

    You may pass the access_token instead of the authentication_token in Online Ordering endpoints to authorize the request. It must be supplied as Bearer ACCESS_TOKEN_GOES_HERE. Note: When authentication is performed using Advanced Authentication, you must include the id_token in the id-token header and the access_token in the Authorization header. See Access Punchh APIs Using Access and ID tokens

  • id-token
    Type: string

    A token that contains identity information about the authenticated user. It is used to verify the user’s identity and is required only when authentication is performed using Advanced Authentication. This token alone does not grant access to Punchh APIs. To access the APIs, you must include the id_token in the id-token header and the access_token in the Authorization header. See Access Punchh APIs Using Access and ID tokens

Body
application/json
  • authentication_token
    Type: string

    The authentication token of the user. You can retrieve this from the response of a successful sign-in API call or through the SSO process.

  • channel
    Type: stringenum
    required

    Channel through which the order was placed. If a channel is defined in the Receipt Qualifier condition under Offers > Qualification Criteria in the Punchh platform, the API returns the list of offers applicable to the transaction after evaluating the value set for the channel. Possible values: online_order, web.

    • online_order
    • web
  • client
    Type: string
    required

    Client key of the business

  • menu_items
    Type: array Menu Items (Array Object)[]

    This object used in the API request contains one or more menu items added to an order. See How To Send Menu Items to Punchh

  • receipt_amount
    Type: numberFormat: double
    required

    Order amount before taxes, calculated as the sum of all item amounts minus any discounts. This is the amount used to calculate loyalty points/visits. The value of this parameter should match subtotal_amount. For example, if the order amount is $10, both receipt_amount and subtotal_amount will be 10. If a $2 discount is applied, both will be 8.

  • receipt_datetime
    Type: stringFormat: date-time
    required

    Timestamp of the receipt as per ISO 8601, in YYYY-MM-DDThh:mm:ssZ format

  • store_number
    Type: string

    Location where the redemption must be redeemed

  • subtotal_amount
    Type: numberFormat: double
    required

    Order amount before taxes (sum of all item amounts minus any discounts). Same as receipt_amount. For historical reasons, include this parameter along with receipt_amount in the API request.

Responses
  • 200
    Type: array object[]
    • discount_amount
      Type: integer

      Discount amount applied to the order for an applicable offer or reward

    • menu_items
      Type: array Menu Items (Array Object)[]

      Returns a list of menu items in the API response

    • reward
      Type: object
  • 401

    Sending invalid credentials

  • 412

    Sending invalid Signature

  • 422

    The given reward can't be applied to the given receipt details

get/api/auth/redemptions/applicable_offers
[
  {
    "menu_items": [
      {
        "item_name": "string",
        "item_qty": "string",
        "item_amount": 1,
        "menu_item_type": "string",
        "menu_item_id": 1,
        "menu_family": "string",
        "menu_major_group": "string",
        "serial_number": "string"
      }
    ],
    "discount_amount": 1,
    "reward": {
      "created_at": "YYYY-MM-DDThh:mm:ssZ",
      "end_date_tz": "YYYY-MM-DDThh:mm:ssZ",
      "start_date_tz": "YYYY-MM-DDThh:mm:ssZ",
      "updated_at": "YYYY-MM-DDThh:mm:ssZ",
      "id": 1,
      "image": "string",
      "status": "string",
      "points": 1,
      "discount_amount": 1,
      "description": "string",
      "name": "string",
      "redeemable_properties": "string"
    }
  }
]