Description

Void a customer’s redemption.

To force security code usage set $MUST_VERIFY value to true. It is possible for $CODE to be nil when $MUST_VERIFY is set to false.

Parameters

Parameter Type Value Required
operation_name String voidRedemption true
variables JSON $JSON_OBJECT true

$JSON_OBJECT Structure

Key Type Value Required
brandId String $SHARED_BRAND_ID true
redemptionId ID $REDEMPTION_ID true
mustVerify Boolean $MUST_VERIFY true
code String $CODE false

Example

Request

curl \
-X POST \
-H "Content-Type: application/json" \
-H "Token: $TOKEN" \
-d '{
        "operation_name": "voidRedemption",
        "variables": {
            "brandId": $SHARED_BRAND_ID,
            "redemptionId": $REDEMPTION_ID,
            "mustVerify": $MUST_VERIFY,
            "code": $CODE
        }
    }' \
https://mulahpoints.com/third_party

Response

{
  "data": {
    "thirdPartyVoidRedemption": {
      "result": $SUCCESS_MESSAGE,
      "errors": [
        {message: $ERROR_MESSAGE}
      ]
    }
  },
  "errors": [
    {message: $ERROR_MESSAGE}
  ]
}