Voucher KiotViet icon

Voucher KiotViet

Quản lý voucher và chiến dịch khuyến mãi từ KiotViet

Tạo Chiến Dịch

AI-generated

Overview

This node manages vouchers and promotional campaigns from KiotViet, specifically enabling the creation of new voucher campaigns. It is useful for businesses that want to automate and manage discount campaigns, including setting campaign codes, names, validity periods, branch applicability, discount types and values, voucher quantities, and additional campaign details. For example, a retailer can create a campaign offering a fixed discount or percentage discount vouchers valid for a specific period and applicable to certain branches or customer groups.

Use Case Examples

  1. Create a new voucher campaign with a fixed discount amount valid for a month at a specific branch.
  2. Create a percentage discount campaign with unlimited vouchers and auto-generated voucher codes.

Properties

Name Meaning
Mã Chiến Dịch The unique code identifier for the voucher campaign.
Tên Chiến Dịch The name of the voucher campaign.
Ngày Bắt Đầu The start date and time of the campaign.
Ngày Kết Thúc The end date and time of the campaign.
ID Chi Nhánh The branch ID where the campaign applies.
Loại Giảm Giá The type of discount for the campaign, either a fixed amount or a percentage.
Giá Trị Giảm Giá The value of the discount to be applied.
Số Lượng Voucher The number of vouchers to be issued in the campaign.
Tự Động Sinh Mã Whether voucher codes are auto-generated.
Không Giới Hạn Whether the campaign has an unlimited number of vouchers.
Trường Bổ Sung Additional optional fields for the campaign such as description, multiple branch IDs, customer group IDs, minimum order value, maximum discount value, and applicable voucher products.

Output

JSON

  • code - The campaign code.
  • name - The campaign name.
  • startDate - The campaign start date and time.
  • endDate - The campaign end date and time.
  • branchId - The branch ID where the campaign applies.
  • discountType - The type of discount (fixed amount or percentage).
  • discountValue - The discount value.
  • quantity - The number of vouchers issued.
  • isAutoGenerate - Indicates if voucher codes are auto-generated.
  • isUnlimited - Indicates if the campaign has unlimited vouchers.
  • description - Optional description of the campaign.
  • branchIds - Optional list of branch IDs where the campaign applies.
  • customerGroupIds - Optional list of customer group IDs applicable to the campaign.
  • minOrderValue - Optional minimum order value to apply the voucher.
  • maxDiscountValue - Optional maximum discount value.
  • voucherProducts - Optional list of products applicable for the voucher, including product ID, code, name, quantity, and reward status.

Dependencies

  • An API key credential for KiotViet API

Troubleshooting

  • Ensure all required fields (code, name, startDate, endDate, branchId, discountType, discountValue, quantity, isAutoGenerate, isUnlimited) are provided and valid.
  • Check date formats for startDate and endDate to be valid ISO date-time strings.
  • If using additional fields, ensure arrays like branchIds and customerGroupIds contain valid numeric IDs.
  • Verify API credentials and network connectivity to KiotViet API.
  • Common errors may include validation errors from the API if required fields are missing or invalid, or authentication errors if credentials are incorrect.

Links

Discussion