{"id":50474485,"url":"https://github.com/schallym/node-akeneo-api-client","last_synced_at":"2026-06-01T12:03:17.957Z","repository":{"id":301798318,"uuid":"1010330934","full_name":"schallym/node-akeneo-api-client","owner":"schallym","description":"Node client for Akeneo PIM REST API","archived":false,"fork":false,"pushed_at":"2026-05-27T09:08:31.000Z","size":735,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-05-27T10:24:39.862Z","etag":null,"topics":["akeneo","api","api-client","ecommerce","javascript","nodejs","pim","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/schallym.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-06-28T20:58:35.000Z","updated_at":"2026-05-27T09:08:36.000Z","dependencies_parsed_at":"2025-06-28T22:32:23.092Z","dependency_job_id":"a93c0b9a-0d1a-4d13-96ab-85df9e323ddf","html_url":"https://github.com/schallym/node-akeneo-api-client","commit_stats":null,"previous_names":["schallym/node-akeneo-api-client"],"tags_count":43,"template":false,"template_full_name":null,"purl":"pkg:github/schallym/node-akeneo-api-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/schallym%2Fnode-akeneo-api-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/schallym%2Fnode-akeneo-api-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/schallym%2Fnode-akeneo-api-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/schallym%2Fnode-akeneo-api-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/schallym","download_url":"https://codeload.github.com/schallym/node-akeneo-api-client/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/schallym%2Fnode-akeneo-api-client/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33773782,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-01T02:00:06.963Z","response_time":115,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["akeneo","api","api-client","ecommerce","javascript","nodejs","pim","typescript"],"created_at":"2026-06-01T12:03:17.023Z","updated_at":"2026-06-01T12:03:17.947Z","avatar_url":"https://github.com/schallym.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Node Akeneo API Client\n\n[![npm version](https://img.shields.io/npm/v/@schally/node-akeneo-api-client.svg)](https://www.npmjs.com/package/@schally/node-akeneo-api-client)\n[![License](https://img.shields.io/github/license/schallym/node-akeneo-api-client.svg)](LICENSE)\n[![Coverage Status](https://img.shields.io/codecov/c/github/schallym/node-akeneo-api-client.svg)](https://codecov.io/gh/schallym/node-akeneo-api-client)\n[![Known Vulnerabilities](https://snyk.io/test/github/your-org/your-repo/badge.svg)](https://snyk.io/test/github/schallym/node-akeneo-api-client)\n\nA 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.\n\n## Features\n\n- 🚀 **Complete API Coverage** - Supports all Akeneo REST API endpoints\n- 📦 **TypeScript Support** - Full TypeScript definitions included\n- 🔐 **Multiple Authentication Methods** - Classic connection and App connection\n- 🔄 **Automatic Token Refresh** - Handles token expiration automatically\n- 📄 **Pagination Support** - Built-in pagination handling for large datasets\n- 🛡️ **Error Handling** - Comprehensive error handling with detailed messages\n- 🧪 **Well Tested** - Extensive test coverage\n\n## Installation\n\n```bash\nnpm install @schally/node-akeneo-api-client\n```\n\n## Quick Start\n\n### Basic Setup\n\n```javascript\nconst { AkeneoClient } = require('@schally/node-akeneo-api-client');\n\n// Initialize with classic connection\nconst client = new AkeneoClient({\n  baseUrl: 'https://your-akeneo-instance.com',\n  clientId: 'your-client-id',\n  secret: 'your-client-secret',\n  username: 'your-username',\n  password: 'your-password'\n});\n\n// Or initialize with App token\nconst client = new AkeneoClient({\n  baseUrl: 'https://your-akeneo-instance.com',\n  accessToken: 'your-app-token',\n  clientId: 'app-client-id',\n});\n```\n\n### Basic Usage Examples\n\n```javascript\n// List activated products with count\nconst products = await client.products.list({ \n    limit: 10,\n    search: JSON.stringify({ enabled: [{ operator: '=', value: true }] }), \n    with_count: true\n});\n\n// Get a specific product\nconst product = await client.products.get('product-sku');\n\n// Create a new product\nconst newProduct = await client.products.create({\n  identifier: 'new-product-sku',\n  family: 'accessories',\n  values: {\n    name: [{\n      locale: null,\n      scope: null,\n      data: 'My New Product'\n    }]\n  }\n});\n\n// Update a product\nawait client.products.update('product-sku', {\n  values: {\n    description: [{\n      locale: 'en_US',\n      scope: null,\n      data: 'Updated description'\n    }]\n  }\n});\n\n// Delete a product\nawait client.products.delete('product-sku');\n```\n\n## API Reference\n\n### Available Endpoints\n\nPlease refer to the [official Akeneo API documentation](https://api.akeneo.com/api-reference-index.html) for detailed information on each endpoint.\n\n### Error Handling\n\n```javascript\ntry {\n  const product = await client.products.get('non-existent-sku');\n} catch (error) {\n  if (error.status === 404) {\n    console.log('Product not found');\n  } else if (error.status === 401) {\n    console.log('Authentication failed');\n  } else {\n    console.log('API Error:', error.message);\n  }\n}\n```\n\n## TypeScript Support\n\nThis library is written in TypeScript and includes comprehensive type definitions:\n\n```typescript\nimport { AkeneoClient, Product, Category, Family } from '@schally/node-akeneo-api-client';\n\nconst client = new AkeneoClient({\n  baseUrl: 'https://your-akeneo-instance.com',\n  clientId: 'your-client-id',\n  secret: 'your-client-secret',\n  username: 'your-username',\n  password: 'your-password'\n});\n\n// TypeScript will provide full autocompletion and type checking\nconst products: Product[] = await client.products.list();\nconst category: Category = await client.categories.get('category-code');\n```\n\n## Contributing\n\nWe welcome contributions from the community! Please read our [Contributing Guide](CONTRIBUTING.md) to get started.\n\n### Reporting Issues\n\nIf you find a bug or want to request a feature:\n\n1. Check if the issue already exists in the [Issues](https://github.com/schallym/node-akeneo-api-client/issues) section\n2. If not, create a new issue with:\n    - Clear description of the problem or feature request\n    - Steps to reproduce (for bugs)\n    - Expected vs actual behavior\n    - Your environment details (Node.js version, OS, etc.)\n\n### Code of Conduct\n\nBy participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md).\n\n## Supported Akeneo Versions\n\n- Akeneo PIM Cloud Edition\n\nMost API endpoints are supported for both Community and Enterprise editions, but some features may be exclusive to the Cloud edition. \nAlways refer to the [Akeneo API documentation](https://api.akeneo.com/api-reference-index.html) for specific endpoint availability.\n\n## Requirements\n\n- Node.js 20.0 or higher\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Changelog\n\nSee [CHANGELOG.md](CHANGELOG.md) for a detailed list of changes.\n\n## Support\n\n- 🐛 [Bug Reports](https://github.com/schallym/node-akeneo-api-client/issues)\n\n## Related Projects\n\n- [Official Akeneo PHP Client](https://github.com/akeneo/api-php-client)\n- [Akeneo API Documentation](https://api.akeneo.com/)\n\n## Acknowledgments\n\n- Thanks to all contributors who have helped make this project better\n- Built with ❤️ for the Akeneo community\n\n---\n\nMade with ❤️ by [schallym](https://github.com/schallym) and [contributors](https://github.com/schallym/node-akeneo-api-client/graphs/contributors).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fschallym%2Fnode-akeneo-api-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fschallym%2Fnode-akeneo-api-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fschallym%2Fnode-akeneo-api-client/lists"}