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_ordersorstore_v2_transactionsscope. - 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
| Name | Type | Description |
|---|---|---|
| Store Key | String | BigCommerce store hash |
| Access Token | String (sensitive) | BigCommerce API access token (X-Auth-Token) |
| Order ID | String | BigCommerce order ID |
| Refund Amount | String | Shipping fee amount to refund (e.g. 5.99) |
| Reason | String (optional) | Reason for the refund (visible in BigCommerce admin) |
| Safe Mode | Boolean (optional) | If true, errors go to outputs instead of stopping the flow |
Outputs
| Name | Type | Description |
|---|---|---|
| Success? | Boolean | Whether the refund was performed |
| Refunded Amount | Number | Numeric amount refunded |
| Currency | String | Currency code (e.g. GBP, USD) |
| Refund Details | Object | Full BigCommerce refund object |
| Error | String | Error message if the refund failed |