README.md

@netresearch/node-magento-eqp

TypeScript API wrapper for the Adobe Commerce Marketplace EQP API.

Installation

yarn add @netresearch/node-magento-eqp

or

npm install @netresearch/node-magento-eqp

Usage

TypeScript (ES Modules)

import { EQP } from '@netresearch/node-magento-eqp';

const eqp = new EQP({
	appId: 'YOUR_APP_ID',
	appSecret: 'YOUR_APP_SECRET',
	environment: 'sandbox' // or 'production' (default)
});

const packages = await eqp.packageService.getPackages();

JavaScript (CommonJS)

const { EQP } = require('@netresearch/node-magento-eqp');

(async () => {
	const eqp = new EQP({
		appId: 'YOUR_APP_ID',
		appSecret: 'YOUR_APP_SECRET'
	});

	const packages = await eqp.packageService.getPackages();
	console.log(packages);
})();

Available services

Service	Description
packageService	List and retrieve extension/theme packages
fileService	File upload metadata
userService	User profile management
keyService	Magento access keys (M1/M2)
callbackService	Webhook registration and event enrichment
reportService	Marketplace analytics (experimental)

Constructor options

Option	Type	Default	Description
appId	string	required	Your EQP application ID
appSecret	string	required	Your EQP application secret
environment	'production' | 'sandbox'	'production'	API environment
autoRefresh	boolean	false	Reserved for future use
expiresIn	number	360	Reserved for future use
adapter	Adapter	FetchAdapter	Custom HTTP adapter

API documentation

Full API documentation is available at netresearch.github.io/node-magento-eqp.

Related packages

• @netresearch/node-red-contrib-magento-eqp — Node-RED nodes for Magento EQP callbacks

Contributing

Contributions, issues, and feature requests are welcome. See the contributing guide for details.

License

MIT - Netresearch DTT GmbH