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

npm install @schally/node-akeneo-api-client

Quick Start

Basic Setup

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

// 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 for detailed information on each endpoint.

Error Handling

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:

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 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 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.

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 for specific endpoint availability.

Requirements

• Node.js 20.0 or higher

License

This project is licensed under the MIT License - see the LICENSE file for details.

Changelog

See CHANGELOG.md for a detailed list of changes.

Support

• 🐛 Bug Reports

Related Projects

• Official Akeneo PHP Client
• Akeneo API Documentation

Acknowledgments

• Thanks to all contributors who have helped make this project better
• Built with ❤️ for the Akeneo community

Made with ❤️ by schallym and contributors.