BigCommerce Refund Shipping Fee

Refunds a specific shipping fee amount on a BigCommerce order. The refund amount must be computed in the flow beforehand (typically from a prior Search for Order action) and passed in explicitly.

What it does

  • Creates a refund against the specified BigCommerce order for the provided shipping fee amount.
  • Returns whether the refund succeeded, the refunded amount, currency, and full refund details.

Notes

  • The refund amount should be the after-tax value the customer actually paid for shipping.
  • Requires an API token with store_v2_orders or store_v2_transactions scope.
  • Authentication: the action uses the BigCommerce module connection when that connection has both an auth header and a Store Key. Otherwise, it falls back to the Store Key and Access Token inputs. With a connection set up, you can leave these inputs unmapped.
  • If neither a complete connection nor both credential inputs are available, the action returns Success? = false with a "Missing required input" error and makes no request to BigCommerce.
  • Safe Mode: when enabled, errors are returned in outputs instead of stopping the flow.
  • Only refunds shipping; for item refunds use a different action.

Inputs

NameTypeDescription
Store KeyCredentialsBigCommerce store hash. Leave unmapped when a BigCommerce connection is set up
Access TokenCredentialsBigCommerce API access token (X-Auth-Token). Leave unmapped when a BigCommerce connection is set up
Order IDStringBigCommerce order ID
Refund AmountStringShipping fee amount to refund (e.g. 5.99)
ReasonString (optional)Reason for the refund (visible in BigCommerce admin)
Safe ModeBoolean (optional)If true, errors go to outputs instead of stopping the flow

Outputs

NameTypeDescription
Success?BooleanWhether the refund was performed
Refunded AmountNumberNumeric amount refunded
CurrencyStringCurrency code (e.g. GBP, USD)
Refund DetailsObjectFull BigCommerce refund object
ErrorStringError message if the refund failed

API reference


Did this page help you?