nats_list_xsells

Lists cross-sell (xsell) opportunities available for a particular set of sites, programs, and campaigns.

Article Topics: Smarty, Customization

Parameters

(Required parameters in bold)

Parameter	Description	Possible Values	Default Value	Example
tpl	Template used to display output	Any valid template	The template, function_list_xsells	tpl="mytemplate"
campaigns	Return only xsells available to list of campaigns. If set, ignores campaign and use_default_campaign below	An array reference (see Notes section below)	None.	campaigns="$my_array"
campaign	Return only xsells available to a single campaign. If set, ignores use_default_campaign below	Any valid campaign number	The user's current default campaign	campaign="123"
use_default_campaign	Return only xsells available to the database's stored default program for the current user. (See notes for arguments, campaign and campaigns, above)	0 or 1 (exclusive)	None.	use_default_campaign="1"
userid	The user ID number to get campaigns from	Any valid user ID number	The currently logged in user.	userid="123"
programs	Return only xsells available to a list of programs If set, ignores program below	An array reference (see Notes section below)	None.	programs="$my_array"
program	Returns only xsells available to a single program. If set, ignores use_default_program below	Any valid program ID number	The user's default campaign	program="123"
use_default_program	Returns only xsells available to the database's stored default program for the current user. (See notes for arguments, program and programs, above)	0 or 1 (exclusive)	None. The default in campaign will apply (see campaign above)	use_default_campaign="1"
sites	Return only xsells available to a list of sites. If set, ignores site and use_default_site below	An array reference (see Notes section below)	None.	sites="$my_sites"
site	Return only xsells available to a particular site. If set, ignores use_default_site below	Any valid site ID number	The user's default site	site="123"
use_default_site	Returns only xsells available to the database's stored default site for current user. (See notes for arguments site and sites, above)	0 or 1 (exclusive)	None. The default site will apply (see site above)	use_default_site="1"
assign_prefix	Prefix output variables with this word. (Click link for details)	Any valid Smarty variable name	None. (No prefix is used)	assign_prefix="myvar"
data_only	Set variables but don't display the template	1	None. The template is displayed.	data_only=1

Output

Output placed in the array $xsells and displayed using the template function function_list_xsells. If the parameter tpl is used, output displayed using the template specified in tpl's argument.

Notes

To make an array reference, create the array using the nats_add_to_array function.

See Also

• nats_list_sites -- List the available sites

• nats_list_tours -- List the available tours

• nats_list_campaigns -- List the available campaigns