All Classes and Interfaces
Class
Description
Base model containing common fields for validation redeemable responses.
Represents an address entity used in pricing, order, or other related models.
Represents the response structure for product-related data from the Andor Commerce system.
Represents the product details in the response, including a list of individual products.
Represents an individual product in the response, including its SKU, name, and variants.
Represents the inner data structure within the product response.
Represents the product details of a specific variant.
Represents a variant of a product in the response.
This class contains details of Error as returned from Voucherify.
Represents detailed error information.
Represents an error response from the API.
Represents items or products to which a discount is applicable.
Result list containing items to which a discount is applicable.
Enum representing the object types to which a promotion or discount can be applied.
Represents a model that can be applied to a list of items.
Enum defining how a promotion is applied across eligible items.
Represents an item on which a promotion has been applied.
This model contains information about the promotion, its application status,
the items to which it was applied, those it was not applied to, and any errors
encountered during the application process.
Represents an item in an order within the pricing model.
Represents a summary of a value, including its associated currency.
Represents the total details of a transaction, including quantities and monetary summaries.
The class contains BHN configuration.
BHNPromotionEngine implementation
BHNPromotionOperation implementation.
Implementation of the
PromotionProductService interface that provides functionality to
manage products and product SKUs within the BHN promotion service.Implementation of the
PromotionWebhookService interface for handling webhooks in the BHN
promotion system.Configuration for budget overdraft settings.
Enum representing who updated the budget.
Represents the assignment of a validation rule to a specific object in the campaign.
Represents a calculated item in an order.
Represents a product in a calculated order item.
Represents a promotional campaign within the system.
Mapper interface for converting between Voucherify's
Category
and the core model CategoryModel.Represents a category within the campaign management system.
Enum representing channel types.
Represents the request body for Voucherify qualification eligibility checks,
including customer, order, scenario, and filtering/sorting options.
Represents the response body for Voucherify eligibility qualification checks,
including redeemables, discount results, applicable/inapplicable items,
and detailed order-level calculation data.
Common promotion metadata model used for Voucherify integration.
Utility class for safely converting generic
Object instances into common numeric types
such as Double and BigDecimal.Represents the address details of a customer.
Represents customer details used in Voucherify requests and responses.
Represents the delivery options for a pricing model.
Represents a discount applied to a pricing model.
Enum representing the effect of a discount application.
Mapper interface for converting
Discount objects from the Voucherify client
to DiscountModel used in the promotions core model.Represents a discount configuration for a campaign.
Represents the discount details applied to a promotion.
Enum representing the type of discount.
Mapper interface for converting between Voucherify's
DiscountUnitMultipleOneUnit
and the core model DiscountUnitMultipleOneUnitModel.Represents a model for a discount unit that can apply to a specific
product or SKU with multiple units.
Represents a request for checking eligibility in a promotion context.
Represents the response model for checking eligibility in promotions.
Enum representing eligibility check scenarios.
Enum representing sorting rules for eligibility results.
The class contains methods for Encryption and Decryption.
This class contains the error keys as returned to services invoking promotion service
Stores the error details as part of Promotion sdk response
Represents a request for validating promotions or vouchers.
Represents the response model for evaluating promotions or vouchers.
Enum representing expand options for validation requests.
Represents a model for export configuration.
Represents the face value of a pricing model.
Represents a fee associated with a pricing model.
Represents a foreign exchange (forex) currency pair.
Represents a GraphQL request containing a query and associated variables.
Contains constants for GraphQL requests to search orders with pagination, sorting, and filtering.
Represents a response from a GraphQL query containing order data.
Represents the Data Transfer Object (DTO) for IAM (Identity and Access Management) token
details.
Represents items or products to which a discount is not applicable.
Result list containing items to which a discount is not applicable.
InputAdapter interface.
Represents an item in a promotional context.
Represents a collection of foreign exchange (Forex) pairs.
Serializer for LocalDateTime fields to format them as ISO 8601 UTC strings
with milliseconds precision and a trailing 'Z' (e.g. 2025-06-16T05:38:32.000Z).
Locale-specific configuration metadata for promotions.
Service for making GraphQL requests to fetch new user data.
Supported object types used in promotion flows.
Represents an offer that can be applied in pricing contexts.
Represents an order in the system.
(DTO) for representing an order and its associated details.
(DTO) for representing individual order items in an order.
Represents an item in an order, extending the base order item model.
Represents an item in an order.
Represents a product in an order item.
Represents a SKU in an order item.
Represents an entry for order redemptions.
Utility class containing constants for different order statuses.
Enum representing the status of an order.
Service class responsible for preparing and processing
OrderDTO.OutputAdapter interface.
Enum representing the type of overdraft.
Represents a person with personal and contact details.
Proxy class for interacting with the Person Management API.
Service class for getting Person details from the Person Management system.
Represents a promotion in the Pimcore system.
Mapper interface for converting various Voucherify response bodies into
PimcorePromotionModel instances.Proxy class for interacting with the Pimcore API.
Service class for managing promotions in the Pimcore system.
Represents a product used in a promotion service.
Represents the SKU (Stock Keeping Unit) of a product used in promotion service.
PricingServiceInputAdapter implementation.
PricingServiceOutputAdapter implementation.
Represents a product associated with a discount.
Mapper interface for converting between Voucherify product models and PMS product models.
Mapper interface for converting between Voucherify SKU models and PMS product SKU models.
The
Promo class encapsulates all relevant details of a promotion, such as the promo code,
its value, the type of discount applied, and the effect the promo has on the order.PromoMapper is a MapStruct mapper interface used for mapping and transforming Promo objects.
Represents a summary of promotions applied to an order.
This class represents a model for managing and tracking the budget of a promotional campaign.
The class contains configuration for the Promotion module.
Represents a discount applied to a promotion.
PromotionEngine interface.
PromotionException implementation
The
PromotionExportService interface defines operations for scheduling and downloading
reports.Promotion funding metadata defining the financial structure of promotions.
Core promotion metadata containing essential promotion configuration.
The Enum to store Promotion MetaData Keys
PromotionOperation interface.
Represents a model for a product associated with a promotion.
The
PromotionProductService interface defines the operation for managing products and
product SKUs (Stock Keeping Units) within the promotion service.This class encapsulates all the details necessary to generate a pricing quote based on an order.
Proxy class for interacting with the Promotion Service API.
Mapper interface for converting a
PromotionTierAction to a
PromotionTierActionModel.Represents an action model for a promotion tier.
Mapper interface for converting between PromotionTier and PromotionTierModel
as well as their related request and response bodies.
PromotionUtil utility methods
The
PromotionWebhookService interface provides a contract for processing webhooks received from
external sources.PromotionWorkflow implementation.
QualificationEngine implementation
This class holds the receiver's personal information including their first, middle, and last name,
as well as their business name
Enum representing redeemable object types.
Represents the request body for redeeming promotions or vouchers,
including redeemables, order, customer, session, and optional expansion settings.
Represents the response returned after redeeming promotions or vouchers,
including redemption results, order details, applied discounts,
skipped or inapplicable redeemables, and related redemption metadata.
RedemptionEngine implementation
The
RedemptionModel is used to encapsulate the details of a single redemption operation
for a given promotion.This class encapsulates the request data needed to process a redemption.
This model is used to encapsulate the response data returned after a redemption operation, such
as redeeming a voucher or applying a promotion.
Request body used to create a rollback for a redemption,
including reason, customer, order, and optional metadata.
Response returned after rolling back a redemption.
DTO representing the details of a rollback operation, including redemption IDs, business flow, and status.
Wrapper class for RollbackDTO messages.
RollbackEngine implementation
Represents an exception that indicates a rollback scenario in the application.
Represents the model for a rollback operation during a redemption process.
Enum representing rollback order mode.
Represents the summary of a rollback redemption process.
RollbackRequest implementation.
RollbackRequestV3 implementation.
Mapper interface for converting RollbackRequest to RollbackRequestV3.
The
RollbackResponseModel class encapsulates the result of a rollback operation, which
may involve undoing the effects of a promotion, voucher redemption, or discount application.Service responsible for handling retryable rollback operations.
Service responsible for handling rollback operations and sending rollback failure messages to SQS.
This class encapsulates the details of the entity or individual who is placing an order.
Service class handles the logic for applying, updating, and managing shipping fee-related
promotions.
DTO representing a minimal product discount unit.
Represents a simple product discount unit model for promotional campaigns.
Enum representing redemption status.
Enum representing the target level at which a discount is applied.
DTO for representing tenant information.
A utility class containing constants for validation purposes.
ValidationEngine implementation
ValidationException implementation
Request body used to validate redeemables against order, customer,
and session data before applying promotions.
Response body returned after validating redeemables against an order.
Model representing validation error or result details returned by Voucherify.
Model representing an inapplicable redeemable returned during validation.
Model holding error and detail information for an inapplicable validation redeemable.
Model representing a skipped redeemable returned during validation.
Model containing detail information for a skipped validation redeemable.
Enum representing validation status.
This class provides Validation utility methods to validate the request params
Mapper interface for converting between Voucherify's
ValidityHoursDailyItem and the
application-specific ValidityHoursDailyInnerModel.Mapper interface for converting between Voucherify ValidityHours model
and the internal ValidityHoursModel.
Mapper interface for converting between Voucherify ValidityTimeframe model
and the internal ValidityTimeframeModel.
Client for interacting with Voucherify API to redeem stacked discounts.
This class contains implementation of VoucherifyApiException
Mapper interface for converting between Voucherify campaign-related
request/response models and internal CampaignModel.
This class contains all methods related to Voucherify Campaign Service
This class contains all the api calls made to Voucherify service
This class contains methods to prepare logging info for SDK's
external public api's invocation
The class contains Voucherify configuration.
Service class for managing metadata schemas in a Voucherify project.
This class contains Voucherify Util methods
VoucherifyPromotionEngine implementation
This class implements the
PromotionExportService interface and provides methods related
to exporting reports using the Voucherify service.VoucherifyPromotionOperation implementation.
Implementation of the
PromotionProductService interface that integrates with Voucherify
to manage products and SKUs (Stock Keeping Units).This class contains all methods related to Voucherify Promotion Tier Service
A proxy class for interacting with the Voucherify API.
Custom exception for handling Voucherify redemption errors.
Utility class providing methods for handling voucher and promotion data related to the
Voucherify.
This class contains all methods related to Voucherify Validation Service
This class contains all methods related to Voucherify Voucher Service
Service to perform warmup operations for Voucherify API and JSON serialization/deserialization.
Represents a request received from a webhook.
Represents the model for a webhook payload related to a campaign, promotion tier, voucher,
rule, and assignment in the promotion system
This class contains the common fields that are shared across these entities:
Represents a response after executing Voucherify Webhook flow.