Overview

This node operation updates an existing voucher campaign in the KiotViet system. It allows users to modify various campaign details such as campaign code, name, start and end dates, branch information, discount type and value, voucher quantity, auto-generation settings, and additional optional fields like description, applicable branches, customer groups, minimum order value, maximum discount value, and associated voucher products. This operation is useful for managing and adjusting promotional campaigns dynamically based on business needs.

Use Case Examples

1. Updating the discount value and quantity of vouchers in an ongoing campaign.
2. Changing the campaign's start and end dates to extend the promotion period.
3. Adding or removing applicable branches or customer groups for the campaign.

Properties

Output

JSON

• id - The unique identifier of the updated campaign.
• code - The campaign voucher code.
• name - The campaign voucher name.
• startDate - The start date of the campaign.
• endDate - The end date of the campaign.
• branchId - The branch ID where the campaign applies.
• discountType - The type of discount applied in the campaign.
• discountValue - The discount value of the campaign.
• quantity - The number of vouchers issued in the campaign.
• isAutoGenerate - Indicates if voucher codes are auto-generated.
• isUnlimited - Indicates if the campaign has unlimited voucher quantity.
• description - Description of the campaign.
• branchIds - List of branch IDs where the campaign applies.
• customerGroupIds - List of customer group IDs applicable to the campaign.
• minOrderValue - Minimum order value required to apply the voucher.
• maxDiscountValue - Maximum discount value.
• voucherProducts - List of products applicable for the voucher with details such as product ID, code, name, quantity, and reward flag.

Dependencies

• An API key credential for KiotViet API

Troubleshooting

• Common issues include providing an invalid or non-existent campaign ID, which will cause the update to fail. Ensure the campaign ID is correct and exists in the system.
• Incorrect data types or missing required fields in the additionalFields collection can cause errors. Validate input data before execution.
• API authentication errors may occur if the API key credential is missing or invalid. Verify the credential configuration.

Links

• KiotViet API Documentation - Official API documentation for KiotViet, useful for understanding campaign and voucher management endpoints.