User Manual/Administration Interface/Coupon details

Basic coupon details


There are some select and input fields in the left section of the detail view that are available for configuring a coupon. Their purpose are:


 * Status (required) : Controls the global availability of the configured coupon. There are several status values available but the coupon will only be used if the status is "enabled".


 * Provider (required) : This is the last part of the coupon provider class name, e.g. "FixedRebate" for the "MShop_Coupon_Provider_FixedRebate". The name of the provider is case sensitive, so "fixedrebate" is not the same as "FixedRebate"! Each coupon provider can be enhanced by one or more decorators that must be added to the provider name and separated by a comma. To configure the "FixedRebate" coupon provider in combination with e.g. a decorator called "Example", enter "FixedRebate,Example" into the input field of the provider. For a list of coupons and decorators that are part of the Arcavias core, please have a look at the coupon overview and the page for the coupon decorators coupon decorators.


 * Label (required) : An internal label which helps you to identify the coupon and which can be used for searching in the administration interface.


 * Start date (optional) : The point in time when the coupon will be available for customers to enter their codes. The date/time has to be in ISO format (YYYY-MM-DD HH:mm:ss) and the hours must be in the range of 0-23.


 * End date (optional) : The point in time when the coupon won't be available any more. For this field the same format applies as for "Start date".


 * Created (read-only) : Date and time when the entry was added. This value is set automatically.


 * Last modified (read-only) : Last date and time when the entry was edited. This value is set automatically.


 * Editor (read-only) : Last user who added or modified the entry. This value is set automatically.



Coupon configuration
The right side of the coupon detail view contains a key/value configuration panel where the necessary configuration values of the coupon and the decorators must be added. The left column in the configuration panel is for the configuration key, the right column for the value and at least the left column of each line must be filled with a valid key. You can add lines by clicking on the "Add" button in the menu bar and delete selected lines with the "Delete" button. The order of the lines doesn't matter.

Each coupon and decorator needs its own configuration. For the required resp. available configuration keys and values, please refer to the documentation of the coupon or decorator. Documentation for the built-in ones is available at the coupon overview page and the coupon decorators page.

Coupon codes


Besides the "Basic" tab, the coupon detail view also contains a tab "Codes" for managing the codes associated to a coupon. It's list view provides a paged list of all codes available for the coupon in the system, which can be filtered by various criteria. The most important columns are shown by default but the list of columns can be adapted via the list header. Coupon codes can be added, edited or deleted either by using the button in the menu or by using the context menu which is shown if you right-click into the list. A double click also opens the detail view for editing the codes.

Note: Before you can add codes to a new coupon, you have to save the coupon configuration first! This is necessary to be able to associate the codes to the current coupon configuration automatically.



Coupon code details


There are some input fields that are available for coupon codes. Their purpose are:


 * Code (required) : A coupon code that is unique in the shop site and is able to identify only the coupon configuration its associated with. Good coupon codes are not two long and should avoid similar looking characters (e.g. zero and "O" or 1 and "l"). Please think twice before you really add codes with more than eight characters! If a code should be generally available, it's a good idea to create a descriptive code for your promotion. In the other case, if a lot of codes are generated and each code is exactly for one user, they must be random enough so they can't be guessed.


 * Count (required) : The number of times the code can be redeemed. This can be "1" if only one customer should be able to do so or any other positive number. A value of zero disables the coupon code.


 * Start date (optional) : The point in time when this coupon code can be entered by the customer. The date/time has to be in ISO format (YYYY-MM-DD HH:mm:ss) and the hours must be in the range of 0-23.


 * End date (optional) : The point in time when the coupon code will expire. For this field the same format applies as for "Start date".


 * Created (read-only) : Date and time when the coupon code was added. This value is set automatically.


 * Last modified (read-only) : Last date and time when the coupon code was edited. This value is set automatically.


 * Editor (read-only) : Last user who added or modified the coupon code. This value is set automatically.



<< Previous: Coupon overview | Next: Coupon decorators >>