Vorrio-API-Referenz

Die öffentliche REST-API ist unter /api/v1 versioniert. Diese Referenz wird aus dem eingecheckten OpenAPI-Vertrag erstellt und erfordert keine laufende Vorrio-Instanz.

Verwenden Sie bei Anfragen den eigenen HTTPS-Ursprung einer echten Installation. Unterstützte Automatisierungsendpunkte akzeptieren bereichsbezogene Bearer-Tokens, die von einem Eigentümer oder Administrator erstellt wurden. Platzieren Sie niemals ein Token in einer URL, einem öffentlichen Repository oder einer im Browser sichtbaren Dashboard-Konfiguration.

OpenAPI 3.1.0 · Vorrio 0.8.26

REST-API erkunden

Durchsuche den eingecheckten öffentlichen Vertrag, ohne eine Verbindung zu einem Haushalt herzustellen. Von dieser Dokumentationsseite werden keine Anfragen ausgeführt.

OpenAPI-JSON herunterladen

Gruppe

103 / 103 Operationen

System

GET/api/healthÜberprüfen Sie den Zustand der Instanz

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: health_api_health_get
Authentifizierung: Keine Anforderung auf Operationsebene

GET/api/readinessÜberprüfen Sie die Bereitstellungsbereitschaft

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: readiness_api_readiness_get
Authentifizierung: Keine Anforderung auf Operationsebene

GET/api/v1/statusInstanz- und Connector-Status lesen

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: status_api_v1_status_get
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

Authentifizierung

GET/api/v1/auth/api-token-scopesVerfügbare Bereiche für Automatisierungstoken auflisten

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: api_token_scopes_api_v1_auth_api_token_scopes_get
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

GET/api/v1/auth/api-tokensListen Sie die Automatisierungstoken des aktuellen Kontos auf

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: api_tokens_api_v1_auth_api_tokens_get
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

POST/api/v1/auth/api-tokensErstellen Sie ein bereichsbezogenes Automatisierungstoken

Gibt den Rohträger-Token genau einmal zurück. Vorrio speichert nur seinen SHA-256-Hash. Der Token ist auf die ausgewählten Bereiche beschränkt und läuft nach maximal 365 Tagen ab.

Operations-ID: create_api_token_api_v1_auth_api_tokens_post
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

DELETE/api/v1/auth/api-tokens/{token_id}Widerrufen Sie ein Automatisierungstoken

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: revoke_api_token_api_v1_auth_api_tokens__token_id__delete
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

GET/api/v1/auth/invitationsListen Sie aktive Haushaltseinladungen auf

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: household_invitations_api_v1_auth_invitations_get
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

POST/api/v1/auth/invitationsErstellen Sie eine Einwegeinladung für den Haushalt

Gibt das rohe Einladungstoken genau einmal zurück. Es wird nur sein SHA-256-Hash gespeichert. Der Einladende gibt den PWA-Link desselben Ursprungs privat weiter.

Operations-ID: create_household_invitation_api_v1_auth_invitations_post
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

DELETE/api/v1/auth/invitations/{invitation_id}Widerrufen Sie eine ungenutzte Haushaltseinladung

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: revoke_household_invitation_api_v1_auth_invitations__invitation_id__delete
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

GET/api/v1/auth/invitations/{token}Lesen Sie eine Einladung zur einmaligen Verwendung

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: household_invitation_api_v1_auth_invitations__token__get
Authentifizierung: Keine Anforderung auf Operationsebene

POST/api/v1/auth/invitations/{token}/acceptNehmen Sie eine Einladung an und erstellen Sie das Mitgliedskonto

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: accept_household_invitation_api_v1_auth_invitations__token__accept_post
Authentifizierung: Keine Anforderung auf Operationsebene

POST/api/v1/auth/loginErstellen Sie eine Haushaltssitzung

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: login_api_v1_auth_login_post
Authentifizierung: Keine Anforderung auf Operationsebene

POST/api/v1/auth/logoutBeenden Sie die aktuelle Sitzung

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: logout_api_v1_auth_logout_post
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

GET/api/v1/auth/meValidieren Sie die aktuelle Sitzung

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: me_api_v1_auth_me_get
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

GET/api/v1/auth/membersListen Sie die Haushaltsmitglieder auf

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: household_members_api_v1_auth_members_get
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

PATCH/api/v1/auth/members/{user_id}Ändern Sie eine Mitgliedsrolle oder einen Zugriffsstatus

Die Eigentümermitgliedschaft kann über diesen Endpunkt nicht geändert werden. Administratoren können Mitglieder und Zuschauer verwalten, jedoch keinen Administratorzugriff gewähren oder verwalten.

Operations-ID: update_household_member_api_v1_auth_members__user_id__patch
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

POST/api/v1/auth/mfa/verifyBeenden Sie eine Passwort-Anmeldung mit einem zweiten Faktor

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: verify_login_mfa_api_v1_auth_mfa_verify_post
Authentifizierung: Keine Anforderung auf Operationsebene

POST/api/v1/auth/passkeys/authentication/beginStarten Sie die passwortlose Passkey-Authentifizierung

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: begin_passkey_authentication_api_v1_auth_passkeys_authentication_begin_post
Authentifizierung: Keine Anforderung auf Operationsebene

POST/api/v1/auth/passkeys/authentication/completeVollständige passwortlose Passkey-Authentifizierung

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: complete_passkey_authentication_api_v1_auth_passkeys_authentication_complete_post
Authentifizierung: Keine Anforderung auf Operationsebene

POST/api/v1/auth/passkeys/registration/beginStarten Sie die Passkey-Registrierung

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: begin_passkey_registration_api_v1_auth_passkeys_registration_begin_post
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

POST/api/v1/auth/passkeys/registration/completeÜberprüfen und speichern Sie einen Passkey

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: complete_passkey_registration_api_v1_auth_passkeys_registration_complete_post
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

DELETE/api/v1/auth/passkeys/{credential_id}Löschen Sie einen Passkey

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: delete_passkey_api_v1_auth_passkeys__credential_id__delete
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

PUT/api/v1/auth/passwordÄndern Sie das aktuelle Kontopasswort

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: change_password_api_v1_auth_password_put
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

PATCH/api/v1/auth/preferencesAktualisieren Sie die persönlichen Benutzeroberflächeneinstellungen

Speichert das unterstützte BCP 47-Schnittstellengebietsschema des angemeldeten Benutzers. Die Präferenz ist persönlich und hat keinen Einfluss auf die Produktdaten, die Währung oder die Installationszeitzone des Haushalts.

Operations-ID: update_user_preferences_api_v1_auth_preferences_patch
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

PATCH/api/v1/auth/profileVervollständigen oder aktualisieren Sie das Eigentümerprofil

Benennt den ersten Besitzer, der aus dem früheren Haushaltspasswort erstellt wurde. Die optionale E-Mail wird lokal gespeichert und identifiziert das Konto bei der Anmeldung mit dem Wiederherstellungscode.

Operations-ID: update_owner_profile_api_v1_auth_profile_patch
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

POST/api/v1/auth/reauthenticateBestätigen Sie die Identität vor einer sensiblen Änderung

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: reauthenticate_api_v1_auth_reauthenticate_post
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

POST/api/v1/auth/recoveryStellen Sie ein Konto mit einem einmaligen Wiederherstellungscode wieder her

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: recovery_login_api_v1_auth_recovery_post
Authentifizierung: Keine Anforderung auf Operationsebene

POST/api/v1/auth/recovery-codesErsetzen Sie alle Einweg-Wiederherstellungscodes

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: regenerate_recovery_codes_api_v1_auth_recovery_codes_post
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

GET/api/v1/auth/securityLesen Sie Passkey, TOTP und Wiederherstellungsstatus

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: auth_security_api_v1_auth_security_get
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

GET/api/v1/auth/sessionsAktive Browsersitzungen auflisten

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: auth_sessions_api_v1_auth_sessions_get
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

POST/api/v1/auth/sessions/revoke-othersWiderrufen Sie jede zweite Browsersitzung

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: revoke_other_auth_sessions_api_v1_auth_sessions_revoke_others_post
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

DELETE/api/v1/auth/sessions/{session_id}Widerrufen Sie eine Browsersitzung

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: revoke_auth_session_api_v1_auth_sessions__session_id__delete
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

POST/api/v1/auth/setupKomplette Ersteinrichtung

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: setup_api_v1_auth_setup_post
Authentifizierung: Keine Anforderung auf Operationsebene

GET/api/v1/auth/stateLesen Sie den Setup- und Sitzungsstatus

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: auth_state_api_v1_auth_state_get
Authentifizierung: Keine Anforderung auf Operationsebene

DELETE/api/v1/auth/totpDeaktivieren Sie die Authentifizierungs-App-Überprüfung

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: disable_totp_api_v1_auth_totp_delete
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

POST/api/v1/auth/totp/enableÜberprüfen und aktivieren Sie eine Authentifizierungs-App

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: enable_totp_api_v1_auth_totp_enable_post
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

POST/api/v1/auth/totp/setupErstellen Sie ein ausstehendes Authentifikator-App-Geheimnis

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: setup_totp_api_v1_auth_totp_setup_post
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

Katalog

GET/api/v1/catalog/barcodes/{barcode}/lookupLösen Sie einen Barcode lokal oder über Open Facts auf

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: catalog_barcode_lookup_api_v1_catalog_barcodes__barcode__lookup_get
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

GET/api/v1/catalog/master-dataListen Sie Standorte, Einheiten und Produktgruppen auf

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: catalog_master_data_api_v1_catalog_master_data_get
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

POST/api/v1/catalog/master-data/{kind}Erstellen Sie einen Katalogstammdateneintrag

Unterstützte Arten sind Standorte, Mengeneinheiten und Produktgruppen.

Operations-ID: create_catalog_master_data_api_v1_catalog_master_data__kind__post
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

DELETE/api/v1/catalog/master-data/{kind}/{item_id}Archivieren Sie einen nicht verwendeten Katalogstammdateneintrag

Der Eintrag wird archiviert statt physisch gelöscht. Die Archivierung wird blockiert, solange ein aktives Produkt sie noch verwendet.

Operations-ID: archive_catalog_master_data_api_v1_catalog_master_data__kind___item_id__delete
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

PATCH/api/v1/catalog/master-data/{kind}/{item_id}Benennen Sie einen Katalogstammdateneintrag um oder bearbeiten Sie ihn

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: update_catalog_master_data_api_v1_catalog_master_data__kind___item_id__patch
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

GET/api/v1/catalog/productsSuchen Sie nach Katalogprodukten

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: catalog_products_api_v1_catalog_products_get
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

POST/api/v1/catalog/productsErstellen Sie ein lokales Katalogprodukt

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: create_catalog_product_api_v1_catalog_products_post
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

GET/api/v1/catalog/products/{product_id}Lesen Sie ein Produkt mit Varianten und Barcodes

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: catalog_product_detail_api_v1_catalog_products__product_id__get
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

PATCH/api/v1/catalog/products/{product_id}Bearbeiten Sie ein lokales Katalogprodukt

Aktualisiert bestätigte Haushaltsfelder mit optimistischer Parallelität. Ein umbenanntes Produkt behält seinen alten normalisierten Namen als Alias, sodass frühere Quittungsformulierungen weiterhin aufgelöst werden.

Operations-ID: update_catalog_product_api_v1_catalog_products__product_id__patch
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

DELETE/api/v1/catalog/products/{product_id}/imageEntfernen Sie das aktuelle Produktbild

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: delete_catalog_product_image_api_v1_catalog_products__product_id__image_delete
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

GET/api/v1/catalog/products/{product_id}/imageLesen Sie ein lokal verwaltetes Produktbild

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: catalog_product_image_api_v1_catalog_products__product_id__image_get
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

POST/api/v1/catalog/products/{product_id}/imageLaden Sie ein privates Produktbild hoch

Akzeptiert JPEG, PNG oder WebP, entfernt Kamerametadaten und speichert ein optimiertes WebP im lokalen Datenvolumen Vorrio.

Operations-ID: upload_catalog_product_image_api_v1_catalog_products__product_id__image_post
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

GET/api/v1/catalog/products/{product_id}/price-historyListen Sie die Quittungspreise für ein Katalogprodukt auf

Gibt vom Beleg abgeleitete Preise mit Filial- und Paketvariantenkontext zurück. Es werden keine Bank- oder Zahlungsdaten gespeichert.

Operations-ID: catalog_product_price_history_api_v1_catalog_products__product_id__price_history_get
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

POST/api/v1/catalog/products/{product_id}/variantsFügen Sie eine verkaufsfähige Produktvariante hinzu

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: create_catalog_variant_api_v1_catalog_products__product_id__variants_post
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

POST/api/v1/catalog/reconcileBewerten Sie nicht aufgelöste Wareneingangszeilen neu

Verwendet nur den lokalen Produktkatalog und erlernte Zuordnungen. Genaue Übereinstimmungen können automatisch zugewiesen werden; Fuzzy-Kandidaten bleiben immer Vorschläge.

Operations-ID: reconcile_catalog_receipts_api_v1_catalog_reconcile_post
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

DELETE/api/v1/catalog/variants/{variant_id}Löschen Sie eine nicht verwendete Produktvariante

Das Löschen ist gesperrt, solange ein Beleg, ein Bestandslos oder ein Scan noch auf die Variante verweist.

Operations-ID: delete_catalog_variant_api_v1_catalog_variants__variant_id__delete
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

PATCH/api/v1/catalog/variants/{variant_id}Bearbeiten Sie eine Produktvariante

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: update_catalog_variant_api_v1_catalog_variants__variant_id__patch
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

POST/api/v1/catalog/variants/{variant_id}/barcodesFügen Sie einer Produktvariante einen Barcode hinzu

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: create_catalog_barcode_api_v1_catalog_variants__variant_id__barcodes_post
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

DELETE/api/v1/catalog/variants/{variant_id}/barcodes/{barcode}Trennen Sie einen Barcode von einer Produktvariante

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: delete_catalog_barcode_api_v1_catalog_variants__variant_id__barcodes__barcode__delete
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

Nutzungserlebnis

GET/api/v1/experienceLesen Sie den persönlichen Onboarding- und Release-Note-Status

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: get_experience_api_v1_experience_get
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

PUT/api/v1/experienceSchließen Sie das Onboarding ab oder bestätigen Sie die aktuelle Version

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: update_experience_api_v1_experience_put
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

Grocy-Kompatibilität

GET/api/v1/grocy/master-dataGrocy-Stammdaten lesen

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: grocy_master_data_api_v1_grocy_master_data_get
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang
Status: Veraltet

GET/api/v1/grocy/productsSuchen Sie nach Grocy-Produkten

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: search_products_api_v1_grocy_products_get
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang
Status: Veraltet

POST/api/v1/receipts/{receipt_id}/items/{item_id}/create-productErstellen und ordnen Sie ein Grocy-Produkt zu

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: create_and_map_product_api_v1_receipts__receipt_id__items__item_id__create_product_post
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang
Status: Veraltet

Auswertungen

GET/api/v1/insights/budgetFassen Sie das Haushaltsbudget anhand der bestätigten Belege zusammen

Gibt die monatlichen Ausgaben, eine tempobasierte Prognose, einen vergleichbaren Vorzeitraum, den monatlichen Verlauf, Filialanteile und eine explizite Abdeckungsdiagnose zurück. Es werden nur Zugänge mit mindestens einem bestätigten Bestandsimport gezählt; Historische Quittungswerte werden niemals als Live-Marktpreise dargestellt.

Operations-ID: budget_overview_api_v1_insights_budget_get
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

PUT/api/v1/insights/budget/settingsLegen Sie das gemeinsame monatliche Haushaltsbudget fest oder löschen Sie es

Besitzer- und Administratorsitzungen können ein EUR Monatslimit und einen Warnschwellenwert für den Haushalt festlegen. Ein Null-Limit entfernt das Ziel, ohne die Belege zu ändern.

Operations-ID: update_budget_settings_api_v1_insights_budget_settings_put
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

GET/api/v1/insights/pricesFassen Sie bestätigte Empfangspreise nach Produkt und Geschäft zusammen

Erstellt eine schreibgeschützte Haushaltspreisübersicht aus bestätigten Belegimporten. Bei den Store-Werten handelt es sich um historische Beobachtungen, nicht um aktuelle Preise oder Verfügbarkeiten.

Operations-ID: price_insights_api_v1_insights_prices_get
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

Integrationen

POST/api/v1/integrations/grocy/import-catalogImportieren oder aktualisieren Sie den lokalen Katalog von Grocy

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: import_grocy_catalog_api_v1_integrations_grocy_import_catalog_post
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

GET/api/v1/integrations/grocy/stock-previewVorschau der zugeordneten Grocy-Guthaben, ohne Vorrio zu ändern

Liest den konfigurierten Grocy-Bestand und ordnet ihn zuvor importierten Katalogprodukten zu. Bei der Antwort handelt es sich lediglich um einen Überprüfungsvorschlag; Bestandsänderungen erfordern eine separate Bestätigung von POST bis /api/v1/stock/counts.

Operations-ID: grocy_stock_preview_api_v1_integrations_grocy_stock_preview_get
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

Benachrichtigungen

PUT/api/v1/notifications/preferencesAktualisieren Sie die Einstellungen für persönliche Aktienbenachrichtigungen

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: update_notification_preferences_api_v1_notifications_preferences_put
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

GET/api/v1/notifications/statePersönliche Web Push-Einstellungen und Geräte lesen

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: notification_state_api_v1_notifications_state_get
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

POST/api/v1/notifications/subscriptionsRegistrieren oder aktualisieren Sie ein Browser-Push-Gerät

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: register_push_subscription_api_v1_notifications_subscriptions_post
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

DELETE/api/v1/notifications/subscriptions/{subscription_id}Ein persönliches Push-Gerät widerrufen

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: revoke_push_subscription_api_v1_notifications_subscriptions__subscription_id__delete
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

POST/api/v1/notifications/testSenden Sie eine sichtbare Testbenachrichtigung an ein persönliches Gerät

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: test_push_notification_api_v1_notifications_test_post
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

Datenschutz und Betrieb

GET/api/v1/operations/overviewLesen Sie die Übersicht über datenschutzsichere Eigentümervorgänge

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: operations_overview_api_v1_operations_overview_get
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

GET/api/v1/privacy/exportLaden Sie einen geheimnisfreien tragbaren Haushaltsexport herunter

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: privacy_export_api_v1_privacy_export_get
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

GET/api/v1/privacy/export/previewVorschau des tragbaren Haushaltsexports

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: privacy_export_preview_api_v1_privacy_export_preview_get
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

DELETE/api/v1/privacy/householdLöschen Sie diese Einfamilienhausinstallation endgültig

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: privacy_erase_household_api_v1_privacy_household_delete
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

GET/api/v1/privacy/retentionVorschau der Aufbewahrung von Belegdateien

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: privacy_retention_preview_api_v1_privacy_retention_get
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

POST/api/v1/privacy/retention/runWenden Sie jetzt die Aufbewahrung von Belegdateien an

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: privacy_retention_run_api_v1_privacy_retention_run_post
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

Kassenbons

GET/api/v1/receiptsListen Sie aktuelle Belege auf

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: receipts_api_v1_receipts_get
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

POST/api/v1/receipts/analyzeAnalysieren Sie ein Bild oder eine PDF-Quittung

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: analyze_api_v1_receipts_analyze_post
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

GET/api/v1/receipts/{receipt_id}Holen Sie sich eine Quittung mit allen Zeilen

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: receipt_api_v1_receipts__receipt_id__get
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

POST/api/v1/receipts/{receipt_id}/importÜbertragen Sie überprüfte Zeilen auf den lokalen Bestand

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: import_receipt_api_v1_receipts__receipt_id__import_post
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

PATCH/api/v1/receipts/{receipt_id}/items/{item_id}Ordnen Sie eine Wareneingangsposition einem Katalogprodukt zu

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: map_item_api_v1_receipts__receipt_id__items__item_id__patch
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

POST/api/v1/receipts/{receipt_id}/items/{item_id}/candidateBestätigen und lernen Sie einen echten Produktkandidaten kennen

Lädt den ausgewählten Kandidaten aus dem serverseitigen Cache, verknüpft seinen Barcode, sein Bild und seine Verpackungsvariante mit einem vorhandenen oder neu erstellten lokalen Produkt, ordnet die Bonzeile zu und merkt sich den Händlertext.

Operations-ID: confirm_receipt_item_candidate_api_v1_receipts__receipt_id__items__item_id__candidate_post
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

GET/api/v1/receipts/{receipt_id}/items/{item_id}/candidatesFinden Sie echte Produktkandidaten für eine Wareneingangslinie

Durchsucht echte Open Facts-Datensätze nur nach einer expliziten Überprüfungsaktion, speichert das Ergebnis 30 Tage lang im Cache und lässt optional den konfigurierten KI-Anbieter die zurückgegebenen Datensätze bewerten. Kandidaten werden niemals automatisch zugewiesen.

Operations-ID: receipt_item_candidates_api_v1_receipts__receipt_id__items__item_id__candidates_get
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

POST/api/v1/receipts/{receipt_id}/items/{item_id}/catalog-productErstellen und ordnen Sie ein lokales Katalogprodukt zu

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: create_and_map_catalog_product_api_v1_receipts__receipt_id__items__item_id__catalog_product_post
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

Scannen

POST/api/v1/scans/resolveLösen Sie einen Paketcode auf, ohne den Lagerbestand zu ändern

Normalisiert den dekodierten Code, überprüft zuerst den lokalen Katalog und den neuen Cache, lehnt Platzhalter-GTINs mit wiederholten Ziffern ab und fragt dann Open Facts nach EAN/UPC/GTIN Codes ab. Interne Codes verlassen niemals die Installation. Unbekannte und Upstream-fehlgeschlagene Codes werden im ungelösten Posteingang gespeichert. Die Wiederverwendung von client_mutation_id gibt denselben Entwurf zurück.

Operations-ID: resolve_scan_api_v1_scans_resolve_post
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

GET/api/v1/scans/unresolvedListen Sie ungelöste Paketscans auf

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: unresolved_scans_api_v1_scans_unresolved_get
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

DELETE/api/v1/scans/{scan_id}Verwerfen Sie einen nicht aufgelösten Scan

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: discard_scan_api_v1_scans__scan_id__delete
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

GET/api/v1/scans/{scan_id}Lesen Sie einen Scan-Entwurf

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: get_scan_api_v1_scans__scan_id__get
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

PATCH/api/v1/scans/{scan_id}Bearbeiten oder ordnen Sie einen ungelösten Scan zu

Aktualisiert Bewertungsvorschläge oder ordnet den Code einem vorhandenen lokalen Produkt zu.

Operations-ID: update_scan_api_v1_scans__scan_id__patch
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

POST/api/v1/scans/{scan_id}/confirmBestätigen Sie die ausgewählte Paketaktion

Erstellt oder ordnet optional das lokale Produkt zu und führt dann genau eine Aktion zum Identifizieren, Hinzufügen, Konsumieren, Öffnen oder zur Einkaufsliste aus. Der Bestätigungsschlüssel macht Wiederholungsversuche sicher.

Operations-ID: confirm_scan_api_v1_scans__scan_id__confirm_post
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

Einstellungen

GET/api/v1/settingsÖffentliche Einstellungen lesen

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: get_settings_api_v1_settings_get
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

PUT/api/v1/settingsInstanzeinstellungen ersetzen

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: save_settings_api_v1_settings_put
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

POST/api/v1/settings/test-grocyTesten Sie den Grocy-Anschluss

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: test_grocy_api_v1_settings_test_grocy_post
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

POST/api/v1/settings/test-providerTesten Sie den ausgewählten Analyseanbieter

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: provider_test_api_v1_settings_test_provider_post
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

Einkäufe

GET/api/v1/shopping-listListen Sie offene Haushaltseinkäufe auf

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: shopping_list_api_v1_shopping_list_get
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

POST/api/v1/shopping-list/generateGenerieren Sie überprüfte Artikel auf der Einkaufsliste aus geringen Lagerbeständen

Überprüft jedes ausgewählte Produkt erneut transaktionsmäßig. Vorhandene offene Posten werden nur dann erhöht, wenn der berechnete Mangel größer ist, und ein Idempotenzschlüssel verhindert, dass Netzwerkwiederholungsversuche zweimal hinzugefügt werden.

Operations-ID: generate_shopping_list_api_v1_shopping_list_generate_post
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

GET/api/v1/shopping-list/low-stockSehen Sie sich Produkte unterhalb des konfigurierten Mindestbestands in der Vorschau an

Gibt einen schreibgeschützten Vorschlag zurück. Produkte ohne aktives Nachfüllziel werden ausgelassen, und bis zur Bestätigung der Generierung ändert sich kein Artikel auf der Einkaufsliste.

Operations-ID: shopping_low_stock_api_v1_shopping_list_low_stock_get
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

PATCH/api/v1/shopping-list/{item_id}Bearbeiten oder vervollständigen Sie einen Einkaufslisteneintrag

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: update_shopping_list_item_api_v1_shopping_list__item_id__patch
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

Vorrat

GET/api/v1/stock/count/productsListen Sie Produkte für eine überprüfte Bestandszählung auf

Gibt den kompletten aktiven Katalog inklusive aktueller Summen, Varianten und Standardstammdaten zurück. Das Lesen dieses Endpunkts ändert nie den Bestand.

Operations-ID: stock_count_products_api_v1_stock_count_products_get
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

GET/api/v1/stock/countsListen Sie abgeschlossene Bestandszählungen auf

Diese Operation ist im kanonischen Vorrio-OpenAPI-Vertrag definiert.

Operations-ID: stock_counts_api_v1_stock_counts_get
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

POST/api/v1/stock/countsWenden Sie eine überprüfte Öffnungs- oder Korrekturzählung an

Es werden nur explizit eingereichte Produkte geändert. Jede Zeile legt die gezählte Summe für ein Produkt fest; Ausgelassene Produkte bleiben davon unberührt. Positive und negative Differenzen führen zu reinen Anhang-Bestandsbewegungen. Die Wiederverwendung derselben Client-Mutations-ID gibt das ursprüngliche Ergebnis zurück.

Operations-ID: create_stock_count_api_v1_stock_counts_post
Authentifizierung: Sitzung oder unterstütztes Bearer-Token mit eingeschränktem Umfang

Vorrio-API-Referenz ​

REST-API erkunden

System

Authentifizierung

Katalog

Nutzungserlebnis

Grocy-Kompatibilität

Auswertungen

Integrationen

Benachrichtigungen

Datenschutz und Betrieb

Kassenbons

Scannen

Einstellungen

Einkäufe

Vorrat

Vorrio-API-Referenz