Anchor to transactionVoidtransaction
transactionVoid
mutation
Requires access scope. Also: The user must have permission to cancel orders.
Trigger the voiding of an uncaptured authorization transaction.
Anchor to Arguments
Arguments
- Anchor to parentTransactionIdparent•
Transaction Id ID!required An uncaptured authorization transaction.
Was this section helpful?
Anchor to TransactionVoidPayload returnsTransactionVoidPayload returns
- Anchor to transactiontransaction•
The created void transaction.
- Anchor to userErrorsuser•
Errors [TransactionVoid non-nullUser Error!]! The list of errors that occurred from executing the mutation.
Was this section helpful?
Mutation Reference
mutation transactionVoid($parentTransactionId: ID!) {
transactionVoid(parentTransactionId: $parentTransactionId) {
transaction {
# OrderTransaction fields
}
userErrors {
field
message
}
}
}
Input
{
"parentTransactionId": "gid://shopify/<objectName>/10079785100"
}
{
"parentTransactionId": "gid://shopify/<objectName>/10079785100"
}