Documentation

Quick Start

Get your first Akeneo export running in 5 minutes.

Goal: By the end of this guide, you'll have exported products from your Akeneo PIM to your own database.

Prerequisites

πŸ”‘Akeneo PIM with API credentials
πŸ—„οΈMongoDB, PostgreSQL, or MySQL database
⏱️5 minutes of your time
Your Data, Your Infrastructure
Akeneo Exporter is a cloud SaaS, but your data stays in your own database. We only connect to write dataβ€”you maintain full control and ownership.
1

Create Your Account

The platform uses Clerk for secure authentication, supporting email/password and Google SSO.

  • Visit Akeneo Exporter and click "Get Started"
  • Choose your sign-up method and verify your email
  • Complete your profile β†’ redirected to dashboard

Dashboard sections: Configurations (saved setups) β€’ Exports (history) β€’ Enrichers (transformation rules)

2

Connect Your Akeneo PIM

Connect using OAuth 2.0 credentials. All credentials are encrypted with AES-256-GCM.

1.Navigate to Configurations β†’ New Configuration
2.Enter a descriptive name (e.g., "Production Export")
3.Fill in your Akeneo credentials:
Example Akeneo credentials
{
  "url": "https://your-company.akeneo.cloud",
  "clientId": "3_abc123xyz",
  "secret": "your_secret_key_here",
  "username": "api_user",
  "password": "secure_password",
  "scope": "ecommerce"  // Optional: channel filter
}
4.Click Test Connection to verify before saving
Need API credentials?
In Akeneo: System β†’ API connections β†’ Create connection β†’ Copy Client ID and Secret. See our Authentication guide for details.
3

Configure Your Destination

Your data is written to your own database β€” not stored on our servers. Collections/tables are created automatically.

MongoDB

Flexible schema, hierarchical data, fast retrieval

Connection string
mongodb://user:pass@host:27017/products

# MongoDB Atlas
mongodb+srv://user:pass@cluster.mongodb.net/db
PostgreSQL

Structured queries, joins, ACID compliance

Connection string
postgresql://user:pass@host:5432/products

# With SSL
postgresql://user:pass@host:5432/db?sslmode=require

In the UI: Select database type β†’ Enter connection URI β†’ Specify database name β†’ Test Connection

4

Run Your First Export

Exports run asynchronously in the background. You can monitor progress in real-time or return later.

1.Click Run Export from configuration page
2.Choose mode: Full (all products) or Incremental (since last run)
3.Select enrichers to apply (optional)
4.Click Start Export β†’ Monitor real-time progress
Status
completed
Products
1,234
Duration
2m 15s
Throughput
9.1/sec
Success!
Once status is "completed", your products are in your database!

Verify It Works

Connect to your database and query the exported data:

MongoDB
db.products.findOne()

// Output:
{
  "_id": "tshirt-red-m",
  "family": "clothing",
  "attributes": {
    "name": "Red T-Shirt",
    "price": 29.99
  }
}
PostgreSQL
SELECT * FROM products LIMIT 1;

-- Output:
| code         | family   |
|--------------|----------|
| tshirt-red-m | clothing |

Next Steps

Need Help?
Stuck on something? Check our Troubleshooting guide or contact support.