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 → Create
AI-generatedOverview
This node allows users to create refunds in the BigCommerce platform. It is useful for automating refund processes for orders, including specifying refund reasons, items to be refunded, and payment details. For example, an e-commerce business can use this node to programmatically issue refunds for returned products or order cancellations.
Use Case Examples
- Creating a refund for a specific order by providing the order ID, reason for refund, and details of items and payments to be refunded.
- Automating refund issuance based on customer service workflows or return requests.
Properties
| Name | Meaning |
|---|---|
| Order Id | The ID of the order for which the refund is being created. |
| Reason | The reason for issuing the refund. |
| Items (JSON) | A JSON array specifying the items to be refunded, including item type and optional item ID. |
| Payments (JSON) | A JSON array specifying payment details related to the refund, such as provider ID, amount, and offline status. |
| Custom Properties | Allows adding custom properties to the refund request, useful for including additional data as per BigCommerce API documentation. |
Output
JSON
refund_id- The unique identifier of the created refund.order_id- The ID of the order associated with the refund.status- The status of the refund (e.g., pending, completed).reason- The reason provided for the refund.items- Details of the items included in the refund.payments- Details of the payments associated with the refund.
Dependencies
- BigCommerce API authentication credentials
Troubleshooting
- Ensure the order ID provided exists and is valid in the BigCommerce store to avoid errors.
- Validate the JSON format for items and payments fields to prevent parsing errors.
- Check API credentials and permissions to ensure the node can create refunds.
- Common error messages may include invalid order ID, malformed JSON input, or insufficient permissions. Verify inputs and credentials accordingly.
Links
- BigCommerce API - Create Refund - Official BigCommerce API documentation for creating refunds, useful for understanding required and optional fields.