com.bpsinfo.ultracart.affiliate.ui.partner.AffiliatePartnerIndexForm
In addition to other standard variables like $cart
, StoreFront system screens (display and post form data, such as checkout screens) have a $form
variable that contains fields and data specific to that screen. Â
Listed below are the form fields specific to this screen template.
Name | Type | Formal Syntax | Form Data? | Required on Post? | Comments/Sample Usage |
---|
affiliate
| Affiliate
| $form.affiliate
| Â | Â | Â |
affiliateGroup
| AffiliateGroup
| $form.affiliateGroup
| Â | Â | Â |
clickCount
| integer
| $form.clickCount
| Â | Â | Â |
clickCountFormatted
| string
| $form.clickCountFormatted
| Â | Â | Â |
conversionRate
| string
| $form.conversionRate
| Â | Â | Â |
downLineAffiliates
| Affiliate[]
| $form.downLineAffiliates
| Â | Â | Â |
earningsBalance
| BigDecimal
| $form.earningsBalance
| Â | Â | Â |
earningsBalanceFormatted
| string
| $form.earningsBalanceFormatted
| Â | Â | Â |
earningsPaid
| BigDecimal
| $form.earningsPaid
| Â | Â | Â |
earningsPaidFormatted
| string
| $form.earningsPaidFormatted
| Â | Â | Â |
earningsPerClick
| string
| $form.earningsPerClick
| Â | Â | Â |
errors
| Error[]
| $form.errors
| Â | Â | Â |
globalCommissionEarnings
| BigDecimal
| $form.globalCommissionEarnings
| Â | Â | Â |
globalCommissionEarningsFormatted
| string
| $form.globalCommissionEarningsFormatted
| Â | Â | Â |
globalCommissionRepeatEarnings
| BigDecimal
| $form.globalCommissionRepeatEarnings
| Â | Â | Â |
globalCommissionRepeatEarningsFormatted
| string
| $form.globalCommissionRepeatEarningsFormatted
| Â | Â | Â |
infoMessages
| string[]
| $form.infoMessages
| Â | Â | Â |
itemCommissions
| AffiliateItemCommission[]
| $form.itemCommissions
| Â | Â | Â |
itemsReturned
| integer
| $form.itemsReturned
| Â | Â | Â |
itemsReturnedFormatted
| string
| $form.itemsReturnedFormatted
| Â | Â | Â |
itemsSold
| integer
| $form.itemsSold
| Â | Â | Â |
itemsSoldFormatted
| string
| $form.itemsSoldFormatted
| Â | Â | Â |
lastPayment
| string
| $form.lastPayment
| Â | Â | Â |
merchantId
| string
| $form.merchantId
| Â | Â | Â |
numberOfTransactions
| integer
| $form.numberOfTransactions
| Â | Â | Â |
program
| AffiliateProgram[]
| $form.program
| Â | Â | Â |
secureHostName
| string
| $form.secureHostName
| Â | Â | Â |
simpleLinks
| AffiliateSimpleLink[]
| $form.simpleLinks
| Â | Â | Â |
totalRevenue
| BigDecimal
| $form.totalRevenue
| Â | Â | Â |
totalRevenueFormatted
| string
| $form.totalRevenueFormatted
| Â | Â | Â |
uniqueVisitors
| integer
| $form.uniqueVisitors
| Â | Â | Â |
uniqueVisitorsFormatted
| string
| $form.uniqueVisitorsFormatted
| Â | Â | Â |
Flow