Difference between revisions of "Upsells: A to Z"
From TMM Wiki
Jump to navigationJump to search| (16 intermediate revisions by 4 users not shown) | |||
| Line 3: | Line 3: | ||
}} | }} | ||
== Upsells == | == Upsells == | ||
| − | Although the exact setup for | + | Although the exact setup for an [[Ct#Upsell|upsell]] with each [[Ct#Biller|biller]] is different, here are some general guidelines on how to set up [[Ct#Upsell|Upsells]] in NATS v4. |
=== Setting up the Upsells === | === Setting up the Upsells === | ||
| Line 20: | Line 20: | ||
At the bottom, you should see a dropdown of [[Ct#Biller|billers]]... | At the bottom, you should see a dropdown of [[Ct#Biller|billers]]... | ||
| − | [[Image: | + | [[Image:No-Available-Outgoing-Upsells.png|800px|No Available Outgoing Upsells]] |
| − | This dropdown will only contain billers that [[NATS]] will support sending [[Ct#Upsell|upsells]] to, and will only contain billers that you already have configured in your [[Biller|Billers Admin]]. Select the biller that will handle the outgoing upsell from the dropdown and click "Add". | + | This dropdown will only contain billers that [[NATS]] will support sending [[Ct#Upsell|upsells]] to, and will only contain billers that you already have configured in your [[Biller|Billers Admin]]. Select the biller that will handle the outgoing upsell from the dropdown and click "Add New Option". |
| − | You will then see a page similar to this ( | + | You will then see a page similar to this (the exact layout will vary from biller to biller): |
| − | [[Image: | + | [[Image:Configuring-Biller-Outgoing-Upsell.png|800px|Configuring Biller for Outgoing Upsell]] |
* The ''Title'' text box is purely for your own internal reference. | * The ''Title'' text box is purely for your own internal reference. | ||
* If you activate the ''Enable for all Options'' checkbox, [[NATS]] will trigger this [[Ct#Upsell|upsell]] anytime it sends a surfer to the [[Ct#Biller|biller]] handling the upsell. Otherwise, the upsell will never fire until you set up [[#Upsell Rules|rules for your upsell]]. | * If you activate the ''Enable for all Options'' checkbox, [[NATS]] will trigger this [[Ct#Upsell|upsell]] anytime it sends a surfer to the [[Ct#Biller|biller]] handling the upsell. Otherwise, the upsell will never fire until you set up [[#Upsell Rules|rules for your upsell]]. | ||
| − | * The information collected in the '' | + | * The information collected in the ''Biller Info'' section will vary greatly from biller-to-biller. However, almost all billers will require a field called ''Ref Code''. This field links the referring site to the site that is going to receive the [[Ct#Upsell|upsell]]. If you are doing upsells between two of your own sites, NATS will use this field to link the outgoing and incoming upsells. NATS has a tool that will generate the Ref Code for you. See [[#Linking an Outgoing Upsell to an Incoming Upsell|this part of the article]] for more details. |
===== Upsell Rules ===== | ===== Upsell Rules ===== | ||
In order for you outgoing upsell to be triggered, you have to set up rules to tell NATS when to trigger the outgoing upsell. You can see/edit these [[NATS4 Rules|rules]] by clicking on the [[Image:Shuffle_16.gif]] icon. You should see a page similar to this: | In order for you outgoing upsell to be triggered, you have to set up rules to tell NATS when to trigger the outgoing upsell. You can see/edit these [[NATS4 Rules|rules]] by clicking on the [[Image:Shuffle_16.gif]] icon. You should see a page similar to this: | ||
| − | [[Image: | + | [[Image:Configuring-Rules-Outgoing-Upsell.png|800px|Configuring Rules for an Outgoing Upsell]] |
* The '''Type''' specifies whether the rule you are setting up is a "SHOW" rule or a "HIDE" rule. If this rule is a match based on the other fields, this will let NATS know whether or not to trigger the outgoing upsell. The IGNORE setting will disable this rule entirely but not delete it. | * The '''Type''' specifies whether the rule you are setting up is a "SHOW" rule or a "HIDE" rule. If this rule is a match based on the other fields, this will let NATS know whether or not to trigger the outgoing upsell. The IGNORE setting will disable this rule entirely but not delete it. | ||
| + | * The '''Affiliate''' field restricts the rule to a specific affiliate's traffic. | ||
* The '''Option''' field lets you pick which option this rule will apply for. | * The '''Option''' field lets you pick which option this rule will apply for. | ||
| − | * The '''Site''' field allows you to limit the rule by a specific site. | + | <!--* The '''Site''' field allows you to limit the rule by a specific site.--> |
* The '''Program''' field allows you to restrict the rule to a certain program. | * The '''Program''' field allows you to restrict the rule to a certain program. | ||
| − | + | <!--* The '''Country''' field restricts the rule to a specific country if set. | |
| − | * The '''Country''' field restricts the rule to a specific country if set. | ||
* The '''Start Date/Time''' field lets NATS know when this rule is to take effect. | * The '''Start Date/Time''' field lets NATS know when this rule is to take effect. | ||
| − | * The '''End Date/Time''' field lets NATS know when this rule no longer applies. | + | * The '''End Date/Time''' field lets NATS know when this rule no longer applies.--> |
| − | Be sure to click '' | + | Be sure to click ''Save Rule'' when you want to add the [[NATS4 Rules|rule]]. |
| − | '''NOTE:''' You | + | '''NOTE:''' You ''must'' have at least one rule set up in order for the upsell to be triggered. |
==== Incoming ==== | ==== Incoming ==== | ||
| Line 54: | Line 54: | ||
The first step (normally) involves setting up the [[Ct#Upsell|upsell]] on the [[Ct#Biller|biller]]'s end. Please refer to your biller's documentation for more information on how to configure a upsell in their admin. | The first step (normally) involves setting up the [[Ct#Upsell|upsell]] on the [[Ct#Biller|biller]]'s end. Please refer to your biller's documentation for more information on how to configure a upsell in their admin. | ||
| − | When you visit your Upsells Admin, click on the white tab at the top-left that says ''"Incoming | + | When you visit your Upsells Admin, click on the white tab at the top-left that says ''"Incoming Upsells"'': |
| − | [[Image: | + | [[Image:Incoming-upsells.png|800px|Incoming Upsells]] |
Then to set up a new incoming [[Ct#Upsell|upsell]], first pick the [[Ct#Biller|biller]] that will be handling the upsell as well as the site that will receive the upsell and the program the transaction will be paid out under: | Then to set up a new incoming [[Ct#Upsell|upsell]], first pick the [[Ct#Biller|biller]] that will be handling the upsell as well as the site that will receive the upsell and the program the transaction will be paid out under: | ||
| − | [[Image: | + | [[Image:No-Available-Incoming-Upsells.png|800px|Incoming Upsells]] |
From there, you'll be able to add the details for your incoming upsell: | From there, you'll be able to add the details for your incoming upsell: | ||
| − | [[Image: | + | [[Image:Configuring-Biller-Incoming-Upsell.png|800px|Configuring Biller for Incoming Upsell]] |
| − | * The | + | * The ''Program'' dropdowns will only contain valid Cross Sale Program types. |
| + | If no programs are available, please configure a new Cross Sale Program type program via the Programs Admin | ||
* The '''Details''' section allows you to set some basic details for the upsell, such as the internal title of the upsell, the initial amount/days, and rebill amount/days. | * The '''Details''' section allows you to set some basic details for the upsell, such as the internal title of the upsell, the initial amount/days, and rebill amount/days. | ||
* The '''Biller Info''' section is where you tell NATS the information that NATS will use to process the upsell (The information collected varies greatly from biller to biller). | * The '''Biller Info''' section is where you tell NATS the information that NATS will use to process the upsell (The information collected varies greatly from biller to biller). | ||
| Line 74: | Line 75: | ||
=== Linking an Outgoing Upsell to an Incoming Upsell === | === Linking an Outgoing Upsell to an Incoming Upsell === | ||
| − | If you are sending [[Ct#Upsell|upsells]] between two of your NATS [[Ct#Site|sites]], NATS provides a tool that will generate a ref code it can use to link the outgoing and incoming upsell. The tool will use data from a specific [[Ct#Campaign|campaign]], [[Ct#Program|program]], and [[Ct#Upsell|upsell]] to generate a ref code. You can access this tool by visiting <tt>internal.php?page=xsells</tt> on your [[NATS]] installation. | + | If you are sending [[Ct#Upsell|upsells]] between two of your NATS [[Ct#Site|sites]], NATS provides a tool that will generate a ref code it can use to link the outgoing and incoming upsell. The tool will use data from a specific [[Ct#Campaign|campaign]], [[Ct#Program|program]], and [[Ct#Upsell|upsell]] to generate a ref code. You can access this tool by visiting <tt>internal.php?page=xsells</tt> on your [[NATS]] installation. Pick the site, program, and campaign from the dropdowns and click on ''Apply Changes''. |
| − | |||
| − | |||
| − | + | <!--On the right-hand side, you should see three dropdowns. This where you tell NATS what site, program, and campaign you want to generate a ref code for: | |
| + | [[Image:NATS4 Cross Sells xsells limitations.jpg]]--> | ||
You should then see something similar to this: | You should then see something similar to this: | ||
| − | [[Image: | + | [[Image:Ref-Code.png|500px|Ref Codes]] |
You can then take that ref code, go back to your [[Upsells Admin]], and then click on the pencil [[Image:Pen_16.gif]] for the outgoing upsale you wish to link to. From there, copy/paste the ref code you got from the previous page: | You can then take that ref code, go back to your [[Upsells Admin]], and then click on the pencil [[Image:Pen_16.gif]] for the outgoing upsale you wish to link to. From there, copy/paste the ref code you got from the previous page: | ||
| − | [[Image: | + | [[Image:Configuring-Ref-Code-Admin.png|1000px|Configuring the Ref. Code in the Admin]] |
=== Using UpsellPlus === | === Using UpsellPlus === | ||
| Line 94: | Line 94: | ||
Give the following link to your users to give them the upsell saved: | Give the following link to your users to give them the upsell saved: | ||
| − | |||
* <nowiki>http://<linkdomain>/signup/upsellplus.php?site=<siteid>&username=<username></nowiki> | * <nowiki>http://<linkdomain>/signup/upsellplus.php?site=<siteid>&username=<username></nowiki> | ||
| + | **''Siteid and Username is the preferred way of doing it. | ||
| + | * <nowiki>http://<linkdomain>/signup/upsellplus.php?memberid=<memberid>&natssess=<nats_session>&site=<siteid></nowiki> | ||
The first link is preferred. Replace <linkdomain>, <memberid>, <nats_session>, <siteid> and <username> with your link domain and the member's member id, session id, site id and/or user name respectively. | The first link is preferred. Replace <linkdomain>, <memberid>, <nats_session>, <siteid> and <username> with your link domain and the member's member id, session id, site id and/or user name respectively. | ||
| Line 101: | Line 102: | ||
Additional optional variable can be added for the desired effect: | Additional optional variable can be added for the desired effect: | ||
| − | * If you want the user be automatically submitted for the [[Ct#Upsell|upsell]], you can add the variables '&upsellid=<upsellid>&email=<email>&submit=1'. <upsellid> will be the id number from the [[Upsells Admin]] and the <email> will be the email for the member. | + | * If you want the user be automatically submitted for the [[Ct#Upsell|upsell]], you can add the variables '&upsellid=<upsellid>&email=<email>&submit=1'. <upsellid> will be the id number (of the Outgoing Upsell) from the [[Upsells Admin]] and the <email> will be the email for the member. |
* If you want to pre-check certain [[Ct#Upsell|upsells]] that are shown, you can add '&upsellids=<upsellid_list>'. <upsellid_list> should be a comma seperated list of the Upsells ids that you want the user to see checked (e.g. upsellids=1,2,5). | * If you want to pre-check certain [[Ct#Upsell|upsells]] that are shown, you can add '&upsellids=<upsellid_list>'. <upsellid_list> should be a comma seperated list of the Upsells ids that you want the user to see checked (e.g. upsellids=1,2,5). | ||
Latest revision as of 05:50, 20 December 2022
Upsells
Although the exact setup for an upsell with each biller is different, here are some general guidelines on how to set up Upsells in NATS v4.
Setting up the Upsells
Outgoing
Basic Setup
The first step (normally) involves setting up the upsell on the biller's end. Please refer to your biller's documentation for more information on how to configure a upsell in their admin.
After that is complete, to set up an outgoing upsell in NATS, visit your Upsells Admin:
Then you need to click on Outgoing Upsells:
At the bottom, you should see a dropdown of billers...
This dropdown will only contain billers that NATS will support sending upsells to, and will only contain billers that you already have configured in your Billers Admin. Select the biller that will handle the outgoing upsell from the dropdown and click "Add New Option".
You will then see a page similar to this (the exact layout will vary from biller to biller):
- The Title text box is purely for your own internal reference.
- If you activate the Enable for all Options checkbox, NATS will trigger this upsell anytime it sends a surfer to the biller handling the upsell. Otherwise, the upsell will never fire until you set up rules for your upsell.
- The information collected in the Biller Info section will vary greatly from biller-to-biller. However, almost all billers will require a field called Ref Code. This field links the referring site to the site that is going to receive the upsell. If you are doing upsells between two of your own sites, NATS will use this field to link the outgoing and incoming upsells. NATS has a tool that will generate the Ref Code for you. See this part of the article for more details.
Upsell Rules
In order for you outgoing upsell to be triggered, you have to set up rules to tell NATS when to trigger the outgoing upsell. You can see/edit these rules by clicking on the 
icon. You should see a page similar to this:
- The Type specifies whether the rule you are setting up is a "SHOW" rule or a "HIDE" rule. If this rule is a match based on the other fields, this will let NATS know whether or not to trigger the outgoing upsell. The IGNORE setting will disable this rule entirely but not delete it.
- The Affiliate field restricts the rule to a specific affiliate's traffic.
- The Option field lets you pick which option this rule will apply for.
- The Program field allows you to restrict the rule to a certain program.
Be sure to click Save Rule when you want to add the rule.
NOTE: You must have at least one rule set up in order for the upsell to be triggered.
Incoming
Basic Setup
The first step (normally) involves setting up the upsell on the biller's end. Please refer to your biller's documentation for more information on how to configure a upsell in their admin.
When you visit your Upsells Admin, click on the white tab at the top-left that says "Incoming Upsells":
Then to set up a new incoming upsell, first pick the biller that will be handling the upsell as well as the site that will receive the upsell and the program the transaction will be paid out under:
From there, you'll be able to add the details for your incoming upsell:
- The Program dropdowns will only contain valid Cross Sale Program types.
If no programs are available, please configure a new Cross Sale Program type program via the Programs Admin
- The Details section allows you to set some basic details for the upsell, such as the internal title of the upsell, the initial amount/days, and rebill amount/days.
- The Biller Info section is where you tell NATS the information that NATS will use to process the upsell (The information collected varies greatly from biller to biller).
Click on Save Changes when you are done.
Linking an Outgoing Upsell to an Incoming Upsell
If you are sending upsells between two of your NATS sites, NATS provides a tool that will generate a ref code it can use to link the outgoing and incoming upsell. The tool will use data from a specific campaign, program, and upsell to generate a ref code. You can access this tool by visiting internal.php?page=xsells on your NATS installation. Pick the site, program, and campaign from the dropdowns and click on Apply Changes.
You should then see something similar to this:
You can then take that ref code, go back to your Upsells Admin, and then click on the pencil 
for the outgoing upsale you wish to link to. From there, copy/paste the ref code you got from the previous page:
Using UpsellPlus
Upsells let you offer incentives for your members to join other sites after they have joined a site. The member will need to complete an upsell by clicking on a given link.
Give the following link to your users to give them the upsell saved:
- http://<linkdomain>/signup/upsellplus.php?site=<siteid>&username=<username>
- Siteid and Username is the preferred way of doing it.
- http://<linkdomain>/signup/upsellplus.php?memberid=<memberid>&natssess=<nats_session>&site=<siteid>
The first link is preferred. Replace <linkdomain>, <memberid>, <nats_session>, <siteid> and <username> with your link domain and the member's member id, session id, site id and/or user name respectively.
Additional optional variable can be added for the desired effect:
- If you want the user be automatically submitted for the upsell, you can add the variables '&upsellid=<upsellid>&email=<email>&submit=1'. <upsellid> will be the id number (of the Outgoing Upsell) from the Upsells Admin and the <email> will be the email for the member.
- If you want to pre-check certain upsells that are shown, you can add '&upsellids=<upsellid_list>'. <upsellid_list> should be a comma seperated list of the Upsells ids that you want the user to see checked (e.g. upsellids=1,2,5).
The last step you will need to do is setup 3 new site templates.
- gateway_upsell will be shown to the user when they click on the link given to them.
- page_upsell_approval will be shown to the user when their upsell is approved.
- page_upsell_denial will be shown to the user when their upsell is denied.
