BCL icon

BCL

Consume BCL Payment API

Actions20

Coupon → Get

AI-generated

Overview

This node interacts with the BCL Payment API to manage coupons. Specifically, the 'Get' operation under the 'Coupon' resource retrieves detailed information about a specific coupon by its ID. This is useful for scenarios where you need to fetch coupon details for validation, display, or further processing within an automation workflow.

Use Case Examples

  1. Retrieve coupon details by providing the coupon ID to verify discount information before applying it to an order.
  2. Fetch coupon metadata to display in a user interface or for reporting purposes.

Properties

Name Meaning
Coupon ID The unique identifier of the coupon to retrieve. This is a required numeric input used to specify which coupon's details to fetch.

Output

JSON

  • id - The unique identifier of the coupon.
  • code - The coupon code string.
  • description - Description of the coupon.
  • discount_amount - The amount of discount the coupon provides.
  • discount_type - Type of discount, e.g., percentage or fixed.
  • is_active - Indicates whether the coupon is currently active.
  • start_date - The start date and time when the coupon becomes valid.
  • expiry_date - The expiry date and time when the coupon becomes invalid.
  • usage_limit - The maximum number of times the coupon can be used.
  • max_purchase - Maximum purchase amount applicable for the coupon.
  • min_purchase - Minimum purchase amount required to use the coupon.

Dependencies

  • BCL Payment API with an API token credential

Troubleshooting

  • Authentication errors due to invalid or expired API token. Ensure the API token credential is correct and active.
  • Validation errors if required parameters are missing or invalid. Make sure the Coupon ID is provided and valid.
  • Not found errors if the specified coupon ID does not exist in the BCL system.
  • Server errors from the BCL API indicating temporary issues; retry after some time or check API status.

Links

Discussion