X-Cart:Gift Certificates - Revision history

Dohtur: /* Enabling and Configuring 'Gift Certificates' */

2012-10-15T11:49:02Z

‎Enabling and Configuring 'Gift Certificates'

Dohtur: /* Roles in Gift Certificates module management */

2012-10-15T11:39:13Z

‎Roles in Gift Certificates module management

Vladimir Gurinenko: Added version tags

2011-11-02T09:19:18Z

Added version tags

Piligrim: /* Gift Certificate Templates */

2011-01-11T12:22:51Z

‎Gift Certificate Templates

Ivka: /* What Gift Certificates module does */

2010-09-09T09:46:32Z

‎What Gift Certificates module does

Admin: /* Gift Certificate Templates */

2010-01-28T06:01:53Z

‎Gift Certificate Templates

Admin: /* Deleting gift certificates */

2010-01-28T05:59:40Z

‎Deleting gift certificates

Admin: /* Managing Gift Certificates */

2010-01-28T05:58:40Z

‎Managing Gift Certificates

Admin: /* Creating Gift Certificates */

2010-01-28T05:38:38Z

‎Creating Gift Certificates

Admin: /* Creating Gift Certificates */

2010-01-28T05:38:13Z

‎Creating Gift Certificates

← Older revision		Revision as of 11:49, 15 October 2012
Line 50:		Line 50:

	==Enabling and Configuring 'Gift Certificates'==		==Enabling and Configuring 'Gift Certificates'==
		+
		+	<u>Gift Certificates</u> is available as a built-in module in all X-Cart editions. It does not require installation and can be enabled in the <u>Modules</u> section of X-Cart Admin area.

	To begin using the module:		To begin using the module:

@@ Line 33: / Line 33: @@
 == Roles in Gift Certificates module management ==
-If you are an X-Cart GOLD administrator/provider or an X-Cart PRO administrator:
+If you are an X-Cart GOLD or GOLD PLUS administrator/provider or an X-Cart PLATINUM or PRO administrator:
 * You can enable/disable and configure the module <u>Gift Certificates</u> (See [[#Enabling and Configuring 'Gift Certificates']]).

@@ Line 258: / Line 258: @@
 ** The name of a design template file for a gift certificate must include the prefix '<u>template_</u>' and end in <u>.tpl</u>; for example, <u>template_certificate1.tpl</u>.
 ** (If you use CSS files) The name of a CSS file must be identical to the name of the template file for which it is used in all but the file extension (the CSS file must end in <u>.css). F</u>or example, for a file named <u>template_certificate1.tpl</u>, the CSS file must be named <u>template_certificate1.css</u>.
 For the older versions of X-Cart, the predesigned templates are stored in the directory <u>/skin1/modules/Gift Certificates</u>.

@@ Line 249: / Line 249: @@
-Alternatively, you can create your own custom templates, or, at least, make some changes to the pre-designed ones. If you decide to customize the gift certificate templates at your store, you should know the following:
+Alternatively, you can create your own custom templates, or, at least, make some changes to the pre-designed ones. If you decide to customize the gift certificate templates at your store, keep in mind the following:
-* The pre-designed templates <u>template_sample_1.tpl</u> and <u>template_sample_2.tpl are stored </u>in the directory <u>/skin1/modules/Gift Certificates</u>. It is the directory where X-Cart looks for gift certificate templates. If you create your own templates for gift certificates, you must put them into this directory. As soon as you add a design template file to the directory <u>skin1/modules/Gift Certificates</u>, it becomes available for selection from the '<u>Template</u>' field of the '<u>Gift Certificate details</u>' dialog box.
+{{XC_4.4}}
-* If you wish, you can use external style sheets for your gift certificates. External style sheets for gift certificates must also be stored in the directory <u>/skin1/modules/Gift Certificates</u>. The pre-designed gift certificate templates <u>template_sample_1.tpl</u> and <u>template_sample_2.tpl</u> use the CSS files <u>template_sample_1.css</u> and <u>template_sample_2.css </u>respectively.
 * To enable X-Cart to use your custom files for gift certificates, you must adhere to the following file naming conventions:
 ** The name of a design template file for a gift certificate must include the prefix '<u>template_</u>' and end in <u>.tpl</u>; for example, <u>template_certificate1.tpl</u>.
 ** (If you use CSS files) The name of a CSS file must be identical to the name of the template file for which it is used in all but the file extension (the CSS file must end in <u>.css). F</u>or example, for a file named <u>template_certificate1.tpl</u>, the CSS file must be named <u>template_certificate1.css</u>.
 [[Category:X-Cart user manual]]
 [[Category:X-Cart modules]]

← Older revision		Revision as of 09:46, 9 September 2010
Line 24:		Line 24:

	: [[Image:gc6.gif\|679px]]		: [[Image:gc6.gif\|679px]]
		+
		+	When a gift certificate is used to pay for an order, the gift certificate's amount is changed accordingly. If the order, paid by a gift certificate, is declined by the store admin, the order total amount is returned to the gift certificate and its amount is restored.

	Any holder of a gift certificate has the ability to check the current amount and status of his or her gift certificate by using X-Cart's gift certificate verification service. The remaining balance and the status of a gift certificate can be found out at any time by entering the certificate code into the '<u>Gift certificate verification</u>' form.		Any holder of a gift certificate has the ability to check the current amount and status of his or her gift certificate by using X-Cart's gift certificate verification service. The remaining balance and the status of a gift certificate can be found out at any time by entering the certificate code into the '<u>Gift certificate verification</u>' form.

@@ Line 235: / Line 235: @@
 When you click on '''Delete selected''', the selected certificates are deleted.
-Gift certificates created by customers cannot be deleted using the '<u>Gift certificates</u>' section (You will notice that the check boxes next to such certificates are disabled). To delete a gift certificate created by a customer, you will need either to delete the order by which this gift certificate was purchased or to remove the gift certificate from the order using X-Cart's <u>X-AOM</u> add-on module.
+Gift certificates created by customers cannot be deleted using the '<u>Gift certificates</u>' section (You will notice that the check boxes next to such certificates are disabled). To delete a gift certificate created by a customer, you will need either to delete the order by which this gift certificate was purchased or to remove the gift certificate from the order using [[X-Cart:Advanced Order Management|X-AOM]] module.
 ==Gift Certificate Templates==

← Older revision		Revision as of 05:58, 28 January 2010
Line 163:		Line 163:

	==Managing Gift Certificates==		==Managing Gift Certificates==
		+
		+	Gift certificates can be managed using the '<u>Gift Certificates</u>' section of the store's Admin area (<u>Management menu->Gift certificates</u>). This section provides a list of all the gift certificates in your store:
		+
		+	: [[Image:gc3.gif\|589px]]
		+
		+	{{Note1\|Note: By default, this section does not show expired gift certificates. If you wish expired gift certificates to be shown in this section, enable the option 'Show expired Gift Certificates' in General settings/Modules options->Gift certificates options.}}
		+
		+	For each of the gift certificates in the list, the following information is available:
		+
		+	* ORDER: The ID of the order by which the gift certificate was purchased ('n/a' for gift certificates created by the store administrator, as no order is created when a gift certificate is created in the Admin area).
		+	* GIFTCERT ID: A unique identification code assigned to the gift certificate at the time of creation (the code which the gift certificate owner can enter on checkout to redeem the gift certificate).
		+
		+	{{Note1\|Tip: Clicking on the ID of a gift certificate displays the details of the gift certificate.}}
		+
		+	* TYPE: The type of the gift certificate ('Mail' - for a gift certificate meant for sending by postal mail, 'email' - for a gift certificate meant for sending by email).
		+	* STATUS: The current status of the gift certificate.
		+	** Pending - a status automatically assigned to a gift certificate after the order by which the gift certificate is purchased gets placed or after the gift certificate is created by the store administrator.
		+	** Active (the only status with which a gift certificate can be redeemed) - a status automatically assigned to a gift certificate after the order containing this gift certificate gets Processed (In cases when the gift certificate is created by the administrator, the status Active must be assigned to a gift certificate manually).
		+	** Blocked - a status automatically assigned to a gift certificate created as a result of a redemption attempt made during a blocking period.
		+	** Disabled - a status which can be assigned to a gift certificate in order to make its redemption temporarily unavailable.
		+	** Expired - a status which can be assigned to outdated gift certificates (to prevent their future usage).
		+	** Used - a status automatically assigned to any gift certificate after it gets redeemed.
		+	* REM./AMOUNT: The balance on the gift certificate. The first number shows the amount of money currently remaining on the gift certificate, the second one shows the amount for which the gift certificate was issued.
		+	* ADDED: The name of the gift certificate sender + the date and time when the gift certificate was created.
		+
		+	===Viewing/editing gift certificate details===
		+
		+	If necessary, you can view/edit the details of any gift certificate in your store.
		+
		+	To view/edit the details of a gift certificate:
		+
		+	# Find the gift certificate whose details you wish to edit in the '<u>Gift Certificates</u>' section and click on its ID. The gift certificate details will be opened for viewing/modification.
		+	# Change all the necessary details in the '<u>Gift Certificate details</u>' form.
		+	# Click the Update Gift Certificate button.
		+
		+	When you click on '''Update Gift Certificate''', the gift certificate is updated.
		+
		+	=== Changing gift certificate statuses ===
		+
		+	If needed, you can manually change the statuses of your gift certificates.
		+
		+	To change the status of one or more gift certificates:
		+
		+	# Find the gift certificates whose statuses need to be changed in the '<u>Gift Certificates</u>' section.
		+	# Select the desired statuses from the drop-down boxes in the STATUS column.
		+	# Click the '''Update''' button.
		+
		+	When you click on '''Update''', the statuses are updated.
		+
		+	=== Printing gift certificates ===
		+
		+	To send gift certificates by mail, you first need to print them. It is possible to print only those gift certificates for which the delivery method has been specified as 'Send via Postal Mail'. You cannot print gift certificates for which the delivery method has been specified as 'Send via email'.
		+
		+	To print one or more gift certificates:
		+
		+	# Find the gift certificates you wish to print in the '<u>Gift Certificates</u>' section.
		+	# Select these certificates for printing by selecting their check boxes.
		+	# Click the '''Print selected''' button.
		+
		+	This opens the selected gift certificates in new browser windows. Now you can print the gift certificate page(s).
		+
		+	=== Deleting gift certificates ===
		+
		+	The controls of the '<u>Gift certificates</u>' section allow you to delete gift certificates created by the store administrator.
		+
		+	To delete one or more gift certificates:
		+
		+	# In the '<u>Gift Certificates</u>' section, find the gift certificates you wish to delete.
		+	# Click the '''Delete selected''' button.
		+
		+	When you click on '''Delete selected''', the selected certificates are deleted.
		+
		+	Gift certificates created by customers cannot be deleted using the '<u>Gift certificates</u>' section (You will notice that the check boxes next to such certificates are disabled). To delete a gift certificate created by a customer, you will need either to delete the order by which this gift certificate was purchased or to remove the gift certificate from the order using X-Cart's <u>X-AOM</u> add-on module.

	==Gift Certificate Templates==		==Gift Certificate Templates==

@@ Line 135: / Line 135: @@
 . Go to the <u>Gift certificates</u> section of the store Admin area (<u>Management menu->Gift certificates</u>). You should see a dialog box titled '<u>Gift certificates</u>'. This dialog box is a place where you can see all the gift certificates in your store (The list may be empty if no gift certificates have been created):
 : [[Image:gift_certificates0.gif|532px]]
 . Click the '''Add new''' button at the bottom of the '<u>Gift Certificates</u>' dialog box. This should open a form titled '<u>Gift Certificate</u> <u>details</u>':
 : [[Image:gc2.gif|532px]]
 . Complete the '<u>Gift Certificates details</u>' form:

← Older revision		Revision as of 05:38, 28 January 2010
Line 129:		Line 129:

	==Creating Gift Certificates==		==Creating Gift Certificates==
		+
		+	Normally, gift certificates are created by customers in the Customer area. However, there may be situations in which the store administrator might need to create a gift certificate. This can be done directly in the Admin area.
		+
		+	To create a gift certificate:
		+
		+	1. Go to the <u>Gift certificates</u> section of the store Admin area (<u>Management menu->Gift certificates</u>). You should see a dialog box titled '<u>Gift certificates</u>'. This dialog box is a place where you can see all the gift certificates in your store (The list may be empty if no gift certificates have been created):
		+
		+	: [[Image:gift_certificates0.gif\|532px]]
		+
		+	2. Click the '''Add new''' button at the bottom of the '<u>Gift Certificates</u>' dialog box. This should open a form titled '<u>Gift Certificate</u> <u>details</u>':
		+
		+	: [[Image:gc2.gif\|532px]]
		+
		+	3. Complete the '<u>Gift Certificates details</u>' form:
		+
		+	* <u>From</u>: Name of the person or company on whose behalf you are sending the gift certificate.
		+	* <u>To</u>: Name of the gift certificate recipient.
		+	* <u>Message</u>: A message to be sent along with the gift certificate (will be included into the gift certificate).
		+	* <u>Specify the amount in currency</u> [Currency]: Amount for which you want the gift certificate to be issued.
		+	* <u>Send via email/Send via Postal Mail</u>: Method by which you wish the gift certificate to be sent to the recipient (Depending on the selected option, provide an email address or a postal address of the gift certificate recipient. For a gift certificate that will be sent by postal mail, select a [[#Gift Certificate Templates\|design template]] from the '<u>Template</u>' drop-down box).
		+
		+	{{Note1\|Note: The 'Template' drop-down box appears at the bottom of the 'Send via Postal Mail' section only when sending by postal mail is selected as a delivery method.}}
		+
		+	4. Preview the gift certificate: click the Preview link at the bottom of the the '<u>Gift Certificates details</u>' form.
		+
		+	5. Click the Create Gift Certificate link at the bottom of the '<u>Gift Certificates details</u>' form. The gift certificate should be added to the list of gift certificates with the status Pending. You should see an information box with a confirmation message.
		+
		+	6. Activate the gift certificate by changing its status to '''Active'''.

	==Managing Gift Certificates==		==Managing Gift Certificates==