Customer Credit Magento Extension

Transcript

Customer Credit User Guide Customer Credit MageWorx Important Notice MageWorx reserves the right to make corrections, modifications, enhancements, improvements, and other changes to its products and services at any time and to discontinue any product or service without notice. Customers should obtain the latest relevant information before placing orders and should verify that such information is current and complete. All products are sold subject to MageWorx' terms and conditions of sale supplied at the time of order acknowledgment. MageWorx warrants performance of its products to the specifications applicable at the time of sale in accordance with MageWorx' standard warranty. Testing and other quality control techniques are used to the extent MageWorx deems necessary to support this warranty. Except where mandated by government requirements, testing of all parameters of each product is not necessarily performed. MageWorx assumes no liability for applications assistance or customer product design. Customers are responsible for their products and applications using MageWorx components. To minimize the risks associated with customer products and applications, customers should provide adequate design and operating safeguards. MageWorx does not warrant or represent that any license, either express or implied, is granted under any MageWorx patent right, copyright, mask work right, or other MageWorx intellectual property rights relating to any combination, machine, or process in which MageWorx products or services are used. Information published by MageWorx regarding third-party products or services does not constitute a license from MageWorx to use such products or services or a warranty or endorsement thereof. Use of such information may require a license from a third party under the patents or other intellectual property of the third party, or a license from MageWorx under the patents or other intellectual property of MageWorx. Resale of MageWorx products or services with statements different from or beyond the parameters stated by MageWorx for that product or service voids all express and any implied warranties for the associated MageWorx product or service and is an unfair and deceptive business practice. MageWorx is not responsible or liable for any such statements. All company and brand products and service names are trademarks or registered trademarks of their respective holders. Copyright © 2009-2013 MageWorx User Guide 2 Customer Credit MageWorx Table of Contents 1 Extension Description ………………………………………………………… 5 2 Extension Installation ………………………………………………………… 6 3 Extension Usage ………………………………………………………………… 8 • Settings ……………………………………………………………………. 8 • Recharge Codes ………………………………………………………13 • Manage Customers …………………………………………………. 15 • Reports ……………………………………………………………………..17 • Credit Rules ……………………………………………………………. 18 • Order View …………………………………………………………….. 23 • Import/Export Credits ……………………………………………. 25 • “My Credit” section in a customer’s account ……….. 25 • Share Credits …………………………………………………………….27 • Cart Page ………………………………………………………………… 28 • Checkout …………………………………………………………………. 30 • Multiple Addresses Checkout ….......................... 32 • Credit Units …………………………………………………………….. 32 • Expiration Period ……………………………………………………….34 • Magento SOAP API ………………………………………………………35 4 Support …………………………………………………………………………… 36 User Guide 3 Customer Credit MageWorx 5 Getting Help with Magento ……………………………………………… 37 User Guide 4 Customer Credit MageWorx Extension Description Customer Credit extension raises Magento based stores to a higher level of e-commerce business giving customers a pleasurable possibility to make “free of charge” purchases using money available in the account. The extension can also help to attract additional customer audience with the help of prepaid debit cards, which can be automatically generated by a store admin or a sales manager. All operations and payment activity using Internal Credit balance are being logged for a customer and a store manager convenience. Customer Credit operates as one of Magento payment methods, i.e. “Purchase Order” or “Check/Money order” etc. Customer Internal Credit balance is rechargeable. Money can be loaded either by admin or by store account owner using “Recharge Code”. However, admin has extended functionality for managing customers. He can replenish or charge customer balance and every operation can be additionally commented. On multi website Magento stores admin can manage customer balance independently for each website regardless of different currencies. User Guide 5 Customer Credit MageWorx Extension Installation 1 Disable Compilation Mode if enabled 2 Log out from Magento Admin panel if you are logged in 3 Unpack the contents of the ‘extension’ folder (depending on your current Magento version) from the package file purchased from MageWorx to your Magento root folder 4 Log into Magento Admin Panel 5 If Cache Control is enabled in Magento go to ‘System > Cache Management’ section, select ‘Refresh’ under ‘All Cache’ drop-down menu and press ‘Save Cache Settings’ 6 Run Compilation Mode back if necessary 7 Now go to ‘System > Configuration > MageWorx tab > Extensions & Support’ section. If you see ‘Customer Credit’ in the list of installed MageWorx extensions you are done. Installation to a custom template/theme If you use a custom template or theme you should copy the extension’s layouts, templates and skin files to your custom template or theme. The folders that should be copied: app/design/frontend/default/default/layout/ app/design/frontend/default/default/template/ skin/frontend/default/default/css/ User Guide 6 Customer Credit MageWorx skin/frontend/default/default/images/ You should copy them to app/design/frontend///layout/ app/design/frontend//template/ skin/frontend///css/ skin/frontend///images/ Please note that all these folders already exist in your store and you have to merge them with the folders on your server. Do not overwrite them. User Guide 7 Customer Credit MageWorx Extension Usage Back-end Settings Log into Magento Admin panel and go to ‘System > Configuration > MageWorx tab > Customers > Customer Credit — General Settings’ section to ensure Customer Credit is enabled. User Guide 8 Customer Credit MageWorx • Enable Customer Credit – enables/disables internal balance for customers. • Enable Credits Sharing – enables/disables the ability to share credits between customers (if enabled customers can send the credits to their) User Guide 9 Customer Credit MageWorx • Share Customer Credit – there are two available options: per website or global. It means where customers can use their credits. If “Per Website” option is selected, customers will have different balance for each website. • Hide Customer Credit on the Front-end Until the First Use – hides the functionality of the customer credit unless customer has a positive balance. • Enable Recharge Codes – enables/disables the possibility to use recharge codes. • Invoice Orders Paid by Credits – if enabled, orders fully paid by internal credits will be automatically invoiced. • Enable Partial Credit Payment – enables/disables the possibility to use internal balance along with other payment methods. • Enable Credit Memo Return in Credits – allows you to return internal credits instead of funds in case of offline refunds. • Enable Customer Balance Column in Customers Grid – displays/hides “Customer Balance” column in the grid of customers. This shows available balance of every customer. • Send Notification when Balance is Changed by Admin – if enabled, an email notification is send when admin changes balance of a customer manually. User Guide 10 Customer Credit MageWorx • Display Credit Block at Cart page – displays/hides the credit block at cart page, where customers can see their available balance and use credits directly from this page. • Static Block for “My Credit” section – you can assign a static block, which will be shown at “My Credit” page in a customer’s account. • Credit Product – the drop-down that allows you to select any virtual product, which will be used for purchasing credits using other payment methods. See more details at page… • Default Qty of Credit Units – number of Qty of Credit Units, which your customers will see in “My Credit” section by default. • Assign to Customer Groups – assigns customer credit functionality to selected customer groups. If not selected, customers won’t be able to use internal credits at all. • Sent Email Copy to – you can enter emails addresses to receive a copy of notifications about internal balances updates. Configure default Recharge Codes settings in the ‘Customer Credit — Recharge Codes Settings’ subsection User Guide 11 Customer Credit MageWorx • Code Length — number of characters in a Recharge Code • Character Group Length — number of characters in a group of characters separated by Character Group Separator • Code Format — characters used to generate Recharge Codes • Enable Expiration Date — enables/disables expiration period for customer credits; • Default Expiration Period (days) – here you can specify an expiration period in days; • Update Current Expiration Dates if Default Expiration Period is Changed – this setting determines whether current User Guide 12 Customer Credit MageWorx customers’ balances will be updated if admin changes a default period or not; • Notify Customers about Expiration Date – here you can specify a period in days when customers should be notified about expiration date; Recharge Codes Recharge codes are used to refill customers’ balances. The codes are created by admin and sent to customers to be applied in their accounts at the site. You can see a list of the codes in ‘Promotions – Recharge Codes’: To generate a set of Recharge Codes go to ‘Promotions > Recharge Codes’ section and click ‘Generate New Recharge Codes’ button. Under the ‘Settings’ tab modify or leave default settings as is User Guide 13 Customer Credit MageWorx Under the ‘Details’ tab enter ‘Credit Value’, choose website, select activity status and period If you need to import the codes from some other system just click on “Import Codes” button. You will be able to upload a CSV file there. If you are not sure how the CSV file should be formatted, you can download a sample file at the same page: User Guide 14 Customer Credit MageWorx You can also import recharge codes from ‘System – Import/Export – Recharge Codes Import’ section. Manage Customers Customer’s internal balance can be displayed directly from customers’ grid at Manage Customers page. This column can be displayed/hidden based on the setting in the extension: You can filter customers by available credit amount if necessary. To add funds to or deduct from a customer Credit balance go to ‘Customers > Manage Customers‘ section, choose the desired customer account and open Internal Credit tab User Guide 15 Customer Credit MageWorx All the credits actions are logged in the Activity Log section for every customer: User Guide 16 Customer Credit MageWorx Reports Since v2 Customer Credit provides you a complete report for all actions with internal credits in the system. You can find the report in Reports – Customer Credit: This report displays all the details about every credit activity: - Modifying a customer’s balance by admin - Applying of a credit rule - Using of a recharge code - Sharing credits between customers - Canceling or refunding orders paid using the internal credits - Credits expiring You can also see how much credit in the system how much credit were used and how many customers with credits are at your store: User Guide 17 Customer Credit MageWorx The credit report displays a staff, which modified customers’ balances. It can be useful to track the activity of your staffs. You can filter by this name to find all activities of a specific staff. Credit Rules Customer Credit extension allows you to create the rules to give credits to customers automatically based on specific conditions. Thus, you can easily give the credits to every new customer, when customers get certain amount purchased (overall orders numbers) or when customers purchase particular products. All this can be done on Promotions – Credit Rules page You can see how many times each rule was used. To create a new rule, you should click on “Add new Credit Rule” button. You will see 3 tabs there. The 1st one is “Rule Information” tab: User Guide 18 Customer Credit MageWorx • Rule Name – the name of the rule you are creating. It will be visible in the back-end and in the front-end in customer’s log when it’s actually triggered. User Guide 19 Customer Credit MageWorx • Description – the description of the rule. It’s visible only in the back-end. • Status – the status of the rule (active/inactive). • Type – a type of a rule. It can be “Apply Credit” or “Give Credit”. “Apply Credit” creates a rule for applying internal credits to specific products. “Give Credit” creates a rule for adding credits to customers based on specific conditions. • Websites – the website where the rule should be applied. • Customer Groups – the rule will be applied to the customers of these groups only. The “Conditions” tab includes all available conditions you can use for credit rule. There are 3 types of conditions: Customer Attributes (Purchased Amount, Registration Date and Customer’s Birthday), Customer Actions (Review product, Tag product, Signup for Newsletter and Facebook Like) and Product Attributes (all available attributes in your Magento store). For example, with “Customer Actions” you can setup a rule for adding credits for specific amount of reviews, tags, FB Likes or when a customer signups for a newsletter. Thus, you will be able to reward your customers for their activities. “Customer Attributes” conditions allow you to create the rules to give credits to every new customer or when customers get certain amount purchased (it calculates the sum of all customer’s orders)). User Guide 20 Customer Credit MageWorx “Product Attributes” conditions allow you to give credits for purchases of specific products only. Thus, you can motivate your customers to order appropriate products by giving credits for them. In the “Actions” tab you can specify the amount of credits, which will be added when this rule is triggered and mark the rule as onetime or not. If you select a one-time flag to a rule, it means that this rule will be applied only once per a customer. For example, customer will receive $100 in credits only for one purchase of your product. If you need to give the credits based on the rule unlimited number of times per a customer, you should select “No” for “One-time” option. Example: you create a rule for Nokia cell User Guide 21 Customer Credit MageWorx phone. Each time a customer purchases this product, he/she will receive the credits. With enabled One-time option, he/she will receive the credits only after the 1st purchase. All other purchases of this product will be ignored. Qty dependent rules (if you create a rule to reward your customers with credits for purchasing a specific product, then bonus credits can be multiplied to the ordered quantity of these products. Example: you create a rule to give 100 for purchase a mobile phone. If a customer purchases 3 mobile phones, he will get 300 credits. This setting can be enabled or disables) Note: Customers receive credits once the order is completed. Note: Actions section is applicable when “Give Credit” is selected as a rule’s type. How to allow purchasing specific products for credits “Apply Credit” type of credit rules allows you to separate products that can be purchased by credits. For example, you can setup a rule, which will specify that customers can purchase products from a specific category for internal credits and they won’t be able to purchase other products for the internal credits. User Guide 22 Customer Credit MageWorx How to reward customers with a % from an order’s total “Credit Amount” field supports the % symbol. If you need to create a rule, which will reward your customers with a % from an order’s total, you should put the % to the credit amount: 10% The system will parse this value correctly and will calculate 10% from an order and refill a customer’s balance with correct amount once the order is completed. Orders View Internal Credit amount is deducted from the order total decreasing Grant Total. Example of how internal credits are shown in the order view: Payment Information User Guide 23 Customer Credit MageWorx Order Total You can also use credits when processing offline refunds. Now it’s possible to give internal credits to customers instead of refund funds. Just specify the amount of credits you need to return: Note: amount of credits are filled in automatically to make your life easier !. You can still edit this amount if necessary. User Guide 24 Customer Credit MageWorx Import/Export credits Since v1.3.0 you can import/export customers’ balances via CSV. To know how to import balances for customers, you can export them first. Go to System – Import/Export – Dataflow Profiles – choose “Export Customers” profile – Run this profile. Open the result CSV file. You see “credit_balance” column. In order to import customers’ balances you should create CSV file and upload it in System – Import/Export – Dataflow Profiles – select “Import Customers” profile – go to “Upload File” tab – select certain file and upload it – Run profile from “Run Profile” tab. You can fill “credit_balance” column in following the rules: • credit_balance = 100 – it updates customer’s balance with “100” value; • credit_balance = 100+ - it adds 100 to current customer’s balance; • credit_balance = 100- - it deducts 100 from current customer’s balance; Front-end “My Credit” section Customers can refill their Credit Balance in the ‘My Credit’ section under a user account using Recharge Codes or purchase Credit Units using other payment methods. User Guide 25 Customer Credit MageWorx Customer will see the Order ID and the rule name (if applied) based on which the credits are added. Customers will also see when the credits are modified by admin or deducted because of order cancellation or refund. It’s also possible to display a static block on “My Credit” page. For this you need to select an appropriate static block in the extension’s settings. Example: User Guide 26 Customer Credit MageWorx Share Credits Now your customers can share their credits with their friends. They can create the codes for specific amount of credits and send these codes to any one. A customer, who received this code, can apply it in the customer’s account and receive the credits to the internal balance. Customer, who created the code, can remove it only if this code wasn’t used yet. In this case, the credits are returned back to a customer’s account. Creating the codes, applying and removing actions are logged in customers’ logs and in the report in the back-end. User Guide 27 Customer Credit MageWorx Cart Page Customers can apply credits directly from a cart page. Our extension adds “Payment with Credit” block. Available balance is shown there along with the button to use credits for an order. Note: if customer’s balance is not enough to fulfill the order, he will see “Get Credit” button, which will lead to “My Credit” section in customer’s account, where customer will be able to receive credits. User Guide 28 Customer Credit MageWorx If customer uses credits here, they will be deducted from order total: If customer wants to cancel this action, he should click on “Don’t use credit”. This will removed applied credits from totals. Note: the credits block in the cart is developed the way to create minimal conflicts with custom templates and 3rd party extensions. User Guide 29 Customer Credit MageWorx Checkout Internal Credit is available as a payment method during the checkout process: “Recharge” link leads to “My Credit” section in customer’s account. Thus, customers always know how to recharge his internal balance. If customer has internal credits and “Partial payments” setting is enabled, customers can use credits with other payment methods together. It’s useful if credits are not enough to pay for the whole order. In this case customers will pay the difference between order’s total and amount of credits with other payment method. Please note that with enabled Partial Payments, the extension automatically detects credit amount and gives the possibility to use credits only or credits + other payment method. Thus, we recommend keeping this extension enabled. User Guide 30 Customer Credit MageWorx Since 1.4.0 it’s possible to select what checkout attribute the credits should applied to. You can select Subtotal, Shipping & Handling and Tax: The system analyses this selection and applies credits to what is chosen here. For example, if you do not want to allow your customers to pay shipping costs using credits, you can just to remove the selection from “Shipping & Handling” in this setting and the credits will ignore the costs of shipping. I.e. customers will need to pay for them using other payment method. User Guide 31 Customer Credit MageWorx Multiple Addresses Checkout Customer Credit extension supports Multi-shipping checkout. You can pay the whole order using internal credits or use partial payment if necessary: Credit Units Since v1.4.0 Customer Credit extension allows creating virtual products that can be used to sell internal credits for real money. To quickly create such product, we recommend using “Create Product” button in the extension’s setting. It will create a virtual product with default settings and automatically select it as a credit product for your usage. If you want to edit it, you can go to edition page by clicking on “Edit” button in the extension’s settings or find it in Catalog – Manage Products – edit: User Guide 32 Customer Credit MageWorx Customers can purchase any amount of internal credits. They should just enter necessary quantity in “Qty of Credit Units” field in “My Credit” section in customer’s account and add this product to cart. Further checkout process will be standard as for all virtual products. Customer receives the credits once the order is completed. You can edit this product as you want or select another product at all. By default, Credit Unit product is created with the price $1.00 and visibility “Not Visible Individually”. You can turn this product in a promotional product, which will be visible on the front-end. How to handle conversation between credits and your currency. Since Credit Unit is created as a standard product, you can easily change the price of it. This will change the ratio between 1 credit and 1 dollar, for example. By default, the price is $1. It means that for $1 customer receives 1 credit. If you change the price to $10, it will mean that customer will receive 1 credit for $10. Thus, playing with Credit Unit price, you change the cost of 1 credit for your customers. User Guide 33 Customer Credit MageWorx Expiration Period for Credits Since the v2.3.0 you can limit a period when customers can use their credits. To enable this you should enable the setting “Enable Expiration Date” in ‘System – Configuration – MAGEWORX – Customers – Customer Credit – Expiration Date’. Please note that once you enable this setting, it won’t add the expiration period for all current balances. You can setup a default expiration period in “Default Expiration Period” setting. If the expiration period is set, customers and admin will see a number of days the credits will be expired in: User Guide 34 Customer Credit MageWorx You can also specify a number of days to notify customers about expiration date. By default it’s set to 2 days. It means that customers will receive a reminder about expiration date when 2 days are left. You can easily change this number of days. Email template can be easily edited in the app/locale/ folder. Magento SOAP API Customer Credit v2 supports updating customers’ balances via Magento SOAP API and SOAP API v2. It’s possible to generate recharge codes via API too. MageWorx_CustomerCredit_Model_Api is the model responsible for this. API code example: Connect to API: url = 'http://'.$_SERVER['HTTP_HOST'].'/api/v2_soap/?wsdl=1'; $client = new SoapClient($url, array('cache_wsdl' => WSDL_CACHE_NONE)); //array('cache_wsdl' => WSDL_CACHE_NONE) - optional $session = $client>login($login, $pass); $client->customerCreditList($session); // getting the complete list of credits out of the base (return array()) $client->customerCreditGetcredit($session,5); // getting credits for a customer with ID=5 (return float()) $client->customerCreditSetcredit($session,5,10); // replace the customer's (ID=5) current credit with value of 10 (return bool()) $client->customerCreditIncrcredit($session,5,123); // increase the customer's (ID=5) current credit up to 123 (return bool()) $client->customerCreditDecrcredit($session,5,17); // decrease the customer's (ID=5) current credit to 17 (return bool()) User Guide 35 Customer Credit MageWorx Support MageWorx offers FREE lifetime support and updates for any extension developed for Magento. If you need support related to MageWorx extension usage, feel free to contact us at [email protected] Please check our knowledgebase before submitting a ticket: http://support.mageworx.com/index.php?/Knowledgebase/List/In dex/16/customer-credit Or send us a message directly from your Magento Admin Panel. To do it, go to ‘System > Configuration’ section, ‘MageWorx’ tab ‘Extensions & Support > Get Support’. User Guide 36 Customer Credit MageWorx Getting Help with Magento MageWorx offers outstanding services developing custom tailored solutions for Magento platform to attain your eCommerce objectives. Our professional impassioned team provides profound and custom oriented development of your project in a short timeframe. You are most welcome to contact us at [email protected] User Guide 37