https://github.com/schallym/node-akeneo-api-client
Node client for Akeneo PIM REST API
https://github.com/schallym/node-akeneo-api-client
akeneo api api-client ecommerce javascript nodejs pim typescript
Last synced: 19 days ago
JSON representation
Node client for Akeneo PIM REST API
- Host: GitHub
- URL: https://github.com/schallym/node-akeneo-api-client
- Owner: schallym
- License: mit
- Created: 2025-06-28T20:58:35.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2026-05-27T09:08:31.000Z (24 days ago)
- Last Synced: 2026-05-27T10:24:39.862Z (24 days ago)
- Topics: akeneo, api, api-client, ecommerce, javascript, nodejs, pim, typescript
- Language: TypeScript
- Homepage:
- Size: 718 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Node Akeneo API Client
[](https://www.npmjs.com/package/@schally/node-akeneo-api-client)
[](LICENSE)
[](https://codecov.io/gh/schallym/node-akeneo-api-client)
[](https://snyk.io/test/github/schallym/node-akeneo-api-client)
A complete and up-to-date Node.js client for the Akeneo PIM REST API. This library provides a simple and intuitive interface to interact with all Akeneo PIM endpoints, supporting both Community and Enterprise editions.
## Features
- 🚀 **Complete API Coverage** - Supports all Akeneo REST API endpoints
- 📦 **TypeScript Support** - Full TypeScript definitions included
- 🔐 **Multiple Authentication Methods** - Classic connection and App connection
- 🔄 **Automatic Token Refresh** - Handles token expiration automatically
- 📄 **Pagination Support** - Built-in pagination handling for large datasets
- 🛡️ **Error Handling** - Comprehensive error handling with detailed messages
- 🧪 **Well Tested** - Extensive test coverage
## Installation
```bash
npm install @schally/node-akeneo-api-client
```
## Quick Start
### Basic Setup
```javascript
const { AkeneoClient } = require('@schally/node-akeneo-api-client');
// Initialize with classic connection
const client = new AkeneoClient({
baseUrl: 'https://your-akeneo-instance.com',
clientId: 'your-client-id',
secret: 'your-client-secret',
username: 'your-username',
password: 'your-password'
});
// Or initialize with App token
const client = new AkeneoClient({
baseUrl: 'https://your-akeneo-instance.com',
accessToken: 'your-app-token',
clientId: 'app-client-id',
});
```
### Basic Usage Examples
```javascript
// List activated products with count
const products = await client.products.list({
limit: 10,
search: JSON.stringify({ enabled: [{ operator: '=', value: true }] }),
with_count: true
});
// Get a specific product
const product = await client.products.get('product-sku');
// Create a new product
const newProduct = await client.products.create({
identifier: 'new-product-sku',
family: 'accessories',
values: {
name: [{
locale: null,
scope: null,
data: 'My New Product'
}]
}
});
// Update a product
await client.products.update('product-sku', {
values: {
description: [{
locale: 'en_US',
scope: null,
data: 'Updated description'
}]
}
});
// Delete a product
await client.products.delete('product-sku');
```
## API Reference
### Available Endpoints
Please refer to the [official Akeneo API documentation](https://api.akeneo.com/api-reference-index.html) for detailed information on each endpoint.
### Error Handling
```javascript
try {
const product = await client.products.get('non-existent-sku');
} catch (error) {
if (error.status === 404) {
console.log('Product not found');
} else if (error.status === 401) {
console.log('Authentication failed');
} else {
console.log('API Error:', error.message);
}
}
```
## TypeScript Support
This library is written in TypeScript and includes comprehensive type definitions:
```typescript
import { AkeneoClient, Product, Category, Family } from '@schally/node-akeneo-api-client';
const client = new AkeneoClient({
baseUrl: 'https://your-akeneo-instance.com',
clientId: 'your-client-id',
secret: 'your-client-secret',
username: 'your-username',
password: 'your-password'
});
// TypeScript will provide full autocompletion and type checking
const products: Product[] = await client.products.list();
const category: Category = await client.categories.get('category-code');
```
## Contributing
We welcome contributions from the community! Please read our [Contributing Guide](CONTRIBUTING.md) to get started.
### Reporting Issues
If you find a bug or want to request a feature:
1. Check if the issue already exists in the [Issues](https://github.com/schallym/node-akeneo-api-client/issues) section
2. If not, create a new issue with:
- Clear description of the problem or feature request
- Steps to reproduce (for bugs)
- Expected vs actual behavior
- Your environment details (Node.js version, OS, etc.)
### Code of Conduct
By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md).
## Supported Akeneo Versions
- Akeneo PIM Cloud Edition
Most API endpoints are supported for both Community and Enterprise editions, but some features may be exclusive to the Cloud edition.
Always refer to the [Akeneo API documentation](https://api.akeneo.com/api-reference-index.html) for specific endpoint availability.
## Requirements
- Node.js 20.0 or higher
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Changelog
See [CHANGELOG.md](CHANGELOG.md) for a detailed list of changes.
## Support
- 🐛 [Bug Reports](https://github.com/schallym/node-akeneo-api-client/issues)
## Related Projects
- [Official Akeneo PHP Client](https://github.com/akeneo/api-php-client)
- [Akeneo API Documentation](https://api.akeneo.com/)
## Acknowledgments
- Thanks to all contributors who have helped make this project better
- Built with ❤️ for the Akeneo community
---
Made with ❤️ by [schallym](https://github.com/schallym) and [contributors](https://github.com/schallym/node-akeneo-api-client/graphs/contributors).