Vorrio API reference

The public REST API is versioned under /api/v1. This reference is built from the checked-in OpenAPI contract and does not require a running Vorrio instance.

Use a real installation's own HTTPS origin when making requests. Supported automation endpoints accept scoped bearer tokens created by an Owner or Admin; never place a token in a URL, public repository or browser-visible dashboard configuration.

OpenAPI 3.1.0 · Vorrio 0.8.26

Explore the REST API

Browse the checked-in public contract without connecting to a household. Requests are not executed from this documentation site.

Download OpenAPI JSON

Group

103 / 103 operations

System

GET/api/healthCheck instance health

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: health_api_health_get
Authentication: No operation-level requirement

GET/api/readinessCheck deployment readiness

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: readiness_api_readiness_get
Authentication: No operation-level requirement

GET/api/v1/statusRead instance and connector status

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: status_api_v1_status_get
Authentication: Session or supported scoped bearer token

Authentication

GET/api/v1/auth/api-token-scopesList available automation-token scopes

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: api_token_scopes_api_v1_auth_api_token_scopes_get
Authentication: Session or supported scoped bearer token

GET/api/v1/auth/api-tokensList the current account's automation tokens

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: api_tokens_api_v1_auth_api_tokens_get
Authentication: Session or supported scoped bearer token

POST/api/v1/auth/api-tokensCreate a scoped automation token

Returns the raw bearer token exactly once. Vorrio stores only its SHA-256 hash. The token is restricted to the selected scopes and expires after at most 365 days.

Operation ID: create_api_token_api_v1_auth_api_tokens_post
Authentication: Session or supported scoped bearer token

DELETE/api/v1/auth/api-tokens/{token_id}Revoke one automation token

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: revoke_api_token_api_v1_auth_api_tokens__token_id__delete
Authentication: Session or supported scoped bearer token

GET/api/v1/auth/invitationsList active household invitations

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: household_invitations_api_v1_auth_invitations_get
Authentication: Session or supported scoped bearer token

POST/api/v1/auth/invitationsCreate a single-use household invitation

Returns the raw invitation token exactly once. Only its SHA-256 hash is stored. The inviter shares the same-origin PWA link privately.

Operation ID: create_household_invitation_api_v1_auth_invitations_post
Authentication: Session or supported scoped bearer token

DELETE/api/v1/auth/invitations/{invitation_id}Revoke an unused household invitation

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: revoke_household_invitation_api_v1_auth_invitations__invitation_id__delete
Authentication: Session or supported scoped bearer token

GET/api/v1/auth/invitations/{token}Read a single-use invitation

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: household_invitation_api_v1_auth_invitations__token__get
Authentication: No operation-level requirement

POST/api/v1/auth/invitations/{token}/acceptAccept an invitation and create the member account

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: accept_household_invitation_api_v1_auth_invitations__token__accept_post
Authentication: No operation-level requirement

POST/api/v1/auth/loginCreate a household session

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: login_api_v1_auth_login_post
Authentication: No operation-level requirement

POST/api/v1/auth/logoutEnd the current session

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: logout_api_v1_auth_logout_post
Authentication: Session or supported scoped bearer token

GET/api/v1/auth/meValidate the current session

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: me_api_v1_auth_me_get
Authentication: Session or supported scoped bearer token

GET/api/v1/auth/membersList household members

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: household_members_api_v1_auth_members_get
Authentication: Session or supported scoped bearer token

PATCH/api/v1/auth/members/{user_id}Change a member role or access state

Owner membership cannot be changed through this endpoint. Admins may manage members and viewers but cannot grant or manage admin access.

Operation ID: update_household_member_api_v1_auth_members__user_id__patch
Authentication: Session or supported scoped bearer token

POST/api/v1/auth/mfa/verifyFinish a password login with a second factor

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: verify_login_mfa_api_v1_auth_mfa_verify_post
Authentication: No operation-level requirement

POST/api/v1/auth/passkeys/authentication/beginStart passwordless passkey authentication

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: begin_passkey_authentication_api_v1_auth_passkeys_authentication_begin_post
Authentication: No operation-level requirement

POST/api/v1/auth/passkeys/authentication/completeComplete passwordless passkey authentication

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: complete_passkey_authentication_api_v1_auth_passkeys_authentication_complete_post
Authentication: No operation-level requirement

POST/api/v1/auth/passkeys/registration/beginStart passkey registration

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: begin_passkey_registration_api_v1_auth_passkeys_registration_begin_post
Authentication: Session or supported scoped bearer token

POST/api/v1/auth/passkeys/registration/completeVerify and save a passkey

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: complete_passkey_registration_api_v1_auth_passkeys_registration_complete_post
Authentication: Session or supported scoped bearer token

DELETE/api/v1/auth/passkeys/{credential_id}Delete one passkey

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: delete_passkey_api_v1_auth_passkeys__credential_id__delete
Authentication: Session or supported scoped bearer token

PUT/api/v1/auth/passwordChange the current account password

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: change_password_api_v1_auth_password_put
Authentication: Session or supported scoped bearer token

PATCH/api/v1/auth/preferencesUpdate personal interface preferences

Stores the signed-in user's supported BCP 47 interface locale. The preference is personal and does not alter household product data, currency or installation timezone.

Operation ID: update_user_preferences_api_v1_auth_preferences_patch
Authentication: Session or supported scoped bearer token

PATCH/api/v1/auth/profileComplete or update the owner profile

Names the first owner created from the former household password. The optional email is stored locally and identifies the account during recovery-code login.

Operation ID: update_owner_profile_api_v1_auth_profile_patch
Authentication: Session or supported scoped bearer token

POST/api/v1/auth/reauthenticateConfirm identity before a sensitive change

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: reauthenticate_api_v1_auth_reauthenticate_post
Authentication: Session or supported scoped bearer token

POST/api/v1/auth/recoveryRecover an account with a single-use recovery code

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: recovery_login_api_v1_auth_recovery_post
Authentication: No operation-level requirement

POST/api/v1/auth/recovery-codesReplace all single-use recovery codes

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: regenerate_recovery_codes_api_v1_auth_recovery_codes_post
Authentication: Session or supported scoped bearer token

GET/api/v1/auth/securityRead passkey, TOTP and recovery status

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: auth_security_api_v1_auth_security_get
Authentication: Session or supported scoped bearer token

GET/api/v1/auth/sessionsList active browser sessions

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: auth_sessions_api_v1_auth_sessions_get
Authentication: Session or supported scoped bearer token

POST/api/v1/auth/sessions/revoke-othersRevoke every other browser session

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: revoke_other_auth_sessions_api_v1_auth_sessions_revoke_others_post
Authentication: Session or supported scoped bearer token

DELETE/api/v1/auth/sessions/{session_id}Revoke one browser session

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: revoke_auth_session_api_v1_auth_sessions__session_id__delete
Authentication: Session or supported scoped bearer token

POST/api/v1/auth/setupComplete first-run setup

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: setup_api_v1_auth_setup_post
Authentication: No operation-level requirement

GET/api/v1/auth/stateRead setup and session state

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: auth_state_api_v1_auth_state_get
Authentication: No operation-level requirement

DELETE/api/v1/auth/totpDisable authenticator-app verification

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: disable_totp_api_v1_auth_totp_delete
Authentication: Session or supported scoped bearer token

POST/api/v1/auth/totp/enableVerify and enable an authenticator app

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: enable_totp_api_v1_auth_totp_enable_post
Authentication: Session or supported scoped bearer token

POST/api/v1/auth/totp/setupCreate a pending authenticator-app secret

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: setup_totp_api_v1_auth_totp_setup_post
Authentication: Session or supported scoped bearer token

Catalog

GET/api/v1/catalog/barcodes/{barcode}/lookupResolve a barcode locally or through Open Facts

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: catalog_barcode_lookup_api_v1_catalog_barcodes__barcode__lookup_get
Authentication: Session or supported scoped bearer token

GET/api/v1/catalog/master-dataList locations, units and product groups

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: catalog_master_data_api_v1_catalog_master_data_get
Authentication: Session or supported scoped bearer token

POST/api/v1/catalog/master-data/{kind}Create a catalog master-data entry

Supported kinds are locations, quantity-units and product-groups.

Operation ID: create_catalog_master_data_api_v1_catalog_master_data__kind__post
Authentication: Session or supported scoped bearer token

DELETE/api/v1/catalog/master-data/{kind}/{item_id}Archive an unused catalog master-data entry

The entry is archived instead of physically deleted. Archiving is blocked while an active product still uses it.

Operation ID: archive_catalog_master_data_api_v1_catalog_master_data__kind___item_id__delete
Authentication: Session or supported scoped bearer token

PATCH/api/v1/catalog/master-data/{kind}/{item_id}Rename or edit a catalog master-data entry

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: update_catalog_master_data_api_v1_catalog_master_data__kind___item_id__patch
Authentication: Session or supported scoped bearer token

GET/api/v1/catalog/productsSearch catalog products

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: catalog_products_api_v1_catalog_products_get
Authentication: Session or supported scoped bearer token

POST/api/v1/catalog/productsCreate a local catalog product

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: create_catalog_product_api_v1_catalog_products_post
Authentication: Session or supported scoped bearer token

GET/api/v1/catalog/products/{product_id}Read a product with variants and barcodes

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: catalog_product_detail_api_v1_catalog_products__product_id__get
Authentication: Session or supported scoped bearer token

PATCH/api/v1/catalog/products/{product_id}Edit a local catalog product

Updates confirmed household fields with optimistic concurrency. A renamed product keeps its old normalized name as an alias so earlier receipt wording continues to resolve.

Operation ID: update_catalog_product_api_v1_catalog_products__product_id__patch
Authentication: Session or supported scoped bearer token

DELETE/api/v1/catalog/products/{product_id}/imageRemove the current product image

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: delete_catalog_product_image_api_v1_catalog_products__product_id__image_delete
Authentication: Session or supported scoped bearer token

GET/api/v1/catalog/products/{product_id}/imageRead a locally managed product image

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: catalog_product_image_api_v1_catalog_products__product_id__image_get
Authentication: Session or supported scoped bearer token

POST/api/v1/catalog/products/{product_id}/imageUpload a private product image

Accepts JPEG, PNG or WebP, removes camera metadata and stores an optimized WebP in the local Vorrio data volume.

Operation ID: upload_catalog_product_image_api_v1_catalog_products__product_id__image_post
Authentication: Session or supported scoped bearer token

GET/api/v1/catalog/products/{product_id}/price-historyList receipt prices for a catalog product

Returns receipt-derived prices with store and package variant context. No bank or payment data is stored.

Operation ID: catalog_product_price_history_api_v1_catalog_products__product_id__price_history_get
Authentication: Session or supported scoped bearer token

POST/api/v1/catalog/products/{product_id}/variantsAdd a sellable product variant

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: create_catalog_variant_api_v1_catalog_products__product_id__variants_post
Authentication: Session or supported scoped bearer token

POST/api/v1/catalog/reconcileRe-evaluate unresolved receipt lines

Uses only the local product catalog and learned mappings. Exact matches may be assigned automatically; fuzzy candidates always remain suggestions.

Operation ID: reconcile_catalog_receipts_api_v1_catalog_reconcile_post
Authentication: Session or supported scoped bearer token

DELETE/api/v1/catalog/variants/{variant_id}Delete an unused product variant

Deletion is blocked while a receipt, stock lot or scan still references the variant.

Operation ID: delete_catalog_variant_api_v1_catalog_variants__variant_id__delete
Authentication: Session or supported scoped bearer token

PATCH/api/v1/catalog/variants/{variant_id}Edit a product variant

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: update_catalog_variant_api_v1_catalog_variants__variant_id__patch
Authentication: Session or supported scoped bearer token

POST/api/v1/catalog/variants/{variant_id}/barcodesAttach a barcode to a product variant

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: create_catalog_barcode_api_v1_catalog_variants__variant_id__barcodes_post
Authentication: Session or supported scoped bearer token

DELETE/api/v1/catalog/variants/{variant_id}/barcodes/{barcode}Detach a barcode from a product variant

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: delete_catalog_barcode_api_v1_catalog_variants__variant_id__barcodes__barcode__delete
Authentication: Session or supported scoped bearer token

Experience

GET/api/v1/experienceRead personal onboarding and release-note state

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: get_experience_api_v1_experience_get
Authentication: Session or supported scoped bearer token

PUT/api/v1/experienceComplete onboarding or acknowledge the current release

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: update_experience_api_v1_experience_put
Authentication: Session or supported scoped bearer token

Legacy Grocy

GET/api/v1/grocy/master-dataRead Grocy master data

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: grocy_master_data_api_v1_grocy_master_data_get
Authentication: Session or supported scoped bearer token
Status: Deprecated

GET/api/v1/grocy/productsSearch Grocy products

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: search_products_api_v1_grocy_products_get
Authentication: Session or supported scoped bearer token
Status: Deprecated

POST/api/v1/receipts/{receipt_id}/items/{item_id}/create-productCreate and map a Grocy product

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: create_and_map_product_api_v1_receipts__receipt_id__items__item_id__create_product_post
Authentication: Session or supported scoped bearer token
Status: Deprecated

Insights

GET/api/v1/insights/budgetSummarize the household budget from confirmed receipts

Returns month-to-date spending, a pace-based forecast, a comparable prior period, monthly history, store shares and explicit coverage diagnostics. Only receipts with at least one confirmed stock import are counted; historic receipt values are never presented as live market prices.

Operation ID: budget_overview_api_v1_insights_budget_get
Authentication: Session or supported scoped bearer token

PUT/api/v1/insights/budget/settingsSet or clear the shared monthly household budget

Owner and admin sessions can set one EUR monthly limit and warning threshold for the household. A null limit removes the target without changing receipts.

Operation ID: update_budget_settings_api_v1_insights_budget_settings_put
Authentication: Session or supported scoped bearer token

GET/api/v1/insights/pricesSummarize confirmed receipt prices by product and store

Builds a read-only household price overview from confirmed receipt imports. Store values are historic observations, not live prices or availability.

Operation ID: price_insights_api_v1_insights_prices_get
Authentication: Session or supported scoped bearer token

Integrations

POST/api/v1/integrations/grocy/import-catalogImport or update the local catalog from Grocy

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: import_grocy_catalog_api_v1_integrations_grocy_import_catalog_post
Authentication: Session or supported scoped bearer token

GET/api/v1/integrations/grocy/stock-previewPreview mapped Grocy balances without changing Vorrio

Reads the configured Grocy stock and maps it to previously imported catalog products. The response is a review proposal only; stock changes require a separate confirmed POST to /api/v1/stock/counts.

Operation ID: grocy_stock_preview_api_v1_integrations_grocy_stock_preview_get
Authentication: Session or supported scoped bearer token

Notifications

PUT/api/v1/notifications/preferencesUpdate personal stock notification preferences

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: update_notification_preferences_api_v1_notifications_preferences_put
Authentication: Session or supported scoped bearer token

GET/api/v1/notifications/stateRead personal Web Push settings and devices

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: notification_state_api_v1_notifications_state_get
Authentication: Session or supported scoped bearer token

POST/api/v1/notifications/subscriptionsRegister or refresh one browser push device

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: register_push_subscription_api_v1_notifications_subscriptions_post
Authentication: Session or supported scoped bearer token

DELETE/api/v1/notifications/subscriptions/{subscription_id}Revoke one personal push device

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: revoke_push_subscription_api_v1_notifications_subscriptions__subscription_id__delete
Authentication: Session or supported scoped bearer token

POST/api/v1/notifications/testSend a visible test notification to one personal device

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: test_push_notification_api_v1_notifications_test_post
Authentication: Session or supported scoped bearer token

Privacy & Operations

GET/api/v1/operations/overviewRead the privacy-safe owner operations overview

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: operations_overview_api_v1_operations_overview_get
Authentication: Session or supported scoped bearer token

GET/api/v1/privacy/exportDownload a secret-free portable household export

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: privacy_export_api_v1_privacy_export_get
Authentication: Session or supported scoped bearer token

GET/api/v1/privacy/export/previewPreview the portable household export

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: privacy_export_preview_api_v1_privacy_export_preview_get
Authentication: Session or supported scoped bearer token

DELETE/api/v1/privacy/householdPermanently erase this single-household installation

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: privacy_erase_household_api_v1_privacy_household_delete
Authentication: Session or supported scoped bearer token

GET/api/v1/privacy/retentionPreview receipt-file retention

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: privacy_retention_preview_api_v1_privacy_retention_get
Authentication: Session or supported scoped bearer token

POST/api/v1/privacy/retention/runApply receipt-file retention now

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: privacy_retention_run_api_v1_privacy_retention_run_post
Authentication: Session or supported scoped bearer token

Receipts

GET/api/v1/receiptsList recent receipts

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: receipts_api_v1_receipts_get
Authentication: Session or supported scoped bearer token

POST/api/v1/receipts/analyzeAnalyze an image or PDF receipt

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: analyze_api_v1_receipts_analyze_post
Authentication: Session or supported scoped bearer token

GET/api/v1/receipts/{receipt_id}Get a receipt with all lines

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: receipt_api_v1_receipts__receipt_id__get
Authentication: Session or supported scoped bearer token

POST/api/v1/receipts/{receipt_id}/importCommit reviewed lines to local stock

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: import_receipt_api_v1_receipts__receipt_id__import_post
Authentication: Session or supported scoped bearer token

PATCH/api/v1/receipts/{receipt_id}/items/{item_id}Map a receipt line to a catalog product

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: map_item_api_v1_receipts__receipt_id__items__item_id__patch
Authentication: Session or supported scoped bearer token

POST/api/v1/receipts/{receipt_id}/items/{item_id}/candidateConfirm and learn a real product candidate

Loads the selected candidate from the server-side cache, links its barcode, image and package variant to an existing or newly created local product, maps the receipt line and remembers the retailer wording.

Operation ID: confirm_receipt_item_candidate_api_v1_receipts__receipt_id__items__item_id__candidate_post
Authentication: Session or supported scoped bearer token

GET/api/v1/receipts/{receipt_id}/items/{item_id}/candidatesFind real product candidates for a receipt line

Searches real Open Facts records only after an explicit review action, caches the result for 30 days and optionally lets the configured AI provider rank the returned records. Candidates are never assigned automatically.

Operation ID: receipt_item_candidates_api_v1_receipts__receipt_id__items__item_id__candidates_get
Authentication: Session or supported scoped bearer token

POST/api/v1/receipts/{receipt_id}/items/{item_id}/catalog-productCreate and map a local catalog product

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: create_and_map_catalog_product_api_v1_receipts__receipt_id__items__item_id__catalog_product_post
Authentication: Session or supported scoped bearer token

Scanning

POST/api/v1/scans/resolveResolve a package code without changing stock

Normalizes the decoded code, checks the local catalog and fresh cache first, rejects repeated-digit placeholder GTINs, then queries Open Facts for EAN/UPC/GTIN codes. Internal codes never leave the installation. Unknown and upstream-failed codes are kept in the unresolved inbox. Reusing client_mutation_id returns the same draft.

Operation ID: resolve_scan_api_v1_scans_resolve_post
Authentication: Session or supported scoped bearer token

GET/api/v1/scans/unresolvedList unresolved package scans

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: unresolved_scans_api_v1_scans_unresolved_get
Authentication: Session or supported scoped bearer token

DELETE/api/v1/scans/{scan_id}Discard an unresolved scan

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: discard_scan_api_v1_scans__scan_id__delete
Authentication: Session or supported scoped bearer token

GET/api/v1/scans/{scan_id}Read one scan draft

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: get_scan_api_v1_scans__scan_id__get
Authentication: Session or supported scoped bearer token

PATCH/api/v1/scans/{scan_id}Edit or map an unresolved scan

Updates review suggestions or maps the code to an existing local product.

Operation ID: update_scan_api_v1_scans__scan_id__patch
Authentication: Session or supported scoped bearer token

POST/api/v1/scans/{scan_id}/confirmConfirm the selected package action

Optionally creates or maps the local product and then performs exactly one identify, add, consume, open or shopping-list action. The confirmation key makes retries safe.

Operation ID: confirm_scan_api_v1_scans__scan_id__confirm_post
Authentication: Session or supported scoped bearer token

Settings

GET/api/v1/settingsRead public settings

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: get_settings_api_v1_settings_get
Authentication: Session or supported scoped bearer token

PUT/api/v1/settingsReplace instance settings

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: save_settings_api_v1_settings_put
Authentication: Session or supported scoped bearer token

POST/api/v1/settings/test-grocyTest the Grocy connector

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: test_grocy_api_v1_settings_test_grocy_post
Authentication: Session or supported scoped bearer token

POST/api/v1/settings/test-providerTest the selected analysis provider

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: provider_test_api_v1_settings_test_provider_post
Authentication: Session or supported scoped bearer token

Shopping

GET/api/v1/shopping-listList open household shopping items

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: shopping_list_api_v1_shopping_list_get
Authentication: Session or supported scoped bearer token

POST/api/v1/shopping-list/generateGenerate reviewed shopping-list items from low stock

Re-checks every selected product transactionally. Existing open items are raised only when the calculated shortage is larger, and an idempotency key prevents network retries from adding twice.

Operation ID: generate_shopping_list_api_v1_shopping_list_generate_post
Authentication: Session or supported scoped bearer token

GET/api/v1/shopping-list/low-stockPreview products below their configured minimum stock

Returns a read-only proposal. Products without an active refill target are omitted, and no shopping-list item changes until generation is confirmed.

Operation ID: shopping_low_stock_api_v1_shopping_list_low_stock_get
Authentication: Session or supported scoped bearer token

PATCH/api/v1/shopping-list/{item_id}Edit or complete a shopping-list item

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: update_shopping_list_item_api_v1_shopping_list__item_id__patch
Authentication: Session or supported scoped bearer token

Stock

GET/api/v1/stock/count/productsList products for a reviewed stock count

Returns the complete active catalog including current totals, variants and default master data. Reading this endpoint never changes stock.

Operation ID: stock_count_products_api_v1_stock_count_products_get
Authentication: Session or supported scoped bearer token

GET/api/v1/stock/countsList completed stock counts

This operation is defined in the canonical Vorrio OpenAPI contract.

Operation ID: stock_counts_api_v1_stock_counts_get
Authentication: Session or supported scoped bearer token

POST/api/v1/stock/countsApply a reviewed opening or correction count

Only explicitly submitted products are changed. Each line sets the counted total for one product; omitted products remain untouched. Positive and negative differences create append-only stock movements. Reusing the same client mutation id returns the original result.

Operation ID: create_stock_count_api_v1_stock_counts_post
Authentication: Session or supported scoped bearer token

Vorrio API reference ​

Explore the REST API

System

Authentication

Catalog

Experience

Legacy Grocy

Insights

Integrations

Notifications

Privacy & Operations

Receipts

Scanning

Settings

Shopping

Stock

Vorrio API reference