ideal.shop

Sync Data

Import complete catalogue data, order history, and content pages.

The recommended way to sync ideal.shop data is an AI Integration using the shop’s API. Set it up for all data types, with content pages fetched through the sitemap as part of the same integration.

Create API User #

Create an API user in ideal.shop to give the AI Integration access to your shop’s data.

  1. Log in to your ideal.shop backend.
  2. Go to Indstillinger > Integrationer > API.
  3. Create a new API user.
  4. Tick the Aktiv checkbox next to the API user. API users are not activated automatically, and the integration will not work until the user is active.
  5. Keep the API Username and API code shown for the user. You will need both during setup.

AI Integration #

Use the API credentials to build the integration through Ask Clerk.io.

  1. In my.clerk.io, open the matching Store and go to Ask Clerk.io.
  2. Ask it to set up an AI Integration for ideal.shop covering all data types. Include your webshop URL.
  3. Provide the API Username and API code when asked for credentials.
  4. Provide your sitemap URL and ask it to fetch content pages as part of the same integration, as described in Import Pages.
  5. Review the test results and sample records before completing setup and handing the integration over to Data Sync.
  6. Open Data > Configuration, start a data sync, and check the imported counts and records.

Check that the first import covers the full catalogue and intended order history, and that ongoing imports cover all orders since the previous successful sync. See Data Sync for scheduling, status, and logs.

Import Pages #

Articles and other content pages need their own records before they can appear in Search or provide context for page-based recommendations.

Pages still need to be fetched through the webshop’s sitemap. Include this in the same AI Integration as the API import; a separate pages integration is not required.

Provide the sitemap URL in Ask Clerk.io and explain which page types to include and exclude. Ask it to discover sitemap indexes and their child sitemaps, fetch the intended pages, and propose sample records for review.

For Fodmagasinet, the example discovery source is https://www.fodmagasinet.dk/sitemap.xml, with the homepage and URLs containing /vare excluded. These rules fit that webshop’s URL structure; inspect your own sitemap before choosing filters.

Validate each sample record:

  • A stable, unique ID that matches the storefront article ID when using page-based recommendations.
  • The correct title, canonical URL, and useful article content without header, footer, or navigation text.
  • No duplicate URLs, product pages, category listings, or other unwanted page types.

If the importer generates different IDs from those exposed by the theme, agree a mapping with the developer before configuring article recommendations. Verify imported samples and counts after the first run.

Importing pages and displaying them are separate steps. The Search Design must also render page results; see Search.

Native Feed #

The native JSON feed is an alternative for existing feed-based setups. Its limits below apply to that feed, not to the recommended API-based AI Integration.

First enable the integration, including Feed offentligt.

Configure Feed #

Without explicit limits, the feed returns up to 50 records per data type. Set separate product, category, and order limits for the first historical import.

  1. In ideal.shop, open Indstillinger > Integrationer > Clerk.io.
  2. Copy the URL under Sti til feed.
  3. For a URL without query parameters, append ?&products=10000&categories=10000&orders=10000:
https://example.com/feeds/clerk_io_feed.json?&products=10000&categories=10000&orders=10000

If your URL already has a query string, append the parameters with & and keep any existing required parameters. Do not add a second ? or duplicate an existing limit.

These values request up to 10,000 records of each named type. Increase each limit where necessary; 10,000 is an example, not a guarantee of a complete export. Other data types retain their default unless configured separately.

For example, Fodmagasinet’s feed uses the same syntax on its own domain:

https://www.fodmagasinet.dk/feeds/clerk_io_feed.json?&products=10000&categories=10000&orders=10000

Start Sync #

Configure Clerk.io to read the complete feed URL, including its limits.

  1. In my.clerk.io, open the matching Store and go to Data > Configuration.
  2. Choose Clerk.io JSON Feed as the sync method.
  3. Paste the feed URL and save the configuration.
  4. Click Start New Data Sync and wait for completion.
  5. Compare imported counts with the webshop’s exportable totals, accounting for deliberately excluded records.

A count equal to a requested limit can indicate truncation. Increase that limit and sync again. Check the oldest imported order as well as the total; a successful sync can still contain only part of the history.

See Data Sync for status and logs, or the feed FAQ for truncation and timeouts.

Ongoing Imports #

After the first successful historical import, remove &orders=10000. Keep the full catalogue limits:

https://example.com/feeds/clerk_io_feed.json?&products=10000&categories=10000

Removing orders restores the default of the 50 most recent orders. It does not disable order imports. Clerk.io retains previously imported orders, so the ongoing feed only needs to cover recent orders.

Before using the default, compare the webshop’s order volume with the time between successful syncs, including delays or failed syncs. Check that the oldest order returned overlaps the last successful import and that all orders since then are present.

If 50 orders cannot cover that interval, keep an explicit orders limit large enough to cover it with overlap. For example, append &orders=500 only if that covers your volume. Recheck after a sync outage or a rise in orders.

Keep products and categories high enough for the entire current catalogue on every sync. Do not reduce them to the default after importing once.

Validate Data #

A successful status and plausible counts do not prove that the data matches the storefront. Compare representative imported records with the actual webshop.

CheckWhat to verify
CategoriesHidden or unpublished categories are excluded as intended. Product-category references resolve to the correct imported category records.
AvailabilityIn-stock, out-of-stock, and unavailable products behave as intended in results and purchasing. Confirm the meaning and type of stock fields.
ImagesImages remain sharp at the actual rendered card size on desktop and mobile, including high-density screens.
PricesParent and variant prices match the webshop’s currency, tax treatment, and discounts. Check zero prices and products with multiple variant prices.
DiscountsThe regular-price field exists and exceeds the selling price before showing a strike-through price or sale badge.
PagesTitles, URLs, content, and article IDs match the intended content pages.

See card data for price display and the FAQ for image and source-data issues.