Difference between revisions of "NATS4 Mailer Template Variables"
From TMM Wiki
Jump to navigationJump to searchTMMStephenY (talk | contribs) |
TMMStephenY (talk | contribs) |
||
| Line 375: | Line 375: | ||
The mail_affiliate_on_signup mailing [[Ct#Template|template]] in [[NATS]] accepts different variables than the other available mailing [[Ct#Template|templates]]. In this [[Ct#Template|template]], all of the stored [[Ct#Affiliate|affiliate]] information can be found in the $affiliate array. | The mail_affiliate_on_signup mailing [[Ct#Template|template]] in [[NATS]] accepts different variables than the other available mailing [[Ct#Template|templates]]. In this [[Ct#Template|template]], all of the stored [[Ct#Affiliate|affiliate]] information can be found in the $affiliate array. | ||
| − | * {$affiliate | + | * {$affiliate.nats} |
| − | * {$affiliate | + | * {$affiliate.company} |
| − | * {$affiliate | + | * {$affiliate.url} |
| − | * {$affiliate | + | * {$affiliate.firstname} |
| − | * {$affiliate | + | * {$affiliate.lastname} |
| − | * {$affiliate | + | * {$affiliate.email} |
| − | * {$affiliate | + | * {$affiliate.nostore_verify_email} |
| − | * {$affiliate | + | * {$affiliate.mailok} |
| − | * {$affiliate | + | * {$affiliate.icq} |
| − | * {$affiliate | + | * {$affiliate.aim} |
| − | * {$affiliate | + | * {$affiliate.msn} |
| − | * {$affiliate | + | * {$affiliate.username} |
| − | * {$affiliate | + | * {$affiliate.password} |
| − | * {$affiliate | + | * {$affiliate.nostore_verify_password} |
| − | * {$affiliate | + | * {$affiliate.address1} |
| − | * {$affiliate | + | * {$affiliate.address2} |
| − | * {$affiliate | + | * {$affiliate.city} |
| − | * {$affiliate | + | * {$affiliate.state} |
| − | * {$affiliate | + | * {$affiliate.zip_code} |
| − | * {$affiliate | + | * {$affiliate.country} |
| − | * {$affiliate | + | * {$affiliate.tax_id_or_ssn} |
| − | * {$affiliate | + | * {$affiliate.payvia} |
| − | * {$affiliate | + | * {$affiliate.minimum_payout} |
| − | * {$affiliate | + | * {$affiliate.verify} |
== Profits == | == Profits == | ||
Revision as of 10:27, 21 February 2011
You can use the following variables, grouped by their arrays, on templates in the Skins & Templates Admin and Site Templates that get mailed to affiliates. For example, mail_affiliate_on_member_joined or mail_member_change.
member
The following variables hold members' information.
- {$cost} - shows the affiliate payout.
- {$memberid} - the id of the member
- {$firstname} - first name of the member
- {$lastname} - last name of the member
- {$address1} - first line of address
- {$address2} - second line of address
- {$zip} - the zip code
- {$city} - city of address
- {$country} - country
- {$state} - state
- {$shipping_firstname} - shipping first name
- {$shipping_lastname} - shipping last name
- {$shipping_address1} - shipping address 1
- {$shipping_address2} - shipping address 2
- {$shipping_zip} - shipping zip code
- {$shipping_city} - shipping city
- {$shipping_country} - shipping country
- {$shipping_state} - shipping state
- {$phone} - member's phone number
- {$xsell_success} - if the xsell is successful
- {$xsell_message} - the xsell message sent
- {$custom1} - the custom field in the members admin
- {$custom2}
- {$custom3}
- {$custom4}
- {$custom5}
- {$last_modified} - last time the member
- {$identid} - a unique number that contains information about the campaignid, tourid, siteid, optionid etc.
- {$loginid} - The member's username
- {$refurl_lookup_id} An id that identifies the URL that referred the member.
- Note: This only retrieves the ID number and not the referring URL. To get the URL, use the template function nats_get_refurl.
- For example:
{nats_get_refurl refid=$member.refurl_lookup_id}to set the function, then use the Smarty function:{$nats_refurl}to display it.
- {$status} - the status of the member
- {$trial} - whether they are on trial or not
- {$joined} - when they joined
- {$expired} - when they will be expired
- {$last_login} - last time they logged in
- {$stamp}
- {$siteid} - which site they signed up with
- {$username} - the member's username
- {$cryptpass} - the crypted password
- {$ip} - the ip they used to sign up
- {$email} - the email they signed up with
- {$session}
- {$mailok}
- {$flat_price}
- {$first_login} - when they first logged in.
- {$third_party_partner_id} - the id of the third party
- {$cascadeid} - The id for the cascade that the member used to sign up.
- {$cascade_item_id} - The id for the biller in the cascade that the member used to sign up.
- {$token} - The hash that each member of a token site uses to authenticate.
- {$original_username} The member's original username.
- {$renamed} - The date when the member's username was changed.
details.loginid
The details.login array holds the NATS information about the affiliate.
- {$details.loginid.loginid}
- {$details.loginid.username}
- {$details.loginid.password}
- {$details.loginid.deleted}
- {$details.loginid.type}
- {$details.loginid.skinid}
- {$details.loginid.payvia_type_id}
- {$details.loginid.status}
- {$details.loginid.pass_hash}
- {$details.loginid.join_date}
- {$details.loginid.inhouse}
- {$details.loginid.loginid}
- {$details.loginid.firstname}
- {$details.loginid.lastname}
- {$details.loginid.email}
- {$details.loginid.date_posted}
- {$details.loginid.last_login}
- {$details.loginid.last_login_ip}
- {$details.loginid.reviewed}
- {$details.loginid.minimum_payout}
- {$details.loginid.bonus}
- {$details.loginid.verify}
- {$details.loginid.reason}
- {$details.loginid.unencoded}
- {$details.loginid.startpage}
- {$details.loginid.rep_baseline}
- {$details.loginid.company}
- {$details.loginid.url}
- {$details.loginid.tel}
- {$details.loginid.icq}
- {$details.loginid.aim}
- {$details.loginid.msn}
- {$details.loginid.address1}
- {$details.loginid.address2}
- {$details.loginid.city}
- {$details.loginid.state}
- {$details.loginid.country}
- {$details.loginid.zip_code}
- {$details.loginid.tax_id_or_ssn}
- {$details.loginid.invoicer}
- {$details.loginid.req_docs}
- {$details.loginid.w9}
- {$details.loginid.mailok}
- {$details.loginid.trust_level}
- {$details.loginid.new_notification}
- {$details.loginid.flag1}
- {$details.loginid.flag2}
- {$details.loginid.flag3}
- {$details.loginid.flag4}
- {$details.loginid.flag5}
- {$details.loginid.select1}
- {$details.loginid.select2}
- {$details.loginid.select3}
- {$details.loginid.select4}
- {$details.loginid.select5}
- {$details.loginid.default_campaign}
- {$details.loginid.default_program}
- {$details.loginid.default_site}
- {$details.loginid.pv_instant}
- {$details.loginid.payout_approval}
- {$details.loginid.notify_password}
- {$details.loginid.notify_payvia}
- {$details.loginid.notify_payvia_info}
- {$details.loginid.notify_defaults}
- {$details.loginid.notify_details}
- {$details.loginid.notify_settings}
- {$details.loginid.notify_member_change}
- {$details.loginid.notify_member_voided}
- {$details.loginid.notify_member_chargeback}
- {$details.loginid.notify_member_credited}
- {$details.loginid.notify_member_insufficient}
- {$details.loginid.notify_member_cancelled}
- {$details.loginid.notify_member_rebilled}
- {$details.loginid.notify_member_joined}
- {$details.loginid.verify_details}
- {$details.loginid.verify_settings}
- {$details.loginid.verify_defaults}
- {$details.loginid.verify_payvia}
- {$details.loginid.verify_payvia_info}
- {$details.loginid.email_promotional}
- {$details.loginid.email_on_notify}
- {$details.loginid.email_on_member_change}
- {$details.loginid.email_on_member_voided}
- {$details.loginid.email_on_member_chargeback}
- {$details.loginid.email_on_member_credited}
- {$details.loginid.email_on_member_insufficient}
- {$details.loginid.email_on_member_cancelled}
- {$details.loginid.email_on_member_rebilled}
- {$details.loginid.email_on_member_joined}
- {$details.loginid.access_preset}
- {$details.loginid.post_member_approval}
- {$details.loginid.post_member_rebill}
- {$details.loginid.post_member_upgrade}
- {$details.loginid.post_member_expire}
- {$details.loginid.post_member_insufficient_fund}
- {$details.loginid.post_member_credit}
- {$details.loginid.post_member_chargeback}
- {$details.loginid.post_member_void}
- {$details.loginid.post_member_upgradedeny}
- {$details.loginid.post_member_change_details}
- {$details.loginid.live_update_defaults}
- {$details.loginid.default_stats_view}
- {$details.loginid.default_stats_date_range}
- {$details.loginid.default_stats_limit_site}
- {$details.loginid.default_stats_limit_program}
- {$details.loginid.default_stats_limit_campaign}
- {$details.loginid.default_stats_small_map_1_data}
- {$details.loginid.default_stats_small_map_2_data}
- {$details.loginid.default_stats_pie_chart_1_data}
- {$details.loginid.default_stats_pie_chart_2_data}
- {$details.loginid.default_stats_pie_chart_3_data}
- {$details.loginid.default_stats_pie_chart_4_data}
- {$details.loginid.default_stats_pie_chart_5_data}
- {$details.loginid.default_stats_pie_chart_1_break}
- {$details.loginid.default_stats_pie_chart_2_break}
- {$details.loginid.default_stats_pie_chart_3_break}
- {$details.loginid.default_stats_pie_chart_4_break}
- {$details.loginid.default_stats_pie_chart_5_break}
- {$details.loginid.default_stats_mixed_chart_1_type}
- {$details.loginid.default_stats_mixed_chart_2_type}
- {$details.loginid.default_stats_mixed_chart_1_data}
- {$details.loginid.default_stats_mixed_chart_2_data}
- {$details.loginid.default_stats_multi_graph_data_1}
- {$details.loginid.default_stats_multi_graph_data_2}
- {$details.loginid.default_stats_multi_graph_data_3}
- {$details.loginid.default_stats_large_map_data}
- {$details.loginid.default_stats_comp_data}
- {$details.loginid.default_stats_order}
- {$details.loginid.default_stats_table_column1}
- {$details.loginid.default_stats_table_column2}
- {$details.loginid.default_stats_table_column3}
- {$details.loginid.default_stats_table_column4}
- {$details.loginid.default_stats_table_column5}
- {$details.loginid.default_stats_table_column6}
- {$details.loginid.default_stats_table_column7}
- {$details.loginid.default_stats_table_column8}
- {$details.loginid.default_stats_table_column9}
- {$details.loginid.default_adtools_view}
- {$details.loginid.default_adtools_cat_1_type}
- {$details.loginid.default_adtools_cat_2_type}
- {$details.loginid.default_adtools_cat_3_type}
- {$details.loginid.default_adtools_cat_4_type}
- {$details.loginid.default_adtools_cat_5_type}
- {$details.loginid.default_adtools_publish_setting}
- {$details.loginid.default_adtools_publish_date}
- {$details.loginid.default_adtools_dump_separater}
- {$details.loginid.default_adtools_dump_record_end}
- {$details.loginid.default_adtools_dump_field_1}
- {$details.loginid.default_adtools_dump_field_2}
- {$details.loginid.default_adtools_dump_field_3}
- {$details.loginid.default_adtools_dump_field_4}
- {$details.loginid.default_adtools_dump_field_5}
- {$details.loginid.default_adtools_dump_field_6}
- {$details.loginid.default_adtools_dump_field_7}
- {$details.loginid.default_adtools_dump_field_8}
- {$details.loginid.default_news_announcement_section}
- {$details.loginid.default_news_section}
- {$details.loginid.default_news_count}
- {$details.loginid.default_account_view}
- {$details.loginid.default_account_changes_count}
- {$details.loginid.default_account_changes_order}
- {$details.loginid.default_account_campaign_count}
- {$details.loginid.default_account_campaign_order}
details.campaignid
The details.campaignid array holds information about the campaign the member signed up under.
- {$details.campaignid.campaignid}
- {$details.campaignid.loginid}
- {$details.campaignid.name}
- {$details.campaignid.description}
- {$details.campaignid.created_date}
- {$details.campaignid.hide}
- {$details.campaignid.old_campaignid}
details.programid
The details.campaignid array holds information about the program the member signed up under.
- {$details.programid.programid}
- {$details.programid.program}
- {$details.programid.hidden}
- {$details.programid.type}
- {$details.programid.name}
- {$details.programid.extended_payout}
- {$details.programid.max_ratio}
- {$details.programid.fallbackid}
- {$details.programid.addstr}
- {$details.programid.deleted}
- {$details.programid.abi_paycom_prefix}
- {$details.programid.abi_paycom_perc}
- {$details.programid.deduct_credits}
- {$details.programid.deduct_chargebacks}
- {$details.programid.deduct_voids}
- {$details.programid.deduct_insufficient}
- {$details.programid.verify_hash}
- {$details.programid.verify_initial}
- {$details.programid.retro_payout}
details.siteid
The details.campaignid array holds information about the site the member signed up under.
- {$details.siteid.siteid}
- {$details.siteid.networkid}
- {$details.siteid.site}
- {$details.siteid.deleted}
- {$details.siteid.name}
- {$details.siteid.type}
- {$details.siteid.hidden}
- {$details.siteid.date_added}
- {$details.siteid.date_live}
- {$details.siteid.network}
details.tourid
The details.campaignid array holds information about the tour the member signed up under.
- {$details.tourid.tourid}
- {$details.tourid.tour}
- {$details.tourid.siteid}
- {$details.tourid.networkid}
- {$details.tourid.name}
- {$details.tourid.url}
- {$details.tourid.linkdomain}
- {$details.tourid.description}
- {$details.tourid.thumb}
- {$details.tourid.thumb_ext}
- {$details.tourid.third_party_partner_id}
- {$details.tourid.spartaurl}
- {$details.tourid.denyurl}
- {$details.tourid.denypost}
- {$details.tourid.approvalurl}
- {$details.tourid.approvalpost}
- {$details.tourid.rebillpost}
- {$details.tourid.creditpost}
- {$details.tourid.chargebackpost}
- {$details.tourid.insufficient_fundpost}
- {$details.tourid.voidpost}
- {$details.tourid.userpost}
- {$details.tourid.userman}
- {$details.tourid.expirepost}
- {$details.tourid.custom}
- {$details.tourid.admin_signup_email}
- {$details.tourid.upgradeurl}
- {$details.tourid.upgradepost}
- {$details.tourid.allowed_lang}
- {$details.tourid.alternativeurl}
- {$details.tourid.allowed_lang_track_raw}
- {$details.tourid.allowed_lang_track_unq}
- {$details.tourid.hidden}
- {$details.tourid.mail_member_joined}
- {$details.tourid.mail_member_cancelled}
- {$details.tourid.mail_member_rebilled}
- {$details.tourid.mail_member_credited}
- {$details.tourid.mail_member_chargedback}
- {$details.tourid.mail_member_insufficient}
- {$details.tourid.mail_member_voided}
- {$details.tourid.upgradedenyurl}
- {$details.tourid.upgradedenypost}
- {$details.tourid.prejoinpost}
- {$details.tourid.byo_owner}
- {$details.tourid.byo_program}
- {$details.tourid.byo_owner_only}
- {$details.tourid.deleted}
- {$details.tourid.niche}
- {$details.tourid.strack_programid}
- {$details.tourid.mail_member_change}
- {$details.tourid.change_detailspost}
details.billerid
The details.campaignid array holds information about the biller the member signed up under.
- {$details.billerid.billerid}
- {$details.billerid.networkid}
- {$details.billerid.biller}
- {$details.billerid.last_poll}
- {$details.billerid.form_method}
- {$details.billerid.deleted}
details.optionid
The details.campaignid array holds information about the join option the member signed up under.
- {$details.optionid.optionid}
- {$details.optionid.siteid}
- {$details.optionid.networkid}
- {$details.optionid.deleted}
- {$details.optionid.enabled}
- {$details.optionid.orderid}
- {$details.optionid.option_type_id}
- {$details.optionid.billerid}
- {$details.optionid.programid}
details.countryid
If country information is available, you can also use the following variables in details.countryid array
- {$details.countryid.short}
- {$details.countryid.name}
mail_affiliate_on_signup
The mail_affiliate_on_signup mailing template in NATS accepts different variables than the other available mailing templates. In this template, all of the stored affiliate information can be found in the $affiliate array.
- {$affiliate.nats}
- {$affiliate.company}
- {$affiliate.url}
- {$affiliate.firstname}
- {$affiliate.lastname}
- {$affiliate.email}
- {$affiliate.nostore_verify_email}
- {$affiliate.mailok}
- {$affiliate.icq}
- {$affiliate.aim}
- {$affiliate.msn}
- {$affiliate.username}
- {$affiliate.password}
- {$affiliate.nostore_verify_password}
- {$affiliate.address1}
- {$affiliate.address2}
- {$affiliate.city}
- {$affiliate.state}
- {$affiliate.zip_code}
- {$affiliate.country}
- {$affiliate.tax_id_or_ssn}
- {$affiliate.payvia}
- {$affiliate.minimum_payout}
- {$affiliate.verify}
Profits
TRUE PROFIT CALCULATIONS
As of version 4.0.71.2
Profit calculation(in mail_owner_joined template):
{math equation="(y-x-z)/100" x=$member.cost_charge y=$member.transaction.amount z=$member.transaction.total_transaction_payout assign='profit'}
Profit: {$profit|string_format:"%.2f"}
In this equation the variable Z calculates the affiliate payouts for ALL affiliates including site partners etc. In the next version, 4.0.73.1, This variable will be broken down further to allow you to grab the transaction details for a specific subscription, including the detailed list of payouts for the transaction.
