get-api2-dashboard-offers-qc

Get Qualification Criteria (QC) List

​

Pulls a list of all qualification criteria (QC) available and defined at the business level.

To call this API, the offers ingestion option must be enabled for the business on the Punchh platform. Contact your Punchh representative to update this Punchh platform configuration.

Qualification criteria search is on a business level, and the request can:

  • Set search limits and order by descending search
  • Filter based on name and other attributes, for example, name or recency For more information, see Offers Ingestion Management
Headers
  • Accept
    Type: string

    Set this header to application/json

  • Authorization
    Type: string
    required

    Bearer token for admin authorization, who is making a call on behalf of the customer. Send the API key in the following format: "Authorization: Bearer BUSINESS_ADMIN_KEY_GOES_HERE".

  • Content-Type
    Type: string

    Set this header to application/json

Body
application/json
  • page
    Type: integer
    default: 
    1

    Number of pages to retrieve. If the requested number exceeds the available pages, the system will retrieve up to the last valid page. If the page value is not provided, the default value is used.

  • per_page
    Type: integer
    default: 
    20

    Number of records per page. If the per_page value is not provided, the default value is used. The maximum per_page value is enforced based on the OFFERS_LIST_MAX_PER_PAGE environment variable.

  • query
    Type: string

    Define the search string on the qc name column

Responses
  • 200
    Type: QC List Output (Object)
    • data
      Type: array object[]

      A list of qualification criteria (QC)

    • meta
      Type: Meta (Object)

      Shows pagination information

  • 400
    Type: object
    • error
      Type: string
  • 401
    Type: object
    • error
      Type: string
  • 403
    Type: object
    • error
      Type: string
get/api2/dashboard/offers/qc
{
  "data": [
    {
      "name": "string",
      "external_id": "string",
      "amount_cap": 1,
      "percentage_of_processed_amount": 1,
      "qc_processing_function": "string",
      "rounding_rule": "string",
      "max_discount_units": 1,
      "minimum_unit_rate": 1,
      "unit_discount": 1,
      "target_price": 1,
      "effective_location": [
        "string"
      ],
      "stack_discounting": true,
      "reuse_qualifying_items": true,
      "line_item_filters": [
        {
          "processing_method": "string",
          "quantity": 1,
          "line_item_selector": {
            "name": "string",
            "external_id": "string",
            "exclude_non_payable": true,
            "filter_item_set": "string",
            "base_items": {
              "clauses": [
                {
                  "attribute": "string",
                  "operator": "string",
                  "value": "string"
                }
              ]
            },
            "modifiers": {
              "clauses": [
                {
                  "attribute": "string",
                  "operator": "string",
                  "value": "string"
                }
              ],
              "processing_method": "string",
              "max_discount_units": 1
            }
          }
        }
      ],
      "enable_menu_item_aggregator": true,
      "aggregator_grouping_attributes": {
        "item_name": true,
        "item_id": true,
        "item_major_group": true,
        "item_family": true,
        "line_item_type": true
      },
      "item_qualifiers": [
        {
          "expression_type": "string",
          "line_item_selector": {
            "name": "string",
            "external_id": "string",
            "exclude_non_payable": true,
            "filter_item_set": "string",
            "base_items": {
              "clauses": [
                {
                  "attribute": "string",
                  "operator": "string",
                  "value": "string"
                }
              ]
            },
            "modifiers": {
              "clauses": [
                {
                  "attribute": "string",
                  "operator": "string",
                  "value": "string"
                }
              ],
              "processing_method": "string",
              "max_discount_units": 1
            }
          },
          "net_value": 1
        }
      ],
      "receipt_qualifier": [
        {
          "attribute": "string",
          "operator": "string",
          "value": "string"
        }
      ]
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 1,
    "total_records": 1
  }
}

OK