Mageworx Magento Store - Table of Contents...The extension upload 1. Log into the Magento server (or...

Table of Contents

1. Extension Installation Instructions

2. Custom Checkout Fields

3. Extension General Settings

4. Custom Checkout Fields on the Front-end

5. Custom Checkout Fields in Order details

6. Magento API Support

7. Support

The extension upload

1. Log into the Magento server (or switch to) as a user, who has permissions to write to the Magento file system.

2. Download the "Ready to paste" package from your customer's area, unzip it and upload the 'app' folder to your Magento install dir.

Enable the module

1. Log into the Magento server (or switch to) as a user, who has permissions to write to the Magento file system.

2. Go to your Magento install dir:cd <your Magento install dir>

3. Update the database:

php bin/magento setup:upgrade

4. Enable the extension:

php bin/magento module:enable Aitoc_CheckoutFieldsManager

1. Installation Instructions

That is it.

Now you can start using the extension.

2. Custom Checkout Fields

To create or edit a custom checkout attribute, go to System - Extensions - Checkout Fields Manager.

Also the page can be found here: Stores - Attributes - Checkout

2. Custom Checkout Fields

Specify the title of your extra field (will be visible on the front-end)

Choose one of the 9 input types and mark value as a required or optional

2. Custom Checkout Fields

In the Manage Labels section add a title/ description of the field for various Store Views

By default the extension adds the data from custom checkout fields into the HTML Order Confirmation email (when a customer uses standard Magento payment gateways, including PayPal).

Store Admin can add the value and label of custom fields to the plain-text Order Confirmation email. The attribute code is used as XYZ in an example below: {{var cfm.XYZ_label}}:{{var cfm.XYZ}}

2. Custom Checkout Fields

Specify the step when your custom checkout fields should appear .

In the Websites/ Store Views section define the Store View for your custom checkout fields.

3. Custom Checkout Fields (General Settings)

To change general settings, go to Stores - Configuration - Aitoc Extensions - Checkout Fields

Manager

Here you can restrict cart editing on the checkout page and disable cart for customers to instantly

proceed to checkout.

4. Custom Checkout Fields (Front-end View)

An example of how Custom Checkout Fields look on the Payment Info step.

5. Custom Checkout Fields (Order Details)

Customer can see extra fields they filled out in their accounts (available for registered users

only) and in emails.

5. Custom Checkout Fields (Order Details)

Store Admin can check the custom fields data in the Order/Invoice form. To edit this info, click

the Edit link.

Export data provided by customers using Magento API. Retrieving data by SOAP is done via OAuth. Store admin must generate a key in console (SSH).

Here is an example of how to get a key:

Command syntax:

curl -X POST "http://magentohost/index.php/rest/V1/integration/admin/token" -H "Content- Type:application/json" -d '{"username":"user", “password":"password"}'

Example:

curl -X POST "http://example.com/index.php/rest/V1/integration/admin/token" -H "Content- Type:application/json" -d '{"username":"admin", “password":"admin_pass"}'

The result of the command above is a set of symbols, which represents the key. One should use it to initialize the variation $key as in the example below.

6. Magento API Support

The code to retrieve data using SOAP:

$url = 'http://magentohost/index.php/soap/all?wsdl&services=salesOrderRepositoryV1'; $key = 'REPLACE_WITH_YOUR_KEY';$opts = array( 'http'=>array( 'header' => 'Authorization: Bearer ' . $key ));$context = stream_context_create($opts);$client = new SoapClient($url, array('soap_version'=> SOAP_1_2, 'stream_context'=>$context));

// ORDER ID$order = '000000003';$soapResponse = $client->salesOrderRepositoryV1GetList( [ 'searchCriteria' => [ 'filterGroups' => [ 0 => [ 'filters' => [ 0 => [ ‘field' => 'increment_id', ‘value' => $order , 'condition_type' => 'eq' ] ]

] ] ]]);echo json_encode($soapResponse);

GOT QUESTIONS?

Aitoc offers free email support and free updates for 6 months for any extension developed for Magento. Need help with the extensions? Feel free to submit a ticket from https://support.aitoc.com/index.php?/Tickets/Submit

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. Click here to contact us.

7. Support