Anchor to section titled 'undefined'

transactionVoid
mutation

Requires write_orders access scope. Also: The user must have permission to cancel orders.

Trigger the voiding of an uncaptured authorization transaction.

Anchor to section titled 'Arguments'

Arguments

Anchor to parentTransactionId
parentTransactionId
ID!
required

An uncaptured authorization transaction.

Was this section helpful?
Anchor to section titled 'TransactionVoidPayload returns'

TransactionVoidPayload returns

Anchor to TransactionVoidPayload.transaction
transaction
OrderTransaction

The created void transaction.

Anchor to TransactionVoidPayload.userErrors
userErrors
[TransactionVoidUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?
Hide code
Mutation reference
Copy
mutation transactionVoid($parentTransactionId: ID!) {
  transactionVoid(parentTransactionId: $parentTransactionId) {
    transaction {
      # OrderTransaction fields
    }
    userErrors {
      field
      message
    }
  }
}
Hide code
Input
Copy
{
  "parentTransactionId": "gid://shopify/<objectName>/10079785100"
}