Skip to main content

Promo Code

Promo Code Simple Resource

KeyTypeDescription
idIntegerA unique identifier for the promo code.
nameStringThe name or code of the promo code.
typeIntegerThe type of discount, either a percentage or a fixed amount off. Types 1=> Amount, 2=> Percentage, 3=> Free Delivery, 4=> Exclusive.
amountIntegerThe amount of discount provided by the promo code.
max_amountIntegerThe maximum amount that can be discounted with this promo code.
descriptionStringA description of the promo code.
expiration_dateDataTimeThe date and time at which the promo code expires.
is_voucherIntegerIndicates whether the promo code is a voucher or not.
activeIntegerIndicates whether the promo code is currently active or not.
created_atTimestampThe date and time at which the promo code was created.
updated_atTimestampThe date and time at which the promo code was last updated.
deactivation_notesStringAny notes related to the deactivation of the promo code.
first_orderIntegerIndicates whether the promo code is valid only for the first order or not.
minimum_amountIntegerThe minimum amount required for the promo code to be valid.
list_idIntegerThe ID of the custom list the promo code is a part of.
target_typeIntegerThe target type of the promo code, such as a specific product or category.
deleted_atDataTimeThe date and time at which the promo code was deleted, if applicable.
start_dateDataTimeThe date and time at which the promo code becomes valid.
uses_per_userIntegerThe maximum number of times a user can use this promo code.
usage_limitIntegerThe maximum number of times this promo code can be used.
work_with_promotionIntegerIndicates whether the promo code can be used with other promotions or not.
show_in_productIntegerIndicates whether the promo code is displayed on the product page or not.
free_deliveryIntegerIndicates whether the promo code provides free delivery or not.
loyalty_methodIntegerThe method of loyalty points calculation associated with the promo code.
loyalty_idIntegerThe ID of the loyalty program associated with the promo code.
check_all_conditionsIntegerIndicates whether all conditions need to be met for the promo code to be valid or not.
auto_add_to_new_registered_usersIntegerIndicates whether the promo code is automatically added to new registered users.
promo_creditIntegerThe credit amount associated with the promo code.
usage_limit_perIntegerThe maximum number of times this promo code can be used per user.
use_numberIntegerThe current number of times this promo code has been used.