delete-api-auth-batch_redemptions

Void Redemption (Redemptions 2.0)

​

Voids the complete discount basket. The value of redemption_ref must be appended to the URL path. You can get the redemption_ref value from the Get Active Discount Basket API response.

Example:

DELETE https://{base}/api/auth/batch_redemptions/aBCDEfghIJkL-MN1opR

Note: It will not support partial voiding of a discount basket.

Path Parameters
  • redemption_ref
    Type: string
    required

    Transaction level identifier for all discount selections
    Example - aBCDEfghIJkL-MN1opR

Headers
  • Accept
    Type: string
    required

    Advertises which content types the client is able to understand

  • 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

  • Content-Type
    Type: string
    required

    Set this header to application/json.

  • User-Agent
    Type: string
    required

    For details, see User Agent.

  • x-pch-digest
    Type: string
    required

    The signature for the API call

  • 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
  • client
    Type: string
    required

    Client key of the business

Responses
  • 202

    Accepted - Success Response

  • 400
    Type: object
  • 404
    Type: object
  • 422
    Type: object
delete/api/auth/batch_redemptions/{redemption_ref}
No Body

Accepted - Success Response