refundOrder
View as MarkdownRefund an existing order. Only non-draft orders can be marked as refunded
mutation
Requires one of commerce.order:create, commerce.order:update, commerce.order:cancel, or commerce.order:complete (use the scope that matches the operation).
Refund an existing order. Only non-draft orders can be marked as refunded
Required headers
| Header | Required | Description |
|---|---|---|
x-store-id | Yes | ID of the store the operation targets. Omitting it returns HTTP 200 with a GraphQL error: extensions.code: "UNAUTHENTICATED". |
Go to Authentication for credential setup.
Arguments
inputRefundOrderInput!requiredorderIdID!required — Global ID in formatOrder_\<KSUID\>refundedAtDateTimeoptional
Possible returns
OrderOrder
Last updated on
How is this guide?