Skip to content

Plenty

service_omni — Endpoints: Plenty

Location: backend/service_omni/app/api/v1/endpoints/plenty.py

Summary

  • Manage Plenty API credentials and start export/cleanup tasks.

Routes

  • POST /plenty/credentials/ — Create Plenty credential. Body model: PlentyCredentialsCreate (fields: username, password, plenty_id, active_omni, is_active).

Example request:

{
  "username": "plenty_user",
  "password": "secret",
  "plenty_id": 906,
  "active_omni": true,
  "is_active": true
}

Curl:

curl -X POST "http://localhost:8000/api/v1/plenty/credentials/" \
  -H "Content-Type: application/json" \
  -d '{"username":"plenty_user","password":"...","plenty_id":906,"active_omni":true,"is_active":true}'
  • GET /plenty/credentials/ — List credentials.
  • PUT /plenty/credentials/{credential_id} — Update credential (PlentyCredentialsUpdate).
  • POST /plenty/credentials/{credential_id}/toggle-active — Toggle active status.
  • DELETE /plenty/credentials/{credential_id} — Delete credential.
  • POST /plenty/credentials/test — Test a credential using PlentyCredentialTestRequest (returns validation result).

Implementation & notes