Checkout Fields Manager User Manual for Magento
Table of Content 1. Enabling the extension in Magento. 2. Adding a custom checkout attribute. 3. Front-end view. 4. Custom checkout fields in Order details. 5. Orders grid options. 6. Magento API Support.
1. Enabling the extension in Magento In System > Manage Modules, check Checkout Fields Manager and click "Save modules settings" on the top right.
Click New Attribute to add a new checkout attribute, or click an existing attribute to edit it. System > Checkout Attributes
The extension adds the info from custom fields into the HTML Order confirmation e- mail by default (when the customer uses standard Magento payment gateways, including PayPal). The admin can add the label and the value of a custom field to the plain-text order confirmation email. The attribute code is used as XYZ in example below {{var cfm.xyz_label}}:{{var cfm. XYZ}}. If you use a dropdown, you can enable 'Add default "Please Select" option'. Please Select replaces the value selected by default in the dropdown. When this setting is enabled, customers won't be able to continue checking out until they choose an option other than "Please Select". System > Checkout Attributes - Edit an Attribute
Once you fill out all the necessary fields in the Properties tab, go to Manage Label/ Options to add a title and a description for your new field. The extension supports the following input types for attributes: Text Field, Text Area, Date, Yes/No, Multiple Select, Dropdown, Checkbox and Radio Button. Specify at which checkout step your custom attribute should be displayed. The setting is specified separately for One-Page & Multi-Address checkout. System > Checkout Attributes - Edit an Attribute
Put custom fields onto the Orders grid (except for the Date field, since it already exists in default Magento grid). Add a new export option to standard Magento export options in the Orders grid, so that you can export custom fields data in.csv or.xls. System > Checkout Attributes - Edit an Attribute
Choose "Yes" if you want to use the custom attribute on your customer registration page, too. Additional options for the "Attribute Placeholder" and "Position in Placeholder" will appear. Checkout Fields Manager lets you automatically pre-fill custom checkout fields with the information entered to custom registration fields. System > Checkout Attributes - Edit an Attribute
The description you enter will be displayed under the field on the checkout page. Use it to point your customers in a particualr direction, if you wish. This is not a required field. System > Checkout Attributes - Edit an Attribute
Here you can specify your own title for the Please Select option. System > Checkout Attributes - Edit an Attribute
If "Global" is checked (it is by default), the attribute will be displayed in all Store Views of all Websites (both current and future ones). System > > Checkout Import/Export Attributes > Dataflow - Edit an - Profiles Attribute
For the new checkout attribute to appear only in a specific Store View of a Website, uncheck "Global" and "All store views of the website" and select the required Store View(s). System > Checkout Attributes - Edit an Attribute
Choose which Customer Group(s) should be shown your custom field. System > Checkout Attributes - Edit an Attribute
Show a custom field when a product from a specific category is ordered. System > Checkout Attributes - Edit an Attribute
Show a custom field when a specific product is ordered. System > Checkout Attributes - Edit an Attribute
3. Front-end view An example of what a custom attribute looks like on a one-page checkout form.
4. Custom checkout fields in Order details Your customers will be able to see the extra feilds they filled out in their Magento account (registered users only) and email.
4. Custom checkout fields in Order details The custom data provided by a client is visible to admin in the Order/Invoice form. Click Change to edit these data. If admin edits custom data in an Order, the Order is not cancelled, nor is another Order created.
5. Orders grid options Export custom fields from the Orders grid along with regular Magento fields in.csv or.xls. Export data from selected custom fields matched with Order IDs to.xls. Add custom fields to the Orders grid. Filter Orders by custom fields (except for Date) Sort Orders by custom fields (except for Date, checkbox or multiselect).
6. Magento API Support You can export the data provided by customers using Magento API. We add data entered via our extension to the following Magento objects: sales_order.list sales_order.info Please find below an example of how to retrieve an order data using the API: // SOAP v1: $client = new SoapClient('http://example.com/api/?wsdl=1'); $order = '100000001'; $session = $client->login('apiuser', 'apikey'); $return = $client->call($session, 'sales_order.info', array($order)); echo '<pre>'.print_r($session,1).'</pre>'; echo '<pre>'.print_r($return,1).'</pre>'; // SOAP v2: $client = new SoapClient('http://example.com/index.php/api/v2_soap?wsdl=1'); $order = '100000001'; $session = $client->login('apiuser', 'apikey'); $return = $client->salesorderinfo($session, $order); $client->endsession($session, $order); echo '<pre>'.print_r($session,1).'</pre>'; echo '<pre>'.print_r($return,1).'</pre>'; // SOAP v2 + WSI: $client = new SoapClient('http://example.com/api/v2_soap?wsdl=1'); $order = '100000001'; $session = $client->login((object)array('username'=> 'apiuser', 'apikey' => 'apikey')); //with WS-I $return = $client->salesorderinfo((object)array('sessionid'=> $session->result, 'orderincrementid' => $order)); $client->endsession((object)array('sessionid'=> $session->result, 'orderincrementid' => $order)); echo '<pre>'.print_r($session,1).'</pre>'; echo '<pre>'.print_r($return,1).'</pre>'; * WS-I works only without index.php in hostname * WSDL works only with index.php The data can also be retrieved within sales_order.list.
Brought to you by You can purchase Checkout Fields Manager at www.aitoc.com/en/magentomods_checkoutfieldsmanager.html For questions please email at sales@aitoc.com