Widget parameter reference

8 min

This article describes all parameters that can be used when configuring widgets

Supports skinid, l and returnurl. See Parameters available in all widgets

Parameter	Description
event	comma-separated list of event ids
product	comma-separated list of product ids
flow	this parameter determines the flow of the widget. Possible values are checkout, return, basket or basketwithcheckout. Default value is checkout
reservemoretickets	if this parameter value has no, the basket page will not show the Reserve more tickets button. Default value is yes
saleschannelid	the web sales channel id that needs to be used. If not specified, the default sales channel is used
ticketinfo	comma-separated list of ticket info fields that the user must fill in. default is empty: no extra ticket info will be requested. Possible fields are email and name
extraevents	comma-separated list of extra events that can be sold. The main purpose is upselling. Only suited for simple events without seatingplan and a limited number of prices
extraproducts	comma-separated list of extra products that can be sold. The main purpose is upselling
edit	see basket widget
panels	see checkout widget
oncompletion	see checkout widget
withauthentication	if this parameter has value yes, the user must be authenticated before being able to enter the wizard. If the user is not authenticated, a login-screen will appear. Default value is no
subscribe	if this parameter has value yes, the user will be presented a subscription form. Default value is no
requiredfields	comma-separated list of fields that are required, possible values are customertitle, phone, birthdate
ticketcustomfields	comma-separated list of ticket fields to show
requiredticketcustomfields	comma-separated list of ticket fields that are required, make sure these fields are in the ticketcustomfields list too.

Parameter	Description
flow	this parameter determines the flow of the widget. Possible values are checkout or return. Default value is checkout
edit	If the value is yes, the user can edit the basket (e.g. remove tickets). If the value is no, the basket is read-only. Default value is no.
reservemoretickets	if this parameter value has no, the basket page will not show the Reserve more tickets button. Default value is yes.
panels	see checkout widget
oncompletion	see checkout widget

Parameter	Description
panels	comma-separated list of panels that should be shown. Default = all panels are shown. Possible panels: customer, delivery, payment, voucher
oncompletion	what to do after completion of the order. Possible values are orderdetail or return. When orderdetail is specified, the customer sees an order detail page. If return is specified, the customer is returned to the specified returnurl.

Parameter	Description
product	comma-separated list of product ids
withauthentication	if this parameter has value yes, the user must be authenticated before being able to enter the wizard. If the user is not authenticated, a login-screen will appear. Default value is no
saleschannelid	the web sales channel id that needs to be used. If not specified, the default sales channel is used
subscribe	if this parameter has value yes, the user will be presented a subscription form. Default value is no
flow	see addtickets widget
ticketinfo	see addtickets widget
reservemoretickets	see basket widget
edit	see basket widget
panels	see checkout widget
oncompletion	see checkout widget

Parameter	Description
fields	comma-separated list of fields to show, possible values are customertitle, address, phone, birthdate
requiredfields	comma-separated list of fields that are required, make sure these fields are in the fields list too. Possible values see fields.
customfields	comma-separated list of custom field ids
optins	comma-separated list of opt-in ids the user has to answer

Parameter	Description
event	comma-separated list of event ids

Parameters available in all widgets

Parameter	Description
l	language code. Optional, if not specified the default language that is configured in account parameters is used. Remark that the language should not be included when generating the signature. This allows for easily generating multi-language links, as you can simply modify the language code in the url without needing to regenerate the signature
contactid	the id of the contact used to authenticate this widget. Will be linked to the order if one is created. If no contactid is specified the customer needs to fill in an e-mail (and possibly more information).
skinid	the id of the web skin that needs to be used. If not specified the default skin is used
orderid	optional. If it is specified, the widget will use this order. This allows you for example to first use the API to create a new order, and then call a widget with as parameter the new orderid to further manipulate the order. If you don't specify an orderid, the widget will check the context if an order was already created. If yes, it will use it, if not, it will create a new order. Remark that the orderid is stored in the session, so when calling multiple widgets the default behavior is that the same orderid is kept. Not used by waitinglist widget
returnurl	This parameter should always be specified, and must contain the landingpage on the website where the user will be redirected to after finishing the widget. When redirecting the user to the landingpage, Ticketmatic will add following parameters to the returnurl: accesskey, orderid, contactid, reason and signature

Docs powered by Archbee