Skip to main content

Clover Installation Instructions

Install the Clover integration to iPaaS.com

Updated today

Before You Begin

Before starting installation, you need to obtain the information you will use when installing the Clover Subscription. These settings are necessary to authenticate the iPaaS.com connection to Clover. You need the following settings:

  • Merchant ID

  • Order Tax ID

  • Order Type ID

  • Employee ID

  • API Key

Merchant ID

You can find the Merchant ID inyour Clover administrative URL. Log in to your Clover account and find the Merchant ID at the end of the URL:

Order Tax ID

The Order Tax ID is used as the tax type on transaction lines uploaded by iPaaS. Tax IDs are not displayed in the Clover administrative interface.

To retrieve the Order tax ID:

  1. Open a browser page to

    https://sandbox.dev.clover.com/v3/merchants/<MERCHANT ID>/tax_rates, replacing <MERCHANT ID> with your Merchant ID. Your browser displays a JSON-formatted page that resembles this:

    {
    "elements": [ {
    "id": "0G0DFRHMDMM2R",
    "name": "ImportedTax11",
    "rate": 500000,
    "isDefault": false
    }, {
    "id": "DCTH7WGKPKBXG",
    "name": "ImportedTax",
    "rate": 200000,
    "isDefault": false
    }, {
    "id": "4E2X3TC98N130",
    "name": "NO_TAX_APPLIED",
    "rate": 0,
    "isDefault": false
    }
    ],
    "href": "http://sandbox.dev.clover.com/v3/merchants/WJ4FZAW3YQT51/tax_rates?limit=100&"
  2. Your Tax Order ID is the first ID under elements.

  3. Copy the Tax Order ID and save it.

Order Type ID

The Order Type ID is an alphanumeric code assigned to each order category.

To retrieve the Order Type ID:

  1. Log in to your Clover Merchant account

  2. Go to Account & Setup > Transactions > Order Types.

  3. Click the Pencil Icon (Edit) next to the order type you are interested in.

  4. Look at the URL in your browser's address bar. It will look something like this:

  5. Copy the highlighted text and save it

Employee ID

The Employee ID is used as the employee on record for transactions uploaded to iPaaS.com.

To retrieve the Employee ID:

  1. Log in to your Clover Merchant account

  2. Go to Account & Setup > Employees > Employees.

  3. Find the desired employee and copy the ID, highlighted here.

  4. Copy and save the ID.

API Key

You can manually generate an API key in Clover.

To generate an API Key:

  1. Log in to your Clover Merchant account

  2. Go to Account & Setup > Business Operations > API tokens.

  3. Read the Information dialog and then click Get Started.

  4. Click Create new token.

  5. In the Create new token dialog box, enter a token name and set the necessary Read/Write permissions.

  6. Click Create token. Clover creates the token and displays the API tokens page

  7. Click Copy and save the token.

Now that you have these, you can install and set up the integration.

Installation Instructions for Integration Setup

  1. Go to Subscriptions Management > Subscriptions and click Search Certified Integration Marketplace and Subscribe.

  2. Click the Clover Integration title.

  3. On the Subscription Detail page, click the Subscribe button.

  4. Enter the name of the subscription and select a version. It can be set to any relevant and unique subscription name within the company where this subscription is created.

    • Format: [Product Name] - [Environment/Purpose]

    • Example: Clover – My Account

  5. Select a Version from the drop-down.

  6. Select Create Default Mappings (recommended).
    If you don’t want to create default mappings and want to create all mappings from scratch by yourself, then uncheck this box.

  7. Enter the Environment URL, the API endpoint for your Clover instance.

  8. Enter the following settings you retrieved and saved in the Before You Begin section.

    • Merchant ID

    • API Key

    • Employee ID

    • Order Type ID

    • Order Tax ID

  9. Enter the Environment URL, the API endpoint for your Clover instance.

  10. Enter the value for DeleteAndCreate.

    • True: When converting a simple product to a variant product, the system deletes the existing item in Clover and then recreates it as a new item group before proceeding with the update

    • False: The system will not attempt to delete and recreate, but throws an exception, acting as a safety for controlling product re-creation during updates.

  11. Enter the API Throttle Limit. This setting prevents any single integration or user from overwhelming the system with too many requests. It protects system performance by controlling the number of API requests that can run simultaneously, ensuring fair usage.

    • Recommended Values

      • Initial Setup: 5

      • Ongoing Operations: 500

      • High Volume: 500

  12. Enter the API Throttle Seconds. This defines the time window during which the API Throttle Limit is measured. If an integration makes too many requests within this time window, additional requests are rejected until the window resets.

    • Default Value: 60 seconds

    • Range: 60 seconds

  13. Enter the number of Concurrent Connections. This specifies the maximum number of simultaneous API connections that Akeneo can process for a user or integration. If this limit is exceeded, new requests are queued or rejected until a currently active connection finishes.

    • Default Value: 5

    • Range: 10

  14. Enter the number of Concurrent Batch Executions. This specifies the maximum number of simultaneous batch executions that can process for an integration at one time. . If this limit is exceeded, new requests are queued or rejected until a currently active connection finishes.

    • Default Value: 5

    • Range: 10

  15. Click Apply to save the settings.

Post-Installation Verification

After completing the installation, perform these tests to verify the installation:

Data Sync Test

  1. Initiate a sample data pull. (To iPaaS.com)

  2. Initiate a sample data push. (From iPaaS.com)

Functionality Test

  1. Run an end-to-end business process.

  2. Validate key features like field mappings, workflow triggers, and logging.

  3. Review integration logs in iPaaS.com.

Support and Troubleshooting

Click the Help button on any iPaaS.com page to contact Support or to search our documentation.

  • Documentation: Search our documentation at the top of this article

  • Support Portal: Click the Help and Support button at the lower-right of this window.

  • Contact Information: Contact iPaaS.com.

Did this answer your question?