# @netresearch/node-magento-eqp

> Simple API wrapper around the Magento Marketplace EQP API

Latest version **5.0.0** (published 2026-02-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install @netresearch/node-magento-eqp
pnpm add @netresearch/node-magento-eqp
yarn add @netresearch/node-magento-eqp
bun add @netresearch/node-magento-eqp
```

## Health

**Score 60/100 (C)** — status: stable.

Positive: has types; no vulnerabilities; has provenance; high maintenance score.

Warnings: low downloads; no esm support.

## Facts

| | |
|---|---|
| Version | 5.0.0 |
| Published | 2026-02-17 |
| First published | 2021-04-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=20 |
| Dependencies | 1 |
| Unpacked size | 50.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 8 |
| Author | DevMiner |
| Maintainers | cybot, powlomat, netresearch.admin, gitsko |

## Links

- npm: https://www.npmjs.com/package/@netresearch/node-magento-eqp
- Repository: https://github.com/netresearch/node-magento-eqp
- Homepage: https://github.com/netresearch/node-magento-eqp#readme
- Issues: https://github.com/netresearch/node-magento-eqp/issues
- npm.io page: https://npm.io/package/@netresearch/node-magento-eqp

## Dependencies (1)

- [tslib](https://npm.io/package/tslib.md) ^2.6.0

## Recent versions

- 5.0.0 (latest) — 2026-02-17
- 4.1.0 — 2026-02-16
- 4.0.8 — 2025-09-17
- 4.0.7 — 2024-10-08
- 4.0.5 — 2024-01-10
- 4.0.4 — 2023-09-18
- 4.0.3 — 2023-09-15
- 4.0.2 — 2023-08-25
- 4.0.1 — 2023-07-21
- 4.0.0 — 2023-07-21
- 3.0.3 — 2023-05-02
- 3.0.2 — 2023-01-02
- 3.0.1 — 2023-01-02
- 3.0.0 — 2022-11-28
- 2.0.6 — 2021-09-08
- … 14 more at https://npm.io/package/@netresearch/node-magento-eqp/versions

## README

# @netresearch/node-magento-eqp

[![npm version](https://img.shields.io/npm/v/@netresearch/node-magento-eqp?style=flat-square)](https://www.npmjs.com/package/@netresearch/node-magento-eqp)
[![CI](https://img.shields.io/github/actions/workflow/status/netresearch/node-magento-eqp/lint.and.build.yml?branch=main&style=flat-square&label=CI)](https://github.com/netresearch/node-magento-eqp/actions/workflows/lint.and.build.yml)
[![CodeQL](https://img.shields.io/github/actions/workflow/status/netresearch/node-magento-eqp/codeql.yml?branch=main&style=flat-square&label=CodeQL)](https://github.com/netresearch/node-magento-eqp/actions/workflows/codeql.yml)
[![License: MIT](https://img.shields.io/npm/l/@netresearch/node-magento-eqp?style=flat-square)](https://github.com/netresearch/node-magento-eqp/blob/main/LICENSE)
[![Node.js](https://img.shields.io/node/v/@netresearch/node-magento-eqp?style=flat-square)](https://nodejs.org)
[![TypeScript](https://img.shields.io/badge/TypeScript-strict-blue?style=flat-square)](https://www.typescriptlang.org/)
[![Documentation](https://img.shields.io/badge/docs-TypeDoc-green?style=flat-square)](https://netresearch.github.io/node-magento-eqp)

TypeScript API wrapper for the [Adobe Commerce Marketplace EQP API](https://developer.adobe.com/commerce/marketplace/guides/eqp/v1/).

## Installation

```sh
yarn add @netresearch/node-magento-eqp
```

or

```sh
npm install @netresearch/node-magento-eqp
```

## Usage

### TypeScript (ES Modules)

```typescript
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)

```javascript
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](https://netresearch.github.io/node-magento-eqp).

## Related packages

- [`@netresearch/node-red-contrib-magento-eqp`](https://github.com/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](CONTRIBUTING.md) for details.

## License

[MIT](LICENSE) - Netresearch DTT GmbH

---
_Source: https://npm.io/package/@netresearch/node-magento-eqp · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._