transactionVoid
mutation

Choose a version:

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?

Code examples for MUTATION: transactionVoid

Query Reference for MUTATION: transactionVoid

"mutation transactionVoid($parentTransactionId: ID!) {\n  transactionVoid(parentTransactionId: $parentTransactionId) {\n    transaction {\n      # OrderTransaction fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: transactionVoid

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

Schema Reference for MUTATION: transactionVoid

""

Display Examples for MUTATION: transactionVoid

[]

transactionVoidmutation

Arguments

TransactionVoidPayload returns

transactionVoid
mutation