Luigi's Box IdoSell Integration Guide

Overview

This guide walks you through integrating Luigi's Box with your IdoSell store. The integration enables:

• Search - AI-powered product search with typo tolerance and synonyms
• Product Recommendations - Personalized product suggestions
• Analytics - Insights into customer search behavior
• Automatic Data Sync - Your catalog stays up-to-date with Luigi's Box

Time to Complete: 15-20 minutes
Prerequisites: Admin access to IdoSell, Luigi's Box account

Integration Flow

graph LR
    A[Phase 1: Generate API Key] --> B(Phase 2: Create Sites);
    B --> C(Phase 3: Install Tracking Scripts);
    C --> D(Phase 4: Activate Catalog Sync);
    D --> E(Verification & Next Steps);
    
    %% Add click events to link to page sections
    click A "#phase-1-generate-idosell-api-credentials" "Go to Phase 1"
    click B "#phase-2-create-luigis-box-sites" "Go to Phase 2"
    click C "#phase-3-install-tracking-script-in-idosell" "Go to Phase 3"
    click D "#phase-4-connect-api" "Go to Phase 4"
    click E "#verification-troubleshooting" "Go to Verification"
    
    %% Class assignments for scroll-based highlighting
    class A mermaid-phase-1
    class B mermaid-phase-2
    class C mermaid-phase-3
    class D mermaid-phase-4
    class E mermaid-verification

Phase 1: Generate IdoSell API Credentials

Before connecting Luigi's Box, you need to generate a secure API Key in your IdoSell administration panel.

Step 1: Navigate to API Settings

1. Log in to your IdoSell administration panel
2. Navigate to Settings → API → Access (Ustawienia → API → Dostęp)
3. Click Add New Key (Dodaj klucz)

Step 2: Configure Key Settings

You will see a form titled "Adding an API key" (Dodawanie klucza API). Configure the fields as follows:

Login Settings (Logowanie):

• Authorization Method (Sposób autoryzacji): Select API Key (Klucz API)

Key Details:

• API Key (Klucz API): Will be generated automatically after you save
• Application Name (Nazwa aplikacji): Enter LuigisBox
• Email in case of contact necessity (E-mail w razie potrzeby kontaktu): Optional

Status:

• Active (Aktywny): Set to Yes (tak)
• Restrict hosts from which login is possible (Ogranicz hosty z których możę się logować): Set to No (nie)

Localization (Lokalizacja):

• Leave default settings (usually CET timezone and Polish language)

Step 3: Configure API Gateway Permissions (Dostęp do bramek API)

Scroll down to the permissions matrix and set the following:

Step 4: Save and Copy

1. Click Add (Dodaj) at the bottom of the form
2. The page will reload, and your API Key (Klucz API) will now be visible in the top section
3. Copy this key to your clipboard. You will need it in Phase 4.

Phase 2: Create Project & Sites

In this phase, you will create your Luigi's Box account structure.

Step 1: Create Your First Project & Site

When you log in to Luigi's Box for the first time, you will see the Create a new site/project form:

1. You have decided: This dropdown is automatically set to Create a new project and site
2. Fill in the form:
   • URL: Enter your store's URL (e.g., myshop.com)
   • Website language: Select the language for this specific view (e.g., English)
   • Platform: Select IdoSell
   • Project name: Enter a name of your choosing (e.g., My Store)
   • Segment: Select your e-commerce segment (e.g., Fashion, Electronics, etc.)
3. Click Add project/site

Your first Project and Site are now created!

Step 2: Add Additional Languages/Shops

If you have other languages (e.g., German) or other domains managed in the same IdoSell panel:

1. In Luigi's Box App navigate to General Settings → Site Management (as shown in the image above)
2. A menu appears on the right side of the screen

3. Click Add new site/project button

4. The same form as in Step 1 appears with the You have decided dropdown automatically set to Add a new site to an existing project

   • If you want to create a separate project instead, change this to Create a new project and site

5. Fill in the form:

   • URL: Enter the URL (same as Step 1 if it's just a language subfolder, or different if it's a new domain)
   • Website language: Select the new language (e.g., German)
   • Platform: Automatically selected as IdoSell
   • Name: Enter a descriptive name for this site (e.g., My Store - German)
   • Assign to project group: Select Default Group (if you haven't created custom groups yet)
   • Segment: Automatically selected and cannot be changed (inherited from the project)

6. Click Add project/site

7. Repeat this process for every active language you have

Phase 3: Install Tracking Scripts

Now you will install the tracking scripts so Luigi's Box can start analyzing traffic.

Step 1: Prepare Your Tracking Scripts

You should already have your tracking scripts from Phase 2. If you need to retrieve them again:

1. In your Luigi's Box Dashboard, go to Settings → Site Management
2. You will see a list of all sites you created (e.g., "Shop - English", "Shop - German")
3. Each site displays its Tracking Script with the unique Script ID (e.g., LBX-xxxxxx)

Step 2: Create IdoSell Campaign

1. Log in to IdoSell
2. Navigate to Store → Optimization & Functionality → HTML/JS Add-ons (Sklep → Optymalizacja i funkcjonalność → Dodatki HTML/JS)
3. Click Add a campaign (Dodaj kampanię)

Campaign Settings:

• Name: LuigisBox
• Active: Yes
• Pages: Select the pages where you want the script to run
  • For single-store setups: Select All pages (Wszystkie strony)
  • For multi-store setups: Select only the pages relevant to the current store/domain using the checkboxes
• Click Save

Step 3: Add Script & Handle Languages

1. Edit your new campaign and click New addition (Dodaj nowy dodatek)
2. Configure the settings:
   • Type: HTML
   • Load: Along with page content
   • Show: Normal version AND Mobile version

Step 4: Insert Code (The Critical Part)

For Single-Language Stores:

Simply paste your tracking script in the code editor:

<script src="https://scripts.luigisbox.com/LBX-YOUR-ID.js"></script>

Click Add (Dodaj)

For Multi-Language Stores:

1. Click the [English] Tab → Paste your English tracking script: <script src="https://scripts.luigisbox.com/LBX-YOUR-ENGLISH-ID.js"></script>

2. Click the [German] Tab → Paste your German tracking script: <script src="https://scripts.luigisbox.com/LBX-YOUR-GERMAN-ID.js"></script>

3. Repeat for all language tabs, ensuring each has its correct unique script

4. Click Add (Dodaj)

Phase 4: Activate Catalog Sync (Support)

To finalize the connection and begin syncing your products, please email your Luigi's Box representative (or support@luigisbox.com) with the following:

Subject: IdoSell API Configuration - [Your Company Name]

Body:

• The API Key you generated in Phase 1
• Confirmation that you have created the sites in the dashboard
• Your IdoSell store URL(s)

What Happens Next?

Our team will securely configure your API Key in our backend. Once confirmed (usually within 24 hours), your product catalog will begin syncing automatically every 3 hours.

You will receive a confirmation email when the sync is active.

Verification & Troubleshooting

Verify Script Installation

To confirm the tracking script is working:

1. Open your IdoSell store homepage in a new browser tab
2. Right-click and select View Page Source
3. Search (Ctrl+F / Cmd+F) for luigisbox

You should see the script injected within the code:

<!-- Begin additional html or js -->
<!--7|1|6-->
<script src="https://scripts.luigisbox.com/LBX-xxxxxx.js"></script>
<!-- End additional html or js -->

For Multi-Language: Check each language version of your site to ensure the correct Script ID appears for each language.

Verify Catalog Sync Status

After receiving confirmation from support (Phase 4):

1. Go to your Luigi's Box Dashboard
2. Navigate to Catalog → Browser
3. You should see your products appearing within 3-6 hours of the initial sync

Next Steps

1. Wait for Initial Sync: Your catalog is now syncing. This typically takes 15-60 minutes depending on catalog size
2. Check Catalog: Go to Catalog → Browser in Luigi's Box to confirm products are appearing
3. Configure Search: Once synced, you can begin configuring search rules and recommendations

Implement Your Features

Once your catalog is synced, you can implement Luigi's Box features on your storefront:

• Implement Search: Activate and configure your new search bar
• Implement Recommendations: Add personalized "cross-sell" and "upsell" carousels to your product and cart pages
• Implement Product Listings: Power your category pages with Luigi's Box for smart filtering and faceting