Skip to main content

Zoho Commerce Installation Instructions

Connect Zoho Commerce to iPaaS.com

Updated this week

Before you Begin

Before you begin, you will need to obtain authentication information from Zoho Commerce.

Important! Your MiSP or Integrator can provide these settings, including additional settings for OAuth 2.0 authentication. You cannot provide the additional OAuth 2.0 settings as a Subscriber. If you need assistance, contact your MiSP, Integrator, or contact iPaaS.com Support.

Steps to Obtain Client ID and Client Secret for Zoho Commerce OAuth 2.0:

  1. Go to the Zoho Developer Console.

  2. Log in with your Zoho account credentials (the account that has access to Zoho Commerce).

  3. Once logged in to the API Console, click Add Client, navigate to My Apps to create a new OAuth Application.

  4. Click Server-based Applications.

  5. On the Create New Client screen, provide the following information:

    • Client Name: Choose a descriptive name for your app.

    • Homepage URL: This is the domain where your application is hosted.

    • Authorized Redirect URLs: This is the URL where Zoho will send the user after authentication. It's part of the OAuth flow and is used to capture the Authorization Code. For example:
      ​https://portal.ipaas.com/customer/subscription-mgmt/subscriptions/authorization/app
      This URL will be used during the OAuth 2.0 flow to exchange the authorization code for an access token.
      ​


      To authenticate against a different regional instance, select the appropriate region in the Settings tab and toggle the slider for the required data center based on your region. For example, to use the European instance, toggle EU (zoho.eu).
      ​

  6. Click Update. Zoho Commerce generates a Client ID (public identifier for your app) and a Client Secret (a confidential credential that must be kept secure and not shared publicly).
    ​

    • Organization ID: Zoho Commerce refers to your business as an "organization." Each organization has its own unique organization_ididentifier, which is required in every API request to identify which business you're interacting with. This ensures that requests are scoped correctly to your specific store account. There are three ways to obtain the organization_id:

      1. Via the Browser Developer Console: Using your web browser's inspector (developer tools), you can find the value in a variable called app.data.books_org_id

      2. Via the API call, GET https://commerce.zoho.com/zs-site/api/v1/index: This endpoint returns JSON data that includes your organization_id.

      3. Contact Zoho support to obtain the correct organization_id for your organization.

Installation Instructions for Integration Setup

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

  2. Click the Zoho Commerce integration tile.
    ​

  3. On the Subscription Settings 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: ZohoCommerce – Production

  5. 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.
    ​

  6. Enter the Organization_ID, the Client_Id, and Client_Secret you retrieved from your Zoho Commerce account.

  7. Provide the API URL endpoint for your Zoho Commerce instance.

    • Example Environment URL for Production:https://www.commerce.zoho.com/store/api

  8. Click Apply.

Initiate the OAuth Flow within iPaaS.com

To initiate the OAuth flow and obtain an access token for API communication with Zoho Commerce:

  1. Go to the Zoho Commerce Subscription that was created earlier.

  2. Enter all authentication details, such as the Client ID and Client Secret (generated above).

  3. Click the Authentication icon in the top toolbar.
    ​

    ​A new browser window opens.

  4. Click Accept.

  5. When the authentication is validated, Zoho Commerce displays a success message.

  6. After the confirmation page is displayed, close the window.

  7. Refresh the subscription page.

    • If successful, the Access Token and Refresh Token are populated.
      ​

  8. If an error occurs, double-check that all settings match the configuration described above.

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.

Common Issues and Solutions

1. Invalid API Domain

  • Issue: Using a generic or incorrect domain for API requests.

  • Solution: Use your region-specific Zoho Accounts domain. For example:

    • https://accounts.zoho.com (US)

    • https://accounts.zoho.eu (EU)

    • https://accounts.zoho.in (India)

2. Authentication Failures

  • Issue: Requests return 401 Unauthorized or invalid_client.

  • Solution:

    1. Ensure you are using the correct Client ID and Client Secret generated in the Zoho API Console.

    2. Use a valid OAuth 2.0 access token and refresh it before expiry using the refresh token.

3. Insufficient Permissions

  • Issue: User cannot access store data or update products/orders.

  • Solution: Verify that the Zoho user account has the required role (e.g., Admin in Zoho Commerce) and that the scope requested in OAuth includes the required modules (e.g., ZohoCommerce.products.ALL, ZohoCommerce.orders.ALL).

4. Invalid or Missing IDs

  • Issue: API requests fail due to referencing non-existent objects (e.g., product ID, order ID, customer ID).

  • Solution: Always fetch and validate IDs with the appropriate GET API endpoints before using them in POST/PUT/DELETE requests.

5. Incorrect Data Format

Issue: API rejects fields like dates, currency, or JSON payload format.

  • Solution:

    1. Use the ISO 8601 format for dates.

    2. Ensure numbers (price, quantity) are provided as valid integers or decimals.

    3. Validate request body against Zoho Commerce API documentation.

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.

Related Articles
Zoho CRM Connections and Settings
Zoho CRM Installation Instructions
Adobe Commerce/Magento 2 Installation Instructions
Commercetools Installation Instructions
Zoho Commerce Internal Authentication Setup
Did this answer your question?