Luigi's Box IdoSell Data Synchronization Guide

Info

This guide explains how data synchronization works. If you haven't connected IdoSell yet, start with the Integration Guide.

Overview

Luigi's Box automatically synchronizes your IdoSell product catalog to power search, recommendations, and analytics. The IdoSell integration performs a comprehensive sync to ensure your data is always 100% consistent.

This guide explains what data is synced, how the synchronization process works, and how to troubleshoot common issues.

What Data is Synchronized

Product Information

Luigi's Box syncs comprehensive product data from your IdoSell store via the Admin API.

Data Type What's Included Purpose
Basic info Name, description, parameters Product identification and display
Pricing Prices in all active currencies Price-based filtering and sorting for multi-currency stores
Images All image URLs (primary mapped from productImageSmallUrl) Visual search results and recommendations
Categories Category structure and Menus Category-based filtering and navigation
Attributes All productParameters (except export-specific ones) Faceted search and filtering
Variants Sizes, colors, and variations Grouped under master products for clean search results
Visibility Active status (productIsVisible: "y") Ensures hidden products do not appear in search

Filtering & Scope

To keep your search results clean, the integration applies specific logic during the sync:

  • Visibility: Only products marked as visible (productIsVisible: "y") are indexed.
  • Hidden Categories: By default, hidden menu categories are excluded from the sync.
  • Export Parameters: Technical parameters containing 'export' (case-insensitive, e.g., googleExport) are skipped to avoid cluttering filters.

Multi-Language & Multi-Currency

  • Languages: Each language version of your store is treated as a separate "Site" in Luigi's Box and is synced independently.
  • Currencies: The integration fetches all active currencies for every product. This allows Luigi's Box to support multi-currency search if your frontend requires it.

How Synchronization Works

The Sync Cycle (Polling)

The integration uses a polling mechanism to fetch data. It does not use webhooks or "push" notifications.

  • Frequency: Automatic, running approximately every 3 hours.
  • Mechanism: Full catalog reload.

Full Catalog Reload

Because the IdoSell API does not support incremental ("delta") updates, the integration performs a full catalog reload during every cycle. This means Luigi's Box re-fetch your entire product list rather than just downloading recent changes.

Why is this important?

  • Consistency: It ensures that Luigi's Box always has an exact mirror of your current IdoSell data, preventing "drift" where old data might get stuck.
  • Deletions: If you delete a product in IdoSell, it simply disappears from the next full sync, removing it from search automatically.
Note

Because the integration reloads the full catalog, the sync duration depends on the size of your inventory. Luigi's Box utilize IdoSell's built-in pagination mechanism (fetching 100 products per request) to ensure connection stability.

Technical Details (API Usage)

This section is for developers or technical teams debugging the connection.

API Endpoints Used

Luigi's Box connects to your IdoSell Admin API and consumes specific endpoints to build the search index:

Authentication & Headers

The integration authenticates using the API Key generated in your IdoSell settings.

  • Header: X-API-KEY

Permissions Required:

  • System: Read only
  • CMS: Read only
  • PIM: Read only

Common Sync Scenarios

Scenario 1: Adding New Products

Your Action: You add 10 new products in IdoSell and set productIsVisible to "yes".

What Happens:

  • The products will not appear immediately.
  • They will be detected during the next scheduled 3-hour sync cycle.
  • Once the cycle completes, they appear in search results.

Scenario 2: Changing API Keys

Your Action: You regenerate your API Key in the IdoSell panel for security reasons.

What Happens:

  • The sync will fail silently.
  • Luigi's Box will continue to attempt using the old key, which is now invalid.

Fix: You must immediately contact Luigi's Box support with the new API Key to restore synchronization.

Scenario 3: Hiding Products

Your Action: You change a product's visibility to "hidden" or delete it.

What Happens:

  • The product remains in search until the next 3-hour sync cycle begins.
  • During the sync, Luigi's Box sees the product is missing or hidden in the full export.
  • The product is removed from the search index.

Verifying & Troubleshooting

If you suspect your catalog is not syncing correctly, follow these steps:

Step 1: Check the Last Sync Time

  • Log in to your Luigi's Box Dashboard.
  • Check the catalog status. If the last sync was more than 4 hours ago, there may be an issue.

Step 2: Verify API Permissions

  • In IdoSell, go to Settings → API → Access.
  • Ensure the key used for Luigi's Box has:
    • System: Read only
    • CMS: Read only
    • PIM: Read only
!
Warning

Permission Errors: If permissions are incorrect (e.g., set to "No access"), the sync will fail. IdoSell does not always provide an immediate error alert, so the sync may simply stop working.

Step 3: Check "Visible" Status

  • Luigi's Box strictly respects the productIsVisible flag.
  • If a product exists in IdoSell but is missing in Luigi's Box, verify that it is actually visible on your storefront. If IdoSell considers it hidden, Luigi's Box will not index it.

Step 4: Contact Support

  • If you have verified the permissions and the product visibility, but data is still not appearing after 4+ hours, please contact support@luigisbox.com.