transactionVoid

mutation

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

Trigger the voiding of an uncaptured authorization transaction.

Arguments

Anchor to parentTransactionIdparentTransactionId • ID!required: An uncaptured authorization transaction.

Was this section helpful?

Anchor to TransactionVoidPayload returnsTransactionVoidPayload returns

Anchor to transactiontransaction • OrderTransaction: The created void transaction.
Anchor to userErrorsuserErrors • [TransactionVoidUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Mutation Reference

1mutation transactionVoid($parentTransactionId: ID!) {
2  transactionVoid(parentTransactionId: $parentTransactionId) {
3    transaction {
4      # OrderTransaction fields
5    }
6    userErrors {
7      field
8      message
9    }
10  }
11}

Input

1{
2  "parentTransactionId": "gid://shopify/<objectName>/10079785100"
3}

{
  "parentTransactionId": "gid://shopify/<objectName>/10079785100"
}