🎃 New adapter: PlentyONE / plentymarkets (e-commerce ERP)
Los mantenedores suelen responder en 1 día
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 50/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Bien especificado
- Estado de actividad
- Activo
- Stack tecnológico
- json, typescript
- Área
- api
Línea de trabajo
Create packages/backend/src/adapters/de/plentymarkets.json by copying the LOGIN_TOKEN shape in de/hrworks.json:15-28, and check the authConfig fields against docs/connectors/login-token-auth.md. Add the 8 tools, keeping the write tool at "enabled": false, then run validate-adapters.mjs --warn and adapter-count.mjs --check. Done when the validator is clean, the spec de/plentymarkets.live.spec.ts passes, and no credentials appear in any file. The issue requires a claim comment before work starts.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Part of the October Challenge #997.
Why
PlentyONE (formerly plentymarkets) is one of the most widely used e-commerce ERPs among German online retailers: orders, items and variations, stock across warehouses, and customer contacts for shops and marketplaces such as Amazon, eBay and Otto. The catalog has JTL-Wawi, Xentral, weclapp and Billbee, but no plentymarkets (grep -ril plenty packages/backend/src/adapters finds nothing). With an adapter, a user could ask "which orders from yesterday are still in status 5?", "how much stock of SKU X is in the main warehouse?" or "show customer 1234's last orders".
Self-hosted vs Cloud
- Self-hosted: available in Community and Business; no edition gating.
- Cloud (
DEPLOYMENT_MODE=cloud): available. PlentyONE systems are public SaaS (https://p<PID>.my.plentysystems.com), so the SSRF guard allows them. On Cloud trial plans, installs count toward the connector limit (license-guard.service.ts:65). - Who can use it: any role except VIEWER can install it (
adapters.controller.ts:207). The username and password live encrypted in the organization's own connectorauthConfig. The cached bearer token is encrypted too and keyed by connector (docs/connectors/login-token-auth.md, "Security notes"). Nothing is shared across organizations.
What to build
packages/backend/src/adapters/de/plentymarkets.json. Start with npm run adapter:new -- plentymarkets --region de --auth LOGIN_TOKEN.
- API docs: https://developers.plentymarkets.com/en-gb/developers/main/rest-api-guides/getting-started.html (REST reference: https://developers.plentymarkets.com/en-gb/plentymarkets-rest-api/index.html; order guide: https://developers.plentymarkets.com/en-gb/developers/main/rest-api-guides/order-data.html).
- Base URL:
{{PLENTY_URL}}/rest, wherePLENTY_URLis e.g.https://p12345.my.plentysystems.com. The exact URL is shown under Setup → Settings → API → Data. - Auth:
LOGIN_TOKEN.POST {{PLENTY_URL}}/rest/loginwith{"username": "${username}", "password": "${password}"}returns{token_type, expires_in: 86400, access_token, refresh_token}. MaptokenJsonPath: "access_token",expiryJsonPath: "expires_in",expiryFormat: "ttl_seconds",refreshOn401: true, and setproactiveRefreshSecondswell below 86400 (e.g. 3600). Copy the shape fromde/hrworks.json:15-28. - Env vars:
PLENTY_URL,PLENTY_USERNAME,PLENTY_PASSWORD. Ininstructions, recommend a dedicated REST user with only the needed rights (Setup → Settings → User → Accounts). That user also counts toward the concurrent API user limit (default 3; a 429 means the limit was hit). - Rate limits depend on the plan (Basic: 80 reads/min, 40 writes/min). Put this in
instructions. - Category:
e-commerce. probe:plentymarkets_list_warehouses.
| Tool | Endpoint | Expected hints |
|---|---|---|
plentymarkets_list_orders |
GET /orders (statusFrom, statusTo, createdAtFrom, createdAtTo, contactId, with[], page, itemsPerPage) |
read-only |
plentymarkets_get_order |
GET /orders/{orderId} (with[]=orderItems, addresses) |
read-only |
plentymarkets_list_variations |
GET /items/variations (numberExact, itemName, barcode, isActive) |
read-only |
plentymarkets_list_stock |
GET /stockmanagement/stock (variationId, warehouseId) |
read-only |
plentymarkets_list_warehouses |
GET /stockmanagement/warehouses |
read-only |
plentymarkets_list_contacts |
GET /accounts/contacts (email, fullText, page) |
read-only |
plentymarkets_get_contact |
GET /accounts/contacts/{contactId} |
read-only |
plentymarkets_update_order_status |
PUT /orders/{orderId} with body {statusId} |
write, destructive, idempotent (derived from PUT). Ship it with "enabled": false so a workspace turns it on deliberately |
Hints come from the HTTP method (docs/tool-definition.md:503-545); do not hand-write annotations. Check each path and parameter against the REST reference and note any deviation in the PR.
Where to look
packages/backend/src/adapters/de/hrworks.json:15-28— a workingLOGIN_TOKENadapter (POST credentials, read token, refresh).docs/connectors/login-token-auth.md—authConfigfields (loginUrl,loginBody,tokenJsonPath,expiryJsonPath,expiryFormat).packages/backend/src/adapters/de/jtl-wawi.json— a comparable German commerce ERP; copy how itsinstructionsexplain orders vs items vs stock.packages/backend/src/adapters/intl/todoist.live.spec.ts— spec template; live calls behindRUN_PLENTYMARKETS_LIVE=1..github/CONTRIBUTING.md:136— the "Add an adapter" checklist; #982 — adapter guide.
Acceptance criteria
-
de/plentymarkets.jsonwith the 8 tools above; the write tool has"enabled": false. -
validate-adapters.mjs --warnis clean (the validator requiresinstructions≥ 800 chars and each tool description ≥ 60 chars,scripts/validate-adapters.mjs:32);catalog.tsis regenerated;adapter-count.mjs --checkpasses. -
de/plentymarkets.live.spec.ts: static checks (auth typeLOGIN_TOKEN,loginUrlends with/rest/login,tokenJsonPathisaccess_token, write tool disabled); withRUN_PLENTYMARKETS_LIVE=1it logs in and lists warehouses and orders on a trial system.npx jest src/adapters/de/plentymarketspasses inpackages/backend. - No password or token appears in the spec, the fixtures or the PR.
- Logo at
packages/frontend/public/logos/connectors/plentymarkets.svg. - Docs updated: optional
content/guides/en/plentymarkets-to-mcp.mdx.
Out of scope
- Creating orders, items or contacts; deleting anything; stock corrections (
/stockmanagement/.../correction). - The plugin/Ceres interface, webhooks (event procedures), marketplace-specific endpoints.
- Using
refresh_token. Re-login throughLOGIN_TOKENis enough.
Free account: PlentyONE offers a 30-day free test system without obligation (start from https://www.plentyone.com). Enable REST access for a user in it.
Size
M (1–2 days). The login flow and the order filters need testing against a real trial system.
How to claim
Comment "I'd like to work on this" and we'll assign you. Rules in #997.
- Lenguaje dominante
- TypeScript
- Estrellas
- 856
- Forks
- 82
- Merge medio
- 5 h 18 min
- PR fusionados (30 d)
- 162
Preparar el entorno
Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de HelpCode-ai/anythingmcp
-
Docs: document all SMTP_* and other undocumented env vars for self-hostingPosiblemente ocupada @notlakshitha la tomó hace 1 día. Abiertoenhancement
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
HelpCode-ai/anythingmcp#1049 · 3 comentarios ·
Los mantenedores suelen responder en 1 día
-
good first issue hacktoberfest
Dificultad 2/5 Medio día Aptitud para principiantes 70/100
HelpCode-ai/anythingmcp#996 ·
Los mantenedores suelen responder en 1 día
-
good first issue hacktoberfest
Dificultad 2/5 Medio día Aptitud para principiantes 72/100
HelpCode-ai/anythingmcp#995 ·
Los mantenedores suelen responder en 1 día
-
enhancement good first issue hacktoberfest help wanted
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
HelpCode-ai/anythingmcp#982 ·
Los mantenedores suelen responder en 1 día
-
Upload the new social previewPosiblemente ocupada @helpcodeai la tomó hace 1 día. Abierto
HelpCode-ai/anythingmcp#1087 · 4 comentarios · 1 asignado ·
Los mantenedores suelen responder en 1 día
Todos los issues de HelpCode-ai/anythingmcp
Issues similares
-
test: make the #3408 Claude OAuth token fixture obviously fake so secret scanners stop flagging itAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
code-yeongyu/senpi#3436 ·
Los mantenedores suelen responder en 1 día
-
community first-timers-only good first issue hacktoberfest help wanted low hanging fruit up-for-grabs
Dificultad 1/5 Menos de una hora Aptitud para principiantes 78/100
lingdojo/kana-dojo#32505 · 1 comentario · 5 reacciones ·
Los mantenedores suelen responder en 1 día
-
code-quality refactoring
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
github/gh-aw-firewall#10040 ·
Los mantenedores suelen responder en 1 día
-
review-followup
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
griffinwork40/agent-afk#3868 ·
Los mantenedores suelen responder en 1 día
-
area: import-export bug status: needs-triage
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
amatya-aditya/obsidian-rss-dashboard#1191 ·
Los mantenedores suelen responder en 1 día