Table of Contents
What can you do with your Event Ticket with Ticket Scanner for WooCommerce plugin?
You can start sell event tickets immediately with WooCommerce. Assign a product a ticket list and that’s it.
You can also redeem the tickets at the entrance using the ticket scanner. It will work on mobile devices and desktop PC.
We are adding more and more videos about new options to our youtube channel. Do not miss something and subscribe.
Quick start
Ticket Sale WooCommerce
You can sell now Tickets with WooCommerce using the Serial Code to generate Ticket numbers. You have also a Ticket Scanner, that allows you to redeem the tickets on the entrance. Fast and secure.
Options for WooCommerce ticket sale
Download event or party flyer
You can download a flyer for your party or event. The flyer can also be customized within the options.
Options for WooCommerce event or party flyer
Attache ticket PDF to the purchase email
If this premium option is activated, then for each code you will have one PDF in the email to your customer.
So for 5 codes, there will be 5 PDFs attached.
But PDFs are only attached, if your customer is buying less then 20 tickets. Otherwise the timeout could prevent the purchase email to be generated and the email might be to big for the recipient mailbox.
Options for calendar file (ICS file)
It is possible to add a start and an end date to your WooCoomerce product that will be sold as an event. With this you can activate more attractive and helpful options for your customers.
You can attache a calendar file to the purchase emails and even display the date on the email and on the product detail page.
The settings are made on the product detail view. The date is optional. If you leave out the end date, then this event will become a day calendar entry.
You can also download the ICS file directly from within the product detail view in the WooCommerce backend.
Quick Overview of the Basic Plugin Functionalities
Logo, Banner and Background on the PDF ticket
The global settings allow you to set up a logo, banner and background image for your PDF ticket.
With the premium version you can overwrite this on the ticket list level and on the product level. The ticket list level overwrites the global settings, the product level overwrites the ticket list and global settings.
Event or Party Ticket
You can add a banner image that will be placed above the ticket information.
The QR code will contain the ticket number. You can scan this with the ticket scanner (URL to it is within the event ticket admin area) and redeem the ticket at the entrance.
You can display the short description of the ticket and unicode is supported as well as HTML.
You can also add a logo at the bottom of the ticket.
Event or Party Flyer
You can download a event or party flyer within the product detail area.
You can also add a banner, log and a background image to the PDF.
The QR code contains the URL to the detail page of the product.
The product description an contain unicode and HTML.
You can hide the price if needed.
Scan event ticket
The built in ticket scanner allows you to scan the QR code of the ticket. Once it is scanned, it will load the ticket information. You can redeem the ticket with the button at the bottom.
Shortcode to display the ticket scanner on a page
Important: Some installations do not allow a direct access to the plugin folder. In this case please create a page and add the shortcode for the ticket scanner.
[ sasoEventTicketsValidator_ticket_scanner ]
Shortcode to display users assigned tickets and codes
You can display the assigned (to a user registered) serial codes within a page. Use the following shortcode for this.
[ sasoEventTicketsValidator_code ]
Product variants
The plugin support product variants. If you want to sell different time slots or categories.
The ticket info and PDF will contain some details from the main product and some from the product variant.
The event time can be printed on the variant product too. This is best for tickets with the same time, like categories. In this case activate the checkbox „Date is for all variants“, to have the event time on each sold product variant.
Important. The short description is only used for non-variant products. With variant products, the description of the variant will be displayed. Here you can enter the different time slot information. Do not forget to activate this option within the options.
You can control if the variant type name should be displayed also on the PDF ticket. Set this option within the options area.
You can opt-out product variants. So the variant will not receive a ticket. Could be helpful for different type of event categories, where not all product variants will need a digital ticket.
Redeem Logs
Premium Feature. You can inspect and download the statistics about the redeemed tickets of a product. Within the product, there is a „Event Tickets“ box with the option to open the logs and also a button to download a CSV file.
If you re-use the product or the product is not for a specific venue, you can still use the date to determine the redeemed tickets.
Code Validator basic form style options
You can set basic styling options for the validation form for your users. If you are more experienced, you should consider to use CSS to style the form to your needs. Explained here.
The shortcode will add the user form to validate codes. This form contains only an input field and a button. This allows you to add your own text and look&feel to the page.
Ticket and Code validation messages
Depending on the status of the code, and if the code exists at all, a different message will be shown. You can adjust the messages in the options.
Additional Validation Message
Calling URLs from the event ticket with ticket scanner plugin
We have two options for calling URLs
1. Redirects
2. Webhooks
Redirects
You need to activate the redirect options within the option area.
You can enter the URL as an absolute (e.g. https://vollstart.de/) or relative (e.g. /page/) URI. This redirect URL will be executed on the frontend. If you do not enter a button label, then the user will be redirected to the URL immediately if the code is valid. If you enter a button label, the user need to click on the button to be forwarded.
Webhooks
You can enter URLs for the different validation steps that will be called from your server (your WordPress server is calling the URL). This allows you to inform other server (system), when the validation step is performed.
URL format & syntax
How to build an URL for a webhook call?
We offer 5 placeholder: {USERID}, {CODE}, {CODEDISPLAY}, {IP}, {LIST}, {LIST_DESC}
Please be aware that the placeholders are case sensitive. The easiest way is to copy & paste the placeholder with the brackets into your URL.
Additional, you can use also these replacement tags in your text messages and URLs for the meta code values
{USER_VALUE}: Value given by the user during the code registration.
{USER_REG_IP}: IP address of the user, register to a code.
{USER_REG_USERID}: User id of the registered user to a code. Default will be 0.
{USED_REG_IP}: IP addres of the user that used the code.
{CONFIRMEDCOUNT}: Amount of how many times the code was validated successfully.
{WOOCOMMERCE_ORDER_ID}: WooCommerce order id assigned to the code.
{WOOCOMMERCE_PRODUCT_ID}: WooCommerce product id assigned to the code.
{WOOCOMMERCE_CREATION_DATE}: Creation date of the WooCommerce sales date.
{WC_RP_ORDER_ID}: WooCommerce order id, that was purchases using this serial code as an allowance to purchase a restricted product.
{WC_RP_PRODUCT_ID}: WooCommerce product id that was restricted with this serial.
{WC_RP_CREATION_DATE}: Creation date of the WooCommerce purchase using the allowance code.
Example:
Userid (empty if the user is not logged in): userid
Display-Code: NYA-ZER-TER
Code: NYAZERTER
Name of the list the code is assigned to: myList
IP of the user: 1.2.3.4
The webhook example URL:
https://vollstart.de/anotherService/{LIST}/{CODE}/?code={CODEDISPLAY}&ip={IP}
will be translated by the plugin into:https://vollstart.de/anotherService/myList/NYAZERTER/?code=NYA-ZER-TER&ip=1.2.3.4 and then the URL will be called by your wordpress server.
On option 1 (Redirect), the browser will go tohttps://vollstart.de/anotherService/myList/NYAZERTER/?code=NYA-ZER-TER&ip=1.2.3.4
On option 2 (Webhook), your server will call the URL in the backgroundhttps://vollstart.de/anotherService/myList/NYAZERTER/?code=NYA-ZER-TER&ip=1.2.3.4
Shortcode validator optional parameters
Use your own form
You can use your own HTML input, output and trigger component for the check.
If you add the parameters (all 3 mandatory to use this feature), then the default input area will not be rendered.
[ sasoEventTicketsValidator inputid="" triggerid="" outputid="" ]
inputid
The component with the set HTML-ID will be used as the input element. It need to be an HTML input element.
We will access the value-parameter of it.
[ sasoEventTicketsValidator
inputid=""
triggerid=""
outputid=""
]
triggerid
The onclick event of the component with this HTML-ID will be replaced by our function in order to call the server validation for the code.
[ sasoEventTicketsValidator
inputid=""
triggerid=""
outputid=""
]
outputid
The component with the provided HTML-ID on this parameter will be used for the server answer – the output.
It cannot be empty. If you want to hide the output, hide it using css style commands.
The content of this component will be replaced by the server result after the check . We will use the innerHTML property of it, so use a DIV, SPAN, TD or similar for best results.
If you need to control the form depending on the result of the serial code check, then please consider using one or both of the additional optional parameter for your own JavaScript callback functions.
[ sasoEventTicketsValidator
inputid=""
triggerid=""
outputid=""
]
Use your own JavaScript callbacks and gain more control
You can add JavaScript function names, that are called before and after the check.
Both parameters are optional and not required.
[ sasoEventTicketsValidator jspre="" jsafter="" ]
These parameters can be combined with the input and output parameters.
jspre
If you want to control or manipulate the input before it is sent to the server, then use this parameter.
The function will be called. The input parameter for the function will be the code.
If your function returns a value, than this returned value will be used. If nothing is returned or an empty string, then the entered code of the user will be used.
[ sasoEventTicketsValidator
jspre="myCodePre"
jsafter=""
]
Example function
Add your JavaScript code to your page, so that it can be called from the serial code plugin. Make sure the function name your are using for the jspre-call is matching, the jspre attribute value. The input parameter is a string with the user entered code.
function myCodePre(myCode) {
// console.log(myCode);
return myCode;
}
jsafter
The function will be called. The input parameter will be the result JSON object from the server.
The content differs (depending on the activated options) and can be extended in the future. Please inspect the result first, before relying on the available property.
If you want to use the result as a form controlling mechanism check for the returned property: data.valid
The data.valid === 1 is true, if the serial code was valid and unsed.
[ sasoEventTicketsValidator
jspre=""
jsafter="myCodeAfter"
]
Example function
Add your JavaScript code to your page, so that it can be called from the serial code plugin. Make sure the function name your are using for the jsafter-call is matching, the jsafter attribute value. The input parameter is a JSON object returned from the server after the serial code was evaluated.
function myCodeAfter(data) {
// console.log(data);
if (data.valid === 1) {
// do your thing
}
}
Worpress filters for the pre and after check option
You can use the „add_filter“ function to register your PHP functions. They will be called and expected a specific return value. With this option you can extend the serial code validation check by yourself.
Before the code check pre
This filter will be called right after the parameter check. You can change the $data[‚code‘] before it is used to perform the internal pre checks.
add_filter('saso_eventtickets_beforeCheckCodePre', 'myfunc', 20, 1);
/**
* param $data assoc array contains the code from the validator form $data['code'];
*/
function myfunc($data) {
$code = $data['code'];
return $data;
}
Before the code check
This filter will be called after some initial checks are passed. After this the code will be evaluated.
add_filter('saso_eventtickets_beforeCheckCode', 'myfunc', 20, 1);
/**
* param $data assoc array contains the code pre analyzed code $data['code']
*/
function myfunc($data) {
$code = $data['code'];
return $data;
}
After the check pre
The check is performed and the serial code is evaluated. The code object is available, but only filled if the serial was found. The status can be checked. This filter is called before the additional after operations are executed, like IP block, status messages and more.
add_filter('saso_eventtickets_afterCheckCodePre', 'myfunc', 20, 1);
/**
* param $codeObj contains the serial if found
*/
function myfunc($codeObj) {
// print_r($codeObj);
// echo $codeObj['status'];
// echo $codeObj['_valid'];
// echo $codeObj['aktiv'];
return $codeObj;
}
After the check
This filter will be called after all the additional operations are done. The webhook trigger is send.
The returned values to the validator form will be $codeObj[‚_valid‘] and $codeObj[‚_retObject‘].
add_filter('saso_eventtickets_afterCheckCode', 'myfunc', 20, 1);
/**
* param $codeObj assoc array
*/
function myfunc($codeObj) {
// echo $codeObj['_valid'];
// var_dump($codeObj['_retObject']);
return $codeObj;
}
Styling
The frontend will be rendered by the Javascript file. The elements will have css classes, that you could override.
The actual used CSS file can be view here: Open the CSS file
<div id="sasoEventtickets">
<div class="sngmbh_container">
<div class="sngmbh_container">
<div class="sngmbh_input-group sngmbh_mb-3">
<input required="" type="text" class="sngmbh_form-control sngmbh_mb-2" data-input="sasoEventticketscode" placeholder="XXYYYZZ">
<div class="sngmbh_input-group-append">
<button type="submit" data-btn="sasoEventticketsbtn" class="sngmbh_btn sngmbh_btn-primary sngmbh_mb-2">Check</button>
</div>
</div>
</div>
<div></div>
</div>
</div>
Form validation look and feel is controled by 2 css classes:
.sngmbh_is-invalid, .was-validated .sngmbh_form-control:invalid {
border-color: #dc3545;
padding-right: calc(1.5em + .75rem);
background-image: url(data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' width='12' height='12' fill='none' stroke='%23dc3545' viewBox='0 0 12 12'%3e%3ccircle cx='6' cy='6' r='4.5'/%3e%3cpath stroke-linejoin='round' d='M5.8 3.6h.4L6 6.5z'/%3e%3ccircle cx='6' cy='8.2' r='.6' fill='%23dc3545' stroke='none'/%3e%3c/svg%3e);
background-repeat: no-repeat;
background-position: right calc(.375em + .1875rem) center;
background-size: calc(.75em + .375rem) calc(.75em + .375rem);
}
.sngmbh_is-valid, .was-validated .sngmbh_form-control:valid {
border-color: #28a745;
padding-right: calc(1.5em + .75rem);
background-image: url(data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' width='8' height='8' viewBox='0 0 8 8'%3e%3cpath fill='%2328a745' d='M2.3 6.73L.6 4.53c-.4-1.04.46-1.4 1.1-.8l1.1 1.4 3.4-3.8c.6-.63 1.6-.27 1.2.7l-4 4.6c-.43.5-.8.4-1.1.1z'/%3e%3c/svg%3e);
background-repeat: no-repeat;
background-position: right calc(.375em + .1875rem) center;
background-size: calc(.75em + .375rem) calc(.75em + .375rem);
}
The ajax call progress is rendered dynamically with the CSS rule: „lds-dual-ring„. It will be injected if it is not defined. To overrule this look and feel, just create the CSS rule with your values.
The progress wheel (spinner) is rendered by:
<div id="sasoEventticketsspinner">
<span class="lds-dual-ring"></span>
</div>
Here is the default CSS rule of the progress wheel:
.lds-dual-ring {
display:inline-block;
width:64px;
height:64px;
}
.lds-dual-ring:after {
content:" ";
display:block;
width:46px;
height:46px;
margin:1px;
border-radius:50%;
border:5px solid #fff;
border-color:#2e74b5 transparent #2e74b5 transparent;
animation:lds-dual-ring 0.6s linear infinite;
}
@keyframes lds-dual-ring {
0% {
transform: rotate(0deg);
}
100% {
transform: rotate(360deg);
}
}
WooCommerce restrict product sale without serial code
Optional. If you use WooCommerce, you can profit from our plugin too.
You can restrict the sale of products to be allowed only if your customer enters a valid and unused serial code. You can assign the serial code list for the restriction, within the product details.
Your customer can receive from you a serial code out of the code list that is assigned to your WooCommerce product. They can use the code to buy as many as products as protected with this code. Or you allow only a „one time use“. If you activate the „one time use“ option, then you can reuse a code used on refunded orders. Please activate for this the „Clear the code if the order was deleted or a refund triggered“ option.
Display registered information to a code
You can ask the user to register to a code after a successfull restriction code validation check.
You can also display this information to the next user who checks this code.
This allows you basically to a database, where users can check a restriction code. Maybe printed on a certification or personal ID.
IP block against brute force attacks (premium only)
You can activate the IP blocker to protect your server from bruteforce checks. That way they cannot try out serial codes untill they found a correct one.
IP log history
You can activate the IP log history and track the usage. You will see the IP address and the used code for the check. The code status shows you the return value of the validation check.
You can delete the history also untill a date to clean up your database and free some space.
WooCommerce product code assignment
Optional. If you use WooCommerce, you can profit from our plugin too.
You can assign a code list to a product. A new code will be generated with the purchase and assigned to the order.
It is possible to reuse existing unassigned codes in the code list. This way you can reuse codes that are marked again as unused for your refunded orders. The serial code will be added to the purchase email within the product table. And also will be printed on the optional plugin „WooCommerce PDF Invoices“.
The default format for a new generated code will be 20 letters with a „-“ delimiter. E.g. abcde-abcde-abcde-abcde
Expiration and validity of codes
Only for premium users.
You can activate to let your restriction codes expire. A check after expiration will result in the „expired message“ to your users.
You can always add an expiration date as days from the first successfull check or creation date to any code.
Additional you can start tracking old codes also. To do this, activate the global expiration option. This will have an effect for all validation checks from now on.
Enter the days how long the serial is valid untill it expires. Used for the global setting. If a code was already successful validated by the user, then this date will be used to calculate if the code is expired.
If you want to expire also old codes in your database, then you can activate the option for it.
For WooCommerce sales generated serials, you can activate the expiration date calculation right from the purchase date. So your customer do not need to validate them first to start the expiration countdown.
Additional you can edit the validation directly on the serial code, via code list and on the WooCommerce product.
FAQ's
No. The plugin is only for one domain.
Up to 3 Sub-Domains are fine, as long as they are used for testing reasons.
Your serial will be checked against the domain and how many different sub-domains are calling the update.
Yes. You can copy and paste your codes within the „adding codes“ area. No direct file import possible.
Yes, absolutely.
That is the basic functionality of this plugin.
You have the option to ask the user to enter a value once the code was successfully checked. Activate this option within the option area.
Please note, that you can ask for one value. It will be stored to the code. You can define the labels for this in the option area.
We offer also JS hooks, so that you can add your own JS code to be executed before and after the serial code check.
Yes, but only with the premium plugin.
The premium plugin offers: „Save IP address of user using the code validation check on your page“
The data is stored into your database.
Yes, the confirmed checks are displayed on the code details and is labeled „Confirmed count:“
Yes. Unlimited tickets numbers. Your server is the limit.
If you plan to have a lot of tickets, then we recommend to choose a longer ticket number within the options, to make sure you are not running out of possible numbers.
No.
The ticket scanner is making ajax calls to your wordpress installation to update the database and check if the ticket is still valid.
It could have been redeemed already on another entrance.
This is not supported yet.
But we kept the words on the ticket to a minimum. And most of the action (buttons, links) and title lables can be changed by you within the plugin option area.
The plugin is not coming with its own payment methods. Selling the ticket is a responsibility of WooCommerce and so you can use all the available payment methods for it.
If you want to redeem a ticket and receive this message, then the ticket order is not yet set to „complete“.
To prevent ticket to be redeemed even if they are not paid yet (like for check or bank transer), checks the system the order status.
By default only „completed“ orders are accepted.
