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
Coupon → Get
AI-generatedOverview
This node interacts with the BigCommerce API to perform operations related to coupons, specifically retrieving coupon information associated with a given order. It is useful for scenarios where you need to fetch coupon details applied to a specific order in a BigCommerce store, such as for order processing, reporting, or customer service purposes.
Use Case Examples
- Retrieve coupons used in a specific order to verify discounts applied.
- Fetch coupon details for an order to generate a report on promotional usage.
Properties
| Name | Meaning |
|---|---|
| Order Id | The ID of the order from which to get coupons. This is a required string input property used to specify the target order for coupon retrieval. |
Output
JSON
- ``
id- The unique identifier of the coupon.code- The coupon code used in the order.discount_type- Type of discount applied by the coupon (e.g., percentage, fixed amount).amount- The discount amount applied by the coupon.order_id- The ID of the order associated with the coupon.
Dependencies
- BigCommerce API access with appropriate credentials (API key or token)
Troubleshooting
- Ensure the provided Order Id is valid and exists in the BigCommerce store to avoid errors or empty results.
- Verify that the API credentials have sufficient permissions to access order and coupon data.
- Common error messages may include authentication failures or resource not found errors; check API credentials and order ID correctness.
Links
- BigCommerce API - Get Coupons by Order ID - Official BigCommerce API documentation for retrieving coupons associated with a specific order.