> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ocular.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# EasyEcom

> Connect EasyEcom to Ocular using your username, password, X-API-Key, and Location Key to sync orders, inventory, and fulfilment data.

**Required fields in Ocular:**

* **Username** – your EasyEcom account username
* **Password** – the password for your EasyEcom account
* **X-API-Key** – the API key generated from your EasyEcom account
* **Location Key** – the location/warehouse key from your EasyEcom account

Follow the three sections below: grab each credential from EasyEcom, then paste them into **Data Management → Connectors → Add connector → EasyEcom**.

<CardGroup cols={2}>
  <Card title="What you need" icon="key">
    Username, password, X-API-Key, and Location Key from your EasyEcom account.
  </Card>

  <Card title="What it unlocks" icon="boxes-stacked">
    OMS orders, inventory levels, and fulfilment data flowing into Sales Performance and the P\&L.
  </Card>
</CardGroup>

***

## <Icon icon="gear" /> Step 1 · Connector Setup Details

When adding the connector, Ocular will ask you to fill in the following fields:

<CardGroup cols={2}>
  <Card title="Connector Name" icon="tag">
    Give this connector a unique, recognisable name (e.g., `easyecom_main`). This cannot be changed after creation, so choose carefully.
  </Card>

  <Card title="Connector Identifier" icon="hashtag">
    Auto-generated by Ocular. No action needed.
  </Card>

  <Card title="Start Date" icon="calendar">
    YYYY-MM-DD — choose the date from which you want Ocular to begin pulling your EasyEcom data.
  </Card>

  <Card title="Lookback Days" icon="clock-rotate-left">
    The number of days for which Ocular will keep refreshing past data (default is 30 days). This is particularly useful for orders whose status updates — such as returns or fulfilment changes — may come in several days after the original order date.
  </Card>

  <Card title="Schedule Frequency" icon="repeat">
    Defines how often Ocular syncs your EasyEcom data. Set the **Frequency** (a numeric value) and the **Unit** (e.g., Hours) together to control the sync interval. Default is every 4 hours.
  </Card>

  <Card title="Auto Sync" icon="toggle-on">
    Toggle this on if you want Ocular to begin syncing automatically as soon as the connector is created.
  </Card>
</CardGroup>

***

## <Icon icon="key" /> Step 2 · Find your EasyEcom credentials

### Username & Password

<Steps>
  <Step title="Use your EasyEcom login" icon="user">
    These are the same credentials you use to log in to your EasyEcom account at [app.easyecom.io](https://app.easyecom.io/).
  </Step>

  <Step title="Create a dedicated user (recommended)" icon="user-plus">
    It is recommended to create a dedicated user for Ocular (e.g., `ocular_api`) with the necessary permissions, rather than using a personal login.
  </Step>
</Steps>

<Frame caption="EasyEcom dashboard — open Settings from the top-right gear icon">
  <img src="https://mintcdn.com/ocular/q-V-PFkPr0MOCSrr/EE1.png?fit=max&auto=format&n=q-V-PFkPr0MOCSrr&q=85&s=43ae0a12472d4b2a6bad7aff8031dff7" alt="EE1" width="1918" height="875" data-path="EE1.png" />
</Frame>

<Frame caption="Settings → Change Credentials">
  <img src="https://mintcdn.com/ocular/q-V-PFkPr0MOCSrr/EE2.png?fit=max&auto=format&n=q-V-PFkPr0MOCSrr&q=85&s=0d1246807ab1b2fd37a726a2e3fe15fc" alt="EE2" width="1907" height="866" data-path="EE2.png" />
</Frame>

### X-API-Key

<Steps>
  <Step title="Open API settings" icon="gear">
    Log in to EasyEcom and go to **Settings → API & Webhooks** (or **Integrations → API Access**, depending on your account version).
  </Step>

  <Step title="Copy the X-API-Key" icon="copy">
    Copy the **X-API-Key** shown on that page. If no key exists, click **Generate** to create one.
  </Step>
</Steps>

<Warning>
  Keep this key secure — it grants API-level access to your EasyEcom account.
</Warning>

<Frame caption="Copy your X-API-Key from the API settings page">
  <img src="https://mintcdn.com/ocular/q-V-PFkPr0MOCSrr/EE3.png?fit=max&auto=format&n=q-V-PFkPr0MOCSrr&q=85&s=4ee82b081d920d3d90b566a50021ef04" alt="EE3" width="1908" height="852" data-path="EE3.png" />
</Frame>

### Location Key

<Steps>
  <Step title="Open warehouse settings" icon="warehouse">
    In EasyEcom, go to **Settings → Warehouses / Locations**.
  </Step>

  <Step title="Copy the Location Key" icon="copy">
    Each warehouse or fulfilment location in your account has a unique **Location Key**. Copy the key for the location whose data you want Ocular to pull. If you want data from multiple locations, you can add them as separate connectors.
  </Step>
</Steps>

<Frame caption="EasyEcom Location Master">
  <img src="https://mintcdn.com/ocular/q-V-PFkPr0MOCSrr/EE4.png?fit=max&auto=format&n=q-V-PFkPr0MOCSrr&q=85&s=2c1f8dbe2399293d7b3e93aabdb1b4bc" alt="EE4" width="1915" height="867" data-path="EE4.png" />
</Frame>

<Frame caption="Each location has a unique Location Key">
  <img src="https://mintcdn.com/ocular/q-V-PFkPr0MOCSrr/EE5.png?fit=max&auto=format&n=q-V-PFkPr0MOCSrr&q=85&s=0aa07373bd551408fb7b6ab78b0137a1" alt="EE5" width="1897" height="858" data-path="EE5.png" />
</Frame>

<Note>
  If you are unsure where to find the X-API-Key or Location Key in your specific EasyEcom plan, contact EasyEcom support or check their API documentation at [developers.easyecom.io](https://developers.easyecom.io/).
</Note>

***

## <Icon icon="plug" /> Step 3 · Plug the credentials into Ocular

<Steps>
  <Step title="Open the connector form" icon="window">
    In Ocular, open **Data Management → Connectors → Add connector → EasyEcom**.
  </Step>

  <Step title="Open the connector form" icon="window">
    In Ocular, open **Data Management → Connectors → Add connector → EasyEcom**.

    <Frame caption="EasyEcom connector form in Ocular">
      <img src="https://mintcdn.com/ocular/q-V-PFkPr0MOCSrr/EE6.png?fit=max&auto=format&n=q-V-PFkPr0MOCSrr&q=85&s=2763d323a6b744adb69cb77da2e4a365" alt="EE6" width="1918" height="867" data-path="EE6.png" />
    </Frame>
  </Step>

  <Step title="Fill the fields" icon="pen-to-square">
    <CardGroup cols={2}>
      <Card title="Username" icon="user">
        Your EasyEcom account username.
      </Card>

      <Card title="Password" icon="lock">
        The password for that account.
      </Card>

      <Card title="X-API-Key" icon="key">
        The API key from Step 2.
      </Card>

      <Card title="Location Key" icon="warehouse">
        The location key from Step 2.
      </Card>
    </CardGroup>
  </Step>

  <Step title="Test the connection" icon="flask-vial">
    Click **Create Connector**. Ocular authenticates against the EasyEcom API; on success, you'll see **Connection successful**.
  </Step>

  <Step title="Create" icon="circle-check">
    Click **Create**. Your credentials are encrypted in Ocular's vault; your first incremental sync kicks off within minutes.
  </Step>

  <Step title="Create" icon="circle-check">
    Click **Create**. Your credentials are encrypted in Ocular's vault; your first incremental sync kicks off within minutes.

    <Frame caption="Connector created — data will begin syncing shortly">
      <img src="https://mintcdn.com/ocular/q-V-PFkPr0MOCSrr/EE-successful.png?fit=max&auto=format&n=q-V-PFkPr0MOCSrr&q=85&s=d3a010dd531d1e102492a714bbd3ae66" alt="EE Successful" width="1495" height="801" data-path="EE-successful.png" />
    </Frame>
  </Step>
</Steps>

<Note>
  For ticket-writing format when filing a connector issue, see [Working with the Ocular team → Connector-not-working tickets](/overview/working-with-the-ocular-team).
</Note>