This represents an individual address.
All of the information required to enroll a new associate. Can also be used to upgrade an associate from a retail customer to a distributor.
This is the information needed to create a new order at enrollment time.
This is all the basic information for an associate.
Class for representing the AssociateCreated event's message
Associates can have up to 10 custom fields.
Class for representing the AssociateDeleted event's message
Class for representing the AssociateEdited event's message
Class for representing the AssociateStatusEdited event's message
Class for representing the AutoshipCreated event's message
Class for representing the AutoshipEdited event's message
Indicates which features are enabled.
This is the in-depth details for a bonus earned by an associate during a commission period.
This is the basic summary for the total amount an associate earned for a specific bonus during a commission period.
Extend this class to create a new custom money out merchant implementation.
Used to define information for this merchant to process payments. For example, an associate might have a specific account number or access token that must be created before payments can be made. These values are usually defined when the associate selects this merchant to receive their payments, and are then passed into the custom merchant when the payment is being processed.
IOverrideService is used to manage manual commission overrides for rules, ranks, and bonuses
Represents the status of an individual commission payment.
Represenst the result of an individual payment which has been processed.
The results of processing a payment batch.>
Represents all of an associate's stats during a commission period.
Shows how much was paid from an individual order towards someone's bonus
Represents a coupon that that can be used for a discount.
Represents the branding colors used.
Represents the CMS paths to various icons.
Represents a specific country's currency. Managed in the currency admin page.
This is a custom volume source that can be used to add additional values into the commission template that are not normally included. This could be any kind of points or values for an associate, that can be represented as a float.
Context information about the extension hosting environment
Key Performance Indicators (KPIs) are the results of a kpi or condition.
IMoneyInMerchant Is the base class for creating custom money in merchants. It provides default implementations where possible. Do not implement directly. You must implement one of the children abstract classes: SavedPaymentMoneyInMerchant, SinglePaymentMoneyInMerchant, or RedirectMoneyInMerchant. SavedPaymentMoneyInMerchant is normally used to tokenize and process credit cards. SinglePaymentMoneyInMerchant is used to process payments without saved payment data. This can be something that can be looked up by the associate, like reward points. RedirectMoneyInMerchant is used to forward the customer to the merchant's site to complete an order. This is done if the merchant can't process the payment as two separate steps (tokenize card, then charge card) and instead needs to control the full payment process. After the customer hits submit order, the order will be created in a pending state until they have completed the payment. Normally, after the payment is completed from the merchant's site, the merchant will then call a provided custom API endpoint to send the results of the attempted payment.
This is the information needed to create a new order.
This indicates a placement in a tree. Most of the time TreeIndex will be 0 and only the AssociateId will be used, unless you allow associates to be placed in the same tree multiple times (Should only applies Matrix trees).
Represents the company configured specific terminology used for these terms.
This is a specific time a coupon was used on an order, which order it was used on, and how much of a discount it gave.
Represents all of the coupons used in an order.
Class for representing the OrderCreated event's message
Class for representing the OutcomeHandoff event's message
Used to determin if a CommissionOverride is valid for a specific period.
This is the result of processing a charge or refund transaction.
The information about a rank.
Specifies a Rank and when it was obtained.
This is used to show an associate's progress towards a specific rank.
Provides the details of what an associate has to do for this rule group to be met.
Indicates the associate's progress towards this rank and each specific rule group.
This is one of the templates available for creating a custom money in merchant. With this merchant, when a customer places an order, they will be redirected to another site defined in PaymentResponse.RedirectURL where they will complete the payment.
The result of calling
This is one of the templates available for creating a custom money in merchant. Most of the time this merchant type is processing credit card payments.
This is one of the templates available for creating a custom money in merchant. Use this merchant to process payments without saved payment data.
Information used to update an existing order.
Repersents a user that can log into the system.
Class for representing the UsernameEdited event's message
Used to return an error if something is invalid.
Indicates an associate who's had volume change and who's stats will be recalculated.
Indicates if the discount should be a fixed amount or a percentage.
Indicates how the coupon is applied.
Enum value for the Extension environment type.
This is the source that the order came from
Enumeration of store types. The values in this enumeration should correspond directly with what is in the INV_StoreType table