ClearSale Magento 2
Installation Guide

These instructions will guide you through installing ClearSale’s extension for your Magento 2 store.  You will need admin access to your Magento project directory (SSH access)

If you need any help installing this module, please contact us at

Install the Module Utilizing Composer

Before installing, we advise you to:

  • Backup your database
  • Enable maintenance mode

To install using composer you must:

  1. 1

    Get ClearSale from the Magento Marketplace (add it to your purchased modules)

  2. 2

    Retrieve the extension’s Composer name and version

  3. 3

    Retrieve your authentication keys

  4. 4

    Update the composer.json file

  5. 5

    Confirm the installation

  6. 6

    Enable the extension

Get ClearSale from the
Magento Marketplace

  1. 1

    Search for ClearSale’s Magento 2 module in the Magento Marketplace.

  2. 2

    Add it to your account.


Retrieving the Extension’s
Composer Name & Version

  1. 1

    Log into Magento Marketplace

  2. 2

    Go to your profile and in the upper-right corner, click on Your Name > My Profile

  3. 3

    Click on My Purchases

  4. 4

    Under the ClearSale’s extension, click on Technical Details

  5. 5

    Copy and save the Component Name and Component Version


Retrieving Authentication Keys

  1. 1

    Go to your profile and in the upper-right corner, click on Your Name > My Profile

  2. 2

    Click on Access Keys under the Marketplace tab.

  3. 3

    If you don’t have any keys yet, you can click on Create a New Access Key to create new keys for development. Otherwise, copy and save the access keys.


Updating the composer.json File

This section requires SSH access to your Magento 2.x installation directory. (For details, contact your hosting provider or system administrator)


Navigate to your Magento project directory and update the composer.json file to require ClearSale. (Run the command below)

$ composer require <component-name>:<version>

For example,

$ composer require clearsale/integration:2.7.2


Enter the authentication keys. The public key will be the username and the private key will be the password.


Wait for Composer to complete the task and confirm that no errors were encountered.

Verify the Extension


To verify the extension was installed properly, run the command below.

$ bin/magento module:status


If the extension does not appear, try to recompile your Magento project.

$ bin/magento setup:upgrade

$ bin/magento setup:di:compile

$ bin/magento cache:clean

NOTE: After installing the module, remember to disable maintenance mode if it was previously enabled.

Configuring the Extension

Once the ClearSale extension is installed, you can configure its settings. The settings can be found in your installed apps.

To fully configure ClearSale, you must have already received your integration credentials.

  1. 1

    Set the Enabled field to Yes.

  2. 2

    Insert your ClearSale credentials (API Key, Client ID, and Client Secret).

  3. 3

    If you would like to test the module before sending real orders, you can set the Environment field to Sandbox. Otherwise, you can set it to Production.

  4. 4

    Set the Analysis Location to USA.

  5. 5

    In the Payment Methods to Send section, please select the payment method(s) you would like to have analyzed by ClearSale.

  6. 6

    Statuses to send section, please select the status(es) you would like to have analyzed by ClearSale.

  7. 7

    Select the desired order status for each ClearSale stage or response:

    1. a

      Analyzing ClearSale – ClearSale is analyzing this order.

    2. b

      Approved ClearSale – ClearSale approved this order.

    3. c

      Denied ClearSale – ClearSale was unable to establish contact and/or received an invalid document. These orders should not be fulfilled.

    4. d

      Canceled ClearSale – ClearSale found suspicion for fraud and the order should not be fulfilled. This status can also reflect the merchant manually cancelling the order.

  8. 8

    If you would like the ClearSale module to keep a log for future troubleshooting, please set Enable Transaction Log to Yes. The log files can be found in your Magento project’s directory in /var/log


Customer Service – For questions related to order analysis and requests.

Technical Support – For general technical inquiries regarding the module / functions.

Integration Support – For questions related to the initial setup and use of the module.

ClearSale reviews by G2