• v5.0
    • Versions
    • master

 

  • Install Akeneo PIM
    • Install Akeneo PIM for development with Docker
    • Install Akeneo PIM manually
      • System Requirements
      • System installation on Debian 10 (Buster)
      • System installation on Ubuntu 18.04 (Bionic Beaver)
      • System installation on Ubuntu 20.04 (Focal Fossa)
      • Installing Akeneo PIM Community Edition (CE)
      • Installing Akeneo PIM Enterprise Edition (EE) with the Archive
      • Setting up the job queue daemon
      • Setting up the Events API
    • How to customize the Dataset
    • How to Add Translation Packs
  • Upgrade Akeneo PIM projects
    • How to apply a patch?
      • How to apply a patch - Community Edition
      • How to apply a patch - Enterprise Edition - Flexibility Cloud offer
      • How to apply a patch - Enterprise Edition - On Premise offer
    • Where is the Changelog?
    • How to upgrade to a minor version?
    • How to upgrade to a major version?
      • Upgrade from 3.2 to 4.0
      • Upgrade from 4.0 to 5.0
  • Import and Export data
    • How import works
    • Understanding the Product Import
    • Understanding the Product Export
    • Formats
      • Localized labels
      • Scopable labels
      • Association types data structure
      • Attribute data structure
      • Category data structure
      • Family data structure
      • Family variant data structure
      • Group data structure
      • Options data structure
      • Product data structure
      • Product model data structure
    • Akeneo Connectors
    • How to Customize Import / Export
      • How to create a new Connector
      • How to import Products from a XML file
      • How to clean a CSV file during a Product import
      • How to automate imports/exports
  • Manipulate the Akeneo PIM data
    • How to Customize Mass Edit Operations
      • How to register a new bulk action
      • How to Register a New Mass Edit Action on Products
    • How to Manipulate Products
      • How to Query Products
      • How to Create Products
      • How to Update Products
      • How to Validate Products
      • How to Save Products
      • How to Remove Products
    • How to Manipulate Non-Product Objects
      • How to Query Non-Product Objects
      • How to Create Non-Product Objects
      • How to Update Non-Product Objects
      • How to Validate Non-Product Objects
      • How to Save Non-Product Objects
      • How to Remove Non-Product Objects
    • How to add a custom action rule
      • General information about rule format
      • How to add a custom action in the rule engine
    • How to Define Access Control List
    • How to Customize the Catalog Structure
      • How to Create a Reference Data
    • How To Customize Teamwork Assistant (Enterprise Edition)
      • Customize notifications
      • Add a calculation step
      • How to log calculation step
      • Remove projects impacted by a custom catalog update
    • How to store assets externally
    • How to Configure Measurement Limits
  • Maintain Akeneo PIM projects
    • First aid kit
    • Bug qualification
    • Common issues
    • Scalability Guide
      • Audit with 3 Representative Catalogs
      • More than 10k attributes?
      • More than 10k families?
      • More than 10k categories?
      • More than 500 attributes usable in the product grids?
      • More than 100k products to export?
      • More than 1GB of product media to export?
    • How to purge history
      • How to Purge jobs executions
      • How to adapt the version purger to your needs
  • Contribute to Akeneo PIM
    • How to report an issue?
    • How to translate the user interface?
    • How to enhance the documentation?
    • How to contribute to a Connector?
    • How to submit a patch to the PIM?
    • How to contribute to the frontend part of the application
    • How behavior tests are architectured in the PIM?
      • Establishing Decorator Pattern
      • Using Spin In Behat
  • Use SSO authentication locally
  • Reference Entities
    • Configure Entity Limits
    • Create a new Reference Entity Attribute type
    • Enrich Records with a new Reference Entity Attribute type
    • Add a Custom Property to Your Custom Attribute Type
    • Refresh records completeness
  • Troubleshooting guide
  • Technical overview
    • Product Information
    • Teamwork Assistant (Enterprise Edition)
      • Project creation
      • Project completeness
      • Project Completeness widget
      • Catalog update impact
      • Scalability guide
      • Users permission summary for Behat tests
    • Collaborative workflow
      • Simple workflow
      • Partial workflow
  • Technical architecture
    • Best Practices
      • Create a project
      • Create a reusable bundle
      • Code Conventions
      • Coding Standards
    • How to implement your business logic using the event system
    • Events
      • Storage events
      • Workflow events (Enterprise Edition only)
    • How to Localize your data
      • How to change the PIM locale
      • How to Use Localizers
      • How to use Presenters
    • How to Add a Notification
    • Performances Guide
      • Memory usage of rules execution (Enterprise Edition)
      • Memory leak fix in Rules Engine (ORM)
      • More than 100 WYSIWYG editors in a page
      • PHP7 and HHVM Compatibility?
      • Job product batch size
    • How to Use the Web REST API
    • Standard format
      • Products
      • Other entities
      • Usage
    • Application Technical Information
      • Application Technical Dependencies
      • Server side set up for hosting
      • System Requirements
      • Recommended configuration
      • Client side configuration and compatibilities
      • Operation processes
      • Flow Matrix
  • Akeneo Cloud Edition
    • Flexibility
      • Environment accesses
      • System Administration & Services Management
      • Periodic tasks & Crontab configuration
      • Composer settings
      • Queue Management & Workers
      • Disk Usage Management
    • Serenity
  • Akeneo Onboarder
    • Prerequisites
    • How to install the Onboarder bundle
    • Synchronization
    • How to update a minor version or to apply a patch
      • How to update the Onboarder bundle - Enterprise Edition - Flexibility Cloud offer
      • How to update the Onboarder bundle - Enterprise Edition - On Premise offer
    • How to upgrade to a major version
    • Troubleshooting
    • How to uninstall the Onboarder bundle
    • Environment variables
      • Using the DotEnv file
      • Using environment variables

Product data structureΒΆ

Products are exported in a file with the following fields.

Attributes fields can be one of these:

  • sku (required): Identifier attribute (SKU is the common code)

  • clothing_size: size option code for a simple select option

  • description-en_US-mobile: localizable and scopable attribute en_US for channel mobile

  • description-fr_FR-mobile: localizable and scopable attribute fr_FR for channel mobile

  • name-fr_FR: localizable attribute fr_FR

  • name-en_US: localizable attribute en_US

  • price-EUR: numeric price value for Euro

  • price-USD: numeric price value for US Dollar

  • tshirt_style: list of option codes for a multi select option list

Associations fields:

  • <association-type-code>-groups: groups list for the <association-type-code> association type

  • <association-type-code>-product_models: list of product models codes in this association type

  • <association-type-code>-products: list of products identifiers in this association type

Product properties fields:

  • categories: list of category codes

  • enabled: boolean

  • family: family code

  • groups: list of product group codes

  • parent: product model code

Note

File example:

sku;PACK-groups;PACK-product_models;PACK-products;SUBSTITUTION-groups;SUBSTITUTION-product_models;SUBSTITUTION-products;UPSELL-groups;UPSELL-product_models;UPSELL-products;X_SELL-groups;X_SELL-product_models;X_SELL-products;categories;clothing_size;container_material;description-de_DE-mobile;description-en_US-mobile;description-fr_FR-mobile;parent;enabled;family;groups;main_color;name;picture;price-EUR;price-USD;secondary_color;tshirt_materials;tshirt_style
AKNTS_BPXS;;;;;;AKNTS_WPXS,AKNTS_PBXS,AKNTS_PWXS;;;;;;;goodies,tshirts;xs;;;Akeneo T-Shirt;T-Shirt Akeneo;;1;tshirts;akeneo_tshirt;black;Akeneo T-Shirt black and purple with short sleeve;;10;14;purple;cotton;crewneck,short_sleeve
AKNTS_BPS;;;;;;AKNTS_WPS,AKNTS_PBS,AKNTS_PWS;;;;;;;goodies,tshirts;s;;;Akeneo T-Shirt;T-Shirt Akeneo;;1;tshirts;akeneo_tshirt;black;Akeneo T-Shirt black and purple with short sleeve;;10;14;purple;cotton;crewneck,short_sleeve
AKNTS_BPM;;;;;;AKNTS_WPM,AKNTS_PBM,AKNTS_PWM;;;;;;;goodies,tshirts;m;;;Akeneo T-Shirt;T-Shirt Akeneo;;1;tshirts;akeneo_tshirt;black;Akeneo T-Shirt black and purple with short sleeve;;10;14;purple;cotton;crewneck,short_sleeve
AKNTS_WPS;;;;;;;;;;;;;goodies,tshirts;s;;;Akeneo T-Shirt;T-Shirt Akeneo;;1;tshirts;akeneo_tshirt;white;Akeneo T-Shirt white and purple with short sleeve;;10;14;purple;cotton;crewneck,short_sleeve
AKNTS_WPM;akeneo_mug;;OROMUG_DBO,AKNSTK;;;;;;;;;;goodies,tshirts;m;;;Akeneo T-Shirt;T-Shirt Akeneo;;1;tshirts;akeneo_tshirt;white;Akeneo T-Shirt white and purple with short sleeve;;10;14;purple;cotton;crewneck,short_sleeve
AKNTS_BPXS_LS;;;;;;AKNTS_WPXS_LS,AKNTS_PBXS_LS,AKNTS_PWXS_LS;;;;;;;goodies,tshirts;xs;;;Akeneo T-Shirt;T-Shirt Akeneo;;1;tshirts;akeneo_long_sleeve_tshirt;black;Akeneo T-Shirt black and purple with long sleeve;;10;14;purple;cotton;crewneck,long_sleeve
AKNTS_BPS_LS;;;;;;AKNTS_WPS_LS,AKNTS_PBS_LS,AKNTS_PWS_LS;;;;;;;goodies,tshirts;s;;;Akeneo T-Shirt;T-Shirt Akeneo;;1;tshirts;akeneo_long_sleeve_tshirt;black;Akeneo T-Shirt black and purple with long sleeve;;10;14;purple;cotton;crewneck,long_sleeve
AKNTS_BPM_LS;;;;;;AKNTS_WPM_LS,AKNTS_PBM_LS,AKNTS_PWM_LS;;;;;;;goodies,tshirts;m;;;Akeneo T-Shirt;T-Shirt Akeneo;;1;tshirts;akeneo_long_sleeve_tshirt;black;Akeneo T-Shirt black and purple with long sleeve;;10;14;purple;cotton;crewneck,long_sleeve
OROMUG_BO;;;;;;;;;;;;;goodies;;ceramic;Oro Mug;Oro Mug;Mug Oro;;1;mugs;oro_mug;black;Oro Mug;;5;5;orange;;
OROMUG_WO;;;;;;;;;;;;;goodies;;ceramic;Oro Mug;Oro Mug;Mug Oro;;1;mugs;oro_mug;white;Oro Mug;;5;5;orange;;
OROMUG_DBO;;;;;;OROMUG_BO,OROMUG_WO,OROMUG_OW,OROMUG_OB,OROMUG_ODB;;;;;;;goodies;;ceramic;Oro Mug;Oro Mug;Mug Oro;;1;mugs;oro_mug;blue;Oro Mug;;5;5;orange;;
OROMUG_BO_P;;;;;;;;;;;;;goodies;;porcelain;Oro Mug;Oro Mug;Mug Oro;;1;mugs;oro_mug;black;Oro Mug;;5;5;orange;;
OROMUG_WO_P;;;;;;;;;;;;;goodies;;porcelain;Oro Mug;Oro Mug;Mug Oro;;1;mugs;oro_mug;white;Oro Mug;;5;5;orange;;
AKNMUG_BP;;;;;;AKNMUG_WP,AKNMUG_PB,AKNMUG_PW;;;;;;;goodies;;;Akeneo Mug;Akeneo Mug;Mug Akeneo;;1;mugs;akeneo_mug;black;Akeneo Mug;;5;5;purple;;
AKNMUG_WP;akeneo_tshirt;;;;;;;;;;;;goodies;;;Akeneo Mug;Akeneo Mug;Mug Akeneo;;1;mugs;akeneo_mug;white;Akeneo Mug;;5;5;purple;;

Found a typo or a hole in the documentation and feel like contributing?
Join us on Github!