Skip to main content
POST
/
cancelPoints
Cancel Points API
curl --request POST \
  --url https://stagingstores.xoxoday.com/chef/v1/oauth/api/cancelPoints \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "storesAdmin.mutation.cancelBalance",
  "tag": "storeAdmin",
  "variables": {
    "recipients_data": {
      "recipients": [
        {
          "unique_id": 987654321
        }
      ]
    }
  }
}
'
{
  "data": {
    "cancelBalance": {
      "error": false,
      "message": "Cancellation processed successfully",
      "recipients": [
        {
          "unique_id": 987654321,
          "success": true,
          "message": "Points cancelled successfully"
        }
      ]
    }
  }
}
PropertyTypeDescription
recipients_data.recipientsarrayList of recipients for whom points cancellation is requested.
recipients_data.recipients[].unique_idnumberUnique transaction ID of the points issuance that needs to be cancelled.

​
Response Schema

PropertyTypeDescription
data.cancelBalance.errorbooleanIndicates whether the cancellation operation failed (false = success).
data.cancelBalance.messagestringSummary message describing the overall cancellation result.
data.cancelBalance.recipientsarrayList of point transactions processed in the cancellation request.
data.cancelBalance.recipients[].unique_idnumberUnique transaction ID of the points issuance.
data.cancelBalance.recipients[].successbooleanIndicates whether the transaction cancellation was successful.
data.cancelBalance.recipients[].messagestringTransaction-level status message explaining the outcome of the cancellation.

Authorizations

​
Authorization
string
header
required

Authorization: Bearer <access_token>

Body

application/json
​
query
enum<string>
default:storesAdmin.mutation.cancelBalance
required

Always use storesAdmin.mutation.cancelBalance.

Available options:
storesAdmin.mutation.cancelBalance
​
tag
enum<string>
default:storeAdmin
required

Always use storeAdmin.

Available options:
storeAdmin
​
variables
object
required

Response

Cancellation result returned.

​
data
object