patch-api2-dashboard-offers-lis

Update Line Item Selector (LIS)

Allows a business to update one or more Line Item Selectors. You can bulk update a maximum of 20 line item selectors per API call. If the request input contains more than 20 LIS, only the first 20 are created, and the remaining are ignored.

For more information, see Offers Ingestion Management

Update Rules for Filter Item Set in LIS

1. All clauses of the defined filter item set are updated in the update request. If the filter item set is "Only Base", you must provide the entire set of clauses for the "Base" to update the LIS.

2. If the filter item set is "Base and Modifiers", you can send either the base clause or the modifier clause in the update request. The LIS is updated based on the received clause. For example: In the "Base and Modifiers" filter item set, if the user sends a request with a modifier clause, the existing modifier will be updated while the base remains in its original configuration.

3. The same validation rules applied during LIS creation are followed. If the LIS is created with "Only Modifiers", you must provide both base and modifier clauses as per the system design. However, while updating, the user can send only the modifier clause or only the base clause to update the LIS definition.

An index has been added to the business_id and external_id columns because the LIS is fetched by business_id and external_id.

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.

For more information on line item selector (LIS) settings, see the Line Item Selectors article on the 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.

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
  • data
    Type: array object[]
    required

    A list of line item selectors (LIS) that needs to be created

Responses
  • 200
    Type: object
    • results
      Type: array object[]

      List of responses indicating if the entity is created or not

  • 400
    Type: object
    • error
      Type: string
  • 401
    Type: object
    • error
      Type: string
  • 403
    Type: object
    • error
      Type: string
patch/api2/dashboard/offers/lis
{
  "results": [
    {
      "external_id": "string",
      "success": true,
      "errors": [
        "string"
      ]
    }
  ]
}