Integration¶
Integration essentials¶
Before exploring the integration components, start with Integration Essentials. These outline key concepts, limitations, and best practices for a smooth integration.
- Identifiers & keys - Fundamental principles for working with identifiers and keys.
- Modeling concepts - Core concepts of how to model data in Elevate.
- Restrictions & limits - Integration restrictions and limits.
- Best practices - Recommendations for how to get the most out of Elevate.
Integration components¶
The integration consists of these components:
- Configuration – Setting up Elevate markets and locales.
- Catalog imports – Managing imports of catalog data like products, content, and translations.
- Category page imports – Importing and managing category listing pages for merchandising.
- Navigation imports – Importing navigation structures for site organization.
- Site integration – Querying Elevate and rendering results on the site.
- Order history – Historical sales data for initial relevance.
For detailed specifications of all supported endpoints, refer to the API section.
Info
The catalog feed integration has changed significantly from Admin v3 to Admin v4. The Configuration and Catalog Imports sections assume the use of Admin API v4, which is strongly recommended for new integrations.
For existing integrations still using Admin v3, refer to the following resources:
- XML Format Specification – Import format specification for Admin v3
- Multilingual Markets – Multimarket setup requirements for Admin v3
- Upgrade Guide – Steps to migrate from Admin v3 to Admin v4