Skip to content

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:

ChannelFormatTarget AudienceDescription
JSON ExportJSONDevelopers, systemsGeneric export with configurable filters and formats
Publixx ExportJSONPublixx platformSpecialized export with mapping configuration for Publixx catalogs

Export Pipeline ​

The export process follows a clearly defined pipeline:

RequestAPI endpoint orPQL query withfilters and optionsFilteringStatus, hierarchy,attributes, deltatimestampEnrichmentAttribute values, media,prices, relations,load variantsTransformationApply mapping,choose format(flat/nested/publixx)JSON OutputGeneric exportfor external systemsPublixxPublixx recordsfor catalogs

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:

FormatDescription
flatFlat structure with all attributes as key-value pairs
nestedNested structure, grouped by attribute groups
publixxPublixx-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:00Z

The 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 ​

VersionElement Mapping
BMEcat 1.2Classic element names and structure
BMEcat 2005Extended 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 ElementContent
PRODUCT / ARTICLEProduct master data (SKU, name, description)
PRODUCT_DETAILSDetail attributes (long description, manufacturer, delivery time)
PRODUCT_FEATURESProduct features from EAV attributes
PRODUCT_PRICE_DETAILSPrice information with currency and tiering
MIME_INFOMedia references (images, documents)
PRODUCT_REFERENCEProduct relationships (accessories, spare parts)
CATALOG_GROUP_SYSTEMHierarchy structure
PRODUCT_TO_CATALOGGROUP_MAPProduct-category assignments

Technical Details ​

  • Streaming output -- The export uses XMLWriter for memory-efficient processing. Products are processed in chunks.
  • Element mapping -- The BmecatElementMap class automatically translates between BMEcat 1.2 and 2005 element names.

Further Documentation ​

anyPIM Dokumentation