Actions25
- Coupon Actions
- Customer Actions
- Customer Form Field Values Actions
- Customer Address Actions
- Customer Group Actions
- Line Items Actions
- Order Actions
- Order Shipping Address Actions
- Order Shipment Actions
- Product Actions
- Refunds Actions
- Subscriber Actions
- Variant Actions
Refunds → Get
AI-generatedOverview
This node integrates with the BigCommerce API to perform various operations on different resources, including refunds. Specifically, for the Refunds resource with the Get operation, it retrieves refund information from a BigCommerce store. This is useful for e-commerce businesses that need to automate the retrieval of refund data for order management, customer service, or financial reconciliation.
Use Case Examples
- Retrieve refund details for a specific order to update internal records.
- Fetch all refunds issued within a certain period for reporting purposes.
Properties
| Name | Meaning |
|---|---|
| Custom Properties | Allows adding custom properties to the API request, enabling users to specify additional parameters or filters as per the BigCommerce API documentation. |
Output
JSON
refundId- The unique identifier of the refund.orderId- The identifier of the order associated with the refund.amount- The amount refunded.status- The current status of the refund.createdAt- The date and time when the refund was created.updatedAt- The date and time when the refund was last updated.
Dependencies
- Requires an API key credential for authenticating requests to the BigCommerce API.
Troubleshooting
- Ensure the API credentials are correctly configured and have the necessary permissions to access refund data.
- Verify that the resource and operation parameters are correctly set to 'Refunds' and 'Get' respectively.
- Check network connectivity and BigCommerce API status if requests fail.
- Common error messages include authentication errors (due to invalid or expired API keys) and resource not found errors (if the refund ID does not exist). Resolving these involves updating credentials or verifying refund identifiers.
Links
- BigCommerce API - Get Refunds - Official BigCommerce API documentation for retrieving refund information.