Overview

This node interacts with the KiotViet API to manage vouchers and promotional campaigns. Specifically, for the operation 'Lấy Chiến Dịch Theo ID' (Get Campaign by ID), it retrieves detailed information about a specific promotional campaign using its unique campaign ID. This is useful for scenarios where users need to fetch and review details of a particular campaign, such as its name, dates, discount type, and other attributes, to monitor or update campaign data.

Use Case Examples

1. A marketing manager wants to retrieve details of a specific voucher campaign by its ID to check its status and discount details.
2. An automation workflow fetches campaign information by ID to display or process campaign data in another system.

Properties

Output

JSON

• id - The unique identifier of the campaign.
• code - The code of the campaign.
• name - The name of the campaign.
• startDate - The start date of the campaign.
• endDate - The end date of the campaign.
• branchId - The branch ID where the campaign is applied.
• discountType - The type of discount (fixed amount or percentage).
• discountValue - The value of the discount.
• 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 to apply the voucher.
• maxDiscountValue - Maximum discount value allowed.
• voucherProducts - List of products associated with the voucher, including product ID, code, name, quantity, and reward status.

Dependencies

• KiotViet API with API key credential

Troubleshooting

• Ensure the campaign ID provided is valid and exists in the KiotViet system to avoid 'not found' errors.
• Check API credentials and network connectivity if the node fails to connect to the KiotViet API.
• If the node throws errors related to permissions, verify that the API key has sufficient rights to access campaign data.

Links

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