EasyEcom API modifications V2.1

EasyEcom API modifications V2.1

We are modifying our authorization module for API access. Two new headers are being introduced:
  1. JWT Token
  2. X-API-Key

22 July 2023 onwards, all EasyEcom API can only be accessed by passing both parameters in request headers. Failing to provide that token, the user will not be allowed to access the API and will receive HTTP code 401.

You can access our API documentation at https://api-docs.easyecom.io which now reflects a new method of authorizing your requests

1. JWT Token

To generate a JWT token, refer to the Authorization section in the API documentation

Jwt_token generated by the above method needs to be passed in the header for subsequent API calls 'Authorization: Bearer <jwt_token>'.

This token will be valid for 90 days and the new token can be generated by calling the above API again.

2. X-API-Key

Steps to generate X-API-key 

  1. Log in to easyecom.io primary account. X-API-Key can only be generated from the primary account of the seller.
  2. Go to Account Settings > Change credentials
  3. Under X-API-KEY section, click on Generate X-API-KEY button
  4. Sample Token : 681d976c3bkgkjg6577754lkh46dc8927366eee4

Below is a sample curl request which uses both the mandatory headers: 

curl --location --request GET 'https://api.easyecom.io/<endpoint>' 

--header 'x-api-key: 40e18be2xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx’

--header 'Authorization: Bearer  eyJ0eXAiOiJKV1QiLCJhbGciOixxxxxxxxxxxxxxxxxxxxx’

--header 'Content-Type: application/json'


Rate Limiting

All clients using EasyEcom APIs will experience rate limiting at the X-API-Key level. 
Please refer to the table below for detailed rate limiting tiers:


Initially the Newly generated X-API Key will be created under Default tier for enabling the User to conclude the Testing,
Once the Client level Testing is completed, Our Integration Team will hold a review session, 
Please share the below details for the UAT review:
  1. Flow Diagram
  2. Implemented Touchpoints for Integration in the below format with exact APIs consumed against all use cases/Touchpoints:
    TouchpointsSub-CategorySource DestinationActionDescription
    Major Touchpoint:
    Product/ Inventory/Order Data    		Detailed category of touchpoint wrt against any specific Use caseExact API/Webhook Used with the GET/ POST ImplementationSome details regarding the implementation of the given API along with Below details: Trigger setup: Cron/Real time
Post successful review process the X-API Tier will be upgraded.

Please Note:  Any request to increase the Rate limit beyond the Default tier will Incur additional commercial scope for Tier upgradation,

Once the allowed quota is consumed, HTTP Code 429 Too Many Requests will be responded to by API. 


    • Related Articles

    • Integrating Marketplace using EasyEcom Standard APIs

      You can easily integrate your marketplace with EasyEcom by following the process explained in this video and/or the integration workflow document shared with you.  Marketplace Integration Frequently Asked Questions  1. Do we need to add carrier ...

    • Integrating Loqally with EasyEcom

      This guide explains how to configure the Loqally integration in EasyEcom, and also supports reverse shipment. Step 1: Navigate to Carrier Master Masters > Carrier Master Step 2: Click on 'Add New' and Select 'Loqally Outbound' from the dropdown Step ...

    • Integrating SharkShip Outbound with EasyEcom

      This guide explains how to configure the SharkShip carrier integration in EasyEcom for shipment creation and shipment cancellation. Step 1: Navigate to Carrier Master Masters > Carrier Master Step 2: Click on 'Add New' and Select 'Sharkship Outbound' ...

    • Integrating BoxD Logistics with EasyEcom

      This guide explains how to configure the BoxD Logistics integration in EasyEcom, and also supports reverse shipment. Step 1: Navigate to Carrier Master Masters > Carrier Master Step 2: Click on 'Add New' and Select 'BoxD Logistics Outbound' from the ...

    • Integrating RapidShyp B2B with EasyEcom

      This guide explains how to configure the RapidShyp B2B integration in EasyEcom. Prerequisite RapidShyp B2B works only for accounts where the New B2B Module is enabled. For B2B order processing flow, refer to: B2B Order Processing - New Workflow Step ...