Sync products to the catalog

POST 
/api/integrations/v1/products/sync

Synchronizes products from the external platform into the Neuroon search index.

Sync types:

• FULL: Replaces the entire catalog. All products previously synced from this source are removed and replaced with the provided list. Use for the initial data load or scheduled full refreshes (e.g. nightly).
• INCREMENTAL: Adds or updates only the provided products. Existing products not in this batch are left unchanged. Use for real-time updates (e.g. webhook on product update).

Limits: Maximum 500 products per batch. For catalogs larger than 500 products, send multiple sequential batches.

Required fields per product: externalId, name, price, url. Optional fields: description, categories, brands, imageUrl, inStock, stockQuantity, rating, reviewCount, isActive, tags, salePrice, parentExternalId, attributes.

Response: Returns counts of created, updated, skipped, and failed products, plus per-product error details.

Request

Responses

200

Sync completed. Check failed count for per-product errors

400

Validation error — batch too large, missing required fields, or the shop's product quota would be exceeded (upgrade the plan to sync more products)

401

Missing or invalid API key