Export
The export module of the anyPIM provides product data in a structured form for external systems. It supports both generic JSON exports and the specialized Publixx integration.
Export Formats
The anyPIM offers two export channels:
| Channel | Format | Target Audience | Description |
|---|---|---|---|
| JSON Export | JSON | Developers, systems | Generic export with configurable filters and formats |
| Publixx Export | JSON | Publixx platform | Specialized export with mapping configuration for Publixx catalogs |
Export Pipeline
The export process follows a clearly defined pipeline:
1. Request
The export is triggered via an API endpoint or a PQL query. The caller defines filters, include options, and the desired output format.
2. Filtering
The product set is narrowed down based on the specified criteria:
- Status -- Only products with a specific status (e.g.,
active) - Hierarchy -- Products of a specific hierarchy node or path
- Attributes -- Filtering by attribute values
- Attribute views -- Restriction to specific views
- Output hierarchy -- Structuring by an output hierarchy
- Delta timestamp -- Only products changed since a specific point in time (
updated_after)
3. Data Enrichment
The filtered products are enriched with the requested supplementary data:
- Attribute values (with inheritance resolution for variants)
- Media (images, documents, videos)
- Prices (by currency and validity)
- Relations (accessories, spare parts, cross-references)
- Variants (with their own attribute values)
4. Transformation
The enriched data is transformed into the desired format:
| Format | Description |
|---|---|
flat | Flat structure with all attributes as key-value pairs |
nested | Nested structure, grouped by attribute groups |
publixx | Publixx-specific format with mapping transformation |
Delta Export
The delta export enables efficient incremental synchronizations. Using the updated_after parameter, only products that have changed since the specified point in time are exported:
GET /api/v1/export/products?updated_after=2025-06-15T10:00:00ZThe timestamp considers changes to:
- Product master data (name, SKU, status)
- Attribute values
- Media assignments
- Prices
- Variants and their attribute values
- Relations
BMEcat Export
The anyPIM supports the export of product data in BMEcat format (versions 1.2 and 2005). The BMEcat export generates standard-compliant XML files that can be directly processed by ERP systems, online shops, and procurement platforms.
Supported Versions
| Version | Element Mapping |
|---|---|
| BMEcat 1.2 | Classic element names and structure |
| BMEcat 2005 | Extended element names (e.g., PRODUCT instead of ARTICLE) |
Filter Options
The BMEcat export supports flexible filtering:
- Hierarchy -- Export only for specific categories/hierarchy nodes
- Product types -- Restriction to specific product types
- Attributes -- Selection of attributes to export
- Price types -- Filtering by price type
- Relation types -- Selection of product relationships to export
Exported Elements
| BMEcat Element | Content |
|---|---|
| PRODUCT / ARTICLE | Product master data (SKU, name, description) |
| PRODUCT_DETAILS | Detail attributes (long description, manufacturer, delivery time) |
| PRODUCT_FEATURES | Product features from EAV attributes |
| PRODUCT_PRICE_DETAILS | Price information with currency and tiering |
| MIME_INFO | Media references (images, documents) |
| PRODUCT_REFERENCE | Product relationships (accessories, spare parts) |
| CATALOG_GROUP_SYSTEM | Hierarchy structure |
| PRODUCT_TO_CATALOGGROUP_MAP | Product-category assignments |
Technical Details
- Streaming output -- The export uses XMLWriter for memory-efficient processing. Products are processed in chunks.
- Element mapping -- The
BmecatElementMapclass automatically translates between BMEcat 1.2 and 2005 element names.
Further Documentation
- JSON Export -- Endpoints, filters, formats, and pagination
- Publixx Export -- Mapping configuration and Publixx integration