BCL icon

BCL

Consume BCL Payment API

Coupon → Update

AI-generated

Overview

This node updates an existing coupon in the BCL Payment API system. It allows users to modify various coupon attributes such as discount amount, discount type, code, description, activation status, expiry dates, usage limits, and purchase conditions. This node is useful for managing promotional coupons dynamically, for example, updating a coupon's discount percentage or changing its active status based on marketing campaigns or business needs.

Use Case Examples

  1. Updating a coupon's discount amount and description to reflect a new promotional offer.
  2. Changing the coupon's active status to deactivate an expired coupon.
  3. Setting expiry dates and usage limits to control coupon validity and usage.

Properties

Name Meaning
Coupon ID The unique identifier of the coupon to update, required to specify which coupon to modify.
Update Fields A collection of fields to update on the coupon, including discount details, activation status, expiry settings, and purchase conditions.

Output

JSON

  • id - The unique identifier of the updated coupon.
  • code - The coupon code.
  • description - Description of the coupon.
  • discount_amount - The discount amount applied by the coupon.
  • discount_type - The type of discount (percentage or fixed).
  • is_active - Indicates if the coupon is active.
  • expiry_date - The expiry date of the coupon, if set.
  • start_date - The start date of the coupon validity.
  • usage_limit - The usage limit of the coupon.

Dependencies

  • BCL Payment API

Troubleshooting

  • Authentication errors due to invalid or expired API token. Ensure the API token credential is correct and up to date.
  • Validation errors if required update fields are missing or improperly formatted. Provide at least one valid update field.
  • Bad request errors if parameters are invalid or improperly formatted. Verify all input parameters.
  • Permission errors if the API token does not have access to update coupons.
  • Not found errors if the specified coupon ID does not exist.
  • Server errors from the BCL API indicating temporary issues; retry later or contact support.

Links

  • BCL Payment API Documentation - Official API documentation for BCL Payment API, useful for understanding coupon update endpoints and parameters.

Discussion