Pin Django 4.2.25, shouldn't affect us, but better safe than sorry

Co-authored-by: Richard Schreiber <schreiber@rami.io>

.clabot

@@ -1,5 +1,5 @@
 {
   "contributors": "https://crm.rami.io/cla/check/?project=pretix&checkContributor=",
-  "message": "Hey there! :) Thank you very much for offering a contribution to pretix! For legal reasons, we need you to sign a Contributor License Agreement in order to be able to merge the code. Sorry for the hassle :( Please download the agreement from https://pretix.eu/about/en/cla and send a signed copy to support@pretix.eu. Feel free to also contact us there or via comments here if you have any questions!",
+  "message": "Hey there! :) Thank you very much for offering a contribution to pretix! For legal reasons, we need you to sign a Contributor License Agreement in order to be able to merge the code. Sorry for the hassle :( Please download the agreement from https://pretix.eu/about/en/cla and send a signed copy to support@pretix.eu. Feel free to also contact us there or via comments here if you have any questions!\n\nFeel free to ignore me on documentation changes, translations, and trivial PRs like typo fixes (and similar single-line changes) – we can merge these without a CLA as well.",
   "label": "cla-signed"
 }

.github/workflows/build.yml

@@ -38,7 +38,7 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-pip-
       - name: Install system dependencies
-        run: sudo apt update && sudo apt install gettext unzip
+        run: sudo apt update && sudo apt install -y gettext unzip
       - name: Install Python dependencies
         run: pip3 install -U setuptools build pip check-manifest
       - name: Run check-manifest

.github/workflows/docs.yml

@@ -37,7 +37,7 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-pip-
       - name: Install system packages
-        run: sudo apt update && sudo apt install enchant-2 hunspell aspell-en
+        run: sudo apt update && sudo apt install -y enchant-2 hunspell aspell-en
       - name: Install Dependencies
         run: pip3 install -Ur requirements.txt
         working-directory: ./doc

.github/workflows/strings.yml

@@ -35,9 +35,9 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-pip-
       - name: Install system packages
-        run: sudo apt update && sudo apt install gettext
+        run: sudo apt update && sudo apt -y install gettext
       - name: Install Dependencies
-        run: pip3 install -e ".[dev]"
+        run: pip3 install uv && uv pip install --system -e ".[dev]"
       - name: Compile messages
         run: python manage.py compilemessages
         working-directory: ./src
@@ -62,7 +62,7 @@ jobs:
       - name: Install system packages
         run: sudo apt update && sudo apt install enchant-2 hunspell hunspell-de-de aspell-en aspell-de
       - name: Install Dependencies
-        run: pip3 install -e ".[dev]"
+        run: pip3 install uv && uv pip install --system -e ".[dev]"
       - name: Spellcheck translations
         run: potypo
         working-directory: ./src

.github/workflows/style.yml

@@ -35,7 +35,7 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-pip-
       - name: Install Dependencies
-        run: pip3 install -e ".[dev]" psycopg2-binary
+        run: pip3 install uv && uv pip install --system -e ".[dev]" psycopg2-binary
       - name: Run isort
         run: isort -c .
         working-directory: ./src
@@ -55,7 +55,7 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-pip-
       - name: Install Dependencies
-        run: pip3 install -e ".[dev]" psycopg2-binary
+        run: pip3 install uv && uv pip install --system -e ".[dev]" psycopg2-binary
       - name: Run flake8
         run: flake8 .
         working-directory: ./src

.github/workflows/tests.yml

@@ -5,7 +5,6 @@ on:
     branches: [ master ]
     paths-ignore:
       - 'doc/**'
-      - 'src/pretix/locale/**'
   pull_request:
     branches: [ master ]
     paths-ignore:
@@ -31,15 +30,21 @@ jobs:
             python-version: "3.9"
           - database: sqlite
             python-version: "3.10"
+    services:
+      postgres:
+        image: postgres:15
+        env:
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_DB: pretix
+        options: >-
+          --health-cmd "pg_isready -U postgres -d pretix"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
     steps:
       - uses: actions/checkout@v4
-      - uses: harmon758/postgresql-action@v1
-        with:
-          postgresql version: '15'
-          postgresql db: 'pretix'
-          postgresql user: 'postgres'
-          postgresql password: 'postgres'
-        if: matrix.database == 'postgres'
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v5
         with:
@@ -51,9 +56,9 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-pip-
       - name: Install system dependencies
-        run: sudo apt update && sudo apt install gettext
+        run: sudo apt update && sudo apt install -y gettext
       - name: Install Python dependencies
-        run: pip3 install --ignore-requires-python -e ".[dev]" psycopg2-binary  # We ignore that flake8 needs newer python as we don't run flake8 during tests
+        run: pip3 install uv && uv pip install --system -e ".[dev]" psycopg2-binary
       - name: Run checks
         run: python manage.py check
         working-directory: ./src
@@ -65,15 +70,15 @@ jobs:
         run: make all compress
       - name: Run tests
         working-directory: ./src
-        run: PRETIX_CONFIG_FILE=tests/travis_${{ matrix.database }}.cfg py.test -n 3 -p no:sugar --cov=./ --cov-report=xml --reruns 3 tests --maxfail=100
+        run: PRETIX_CONFIG_FILE=tests/ci_${{ matrix.database }}.cfg py.test -n 3 -p no:sugar --cov=./ --cov-report=xml tests --maxfail=100
       - name: Run concurrency tests
         working-directory: ./src
-        run: PRETIX_CONFIG_FILE=tests/travis_${{ matrix.database }}.cfg py.test tests/concurrency_tests/ --reruns 0 --reuse-db
+        run: PRETIX_CONFIG_FILE=tests/ci_${{ matrix.database }}.cfg py.test tests/concurrency_tests/ --reuse-db
         if: matrix.database == 'postgres'
       - name: Upload coverage
-        uses: codecov/codecov-action@v1
+        uses: codecov/codecov-action@v4
         with:
           file: src/coverage.xml
           token: ${{ secrets.CODECOV_TOKEN }}
-          fail_ci_if_error: true
+          fail_ci_if_error: false
         if: matrix.database == 'postgres' && matrix.python-version == '3.11'

.gitlab-ci.yml

@@ -10,7 +10,7 @@ tests:
         - cd src
         - python manage.py check
         - make all compress
-        - PRETIX_CONFIG_FILE=tests/travis_sqlite.cfg py.test --reruns 3 -n 3 tests --maxfail=100
+        - PRETIX_CONFIG_FILE=tests/ci_sqlite.cfg py.test -n 3 tests --maxfail=100
     except:
         - pypi
 pypi:

.node-version

@@ -0,0 +1 @@
+17

CODE_OF_CONDUCT.md

@@ -1,5 +1,5 @@
 Code of Conduct
 ===============
 
-We have a [Code of Conduct](https://docs.pretix.eu/en/latest/development/contribution/codeofconduct.html)
+We have a [Code of Conduct](https://docs.pretix.eu/dev/development/contribution/codeofconduct.html)
 in place that applies to all project contributions, including issues, pull requests, etc.

CONTRIBUTING.md

@@ -3,9 +3,9 @@ Contributing to pretix
 
 Hey there and welcome to pretix!
 
-* We've got a contributors guide in [our documentation](https://docs.pretix.eu/en/latest/development/contribution/) together with notes on the [development setup](https://docs.pretix.eu/en/latest/development/setup.html).
+* We've got a contributors guide in [our documentation](https://docs.pretix.eu/dev/development/contribution/) together with notes on the [development setup](https://docs.pretix.eu/dev/development/setup.html).
 
-* Please note that we have a [Code of Conduct](https://docs.pretix.eu/en/latest/development/contribution/codeofconduct.html) in place that applies to all project contributions, including issues, pull requests, etc.
+* Please note that we have a [Code of Conduct](https://docs.pretix.eu/dev/development/contribution/codeofconduct.html) in place that applies to all project contributions, including issues, pull requests, etc.
 
-* Before we can accept a PR from you we'll need you to sign [our CLA](https://pretix.eu/about/en/cla). You can find more information about the how and why in our [License FAQ](https://docs.pretix.eu/en/latest/license/faq.html#) and in our [license change blog post](https://pretix.eu/about/en/blog/20210412-license/).
+* Before we can accept a PR from you we'll need you to sign [our CLA](https://pretix.eu/about/en/cla). You can find more information about the how and why in our [License FAQ](https://docs.pretix.eu/trust/licensing/faq/) and in our [license change blog post](https://pretix.eu/about/en/blog/20210412-license/).
 

MANIFEST.in

@@ -10,6 +10,8 @@ recursive-include src/pretix/helpers/locale *
 recursive-include src/pretix/base/templates *
 recursive-include src/pretix/control/templates *
 recursive-include src/pretix/presale/templates *
+recursive-include src/pretix/plugins/autocheckin/templates *
+recursive-include src/pretix/plugins/autocheckin/static *
 recursive-include src/pretix/plugins/banktransfer/templates *
 recursive-include src/pretix/plugins/banktransfer/static *
 recursive-include src/pretix/plugins/manualpayment/templates *

README.rst

@@ -5,9 +5,10 @@ pretix
    :target: https://pypi.python.org/pypi/pretix
 
 .. image:: https://github.com/pretix/pretix/workflows/Documentation/badge.svg
-   :target: https://docs.pretix.eu/en/latest/
+   :target: https://docs.pretix.eu/
 
 .. image:: https://github.com/pretix/pretix/workflows/Tests/badge.svg
+   :target: https://github.com/pretix/pretix/actions/workflows/tests.yml
 
 .. image:: https://codecov.io/gh/pretix/pretix/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/pretix/pretix
@@ -56,8 +57,8 @@ License
 The code in this repository is covered by different licenses. Most of it is available to everyone under the terms of
 the GNU AGPL license v3 with additional terms. See the LICENSE file for the complete license details.
 
-.. _installation guide: https://docs.pretix.eu/en/latest/admin/installation/index.html
-.. _developer documentation: https://docs.pretix.eu/en/latest/development/index.html
-.. _Code of Conduct: https://docs.pretix.eu/en/latest/development/contribution/codeofconduct.html
+.. _installation guide: https://docs.pretix.eu/self-hosting/installation/general/
+.. _developer documentation: https://docs.pretix.eu/dev/development/index.html
+.. _Code of Conduct: https://docs.pretix.eu/dev/development/contribution/codeofconduct.html
 .. _pretix.eu: https://pretix.eu
 .. _blog: https://pretix.eu/about/en/blog/

SECURITY.md

@@ -2,11 +2,11 @@
 
 ## Reporting a vulnerability
 
-If you discover a vulnerability with our software or server systems, please report it to us in private. Do not to attempt to harm our users, customer's data or our system's availability when looking for vulneratbilities.
+If you discover a vulnerability with our software or server systems, please report it to us in private. Do not to attempt to harm our users, customer's data or our system's availability when looking for vulnerabilities.
 
 Please contact us at security@pretix.eu with full details and steps to reproduce and allow reasonable time for us to resolve the issue before publishing your findings. If you wish to encrypt your email, you can find our GPG key [here](https://pretix.eu/.well-known/security@pretix.eu.asc).
 
-We're not large enough to run a formal bug bounty program, but if you find a serious vulnerability in our service, we will find a way to show our gratitude. 
+Please also see our [Responsible disclosure policy](https://docs.pretix.eu/trust/security/disclosure/).
 
 ## Version support
 
@@ -18,3 +18,5 @@ subscribe to our [newsletter](https://pretix.eu/about/en/blog/) in the "News abo
 category, we will also send you an email on security issues. 
 
 Past security issues are listed [on our website](https://pretix.eu/about/en/security).
+
+Please also see our [Release cycle](https://docs.pretix.eu/trust/lifecycle/release-cycle/) documentation.

deployment/docker/nginx.conf

@@ -60,6 +60,14 @@ http {
             deny all;
             return 404;
         }
+        location /static/staticfiles.json {
+            deny all;
+            return 404;
+        }
+        location /static/CACHE/manifest.json {
+            deny all;
+            return 404;
+        }
         location /static/ {
             alias /pretix/src/pretix/static.dist/;
             access_log off;

doc/_templates/index.html

@@ -1,43 +1,16 @@
 {% extends "layout.html" %}
 {% set title = 'Overview' %}
 {% block body %}
-    <h1>Welcome to pretix' documentation!</h1>
+    <h1>Welcome to our developer documentation!</h1>
     <p>
-        We work hard to make this website contain all information that you need to use, run, understand, and improve
-        pretix. Of course, this documentation will never be perfect or complete, but if there is anything unclear
+        We work hard to make this website contain all information that you need to work with our API or source code.
+        Of course, this documentation will never be perfect or complete, but if there is anything unclear
         or anything specific that you miss here, that's a bug and we'd be happy if you'd
         <a href="https://github.com/pretix/pretix/issues/new">let us know</a>.
     </p>
 
-    <h2>Documentation structure</h2>
+    <h2>What you can find here</h2>
 
-    <div class="sectionbox">
-        <div class="icon">
-            <a href="user/index.html">
-                <span class="fa fa-user fa-fw"></span>
-            </a>
-        </div>
-        <div class="text">
-            <a href="user/index.html">
-                <strong>User Guide</strong>
-            </a>
-            <p>Go here to find information on how to configure and use pretix as an event organizer.</p>
-        </div>
-    </div>
-    <div class="sectionbox">
-        <div class="icon">
-            <a href="admin/index.html">
-                <span class="fa fa-server fa-fw"></span>
-            </a>
-        </div>
-        <div class="text">
-            <a href="admin/index.html">
-                <strong>Administrator docs</strong>
-            </a>
-            <p>Find out how to install pretix on your own server and how to maintain an installation of pretix.</p>
-        </div>
-    </div>
-    <div class="clearfix"></div>
     <div class="sectionbox">
         <div class="icon">
             <a href="api/index.html">
@@ -69,30 +42,33 @@
         </div>
     </div>
     <div class="clearfix"></div>
+
+
+    <h2>Other sources of documentation</h2>
     <div class="sectionbox">
         <div class="icon">
-            <a href="plugins/index.html">
-                <span class="fa fa-puzzle-piece fa-fw"></span>
+            <a href="https://docs.pretix.eu" target="_blank">
+                <span class="fa fa-user fa-fw"></span>
             </a>
         </div>
         <div class="text">
-            <a href="plugins/index.html">
-                <strong>Plugin docs</strong>
+            <a href="https://docs.pretix.eu" target="_blank">
+                <strong>User docs</strong>
             </a>
-            <p>Documentation and details on plugins that ship with pretix or are officially supported.</p>
+            <p>Go here to find information on how to configure and use pretix as an event organizer.</p>
         </div>
     </div>
     <div class="sectionbox">
         <div class="icon">
-            <a href="contents.html">
-                <span class="fa fa-list fa-fw"></span>
+            <a href="https://docs.pretix.eu/self-hosting/">
+                <span class="fa fa-server fa-fw"></span>
             </a>
         </div>
         <div class="text">
-            <a href="contents.html">
-                <strong>Table of contents</strong>
+            <a href="https://docs.pretix.eu/self-hosting/">
+                <strong>Administrator docs</strong>
             </a>
-            <p>Detailled overview of everything contained in this documentation.</p>
+            <p>Find out how to install pretix on your own server and how to maintain an installation of pretix.</p>
         </div>
     </div>
     <div class="clearfix"></div>
@@ -142,19 +118,6 @@
                 general news on pretix as a project.</p>
         </div>
     </div>
-    <div class="sectionbox">
-        <div class="icon">
-            <a href="https://twitter.com/pretixeu" target="_blank">
-                <span class="fa fa-twitter fa-fw"></span>
-            </a>
-        </div>
-        <div class="text">
-            <a href="https://twitter.com/pretixeu" target="_blank">
-                <strong>Twitter</strong>
-            </a>
-            <p>Keep in touch and stay up to date by following our project account on Twitter.</p>
-        </div>
-    </div>
     <div class="clearfix"></div>
 
 {% endblock %}

doc/_themes/pretix_theme/layout.html

@@ -115,6 +115,7 @@
             {%- if logo or logo_url %}
               <img src="{{ _logo_url }}" class="logo" alt="{{ _('Logo') }}"/>
             {%- endif %}
+            Developer Documentation
           </a>
 
           {% include "searchbox.html" %}

doc/_themes/pretix_theme/static/css/pretix.css

@@ -5183,7 +5183,7 @@ div[class^='highlight'] pre {
 
 .wy-side-nav-search > a img.logo, .wy-side-nav-search .wy-dropdown > a img.logo {
     display: block;
-    margin: 0 auto;
+    margin: 0 auto 10px;
     height: 50px;
     width: auto;
     border-radius: 0;

doc/admin/config.rst

@@ -1,539 +0,0 @@
-.. highlight:: ini
-
-.. _`config`:
-
-.. spelling:word-list:: Galera
-
-Configuration file
-==================
-
-Pretix reads its configuration from a configuration file. It tries to find this file
-at the following locations. It will try to read the file from the specified paths in
-the following order. The file that is found *last* will override the settings from
-the files found before.
-
-1. ``PRETIX_CONFIG_FILE`` environment variable
-2. ``/etc/pretix/pretix.cfg``
-3. ``~/.pretix.cfg``
-4. ``pretix.cfg`` in the current working directory
-
-The file is expected to be in the INI format as specified in the `Python documentation`_.
-
-The config file may contain the following sections (all settings are optional and have
-default values). We suggest that you start from the examples given in one of the
-installation tutorials.
-
-.. note::
-
-    The configuration file is the recommended way to configure pretix. However, you can
-    also set them through environment variables. In this case, the syntax is
-    ``PRETIX_SECTION_CONFIG``. For example, to configure the setting ``password_reset``
-    from the ``[pretix]`` section, set ``PRETIX_PRETIX_PASSWORD_RESET=off`` in your
-    environment.
-
-pretix settings
----------------
-
-Example::
-
-    [pretix]
-    instance_name=pretix.de
-    url=http://localhost
-    currency=EUR
-    datadir=/data
-    plugins_default=pretix.plugins.sendmail,pretix.plugins.statistics
-
-``instance_name``
-    The name of this installation. Default: ``pretix.de``
-
-``url``
-    The installation's full URL, without a trailing slash.
-
-``currency``
-    The default currency as a three-letter code. Defaults to ``EUR``.
-
-``cachedir``
-    The local path to a directory where temporary files will be stored.
-    Defaults to the ``cache`` directory below the ``datadir``.
-
-``datadir``
-    The local path to a data directory that will be used for storing user uploads and similar
-    data. Defaults to the value of the environment variable ``DATA_DIR`` or ``data``.
-
-``logdir``
-    The local path to a directory where log files will be stored.
-    Defaults to the ``logs`` directory below the ``datadir``.
-
-``plugins_default``
-    A comma-separated list of plugins that are enabled by default for all new events.
-    Defaults to ``pretix.plugins.sendmail,pretix.plugins.statistics``.
-
-``plugins_exclude``
-    A comma-separated list of plugins that are not available even though they are installed.
-    Defaults to an empty string.
-
-``plugins_show_meta``
-    Whether to show authors and versions of plugins, defaults to ``on``.
-
-``auth_backends``
-    A comma-separated list of available auth backends. Defaults to ``pretix.base.auth.NativeAuthBackend``.
-
-``registration``
-    Enables or disables the registration of new admin users. Defaults to ``off``.
-
-``password_reset``
-    Enables or disables password reset. Defaults to ``on``.
-
-``long_sessions``
-    Enables or disables the "keep me logged in" button. Defaults to ``on``.
-
-``ecb_rates``
-    By default, pretix periodically downloads currency rates from the European Central Bank as well as other authorities
-    that are used to print tax amounts in the customer currency on invoices for some currencies. Set to ``off`` to
-    disable this feature. Defaults to ``on``.
-
-``audit_comments``
-    Enables or disables nagging staff users for leaving comments on their sessions for auditability.
-    Defaults to ``off``.
-
-``obligatory_2fa``
-    Enables or disables obligatory usage of two-factor authentication for users of the pretix backend.
-    Can be ``True`` to make two-factor authentication obligatory for all users or ``staff`` to make it only
-    obligatory to users with admin permissions. Defaults to ``False``.
-
-``trust_x_forwarded_for``
-    Specifies whether the ``X-Forwarded-For`` header can be trusted. Only set to ``on`` if you have a reverse
-    proxy that actively removes and re-adds the header to make sure the correct client IP is the first value.
-    Defaults to ``off``.
-
-``trust_x_forwarded_proto``
-    Specifies whether the ``X-Forwarded-Proto`` header can be trusted. Only set to ``on`` if you have a reverse
-    proxy that actively removes and re-adds the header to make sure the correct value is set.
-    Defaults to ``off``.
-
-``trust_x_forwarded_host``
-    Specifies whether the ``X-Forwarded-Host`` header can be trusted. Only set to ``on`` if you have a reverse
-    proxy that actively removes and re-adds the header to make sure the correct value is set.
-    Defaults to ``off``.
-
-``csp_log``
-    Log violations of the Content Security Policy (CSP). Defaults to ``on``.
-
-``csp_additional_header``
-    Specifies a CSP header that will be **merged** with pretix's default header. For example, if you set this
-    to ``script-src https://mycdn.com``, pretix will add ``https://mycdn.com`` as an **additional** allowed source
-    to all CSP headers. Empty by default.
-
-``loglevel``
-    Set console and file log level (``DEBUG``, ``INFO``, ``WARNING``, ``ERROR`` or ``CRITICAL``). Defaults to ``INFO``.
-
-``request_id_header``
-    Specifies the name of a header that should be used for logging request IDs. Off by default.
-
-Locale settings
----------------
-
-Example::
-
-    [locale]
-    default=de
-    timezone=Europe/Berlin
-
-``default``
-    The system's default locale. Default: ``en``
-
-``timezone``
-    The system's default timezone as a ``pytz`` name. Default: ``UTC``
-
-Database settings
------------------
-
-Example::
-
-    [database]
-    backend=postgresql
-    name=pretix
-    user=pretix
-    password=abcd
-    host=localhost
-    port=3306
-    advisory_lock_index=1
-    disable_server_side_cursors=0
-    sslmode=require
-    sslrootcert=/etc/pretix/postgresql-ca.crt
-    sslcert=/etc/pretix/postgresql-client-crt.crt
-    sslkey=/etc/pretix/postgresql-client-key.key
-
-``backend``
-    One of ``sqlite3`` and ``postgresql``.
-    Default: ``sqlite3``.
-
-``name``
-    The database's name. Default: ``db.sqlite3``.
-
-``user``, ``password``, ``host``, ``port``
-    Connection details for the database connection. Empty by default.
-
-``advisory_lock_index``
-    On PostgreSQL, pretix uses the "advisory lock" feature. However, advisory locks use a server-wide name space and
-    and are not scoped to a specific database. If you run multiple pretix applications with the same PostgreSQL server,
-    you should set separate values for this setting (integers up to 256).
-
-``disable_server_side_cursors``
-    On PostgreSQL pretix might use server side cursors for certain operations. This is generally fine but will break in
-    specific circumstances, for example when connecting to PostgreSQL through a PGBouncer configured with a transaction
-    pool mode. Off by default (i.e. by default server side cursors will be used).
-
-``sslmode``, ``sslrootcert``
-    Connection TLS details for the PostgreSQL database connection. Possible values of ``sslmode`` are ``disable``, ``allow``, ``prefer``, ``require``, ``verify-ca``, and ``verify-full``. ``sslrootcert`` should be the accessible path of the ca certificate. Both values are empty by default.
-
-``sslcert``, ``sslkey``
-    Connection mTLS details for the PostgreSQL database connection. It's also necessary to specify ``sslmode`` and ``sslrootcert`` parameters, please check the correct values from the TLS part. ``sslcert`` should be the accessible path of the client certificate.  ``sslkey`` should be the accessible path of the client key. All values are empty by default.
-
-.. _`config-replica`:
-
-Database replica settings
--------------------------
-
-If you use a replicated database setup, pretix expects that the default database connection always points to the primary database node.
-Routing read queries to a replica on database layer is **strongly** discouraged since this can lead to inaccurate such as more tickets
-being sold than are actually available.
-
-However, pretix can still make use of a database replica to keep some expensive queries with that can tolerate some latency from your
-primary database, such as backend search queries. The ``replica`` configuration section can have the same settings as the ``database``
-section (except for the ``backend`` setting) and will default back to the ``database`` settings for all values that are not given. This
-way, you just need to specify the settings that are different for the replica.
-
-Example::
-
-    [replica]
-    host=192.168.0.2
-
-.. _`config-urls`:
-
-URLs
-----
-
-Example::
-
-    [urls]
-    media=/media/
-    static=/static/
-
-``media``
-    The URL to be used to serve user-uploaded content. You should not need to modify
-    this. Default: ``/media/``
-
-``static``
-    The URL to be used to serve static files. You should not need to modify
-    this. Default: ``/static/``
-
-.. _`mail-settings`:
-
-Email
------
-
-Example::
-
-    [mail]
-    from=hello@localhost
-    host=127.0.0.71
-    user=pretix
-    password=foobar
-    port=1025
-    tls=on
-    ssl=off
-
-``host``, ``port``
-    The SMTP Host to connect to. Defaults to ``localhost`` and ``25``.
-
-``user``, ``password``
-    The SMTP user data to use for the connection. Empty by default.
-
-``tls``, ``ssl``
-    Use STARTTLS or SSL for the SMTP connection. Off by default.
-
-``from``
-    The email address to set as ``From`` header in outgoing emails by the system.
-    Default: ``pretix@localhost``
-
-``from_notifications``
-    The email address to set as ``From`` header in admin notification emails by the system.
-    Defaults to the value of ``from``.
-
-``from_organizers``
-    The email address to set as ``From`` header in outgoing emails by the system sent on behalf of organizers.
-    Defaults to the value of ``from``.
-
-``custom_sender_verification_required``
-    If this is on (the default), organizers need to verify email addresses they want to use as senders in their event.
-
-``custom_sender_spf_string``
-    If this is set to a valid SPF string, pretix will show a warning if organizers use a sender address from a domain
-    that does not include this value.
-
-``custom_smtp_allow_private_networks``
-    If this is off (the default), custom SMTP servers cannot be private network addresses.
-
-``admins``
-    Comma-separated list of email addresses that should receive a report about every error code 500 thrown by pretix.
-
-.. _`django-settings`:
-
-Django settings
----------------
-
-Example::
-
-    [django]
-    secret=j1kjps5a5&4ilpn912s7a1!e2h!duz^i3&idu@_907s$wrz@x-
-    debug=off
-
-``secret``
-    The secret to be used by Django for signing and verification purposes. If this
-    setting is not provided, pretix will generate a random secret on the first start
-    and will store it in the filesystem for later usage.
-
-``debug``
-    Whether or not to run in debug mode. Default is ``False``.
-
-    .. WARNING:: Never set this to ``True`` in production!
-
-``profile``
-    Enable code profiling for a random subset of requests. Disabled by default, see
-    :ref:`perf-monitoring` for details.
-
-.. _`metrics-settings`:
-
-Metrics
--------
-
-If you want to fetch internally collected prometheus-style metrics you need to configure the credentials for the
-metrics endpoint and enable it::
-
-    [metrics]
-    enabled=true
-    user=your_user
-    passphrase=mysupersecretpassphrase
-
-Currently, metrics-collection requires a redis server to be available.
-
-
-Memcached
----------
-
-You can use an existing memcached server as pretix's caching backend::
-
-    [memcached]
-    location=127.0.0.1:11211
-
-``location``
-    The location of memcached, either a host:port combination or a socket file.
-
-If no memcached is configured, pretix will use redis for caching. If neither is configured, pretix will not use any caching.
-
-.. note:: If you use memcached and you deploy pretix across multiple servers, you should use *one*
-          shared memcached instance, not multiple ones, because cache invalidations would not be
-          propagated otherwise.
-
-Redis
------
-
-If a redis server is configured, pretix can use it for locking, caching and session storage
-to speed up various operations::
-
-    [redis]
-    location=redis://127.0.0.1:6379/1
-    sessions=false
-    sentinels=[
-            ["sentinel_host_1", 26379],
-            ["sentinel_host_2", 26379],
-            ["sentinel_host_3", 26379]
-        ]
-    password=password
-    ssl_cert_reqs=required
-    ssl_ca_certs=/etc/pretix/redis-ca.pem
-    ssl_keyfile=/etc/pretix/redis-client-crt.pem
-    ssl_certfile=/etc/pretix/redis-client-key.key
-
-``location``
-    The location of redis, as a URL of the form ``redis://[:password]@localhost:6379/0``
-    or ``unix://[:password]@/path/to/socket.sock?db=0``
-
-``sessions``
-    When this is set to ``True``, redis will be used as the session storage.
-
-``sentinels``
-    Configures redis sentinels to use.
-    If you don't want to use redis sentinels, you should omit this option.
-    If this is set, redis via sentinels will be used instead of plain redis.
-    In this case the location should be of the form ``redis://my_master/0``.
-    The ``sentinels`` variable should be a json serialized list of sentinels,
-    each being a list with the two elements hostname and port.
-    You cannot provide a password within the location when using sentinels.
-    Note that the configuration format requires you to either place the entire
-    value on one line or make sure all values are indented by at least one space.
-
-``password``
-    If your redis setup doesn't require a password or you already specified it in the location you can omit this option.
-    If this is set it will be passed to redis as the connection option PASSWORD.
-
-``ssl_cert_reqs``
-    If this is set it will be passed to redis as the connection option ``SSL_CERT_REQS``.
-    Possible values are ``none``, ``optional``, and ``required``.
-
-``ssl_ca_certs``
-    If your redis setup doesn't require TLS you can omit this option.
-    If this is set it will be passed to redis as the connection option ``SSL_CA_CERTS``. Possible value is the ca path.
-
-``ssl_keyfile``
-    If your redis setup doesn't require mTLS you can omit this option.
-    If this is set it will be passed to redis as the connection option ``SSL_KEYFILE``. Possible value is the keyfile path.
-
-``ssl_certfile``
-    If your redis setup doesn't require mTLS you can omit this option.
-    If this is set it will be passed to redis as the connection option ``SSL_CERTFILE``. Possible value is the certfile path.
-
-If redis is not configured, pretix will store sessions and locks in the database. If memcached
-is configured, memcached will be used for caching instead of redis.
-
-Translations
-------------
-
-pretix comes with a number of translations. All languages are enabled by default. If you want to limit
-the languages available in your installation, you can enable a set of languages like this::
-
-    [languages]
-    enabled=en,de
-
-Some of the languages them are marked as "incubating", which means
-they can usually only be selected in development mode. If you want to use them nevertheless, you
-can activate them like this::
-
-    [languages]
-    allow_incubating=pt-br,da
-
-You can also tell pretix about additional paths where it will search for translations::
-
-    [languages]
-    path=/path/to/my/translations
-
-For a given language (e.g. ``pt-br``), pretix will then look in the
-specific sub-folder, e.g. ``/path/to/my/translations/pt_BR/LC_MESSAGES/django.po``.
-
-Celery task queue
------------------
-
-For processing long-running tasks asynchronously, pretix requires the celery task queue.
-For communication between the web server and the task workers in both direction, a messaging
-queue and a result backend is needed. You can use a redis database for both directions, or
-an AMQP server (e.g. RabbitMQ) as a broker and redis or your database as a result backend::
-
-    [celery]
-    broker=amqp://guest:guest@localhost:5672//
-    backend=redis://localhost/0
-    broker_transport_options="{}"
-    backend_transport_options="{}"
-
-RabbitMQ might be the better choice if you have a complex, multi-server, high-performance setup,
-but as you already should have a redis instance ready for session and lock storage, we recommend
-redis for convenience. See the `Celery documentation`_ for more details.
-
-The two ``transport_options`` entries can be omitted in most cases.
-If they are present they need to be a valid JSON dictionary.
-For possible entries in that dictionary see the `Celery documentation`_.
-
-It is possible the use Redis with TLS/mTLS for the broker or the backend. To do so, it is necessary to specify the TLS identifier ``rediss``, the ssl mode ``ssl_cert_reqs`` and optionally specify the CA (TLS) ``ssl_ca_certs``, cert ``ssl_certfile`` and key ``ssl_keyfile`` (mTLS) path as encoded string. the following uri describes the format and possible parameters ``rediss://0.0.0.0:6379/1?ssl_cert_reqs=required&ssl_ca_certs=%2Fetc%2Fpretix%2Fredis-ca.pem&ssl_certfile=%2Fetc%2Fpretix%2Fredis-client-crt.pem&ssl_keyfile=%2Fetc%2Fpretix%2Fredis-client-key.key``
-
-To use redis with sentinels set the broker or backend to ``sentinel://sentinel_host_1:26379;sentinel_host_2:26379/0``
-and the respective transport_options to ``{"master_name":"mymaster"}``.
-If your redis instances behind the sentinel have a password use ``sentinel://:my_password@sentinel_host_1:26379;sentinel_host_2:26379/0``.
-If your redis sentinels themselves have a password set the transport_options to ``{"master_name":"mymaster","sentinel_kwargs":{"password":"my_password"}}``.
-
-Sentry
-------
-
-pretix has native support for sentry, a tool that you can use to track errors in the
-application. If you want to use sentry, you need to set a DSN in the configuration file::
-
-    [sentry]
-    dsn=https://<key>:<secret>@sentry.io/<project>
-    traces_sample_rate=0.5
-    traces_sample_token=xyz
-
-``dsn``
-    You will be given this value by your sentry installation.
-
-``traces_sample_rate``
-    Sample rate for performance monitoring.
-
-``traces_sample_token``
-    If this token is found in a query string, a trace will always be sampled.
-
-
-Caching
--------
-
-You can adjust some caching settings to control how much storage pretix uses::
-
-    [cache]
-    tickets=48  ; Number of hours tickets (PDF, passbook, …) are cached
-
-
-Secret length
--------------
-
-If you are really paranoid, you can increase the length of random strings pretix uses in
-various places like order codes, secrets in the ticket QR codes, etc. Example::
-
-    [entropy]
-    ; Order code needs to be < 16 characters, default is 5
-    order_code=5
-    ; Ticket secret needs to be < 64 characters, default is 32
-    ticket_secret=32
-    ; Voucher code needs to be < 255 characters, default is 16
-    voucher_code=16
-
-External tools
---------------
-
-pretix can make use of some external tools if they are installed. Currently, they are all optional. Example::
-
-    [tools]
-    pdftk=/usr/bin/pdftk
-
-.. _Python documentation: https://docs.python.org/3/library/configparser.html?highlight=configparser#supported-ini-file-structure
-.. _Celery documentation: http://docs.celeryproject.org/en/latest/userguide/configuration.html
-
-Maximum upload file sizes
--------------------------
-
-You can configure the maximum file size for uploading various files::
-
-    [pretix_file_upload]
-    ; Max upload size for images in MiB, defaults to 10 MiB
-    max_size_image = 12
-    ; Max upload size for favicons in MiB, defaults to 1 MiB
-    max_size_favicon = 2
-    ; Max upload size for email attachments of manually sent emails in MiB, defaults to 10 MiB
-    max_size_email_attachment = 15
-    ; Max upload size for email attachments of automatically sent emails in MiB, defaults to 1 MiB
-    max_size_email_auto_attachment = 2
-    ; Max upload size for other files in MiB, defaults to 10 MiB
-    ; This includes all file upload type order questions
-    max_size_other = 100
-
-
-GeoIP
------
-
-pretix can optionally make use of a GeoIP database for some features. It needs a file in ``mmdb`` format, for example
-`GeoLite2`_ or `GeoAcumen`_::
-
-    [geoip]
-    path=/var/geoipdata/
-    filename_country=GeoLite2-Country.mmdb
-
-
-.. _GeoAcumen: https://github.com/geoacumen/geoacumen-country
-.. _GeoLite2: https://dev.maxmind.com/geoip/geolite2-free-geolocation-data

doc/admin/errors.rst

@@ -1,40 +0,0 @@
-.. _`admin-errors`:
-
-Dealing with errors
-===================
-
-If you encounter an error in pretix, please follow the following steps to debug it:
-
-* If the error message is shown on a **white page** and the last line of the error includes "nginx", the error is not with pretix
-  directly but with your nginx webserver. This might mean that pretix is not running, but it could also be something else.
-  Please first check your nginx error log. The default location is ``/var/log/nginx/error.log``.
-
-  * If it turns out pretix is not running, check the output of ``docker logs pretix`` for a docker installation and
-    ``journalctl -u pretix-web.service`` for a manual installation.
-
-* If the error message is an "**Internal Server Error**" in purple pretix design, please check pretix' log file which by default is at
-  ``/var/pretix-data/logs/pretix.log`` if you installed with docker and ``/var/pretix/data/logs/pretix.log`` otherwise. If you don't
-  know how to interpret it, open a discussion on GitHub with the relevant parts of the log file.
-
-  * If the error message includes ``/usr/bin/env: ‘node’: No such file or directory``, you forgot to install ``node.js``
-
-  * If the error message includes ``OfflineGenerationError``, you might have forgot to run the ``rebuild`` step after a pretix update
-    or plugin installation.
-
-  * If the error message mentions your database server or redis server, make sure these are running and accessible.
-
-* If pretix loads fine but certain actions (creating carts, orders, or exports, downloading tickets, sending emails) **take forever**,
-  ``pretix-worker`` is not running. Check the output of ``docker logs pretix`` for a docker installation and
-  ``journalctl -u pretix-worker.service`` for a manual installation.
-
-* If the page loads but all **styles are missing**, you probably forgot to update your nginx configuration file after an upgrade of your
-  operating system's python version.
-
-
-If you are unable to debug the issue any further, please open a **discussion** on GitHub in our `Q&A Forum`_. Do **not** open an issue
-right away, since most things turn out not to be a bug in pretix but a mistake in your server configuration. Make sure to include
-relevant log excerpts in your question.
-
-If you're a pretix Enterprise customer, you can also reach out to support@pretix.eu with your issue right away.
-
-.. _Q&A Forum: https://github.com/pretix/pretix/discussions/categories/q-a

doc/admin/index.rst

@@ -1,18 +0,0 @@
-.. _`admindocs`:
-
-Administrator documentation
-===========================
-
-This documentation is for everyone who wants to install pretix on a server.
-
-.. toctree::
-   :maxdepth: 2
-
-   installation/index
-   updates
-   config
-   maintainance
-   scaling
-   errors
-   mysql2postgres
-   indexes

doc/admin/indexes.rst

@@ -1,83 +0,0 @@
-Additional database indices
-===========================
-
-If you have a large pretix database, some features such as search for orders or events might turn pretty slow.
-For PostgreSQL, we have compiled a list of additional database indexes that you can add to speed things up.
-Just like any index, they in turn make write operations insignificantly slower and cause the database to use
-more disk space.
-
-The indexes aren't automatically created by pretix since Django does not allow us to do so only on PostgreSQL
-(and they won't work on other databases). Also, they're really not necessary if you're not having tens of
-thousands of records in your database.
-
-However, this also means they won't automatically adapt if some of the referred fields change in future updates of pretix
-and you might need to re-check this page and change them manually.
-
-Here is the currently recommended set of commands::
-
-    CREATE EXTENSION pg_trgm;
-
-    CREATE INDEX CONCURRENTLY pretix_addidx_event_slug
-        ON pretixbase_event
-        USING gin (upper("slug") gin_trgm_ops);
-    CREATE INDEX CONCURRENTLY pretix_addidx_event_name
-        ON pretixbase_event
-        USING gin (upper("name") gin_trgm_ops);
-    CREATE INDEX CONCURRENTLY pretix_addidx_order_code
-        ON pretixbase_order
-        USING gin (upper("code") gin_trgm_ops);
-    CREATE INDEX CONCURRENTLY pretix_addidx_voucher_code
-        ON pretixbase_voucher
-        USING gin (upper("code") gin_trgm_ops);
-    CREATE INDEX CONCURRENTLY pretix_addidx_invoice_nu1
-        ON "pretixbase_invoice" (UPPER("invoice_no"));
-    CREATE INDEX CONCURRENTLY pretix_addidx_invoice_nu2
-        ON "pretixbase_invoice" (UPPER("full_invoice_no"));
-    CREATE INDEX CONCURRENTLY pretix_addidx_organizer_name
-        ON pretixbase_organizer
-        USING gin (upper("name") gin_trgm_ops);
-    CREATE INDEX CONCURRENTLY pretix_addidx_organizer_slug
-        ON pretixbase_organizer
-        USING gin (upper("slug") gin_trgm_ops);
-    CREATE INDEX CONCURRENTLY pretix_addidx_order_email
-        ON pretixbase_order
-        USING gin (upper("email") gin_trgm_ops);
-    CREATE INDEX CONCURRENTLY pretix_addidx_order_comment
-        ON pretixbase_order
-        USING gin (upper("comment") gin_trgm_ops);
-    CREATE INDEX CONCURRENTLY pretix_addidx_order_event_date_id
-        ON public.pretixbase_order (event_id, datetime, id);
-    CREATE INDEX CONCURRENTLY pretix_addidx_orderpos_name
-        ON pretixbase_orderposition
-        USING gin (upper("attendee_name_cached") gin_trgm_ops);
-    CREATE INDEX CONCURRENTLY pretix_addidx_orderpos_secret
-        ON pretixbase_orderposition
-        USING gin (upper("secret") gin_trgm_ops);
-    CREATE INDEX CONCURRENTLY pretix_addidx_orderpos_email
-        ON pretixbase_orderposition
-        USING gin (upper("attendee_email") gin_trgm_ops);
-    CREATE INDEX CONCURRENTLY pretix_addidx_ia_name
-        ON pretixbase_invoiceaddress
-        USING gin (upper("name_cached") gin_trgm_ops);
-    CREATE INDEX CONCURRENTLY pretix_addidx_ia_company
-        ON pretixbase_invoiceaddress
-        USING gin (upper("company") gin_trgm_ops);
-    CREATE INDEX CONCURRENTLY pretix_addidx_orderpos_email_upper
-        ON public.pretixbase_orderposition (upper((attendee_email)::text));
-    CREATE INDEX CONCURRENTLY pretix_addidx_voucher_code_upper
-        ON public.pretixbase_voucher (upper((code)::text));
-    CREATE INDEX CONCURRENTLY pretix_addidx_logentry_event_date_id
-        ON public.pretixbase_logentry (event_id, datetime, id);
-    CREATE INDEX CONCURRENTLY pretix_addidx_logentry_event_cid_date_id
-        ON public.pretixbase_logentry (event_id, content_type_id, datetime, id);
-
-
-Also, if you use our ``pretix-shipping`` plugin::
-
-    CREATE INDEX CONCURRENTLY pretix_addidx_sa_name
-        ON pretix_shipping_shippingaddress
-        USING gin (upper("name") gin_trgm_ops);
-    CREATE INDEX CONCURRENTLY pretix_addidx_sa_company
-        ON pretix_shipping_shippingaddress
-        USING gin (upper("company") gin_trgm_ops);
-

doc/admin/installation/community.rst

@@ -1,18 +0,0 @@
-.. highlight:: none
-
-.. _`community`:
-
-Community install guides
-========================
-
-.. warning:: The guides are maintained by the community and not by the pretix core team. If you encounter any issues with the guides, please report them to the maintainers of the guides. The pretix core team can not provide support for installs using these guides.
-
-Kubernetes
-----------
-
-- Helm Chart by techwolf12 - A Helm chart for deploying pretix on Kubernetes. The chart documentation is available on `ArtifactHub <https://artifacthub.io/packages/helm/techwolf12/pretix>`_ and the source code is available on `GitHub <https://github.com/Techwolf12/charts/tree/main/pretix-helm>`_.
-
-Docker
-------
-
-- `docker compose setup <https://github.com/ZPascal/pretix-docker-compose>`_ by ZPascal

doc/admin/installation/dev_version.rst

@@ -1,37 +0,0 @@
-.. highlight:: none
-
-Installing a development version
-================================
-
-If you want to use a feature of pretix that is not yet contained in the last monthly release, you can also
-install a development version with pretix.
-
-.. warning:: When in production, we strongly recommend only installing released versions. Development versions might
-             be broken, incompatible to plugins, or in rare cases incompatible to upgrade later on.
-
-
-Manual installation
--------------------
-
-You can use ``pip`` to update pretix directly to the development branch. Then, upgrade as usual::
-
-    $ source /var/pretix/venv/bin/activate
-    (venv)$ pip3 install -U "git+https://github.com/pretix/pretix.git#egg=pretix"
-    (venv)$ python -m pretix migrate
-    (venv)$ python -m pretix rebuild
-    (venv)$ python -m pretix updateassets
-    # systemctl restart pretix-web pretix-worker
-
-Docker installation
--------------------
-
-To use the latest development version with Docker, first pull it from Docker Hub::
-
-    $ docker pull pretix/standalone:latest
-
-
-Then change your ``/etc/systemd/system/pretix.service`` file to use the ``:latest`` tag instead of ``:stable`` as well
-and upgrade as usual::
-
-    $ systemctl restart pretix.service
-    $ docker exec -it pretix.service pretix upgrade

doc/admin/installation/docker_smallscale.rst

@@ -1,334 +0,0 @@
-.. highlight:: none
-
-.. _`dockersmallscale`:
-
-Small-scale deployment with Docker
-==================================
-
-This guide describes the installation of a small-scale installation of pretix using docker. By small-scale, we mean
-that everything is being run on one host and you don't expect thousands of participants trying to get a ticket within
-a few minutes. In this setup, as many parts of pretix as possible are hidden away in one single docker container.
-This has some trade-offs in terms of performance and isolation but allows a rather easy installation.
-
-.. warning:: Even though we try to make it straightforward to run pretix, it still requires some Linux experience to
-             get it right. If you're not feeling comfortable managing a Linux server, check out our hosting and service
-             offers at `pretix.eu`_.
-
-We tested this guide on the Linux distribution **Debian 11.0** but it should work very similar on other
-modern distributions, especially on all systemd-based ones.
-
-Requirements
-------------
-
-Please set up the following systems beforehand, we'll not explain them here (but see these links for external
-installation guides):
-
-* `Docker`_
-* A SMTP server to send out mails, e.g. `Postfix`_ on your machine or some third-party server you have credentials for
-* A HTTP reverse proxy, e.g. `nginx`_ or Apache to allow HTTPS connections
-* A `PostgreSQL`_ 12+ database server
-* A `redis`_ server
-
-We also recommend that you use a firewall, although this is not a pretix-specific recommendation. If you're new to
-Linux and firewalls, we recommend that you start with `ufw`_.
-
-.. note:: Please, do not run pretix without HTTPS encryption. You'll handle user data and thanks to `Let's Encrypt`_
-          SSL certificates can be obtained for free these days. We also *do not* provide support for HTTP-only
-          installations except for evaluation purposes.
-
-.. warning:: By default, using `ufw` in conjunction will not have any effect. Please make sure to either bind the exposed
-             ports of your docker container explicitly to 127.0.0.1 or configure docker to respect any set up firewall
-             rules.
-
-On this guide
--------------
-
-All code lines prepended with a ``#`` symbol are commands that you need to execute on your server as ``root`` user;
-all lines prepended with a ``$`` symbol can also be run by an unprivileged user.
-
-Data files
-----------
-
-First of all, you need to create a directory on your server that pretix can use to store data files and make that
-directory writable to the user that runs pretix inside the docker container::
-
-    # mkdir /var/pretix-data
-    # chown -R 15371:15371 /var/pretix-data
-
-Database
---------
-
-Next, we need a database and a database user. We can create these with any kind of database managing tool or directly on
-our database's shell. Please make sure that UTF8 is used as encoding for the best compatibility. You can check this with
-the following command::
-
-    # sudo -u postgres psql -c 'SHOW SERVER_ENCODING'
-
-For PostgreSQL database creation, we would do::
-
-    # sudo -u postgres createuser -P pretix
-    # sudo -u postgres createdb -O pretix pretix
-
-Make sure that your database listens on the network. If PostgreSQL on the same same host as docker, but not inside a docker container, we recommend that you just listen on the Docker interface by changing the following line in ``/etc/postgresql/<version>/main/postgresql.conf``::
-
-    listen_addresses = 'localhost,172.17.0.1'
-
-You also need to add a new line to ``/etc/postgresql/<version>/main/pg_hba.conf`` to allow network connections to this user and database::
-
-    host    pretix          pretix          172.17.0.1/16           md5
-
-Restart PostgreSQL after you changed these files::
-
-    # systemctl restart postgresql
-
-If you have a firewall running, you should also make sure that port 5432 is reachable from the ``172.17.0.1/16`` subnet.
-
-Redis
------
-
-For caching and messaging in small-scale setups, pretix recommends using redis. In this small-scale setup we assume a
-redis instance to be running on the same host. To avoid the hassle with network configurations and firewalls, we
-recommend connecting to redis via a unix socket. To enable redis on unix sockets, add the following to your
-``/etc/redis/redis.conf``::
-
-    unixsocket /var/run/redis/redis.sock
-    unixsocketperm 777
-
-Now restart redis-server::
-
-    # systemctl restart redis-server
-
-In this setup, systemd will delete ``/var/run/redis`` on every redis restart, which will cause issues with pretix. To
-prevent this, you can execute::
-
-   # systemctl edit redis-server
-
-And insert the following::
-
-    [Service]
-    # Keep the directory around so that pretix.service in docker does not need to be
-    # restarted when redis is restarted.
-    RuntimeDirectoryPreserve=yes
-
-.. warning:: Setting the socket permissions to 777 is a possible security problem. If you have untrusted users on your
-             system or have high security requirements, please don't do this and let redis listen to a TCP socket
-             instead. We recommend the socket approach because the TCP socket in combination with docker's networking
-             can easily become an even worse security hole when configured slightly wrong. Read more about security
-             on the `redis website`_.
-
-             Another possible solution is to run `redis in docker`_ and link the containers using docker's networking
-             features.
-
-Config file
------------
-
-We now create a config directory and config file for pretix::
-
-    # mkdir /etc/pretix
-    # touch /etc/pretix/pretix.cfg
-    # chown -R 15371:15371 /etc/pretix/
-    # chmod 0700 /etc/pretix/pretix.cfg
-
-Fill the configuration file ``/etc/pretix/pretix.cfg`` with the following content (adjusted to your environment)::
-
-    [pretix]
-    instance_name=My pretix installation
-    url=https://pretix.mydomain.com
-    currency=EUR
-    ; DO NOT change the following value, it has to be set to the location of the
-    ; directory *inside* the docker container
-    datadir=/data
-    trust_x_forwarded_for=on
-    trust_x_forwarded_proto=on
-
-    [database]
-    backend=postgresql
-    name=pretix
-    user=pretix
-    ; Replace with the password you chose above
-    password=*********
-    ; In most docker setups, 172.17.0.1 is the address of the docker host. Adjust
-    ; this to wherever your database is running, e.g. the name of a linked container.
-    host=172.17.0.1
-
-    [mail]
-    ; See config file documentation for more options
-    from=tickets@yourdomain.com
-    ; This is the default IP address of your docker host in docker's virtual
-    ; network. Make sure postfix listens on this address.
-    host=172.17.0.1
-
-    [redis]
-    location=unix:///var/run/redis/redis.sock?db=0
-    ; Remove the following line if you are unsure about your redis' security
-    ; to reduce impact if redis gets compromised.
-    sessions=true
-
-    [celery]
-    backend=redis+socket:///var/run/redis/redis.sock?virtual_host=1
-    broker=redis+socket:///var/run/redis/redis.sock?virtual_host=2
-
-See :ref:`email configuration <mail-settings>` to learn more about configuring mail features.
-
-Docker image and service
-------------------------
-
-First of all, download the latest stable pretix image by running::
-
-    $ docker pull pretix/standalone:stable
-
-We recommend starting the docker container using systemd to make sure it runs correctly after a reboot. Create a file
-named ``/etc/systemd/system/pretix.service`` with the following content::
-
-    [Unit]
-    Description=pretix
-    After=docker.service
-    Requires=docker.service
-
-    [Service]
-    TimeoutStartSec=0
-    ExecStartPre=-/usr/bin/docker kill %n
-    ExecStartPre=-/usr/bin/docker rm %n
-    ExecStart=/usr/bin/docker run --name %n -p 127.0.0.1:8345:80 \
-        -v /var/pretix-data:/data \
-        -v /etc/pretix:/etc/pretix \
-        -v /var/run/redis:/var/run/redis \
-        --sysctl net.core.somaxconn=4096 \
-        pretix/standalone:stable all
-    ExecStop=/usr/bin/docker stop %n
-
-    [Install]
-    WantedBy=multi-user.target
-
-You can now run the following commands
-to enable and start the service::
-
-    # systemctl daemon-reload
-    # systemctl enable pretix
-    # systemctl start pretix
-
-Cronjob
--------
-
-You need to set up a cronjob that runs the management command ``runperiodic``. The exact interval is not important
-but should be something between every minute and every hour. You could for example configure cron like this::
-
-    15,45 * * * * /usr/bin/docker exec pretix.service pretix cron
-
-The cronjob may run as any user that can use the docker daemon.
-
-SSL
----
-
-The following snippet is an example on how to configure a nginx proxy for pretix::
-
-    server {
-        listen 80 default_server;
-        listen [::]:80 ipv6only=on default_server;
-        server_name pretix.mydomain.com;
-        location / {
-            return 301 https://$host$request_uri;
-        }
-    }
-    server {
-        listen 443 default_server;
-        listen [::]:443 ipv6only=on default_server;
-        server_name pretix.mydomain.com;
-
-        ssl on;
-        ssl_certificate /path/to/cert.chain.pem;
-        ssl_certificate_key /path/to/key.pem;
-
-        location / {
-            proxy_pass http://localhost:8345;
-            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-            proxy_set_header X-Forwarded-Proto https;
-            proxy_set_header Host $http_host;
-        }
-    }
-
-
-We recommend reading about setting `strong encryption settings`_ for your web server.
-
-Next steps
-----------
-
-Yay, you are done! You should now be able to reach pretix at https://pretix.yourdomain.com/control/ and log in as
-*admin@localhost* with a password of *admin*. Don't forget to change that password! Create an organizer first, then
-create an event and start selling tickets!
-
-You should probably read :ref:`maintainance` next.
-
-.. _`docker_updates`:
-
-Updates
--------
-
-.. warning:: While we try hard not to break things, **please perform a backup before every upgrade**.
-
-Updates are fairly simple, but require at least a short downtime::
-
-    # docker pull pretix/standalone:stable
-    # systemctl restart pretix.service
-    # docker exec -it pretix.service pretix upgrade
-
-Restarting the service can take a few seconds, especially if the update requires changes to the database.
-Replace ``stable`` above with a specific version number like ``1.0`` or with ``latest`` for the development
-version, if you want to.
-
-Make sure to also read :ref:`update_notes` and the release notes of the version you are updating to. Pay special
-attention to the "Runtime and server environment" section of all release notes between your current and new version.
-
-.. _`docker_plugininstall`:
-
-Install a plugin
-----------------
-
-To install a plugin, you need to build your own docker image. To do so, create a new directory and place a file
-named ``Dockerfile`` in it. The Dockerfile could look like this (replace ``pretix-passbook`` with the plugins of your
-choice)::
-
-    FROM pretix/standalone:stable
-    USER root
-    RUN pip3 install pretix-passbook
-    USER pretixuser
-    RUN cd /pretix/src && make production
-
-Then, go to that directory and build the image::
-
-    $ docker build . -t mypretix
-
-You can now use that image ``mypretix`` instead of ``pretix/standalone`` in your service file (see above). Be sure
-to re-build your custom image after you pulled ``pretix/standalone`` if you want to perform an update.
-
-Scaling up
-----------
-
-If you need to scale to multiple machines, please first read our :ref:`scaling guide <scaling>`.
-
-If you run the official docker container on multiple machines, it is recommended to set the environment
-variable ``AUTOMIGRATE=skip`` on all containers and run ``docker exec -it pretix.service pretix migrate``
-on one machine after each upgrade manually, otherwise multiple containers might try to upgrade the
-database schema at the same time.
-
-To run only the ``pretix-web`` component of pretix as well as a nginx server serving static files, you
-can invoke the container with ``docker run … pretix/standalone:stable web`` (instead of ``all``). You
-can adjust the number of ``gunicorn`` processes with the ``NUM_WORKERS`` environment variable (defaults to
-two times the number of CPUs detected).
-
-To run only ``pretix-worker``, you can run ``docker run … pretix/standalone:stable taskworker``. You can
-also pass arguments to limit the worker to specific queues or to change the number of concurrent task
-workers, e.g. ``docker run … taskworker -Q notifications --concurrency 32``.
-
-
-.. _Docker: https://docs.docker.com/engine/installation/linux/debian/
-.. _Postfix: https://www.digitalocean.com/community/tutorials/how-to-install-and-configure-postfix-as-a-send-only-smtp-server-on-ubuntu-22-04
-.. _nginx: https://botleg.com/stories/https-with-lets-encrypt-and-nginx/
-.. _Let's Encrypt: https://letsencrypt.org/
-.. _pretix.eu: https://pretix.eu/
-.. _PostgreSQL: https://www.digitalocean.com/community/tutorials/how-to-install-and-use-postgresql-on-ubuntu-22-04
-.. _redis: https://blog.programster.org/debian-8-install-redis-server/
-.. _ufw: https://en.wikipedia.org/wiki/Uncomplicated_Firewall
-.. _redis website: https://redis.io/topics/security
-.. _redis in docker: https://hub.docker.com/r/_/redis/
-.. _strong encryption settings: https://mozilla.github.io/server-side-tls/ssl-config-generator/

doc/admin/installation/enterprise.rst

@@ -1,84 +0,0 @@
-.. highlight:: none
-
-Installing pretix Enterprise plugins
-====================================
-
-If you want to use a feature of pretix that is part of our commercial offering pretix Enterprise, you need to follow
-some extra steps. Installation works similar to normal pretix plugins, but involves a few extra steps.
-
-Buying the license
-------------------
-
-To obtain a license, please get in touch at sales@pretix.eu. Please let us know how many tickets you roughly intend
-to sell per year and how many servers you want to use the plugin on. We recommend having a look at our `price list`_
-first.
-
-
-Manual installation
--------------------
-
-First, generate an SSH key for the system user that you install pretix as. In our tutorial, that would be the user
-``pretix``. Choose an empty passphrase::
-
-    # su pretix
-    $ ssh-keygen
-    Generating public/private rsa key pair.
-    Enter file in which to save the key (/var/pretix/.ssh/id_rsa):
-    Enter passphrase (empty for no passphrase):
-    Enter same passphrase again:
-    Your identification has been saved in /var/pretix/.ssh/id_rsa.
-    Your public key has been saved in /var/pretix/.ssh/id_rsa.pub.
-
-Next, send the content of the *public* key to your sales representative at pretix::
-
-    $ cat /var/pretix/.ssh/id_rsa.pub
-    ssh-rsa AAAAB3N...744HZawHlD pretix@foo
-
-After we configured your key in our system, you can install the plugin directly using ``pip`` from the URL we told
-you, for example::
-
-    $ source /var/pretix/venv/bin/activate
-    (venv)$ pip3 install -U "git+ssh://git@code.rami.io:10022/pretix/pretix-slack.git@stable#egg=pretix-slack"
-    (venv)$ python -m pretix migrate
-    (venv)$ python -m pretix rebuild
-    # systemctl restart pretix-web pretix-worker
-
-Docker installation
--------------------
-
-To install a plugin, you need to build your own docker image. To do so, create a new directory to work in. As a first
-step, generate a new SSH key in that directory to use for authentication with us::
-
-    $ cd /home/me/mypretixdocker
-    $ ssh-keygen -N "" -f id_pretix_enterprise
-
-Next, send the content of the *public* key to your sales representative at pretix::
-
-    $ cat id_pretix_enterprise.pub
-    ssh-rsa AAAAB3N...744HZawHlD pretix@foo
-
-After we configured your key in our system, you can add a ``Dockerfile`` in your directory that includes the newly
-generated key and installs the plugin from the URL we told you::
-
-    FROM pretix/standalone:stable
-    USER root
-    COPY id_pretix_enterprise /root/.ssh/id_rsa
-    COPY id_pretix_enterprise.pub /root/.ssh/id_rsa.pub
-    RUN chmod -R 0600 /root/.ssh && \
-        mkdir -p /etc/ssh && \
-        ssh-keyscan -t rsa -p 10022 code.rami.io >> /root/.ssh/known_hosts && \
-        echo StrictHostKeyChecking=no >> /root/.ssh/config && \
-        DJANGO_SETTINGS_MODULE= pip3 install -U "git+ssh://git@code.rami.io:10022/pretix/pretix-slack.git@stable#egg=pretix-slack" && \
-        cd /pretix/src && \
-        sudo -u pretixuser make production
-    USER pretixuser
-
-Then, build the image for docker::
-
-    $ docker build -t mypretix
-
-You can now use that image ``mypretix`` instead of ``pretix/standalone:stable`` in your ``/etc/systemd/system/pretix.service``
-service file. Be sure to re-build your custom image after you pulled ``pretix/standalone`` if you want to perform an
-update to a new version of pretix.
-
-.. _price list: https://pretix.eu/about/en/pricing

doc/admin/installation/general.rst

@@ -1,39 +0,0 @@
-.. highlight:: ini
-
-.. spelling:word-list:: SQL
-
-General remarks
-===============
-
-Requirements
-------------
-To use pretix, you will need the following things:
-
-* **pretix** and the python packages it depends on
-
-* An **WSGI application server** (we recommend gunicorn)
-
-* A periodic task runner, e.g. ``cron``
-
-* **A database**. This needs to be a SQL-based that is supported by Django. We highly recommend to either
-  go for **PostgreSQL**. If you do not provide one, pretix will run on SQLite, which is useful
-  for evaluation and development purposes.
-
-  .. warning:: Do not ever use SQLite in production. It will break.
-
-* A **reverse proxy**. pretix needs to deliver some static content to your users (e.g. CSS, images, ...). While pretix
-  is capable of doing this, having this handled by a proper web server like **nginx** or **Apache** will be much
-  faster. Also, you need a proxying web server in front to provide SSL encryption.
-
-  .. warning:: Do not ever run without SSL in production. Your users deserve encrypted connections and thanks to
-               `Let's Encrypt`_ SSL certificates can be obtained for free these days.
-
-* A **redis** server. This will be used for caching, session storage and task queuing.
-
-  .. warning:: pretix can run without redis, however this is only intended for development and should never be
-               used in production.
-
-* Optionally: RabbitMQ or memcached. Both of them might provide speedups, but if they are not present,
-  redis will take over their job.
-
-.. _Let's Encrypt: https://letsencrypt.org/

doc/admin/installation/index.rst

@@ -1,17 +0,0 @@
-.. _`installation`:
-
-Installation guide
-==================
-
-We provide you with multiple installation guides for multiple types of setups so you can choose the one appropriate
-for your needs.
-
-.. toctree::
-   :maxdepth: 1
-
-   general
-   docker_smallscale
-   manual_smallscale
-   dev_version
-   enterprise
-   community

doc/admin/installation/manual_smallscale.rst

@@ -1,339 +0,0 @@
-.. highlight:: none
-
-Small-scale manual deployment
-=============================
-
-This guide describes the installation of a small-scale installation of pretix from source. By small-scale, we mean
-that everything is being run on one host and you don't expect thousands of participants trying to get a ticket within
-a few minutes. In this setup, you will have to perform a number of manual steps. If you prefer using a container
-solution with many things readily set-up, look at :ref:`dockersmallscale`.
-
-.. warning:: Even though we try to make it straightforward to run pretix, it still requires some Linux experience to
-             get it right. If you're not feeling comfortable managing a Linux server, check out our hosting and service
-             offers at `pretix.eu`_.
-
-We tested this guide on the Linux distribution **Debian 12** but it should work very similar on other
-modern distributions, especially on all systemd-based ones.
-
-Requirements
-------------
-
-Please set up the following systems beforehand, we'll not explain them here in detail (but see these links for external
-installation guides):
-
-* A python 3.9+ installation
-* A SMTP server to send out mails, e.g. `Postfix`_ on your machine or some third-party server you have credentials for
-* A HTTP reverse proxy, e.g. `nginx`_ or Apache to allow HTTPS connections
-* A `PostgreSQL`_ 12+ database server
-* A `redis`_ server
-* A `nodejs`_ installation
-
-We also recommend that you use a firewall, although this is not a pretix-specific recommendation. If you're new to
-Linux and firewalls, we recommend that you start with `ufw`_.
-
-.. note:: Please, do not run pretix without HTTPS encryption. You'll handle user data and thanks to `Let's Encrypt`_
-          SSL certificates can be obtained for free these days. We also *do not* provide support for HTTP-only
-          installations except for evaluation purposes.
-
-Unix user
----------
-
-As we do not want to run pretix as root, we first create a new unprivileged user::
-
-    # adduser pretix --disabled-password --home /var/pretix
-
-In this guide, all code lines prepended with a ``#`` symbol are commands that you need to execute on your server as
-``root`` user (e.g. using ``sudo``); all lines prepended with a ``$`` symbol should be run by the unprivileged user.
-
-Database
---------
-
-Having the database server installed, we still need a database and a database user. We can create these with any kind
-of database managing tool or directly on our database's shell. Please make sure that UTF8 is used as encoding for the
-best compatibility. You can check this with the following command::
-
-    # sudo -u postgres psql -c 'SHOW SERVER_ENCODING'
-
-For PostgreSQL database creation, we would do::
-
-    # sudo -u postgres createuser pretix
-    # sudo -u postgres createdb -O pretix pretix
-
-Package dependencies
---------------------
-
-To build and run pretix, you will need the following debian packages::
-
-    # apt-get install git build-essential python3-dev python3-venv python3 python3-pip \
-                      python3-dev libxml2-dev libxslt1-dev libffi-dev zlib1g-dev libssl-dev \
-                      gettext libpq-dev libjpeg-dev libopenjp2-7-dev
-
-Config file
------------
-
-We now create a config directory and config file for pretix::
-
-    # mkdir /etc/pretix
-    # touch /etc/pretix/pretix.cfg
-    # chown -R pretix:pretix /etc/pretix/
-    # chmod 0600 /etc/pretix/pretix.cfg
-
-Fill the configuration file ``/etc/pretix/pretix.cfg`` with the following content (adjusted to your environment)::
-
-    [pretix]
-    instance_name=My pretix installation
-    url=https://pretix.mydomain.com
-    currency=EUR
-    datadir=/var/pretix/data
-    trust_x_forwarded_for=on
-    trust_x_forwarded_proto=on
-
-    [database]
-    backend=postgresql
-    name=pretix
-    user=pretix
-    ; For PostgreSQL on the same host, we don't need a password because we can use
-    ; peer authentication if our PostgreSQL user matches our unix user.
-    password=
-    ; For local postgres authentication, you can leave it empty
-    host=
-
-    [mail]
-    ; See config file documentation for more options
-    from=tickets@yourdomain.com
-    host=127.0.0.1
-
-    [redis]
-    location=redis://127.0.0.1/0
-    sessions=true
-
-    [celery]
-    backend=redis://127.0.0.1/1
-    broker=redis://127.0.0.1/2
-
-See :ref:`email configuration <mail-settings>` to learn more about configuring mail features.
-
-Install pretix from PyPI
-------------------------
-
-Now we will install pretix itself. The following steps are to be executed as the ``pretix`` user. Before we
-actually install pretix, we will create a virtual environment to isolate the python packages from your global
-python installation::
-
-    # sudo -u pretix -s
-    $ python3 -m venv /var/pretix/venv
-    $ source /var/pretix/venv/bin/activate
-    (venv)$ pip3 install -U pip setuptools wheel
-
-We now install pretix, its direct dependencies and gunicorn::
-
-    (venv)$ pip3 install pretix gunicorn
-
-Note that you need Python 3.9 or newer. You can find out your Python version using ``python -V``.
-
-We also need to create a data directory and allow your webserver to traverse to the root directory::
-
-    (venv)$ mkdir -p /var/pretix/data/media
-    (venv)$ chmod +x /var/pretix
-
-Finally, we compile static files and translation data and create the database structure::
-
-    (venv)$ python -m pretix migrate
-    (venv)$ python -m pretix rebuild
-
-
-Start pretix as a service
--------------------------
-
-We recommend starting pretix using systemd to make sure it runs correctly after a reboot. Create a file
-named ``/etc/systemd/system/pretix-web.service`` with the following content::
-
-    [Unit]
-    Description=pretix web service
-    After=network.target
-
-    [Service]
-    User=pretix
-    Group=pretix
-    Environment="VIRTUAL_ENV=/var/pretix/venv"
-    Environment="PATH=/var/pretix/venv/bin:/usr/local/bin:/usr/bin:/bin"
-    ExecStart=/var/pretix/venv/bin/gunicorn pretix.wsgi \
-                          --name pretix --workers 5 \
-                          --max-requests 1200  --max-requests-jitter 50 \
-                          --log-level=info --bind=127.0.0.1:8345
-    WorkingDirectory=/var/pretix
-    Restart=on-failure
-
-    [Install]
-    WantedBy=multi-user.target
-
-For background tasks we need a second service ``/etc/systemd/system/pretix-worker.service`` with the following content::
-
-    [Unit]
-    Description=pretix background worker
-    After=network.target
-
-    [Service]
-    User=pretix
-    Group=pretix
-    Environment="VIRTUAL_ENV=/var/pretix/venv"
-    Environment="PATH=/var/pretix/venv/bin:/usr/local/bin:/usr/bin:/bin"
-    ExecStart=/var/pretix/venv/bin/celery -A pretix.celery_app worker -l info
-    WorkingDirectory=/var/pretix
-    Restart=on-failure
-
-    [Install]
-    WantedBy=multi-user.target
-
-You can now run the following commands to enable and start the services::
-
-    # systemctl daemon-reload
-    # systemctl enable pretix-web pretix-worker
-    # systemctl start pretix-web pretix-worker
-
-
-Cronjob
--------
-
-You need to set up a cronjob that runs the management command ``runperiodic``. The exact interval is not important
-but should be something between every minute and every hour. You could for example configure cron like this::
-
-    15,45 * * * * export PATH=/var/pretix/venv/bin:$PATH && cd /var/pretix && python -m pretix runperiodic
-
-The cronjob should run as the ``pretix`` user (``crontab -e -u pretix``).
-
-SSL
----
-
-The following snippet is an example on how to configure a nginx proxy for pretix::
-
-    server {
-        listen 80 default_server;
-        listen [::]:80 ipv6only=on default_server;
-        server_name pretix.mydomain.com;
-        location / {
-            return 301 https://$host$request_uri;
-        }
-    }
-    server {
-        listen 443 default_server;
-        listen [::]:443 ipv6only=on default_server;
-        server_name pretix.mydomain.com;
-
-        ssl on;
-        ssl_certificate /path/to/cert.chain.pem;
-        ssl_certificate_key /path/to/key.pem;
-
-        add_header Referrer-Policy same-origin;
-        add_header X-Content-Type-Options nosniff;
-
-        location / {
-            proxy_pass http://localhost:8345;
-            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-            proxy_set_header X-Forwarded-Proto https;
-            proxy_set_header Host $http_host;
-        }
-
-        location /media/ {
-            alias /var/pretix/data/media/;
-            expires 7d;
-            access_log off;
-        }
-
-        location ^~ /media/cachedfiles {
-            deny all;
-            return 404;
-        }
-        location ^~ /media/invoices {
-            deny all;
-            return 404;
-        }
-
-        location /static/ {
-            alias /var/pretix/venv/lib/python3.11/site-packages/pretix/static.dist/;
-            access_log off;
-            expires 365d;
-            add_header Cache-Control "public";
-        }
-    }
-
-.. note:: Remember to replace the ``python3.11`` in the ``/static/`` path in the config
-          above with your python version.
-
-We recommend reading about setting `strong encryption settings`_ for your web server.
-
-Next steps
-----------
-
-Yay, you are done! You should now be able to reach pretix at https://pretix.yourdomain.com/control/ and log in as
-*admin@localhost* with a password of *admin*. Don't forget to change that password! Create an organizer first, then
-create an event and start selling tickets!
-
-You should probably read :ref:`maintainance` next.
-
-.. _`manual_updates`:
-
-Updates
--------
-
-.. warning:: While we try hard not to break things, **please perform a backup before every upgrade**.
-
-To upgrade to a new pretix release, pull the latest code changes and run the following commands::
-
-    # sudo -u pretix -s
-    $ source /var/pretix/venv/bin/activate
-    (venv)$ pip3 install -U --upgrade-strategy eager pretix gunicorn
-    (venv)$ python -m pretix migrate
-    (venv)$ python -m pretix rebuild
-    (venv)$ python -m pretix updateassets
-    # systemctl restart pretix-web pretix-worker
-
-Make sure to also read :ref:`update_notes` and the release notes of the version you are updating to. Pay special
-attention to the "Runtime and server environment" section of all release notes between your current and new version.
-
-.. _`manual_plugininstall`:
-
-Install a plugin
-----------------
-
-To install a plugin, just use ``pip``! Depending on the plugin, you should probably apply database migrations and
-rebuild the static files afterwards. Replace ``pretix-passbook`` with the plugin of your choice in the following
-example::
-
-    $ source /var/pretix/venv/bin/activate
-    (venv)$ pip3 install pretix-passbook
-    (venv)$ python -m pretix migrate
-    (venv)$ python -m pretix rebuild
-    # systemctl restart pretix-web pretix-worker
-
-System updates
---------------
-
-After system updates, such as updates to a new Ubuntu or Debian release, you might be using a new Python version.
-That's great, but requires some adjustments. First, adjust any old version paths in your nginx configuration file.
-Then, re-create your Python environment::
-
-    $ source /var/pretix/venv/bin/activate
-    (venv)$ pip3 freeze > /tmp/pip-backup.txt
-    $ rm -rf /var/pretix/venv
-    $ python3 -m venv /var/pretix/venv
-    $ source /var/pretix/venv/bin/activate
-    (venv)$ pip3 install -U pip wheel setuptools
-    (venv)$ pip3 install -r /tmp/pip-backup.txt
-
-Then, proceed like after any plugin installation::
-
-    (venv)$ python -m pretix migrate
-    (venv)$ python -m pretix rebuild
-    (venv)$ python -m pretix updateassets
-    # systemctl restart pretix-web pretix-worker
-
-.. _Postfix: https://www.digitalocean.com/community/tutorials/how-to-install-and-configure-postfix-as-a-send-only-smtp-server-on-ubuntu-22-04
-.. _nginx: https://botleg.com/stories/https-with-lets-encrypt-and-nginx/
-.. _Let's Encrypt: https://letsencrypt.org/
-.. _pretix.eu: https://pretix.eu/
-.. _PostgreSQL: https://www.digitalocean.com/community/tutorials/how-to-install-and-use-postgresql-on-ubuntu-22-04
-.. _redis: https://blog.programster.org/debian-8-install-redis-server/
-.. _ufw: https://en.wikipedia.org/wiki/Uncomplicated_Firewall
-.. _strong encryption settings: https://mozilla.github.io/server-side-tls/ssl-config-generator/
-.. _nodejs: https://github.com/nodesource/distributions/blob/master/README.md#deb

doc/admin/maintainance.rst

@@ -1,114 +0,0 @@
-.. highlight:: ini
-
-.. _`maintainance`:
-
-Backups and Monitoring
-======================
-
-If you host your own pretix instance, you also need to care about the availability
-of your service and the safety of your data yourself. This page gives you some
-information that you might need to do so properly.
-
-.. _`backups`:
-
-Backups
--------
-
-There are essentially two things which you should create backups of:
-
-Database
-    Your SQL database. This is critical and you should **absolutely always create automatic
-    backups of your database**. There are tons of tutorials on the internet on how to do this,
-    and the exact process depends on the choice of your database. For PostgreSQL, see the
-    ``pg_dump`` tool. You probably want to create a cronjob that does the backups for you on a
-    regular schedule.
-
-Data directory
-    The data directory of your pretix configuration might contain some things that you should
-    back up. If you did not specify a secret in your config file, back up the ``.secret`` text
-    file in the data directory. If you lose your secret, all currently active user sessions,
-    password reset links and similar things will be rendered invalid. Also, you probably want
-    to backup the ``media`` subdirectory of the data directory which contains all user-uploaded
-    and generated files. This includes files you could in theory regenerate (ticket downloads)
-    but also files that you might be legally required to keep (invoice PDFs) or files that you
-    would need to re-upload (event logos, product pictures, etc.). It is up to you if you
-    create regular backups of this data, but we strongly advise you to do so. You can create
-    backups e.g. using ``rsync``. There is a lot of information on the internet on how to create
-    backups of folders on a Linux machine.
-
-There is no need to create backups of the redis database, if you use it. We only use it for
-non-critical, temporary or cached data.
-
-Uptime monitoring
------------------
-
-To monitor whether your pretix instance is running, you can issue a GET request to
-``https://pretix.mydomain.com/healthcheck/``. This endpoint tests if the connection to the
-database, to the configured cache and to redis (if used) is working correctly. If everything
-appears to work fine, an empty response with status code ``200`` is returned.
-If there is a problem, a status code in the ``5xx`` range will be returned.
-
-.. _`perf-monitoring`:
-
-Performance monitoring
-----------------------
-
-If you want to generate detailed performance statistics of your pretix installation, there is an
-endpoint at ``https://pretix.mydomain.com/metrics`` (no slash at the end) which returns a
-number of values in the text format understood by monitoring tools like Prometheus_. This data
-is only collected and exposed if you enable it in the :ref:`metrics-settings` section of your
-pretix configuration. You can also configure basic auth credentials there to protect your
-statistics against unauthorized access. The data is temporarily collected in redis, so the
-performance impact of this feature depends on the connection to your redis database.
-
-Currently, mostly response times of HTTP requests and background tasks are exposed.
-
-If you want to go even further, you can set the ``profile`` option in the :ref:`django-settings`
-section to a value between 0 and 1. If you set it for example to 0.1, then 10% of your requests
-(randomly selected) will be run with cProfile_ activated. The profiling results will be saved
-to your data directory. As this might impact performance significantly and writes a lot of data
-to disk, we recommend to only enable it for a small number of requests -- and only if you are
-really interested in the results.
-
-Available metrics
-^^^^^^^^^^^^^^^^^
-
-The metrics available in pretix follow the standard `metric types`_ from the Prometheus world.
-Currently, the following metrics are exported:
-
-pretix_view_requests_total
-    Counter. Counts requests to Django views, labeled with the resolved ``url_name``, the used
-    HTTP ``method`` and the ``status_code`` returned.
-
-pretix_view_durations_seconds
-    Histogram. Measures duration of requests to Django views, labeled with the resolved
-    ``url_name``, the used HTTP ``method`` and the ``status_code`` returned.
-
-pretix_task_runs_total
-    Counter. Counts executions of background tasks, labeled with the ``task_name`` and the
-    ``status``. The latter can be ``success``, ``error`` or ``expected-error``.
-
-pretix_task_duration_seconds
-    Histogram. Measures duration of successful background task executions, labeled with the
-    ``task_name``.
-
-pretix_model_instances
-    Gauge. Measures number of instances of a certain model within the database, labeled with
-    the ``model`` name. Starting with pretix 3.11, these numbers might only be approximate for
-    most tables when running on PostgreSQL to mitigate performance impact.
-
-pretix_celery_tasks_queued_count
-    The number of background tasks in the worker queue, labeled with ``queue``.
-
-pretix_celery_tasks_queued_age_seconds
-    The age of the longest-waiting in the worker queue in seconds, labeled with ``queue``.
-
-pretix_logins_successful
-    Counter. The number of successful backend logins.
-
-pretix_logins_failed
-    Counter. The number of failed backend logins, labeled with ``reason``.
-
-.. _metric types: https://prometheus.io/docs/concepts/metric_types/
-.. _Prometheus: https://prometheus.io/
-.. _cProfile: https://docs.python.org/3/library/profile.html

doc/admin/mysql2postgres.rst

@@ -1,261 +0,0 @@
-.. highlight:: none
-
-Migrating from MySQL/MariaDB to PostgreSQL
-==========================================
-
-Our recommended database for all production installations is PostgreSQL. Support for MySQL/MariaDB has been removed
-in newer pretix releases.
-
-In order to follow this guide, your pretix installation needs to be a version that fully supports MySQL/MariaDB. If you
-already upgraded to pretix 5.0 or later, downgrade back to the last 4.x release using ``pip``.
-
-.. note:: We have tested this guide carefully, but we can't assume any liability for its correctness. The data loss
-          risk should be low as long as pretix is not running while you do the migration. If you are a pretix Enterprise
-          customer, feel free to reach out in advance if you want us to support you along the way.
-
-Update database schema
-----------------------
-
-Before you start, make sure your database schema is up to date. With a local installation::
-
-    # sudo -u pretix -s
-    $ source /var/pretix/venv/bin/activate
-    (venv)$ python -m pretix migrate
-
-With a docker installation::
-
-    docker exec -it pretix.service pretix migrate
-
-
-Install PostgreSQL
-------------------
-
-Now, install and set up a PostgreSQL server. For a local installation on Debian or Ubuntu, use::
-
-    # apt install postgresql
-
-Having the database server installed, we still need a database and a database user. We can create these with any kind
-of database managing tool or directly on our database's shell. Please make sure that UTF8 is used as encoding for the
-best compatibility. You can check this with the following command::
-
-    # sudo -u postgres psql -c 'SHOW SERVER_ENCODING'
-
-Without Docker
-""""""""""""""
-
-For our standard manual installation, create the database and user like this::
-
-    # sudo -u postgres createuser pretix
-    # sudo -u postgres createdb -O pretix pretix
-
-With Docker
-"""""""""""
-
-For our standard docker installation, create the database and user like this::
-
-    # sudo -u postgres createuser -P pretix
-    # sudo -u postgres createdb -O pretix pretix
-
-Make sure that your database listens on the network. If PostgreSQL on the same same host as docker, but not inside a docker container, we recommend that you listen on the Docker interface by changing the following line in ``/etc/postgresql/<version>/main/postgresql.conf``::
-
-    listen_addresses = 'localhost,172.17.0.1'
-
-You also need to add a new line to ``/etc/postgresql/<version>/main/pg_hba.conf`` to allow network connections to this user and database::
-
-    host    pretix          pretix          172.17.0.1/16           md5
-
-Restart PostgreSQL after you changed these files::
-
-    # systemctl restart postgresql
-
-If you have a firewall running, you should also make sure that port 5432 is reachable from the ``172.17.0.1/16`` subnet.
-
-Of course, instead of all this you can also run a PostgreSQL docker container and link it to the pretix container.
-
-Stop pretix
------------
-
-To prevent any more changes to your data, stop pretix from running. With a local installation::
-
-    # systemctl stop pretix-web pretix-worker
-
-With docker::
-
-    # systemctl stop pretix
-
-Change configuration
---------------------
-
-Change the database configuration in your ``/etc/pretix/pretix.cfg`` file::
-
-    [database]
-    backend=postgresql
-    name=pretix
-    user=pretix
-    password=  ; only required for docker or remote database, can be kept empty for local auth
-    host=      ; set to 172.17.0.1 in docker setup, keep empty for local auth
-
-
-Create database schema
------------------------
-
-To create the schema in your new PostgreSQL database, use the following commands. With a local installation::
-
-    # sudo -u pretix -s
-    $ source /var/pretix/venv/bin/activate
-    (venv)$ python -m pretix migrate
-
-With docker::
-
-    # docker run --rm -v /var/pretix-data:/data -v /etc/pretix:/etc/pretix -v /var/run/redis:/var/run/redis pretix/standalone:stable migrate
-
-
-Migrate your data
------------------
-
-Install ``pgloader``::
-
-    # apt install pgloader
-
-.. note::
-
-   If you are using Ubuntu 20.04, the ``pgloader`` version from the repositories seems to be incompatible with PostgreSQL
-   12+. You can install ``pgloader`` from the `PostgreSQL repositories`_ instead.
-   See also `this discussion <https://github.com/pretix/pretix/issues/3090>`_.
-
-Create a new file ``/tmp/pretix.load``, replacing the MySQL and PostgreSQL connection strings with the correct user names, passwords, and/or database names::
-
-    LOAD DATABASE
-        FROM mysql://pretix:password@localhost/pretix  -- replace with mysql://username:password@hostname/dbname
-        INTO postgresql:///pretix                      -- replace with dbname
-
-    WITH data only, include no drop, truncate, disable triggers,
-         create no indexes, drop indexes, reset sequences
-
-    ALTER SCHEMA 'pretix' RENAME TO 'public'           -- replace pretix with the name of the MySQL database
-
-    ALTER TABLE NAMES MATCHING ~/.*/
-        SET SCHEMA 'public'
-
-    SET timezone TO '+00:00'
-
-    SET PostgreSQL PARAMETERS
-         maintenance_work_mem to '128MB',
-         work_mem to '12MB';
-
-Then, run::
-
-    # sudo -u postgres pgloader /tmp/pretix.load
-
-The output should end with a table summarizing the results for every table. You can ignore warnings about type casts
-and missing constraints.
-
-Afterwards, delete the file again::
-
-    # rm -rf /tmp/pretix.load
-
-Start pretix
-------------
-
-Stop your MySQL server as a verification step that you are no longer using it::
-
-    # systemctl stop mariadb
-
-Then, restart pretix. With a local installation::
-
-    # systemctl start pretix-web pretix-worker
-
-With a docker installation::
-
-    # systemctl start pretix
-
-And you're done! After you've verified everything has been copied correctly, you can delete the old MySQL database.
-
-.. note:: Don't forget to update your backup process to back up your PostgreSQL database instead of your MySQL database now.
-
-Troubleshooting
----------------
-
-Peer authentication failed
-""""""""""""""""""""""""""
-
-Sometimes you might see an error message like this::
-
-    django.db.utils.OperationalError: connection to server on socket "/var/run/postgresql/.s.PGSQL.5432" failed: FATAL:  Peer authentication failed for user "pretix"
-
-It is important to understand that PostgreSQL by default offers two types of authentication:
-
-- **Peer authentication**, which works automatically based on the Linux user you are working as. This requires that
-  the connection is made through a local socket (empty ``host=`` in ``pretix.cfg``) and the name of the PostgreSQL user
-  and the Linux user are identical.
-
-  - Typically, you might run into this error if you accidentally execute ``python -m pretix`` commands as root instead
-    of the ``pretix`` user.
-
-- **Password authentication**, which requires a username and password and works over network connections. To force
-  password authentication instead of peer authentication, set ``host=127.0.0.1`` in ``pretix.cfg``.
-
-  - You can alter the password on a PostgreSQL shell using the command ``ALTER USER pretix WITH PASSWORD '***';``.
-    When creating a user with the ``createuser`` command, pass option ``-P`` to set a new password.
-
-  - Even with password authentication, PostgreSQL by default only allows local connections. To allow remote connections,
-    you need to adjust both the ``listen_address`` configuration parameter as well as the ``pg_hba.conf`` file (see above
-    for an example with the docker networking setup).
-
-Database error: relation does not exist
-"""""""""""""""""""""""""""""""""""""""
-
-If you see an error like this::
-
-    2023-04-17T19:20:47.744023Z ERROR Database error 42P01: relation "public.pretix_foobar" does not exist
-    QUERY: ALTER TABLE public.pretix_foobar DROP CONSTRAINT IF EXISTS pretix_foobar_order_id_57e2cb41_fk_pretixbas CASCADE;
-    2023-04-17T19:20:47.744023Z FATAL Failed to create the schema, see above.
-
-The reason is most likely that in the past, you installed a pretix plugin that you no longer have installed. However,
-the database still contains tables of that plugin. If you want to keep the data, reinstall the plugin and re-run the
-``migrate`` step from above. If you want to get rid of the data, manually drop the table mentioned in the error message
-from your MySQL database::
-
-    # mysql -u root pretix
-    mysql> DROP TABLE pretix_foobar;
-
-Then, retry. You might see a new error message with a new table, which you can handle the same way.
-
-Cleaning out a failed attempt
-"""""""""""""""""""""""""""""
-
-You might want to clean your PostgreSQL database before you try again after an error. You can do so like this::
-
-    # sudo -u postgres psql pretix
-    pretix=# DROP SCHEMA public CASCADE;
-    pretix=# CREATE SCHEMA public;
-    pretix=# ALTER SCHEMA public OWNER TO pretix;
-
-``pgloader`` crashes with heap exhaustion error
-"""""""""""""""""""""""""""""""""""""""""""""""
-
-On some larger databases, we've seen ``pgloader`` crash with error messages similar to this::
-
-    Heap exhausted during garbage collection: 16 bytes available, 48 requested.
-
-Or this::
-
-    2021-01-04T21:31:17.367000Z ERROR A SB-KERNEL::HEAP-EXHAUSTED-ERROR condition without bindings for heap statistics.  (If
-    you did not expect to see this message, please report it.
-    2021-01-04T21:31:17.382000Z ERROR The value
-      NIL
-    is not of type
-      NUMBER
-    when binding SB-KERNEL::X
-
-The ``pgloader`` version distributed for Debian and Ubuntu is compiled with the ``SBCL`` compiler. If compiled with
-``CCL``, these bugs go away. Unfortunately, it is pretty hard to compile ``pgloader`` manually with ``CCL``. If you
-run into this, we therefore recommend using the docker container provided by the ``pgloader`` maintainers::
-
-    sudo docker run --rm -v /tmp:/tmp --network host -it dimitri/pgloader:ccl.latest pgloader /tmp/pretix.load
-
-As peer authentication is not available from inside the container, this requires you to use password-based authentication
-in PostgreSQL (see above).
-
-
-.. _PostgreSQL repositories: https://wiki.postgresql.org/wiki/Apt

doc/admin/scaling.rst

@@ -1,236 +0,0 @@
-.. _`scaling`:
-
-Scaling guide
-=============
-
-Our :ref:`installation guide <installation>` only covers "small-scale" setups, by which we mostly mean
-setups that run on a **single (virtual) machine** and do not encounter large traffic peaks.
-
-We do not offer an installation guide for larger-scale setups of pretix, mostly because we believe that
-there is no one-size-fits-all solution for this and the desired setup highly depends on your use case,
-the platform you run pretix on, and your technical capabilities. We do not recommend trying set up pretix
-in a multi-server environment if you do not already have experience with managing server clusters.
-
-This document is intended to give you a general idea on what issues you will encounter when you scale up
-and what you should think of.
-
-.. tip::
-
-   If you require more help on this, we're happy to help. Our pretix Enterprise support team has built
-   and helped building, scaling and load-testing pretix installations at any scale and we're looking
-   forward to work with you on fine-tuning your system. If you intend to sell **more than a thousand
-   tickets in a very short amount of time**, we highly recommend reaching out and at least talking this
-   through. Just get in touch at sales@pretix.eu!
-
-Scaling reasons
----------------
-
-There are two main reasons for scaling up a pretix installation beyond a single server:
-
-* **Availability:** Distributing pretix over multiple servers can allow you to survive failure of one or more single machines, leading to a higher uptime and reliability of your system.
-
-* **Traffic and throughput:** Distributing pretix over multiple servers can allow you to process more web requests and ticket sales at the same time.
-
-You are very unlikely to require scaling for other reasons, such as having too much data in your database.
-
-Components
-----------
-
-A pretix installation usually consists of the following components which run performance-relevant processes:
-
-* ``pretix-web`` is the Django-based web application that serves all user interaction.
-
-* ``pretix-worker`` is a Celery-based application that processes tasks that should be run asynchronously outside of the web application process.
-
-* A **PostgreSQL database** keeps all the important data and processes the actual transactions.
-
-* A **web server** that terminates TLS and HTTP connections and forwards them to ``pretix-web``. In some cases, e.g. when serving static files, the web servers might return a response directly. We recommend using ``nginx``.
-
-* A **redis** server responsible for the communication between ``pretix-web`` and ``pretix-worker``, as well as for caching.
-
-* A directory of **media files** such as user-uploaded files or generated files (tickets, invoices, …) that are created and used by ``pretix-web``, ``pretix-worker`` and the web server.
-
-In the following, we will discuss the scaling behavior of every component individually. In general, you can run all of the components
-on the same server, but you can just as well distribute every component to its own server, or even use multiple servers for some single
-components.
-
-.. warning::
-
-   When setting up your system, don't forget about security. In a multi-server environment,
-   you need to take special care to ensure that no unauthorized access to your database
-   is possible through the network and that it's not easy to wiretap your connections. We
-   recommend a rigorous use of firewalls and encryption on all communications. You can
-   ensure this either on an application level (such as using the TLS support in your
-   database) or on a network level with a VPN solution.
-
-Web server
-""""""""""
-
-Your web server is at the very front of your installation. It will need to absorb all of the traffic, and it should be able to
-at least show a decent error message, even when everything else fails. Luckily, web servers are really fast these days, so this
-can be achieved without too much work.
-
-We recommend reading up on tuning your web server for high concurrency. For nginx, this means thinking about the number of worker
-processes and the number of connections each worker process accepts. Double-check that TLS session caching works, because TLS
-handshakes can get really expensive.
-
-During a traffic peak, your web server will be able to make use of more CPU resources, while memory usage will stay comparatively low,
-so if you invest in more hardware here, invest in more and faster CPU cores.
-
-Make sure that pretix' static files (such as CSS and JavaScript assets) as well as user-uploaded media files (event logos, etc)
-are served directly by your web server and your web server caches them in-memory (nginx does it by default) and sets useful
-headers for client-side caching. As an additional performance improvement, you can turn of access logging for these types of files.
-If you want, you can even farm out serving static files to a different web server entirely and :ref:`configure pretix to reference
-them from a different URL <config-urls>`.
-
-.. tip::
-
-   If you expect *really high traffic* for your very popular event, you might want to do some rate limiting on this layer, or,
-   if you want to ensure a fair and robust first-come-first-served experience and prefer letting users wait over showing them
-   errors, consider a queuing solution. We're happy to provide you with such systems, just get in touch at sales@pretix.eu.
-
-pretix-web
-""""""""""
-
-The ``pretix-web`` process does not carry any internal state and can be easily started on as many machines as you like, and you can
-use the load balancing features of your frontend web server to redirect to all of them.
-
-You can adjust the number of processes in the ``gunicorn`` command line, and we recommend choosing roughly two times the number
-of CPU cores available. Under load, the memory consumption of ``pretix-web`` will stay comparatively constant, while the CPU usage
-will increase a lot. Therefore, if you can add more or faster CPU cores, you will be able to serve more users.
-
-pretix-worker
-"""""""""""""
-
-The ``pretix-worker`` process performs all operations that are not directly executed in the request-response-cycle of ``pretix-web``.
-Just like ``pretix-web`` you can easily start up as many instances as you want on different machines to share the work. As long as they
-all talk to the same redis server, they will all receive tasks from ``pretix-web``, work on them and post their result back.
-You can configure the number of threads that run tasks in parallel through the ``--concurrency`` command line option of ``celery``.
-
-Just like ``pretix-web``, this process is mostly heavy on CPU, disk IO and network IO, although memory peaks can occur e.g. during the
-generation of large PDF files, so we recommend having some reserves here.
-
-``pretix-worker`` performs a variety of tasks which are of different importance.
-Some of them are mission-critical and need to be run quickly even during high load (such as
-creating a cart or an order), others are irrelevant and can easily run later (such as
-distributing tickets on the waiting list). You can fine-tune the capacity you assign to each
-of these tasks by running ``pretix-worker`` processes that only work on a specific **queue**.
-For example, you could have three servers dedicated only to process order creations and one
-server dedicated only to sending emails. This allows you to set priorities and also protects
-you from e.g. a slow email server lowering your ticket throughput.
-
-You can do so by specifying one or more queues on the ``celery`` command line of this process, such as ``celery -A pretix.celery_app worker -Q notifications,mail``. Currently,
-the following queues exist:
-
-* ``checkout`` -- This queue handles everything related to carts and orders and thereby everything required to process a sale. This includes adding and deleting items from carts as well as creating and canceling orders.
-
-* ``mail`` -- This queue handles sending of outgoing emails.
-
-* ``notifications`` -- This queue handles the processing of any outgoing notifications, such as email notifications to admin users (except for the actual sending) or API notifications to registered webhooks.
-
-* ``background`` -- This queue handles tasks that are expected to take long or have no human waiting for their result immediately, such as refreshing caches, re-generating CSS files, assigning tickets on the waiting list or parsing bank data files.
-
-* ``default`` -- This queue handles everything else with "medium" or unassigned priority, most prominently the generation of files for tickets, invoices, badges, admin exports, etc.
-
-Media files
-"""""""""""
-
-Both ``pretix-web``, ``pretix-worker`` and in some cases your webserver need to work with
-media files. Media files are all files generated *at runtime* by the software. This can
-include files uploaded by the event organizers, such as the event logo, files uploaded by
-ticket buyers (if you use such features) or files generated by the software, such as
-ticket files, invoice PDFs, data exports or customized CSS files.
-
-Those files are by default stored to the ``media/`` sub-folder of the data directory given
-in the ``pretix.cfg`` configuration file. Inside that ``media/`` folder, you will find a
-``pub/`` folder containing the subset of files that should be publicly accessible through
-the web server. Everything else only needs to be accessible by ``pretix-web`` and
-``pretix-worker`` themselves.
-
-If you distribute ``pretix-web`` or ``pretix-worker`` across more than one machine, you
-**must** make sure that they all have access to a shared storage to read and write these
-files, otherwise you **will** run into errors with the user interface.
-
-The easiest solution for this is probably to store them on a NFS server that you mount
-on each of the other servers.
-
-Since we use Django's file storage mechanism internally, you can in theory also use an object-storage solution like Amazon S3, Ceph, or Minio to store these files, although we currently do not expose this through pretix' configuration file and this would require you to ship your own variant of ``pretix/settings.py`` and reference it through the ``DJANGO_SETTINGS_MODULE`` environment variable.
-
-At pretix.eu, we use a custom-built `object storage cluster`_.
-
-SQL database
-""""""""""""
-
-One of the most critical parts of the whole setup is the SQL database -- and certainly the
-hardest to scale. Tuning relational databases is an art form, and while there's lots of
-material on it on the internet, there's not a single recipe that you can apply to every case.
-
-As a general rule of thumb, the more resources you can give your databases, the better.
-Most databases will happily use all CPU cores available, but only use memory up to an amount
-you configure, so make sure to set this memory usage as high as you can afford. Having more
-memory available allows your database to make more use of caching, which is usually good.
-
-Scaling your database to multiple machines needs to be treated with great caution. It's a
-good idea to have a replica of your database for availability reasons. In case your primary
-database server fails, you can easily switch over to the replica and continue working.
-
-However, using database replicas for performance gain is much more complicated. When using
-replicated database systems, you are always trading in consistency or availability to get
-additional performance and the consequences of this can be subtle. It is important
-that you have a deep understanding of the semantics of your replication mechanism.
-
-.. warning::
-
-   Using an off-the-shelf database proxy solution that redirects read queries to your
-   replicas and write queries to your primary database **will lead to very nasty bugs.**
-
-   As an example, if you buy a ticket, pretix first needs to calculate how many tickets
-   are left to sell. If this calculation is done on a database replica that lags behind
-   even for fractions of a second, the decision to allow selling the ticket will be made
-   on stale data and you can end up with more tickets sold than configured. Similarly,
-   you could imagine situations leading to double payments etc.
-
-If you do have a replica, you *can* tell pretix about it :ref:`in your configuration <config-replica>`.
-This way, pretix can offload complex read-only queries to the replica when it is safe to do so.
-As of pretix 2.7, this is mainly used for search queries in the backend and for rendering the
-product list and event lists in the frontend, but we plan on expanding this in the future.
-
-Therefore, for now our clear recommendation is: Try to scale your database vertically and put
-it on the most powerful machine you have available.
-
-redis
-"""""
-
-While redis is a very important part that glues together some of the components, it isn't used
-heavily and can usually handle a fairly large pretix installation easily on a single modern
-CPU core.
-Having some memory available is good, e.g. if lots of tasks queue up during a traffic peak, but we wouldn't expect ever needing more than a gigabyte of it.
-
-Feel free to set up a redis cluster for availability – but you probably won't need it for performance.
-
-The limitations
----------------
-
-Up to a certain point, pretix scales really well. However, there are a few things that we consider
-even more important than scalability, and those are correctness and reliability. We want you to be
-able to trust that pretix will not sell more tickets than you intended or run into similar error
-cases.
-
-Combined with pretix' flexibility and complexity, especially around vouchers and quotas, this creates
-some hard issues. In many cases, we need to fall back to event-global locking for some actions which
-are likely to run with high concurrency and cause harm.
-
-For every event, only one of these locking actions can be run at the same time. Examples for this are
-adding products limited by a quota to a cart, adding items to a cart using a voucher or placing an order
-consisting of cart positions that don't have a valid reservation for much longer. In these cases, it is
-currently not realistically possible to exceed selling **approx. 500 orders per minute per event**, even
-if you add more hardware.
-If you have an unlimited number of tickets, we can apply fewer locking and we've reached **approx.
-1500 orders per minute per event** in benchmarks, although even more should be possible.
-
-We're working on reducing the number of cases in which this is relevant and thereby improve the possible
-throughput. If you want to use pretix for an event with 10,000+ tickets that are likely to be sold out
-within minutes, please get in touch to discuss possible solutions. We'll work something out for you!
-
-
-.. _object storage cluster: https://behind.pretix.eu/2018/03/20/high-available-cdn/

doc/admin/updates.rst

@@ -1,76 +0,0 @@
-.. _`update_notes`:
-
-Update notes
-============
-
-pretix receives regular feature and bugfix updates and we highly encourage you to always update to
-the latest version for maximum quality and security. Updates are announces on our `blog`_. There are
-usually 10 feature updates in a year, so you can expect a new release almost every month.
-
-Pure bugfix releases are only issued in case of very critical bugs or security vulnerabilities. In these
-case, we'll publish bugfix releases for the last three stable release branches.
-
-Compatibility to plugins and in very rare cases API clients may break. For in-depth details on the
-API changes of every version, please refer to the release notes published on our blog.
-
-Upgrade steps
--------------
-
-For the actual upgrade, you can usually just follow the steps from the installation guide for :ref:`manual installations <manual_updates>`
-or :ref:`docker installations <docker_updates>` respectively.
-Generally, it is always strongly recommended to perform a :ref:`backup <backups>` first.
-It is possible to skip versions during updates, although we recommend not skipping over major version numbers
-(i.e. if you want to go from 2.4 to 4.4, first upgrade to 3.0, then upgrade to 4.0, then to 4.4).
-
-In addition to these standard update steps, the following list issues steps that should be taken when you upgrade
-to specific versions for pretix. If you're skipping versions, please read the instructions for every version in
-between as well.
-
-Upgrade to 3.17.0 or newer
-""""""""""""""""""""""""""
-
-pretix 3.17 introduces a dependency on ``nodejs``, so you should install it on your system::
-
-    # apt install nodejs npm
-
-Upgrade to 4.4.0 or newer
-"""""""""""""""""""""""""
-
-pretix 4.4 introduces a new data structure to store historical financial data. If you already have existing
-data in your database, you will need to back-fill this data or you might get incorrect reports! This is not
-done automatically as part of the usual update steps since it can take a while on large databases and you might
-want to do it in parallel while the system is already running again. Please execute the following command::
-
-    (venv)$ python -m pretix create_order_transactions
-
-Or, with a docker installation::
-
-    $ docker exec -it pretix.service pretix create_order_transactions
-
-Upgrade to 2023.6.0 or newer
-""""""""""""""""""""""""""""
-
-MariaDB and MySQL are no longer supported.
-
-Upgrade to 2023.8.0 or newer
-""""""""""""""""""""""""""""
-
-PostgreSQL 11 is now required.
-
-Upgrade to 2023.9.0 or newer
-""""""""""""""""""""""""""""
-
-This release includes a migration that changes the `id` column of all core database tables from `integer`
-to `bigint`. If you have a large database, the migration step of the upgrade might take significantly longer than
-usual, so plan the update accordingly.
-
-The default value for the `registration` setting in `pretix.cfg` has changed to `false`.
-
-Upgrade to 2023.10.0 or newer
-"""""""""""""""""""""""""""""
-
-This release includes a migration that changes retroactively fills an `organizer` column in the table
-`pretixbase_logentry`. If you have a large database, the migration step of the upgrade might take significantly
-longer than usual, so plan the update accordingly.
-
-.. _blog: https://pretix.eu/about/en/blog/

doc/api/resources/auto_checkin_rules.rst

@@ -0,0 +1,259 @@
+.. _rest-autocheckinrules:
+
+Auto check-in rules
+===================
+
+This feature requires the bundled ``pretix.plugins.autocheckin`` plugin to be active for the event in order to work properly.
+
+Resource description
+--------------------
+
+Auto check-in rules specify that tickets should under specific conditions automatically be considered checked in after
+they have been purchased.
+
+.. rst-class:: rest-resource-table
+
+===================================== ========================== =======================================================
+Field                                 Type                       Description
+===================================== ========================== =======================================================
+id                                    integer                    Internal ID of the rule
+list                                  integer                    ID of the check-in list to check the ticket in on. If
+                                                                 ``None``, the system will select all matching check-in lists.
+mode                                  string                     ``"placed"`` if the rule should be evaluated right after
+                                                                 an order has been created, ``"paid"`` if the rule should
+                                                                 be evaluated after the order has been fully paid.
+all_sales_channels                    boolean                    If ``true`` (default), the rule applies to tickets sold on all sales channels.
+limit_sales_channels                  list of strings            List of sales channel identifiers the rule should apply to
+                                                                 if ``all_sales_channels`` is ``false``.
+all_products                          boolean                    If ``true`` (default), the rule affects all products and variations.
+limit_products                        list of integers           List of item IDs, if ``all_products`` is not set. If the
+                                                                 product listed here has variations, all variations will be matched.
+limit_variations                      list of integers           List of product variation IDs, if ``all_products`` is not set.
+                                                                 The parent product does not need to be part of ``limit_products``.
+all_payment_methods                   boolean                    If ``true`` (default), the rule applies to tickets paid with all payment methods.
+limit_payment_methods                 list of strings            List of payment method identifiers the rule should apply to
+                                                                 if ``all_payment_methods`` is ``false``.
+===================================== ========================== =======================================================
+
+.. versionadded:: 2024.7
+
+Endpoints
+---------
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/auto_checkin_rules/
+
+   Returns a list of all rules configured for an event.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/auto_checkin_rules/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "count": 1,
+        "next": null,
+        "previous": null,
+        "results": [
+          {
+            "id": 1,
+            "list": 12345,
+            "mode": "placed",
+            "all_sales_channels": false,
+            "limit_sales_channels": ["web"],
+            "all_products": false,
+            "limit_products": [2, 3],
+            "limit_variations": [456],
+            "all_payment_methods": true,
+            "limit_payment_methods": []
+          }
+        ]
+      }
+
+   :query page: The page number in case of a multi-page result set, default is 1
+   :param organizer: The ``slug`` field of a valid organizer
+   :param event: The ``slug`` field of the event to fetch
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to view it.
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/auto_checkin_rules/(id)/
+
+   Returns information on one rule, identified by its ID.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/auto_checkin_rules/1/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "id": 1,
+        "list": 12345,
+        "mode": "placed",
+        "all_sales_channels": false,
+        "limit_sales_channels": ["web"],
+        "all_products": false,
+        "limit_products": [2, 3],
+        "limit_variations": [456],
+        "all_payment_methods": true,
+        "limit_payment_methods": []
+      }
+
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :param event: The ``slug`` field of the event to fetch
+   :param id: The ``id`` field of the rule to fetch
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event/rule does not exist **or** you have no permission to view it.
+
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/auto_checkin_rules/
+
+   Create a new rule.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/auto_checkin_rules/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+      Content-Length: 166
+
+      {
+        "list": 12345,
+        "mode": "placed",
+        "all_sales_channels": false,
+        "limit_sales_channels": ["web"],
+        "all_products": false,
+        "limit_products": [2, 3],
+        "limit_variations": [456],
+        "all_payment_methods": true,
+        "limit_payment_methods": []
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 201 Created
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "id": 1,
+        "list": 12345,
+        "mode": "placed",
+        "all_sales_channels": false,
+        "limit_sales_channels": ["web"],
+        "all_products": false,
+        "limit_products": [2, 3],
+        "limit_variations": [456],
+        "all_payment_methods": true,
+        "limit_payment_methods": []
+      }
+
+   :param organizer: The ``slug`` field of the organizer to create a rule for
+   :param event: The ``slug`` field of the event to create a rule for
+   :statuscode 201: no error
+   :statuscode 400: The rule could not be created due to invalid submitted data.
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to create rules.
+
+
+.. http:patch:: /api/v1/organizers/(organizer)/events/(event)/auto_checkin_rules/(id)/
+
+   Update a rule. You can also use ``PUT`` instead of ``PATCH``. With ``PUT``, you have to provide all fields of
+   the resource, other fields will be reset to default. With ``PATCH``, you only need to provide the fields that you
+   want to change.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      PATCH /api/v1/organizers/bigevents/events/sampleconf/auto_checkin_rules/1/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+      Content-Length: 34
+
+      {
+        "mode": "paid",
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: text/javascript
+
+      {
+        "id": 1,
+        "list": 12345,
+        "mode": "placed",
+        "all_sales_channels": false,
+        "limit_sales_channels": ["web"],
+        "all_products": false,
+        "limit_products": [2, 3],
+        "limit_variations": [456],
+        "all_payment_methods": true,
+        "limit_payment_methods": []
+      }
+
+   :param organizer: The ``slug`` field of the organizer to modify
+   :param event: The ``slug`` field of the event to modify
+   :param id: The ``id`` field of the rule to modify
+   :statuscode 200: no error
+   :statuscode 400: The rule could not be modified due to invalid submitted data.
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event/rule does not exist **or** you have no permission to change it.
+
+
+.. http:delete:: /api/v1/organizers/(organizer)/events/(event)/auto_checkin_rules/(id)/
+
+   Delete a rule.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      DELETE /api/v1/organizers/bigevents/events/sampleconf/auto_checkin_rules/1/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 204 No Content
+      Vary: Accept
+
+   :param organizer: The ``slug`` field of the organizer to modify
+   :param event: The ``slug`` field of the event to modify
+   :param id: The ``id`` field of the rule to delete
+   :statuscode 204: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event/rule does not exist **or** you have no permission to change it **or** this rule cannot be deleted since it is currently in use.

doc/api/resources/badges.rst

@@ -1,7 +1,7 @@
 Badges
 ======
 
-The badges plugin provides a HTTP API that exposes the various layouts used to generate PDF badges.
+The built-in badges plugin provides a HTTP API that exposes the various layouts used to generate PDF badges.
 
 Resource description
 --------------------

doc/api/resources/banktransfer.rst

@@ -1,7 +1,7 @@
-Bank transfer HTTP API
-======================
+Bank transfer
+=============
 
-The banktransfer plugin provides a HTTP API that `pretix-banktool`_ uses to send bank
+The built-in banktransfer plugin provides a HTTP API that `pretix-banktool`_ uses to send bank
 transactions to the pretix server. This API is integrated with the regular :ref:`rest-api`
 and therefore follows the conventions listed there.
 

doc/api/resources/campaigns.rst

@@ -1,6 +1,8 @@
 Campaigns
 =========
 
+.. note:: This API is only available when the plugin **pretix-campaigns** is installed (pretix Hosted and Enterprise only).
+
 The campaigns plugin provides a HTTP API that allows you to create new campaigns.
 
 Resource description

doc/api/resources/carts.rst

@@ -40,14 +40,14 @@ answers                               list of objects            Answers to user
 seat                                  objects                    The assigned seat (or ``null``)
 ├ id                                  integer                    Internal ID of the seat instance
 ├ name                                string                     Human-readable seat name
+├ zone_name                           string                     Name of the zone the seat is in
+├ row_name                            string                     Name/number of the row the seat is in
+├ row_label                           string                     Additional label of the row (or ``null``)
+├ seat_number                         string                     Number of the seat within the row
+├ seat_label                          string                     Additional label of the seat (or ``null``)
 └ seat_guid                           string                     Identifier of the seat within the seating plan
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 4.14
-
-   This ``is_bundled`` attribute has been added and the cart creation endpoints have been updated.
-
-
 Cart position endpoints
 -----------------------
 

doc/api/resources/categories.rst

@@ -23,6 +23,22 @@ position                              integer                    An integer, use
 is_addon                              boolean                    If ``true``, items within this category are not on sale
                                                                  on their own but the category provides a source for
                                                                  defining add-ons for other products.
+cross_selling_mode                    string                     If ``null``, cross-selling is disabled for this category.
+                                                                 If ``"only"``, it is only visible in the cross-selling
+                                                                 step.
+                                                                 If ``"both"``, it is visible on the normal index page
+                                                                 as well.
+                                                                 Only available if ``is_addon`` is ``false``.
+cross_selling_condition               string                     Only relevant if ``cross_selling_mode`` is not ``null``.
+                                                                 If ``"always"``, always show in cross-selling step.
+                                                                 If ``"products"``, only show if the cart contains one of
+                                                                 the products listed in ``cross_selling_match_products``.
+                                                                 If ``"discounts"``, only show products that qualify for
+                                                                 a discount according to discount rules.
+cross_selling_match_products          list of integer            Only relevant if ``cross_selling_condition`` is
+                                                                 ``"products"``. Internal ID of the items of which at
+                                                                 least one needs to be in the cart for this category to
+                                                                 be shown.
 ===================================== ========================== =======================================================
 
 
@@ -60,7 +76,10 @@ Endpoints
             "internal_name": "",
             "description": {"en": "Tickets are what you need to get in."},
             "position": 1,
-            "is_addon": false
+            "is_addon": false,
+            "cross_selling_mode": null,
+            "cross_selling_condition": null,
+            "cross_selling_match_products": []
           }
         ]
       }
@@ -102,7 +121,10 @@ Endpoints
         "internal_name": "",
         "description": {"en": "Tickets are what you need to get in."},
         "position": 1,
-        "is_addon": false
+        "is_addon": false,
+        "cross_selling_mode": null,
+        "cross_selling_condition": null,
+        "cross_selling_match_products": []
       }
 
    :param organizer: The ``slug`` field of the organizer to fetch
@@ -130,7 +152,10 @@ Endpoints
         "internal_name": "",
         "description": {"en": "Tickets are what you need to get in."},
         "position": 1,
-        "is_addon": false
+        "is_addon": false,
+        "cross_selling_mode": null,
+        "cross_selling_condition": null,
+        "cross_selling_match_products": []
       }
 
    **Example response**:
@@ -147,7 +172,10 @@ Endpoints
         "internal_name": "",
         "description": {"en": "Tickets are what you need to get in."},
         "position": 1,
-        "is_addon": false
+        "is_addon": false,
+        "cross_selling_mode": null,
+        "cross_selling_condition": null,
+        "cross_selling_match_products": []
       }
 
    :param organizer: The ``slug`` field of the organizer of the event to create a category for
@@ -193,7 +221,10 @@ Endpoints
         "internal_name": "",
         "description": {"en": "Tickets are what you need to get in."},
         "position": 1,
-        "is_addon": true
+        "is_addon": true,
+        "cross_selling_mode": null,
+        "cross_selling_condition": null,
+        "cross_selling_match_products": []
       }
 
    :param organizer: The ``slug`` field of the organizer to modify

doc/api/resources/certificates.rst

@@ -1,6 +1,8 @@
 Certificates of attendance
 ==========================
 
+.. note:: This API is only available when the plugin **pretix-certificates** is installed (pretix Hosted and Enterprise only).
+
 The certificates plugin provides a HTTP API that allows you to download the certificate for a specific attendee.
 
 
@@ -21,7 +23,7 @@ Certificate download
 
    .. sourcecode:: http
 
-      GET /api/v1/organizers/bigevents/events/sampleconf/orderpositions/23442/download/certificate/ HTTP/1.1
+      GET /api/v1/organizers/bigevents/events/sampleconf/orderpositions/23442/certificate/ HTTP/1.1
       Host: pretix.eu
       Accept: application/json, text/javascript
 
@@ -36,7 +38,7 @@ Certificate download
 
    .. sourcecode:: http
 
-      GET /api/v1/organizers/bigevents/events/sampleconf/orderpositions/23442/download/certificate/?result=1f550651-ae7b-4911-a76c-2be8f348aaa5 HTTP/1.1
+      GET /api/v1/organizers/bigevents/events/sampleconf/orderpositions/23442/certificate/?result=1f550651-ae7b-4911-a76c-2be8f348aaa5 HTTP/1.1
       Host: pretix.eu
       Accept: application/json, text/javascript
 

doc/api/resources/checkin.rst

@@ -9,14 +9,6 @@ This page describes special APIs built for ticket scanning apps. For managing ch
 please also see :ref:`rest-checkinlists`. The check-in list API also contains endpoints to obtain statistics or log
 failed scans.
 
-.. versionchanged:: 4.12
-
-    The endpoints listed on this page have been added.
-
-.. versionchanged:: 4.18
-
-    The ``source_type`` parameter has been added.
-
 .. _`rest-checkin-redeem`:
 
 Checking a ticket in
@@ -54,6 +46,11 @@ Checking a ticket in
                         this request twice with the same nonce, the second request will also succeed but will always
                         create only one check-in object even when the previous request was successful as well. This
                         allows for a certain level of idempotency and enables you to re-try after a connection failure.
+   :<json boolean use_order_locale: Specifies that pretix should use the customer's language (``locale`` field from the
+                                    order) when building texts (currently only the ``reason_explanation`` response field).
+                                    Defaults to ``false`` in which case the server will determine the language (currently
+                                    the event default language, might change in the future with support for the
+                                    ``Accept-Language`` header).
    :>json string status: ``"ok"``, ``"incomplete"``, or ``"error"``
    :>json string reason: Reason code, only set on status ``"error"``, see below for possible values.
    :>json string reason_explanation: Human-readable explanation, only set on status ``"error"`` and reason ``"rules"``, can be null.
@@ -62,7 +59,9 @@ Checking a ticket in
                            will only include check-ins for the selected list. (2) An additional boolean property
                            ``require_attention`` will inform you whether either the order or the item have the
                            ``checkin_attention`` flag set. (3) If ``attendee_name`` is empty, it may automatically fall
-                           back to values from a parent product or from invoice addresses.
+                           back to values from a parent product or from invoice addresses. (4) Additional properties
+                           ``order__status``, ``order__valid_if_pending``, ``order__require_approval``, and
+                           ``order__locale`` are included with details form the order for convenience.
    :>json boolean require_attention: Whether or not the ``require_attention`` flag is set on the item or order.
    :>json list checkin_texts: List of additional texts to show to the user.
    :>json object list: Excerpt of information about the matching :ref:`check-in list <rest-checkinlists>` (if any was found),
@@ -360,3 +359,65 @@ Performing a ticket search
    :statuscode 401: Authentication failure
    :statuscode 403: The requested organizer or check-in list does not exist **or** you have no permission to view this resource.
    :statuscode 404: The requested check-in list does not exist.
+
+.. _`rest-checkin-annul`:
+
+Annulment of a check-in
+-----------------------
+
+.. http:post:: /api/v1/organizers/(organizer)/checkinrpc/annul/
+
+   If a check-in was made in error and the person was not let in, it can be annulled. We do not recommend this to be used
+   in case of manual check-ins or user interfaces because it is too prone for human errors. It is mostly intended for
+   automated entry systems like a turnstile or automated door, where the check-in is first created, then the door is
+   opened, and then the check-in may be annulled if the system knows that the turnstile did not turn or was out of
+   order.
+
+   This endpoint supports passing multiple check-in lists for the context of a multi-event scan. However, each
+   check-in list passed needs to be from a distinct event.
+
+   Check-ins created by a device can only be annulled by the same device. The datetime of annulment may not be more than
+   15 minutes after the datetime of check-in (value subject to change).
+
+   A status code of 404 is returned if no check-in was found for the given nonce. A status code of 400 is returned when
+   multiple check-ins match the nonce, the input is invalid in another way, the annulment is made from the wrong device,
+   the check-in is already in an annulled or failed state, or the datetime constraint is not valid.
+
+   :<json string nonce: ``nonce`` value of the original check-in.
+   :<json array lists: List of check-in list IDs to search on. No two check-in lists may be from the same event.
+   :<json datetime datetime: Specifies the client-side datetime of the annulment. If not supplied, the current time will be used.
+   :<json string error_explanation: A human-readable description of why the check-in was annulled (optional).
+   :>json string status: ``"ok"``
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/checkinrpc/annul/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+      {
+        "lists": [1],
+        "nonce": "Pvrk50vUzQd0DhdpNRL4I4OcXsvg70uA",
+        "error_explanation": "Turnstile did not turn"
+      }
+
+   **Example successful response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "status": "ok",
+      }
+
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :statuscode 200: no error
+   :statuscode 400: Invalid or incomplete request, see above
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
+   :statuscode 404: The requested nonce does not exist.

doc/api/resources/checkinlists.rst

@@ -31,7 +31,6 @@ subevent                              integer                    ID of the date
 position_count                        integer                    Number of tickets that match this list (read-only).
 checkin_count                         integer                    Number of check-ins performed on this list (read-only).
 include_pending                       boolean                    If ``true``, the check-in list also contains tickets from orders in pending state.
-auto_checkin_sales_channels           list of strings            All items on the check-in list will be automatically marked as checked-in when purchased through any of the listed sales channels.
 allow_multiple_entries                boolean                    If ``true``, subsequent scans of a ticket on this list should not show a warning but instead be stored as an additional check-in.
 allow_entry_after_exit                boolean                    If ``true``, subsequent scans of a ticket on this list are valid if the last scan of the ticket was an exit scan.
 rules                                 object                     Custom check-in logic. The contents of this field are currently not considered a stable API and modifications through the API are highly discouraged.
@@ -41,10 +40,6 @@ ignore_in_statistics                  boolean                    If ``true``, ch
 consider_tickets_used                 boolean                    If ``true`` (default), tickets checked in on this list will be considered "used" by other functionality, i.e. when checking if they can still be canceled.
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 4.12
-
-    The ``addon_match`` attribute has been added.
-
 .. versionchanged:: 2023.9
 
     The ``ignore_in_statistics`` and ``consider_tickets_used`` attributes have been added.
@@ -90,10 +85,7 @@ Endpoints
             "allow_entry_after_exit": true,
             "exit_all_at": null,
             "rules": {},
-            "addon_match": false,
-            "auto_checkin_sales_channels": [
-              "pretixpos"
-            ]
+            "addon_match": false
           }
         ]
       }
@@ -145,10 +137,7 @@ Endpoints
         "allow_entry_after_exit": true,
         "exit_all_at": null,
         "rules": {},
-        "addon_match": false,
-        "auto_checkin_sales_channels": [
-          "pretixpos"
-        ]
+        "addon_match": false
       }
 
    :param organizer: The ``slug`` field of the organizer to fetch
@@ -245,10 +234,7 @@ Endpoints
         "subevent": null,
         "allow_multiple_entries": false,
         "allow_entry_after_exit": true,
-        "addon_match": false,
-        "auto_checkin_sales_channels": [
-          "pretixpos"
-        ]
+        "addon_match": false
       }
 
    **Example response**:
@@ -270,10 +256,7 @@ Endpoints
         "subevent": null,
         "allow_multiple_entries": false,
         "allow_entry_after_exit": true,
-        "addon_match": false,
-        "auto_checkin_sales_channels": [
-          "pretixpos"
-        ]
+        "addon_match": false
       }
 
    :param organizer: The ``slug`` field of the organizer of the event/item to create a list for
@@ -325,10 +308,7 @@ Endpoints
         "subevent": null,
         "allow_multiple_entries": false,
         "allow_entry_after_exit": true,
-        "addon_match": false,
-        "auto_checkin_sales_channels": [
-          "pretixpos"
-        ]
+        "addon_match": false
       }
 
    :param organizer: The ``slug`` field of the organizer to modify
@@ -341,7 +321,7 @@ Endpoints
 
 .. http:delete:: /api/v1/organizers/(organizer)/events/(event)/checkinlist/(id)/
 
-   Delete a check-in list. Note that this also deletes the information on all check-ins performed via this list.
+   Delete a check-in list. **Note that this also deletes the information on all check-ins performed via this list.**
 
    **Example request**:
 

doc/api/resources/customers.rst

@@ -34,12 +34,6 @@ password                              string                     Can only be set
                                                                  not be included in any responses.
 ===================================== ========================== =======================================================
 
-.. versionadded:: 4.0
-
-.. versionchanged:: 4.3
-
-   Passwords can now be set through the API during customer creation.
-
 .. versionchanged:: 2024.3
 
    The attribute ``phone`` has been added.

doc/api/resources/digital.rst

@@ -1,6 +1,8 @@
 Digital content
 ===============
 
+.. note:: This API is only available when the plugin **pretix-digital** is installed (pretix Hosted and Enterprise only).
+
 URL interpolation and JWT authentication
 ----------------------------------------
 

doc/api/resources/discounts.rst

@@ -20,8 +20,12 @@ id                                       integer                    Internal ID
 active                                   boolean                    The discount will be ignored if this is ``false``
 internal_name                            string                     A name for the rule used in the backend
 position                                 integer                    An integer, used for sorting the rules which are applied in order
-sales_channels                           list of strings            Sales channels this discount is available on, such as
-                                                                    ``"web"`` or ``"resellers"``. Defaults to ``["web"]``.
+all_sales_channels                       boolean                    If ``true`` (default), the discount is available on all sales channels
+                                                                    that support discounts.
+limit_sales_channels                     list of strings            List of sales channel identifiers the discount is available on
+                                                                    if ``all_sales_channels`` is ``false``.
+sales_channels                           list of strings            **DEPRECATED.** Legacy interface, use ``all_sales_channels``
+                                                                    and ``limit_sales_channels`` instead.
 available_from                           datetime                   The first date time at which this discount can be applied
                                                                     (or ``null``).
 available_until                          datetime                   The last date time at which this discount can be applied
@@ -31,6 +35,10 @@ subevent_mode                            strings                    Determines h
                                                                     ``"same"`` (discount is only applied for groups within
                                                                     the same date), or ``"distinct"`` (discount is only applied
                                                                     for groups with no two same dates).
+subevent_date_from                       datetime                   The first date time of a subevent to which this discount can be applied
+                                                                    (or ``null``). Ignored in non-series events.
+subevent_date_until                      datetime                   The last date time of a subevent to which this discount can be applied
+                                                                    (or ``null``). Ignored in non-series events.
 condition_all_products                   boolean                    If ``true``, the discount condition applies to all items.
 condition_limit_products                 list of integers           If ``condition_all_products`` is not set, this is a list
                                                                     of internal item IDs that the discount condition applies to.
@@ -95,10 +103,14 @@ Endpoints
             "active": true,
             "internal_name": "3 for 2",
             "position": 1,
+            "all_sales_channels": false,
+            "limit_sales_channels": ["web"],
             "sales_channels": ["web"],
             "available_from": null,
             "available_until": null,
             "subevent_mode": "mixed",
+            "subevent_date_from": null,
+            "subevent_date_until": null,
             "condition_all_products": true,
             "condition_limit_products": [],
             "condition_apply_to_addons": true,
@@ -151,10 +163,14 @@ Endpoints
         "active": true,
         "internal_name": "3 for 2",
         "position": 1,
+        "all_sales_channels": false,
+        "limit_sales_channels": ["web"],
         "sales_channels": ["web"],
         "available_from": null,
         "available_until": null,
         "subevent_mode": "mixed",
+        "subevent_date_from": null,
+        "subevent_date_until": null,
         "condition_all_products": true,
         "condition_limit_products": [],
         "condition_apply_to_addons": true,
@@ -193,10 +209,14 @@ Endpoints
         "active": true,
         "internal_name": "3 for 2",
         "position": 1,
+        "all_sales_channels": false,
+        "limit_sales_channels": ["web"],
         "sales_channels": ["web"],
         "available_from": null,
         "available_until": null,
         "subevent_mode": "mixed",
+        "subevent_date_from": null,
+        "subevent_date_until": null,
         "condition_all_products": true,
         "condition_limit_products": [],
         "condition_apply_to_addons": true,
@@ -224,10 +244,14 @@ Endpoints
         "active": true,
         "internal_name": "3 for 2",
         "position": 1,
+        "all_sales_channels": false,
+        "limit_sales_channels": ["web"],
         "sales_channels": ["web"],
         "available_from": null,
         "available_until": null,
         "subevent_mode": "mixed",
+        "subevent_date_from": null,
+        "subevent_date_until": null,
         "condition_all_products": true,
         "condition_limit_products": [],
         "condition_apply_to_addons": true,
@@ -284,10 +308,14 @@ Endpoints
         "active": false,
         "internal_name": "3 for 2",
         "position": 1,
+        "all_sales_channels": false,
+        "limit_sales_channels": ["web"],
         "sales_channels": ["web"],
         "available_from": null,
         "available_until": null,
         "subevent_mode": "mixed",
+        "subevent_date_from": null,
+        "subevent_date_until": null,
         "condition_all_products": true,
         "condition_limit_products": [],
         "condition_apply_to_addons": true,

doc/api/resources/events.rst

@@ -49,8 +49,11 @@ item_meta_properties                  object                     Item-specific m
 valid_keys                            object                     Cryptographic keys for non-default signature schemes.
                                                                  For performance reason, value is omitted in lists and
                                                                  only contained in detail views. Value can be cached.
-sales_channels                        list                       A list of sales channels this event is available for
-                                                                 sale on.
+all_sales_channels                    boolean                    If ``true`` (default), the event is available on all sales channels.
+limit_sales_channels                  list of strings            List of sales channel identifiers the event is available on
+                                                                 if ``all_sales_channels`` is ``false``.
+sales_channels                        list of strings            **DEPRECATED.** Legacy interface, use ``all_sales_channels``
+                                                                 and ``limit_sales_channels`` instead.
 public_url                            string                     The public, customer-facing URL of the event (read-only).
 ===================================== ========================== =======================================================
 
@@ -58,25 +61,6 @@ public_url                            string                     The public, cus
 Endpoints
 ---------
 
-.. versionchanged:: 4.0
-
-    The ``clone_from`` parameter has been added to the event creation endpoint.
-
-.. versionchanged:: 4.1
-
-    The ``with_availability_for`` parameter has been added.
-
-    The ``search`` query parameter has been added to filter events by their slug, name, or location in any language.
-
-.. versionchanged:: 4.17
-
-    The ``public_url`` field has been added.
-
-.. versionchanged:: 5.0
-
-    The ``date_from_before``, ``date_from_after``, ``date_to_before``, and ``date_to_after`` query parameters have been
-    added.
-
 .. http:get:: /api/v1/organizers/(organizer)/events/
 
    Returns a list of all events within a given organizer the authenticated user/token has access to.
@@ -131,11 +115,13 @@ Endpoints
               "pretix.plugins.paypal",
               "pretix.plugins.ticketoutputpdf"
             ],
-            "sales_channels": [
+            "all_sales_channels": false,
+            "limit_sales_channels": [
               "web",
               "pretixpos",
               "resellers"
             ],
+            "sales_channels": [],
             "public_url": "https://pretix.eu/bigevents/sampleconf/"
           }
         ]
@@ -225,6 +211,8 @@ Endpoints
             "LS0tLS1CRUdJTiBQVUJMSUMgS0VZLS0tLS0KTUNvd0JRWURLMlZ3QXlFQTdBRDcvdkZBMzNFc1k0ejJQSHI3aVpQc1o4bjVkaDBhalA4Z3l6Tm1tSXM9Ci0tLS0tRU5EIFBVQkxJQyBLRVktLS0tLQo="
           ]
         },
+        "all_sales_channels": true,
+        "limit_sales_channels": [],
         "sales_channels": [
           "web",
           "pretixpos",
@@ -282,11 +270,8 @@ Endpoints
           "pretix.plugins.stripe",
           "pretix.plugins.paypal"
         ],
-        "sales_channels": [
-          "web",
-          "pretixpos",
-          "resellers"
-        ]
+        "all_sales_channels": true,
+        "limit_sales_channels": []
       }
 
    **Example response**:
@@ -322,6 +307,8 @@ Endpoints
           "pretix.plugins.stripe",
           "pretix.plugins.paypal"
         ],
+        "all_sales_channels": true,
+        "limit_sales_channels": [],
         "sales_channels": [
           "web",
           "pretixpos",
@@ -387,11 +374,8 @@ Endpoints
           "pretix.plugins.stripe",
           "pretix.plugins.paypal"
         ],
-        "sales_channels": [
-          "web",
-          "pretixpos",
-          "resellers"
-        ]
+        "all_sales_channels": true,
+        "limit_sales_channels": []
       }
 
    **Example response**:
@@ -427,6 +411,8 @@ Endpoints
           "pretix.plugins.stripe",
           "pretix.plugins.paypal"
         ],
+        "all_sales_channels": true,
+        "limit_sales_channels": [],
         "sales_channels": [
           "web",
           "pretixpos",
@@ -438,9 +424,9 @@ Endpoints
    :param organizer: The ``slug`` field of the organizer of the event to create.
    :param event: The ``slug`` field of the event to copy settings and items from.
    :statuscode 201: no error
-   :statuscode 400: The event could not be created due to invalid submitted data.
+   :statuscode 400: The event could not be updated due to invalid submitted data.
    :statuscode 401: Authentication failure
-   :statuscode 403: The requested organizer does not exist **or** you have no permission to create this resource.
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to update this resource.
 
 
 .. http:patch:: /api/v1/organizers/(organizer)/events/(event)/
@@ -502,6 +488,8 @@ Endpoints
           "pretix.plugins.paypal",
           "pretix.plugins.pretixdroid"
         ],
+        "all_sales_channels": true,
+        "limit_sales_channels": [],
         "sales_channels": [
           "web",
           "pretixpos",
@@ -623,10 +611,6 @@ organizer level.
    :statuscode 401: Authentication failure
    :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
 
-   .. versionchanged:: 4.18
-
-       The ``readonly`` flag has been added.
-
 .. http:patch:: /api/v1/organizers/(organizer)/events/(event)/settings/
 
    Updates event settings. Note that ``PUT`` is not allowed here, only ``PATCH``.

doc/api/resources/exhibitors.rst

@@ -1,6 +1,8 @@
 Exhibitors
 ==========
 
+.. note:: This API is only available when the plugin **pretix-exhibitors** is installed (pretix Hosted and Enterprise only).
+
 The exhibitors plugin allows to manage exhibitors at your trade show or conference. After signing up your exhibitors
 in the system, you can assign vouchers to exhibitors and give them access to the data of these vouchers. The exhibitors
 module is also the basis of the pretixLEAD lead scanning application.
@@ -347,6 +349,45 @@ Endpoints
    :statuscode 401: Authentication failure
    :statuscode 403: The requested organizer or event or exhibitor does not exist **or** you have no permission to view it.
 
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/exhibitors/(id)/vouchers/bulk_attach/
+
+   Attaches many **existing** vouchers to an exhibitor. You need to send either the ``id`` **or** the ``code`` field of
+   the voucher, but you need to send the same field for all entries.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/exhibitors/1/vouchers/bulk_attach/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+     [
+       {
+         "id": 15,
+         "exhibitor_comment": "Free ticket"
+       },
+       ..
+     ]
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {}
+
+   :param organizer: The ``slug`` field of a valid organizer
+   :param event: The ``slug`` field of the event to use
+   :param id: The ``id`` field of the exhibitor to use
+   :statuscode 200: no error
+   :statuscode 400: Invalid data sent, e.g. voucher does not exist
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer or event or exhibitor does not exist **or** you have no permission to view it.
+
 .. http:post:: /api/v1/organizers/(organizer)/events/(event)/exhibitors/
 
    Create a new exhibitor.

doc/api/resources/giftcards.rst

@@ -47,11 +47,6 @@ acceptor                              string                     Organizer slug
                                                                  this field was added.)
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 4.20
-
-    The ``owner_ticket`` and ``issuer`` attributes of the gift card and the ``info`` and ``acceptor`` attributes of the
-    gift card transaction resource have been added.
-
 Endpoints
 ---------
 
@@ -96,6 +91,8 @@ Endpoints
 
    :query integer page: The page number in case of a multi-page result set, default is 1
    :query string secret: Only show gift cards with the given secret.
+   :query string value: Only show gift cards with the given value.
+   :query boolean expired: Filter for gift cards that are (not) expired.
    :query boolean testmode: Filter for gift cards that are (not) in test mode.
    :query boolean include_accepted: Also show gift cards issued by other organizers that are accepted by this organizer.
    :query string expand: If you pass ``"owner_ticket"``, the respective field will be shown as a nested value instead of just an ID.

doc/api/resources/imported_secrets.rst

@@ -1,6 +1,8 @@
 Secrets Import
 ==============
 
+.. note:: This API is only available when the plugin **pretix-secrets-import** is installed (pretix Hosted and Enterprise only).
+
 Usually, pretix generates ticket secrets (i.e. the QR code used for scanning) itself. You can read more about this
 process at :ref:`secret_generators`.
 

doc/api/resources/index.rst

@@ -22,14 +22,17 @@ at :ref:`plugin-docs`.
    questions
    question_options
    quotas
+   seats
    orders
    invoices
+   transactions
    vouchers
    discounts
    checkin
    checkinlists
    waitinglist
    customers
+   saleschannels
    membershiptypes
    memberships
    giftcards
@@ -42,6 +45,17 @@ at :ref:`plugin-docs`.
    exporters
    scheduled_exports
    shredders
+   banktransfer
+   ticketoutputpdf
+   badges
    sendmail_rules
+   auto_checkin_rules
+   campaigns
+   certificates
+   digital
+   exhibitors
+   imported_secrets
+   offlinesales
+   shipping
    billing_invoices
-   billing_var
+   billing_var

doc/api/resources/invoices.rst

@@ -1,3 +1,5 @@
+.. _rest-invoices:
+
 Invoices
 ========
 
@@ -24,6 +26,8 @@ invoice_from_country                  string                     Sender address:
 invoice_from_tax_id                   string                     Sender address: Local Tax ID
 invoice_from_vat_id                   string                     Sender address: EU VAT ID
 invoice_to                            string                     Full recipient address
+invoice_to_is_business                boolean                    Recipient address: Business vs individual (``null`` for
+                                                                 invoices created before pretix 2025.6).
 invoice_to_company                    string                     Recipient address: Company name
 invoice_to_name                       string                     Recipient address: Person name
 invoice_to_street                     string                     Recipient address: Address lines
@@ -33,6 +37,7 @@ invoice_to_state                      string                     Recipient addre
 invoice_to_country                    string                     Recipient address: Country code
 invoice_to_vat_id                     string                     Recipient address: EU VAT ID
 invoice_to_beneficiary                string                     Invoice beneficiary
+invoice_to_transmission_info          object                     Additional transmission info (see :ref:`rest-transmission-types`)
 custom_field                          string                     Custom invoice address field
 date                                  date                       Invoice date
 refers                                string                     Invoice number of an invoice this invoice refers to
@@ -75,17 +80,12 @@ lines                                 list of objects            The actual invo
                                                                  for all invoice lines
                                                                  created before this field was introduced as well as for
                                                                  all lines not created by a fee (e.g. a product).
-├ event_date_from                     datetime                   Start date of the (sub)event this line was created for as it
-                                                                 was set during invoice creation. Can be ``null`` for all invoice
-                                                                 lines created before this was introduced as well as for lines in
-                                                                 an event series not created by a product (e.g. shipping or
-                                                                 cancellation fees).
-├ event_date_to                       datetime                   End date of the (sub)event this line was created for as it
-                                                                 was set during invoice creation. Can be ``null`` for all invoice
-                                                                 lines created before this was introduced as well as for lines in
-                                                                 an event series not created by a product (e.g. shipping or
-                                                                 cancellation fees) as well as whenever the respective (sub)event
-                                                                 has no end date set.
+├ period_start                        datetime                   Start date of the service or delivery period of the invoice line.
+                                                                 Can be ``null`` if not known.
+├ period_end                          datetime                   End date of the service or delivery period of the invoice line.
+                                                                 Can be ``null`` if not known.
+├ event_date_from                     datetime                   Deprecated alias of ``period_start``.
+├ event_date_to                       datetime                   Deprecated alias of ``period_end``.
 ├ event_location                      string                     Location of the (sub)event this line was created for as it
                                                                  was set during invoice creation. Can be ``null`` for all invoice
                                                                  lines created before this was introduced as well as for lines in
@@ -97,6 +97,7 @@ lines                                 list of objects            The actual invo
 ├ gross_value                         money (string)             Price including taxes
 ├ tax_value                           money (string)             Tax amount included
 ├ tax_name                            string                     Name of used tax rate (e.g. "VAT")
+├ tax_code                            string                     Codified reason for tax rate (or ``null``), see :ref:`rest-taxcodes`.
 └ tax_rate                            decimal (string)           Used tax rate
 foreign_currency_display              string                     If the invoice should also show the total and tax
                                                                  amount in a different currency, this contains the
@@ -107,25 +108,93 @@ foreign_currency_rate                 decimal (string)           If ``foreign_cu
 foreign_currency_rate_date            date                       If ``foreign_currency_rate`` is set, this signifies the
                                                                  date at which the currency rate was obtained.
 internal_reference                    string                     Customer's reference to be printed on the invoice.
+transmission_type                     string                     Requested transmission channel (see :ref:`rest-transmission-types`)
+transmission_provider                 string                     Selected transmission provider (depends on installed
+                                                                 plugins). ``null`` if not yet chosen.
+transmission_status                   string                     Transmission status, one of ``unknown`` (pre-2025.6),
+                                                                 ``pending``, ``inflight``, ``failed``, and ``completed``.
+transmission_date                     datetime                   Time of last change in transmission status (may be ``null``).
 ===================================== ========================== =======================================================
 
 
-.. versionchanged:: 4.1
-
-   The attributes ``fee_type`` and ``fee_internal_type`` have been added.
-
-.. versionchanged:: 4.1
-
-   The attribute ``lines.event_location`` has been added.
-
-.. versionchanged:: 4.6
-
-   The attribute ``lines.subevent`` has been added.
-
 .. versionchanged:: 2023.8
 
    The ``event`` attribute has been added. The organizer-level endpoint has been added.
 
+.. versionchanged:: 2024.8
+
+   The ``tax_code`` attribute has been added.
+
+.. versionchanged:: 2025.6
+
+   The attributes ``invoice_to_is_business``, ``invoice_to_transmission_info``, ``transmission_type``,
+   ``transmission_provider``, ``transmission_status``, and ``transmission_date`` have been added.
+
+
+.. _`rest-transmission-types`:
+
+Transmission types
+------------------
+
+pretix supports multiple ways to transmit an invoice from the organizer to the invoice recipient.
+For each transmission type, different fields are supported in the ``transmission_info`` object of the
+invoice address. Currently, pretix supports the following transmission types:
+
+Email
+"""""
+
+The identifier ``"email"`` represents the transmission of PDF invoices through email.
+This is the default transmission type in pretix and has some special behavior for backwards compatibility.
+Transmission is always executed through the provider ``"email_pdf"``.
+The ``transmission_info`` object may contain the following properties:
+
+.. rst-class:: rest-resource-table
+
+===================================== ========================== =======================================================
+Field                                 Type                       Description
+===================================== ========================== =======================================================
+transmission_email_address            string                     Optional. An email address other than the order address
+                                                                 that the invoice should be sent to.
+                                                                 Business customers only.
+===================================== ========================== =======================================================
+
+Peppol
+""""""
+
+The identifier ``"peppol"`` represents the transmission of XML invoices through the `Peppol`_ network.
+This is only available for business addresses.
+This is not supported by pretix out of the box and requires the use of a suitable plugin.
+The ``transmission_info`` object may contain the following properties:
+
+.. rst-class:: rest-resource-table
+
+===================================== ========================== =======================================================
+Field                                 Type                       Description
+===================================== ========================== =======================================================
+transmission_peppol_participant_id    string                     Required. The Peppol participant ID of the recipient.
+===================================== ========================== =======================================================
+
+Italian Exchange System
+"""""""""""""""""""""""
+
+The identifier ``"it_sdi"`` represents the transmission of XML invoices through the `Sistema di Interscambio`_ network used in Italy.
+This is only available for addresses with country ``"IT"``.
+This is not supported by pretix out of the box and requires the use of a suitable plugin.
+The ``transmission_info`` object may contain the following properties:
+
+.. rst-class:: rest-resource-table
+
+===================================== ========================== =======================================================
+Field                                 Type                       Description
+===================================== ========================== =======================================================
+transmission_it_sdi_codice_fiscale    string                     Required for non-business address. Fiscal code of the
+                                                                 recipient.
+transmission_it_sdi_pec               string                     Required for business addresses. Address for certified
+                                                                 electronic mail.
+transmission_it_sdi_recipient_code    string                     Required for businesses. SdI recipient code.
+===================================== ========================== =======================================================
+
+If this type is selected, ``vat_id`` is required for business addresses.
 
 List of all invoices
 --------------------
@@ -169,6 +238,7 @@ List of all invoices
             "invoice_from_vat_id":"",
             "invoice_to": "Sample company\nJohn Doe\nTest street 12\n12345 Testington\nTestikistan\nVAT-ID: EU123456789",
             "invoice_to_company": "Sample company",
+            "invoice_to_is_business": true,
             "invoice_to_name": "John Doe",
             "invoice_to_street": "Test street 12",
             "invoice_to_zipcode": "12345",
@@ -177,6 +247,7 @@ List of all invoices
             "invoice_to_country": "TE",
             "invoice_to_vat_id": "EU123456789",
             "invoice_to_beneficiary": "",
+            "invoice_to_transmission_info": {},
             "custom_field": null,
             "date": "2017-12-01",
             "refers": null,
@@ -198,17 +269,24 @@ List of all invoices
                 "fee_internal_type": null,
                 "event_date_from": "2017-12-27T10:00:00Z",
                 "event_date_to": null,
+                "period_start": "2017-12-27T10:00:00Z",
+                "period_end": "2017-12-27T10:00:00Z",
                 "event_location": "Heidelberg",
                 "attendee_name": null,
                 "gross_value": "23.00",
                 "tax_value": "0.00",
                 "tax_name": "VAT",
+                "tax_code": "S/standard",
                 "tax_rate": "0.00"
               }
             ],
             "foreign_currency_display": "PLN",
             "foreign_currency_rate": "4.2408",
-            "foreign_currency_rate_date": "2017-07-24"
+            "foreign_currency_rate_date": "2017-07-24",
+            "transmission_type": "email",
+            "transmission_provider": "email_pdf",
+            "transmission_status": "completed",
+            "transmission_date": "2017-07-24T10:00:00Z"
           }
         ]
       }
@@ -217,6 +295,9 @@ List of all invoices
    :query boolean is_cancellation: If set to ``true`` or ``false``, only invoices with this value for the field
                                    ``is_cancellation`` will be returned.
    :query string order: If set, only invoices belonging to the order with the given order code will be returned.
+                        This parameter may be given multiple times. In this case, all invoices matching one of the inputs will be returned.
+   :query string number: If set, only invoices with the given invoice number will be returned.
+                        This parameter may be given multiple times. In this case, all invoices matching one of the inputs will be returned.
    :query string refers: If set, only invoices referring to the given invoice will be returned.
    :query string locale: If set, only invoices with the given locale will be returned.
    :query string ordering: Manually set the ordering of results. Valid fields to be used are ``date`` and
@@ -305,6 +386,7 @@ Fetching individual invoices
         "invoice_from_vat_id":"",
         "invoice_to": "Sample company\nJohn Doe\nTest street 12\n12345 Testington\nTestikistan\nVAT-ID: EU123456789",
         "invoice_to_company": "Sample company",
+        "invoice_to_is_business": true,
         "invoice_to_name": "John Doe",
         "invoice_to_street": "Test street 12",
         "invoice_to_zipcode": "12345",
@@ -313,6 +395,7 @@ Fetching individual invoices
         "invoice_to_country": "TE",
         "invoice_to_vat_id": "EU123456789",
         "invoice_to_beneficiary": "",
+        "invoice_to_transmission_info": {},
         "custom_field": null,
         "date": "2017-12-01",
         "refers": null,
@@ -334,27 +417,34 @@ Fetching individual invoices
             "fee_internal_type": null,
             "event_date_from": "2017-12-27T10:00:00Z",
             "event_date_to": null,
+            "period_start": "2017-12-27T10:00:00Z",
+            "period_end": "2017-12-27T10:00:00Z",
             "event_location": "Heidelberg",
             "attendee_name": null,
             "gross_value": "23.00",
             "tax_value": "0.00",
             "tax_name": "VAT",
+            "tax_code": "S/standard",
             "tax_rate": "0.00"
           }
         ],
         "foreign_currency_display": "PLN",
         "foreign_currency_rate": "4.2408",
-        "foreign_currency_rate_date": "2017-07-24"
+        "foreign_currency_rate_date": "2017-07-24",
+        "transmission_type": "email",
+        "transmission_provider": "email_pdf",
+        "transmission_status": "completed",
+        "transmission_date": "2017-07-24T10:00:00Z"
       }
 
    :param organizer: The ``slug`` field of the organizer to fetch
    :param event: The ``slug`` field of the event to fetch
-   :param invoice_no: The ``invoice_no`` field of the invoice to fetch
+   :param number: The ``number`` field of the invoice to fetch
    :statuscode 200: no error
    :statuscode 401: Authentication failure
    :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
 
-.. http:get:: /api/v1/organizers/(organizer)/events/(event)/invoices/(invoice_no)/download/
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/invoices/(number)/download/
 
    Download an invoice in PDF format.
 
@@ -381,7 +471,7 @@ Fetching individual invoices
 
    :param organizer: The ``slug`` field of the organizer to fetch
    :param event: The ``slug`` field of the event to fetch
-   :param invoice_no: The ``invoice_no`` field of the invoice to fetch
+   :param number: The ``number`` field of the invoice to fetch
    :statuscode 200: no error
    :statuscode 401: Authentication failure
    :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
@@ -394,7 +484,7 @@ Modifying invoices
 
 Invoices cannot be edited directly, but the following actions can be triggered:
 
-.. http:post:: /api/v1/organizers/(organizer)/events/(event)/invoices/(invoice_no)/reissue/
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/invoices/(number)/reissue/
 
    Cancels the invoice and creates a new one.
 
@@ -416,13 +506,13 @@ Invoices cannot be edited directly, but the following actions can be triggered:
 
    :param organizer: The ``slug`` field of the organizer to fetch
    :param event: The ``slug`` field of the event to fetch
-   :param invoice_no: The ``invoice_no`` field of the invoice to reissue
+   :param number: The ``number`` field of the invoice to reissue
    :statuscode 200: no error
    :statuscode 400: The invoice has already been canceled
    :statuscode 401: Authentication failure
    :statuscode 403: The requested organizer/event does not exist **or** you have no permission to change this resource.
 
-.. http:post:: /api/v1/organizers/(organizer)/events/(event)/invoices/(invoice_no)/regenerate/
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/invoices/(number)/regenerate/
 
    Re-generates the invoice from order data.
 
@@ -444,8 +534,75 @@ Invoices cannot be edited directly, but the following actions can be triggered:
 
    :param organizer: The ``slug`` field of the organizer to fetch
    :param event: The ``slug`` field of the event to fetch
-   :param invoice_no: The ``invoice_no`` field of the invoice to regenerate
+   :param number: The ``number`` field of the invoice to regenerate
    :statuscode 200: no error
    :statuscode 400: The invoice has already been canceled
    :statuscode 401: Authentication failure
    :statuscode 403: The requested organizer/event does not exist **or** you have no permission to change this resource.
+
+
+Transmitting invoices
+---------------------
+
+Invoices are transmitted automatically when created during order creation or payment receipt,
+but in other cases transmission may need to be triggered manually.
+
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/invoices/(number)/transmit/
+
+   Transmits the invoice to the recipient, but only if it is in ``pending`` state.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/invoices/00001/transmit/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 204 No Content
+      Vary: Accept
+      Content-Type: application/pdf
+
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :param event: The ``slug`` field of the event to fetch
+   :param number: The ``number`` field of the invoice to transmit
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to transmit this invoice **or** the invoice may not be transmitted
+   :statuscode 409: The invoice is currently in transmission
+
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/invoices/(number)/retransmit/
+
+   Transmits the invoice to the recipient even if transmission was already attempted previously.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/invoices/00001/retransmit/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 204 No Content
+      Vary: Accept
+      Content-Type: application/pdf
+
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :param event: The ``slug`` field of the event to fetch
+   :param number: The ``number`` field of the invoice to transmit
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to transmit this invoice **or** the invoice may not be transmitted
+   :statuscode 409: The invoice is currently in transmission
+
+
+.. _Peppol: https://en.wikipedia.org/wiki/PEPPOL
+.. _Sistema di Interscambio: https://it.wikipedia.org/wiki/Fattura_elettronica_in_Italia

doc/api/resources/item_variations.rst

@@ -38,11 +38,14 @@ require_membership                    boolean                    If ``true``, bo
 require_membership_hidden             boolean                    If ``true`` and ``require_membership`` is set, this variation will
                                                                  be hidden from users without a valid membership.
 require_membership_types              list of integers           Internal IDs of membership types valid if ``require_membership`` is ``true``
-sales_channels                        list of strings            Sales channels this variation is available on, such as
-                                                                 ``"web"`` or ``"resellers"``. Defaults to all existing sales channels.
+all_sales_channels                    boolean                    If ``true`` (default), the variation is available on all sales channels.
+limit_sales_channels                  list of strings            List of sales channel identifiers the variation is available on
+                                                                 if ``all_sales_channels`` is ``false``.
                                                                  The item-level list takes precedence, i.e. a sales
-                                                                 channel needs to be on both lists for the item to be
-                                                                 available.
+                                                                 channel needs to be on both lists for the variation to be
+                                                                 available (unless ``all_sales_channels`` is used).
+sales_channels                        list of strings            **DEPRECATED.** Legacy interface, use ``all_sales_channels``
+                                                                 and ``limit_sales_channels`` instead.
 available_from                        datetime                   The first date time at which this variation can be bought
                                                                  (or ``null``).
 available_from_mode                   string                     If ``hide`` (the default), this variation is hidden in the shop
@@ -61,10 +64,6 @@ hide_without_voucher                  boolean                    If ``true``, th
 meta_data                             object                     Values set for event-specific meta data parameters.
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 4.16
-
-   The ``meta_data`` and ``checkin_attention`` attributes have been added.
-
 .. versionchanged:: 2023.10
 
    The ``free_price_suggestion`` attribute has been added.
@@ -111,6 +110,8 @@ Endpoints
             "require_membership": false,
             "require_membership_hidden": false,
             "require_membership_types": [],
+            "all_sales_channels": false,
+            "limit_sales_channels": ["web"],
             "sales_channels": ["web"],
             "available_from": null,
             "available_from_mode": "hide",
@@ -139,6 +140,8 @@ Endpoints
             "require_membership": false,
             "require_membership_hidden": false,
             "require_membership_types": [],
+            "all_sales_channels": false,
+            "limit_sales_channels": ["web"],
             "sales_channels": ["web"],
             "available_from": null,
             "available_from_mode": "hide",
@@ -157,6 +160,7 @@ Endpoints
       }
 
    :query integer page: The page number in case of a multi-page result set, default is 1
+   :query string search: Filter the list by the value of the variation (substring search).
    :query boolean active: If set to ``true`` or ``false``, only items with this value for the field ``active`` will be
                           returned.
    :param organizer: The ``slug`` field of the organizer to fetch
@@ -202,6 +206,8 @@ Endpoints
         "require_membership": false,
         "require_membership_hidden": false,
         "require_membership_types": [],
+        "all_sales_channels": false,
+        "limit_sales_channels": ["web"],
         "sales_channels": ["web"],
         "available_from": null,
         "available_from_mode": "hide",
@@ -244,7 +250,8 @@ Endpoints
         "require_membership": false,
         "require_membership_hidden": false,
         "require_membership_types": [],
-        "sales_channels": ["web"],
+        "all_sales_channels": false,
+        "limit_sales_channels": ["web"],
         "available_from": null,
         "available_from_mode": "hide",
         "available_until": null,
@@ -277,6 +284,8 @@ Endpoints
         "require_membership": false,
         "require_membership_hidden": false,
         "require_membership_types": [],
+        "all_sales_channels": false,
+        "limit_sales_channels": ["web"],
         "sales_channels": ["web"],
         "available_from": null,
         "available_from_mode": "hide",
@@ -341,6 +350,8 @@ Endpoints
         "require_membership": false,
         "require_membership_hidden": false,
         "require_membership_types": [],
+        "all_sales_channels": false,
+        "limit_sales_channels": ["web"],
         "sales_channels": ["web"],
         "available_from": null,
         "available_from_mode": "hide",

doc/api/resources/items.rst

@@ -46,8 +46,11 @@ personalized                            boolean                    ``true`` for
 position                                integer                    An integer, used for sorting
 picture                                 file                       A product picture to be displayed in the shop
                                                                    (can be ``null``).
-sales_channels                          list of strings            Sales channels this product is available on, such as
-                                                                   ``"web"`` or ``"resellers"``. Defaults to ``["web"]``.
+all_sales_channels                      boolean                    If ``true`` (default), the item is available on all sales channels.
+limit_sales_channels                    list of strings            List of sales channel identifiers the item is available on
+                                                                   if ``all_sales_channels`` is ``false``.
+sales_channels                          list of strings            **DEPRECATED.** Legacy interface, use ``all_sales_channels``
+                                                                   and ``limit_sales_channels`` instead.
 available_from                          datetime                   The first date time at which this item can be bought
                                                                    (or ``null``).
 available_from_mode                     string                     If ``hide`` (the default), this item is hidden in the shop
@@ -66,6 +69,10 @@ hidden_if_available                     integer                    **DEPRECATED*
 hidden_if_item_available                integer                    The internal ID of a different item, or ``null``. If
                                                                    set, this item won't be shown publicly as long as this
                                                                    other item is available.
+hidden_if_item_available_mode           string                     If ``hide`` (the default), this item is hidden in the shop
+                                                                   if unavailable due to the ``hidden_if_item_available`` setting.
+                                                                   If ``info``, the item is visible, but can't be purchased,
+                                                                   and a note explaining the unavailability is displayed.
 require_voucher                         boolean                    If ``true``, this item can only be bought using a
                                                                    voucher that is specifically assigned to this item.
 hide_without_voucher                    boolean                    If ``true``, this item is only shown during the voucher
@@ -157,11 +164,14 @@ variations                              list of objects            A list with o
                                                                    be hidden from users without a valid membership.
 ├ require_membership_types              list of integers           Internal IDs of membership types valid if ``require_membership`` is ``true``
                                                                    Markdown syntax or can be ``null``.
-├ sales_channels                        list of strings            Sales channels this variation is available on, such as
-                                                                   ``"web"`` or ``"resellers"``. Defaults to all existing sales channels.
+├ all_sales_channels                    boolean                    If ``true`` (default), the variation is available on all sales channels.
+├ limit_sales_channels                  list of strings            List of sales channel identifiers the variation is available on
+                                                                   if ``all_sales_channels`` is ``false``.
                                                                    The item-level list takes precedence, i.e. a sales
-                                                                   channel needs to be on both lists for the item to be
-                                                                   available.
+                                                                   channel needs to be on both lists for the variation to be
+                                                                   available (unless ``all_sales_channels`` is used).
+├ sales_channels                        list of strings            **DEPRECATED.** Legacy interface, use ``all_sales_channels``
+                                                                   and ``limit_sales_channels`` instead.
 ├ available_from                        datetime                   The first date time at which this variation can be bought
                                                                    (or ``null``).
 ├ available_from_mode                   string                     If ``hide`` (the default), this variation is hidden in the shop
@@ -201,28 +211,6 @@ bundles                                 list of objects            Definition of
 meta_data                               object                     Values set for event-specific meta data parameters.
 ======================================= ========================== =======================================================
 
-.. versionchanged:: 4.0
-
-   The attributes ``require_membership``, ``require_membership_types``, ``grant_membership_type``, ``grant_membership_duration_like_event``,
-    ``grant_membership_duration_days`` and ``grant_membership_duration_months`` have been added.
-
-.. versionchanged:: 4.4
-
-   The attributes ``require_membership_hidden`` attribute has been added.
-
-.. versionchanged:: 4.16
-
-   The ``variations[x].meta_data`` and ``variations[x].checkin_attention`` attributes have been added.
-   The ``personalized`` attribute has been added.
-
-.. versionchanged:: 4.17
-
-   The ``validity_*`` attributes have been added.
-
-.. versionchanged:: 4.18
-
-   The ``media_policy`` and ``media_type`` attributes have been added.
-
 .. versionchanged:: 2023.10
 
    The ``checkin_text`` and ``variations[x].checkin_text`` attributes have been added.
@@ -233,6 +221,10 @@ meta_data                               object                     Values set fo
    The ``hidden_if_item_available`` attributes has been added, the ``hidden_if_available`` attribute has been
    deprecated.
 
+.. versionchanged:: 2025.01
+
+   The ``hidden_if_item_available_mode`` attributes has been added.
+
 Notes
 -----
 
@@ -276,6 +268,8 @@ Endpoints
             "id": 1,
             "name": {"en": "Standard ticket"},
             "internal_name": "",
+            "all_sales_channels": false,
+            "limit_sales_channels": ["web"],
             "sales_channels": ["web"],
             "default_price": "23.00",
             "original_price": null,
@@ -300,6 +294,7 @@ Endpoints
             "available_until_mode": "hide",
             "hidden_if_available": null,
             "hidden_if_item_available": null,
+            "hidden_if_item_available_mode": "hide",
             "require_voucher": false,
             "hide_without_voucher": false,
             "allow_cancel": true,
@@ -340,6 +335,8 @@ Endpoints
                  "require_approval": false,
                  "require_membership": false,
                  "require_membership_types": [],
+                 "all_sales_channels": false,
+                 "limit_sales_channels": ["web"],
                  "sales_channels": ["web"],
                  "available_from": null,
                  "available_from_mode": "hide",
@@ -362,6 +359,8 @@ Endpoints
                  "require_approval": false,
                  "require_membership": false,
                  "require_membership_types": [],
+                 "all_sales_channels": false,
+                 "limit_sales_channels": ["web"],
                  "sales_channels": ["web"],
                  "available_from": null,
                  "available_from_mode": "hide",
@@ -380,6 +379,7 @@ Endpoints
       }
 
    :query integer page: The page number in case of a multi-page result set, default is 1
+   :query string search: Filter the list by internal name or name of the item (substring search).
    :query boolean active: If set to ``true`` or ``false``, only items with this value for the field ``active`` will be
                           returned.
    :query integer category: If set to the ID of a category, only items within that category will be returned.
@@ -420,6 +420,8 @@ Endpoints
         "id": 1,
         "name": {"en": "Standard ticket"},
         "internal_name": "",
+        "all_sales_channels": false,
+        "limit_sales_channels": ["web"],
         "sales_channels": ["web"],
         "default_price": "23.00",
         "original_price": null,
@@ -444,6 +446,7 @@ Endpoints
         "available_until_mode": "hide",
         "hidden_if_available": null,
         "hidden_if_item_available": null,
+        "hidden_if_item_available_mode": "hide",
         "require_voucher": false,
         "hide_without_voucher": false,
         "allow_cancel": true,
@@ -485,6 +488,8 @@ Endpoints
              "require_membership": false,
              "require_membership_types": [],
              "description": null,
+             "all_sales_channels": false,
+             "limit_sales_channels": ["web"],
              "sales_channels": ["web"],
              "available_from": null,
              "available_from_mode": "hide",
@@ -506,6 +511,8 @@ Endpoints
              "require_approval": false,
              "require_membership": false,
              "require_membership_types": [],
+             "all_sales_channels": false,
+             "limit_sales_channels": ["web"],
              "sales_channels": ["web"],
              "available_from": null,
              "available_from_mode": "hide",
@@ -545,7 +552,8 @@ Endpoints
         "id": 1,
         "name": {"en": "Standard ticket"},
         "internal_name": "",
-        "sales_channels": ["web"],
+        "all_sales_channels": false,
+        "limit_sales_channels": ["web"],
         "default_price": "23.00",
         "original_price": null,
         "category": null,
@@ -569,6 +577,7 @@ Endpoints
         "available_until_mode": "hide",
         "hidden_if_available": null,
         "hidden_if_item_available": null,
+        "hidden_if_item_available_mode": "hide",
         "require_voucher": false,
         "hide_without_voucher": false,
         "allow_cancel": true,
@@ -608,7 +617,8 @@ Endpoints
              "require_approval": false,
              "require_membership": false,
              "require_membership_types": [],
-             "sales_channels": ["web"],
+             "all_sales_channels": false,
+             "limit_sales_channels": ["web"],
              "available_from": null,
              "available_from_mode": "hide",
              "available_until": null,
@@ -630,7 +640,8 @@ Endpoints
              "require_approval": false,
              "require_membership": false,
              "require_membership_types": [],
-             "sales_channels": ["web"],
+             "all_sales_channels": false,
+             "limit_sales_channels": ["web"],
              "available_from": null,
              "available_from_mode": "hide",
              "available_until": null,
@@ -657,6 +668,8 @@ Endpoints
         "id": 1,
         "name": {"en": "Standard ticket"},
         "internal_name": "",
+        "all_sales_channels": false,
+        "limit_sales_channels": ["web"],
         "sales_channels": ["web"],
         "default_price": "23.00",
         "original_price": null,
@@ -681,6 +694,7 @@ Endpoints
         "available_until_mode": "hide",
         "hidden_if_available": null,
         "hidden_if_item_available": null,
+        "hidden_if_item_available_mode": "hide",
         "require_voucher": false,
         "hide_without_voucher": false,
         "allow_cancel": true,
@@ -721,6 +735,8 @@ Endpoints
              "require_approval": false,
              "require_membership": false,
              "require_membership_types": [],
+             "all_sales_channels": false,
+             "limit_sales_channels": ["web"],
              "sales_channels": ["web"],
              "available_from": null,
              "available_from_mode": "hide",
@@ -743,6 +759,8 @@ Endpoints
              "require_approval": false,
              "require_membership": false,
              "require_membership_types": [],
+             "all_sales_channels": false,
+             "limit_sales_channels": ["web"],
              "sales_channels": ["web"],
              "available_from": null,
              "available_from_mode": "hide",
@@ -801,6 +819,8 @@ Endpoints
         "id": 1,
         "name": {"en": "Ticket"},
         "internal_name": "",
+        "all_sales_channels": false,
+        "limit_sales_channels": ["web"],
         "sales_channels": ["web"],
         "default_price": "25.00",
         "original_price": null,
@@ -825,6 +845,7 @@ Endpoints
         "available_until_mode": "hide",
         "hidden_if_available": null,
         "hidden_if_item_available": null,
+        "hidden_if_item_available_mode": "hide",
         "require_voucher": false,
         "hide_without_voucher": false,
         "generate_tickets": null,
@@ -865,6 +886,8 @@ Endpoints
              "require_approval": false,
              "require_membership": false,
              "require_membership_types": [],
+             "all_sales_channels": false,
+             "limit_sales_channels": ["web"],
              "sales_channels": ["web"],
              "available_from": null,
              "available_from_mode": "hide",
@@ -887,6 +910,8 @@ Endpoints
              "require_approval": false,
              "require_membership": false,
              "require_membership_types": [],
+             "all_sales_channels": false,
+             "limit_sales_channels": ["web"],
              "sales_channels": ["web"],
              "available_from": null,
              "available_from_mode": "hide",

doc/api/resources/offlinesales.rst

@@ -0,0 +1,219 @@
+Offline sales
+=============
+
+.. note:: This API is only available when the plugin **pretix-offlinesales** is installed (pretix Hosted and Enterprise only).
+
+The offline sales module allows you to create batches of tickets intended for the sale outside the system.
+
+Resource description
+--------------------
+
+The offline sales batch resource contains the following public fields:
+
+.. rst-class:: rest-resource-table
+
+===================================== ========================== =======================================================
+Field                                 Type                       Description
+===================================== ========================== =======================================================
+id                                    integer                    Internal batch ID
+creation                              datetime                   Time of creation
+testmode                              boolean                    ``true`` if orders are created in test mode
+sales_channel                         string                     Sales channel of the orders
+layout                                integer                    Internal ID of the chosen ticket layout
+subevent                              integer                    Internal ID of the chosen subevent (or ``null``)
+item                                  integer                    Internal ID of the chosen product
+variation                             integer                    Internal ID of the chosen variation (or ``null``)
+amount                                integer                    Number of tickets in the batch
+comment                               string                     Internal comment
+orders                                list of strings            List of order codes (omitted in list view for performance reasons)
+===================================== ========================== =======================================================
+
+Endpoints
+---------
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/offlinesalesbatches/
+
+   Returns a list of all offline sales batches
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/democon/offlinesalesbatches/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: text/javascript
+
+      {
+        "count": 1,
+        "next": null,
+        "previous": null,
+        "results": [
+          {
+            "id": 1,
+            "creation": "2025-07-08T18:27:32.134368+02:00",
+            "testmode": False,
+            "sales_channel": "web",
+            "comment": "Batch for sale at the event",
+            "layout": 3,
+            "subevent": null,
+            "item": 23,
+            "variation": null,
+            "amount": 7
+          }
+        ]
+      }
+
+   :query page: The page number in case of a multi-page result set, default is 1
+   :param organizer: The ``slug`` field of a valid organizer
+   :param event: The ``slug`` field of a valid event
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to view it.
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/offlinesalesbatches/(id)/
+
+   Returns information on a given batch.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/democon/offlinesalesbatches/1/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: text/javascript
+
+      {
+        "id": 1,
+        "creation": "2025-07-08T18:27:32.134368+02:00",
+        "testmode": False,
+        "sales_channel": "web",
+        "comment": "Batch for sale at the event",
+        "layout": 3,
+        "subevent": null,
+        "item": 23,
+        "variation": null,
+        "amount": 7,
+        "orders": ["TSRNN", "3FBSL", "WMDNJ", "BHW9H", "MXSUG", "DSDAP", "URLLE"]
+      }
+
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :param event: The ``slug`` field of the event to fetch
+   :param id: The ``id`` field of the batch to fetch
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view it.
+
+
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/offlinesalesbatches/
+
+   With this API call, you can instruct the system to create a new batch.
+
+   Since batches can contain up to 10,000 tickets, they are created asynchronously on the server.
+   If your input parameters validate correctly, a ``202 Accepted`` status code is returned.
+   The body points you to the check URL of the result. Running a ``GET`` request on that result URL will
+   yield one of the following status codes:
+
+    * ``200 OK`` – The creation of the batch has succeeded. The body will be your resulting batch with the same information as in the detail endpoint above.
+    * ``409 Conflict`` – Your creation job is still running. The body will be JSON with the structure ``{"status": "running"}``. ``status`` can be ``waiting`` before the task is actually being processed. Please retry, but wait at least one second before you do.
+    * ``410 Gone`` – Creating the batch has failed permanently (e.g. quota no longer available). The body will be JSON with the structure ``{"status": "failed", "message": "Error message"}``
+    * ``404 Not Found`` – The job does not exist / is expired.
+
+   .. note:: To avoid performance issues, a maximum amount of 10000 is currently allowed.
+
+   .. note:: Do not wait multiple hours or more to retrieve your result. After a longer wait time, ``409`` might be returned permanently due to technical constraints, even though nothing will happen any more.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/offlinesalesbatches/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+
+      {
+        "testmode": True,
+        "layout": 123,
+        "item": 14,
+        "sales_channel": "web",
+        "amount": 10,
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "check": "https://pretix.eu/api/v1/organizers/bigevents/events/sampleconf/offlinesalesbatches/check/29891ede-196f-4942-9e26-d055a36e98b8/"
+      }
+
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :param event: The ``slug`` field of the event to fetch
+   :statuscode 202: no error
+   :statuscode 400: Invalid input options
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
+
+
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/offlinesalesbatches/(id)/render/
+
+   With this API call, you can render the PDF representation of a batch.
+
+   Since batches can contain up to 10,000 tickets, they are rendered asynchronously on the server.
+   If your input parameters validate correctly, a ``202 Accepted`` status code is returned.
+   The body points you to the download URL of the result. Running a ``GET`` request on that result URL will
+   yield one of the following status codes:
+
+    * ``200 OK`` – The creation of the batch has succeeded. The body will be your resulting batch with the same information as in the detail endpoint above.
+    * ``409 Conflict`` – Your rendering process is still running. The body will be JSON with the structure ``{"status": "running"}``. ``status`` can be ``waiting`` before the task is actually being processed. Please retry, but wait at least one second before you do.
+    * ``410 Gone`` – Rendering the batch has failed permanently. The body will be JSON with the structure ``{"status": "failed", "message": "Error message"}``
+    * ``404 Not Found`` – The rendering job does not exist / is expired.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/offlinesalesbatches/1/render HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "download": "https://pretix.eu/api/v1/organizers/bigevents/events/sampleconf/offlinesalesbatches/1/download/29891ede-196f-4942-9e26-d055a36e98b8/3f279f13-c198-4137-b49b-9b360ce9fcce/"
+      }
+
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :param event: The ``slug`` field of the event to fetch
+   :param id: The ``id`` field of the batch to fetch
+   :statuscode 202: no error
+   :statuscode 400: Invalid input options
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
+

doc/api/resources/orders.rst

@@ -42,6 +42,8 @@ payment_date                          date                       **DEPRECATED AN
 payment_provider                      string                     **DEPRECATED AND INACCURATE** Payment provider used for this order
 total                                 money (string)             Total value of this order
 comment                               string                     Internal comment on this order
+api_meta                              object                     Meta data for that order. Only available through API, no guarantees
+                                                                 on the content structure. You can use this to save references to your system.
 custom_followup_at                    date                       Internal date for a custom follow-up action
 checkin_attention                     boolean                    If ``true``, the check-in app should show a warning
                                                                  that this ticket requires special attention if a ticket
@@ -63,18 +65,24 @@ invoice_address                       object                     Invoice address
 ├ state                               string                     Customer state (ISO 3166-2 code). Only supported in
                                                                  AU, BR, CA, CN, MY, MX, and US.
 ├ internal_reference                  string                     Customer's internal reference to be printed on the invoice
+
 ├ custom_field                        string                     Custom invoice address field
 ├ vat_id                              string                     Customer VAT ID
-└ vat_id_validated                    string                     ``true``, if the VAT ID has been validated against the
+├ vat_id_validated                    string                     ``true``, if the VAT ID has been validated against the
                                                                  EU VAT service and validation was successful. This only
                                                                  happens in rare cases.
+├ transmission_type                   string                     Transmission channel for invoice (see also :ref:`rest-transmission-types`).
+                                                                 Defaults to ``email``.
+└ transmission_info                   object                     Transmission-channel specific information (or ``null``).
+                                                                 See also :ref:`rest-transmission-types`.
 positions                             list of objects            List of order positions (see below). By default, only
                                                                  non-canceled positions are included.
 fees                                  list of objects            List of fees included in the order total. By default, only
                                                                  non-canceled fees are included.
 ├ id                                  integer                    Internal ID of the fee record
-├ fee_type                            string                     Type of fee (currently ``payment``, ``passbook``,
-                                                                 ``other``)
+├ fee_type                            string                     Type of fee (currently ``payment``, ``shipping``,
+                                                                 ``service``, ``cancellation``, ``insurance``, ``late``,
+                                                                 ``other``, ``giftcard``)
 ├ value                               money (string)             Fee amount
 ├ description                         string                     Human-readable string with more details (can be empty)
 ├ internal_type                       string                     Internal string (i.e. ID of the payment provider),
@@ -82,6 +90,7 @@ fees                                  list of objects            List of fees in
 ├ tax_rate                            decimal (string)           VAT rate applied for this fee
 ├ tax_value                           money (string)             VAT included in this fee
 ├ tax_rule                            integer                    The ID of the used tax rule (or ``null``)
+├ tax_code                            string                     Codified reason for tax rate (or ``null``), see :ref:`rest-taxcodes`.
 └ canceled                            boolean                    Whether or not this fee has been canceled.
 downloads                             list of objects            List of ticket download options for order-wise ticket
                                                                  downloading. This might be a multi-page PDF or a ZIP
@@ -102,37 +111,14 @@ url                                   string                     The full URL to
 payments                              list of objects            List of payment processes (see below)
 refunds                               list of objects            List of refund processes (see below)
 last_modified                         datetime                   Last modification of this object
+cancellation_date                     datetime                   Time of order cancellation (or ``null``). **Note**:
+                                                                 Will not be set for partial cancellations and is not
+                                                                 reliable for orders that have been cancelled,
+                                                                 reactivated and cancelled again.
+plugin_data                           object                     Additional data added by plugins.
 ===================================== ========================== =======================================================
 
 
-.. versionchanged:: 4.0
-
-   The ``customer`` attribute has been added.
-
-.. versionchanged:: 4.1
-
-   The ``custom_followup_at`` attribute has been added.
-
-.. versionchanged:: 4.4
-
-   The ``item`` and ``variation`` query parameters have been added.
-
-.. versionchanged:: 4.6
-
-   The ``subevent`` query parameters has been added.
-
-.. versionchanged:: 4.8
-
-   The ``order.fees.id`` attribute has been added.
-
-.. versionchanged:: 4.15
-
-   The ``include`` query parameter has been added.
-
-.. versionchanged:: 4.16
-
-   The ``valid_if_pending`` attribute has been added.
-
 .. versionchanged:: 2023.8
 
    The ``event`` attribute has been added. The organizer-level endpoint has been added.
@@ -149,6 +135,21 @@ last_modified                         datetime                   Last modificati
 
    The ``expires`` attribute can now be passed during order creation.
 
+.. versionchanged:: 2024.11
+
+   The ``cancellation_date`` attribute has been added and can also be used as an ordering key.
+
+.. versionchanged:: 2025.1
+
+   The ``tax_code`` attribute has been added.
+
+.. versionchanged:: 2025.2
+
+   The ``plugin_data`` attribute has been added.
+
+.. versionchanged:: 2025.6
+
+   The ``invoice_address.transmission_type`` and ``invoice_address.transmission_info`` attributes have been added.
 
 .. _order-position-resource:
 
@@ -186,6 +187,7 @@ voucher_budget_use                    money (string)             Amount of money
                                                                  are changed *after* the order was created. Can be ``null``.
 tax_rate                              decimal (string)           VAT rate applied for this position
 tax_value                             money (string)             VAT included in this position
+tax_code                              string                     Codified reason for tax rate (or ``null``), see :ref:`rest-taxcodes`.
 tax_rule                              integer                    The ID of the used tax rule (or ``null``)
 secret                                string                     Secret code printed on the tickets for validation
 addon_to                              integer                    Internal ID of the position this position is an add-on for (or ``null``)
@@ -201,8 +203,20 @@ checkins                              list of objects            List of **succe
 ├ datetime                            datetime                   Time of check-in
 ├ type                                string                     Type of scan (defaults to ``entry``)
 ├ gate                                integer                    Internal ID of the gate. Can be ``null``.
-├ device                              integer                    Internal ID of the device. Can be ``null``.
+├ device                              integer                    Internal ID of the device. Can be ``null``. **Deprecated**, since this ID is not otherwise used in the API and is therefore not very useful.
+├ device_id                           integer                    Attribute ``device_id`` of the device. Can be ``null``.
 └ auto_checked_in                     boolean                    Indicates if this check-in been performed automatically by the system
+print_logs                            list of objects            List of print jobs recorded e.g. by the pretix apps
+├ id                                  integer                    Internal ID of the print job
+├ successful                          boolean                    Whether the print job successfully resulted in a print.
+                                                                 This is not expected to be 100 % reliable information (since
+                                                                 printer feedback is never perfect) and there is no guarantee
+                                                                 that unsuccessful jobs will be logged.
+├ device_id                           integer                    Attribute ``device_id`` of the device that recorded the print. Can be ``null``.
+├ datetime                            datetime                   Time of printing
+├ source                              string                     Source of print job, e.g. name of the app used.
+├ type                                string                     Type of print (currently ``badge``, ``ticket``, ``certificate``, or ``other``)
+└ info                                object                     Additional data with client-dependent structure.
 downloads                             list of objects            List of ticket download options
 ├ output                              string                     Ticket output provider (e.g. ``pdf``, ``passbook``)
 └ url                                 string                     Download URL
@@ -215,15 +229,29 @@ answers                               list of objects            Answers to user
 seat                                  objects                    The assigned seat. Can be ``null``.
 ├ id                                  integer                    Internal ID of the seat instance
 ├ name                                string                     Human-readable seat name
+├ zone_name                           string                     Name of the zone the seat is in
+├ row_name                            string                     Name/number of the row the seat is in
+├ row_label                           string                     Additional label of the row (or ``null``)
+├ seat_number                         string                     Number of the seat within the row
+├ seat_label                          string                     Additional label of the seat (or ``null``)
 └ seat_guid                           string                     Identifier of the seat within the seating plan
 pdf_data                              object                     Data object required for ticket PDF generation. By default,
                                                                  this field is missing. It will be added only if you add the
                                                                  ``pdf_data=true`` query parameter to your request.
+plugin_data                           object                     Additional data added by plugins.
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 4.16
+.. versionchanged:: 2024.9
 
-   The attributes ``blocked``, ``valid_from`` and ``valid_until`` have been added.
+   The attribute ``print_logs`` has been added.
+
+.. versionchanged:: 2025.1
+
+   The ``tax_code`` attribute has been added.
+
+.. versionchanged:: 2025.2
+
+   The ``plugin_data`` attribute has been added.
 
 .. _order-payment-resource:
 
@@ -349,7 +377,9 @@ List of all orders
                 "state": "",
                 "internal_reference": "",
                 "vat_id": "EU123456789",
-                "vat_id_validated": false
+                "vat_id_validated": false,
+                "transmission_type": "email",
+                "transmission_info": {}
             },
             "positions": [
               {
@@ -376,6 +406,7 @@ List of all orders
                 "tax_rate": "0.00",
                 "tax_value": "0.00",
                 "tax_rule": null,
+                "tax_code": null,
                 "secret": "z3fsn8jyufm5kpk768q69gkbyr5f4h6w",
                 "addon_to": null,
                 "subevent": null,
@@ -387,14 +418,26 @@ List of all orders
                 "seat": null,
                 "checkins": [
                   {
+                    "id": 1337,
                     "list": 44,
                     "type": "entry",
                     "gate": null,
                     "device": 2,
+                    "device_id": 1,
                     "datetime": "2017-12-25T12:45:23Z",
                     "auto_checked_in": false
                   }
                 ],
+                "print_logs": [
+                  {
+                    "id": 1,
+                    "type": "badge",
+                    "datetime": "2017-12-25T12:45:23Z",
+                    "device_id": 1,
+                    "source": "pretixSCAN",
+                    "info": {}
+                  }
+                ],
                 "answers": [
                   {
                     "question": 12,
@@ -409,7 +452,8 @@ List of all orders
                     "output": "pdf",
                     "url": "https://pretix.eu/api/v1/organizers/bigevents/events/sampleconf/orderpositions/23442/download/pdf/"
                   }
-                ]
+                ],
+                "plugin_data": {}
               }
             ],
             "downloads": [
@@ -430,14 +474,16 @@ List of all orders
                 "provider": "banktransfer"
               }
             ],
-            "refunds": []
+            "refunds": [],
+            "cancellation_date": null,
+            "plugin_data": {}
           }
         ]
       }
 
    :query integer page: The page number in case of a multi-page result set, default is 1
    :query string ordering: Manually set the ordering of results. Valid fields to be used are ``datetime``, ``code``,
-                           ``last_modified``, and ``status``. Default: ``datetime``
+                           ``last_modified``, ``status`` and ``cancellation_date``. Default: ``datetime``
    :query string code: Only return orders that match the given order code
    :query string status: Only return orders in the given order status (see above)
    :query string search: Only return orders matching a given search query (matching for names, email addresses, and company names)
@@ -455,10 +501,13 @@ List of all orders
    :query datetime modified_since: Only return orders that have changed since the given date. Be careful: We only
        recommend using this in combination with ``testmode=false``, since test mode orders can vanish at any time and
        you will not notice it using this method.
-   :query datetime created_since: Only return orders that have been created since the given date.
+   :query datetime created_since: Only return orders that have been created since the given date (inclusive).
+   :query datetime created_before: Only return orders that have been created before the given date (exclusive).
    :query integer subevent: Only return orders with a position that contains this subevent ID. *Warning:* Result will also include orders if they contain mixed subevents, and it will even return orders where the subevent is only contained in a canceled position.
    :query datetime subevent_after: Only return orders that contain a ticket for a subevent taking place after the given date. This is an exclusive after, and it considers the **end** of the subevent (or its start, if the end is not set).
    :query datetime subevent_before: Only return orders that contain a ticket for a subevent taking place after the given date. This is an exclusive before, and it considers the **start** of the subevent.
+   :query string sales_channel: Only return orders with the given sales channel identifier (e.g. ``"web"``).
+   :query string payment_provider: Only return orders that contain a payment using the given payment provider. Note that this also searches for partial incomplete, or failed payments within the order and is not useful to get a sum of payment amounts without further processing.
    :query string exclude: Exclude a field from the output, e.g. ``fees`` or ``positions.downloads``. Can be used as a performance optimization. Can be passed multiple times.
    :query string include: Include only the given field in the output, e.g. ``fees`` or ``positions.downloads``. Can be used as a performance optimization. Can be passed multiple times. ``include`` is applied before ``exclude``, so ``exclude`` takes precedence.
    :param organizer: The ``slug`` field of the organizer to fetch
@@ -554,6 +603,7 @@ Fetching individual orders
         "fees": [],
         "total": "23.00",
         "comment": "",
+        "api_meta": {},
         "custom_followup_at": null,
         "checkin_attention": false,
         "checkin_text": null,
@@ -572,7 +622,9 @@ Fetching individual orders
             "state": "",
             "internal_reference": "",
             "vat_id": "EU123456789",
-            "vat_id_validated": false
+            "vat_id_validated": false,
+            "transmission_type": "email",
+            "transmission_info": {}
         },
         "positions": [
           {
@@ -599,6 +651,7 @@ Fetching individual orders
             "tax_rate": "0.00",
             "tax_rule": null,
             "tax_value": "0.00",
+            "tax_code": null,
             "secret": "z3fsn8jyufm5kpk768q69gkbyr5f4h6w",
             "addon_to": null,
             "subevent": null,
@@ -610,14 +663,27 @@ Fetching individual orders
             "seat": null,
             "checkins": [
               {
+                "id": 1337,
                 "list": 44,
                 "type": "entry",
                 "gate": null,
                 "device": 2,
+                "device_id": 1,
                 "datetime": "2017-12-25T12:45:23Z",
                 "auto_checked_in": false
               }
             ],
+            "print_logs": [
+              {
+                "id": 1,
+                "type": "badge",
+                "successful": true,
+                "datetime": "2017-12-25T12:45:23Z",
+                "device_id": 1,
+                "source": "pretixSCAN",
+                "info": {}
+              }
+            ],
             "answers": [
               {
                 "question": 12,
@@ -632,7 +698,8 @@ Fetching individual orders
                 "output": "pdf",
                 "url": "https://pretix.eu/api/v1/organizers/bigevents/events/sampleconf/orderpositions/23442/download/pdf/"
               }
-            ]
+            ],
+            "plugin_data": {}
           }
         ],
         "downloads": [
@@ -653,7 +720,9 @@ Fetching individual orders
             "provider": "banktransfer"
           }
         ],
-        "refunds": []
+        "refunds": [],
+        "cancellation_date": null,
+        "plugin_data": {}
       }
 
    :param organizer: The ``slug`` field of the organizer to fetch
@@ -670,10 +739,6 @@ Fetching individual orders
 Order ticket download
 ---------------------
 
-.. versionchanged:: 4.10
-
-   The API now supports ticket downloads for pending orders if allowed by the event settings.
-
 .. http:get:: /api/v1/organizers/(organizer)/events/(event)/orders/(code)/download/(output)/
 
    Download tickets for an order, identified by its order code. Depending on the chosen output, the response might
@@ -734,6 +799,8 @@ Updating order fields
 
    * ``comment``
 
+   * ``api_meta``
+
    * ``custom_followup_at``
 
    * ``invoice_address`` (you always need to supply the full object, or ``null`` to delete the current address)
@@ -782,7 +849,7 @@ Generating new secrets
 
 .. http:post:: /api/v1/organizers/(organizer)/events/(event)/orders/(code)/regenerate_secrets/
 
-   Triggers generation of new ``secret`` attributes for both the order and all order positions.
+   Triggers generation of new ``secret`` and ``web_secret`` attributes for both the order and all order positions.
 
    **Example request**:
 
@@ -813,7 +880,7 @@ Generating new secrets
 
 .. http:post:: /api/v1/organizers/(organizer)/events/(event)/orderpositions/(id)/regenerate_secrets/
 
-   Triggers generation of a new ``secret`` attribute for a single order position.
+   Triggers generation of a new ``secret`` and ``web_secret`` attribute for a single order position.
 
    **Example request**:
 
@@ -963,8 +1030,10 @@ Creating orders
       * ``internal_reference``
       * ``vat_id``
       * ``vat_id_validated`` (optional) – If you need support for reverse charge (rarely the case), you need to check
-       yourself if the passed VAT ID is a valid EU VAT ID. In that case, set this to ``true``. Only valid VAT IDs will
-       trigger reverse charge taxation. Don't forget to set ``is_business`` as well!
+         yourself if the passed VAT ID is a valid EU VAT ID. In that case, set this to ``true``. Only valid VAT IDs will
+         trigger reverse charge taxation. Don't forget to set ``is_business`` as well!
+     * ``transmission_type`` (optional, defaults to ``email``)
+     * ``transmission_info`` (optional, see also :ref:`rest-transmission-types`)
 
    * ``positions``
 
@@ -1007,9 +1076,10 @@ Creating orders
         prices. Note that this will not include other fees and is calculated once during order generation and will not
         be respected automatically when the order changes later.)
       * ``_split_taxes_like_products`` (Optional convenience flag. If set to ``true``, your ``tax_rule`` will be ignored
-        and the fee will be taxed like the products in the order. If the products have multiple tax rates, multiple fees
-        will be generated with weights adjusted to the net price of the products. Note that this will be calculated once
-        during order generation and is not respected automatically when the order changes later.)
+        and the fee will be taxed like the products in the order *unless* the total amount of the positions is zero.
+        If the products have multiple tax rates, multiple fees will be generated with weights adjusted to the net price
+        of the products. Note that this will be calculated once during order generation and is not respected automatically
+        when the order changes later.)
 
    * ``force`` (optional). If set to ``true``, quotas will be ignored.
    * ``send_email`` (optional). If set to ``true``, the same emails will be sent as for a regular order, regardless of
@@ -1552,6 +1622,7 @@ List of all order positions
             "tax_rate": "0.00",
             "tax_rule": null,
             "tax_value": "0.00",
+            "tax_code": null,
             "secret": "z3fsn8jyufm5kpk768q69gkbyr5f4h6w",
             "discount": null,
             "pseudonymization_id": "MQLJvANO3B",
@@ -1563,14 +1634,27 @@ List of all order positions
             "blocked": null,
             "checkins": [
               {
+                "id": 1337,
                 "list": 44,
                 "type": "entry",
                 "gate": null,
                 "device": 2,
+                "device_id": 1,
                 "datetime": "2017-12-25T12:45:23Z",
                 "auto_checked_in": false
               }
             ],
+            "print_logs": [
+              {
+                "id": 1,
+                "type": "badge",
+                "successful": true,
+                "datetime": "2017-12-25T12:45:23Z",
+                "device_id": 1,
+                "source": "pretixSCAN",
+                "info": {}
+              }
+            ],
             "answers": [
               {
                 "question": 12,
@@ -1585,7 +1669,8 @@ List of all order positions
                 "output": "pdf",
                 "url": "https://pretix.eu/api/v1/organizers/bigevents/events/sampleconf/orderpositions/23442/download/pdf/"
               }
-            ]
+            ],
+            "plugin_data": {}
           }
         ]
       }
@@ -1666,6 +1751,7 @@ Fetching individual positions
         "tax_rate": "0.00",
         "tax_rule": null,
         "tax_value": "0.00",
+        "tax_code": null,
         "secret": "z3fsn8jyufm5kpk768q69gkbyr5f4h6w",
         "addon_to": null,
         "subevent": null,
@@ -1677,14 +1763,27 @@ Fetching individual positions
         "seat": null,
         "checkins": [
           {
+            "id": 1337,
             "list": 44,
             "type": "entry",
             "gate": null,
             "device": 2,
+            "device_id": 1,
             "datetime": "2017-12-25T12:45:23Z",
             "auto_checked_in": false
           }
         ],
+        "print_logs": [
+          {
+            "id": 1,
+            "type": "badge",
+            "successful": true,
+            "datetime": "2017-12-25T12:45:23Z",
+            "device_id": 1,
+            "source": "pretixSCAN",
+            "info": {}
+          }
+        ],
         "answers": [
           {
             "question": 12,
@@ -1699,7 +1798,8 @@ Fetching individual positions
             "output": "pdf",
             "url": "https://pretix.eu/api/v1/organizers/bigevents/events/sampleconf/orderpositions/23442/download/pdf/"
           }
-        ]
+        ],
+        "plugin_data": {}
       }
 
    :param organizer: The ``slug`` field of the organizer to fetch
@@ -1716,10 +1816,6 @@ Fetching individual positions
 Order position ticket download
 ------------------------------
 
-.. versionchanged:: 4.10
-
-   The API now supports ticket downloads for pending orders if allowed by the event settings.
-
 .. http:get:: /api/v1/organizers/(organizer)/events/(event)/orderpositions/(id)/download/(output)/
 
    Download tickets for one order position, identified by its internal ID.
@@ -1772,14 +1868,9 @@ Order position ticket download
 Manipulating individual positions
 ---------------------------------
 
-.. versionchanged:: 4.8
+.. versionchanged:: 2024.9
 
-   The ``PATCH`` method now supports changing items, variations, subevents, seats, prices, and tax rules.
-   The ``POST`` endpoint to add individual positions has been added.
-
-.. versionadded:: 4.16
-
-   The endpoints to manage blocks have been added.
+   The API now supports logging ticket and badge prints.
 
 .. http:patch:: /api/v1/organizers/(organizer)/events/(event)/orderpositions/(id)/
 
@@ -1823,9 +1914,14 @@ Manipulating individual positions
 
    * ``valid_until``
 
+   * ``secret``
+
    Changing parameters such as ``item`` or ``price`` will **not** automatically trigger creation of a new invoice,
    you need to take care of that yourself.
 
+   Changing ``secret`` does not cause a new PDF ticket to be sent to the customer, nor does it cause the old secret
+   to be added to the revocation list, even if your ticket generator uses one.
+
    **Example request**:
 
    .. sourcecode:: http
@@ -1849,6 +1945,7 @@ Manipulating individual positions
 
       (Full order position resource, see above.)
 
+   :query boolean check_quotas: Whether to check quotas before committing item changes, default is ``true``
    :param organizer: The ``slug`` field of the organizer of the event
    :param event: The ``slug`` field of the event
    :param id: The ``id`` field of the order position to update
@@ -1928,6 +2025,7 @@ Manipulating individual positions
 
       (Full order position resource, see above.)
 
+   :query boolean check_quotas: Whether to check quotas before creating the new position, default is ``true``
    :param organizer: The ``slug`` field of the organizer of the event
    :param event: The ``slug`` field of the event
 
@@ -2040,6 +2138,59 @@ Manipulating individual positions
    :statuscode 401: Authentication failure
    :statuscode 403: The requested organizer/event does not exist **or** you have no permission to update this order position.
 
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/orderpositions/(id)/printlog/
+
+   Creates a print log, stating that this ticket has been printed.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/orderpositions/23442/printlog/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+
+     {
+       "datetime": "2024-09-19T13:37:00+02:00",
+       "source": "pretixPOS",
+       "type": "badge",
+       "info": {
+         "cashier": 1234
+       }
+     }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 201 Created
+      Vary: Accept
+      Content-Type: application/pdf
+
+     {
+       "id": 1234,
+       "device_id": null,
+       "datetime": "2024-09-19T13:37:00+02:00",
+       "source": "pretixPOS",
+       "type": "badge",
+       "info": {
+         "cashier": 1234
+       }
+     }
+
+   :param organizer: The ``slug`` field of the organizer to create a log for
+   :param event: The ``slug`` field of the event to create a log for
+   :param id: The ``id`` field of the order position to create a log for
+   :statuscode 201: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource
+                    **or** downloads are not available for this order position at this time. The response content will
+                    contain more details.
+   :statuscode 404: The requested order position or download provider does not exist.
+   :statuscode 409: The file is not yet ready and will now be prepared. Retry the request after waiting for a few
+                    seconds.
+
 Changing order contents
 -----------------------
 
@@ -2048,10 +2199,6 @@ multiple changes to an order at once within one transaction. This makes it possi
 attendees in an order without running into conflicts. This interface also offers some possibilities not available
 otherwise, such as splitting an order or changing fees.
 
-.. versionchanged:: 4.8
-
-   This endpoint has been added to the system.
-
 .. http:post:: /api/v1/organizers/(organizer)/events/(event)/orders/(code)/change/
 
    Performs a change operation on an order. You can supply the following fields:
@@ -2072,6 +2219,9 @@ otherwise, such as splitting an order or changing fees.
 
    * ``cancel_fees``: A list of objects with the single key ``fee`` specifying an order fee ID.
 
+   * ``create_fees``: A list of objects describing new order fees with the fields ``fee_type``, ``value``, ``description``,
+     ``internal_type``, ``tax_rule``
+
    * ``recalculate_taxes``: If set to ``"keep_net"``, all taxes will be recalculated based on the tax rule and invoice
      address, the net price will be kept. If set to ``"keep_gross"``, the gross price will be kept. If set to ``null``
      (the default) the taxes are not recalculated.
@@ -2091,17 +2241,12 @@ otherwise, such as splitting an order or changing fees.
       Content-Type: application/json
 
       {
-        "cancel_positions": [
-          {
-            "position": 12373
-          }
-        ],
         "patch_positions": [
           {
             "position": 12374,
             "body": {
               "item": 12,
-              "variation": None,
+              "variation": null,
               "subevent": 562,
               "seat": "seat-guid-2",
               "price": "99.99",
@@ -2109,6 +2254,11 @@ otherwise, such as splitting an order or changing fees.
             }
           }
         ],
+        "cancel_positions": [
+          {
+            "position": 12373
+          }
+        ],
         "split_positions": [
           {
             "position": 12375
@@ -2117,7 +2267,7 @@ otherwise, such as splitting an order or changing fees.
         "create_positions": [
           {
             "item": 12,
-            "variation": None,
+            "variation": null,
             "subevent": 562,
             "seat": "seat-guid-2",
             "price": "99.99",
@@ -2125,12 +2275,7 @@ otherwise, such as splitting an order or changing fees.
             "attendee_name": "Peter",
           }
         ],
-        "cancel_fees": [
-          {
-            "fee": 49
-          }
-        ],
-        "change_fees": [
+        "patch_fees": [
           {
             "fee": 51,
             "body": {
@@ -2138,6 +2283,20 @@ otherwise, such as splitting an order or changing fees.
             }
           }
         ],
+        "cancel_fees": [
+          {
+            "fee": 49
+          }
+        ],
+        "create_fees": [
+          {
+            "fee_type": "other",
+            "value": "1.50",
+            "description": "Example Fee",
+            "internal_type": "",
+            "tax_rule": 15
+          }
+        ],
         "reissue_invoice": true,
         "send_email": true,
         "recalculate_taxes": "keep_gross"
@@ -2153,6 +2312,7 @@ otherwise, such as splitting an order or changing fees.
 
       (Full order position resource, see above.)
 
+   :query boolean check_quotas: Whether to check quotas before patching or creating positions, default is ``true``
    :param organizer: The ``slug`` field of the organizer of the event
    :param event: The ``slug`` field of the event
    :param code: The ``code`` field of the order to update

doc/api/resources/organizers.rst

@@ -19,16 +19,17 @@ name                                  string                     The organizer's
 slug                                  string                     A short form of the name, used e.g. in URLs.
 public_url                            string                     The public, customer-facing URL of the organizer, where
                                                                  the list of all events can be found (read-only).
+plugins                               list                       A list of package names of the enabled plugins for this
+                                                                 organizer. Note that most plugins are enabled on the
+                                                                 event level (or both levels). If you remove a plugin
+                                                                 that is also enabled on some events, it will
+                                                                 automatically be removed from all events as well.
 ===================================== ========================== =======================================================
 
 
 Endpoints
 ---------
 
-.. versionchanged:: 4.17
-
-    The ``public_url`` field has been added.
-
 .. http:get:: /api/v1/organizers/
 
    Returns a list of all organizers the authenticated user/token has access to.
@@ -57,7 +58,10 @@ Endpoints
           {
             "name": "Big Events LLC",
             "slug": "Big Events",
-            "public_url": "https://pretix.eu/bigevents/"
+            "public_url": "https://pretix.eu/bigevents/",
+            "plugins": [
+              "pretix_datev"
+            ]
           }
         ]
       }
@@ -91,7 +95,10 @@ Endpoints
       {
         "name": "Big Events LLC",
         "slug": "Big Events",
-        "public_url": "https://pretix.eu/bigevents/"
+        "public_url": "https://pretix.eu/bigevents/",
+        "plugins": [
+          "pretix_datev"
+        ]
       }
 
    :param organizer: The ``slug`` field of the organizer to fetch
@@ -99,6 +106,50 @@ Endpoints
    :statuscode 401: Authentication failure
    :statuscode 403: The requested organizer does not exist **or** you have no permission to view it.
 
+.. http:patch:: /api/v1/organizers/(organizer)/
+
+   Updates an organizer. Currently only the ``plugins`` field may be updated.
+
+   Permission required: "Can change organizer settings"
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      PATCH /api/v1/organizers/bigevents/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+
+      {
+        "plugins": [
+          "pretix_seating"
+        ]
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "name": "Big Events LLC",
+        "slug": "Big Events",
+        "public_url": "https://pretix.eu/bigevents/",
+        "plugins": [
+          "pretix_seating"
+        ]
+      }
+
+   :param organizer: The ``slug`` field of the organizer to update
+   :statuscode 200: no error
+   :statuscode 400: The organizer could not be updated due to invalid submitted data.
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to update this resource.
+
 Organizer settings
 ------------------
 

doc/api/resources/quotas.rst

@@ -28,6 +28,8 @@ closed                                boolean                    Whether the quo
                                                                  field).
 release_after_exit                    boolean                    Whether the quota regains capacity as soon as some tickets
                                                                  have been scanned at an exit.
+ignore_for_event_availability         boolean                    Whether the quota is ignored when calculating the event's
+                                                                 availability of tickets.
 available                             boolean                    Whether this quota is available. Only returned if ``with_availability=true``
                                                                  is set on the request. Do not rely on this value for critical operations, it may be
                                                                  slightly out of date.
@@ -36,10 +38,9 @@ available_number                      integer                    Number of avail
                                                                  slightly out of date. ``null`` means unlimited.
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 4.1
-
-    The ``with_availability`` query parameter has been added.
+.. versionchanged:: 2025.7
 
+    The attribute ``ignore_for_event_availability`` has been added.
 
 Endpoints
 ---------
@@ -77,7 +78,8 @@ Endpoints
             "variations": [1, 4, 5, 7],
             "subevent": null,
             "close_when_sold_out": false,
-            "closed": false
+            "closed": false,
+            "ignore_for_event_availability": false
           }
         ]
       }
@@ -86,7 +88,8 @@ Endpoints
    :query string ordering: Manually set the ordering of results. Valid fields to be used are ``id`` and ``position``.
                            Default: ``position``
    :query integer subevent: Only return quotas of the sub-event with the given ID.
-   :query integer subevent__in: Only return quotas of sub-events with one the given IDs (comma-separated).
+   :query integer subevent__in: Only return quotas of sub-events with one of the given IDs (comma-separated).
+   :query integer items__in: Only return quotas that include a product with one of the given IDs (comma-separated).
    :query string with_availability: Set to ``true`` to get availability information. Can lead to increased answer times.
    :param organizer: The ``slug`` field of the organizer to fetch
    :param event: The ``slug`` field of the event to fetch
@@ -122,7 +125,8 @@ Endpoints
         "variations": [1, 4, 5, 7],
         "subevent": null,
         "close_when_sold_out": false,
-        "closed": false
+        "closed": false,
+        "ignore_for_event_availability": false
       }
 
    :param organizer: The ``slug`` field of the organizer to fetch
@@ -153,7 +157,8 @@ Endpoints
         "variations": [1, 4, 5, 7],
         "subevent": null,
         "close_when_sold_out": false,
-        "closed": false
+        "closed": false,
+        "ignore_for_event_availability": false
       }
 
    **Example response**:
@@ -172,7 +177,8 @@ Endpoints
         "variations": [1, 4, 5, 7],
         "subevent": null,
         "close_when_sold_out": false,
-        "closed": false
+        "closed": false,
+        "ignore_for_event_availability": false
       }
 
    :param organizer: The ``slug`` field of the organizer of the event/item to create a quota for
@@ -227,7 +233,8 @@ Endpoints
         ],
         "subevent": null,
         "close_when_sold_out": false,
-        "closed": false
+        "closed": false,
+        "ignore_for_event_availability": false
       }
 
    :param organizer: The ``slug`` field of the organizer to modify

doc/api/resources/saleschannels.rst

@@ -0,0 +1,219 @@
+Sales channels
+==============
+
+Resource description
+--------------------
+
+The sales channel resource contains the following public fields:
+
+.. rst-class:: rest-resource-table
+
+===================================== ========================== =======================================================
+Field                                 Type                       Description
+===================================== ========================== =======================================================
+identifier                            string                     Internal ID of the sales channel. For sales channel types
+                                                                 that allow only one instance, this is the same as ``type``.
+                                                                 For sales channel types that allow multiple instances, this
+                                                                 is always prefixed with ``type.``.
+label                                 multi-lingual string       Human-readable name of the sales channel
+type                                  string                     Type of the sales channel. Only channels with type ``api``
+                                                                 can currently be created through the API.
+position                              integer                    Position for sorting lists of sales channels
+===================================== ========================== =======================================================
+
+Endpoints
+---------
+
+.. http:get:: /api/v1/organizers/(organizer)/saleschannels/
+
+   Returns a list of all sales channels within a given organizer.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/saleschannels/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "count": 1,
+        "next": null,
+        "previous": null,
+        "results": [
+          {
+            "identifier": "web",
+            "label": {
+              "en": "Online shop"
+            },
+            "type": "web",
+            "position": 0
+          }
+        ]
+      }
+
+   :query integer page: The page number in case of a multi-page result set, default is 1
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to view this resource.
+
+.. http:get:: /api/v1/organizers/(organizer)/saleschannels/(identifier)/
+
+   Returns information on one sales channel, identified by its identifier.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/saleschannels/web/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "identifier": "web",
+        "label": {
+          "en": "Online shop"
+        },
+        "type": "web",
+        "position": 0
+      }
+
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :param identifier: The ``identifier`` field of the sales channel to fetch
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to view this resource.
+
+.. http:post:: /api/v1/organizers/(organizer)/saleschannels/
+
+   Creates a sales channel
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/saleschannels/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+
+      {
+        "identifier": "api.custom",
+        "label": {
+          "en": "Custom integration"
+        },
+        "type": "api",
+        "position": 2
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 201 Created
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "identifier": "api.custom",
+        "label": {
+          "en": "Custom integration"
+        },
+        "type": "api",
+        "position": 2
+      }
+
+   :param organizer: The ``slug`` field of the organizer to create a sales channel for
+   :statuscode 201: no error
+   :statuscode 400: The sales channel could not be created due to invalid submitted data.
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to create this resource.
+
+.. http:patch:: /api/v1/organizers/(organizer)/saleschannels/(identifier)/
+
+   Update a sales channel. You can also use ``PUT`` instead of ``PATCH``. With ``PUT``, you have to provide all fields of
+   the resource, other fields will be reset to default. With ``PATCH``, you only need to provide the fields that you
+   want to change.
+
+   You can change all fields of the resource except the ``identifier`` and ``type`` fields.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      PATCH /api/v1/organizers/bigevents/saleschannels/web/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+      Content-Length: 94
+
+      {
+        "position": 5
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "identifier": "web",
+        "label": {
+          "en": "Online shop"
+        },
+        "type": "web",
+        "position": 5
+      }
+
+   :param organizer: The ``slug`` field of the organizer to modify
+   :param identifier: The ``identifier`` field of the sales channel to modify
+   :statuscode 200: no error
+   :statuscode 400: The sales channel could not be modified due to invalid submitted data
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to change this resource.
+
+.. http:delete:: /api/v1/organizers/(organizer)/saleschannels/(identifier)/
+
+   Delete a sales channel. You can not delete sales channels which have already been used or which are integral parts
+   of the system.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      DELETE /api/v1/organizers/bigevents/saleschannels/api.custom/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 204 No Content
+      Vary: Accept
+
+   :param organizer: The ``slug`` field of the organizer to modify
+   :param identifier: The ``identifier`` field of the sales channel to delete
+   :statuscode 204: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to delete this resource **or** the sales channel is currently in use.

doc/api/resources/scheduled_exports.rst

@@ -313,7 +313,7 @@ Endpoints for event exports
    :statuscode 403: The requested organizer/event does not exist **or** you have no permission to delete this resource.
 
 Endpoints for organizer exports
----------------------------
+-------------------------------
 
 .. http:get:: /api/v1/organizers/(organizer)/scheduled_exports/
 
@@ -553,4 +553,4 @@ Endpoints for organizer exports
    :statuscode 403: The requested organizer does not exist **or** you have no permission to delete this resource.
 
 
-.. _RFC 5545: https://datatracker.ietf.org/doc/html/rfc5545#section-3.8.5.3
+.. _RFC 5545: https://datatracker.ietf.org/doc/html/rfc5545#section-3.8.5.3

doc/api/resources/seats.rst

@@ -0,0 +1,373 @@
+.. _`rest-seats`:
+
+Seats
+=====
+
+The seat resource represents the seats in a seating plan in a specific event or subevent.
+
+Resource description
+--------------------
+
+The seat resource contains the following public fields:
+
+.. rst-class:: rest-resource-table
+
+===================================== ========================== =======================================================
+Field                                 Type                       Description
+===================================== ========================== =======================================================
+id                                    integer                    Internal ID of this seat
+subevent                              integer                    Internal ID of the subevent this seat belongs to
+zone_name                             string                     Name of the zone the seat is in
+row_name                              string                     Name/number of the row the seat is in
+row_label                             string                     Additional label of the row (or ``null``)
+seat_number                           string                     Number of the seat within the row
+seat_label                            string                     Additional label of the seat (or ``null``)
+seat_guid                             string                     Identifier of the seat within the seating plan
+product                               integer                    Internal ID of the product that is mapped to this seat
+blocked                               boolean                    Whether this seat is blocked manually.
+orderposition                         integer / object           Internal ID of an order position reserving this seat.
+cartposition                          integer / object           Internal ID of a cart position reserving this seat.
+voucher                               integer / object           Internal ID of a voucher reserving this seat.
+===================================== ========================== =======================================================
+
+Endpoints
+---------
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/seats/
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/subevents/(subevent_id)/seats/
+
+   Returns a list of all seats in the specified event or subevent. Depending on whether the event has subevents, the
+   according endpoint has to be used.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/seats/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+        HTTP/1.1 200 OK
+        Vary: Accept
+        Content-Type: application/json
+
+        {
+            "count": 500,
+            "next": "https://pretix.eu/api/v1/organizers/bigevents/events/sampleconf/seats/?page=2",
+            "previous": null,
+            "results": [
+                {
+                    "id": 1633,
+                    "subevent": null,
+                    "zone_name": "Ground floor",
+                    "row_name": "1",
+                    "row_label": null,
+                    "seat_number": "1",
+                    "seat_label": null,
+                    "seat_guid": "b9746230-6f31-4f41-bbc9-d6b60bdb3342",
+                    "product": 104,
+                    "blocked": false,
+                    "orderposition": null,
+                    "cartposition": null,
+                    "voucher": 51
+                },
+                {
+                    "id": 1634,
+                    "subevent": null,
+                    "zone_name": "Ground floor",
+                    "row_name": "1",
+                    "row_label": null,
+                    "seat_number": "2",
+                    "seat_label": null,
+                    "seat_guid": "1d29fe20-8e1e-4984-b0ee-2773b0d07e07",
+                    "product": 104,
+                    "blocked": true,
+                    "orderposition": 4321,
+                    "cartposition": null,
+                    "voucher": null
+                },
+                // ...
+            ]
+        }
+
+   :query integer page: The page number in case of a multi-page result set, default is 1.
+   :query string zone_name: Only show seats with the given zone_name.
+   :query string row_name: Only show seats with the given row_name.
+   :query string row_label: Only show seats with the given row_label.
+   :query string seat_number: Only show seats with the given seat_number.
+   :query string seat_label: Only show seats with the given seat_label.
+   :query string seat_guid: Only show seats with the given seat_guid.
+   :query boolean blocked: Only show seats with the given blocked status.
+   :query boolean is_available: Only show seats that are (not) currently available.
+   :query string expand: If you pass ``"orderposition"``, ``"cartposition"``, or ``"voucher"``, the respective field will be
+                         shown as a nested value instead of just an ID. This requires permission to access that object.
+                         The nested objects are identical to the respective resources, except that order positions
+                         will have an attribute of the format ``"order": {"code": "ABCDE", "event": "eventslug"}`` to make
+                         matching easier, and won't include the `seat` attribute, as that would be redundant.
+                         The parameter can be given multiple times.
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :param event: The ``slug`` field of the event to fetch
+   :param subevent_id: The ``id`` field of the subevent to fetch
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to view this resource.
+   :statuscode 404: Endpoint without subevent id was used for event with subevents, or vice versa.
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/seats/(id)/
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/subevents/(subevent_id)/seats/(id)/
+
+   Returns information on one seat, identified by its ID.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+        GET /api/v1/organizers/bigevents/events/sampleconf/seats/1634/?expand=orderposition HTTP/1.1
+        Host: pretix.eu
+        Accept: application/json
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+        HTTP/1.1 200 OK
+        Vary: Accept
+        Content-Type: application/json
+
+        {
+            "id": 1634,
+            "subevent": null,
+            "zone_name": "Ground floor",
+            "row_name": "1",
+            "row_label": null,
+            "seat_number": "2",
+            "seat_label": null,
+            "seat_guid": "1d29fe20-8e1e-4984-b0ee-2773b0d07e07",
+            "product": 104,
+            "blocked": true,
+            "orderposition": {
+                "id": 134,
+                "order": {
+                    "code": "U0HW7",
+                    "event": "sampleconf"
+                },
+                "positionid": 1,
+                "item": 104,
+                "variation": 59,
+                "price": "60.00",
+                "attendee_name": "",
+                "attendee_name_parts": {
+                    "_scheme": "given_family"
+                },
+                "company": null,
+                "street": null,
+                "zipcode": null,
+                "city": null,
+                "country": null,
+                "state": null,
+                "discount": null,
+                "attendee_email": null,
+                "voucher": null,
+                "tax_rate": "0.00",
+                "tax_value": "0.00",
+                "secret": "4rfgp263jduratnsvwvy6cc6r6wnptbj",
+                "addon_to": null,
+                "subevent": null,
+                "checkins": [],
+                "downloads": [],
+                "answers": [],
+                "tax_rule": null,
+                "pseudonymization_id": "ZSNYSG3URZ",
+                "canceled": false,
+                "valid_from": null,
+                "valid_until": null,
+                "blocked": null,
+                "voucher_budget_use": null
+            },
+            "cartposition": null,
+            "voucher": null
+        }
+
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :param event: The ``slug`` field of the event to fetch
+   :param subevent_id: The ``id`` field of the subevent to fetch
+   :param id: The ``id`` field of the seat to fetch
+   :query string expand: If you pass ``"orderposition"``, ``"cartposition"``, or ``"voucher"``, the respective field will be
+                         shown as a nested value instead of just an ID. This requires permission to access that object.
+                         The nested objects are identical to the respective resources, except that order positions
+                         will have an attribute of the format ``"order": {"code": "ABCDE", "event": "eventslug"}`` to make
+                         matching easier, and won't include the `seat` attribute, as that would be redundant.
+                         The parameter can be given multiple times.
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to view this resource.
+   :statuscode 404: Seat does not exist; or the endpoint without subevent id was used for event with subevents, or vice versa.
+
+.. http:patch:: /api/v1/organizers/(organizer)/events/(event)/seats/(id)/
+.. http:patch:: /api/v1/organizers/(organizer)/events/(event)/subevents/(id)/seats/(id)/
+
+   Update a seat.
+
+   You can only change the ``blocked`` field.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+        PATCH /api/v1/organizers/bigevents/events/sampleconf/seats/1636/ HTTP/1.1
+        Host: pretix.eu
+        Accept: application/json, text/javascript
+        Content-Type: application/json
+
+        {
+            "blocked": true
+        }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+        HTTP/1.1 200 OK
+        Vary: Accept
+        Content-Type: application/json
+
+        {
+            "id": 1636,
+            "subevent": null,
+            "zone_name": "Ground floor",
+            "row_name": "1",
+            "row_label": null,
+            "seat_number": "4",
+            "seat_label": null,
+            "seat_guid": "6c0e29e5-05d6-421f-99f3-afd01478ecad",
+            "product": 104,
+            "blocked": true,
+            "orderposition": null,
+            "cartposition": null,
+            "voucher": null
+        }
+
+   :param organizer: The ``slug`` field of the organizer to modify
+   :param event: The ``slug`` field of the event to modify
+   :param subevent_id: The ``id`` field of the subevent to modify
+   :param id: The ``id`` field of the seat to modify
+   :statuscode 200: no error
+   :statuscode 400: The seat could not be modified due to invalid submitted data
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer or event does not exist **or** you have no permission to change this resource.
+   :statuscode 404: Seat does not exist; or the endpoint without subevent id was used for event with subevents, or vice versa.
+
+
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/seats/bulk_block/
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/subevents/(id)/seats/bulk_block/
+
+   Set the ``blocked`` attribute to ``true`` for a large number of seats at once.
+   You can pass either a list of ``id`` values or a list of ``seat_guid`` values.
+   You can pass up to 10,000 seats in one request.
+
+   The endpoint will return an error if you pass a seat ID that does not exist.
+   However, it will not return an error if one of the passed seats is already blocked or sold.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+        PATCH /api/v1/organizers/bigevents/events/sampleconf/seats/bulk_block/ HTTP/1.1
+        Host: pretix.eu
+        Accept: application/json, text/javascript
+        Content-Type: application/json
+
+        {
+            "ids": [12, 45, 56]
+        }
+
+   or
+
+   .. sourcecode:: http
+
+        PATCH /api/v1/organizers/bigevents/events/sampleconf/seats/bulk_block/ HTTP/1.1
+        Host: pretix.eu
+        Accept: application/json, text/javascript
+        Content-Type: application/json
+
+        {
+            "seat_guids": ["6c0e29e5-05d6-421f-99f3-afd01478ecad", "c2899340-e2e7-4d05-8100-000a4b6d7cf4"]
+        }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+        HTTP/1.1 200 OK
+        Vary: Accept
+        Content-Type: application/json
+
+        {}
+
+   :param organizer: The ``slug`` field of the organizer to modify
+   :param event: The ``slug`` field of the event to modify
+   :param subevent_id: The ``id`` field of the subevent to modify
+   :statuscode 200: no error
+   :statuscode 400: The seat could not be modified due to invalid submitted data
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer or event does not exist **or** you have no permission to change this resource.
+   :statuscode 404: Seat does not exist; or the endpoint without subevent id was used for event with subevents, or vice versa.
+
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/seats/bulk_unblock/
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/subevents/(id)/seats/bulk_unblock/
+
+   Set the ``blocked`` attribute to ``false`` for a large number of seats at once.
+   You can pass either a list of ``id`` values or a list of ``seat_guid`` values.
+   You can pass up to 10,000 seats in one request.
+
+   The endpoint will return an error if you pass a seat ID that does not exist.
+   However, it will not return an error if one of the passed seat is already unblocked or is sold.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+        PATCH /api/v1/organizers/bigevents/events/sampleconf/seats/bulk_unblock/ HTTP/1.1
+        Host: pretix.eu
+        Accept: application/json, text/javascript
+        Content-Type: application/json
+
+        {
+            "ids": [12, 45, 56]
+        }
+
+   or
+
+   .. sourcecode:: http
+
+        PATCH /api/v1/organizers/bigevents/events/sampleconf/seats/bulk_unblock/ HTTP/1.1
+        Host: pretix.eu
+        Accept: application/json, text/javascript
+        Content-Type: application/json
+
+        {
+            "seat_guids": ["6c0e29e5-05d6-421f-99f3-afd01478ecad", "c2899340-e2e7-4d05-8100-000a4b6d7cf4"]
+        }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+        HTTP/1.1 200 OK
+        Vary: Accept
+        Content-Type: application/json
+
+        {}
+
+   :param organizer: The ``slug`` field of the organizer to modify
+   :param event: The ``slug`` field of the event to modify
+   :param subevent_id: The ``id`` field of the subevent to modify
+   :statuscode 200: no error
+   :statuscode 400: The seat could not be modified due to invalid submitted data
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer or event does not exist **or** you have no permission to change this resource.
+   :statuscode 404: Seat does not exist; or the endpoint without subevent id was used for event with subevents, or vice versa.

doc/api/resources/sendmail_rules.rst

@@ -1,6 +1,8 @@
 Scheduled email rules
 =====================
 
+This feature requires the bundled ``pretix.plugins.sendmail`` plugin to be active for the event in order to work properly.
+
 Resource description
 --------------------
 
@@ -48,6 +50,7 @@ send_to                               string                     Can be ``"order
                                                                  or ``"both"``.
                                                                  date. Otherwise it is relative to the event start date.
 ===================================== ========================== =======================================================
+
 .. versionchanged:: 2023.7
 
     The ``include_pending`` field has been  deprecated.

doc/api/resources/shipping.rst

@@ -1,6 +1,8 @@
 Shipping
 ========
 
+.. note:: This API is only available when the plugin **pretix-shipping** is installed (pretix Hosted and Enterprise only).
+
 The shipping plugin provides a HTTP API that exposes the various layouts used to generate PDF badges.
 
 Shipping address resource

doc/api/resources/shredders.rst

@@ -6,10 +6,6 @@ Data shredders
 pretix and it's plugins include a number of data shredders that allow you to clear personal information from the system.
 This page shows you how to use these shredders through the API.
 
-.. versionchanged:: 4.12
-
-   This feature has been added to the API.
-
 .. warning::
 
    Unlike the user interface, the API will not force you to download tax-relevant data before you delete it.

doc/api/resources/subevents.rst

@@ -59,15 +59,6 @@ seat_category_mapping                 object                     An object mappi
 last_modified                         datetime                   Last modification of this object
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 4.15
-
-    The ``search`` query parameter has been added to filter sub-events by their name or location in any language.
-
-.. versionchanged:: 5.0
-
-    The ``date_from_before``, ``date_from_after``, ``date_to_before``, and ``date_to_after`` query parameters have been
-    added.
-
 .. versionchanged:: 2023.8.0
 
     For the organizer-wide endpoint, the ``search`` query parameter has been modified to filter sub-events by their parent events slug too.
@@ -75,10 +66,6 @@ last_modified                         datetime                   Last modificati
 Endpoints
 ---------
 
-.. versionchanged:: 4.1
-
-    The ``with_availability_for`` parameter has been added.
-
 .. http:get:: /api/v1/organizers/(organizer)/events/(event)/subevents/
 
    Returns a list of all sub-events of an event.
@@ -136,6 +123,7 @@ Endpoints
       }
 
    :query page: The page number in case of a multi-page result set, default is 1
+   :query is_public: If set to ``true``/``false``, only subevents with a matching value of ``is_public`` are returned.
    :query active: If set to ``true``/``false``, only events with a matching value of ``active`` are returned.
    :query is_future: If set to ``true`` (``false``), only events that happen currently or in the future are (not) returned.
    :query is_past: If set to ``true`` (``false``), only events that are over are (not) returned.
@@ -467,6 +455,7 @@ Endpoints
       }
 
    :query page: The page number in case of a multi-page result set, default is 1
+   :query is_public: If set to ``true``/``false``, only subevents with a matching value of ``is_public`` are returned.
    :query active: If set to ``true``/``false``, only events with a matching value of ``active`` are returned.
    :query event__live: If set to ``true``/``false``, only events with a matching value of ``live`` on the parent event are returned.
    :query is_future: If set to ``true`` (``false``), only events that happen currently or in the future are (not) returned.

doc/api/resources/taxrules.rst

@@ -1,3 +1,8 @@
+.. spelling:word-list::
+
+   EN16931
+   DSFinV-K
+
 .. _rest-taxrules:
 
 Tax rules
@@ -18,10 +23,14 @@ id                                    integer                    Internal ID of
 name                                  multi-lingual string       The tax rules' name
 internal_name                         string                     An optional name that is only used in the backend
 rate                                  decimal (string)           Tax rate in percent
+code                                  string                     Codified reason for tax rate (or ``null``), see :ref:`rest-taxcodes`.
 price_includes_tax                    boolean                    If ``true`` (default), tax is assumed to be included in
                                                                  the specified product price
-eu_reverse_charge                     boolean                    If ``true``, EU reverse charge rules are applied. Will
-                                                                 be ignored if custom rules are set.
+default                               boolean                    If ``true`` (default), this is the default tax rate for this event
+                                                                 (there can only be one per event).
+eu_reverse_charge                     boolean                    **DEPRECATED**. If ``true``, EU reverse charge rules
+                                                                 are applied. Will be ignored if custom rules are set.
+                                                                 Use custom rules instead.
 home_country                          string                     Merchant country (required for reverse charge), can be
                                                                  ``null`` or empty string
 keep_gross_if_rate_changes            boolean                    If ``true``, changes of the tax rate based on custom
@@ -33,14 +42,50 @@ custom_rules                          object                     Dynamic rules s
 ===================================== ========================== =======================================================
 
 
-.. versionchanged:: 4.6
-
-    The ``internal_name`` and ``keep_gross_if_rate_changes`` attributes have been added.
-
 .. versionchanged:: 2023.6
 
     The ``custom_rules`` attribute has been added.
 
+.. versionchanged:: 2023.8
+
+    The ``code`` attribute has been added.
+
+.. versionchanged:: 2025.4
+
+    The ``default`` attribute has been added.
+
+.. _rest-taxcodes:
+
+Tax codes
+---------
+
+For integration with external systems, such as electronic invoicing or bookkeeping systems, the tax rate itself is often
+not sufficient information. For example, there could be many different reasons why a sale has a tax rate of 0 %, but the
+external handling of the transaction depends on which reason applies. Therefore, pretix allows to supply a codified
+reason that allows us to understand what the specific legal situation is. These tax codes are modeled after a combination
+of the code lists from the European standard EN16931 and the German standard DSFinV-K.
+
+The following codes are supported:
+
+- ``S/standard`` -- Standard VAT rate in the merchant country
+- ``S/reduced`` -- Reduced VAT rate in the merchant country
+- ``S/averaged`` -- Averaged VAT rate in the merchant country (known use case: agricultural businesses in Germany)
+- ``AE`` -- Reverse charge
+- ``O`` -- Services outside of scope of tax
+- ``E`` -- Exempt from tax (no reason given)
+- ``E/<reason>`` -- Exempt from tax, where ``<reason>`` is one of the codes listed in the `VATEX code list`_ version 5.0.
+- ``Z`` -- Zero-rated goods
+- ``G`` -- Free export item, VAT not charged
+- ``K`` -- VAT exempt for EEA intra-community supply of goods and services
+- ``L`` -- Canary Islands general indirect tax
+- ``M`` -- Tax for production, services and importation in Ceuta and Melilla
+- ``B`` -- Transferred (VAT), only in Italy
+
+The code set in the ``code`` attribute of the tax rule is used by default. When ``eu_reverse_charge`` is active, the
+code is replaced by ``AE`` for reverse charge sales and by ``O`` for non-EU sales. When configuring custom rules, you
+should actively set a ``"code"`` key on each rule. Only for ``"action": "reverse"`` we automatically apply the code
+``AE``, in all other cases the default ``code`` of the tax rule is selected.
+
 Endpoints
 ---------
 
@@ -72,7 +117,9 @@ Endpoints
           {
             "id": 1,
             "name": {"en": "VAT"},
+            "default": true,
             "internal_name": "VAT",
+            "code": "S/standard",
             "rate": "19.00",
             "price_includes_tax": true,
             "eu_reverse_charge": false,
@@ -113,7 +160,9 @@ Endpoints
       {
         "id": 1,
         "name": {"en": "VAT"},
+            "default": true,
         "internal_name": "VAT",
+        "code": "S/standard",
         "rate": "19.00",
         "price_includes_tax": true,
         "eu_reverse_charge": false,
@@ -162,7 +211,9 @@ Endpoints
       {
         "id": 1,
         "name": {"en": "VAT"},
+        "default": false,
         "internal_name": "VAT",
+        "code": "S/standard",
         "rate": "19.00",
         "price_includes_tax": true,
         "eu_reverse_charge": false,
@@ -211,6 +262,7 @@ Endpoints
         "id": 1,
         "name": {"en": "VAT"},
         "internal_name": "VAT",
+        "code": "S/standard",
         "rate": "20.00",
         "price_includes_tax": true,
         "eu_reverse_charge": false,
@@ -257,3 +309,4 @@ Endpoints
    :statuscode 403: The requested organizer/event/rule does not exist **or** you have no permission to change it **or** this tax rule cannot be deleted since it is currently in use.
 
 .. _here: https://github.com/pretix/pretix/blob/master/src/pretix/static/schema/tax-rules-custom.schema.json
+.. _VATEX code list: https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/Registry+of+supporting+artefacts+to+implement+EN16931#RegistryofsupportingartefactstoimplementEN16931-Codelists

doc/api/resources/teams.rst

@@ -39,10 +39,6 @@ can_change_vouchers                   boolean
 can_checkin_orders                    boolean
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 4.18
-
-    The ``can_manage_reusable_media`` permission has been added.
-
 Team member resource
 --------------------
 

doc/api/resources/ticketoutputpdf.rst

@@ -1,7 +1,7 @@
 PDF ticket output
 =================
 
-The PDF ticket output plugin provides a HTTP API that exposes the various layouts used
+The build-in PDF ticket output plugin provides a HTTP API that exposes the various layouts used
 to generate PDF tickets.
 
 Resource description
@@ -29,8 +29,8 @@ item_assignments                      list of objects            Products this l
 ===================================== ========================== =======================================================
 
 
-Endpoints
----------
+Layout endpoints
+----------------
 
 .. http:get:: /api/v1/organizers/(organizer)/events/(event)/ticketlayouts/
 
@@ -268,5 +268,75 @@ Endpoints
    :statuscode 401: Authentication failure
    :statuscode 403: The requested organizer/event does not exist **or** you have no permission to delete this resource.
 
+Ticket rendering endpoint
+-----------------------------
+
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/ticketpdfrenderer/render_batch/
+
+   With this API call, you can instruct the system to render a set of tickets into one combined PDF file. To specify
+   which tickets to render, you need to submit a list of "parts". For every part, the following fields are supported:
+
+   * ``orderposition`` (``integer``, required): The ID of the order position to render.
+   * ``override_channel`` (``string``, optional): The sales channel ID to be used for layout selection instead of the
+     original channel of the order.
+   * ``override_layout`` (``integer``, optional): The ticket layout ID to be used instead of the auto-selected one.
+
+   If your input parameters validate correctly, a ``202 Accepted`` status code is returned.
+   The body points you to the download URL of the result. Running a ``GET`` request on that result URL will
+   yield one of the following status codes:
+
+    * ``200 OK`` – The export succeeded. The body will be your resulting file. Might be large!
+    * ``409 Conflict`` – Your export is still running. The body will be JSON with the structure ``{"status": "running"}``. ``status`` can be ``waiting`` before the task is actually being processed. Please retry, but wait at least one second before you do.
+    * ``410 Gone`` – Running the export has failed permanently. The body will be JSON with the structure ``{"status": "failed", "message": "Error message"}``
+    * ``404 Not Found`` – The export does not exist / is expired.
+
+   .. warning:: This endpoint is considered **experimental**. It might change at any time without prior notice.
+
+   .. note:: To avoid performance issues, a maximum number of 1000 parts is currently allowed.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/ticketpdfrenderer/render_batch/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+
+      {
+        "parts": [
+          {
+            "orderposition": 55412
+          },
+          {
+            "orderposition": 55412,
+            "override_channel": "web"
+          },
+          {
+            "orderposition": 55412,
+            "override_layout": 56
+          }
+        ]
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "download": "https://pretix.eu/api/v1/organizers/bigevents/events/sampleconf/ticketpdfrenderer/download/29891ede-196f-4942-9e26-d055a36e98b8/3f279f13-c198-4137-b49b-9b360ce9fcce/"
+      }
+
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :param event: The ``slug`` field of the event to fetch
+   :statuscode 202: no error
+   :statuscode 400: Invalid input options
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
+
 
 .. _here: https://github.com/pretix/pretix/blob/master/src/pretix/static/schema/pdf-layout.schema.json

doc/api/resources/transactions.rst

@@ -0,0 +1,232 @@
+.. _rest-transactions:
+
+Transactions
+============
+
+Transactions are an additional way to think about orders. They are are an immutable, filterable view into an order's
+history and are a good basis for financial reporting.
+
+Our financial model
+-------------------
+
+You can think of a pretix order similar to a debtor account in double-entry bookkeeping. For example, the flow of an
+order could look like this:
+
+===================================================== ==================== =====================
+Transaction                                           Debit                Credit
+===================================================== ==================== =====================
+Order is placed with two tickets                      € 500
+Order is paid partially with a gift card                                   € 200
+Remainder is paid with a credit card                                       € 300
+One of the tickets is canceled                        **-** € 250
+Refund is made to the credit card                                          **-** € 250
+**Balance**                                           **€ 250**            **€ 250**
+===================================================== ==================== =====================
+
+If an order is fully settled, the sums of both columns match. However, as the movements in both columns do not always
+happen at the same time, at some times during the lifecycle of an order the sums are not balanced, in which case we
+consider an order to be "pending payment" or "overpaid".
+
+In the API, the "Debit" column is represented by the "transaction" resource listed on this page.
+In many cases, the left column *usually* also matches the data returned by the :ref:`rest-invoices` resource, but there
+are two important differences:
+
+- pretix may be configured such that an invoice is not always generated for an order. In this case, only the transactions
+  return the full data set.
+
+- pretix does not enforce a new invoice to be created e.g. when a ticket is changed to a different subevent. However,
+  pretix always creates a new transaction whenever there is a change to a ticket that concerns the **price**, **tax rate**,
+  **product**, or **date** (in an event series).
+
+The :ref:`rest-orders` themselves are not a good representation of the "Debit" side of the table for accounting
+purposes since they are not immutable:
+They will only tell you the current state of the order, not what it was a week ago.
+
+The "Credit" column is represented by the :ref:`order-payment-resource` and :ref:`order-refund-resource`.
+
+
+Resource description
+--------------------
+
+.. rst-class:: rest-resource-table
+
+===================================== ========================== =======================================================
+Field                                 Type                       Description
+===================================== ========================== =======================================================
+id                                    integer                    Internal ID of the transaction
+order                                 string                     Order code the transaction was created from
+event                                 string                     Event slug, only present on organizer-level API calls
+created                               datetime                   The creation time of the transaction in the database
+datetime                              datetime                   The time at which the transaction is financially relevant.
+                                                                 This is usually the same as created, but may vary for
+                                                                 retroactively created transactions after software bugs or
+                                                                 for data that preceeds this data model.
+positionid                            integer                    Number of the position within the order this refers to,
+                                                                 is ``null`` for transactions that refer to a fee
+count                                 integer                    Number of items purchased, is negative for cancellations
+item                                  integer                    The internal ID of the item purchased (or ``null`` for fees)
+variation                             integer                    The internal ID of the variation purchased (or ``null``)
+subevent                              integer                    The internal ID of the event series date (or ``null``)
+price                                 money (string)             Gross price of the transaction
+tax_rate                              decimal (string)           Tax rate applied in transaction
+tax_rule                              integer                    The internal ID of the tax rule used (or ``null``)
+tax_code                              string                     The selected tax code (or ``null``)
+tax_value                             money (string)             The computed tax value
+fee_type                              string                     The type of fee (or ``null`` for products)
+internal_type                         string                     Additional type classification of the fee (or ``null`` for products)
+===================================== ========================== =======================================================
+
+.. versionchanged:: 2025.7.0
+
+   This resource was added to the API.
+
+
+Endpoints
+---------
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/transactions/
+
+   Returns a list of all transactions of an event.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/transactions/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "count": 1,
+        "next": null,
+        "previous": null,
+        "results": [
+          {
+            "id": 123,
+            "order": "FOO",
+            "count": 1,
+            "created": "2017-12-01T10:00:00Z",
+            "datetime": "2017-12-01T10:00:00Z",
+            "item": null,
+            "variation": null,
+            "positionid": 1,
+            "price": "23.00",
+            "subevent": null,
+            "tax_code": "E",
+            "tax_rate": "0.00",
+            "tax_rule": 23,
+            "tax_value": "0.00",
+            "fee_type": null,
+            "internal_type": null
+          }
+        ]
+      }
+
+   :query integer page: The page number in case of a multi-page result set, default is 1
+   :query string order: Only return transactions matching the given order code.
+   :query datetime_since: Only return transactions with a datetime at or after the given time.
+   :query datetime_before: Only return transactions with a datetime before the given time.
+   :query created_since: Only return transactions with a creation time at or after the given time.
+   :query created_before: Only return transactions with a creation time before the given time.
+   :query item: Only return transactions that match the given item ID.
+   :query item__in: Only return transactions that match one of the given item IDs (separated with a comma).
+   :query variation: Only return transactions that match the given variation ID.
+   :query variation__in: Only return transactions that match one of the given variation IDs (separated with a comma).
+   :query subevent: Only return transactions that match the given subevent ID.
+   :query subevent__in: Only return transactions that match one of the given subevent IDs (separated with a comma).
+   :query tax_rule: Only return transactions that match the given tax rule ID.
+   :query tax_rule__in: Only return transactions that match one of the given tax rule IDs (separated with a comma).
+   :query tax_code: Only return transactions that match the given tax code.
+   :query tax_code__in: Only return transactions that match one of the given tax codes (separated with a comma).
+   :query tax_rate: Only return transactions that match the given tax rate.
+   :query tax_rate__in: Only return transactions that match one of the given tax rates (separated with a comma).
+   :query fee_type: Only return transactions that match the given fee type.
+   :query fee_type__in: Only return transactions that match one of the given fee types (separated with a comma).
+   :query string ordering: Manually set the ordering of results. Valid fields to be used are ``datetime``, ``created``, and ``id``.
+   :param organizer: The ``slug`` field of a valid organizer
+   :param event: The ``slug`` field of a valid event
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer or event does not exist **or** you have no permission to view it.
+
+.. http:get:: /api/v1/organizers/(organizer)/transactions/
+
+   Returns a list of all transactions of an organizer that you have access to.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/transactions/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "count": 1,
+        "next": null,
+        "previous": null,
+        "results": [
+          {
+            "id": 123,
+            "event": "sampleconf",
+            "order": "FOO",
+            "count": 1,
+            "created": "2017-12-01T10:00:00Z",
+            "datetime": "2017-12-01T10:00:00Z",
+            "item": null,
+            "variation": null,
+            "positionid": 1,
+            "price": "23.00",
+            "subevent": null,
+            "tax_code": "E",
+            "tax_rate": "0.00",
+            "tax_rule": 23,
+            "tax_value": "0.00",
+            "fee_type": null,
+            "internal_type": null
+          }
+        ]
+      }
+
+   :query integer page: The page number in case of a multi-page result set, default is 1
+   :query string event: Only return transactions matching the given event slug.
+   :query string order: Only return transactions matching the given order code.
+   :query datetime_since: Only return transactions with a datetime at or after the given time.
+   :query datetime_before: Only return transactions with a datetime before the given time.
+   :query created_since: Only return transactions with a creation time at or after the given time.
+   :query created_before: Only return transactions with a creation time before the given time.
+   :query item: Only return transactions that match the given item ID.
+   :query item__in: Only return transactions that match one of the given item IDs (separated with a comma).
+   :query variation: Only return transactions that match the given variation ID.
+   :query variation__in: Only return transactions that match one of the given variation IDs (separated with a comma).
+   :query subevent: Only return transactions that match the given subevent ID.
+   :query subevent__in: Only return transactions that match one of the given subevent IDs (separated with a comma).
+   :query tax_rule: Only return transactions that match the given tax rule ID.
+   :query tax_rule__in: Only return transactions that match one of the given tax rule IDs (separated with a comma).
+   :query tax_code: Only return transactions that match the given tax code.
+   :query tax_code__in: Only return transactions that match one of the given tax codes (separated with a comma).
+   :query tax_rate: Only return transactions that match the given tax rate.
+   :query tax_rate__in: Only return transactions that match one of the given tax rates (separated with a comma).
+   :query fee_type: Only return transactions that match the given fee type.
+   :query fee_type__in: Only return transactions that match one of the given fee types (separated with a comma).
+   :query string ordering: Manually set the ordering of results. Valid fields to be used are ``datetime``, ``created``, and ``id``.
+   :param organizer: The ``slug`` field of a valid organizer
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to view it.

doc/api/resources/vouchers.rst

@@ -14,6 +14,7 @@ The voucher resource contains the following public fields:
 Field                                 Type                       Description
 ===================================== ========================== =======================================================
 id                                    integer                    Internal ID of the voucher
+created                               datetime                   The creation date of the voucher. For vouchers created before pretix 2025.7.0, this is guessed retroactively and might not be accurate.
 code                                  string                     The voucher code that is required to redeem the voucher
 max_usages                            integer                    The maximum number of times this voucher can be
                                                                  redeemed (default: 1).
@@ -49,8 +50,14 @@ subevent                              integer                    ID of the date
 show_hidden_items                     boolean                    Only if set to ``true``, this voucher allows to buy products with the property ``hide_without_voucher``. Defaults to ``true``.
 all_addons_included                   boolean                    If set to ``true``, all add-on products for the product purchased with this voucher are included in the base price.
 all_bundles_included                  boolean                    If set to ``true``, all bundled products for the product purchased with this voucher are added without their designated price.
+budget                                money (string)             The budget a voucher is allowed to consume before being used up (or ``null``)
+budget_used                           money (string)             The amount of budget the voucher has already used up.
 ===================================== ========================== =======================================================
 
+.. versionchanged:: 2025.7
+
+    The attributes ``created``, ``budget``, and ``budget_used`` have been added.
+
 
 Endpoints
 ---------
@@ -82,6 +89,7 @@ Endpoints
         "results": [
           {
             "id": 1,
+            "created": "2020-09-18T14:17:40.971519Z",
             "code": "43K6LKM37FBVR2YG",
             "max_usages": 1,
             "redeemed": 0,
@@ -99,7 +107,9 @@ Endpoints
             "subevent": null,
             "show_hidden_items": false,
             "all_addons_included": false,
-            "all_bundles_included": false
+            "all_bundles_included": false,
+            "budget": None,
+            "budget_used": "0.00"
           }
         ]
       }
@@ -152,6 +162,7 @@ Endpoints
 
       {
         "id": 1,
+        "created": "2020-09-18T14:17:40.971519Z",
         "code": "43K6LKM37FBVR2YG",
         "max_usages": 1,
         "redeemed": 0,
@@ -169,7 +180,9 @@ Endpoints
         "subevent": null,
         "show_hidden_items": false,
         "all_addons_included": false,
-        "all_bundles_included": false
+        "all_bundles_included": false,
+        "budget": None,
+        "budget_used": "0.00"
       }
 
    :param organizer: The ``slug`` field of the organizer to fetch
@@ -222,6 +235,7 @@ Endpoints
 
       {
         "id": 1,
+        "created": "2020-09-18T14:17:40.971519Z",
         "code": "43K6LKM37FBVR2YG",
         "max_usages": 1,
         "redeemed": 0,
@@ -239,7 +253,9 @@ Endpoints
         "subevent": null,
         "show_hidden_items": false,
         "all_addons_included": false,
-        "all_bundles_included": false
+        "all_bundles_included": false,
+        "budget": None,
+        "budget_used": "0.00"
       }
 
    :param organizer: The ``slug`` field of the organizer to create a voucher for
@@ -313,6 +329,7 @@ Endpoints
       [
         {
           "id": 1,
+          "created": "2020-09-18T14:17:40.971519Z",
           "code": "43K6LKM37FBVR2YG",
           …
         }, …
@@ -359,6 +376,7 @@ Endpoints
 
       {
         "id": 1,
+        "created": "2020-09-18T14:17:40.971519Z",
         "code": "43K6LKM37FBVR2YG",
         "max_usages": 1,
         "redeemed": 0,
@@ -376,7 +394,9 @@ Endpoints
         "subevent": null,
         "show_hidden_items": false,
         "all_addons_included": false,
-        "all_bundles_included": false
+        "all_bundles_included": false,
+        "budget": None,
+        "budget_used": "0.00"
       }
 
    :param organizer: The ``slug`` field of the organizer to modify

doc/api/resources/webhooks.rst

@@ -41,6 +41,7 @@ The following values for ``action_types`` are valid with pretix core:
     * ``pretix.event.order.modified``
     * ``pretix.event.order.contact.changed``
     * ``pretix.event.order.changed.*``
+    * ``pretix.event.order.deleted`` (can only occur for test mode orders)
     * ``pretix.event.order.refund.created``
     * ``pretix.event.order.refund.created.externally``
     * ``pretix.event.order.refund.requested``
@@ -59,6 +60,9 @@ The following values for ``action_types`` are valid with pretix core:
     * ``pretix.event.added``
     * ``pretix.event.changed``
     * ``pretix.event.deleted``
+    * ``pretix.voucher.added``
+    * ``pretix.voucher.changed``
+    * ``pretix.voucher.deleted``
     * ``pretix.subevent.added``
     * ``pretix.subevent.changed``
     * ``pretix.subevent.deleted``
@@ -115,6 +119,7 @@ Endpoints
       }
 
    :query integer page: The page number in case of a multi-page result set, default is 1
+   :query boolean enabled: Only show webhooks that are or are not enabled
    :param organizer: The ``slug`` field of the organizer to fetch
    :statuscode 200: no error
    :statuscode 401: Authentication failure

doc/conf.py

@@ -69,7 +69,7 @@ master_doc = 'index'
 
 # General information about the project.
 project = 'pretix'
-copyright = '2014-{}, Raphael Michel'.format(date.today().year)
+copyright = '2014-{}, rami.io GmbH'.format(date.today().year)
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -233,8 +233,8 @@ latex_elements = {
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    ('index', 'pretix.tex', 'pretix Documentation',
-     'Raphael Michel', 'manual'),
+    ('index', 'pretix.tex', 'pretix Developer Documentation',
+     'rami.io GmbH', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -263,8 +263,8 @@ latex_documents = [
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'pretix', 'pretix Documentation',
-     ['Raphael Michel'], 1)
+    ('index', 'pretix', 'pretix Developer Documentation',
+     ['rami.io GmbH'], 1)
 ]
 
 # If true, show URL addresses after external links.
@@ -277,8 +277,8 @@ man_pages = [
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    ('index', 'pretix', 'pretix Documentation',
-     'Raphael Michel', 'pretix', 'One line description of project.',
+    ('index', 'pretix', 'pretix Developer Documentation',
+     'rami.io GmbH', 'pretix', 'One line description of project.',
      'Miscellaneous'),
 ]
 

doc/contents.rst

@@ -4,10 +4,6 @@ Table of contents
 .. toctree::
    :maxdepth: 3
 
-   user/index
-   admin/index
    api/index
    development/index
-   plugins/index
-   license/faq
 

doc/development/api/cookieconsent.rst

@@ -17,6 +17,7 @@ First, you need to declare that you are using non-essential cookies by respondin
 signal:
 
 .. automodule:: pretix.presale.signals
+   :no-index:
    :members: register_cookie_providers
 
 You are expected to return a list of ``CookieProvider`` objects instantiated from the following class:

doc/development/api/customview.rst

@@ -178,13 +178,6 @@ You can then implement a view as you would normally do. It will be automatically
 * Your plugin is enabled
 * The locale is set correctly
 
-.. versionchanged:: 1.7
-
-   The ``event_url()`` wrapper has been added in 1.7 to replace the former ``@event_view`` decorator. The
-   ``event_url()`` wrapper is optional and using ``url()`` still works, but you will not be able to set the
-   ``require_live`` setting any more via the decorator. The ``@event_view`` decorator is now deprecated and
-   does nothing.
-
 REST API viewsets
 -----------------
 

doc/development/api/datasync.rst

@@ -0,0 +1,207 @@
+.. highlight:: python
+   :linenothreshold: 5
+
+Data sync providers
+===================
+
+.. warning:: This feature is considered **experimental**. It might change at any time without prior notice.
+
+pretix provides connectivity to many external services through plugins. A common requirement
+is unidirectionally sending (order, customer, ticket, ...) data into external systems.
+The transfer is usually triggered by signals provided by pretix core (e.g. :data:`order_placed`),
+but performed asynchronously.
+
+Such plugins should use the :class:`OutboundSyncProvider` API to utilize the queueing, retry and mapping 
+mechanisms as well as the user interface for configuration and monitoring. Sync providers are registered 
+in the :py:attr:`pretix.base.datasync.datasync.datasync_providers` :ref:`registry <registries>`.
+
+An :class:`OutboundSyncProvider` for subscribing event participants to a mailing list could start
+like this, for example:
+
+.. code-block:: python
+
+    from pretix.base.datasync.datasync import (OutboundSyncProvider, datasync_providers)
+
+    @datasync_providers.register
+    class MyListSyncProvider(OutboundSyncProvider):
+        identifier = "my_list"
+        display_name = "My Mailing List Service"
+        # ...
+
+
+The plugin must register listeners in `signals.py` for all signals that should to trigger a sync and
+within it has to call :meth:`MyListSyncProvider.enqueue_order` to enqueue the order for synchronization:
+
+.. code-block:: python
+
+    @receiver(order_placed, dispatch_uid="mylist_order_placed")
+    def on_order_placed(sender, order, **kwargs):
+        MyListSyncProvider.enqueue_order(order, "order_placed")
+
+
+Property mappings
+-----------------
+
+Most of these plugins need to translate data from some pretix objects (e.g. orders)
+into an external system's data structures. Sometimes, there is only one reasonable way or the
+plugin author makes an opinionated decision what information from which objects should be
+transferred into which data structures in the external system.
+
+Otherwise, you can use a :class:`PropertyMappingFormSet` to let the user set up a mapping from pretix model fields
+to external data fields. You could store the mapping information either in the event settings, or in a separate
+data model. Your implementation of :attr:`OutboundSyncProvider.mappings`
+needs to provide a list of mappings, which can be e.g. static objects or model instances, as long as they
+have at least the properties defined in
+:class:`pretix.base.datasync.datasync.StaticMapping`.
+
+.. code-block:: python
+
+    # class MyListSyncProvider, contd.
+        def mappings(self):
+            return [
+                StaticMapping(
+                    id=1, pretix_model='Order', external_object_type='Contact',
+                    pretix_id_field='email', external_id_field='email',
+                    property_mappings=self.event.settings.mylist_order_mapping,
+                ))
+            ]
+
+
+Currently, we support `orders` and `order positions` as data sources, with the data fields defined in
+:func:`pretix.base.datasync.sourcefields.get_data_fields`.
+
+To perform the actual sync, implement :func:`sync_object_with_properties` and optionally
+:func:`finalize_sync_order`. The former is called for each object to be created according to the ``mappings``.
+For each order that was enqueued using :func:`enqueue_order`:
+
+- each Mapping with ``pretix_model == "Order"`` results in one call to :func:`sync_object_with_properties`,
+- each Mapping with ``pretix_model == "OrderPosition"`` results in one call to
+  :func:`sync_object_with_properties` per order position,
+- :func:`finalize_sync_order` is called one time after all calls to :func:`sync_object_with_properties`.
+
+
+Implementation examples
+-----------------------
+
+For example implementations, see the test cases in :mod:`tests.base.test_datasync`.
+
+In :class:`SimpleOrderSync`, a basic data transfer of order data only is
+shown. Therein, a ``sync_object_with_properties`` method is defined as follows:
+
+.. code-block:: python
+
+    from pretix.base.datasync.utils import assign_properties
+
+    # class MyListSyncProvider, contd.
+    def sync_object_with_properties(
+            self, external_id_field, id_value, properties: list, inputs: dict,
+            mapping, mapped_objects: dict, **kwargs,
+    ):
+        # First, we query the external service if our object-to-sync already exists there.
+        # This is necessary to make sure our method is idempotent, i.e. handles already synced
+        # data gracefully.
+        pre_existing_object = self.fake_api_client.retrieve_object(
+            mapping.external_object_type,
+            external_id_field,
+            id_value
+        )
+
+        # We use the helper function ``assign_properties`` to update a pre-existing object.
+        update_values = assign_properties(
+            new_values=properties,
+            old_values=pre_existing_object or {},
+            is_new=pre_existing_object is None,
+            list_sep=";",
+        )
+
+        # Then we can send our new data to the external service. The specifics of course depends
+        # on your API, e.g. you may need to use different endpoints for creating or updating an
+        # object, or pass the identifier separately instead of in the same dictionary as the
+        # other properties.
+        result = self.fake_api_client.create_or_update_object(mapping.external_object_type, {
+            **update_values,
+            external_id_field: id_value,
+            "_id": pre_existing_object and pre_existing_object.get("_id"),
+        })
+
+        # Finally, return a dictionary containing at least `object_type`, `external_id_field`,
+        # `id_value`, `external_link_href`, and `external_link_display_name` keys.
+        # Further keys may be provided for your internal use. This dictionary is provided
+        # in following calls in the ``mapped_objects`` dict, to allow creating associations
+        # to this object.
+        return {
+            "object_type": mapping.external_object_type,
+            "external_id_field": external_id_field,
+            "id_value": id_value,
+            "external_link_href": f"https://example.org/external-system/{mapping.external_object_type}/{id_value}/",
+            "external_link_display_name": f"Contact #{id_value} - Jane Doe",
+            "my_result": result,
+        }
+
+.. note:: The result dictionaries of earlier invocations of :func:`sync_object_with_properties` are
+          only provided in subsequent calls of the same sync run, such that a mapping can
+          refer to e.g. the external id of an object created by a preceding mapping.
+          However, the result dictionaries are currently not provided across runs. This will
+          likely change in a future revision of this API, to allow easier integration of external
+          systems that do not allow retrieving/updating data by a pretix-provided key.
+
+``mapped_objects`` is a dictionary of lists of dictionaries. The keys to the dictionary are
+the mapping identifiers (``mapping.id``), the lists contain the result dictionaries returned
+by :func:`sync_object_with_properties`.
+
+
+In :class:`OrderAndTicketAssociationSync`, an example is given where orders, order positions,
+and the association between them are transferred.
+
+
+The OutboundSyncProvider base class
+-----------------------------------
+
+.. autoclass:: pretix.base.datasync.datasync.OutboundSyncProvider
+   :members:
+
+
+Property mapping format
+-----------------------
+
+To allow the user to configure property mappings, you can use the PropertyMappingFormSet,
+which will generate the required ``property_mappings`` value automatically. If you need
+to specify the property mappings programmatically, you can refer to the description below
+on their format.
+
+.. autoclass:: pretix.control.forms.mapping.PropertyMappingFormSet
+   :members: to_property_mappings_json
+
+A simple JSON-serialized ``property_mappings`` list for mapping some order information can look like this:
+
+.. code-block:: json
+
+      [
+        {
+            "pretix_field": "email",
+            "external_field": "orderemail",
+            "value_map": "",
+            "overwrite": "overwrite",
+        },
+        {
+            "pretix_field": "order_status",
+            "external_field": "status",
+            "value_map": "{\"n\": \"pending\", \"p\": \"paid\", \"e\": \"expired\", \"c\": \"canceled\", \"r\": \"refunded\"}",
+            "overwrite": "overwrite",
+        },
+        {
+            "pretix_field": "order_total",
+            "external_field": "total",
+            "value_map": "",
+            "overwrite": "overwrite",
+        }
+      ]
+
+
+Translating mappings on Event copy
+----------------------------------
+
+Property mappings can contain references to event-specific primary keys. Therefore, plugins must register to the
+event_copy_data signal and call translate_property_mappings on all property mappings they store.
+
+.. autofunction:: pretix.base.datasync.utils.translate_property_mappings

doc/development/api/general.rst

@@ -12,9 +12,9 @@ Core
 
 .. automodule:: pretix.base.signals
    :members: periodic_task, event_live_issues, event_copy_data, email_filter, register_notification_types, notification,
-      item_copy_data, register_sales_channels, register_global_settings, quota_availability, global_email_filter,
+      item_copy_data, register_sales_channel_types, register_global_settings, quota_availability, global_email_filter,
       register_ticket_secret_generators, gift_card_transaction_display,
-      register_text_placeholders, register_mail_placeholders
+      register_text_placeholders, register_mail_placeholders, device_info_updated
 
 Order events
 """"""""""""
@@ -22,35 +22,40 @@ Order events
 There are multiple signals that will be sent out in the ordering cycle:
 
 .. automodule:: pretix.base.signals
-   :members: validate_cart, validate_cart_addons, validate_order, order_valid_if_pending, order_fee_calculation, order_paid, order_placed, order_canceled, order_reactivated, order_expired, order_modified, order_changed, order_approved, order_denied, order_fee_type_name, allow_ticket_download, order_split, order_gracefully_delete, invoice_line_text
+   :no-index:
+   :members: validate_cart, validate_cart_addons, validate_order, order_valid_if_pending, order_fee_calculation, order_paid, order_placed, order_canceled, order_reactivated, order_expired, order_expiry_changed, order_modified, order_changed, order_approved, order_denied, order_fee_type_name, allow_ticket_download, order_split, order_gracefully_delete, build_invoice_data, invoice_line_text
 
 Check-ins
 """""""""
 
 .. automodule:: pretix.base.signals
-   :members: checkin_created
+   :no-index:
+   :members: checkin_created, checkin_annulled
 
 
 Frontend
 --------
 
 .. automodule:: pretix.presale.signals
-   :members: html_head, html_footer, footer_link, global_footer_link, front_page_top, front_page_bottom, front_page_bottom_widget, fee_calculation_for_cart, contact_form_fields, question_form_fields, contact_form_fields_overrides, question_form_fields_overrides, checkout_confirm_messages, checkout_confirm_page_content, checkout_all_optional, html_page_header, render_seating_plan, checkout_flow_steps, position_info, position_info_top, item_description, global_html_head, global_html_footer, global_html_page_header
+   :members: html_head, html_footer, footer_link, global_footer_link, front_page_top, front_page_bottom, front_page_bottom_widget, fee_calculation_for_cart, contact_form_fields, question_form_fields, contact_form_fields_overrides, question_form_fields_overrides, checkout_confirm_messages, checkout_confirm_page_content, checkout_all_optional, html_page_header, render_seating_plan, checkout_flow_steps, position_info, position_info_top, item_description, global_html_head, global_html_footer, global_html_page_header, seatingframe_html_head, filter_subevents
 
 
 .. automodule:: pretix.presale.signals
-   :members: order_info, order_info_top, order_meta_from_request
+   :no-index:
+   :members: order_info, order_info_top, order_meta_from_request, order_api_meta_from_request
 
 Request flow
 """"""""""""
 
 .. automodule:: pretix.presale.signals
+   :no-index:
    :members: process_request, process_response
 
 Vouchers
 """"""""
 
 .. automodule:: pretix.presale.signals
+   :no-index:
    :members: voucher_redeem_info
 
 Backend
@@ -62,24 +67,28 @@ Backend
              item_formsets, order_search_filter_q, order_search_forms
 
 .. automodule:: pretix.base.signals
+   :no-index:
    :members: logentry_display, logentry_object_link, requiredaction_display, timeline_events, orderposition_blocked_display, customer_created, customer_signed_in
 
 Vouchers
 """"""""
 
 .. automodule:: pretix.control.signals
+   :no-index:
    :members: item_forms, voucher_form_class, voucher_form_html, voucher_form_validation
 
 Dashboards
 """"""""""
 
 .. automodule:: pretix.control.signals
+   :no-index:
    :members: event_dashboard_widgets, user_dashboard_widgets, event_dashboard_top
 
 Ticket designs
 """"""""""""""
 
 .. automodule:: pretix.base.signals
+   :no-index:
    :members: layout_text_variables, layout_image_variables
 
 .. automodule:: pretix.plugins.ticketoutputpdf.signals
@@ -89,4 +98,9 @@ API
 ---
 
 .. automodule:: pretix.base.signals
+   :no-index:
    :members: validate_event_settings, api_event_settings_fields
+
+.. automodule:: pretix.api.signals
+   :no-index:
+   :members: register_device_security_profile, order_api_details, orderposition_api_details

doc/development/api/import.rst

@@ -60,6 +60,7 @@ that we'll provide in this plugin:
 Similar signals exist for other objects:
 
 .. automodule:: pretix.base.signals
+   :no-index:
    :members: voucher_import_columns
 
 

doc/development/api/index.rst

@@ -10,14 +10,15 @@ Contents:
    exporter
    ticketoutput
    payment
-   payment_2.0
    email
    placeholder
    invoice
+   invoicetransmission
    shredder
    import
    customview
    cookieconsent
    auth
+   datasync
    general
    quality

doc/development/api/invoice.rst

@@ -84,8 +84,6 @@ convenient to you:
 
    .. automethod:: _register_fonts
 
-   .. automethod:: _register_event_fonts
-
    .. automethod:: _on_first_page
 
    .. automethod:: _on_other_page

doc/development/api/invoicetransmission.rst

@@ -0,0 +1,65 @@
+.. highlight:: python
+   :linenothreshold: 5
+
+Writing an invoice transmission plugin
+======================================
+
+An invoice transmission provider transports an invoice from the sender to the recipient.
+There are pre-defined types of invoice transmission in pretix, currently ``"email"``, ``"peppol"``, and ``"it_sdi"``.
+You can find more information about them at :ref:`rest-transmission-types`.
+
+New transmission types can not be added by plugins but need to be added to pretix itself.
+However, plugins can provide implementations for the actual transmission.
+Please read :ref:`Creating a plugin <pluginsetup>` first, if you haven't already.
+
+Output registration
+-------------------
+
+New invoice transmission providers can be registered through the :ref:`registry <registries>` mechanism
+
+.. code-block:: python
+
+   from pretix.base.invoicing.transmission import transmission_providers, TransmissionProvider
+
+   @transmission_providers.new()
+   class SdiTransmissionProvider(TransmissionProvider):
+       identifier = "fatturapa_providerabc"
+       type = "it_sdi"
+       verbose_name = _("FatturaPA through provider ABC")
+       ...
+
+
+The provider class
+------------------
+
+.. class:: pretix.base.invoicing.transmission.TransmissionProvider
+
+   .. autoattribute:: identifier
+
+      This is an abstract attribute, you **must** override this!
+
+   .. autoattribute:: type
+
+      This is an abstract attribute, you **must** override this!
+
+   .. autoattribute:: verbose_name
+
+      This is an abstract attribute, you **must** override this!
+
+   .. autoattribute:: priority
+
+   .. autoattribute:: testmode_supported
+
+   .. automethod:: is_ready
+
+      This is an abstract method, you **must** override this!
+
+   .. automethod:: is_available
+
+      This is an abstract method, you **must** override this!
+
+   .. automethod:: transmit
+
+      This is an abstract method, you **must** override this!
+
+   .. automethod:: settings_url

doc/development/api/payment_2.0.rst

@@ -1,129 +0,0 @@
-.. highlight:: python
-   :linenothreshold: 5
-
-.. _`payment2.0`:
-
-Porting a payment provider from pretix 1.x to pretix 2.x
-========================================================
-
-In pretix 2.x, we changed large parts of the payment provider API. This documentation details the changes we made
-and shows you how you can make an existing pretix 1.x payment provider compatible with pretix 2.x
-
-Conceptual overview
--------------------
-
-In pretix 1.x, an order was always directly connected to a payment provider for the full life of an order. As long as
-an order was unpaid, this could still be changed in some cases, but once an order was paid, no changes to the payment
-provider were possible any more. Additionally, the internal state of orders allowed orders only to be fully paid or
-not paid at all. This leads to a couple of consequences:
-
-* Payment-related functions (like "execute payment" or "do a refund") always operated on full orders.
-
-* Changing the total of an order was basically impossible once an order was paid, since there was no concept of
-  partial payments or partial refunds.
-
-* Payment provider plugins needed to take complicated steps to detect cases that require human intervention, like e.g.
-
-  * An order has expired, no quota is left to revive it, but a payment has been received
-
-  * A payment has been received for a canceled order
-
-  * A payment has been received for an order that has already been paid with a different payment method
-
-  * An external payment service notified us of a refund/dispute
-
-  We noticed that we copied and repeated large portions of code in all our official payment provider plugins, just
-  to deal with some of these cases.
-
-* Sometimes, there is the need to mark an order as refunded within pretix, without automatically triggering a refund
-  with an external API. Every payment method needed to implement a user interface for this independently.
-
-* If a refund was not possible automatically, there was no way user to track which payments actually have been refunded
-  manually and which are still left to do.
-
-* When the payment with one payment provider failed and the user changed to a different payment provider, all
-  information about the first payment was lost from the order object and could only be retrieved from order log data,
-  which also made it hard to design a data shredder API to get rid of this data.
-
-In pretix 2.x, we introduced two new models, :py:class:`OrderPayment <pretix.base.models.OrderPayment>` and
-:py:class:`OrderRefund <pretix.base.models.OrderRefund>`. Each instance of these is connected to an order and
-represents one single attempt to pay or refund a specific amount of money. Each one of these has an individual state,
-can individually fail or succeed, and carries an amount variable that can differ from the order total.
-
-This has the following advantages:
-
-* The system can now detect orders that are over- or underpaid, independent of the payment providers in use.
-
-* Therefore, we can now allow partial payments, partial refunds, and changing paid orders, and automatically detect
-  the cases listed above and notify the user.
-
-Payment providers now interact with those payment and refund objects more than with orders.
-
-Your to-do list
----------------
-
-Payment processing
-""""""""""""""""""
-
-* The method ``BasePaymentProvider.order_pending_render`` has been removed and replaced by a new
-  ``BasePaymentProvider.payment_pending_render(request, payment)`` method that is passed an ``OrderPayment``
-  object instead of an ``Order``.
-
-* The method ``BasePaymentProvider.payment_form_render`` now receives a new ``total`` parameter.
-
-* The method ``BasePaymentProvider.payment_perform`` has been removed and replaced by a new method
-  ``BasePaymentProvider.execute_payment(request, payment)`` that is passed an ``OrderPayment``
-  object instead of an ``Order``.
-
-* The function ``pretix.base.services.mark_order_paid`` has been removed, instead call ``payment.confirm()``
-  on a pending ``OrderPayment`` object. If no further payments are required for this order, this will also
-  mark the order as paid automatically. Note that ``payment.confirm()`` can still throw a ``QuotaExceededException``,
-  however it will still mark the payment as complete (not the order!), so you should catch this exception and
-  inform the user, but not abort the transaction.
-
-* A new property ``BasePaymentProvider.abort_pending_allowed`` has been introduced. Only if set, the user will
-  be able to retry a payment or switch the payment method when the order currently has a payment object in
-  state ``"pending"``. This replaces ``BasePaymentProvider.order_can_retry``, which no longer exists.
-
-* The methods ``BasePaymentProvider.retry_prepare`` and ``BasePaymentProvider.order_prepare`` have both been
-  replaced by a new method ``BasePaymentProvider.payment_prepare(request, payment)`` that is passed an ``OrderPayment``
-  object instead of an ``Order``. **Keep in mind that this payment object might have an amount property that
-  differs from the order total, if the order is already partially paid.**
-
-* The method ``BasePaymentProvider.order_paid_render`` has been removed.
-
-* The method ``BasePaymentProvider.order_control_render`` has been removed and replaced by a new method
-  ``BasePaymentProvider.payment_control_render(request, payment)`` that is passed an ``OrderPayment``
-  object instead of an ``Order``.
-
-* There's no need to manually deal with excess payments or duplicate payments anymore, just setting the ``OrderPayment``
-  methods to the correct state will do the job.
-
-Creating refunds
-""""""""""""""""
-
-* The methods ``BasePaymentProvider.order_control_refund_render`` and ``BasePaymentProvider.order_control_refund_perform``
-  have been removed.
-
-* Two new boolean methods ``BasePaymentProvider.payment_refund_supported(payment)`` and ``BasePaymentProvider.payment_partial_refund_supported(payment)``
-  have been introduced. They should be set to return ``True`` if and only if the payment API allows to *automatically*
-  transfer the money back to the customer.
-
-* A new method ``BasePaymentProvider.execute_refund(refund)`` has been introduced. This method is called using a
-  ``OrderRefund`` object in ``"created"`` state and is expected to transfer the money back and confirm success with
-  calling ``refund.done()``. This will only ever be called if either ``BasePaymentProvider.payment_refund_supported(payment)``
-  or ``BasePaymentProvider.payment_partial_refund_supported(payment)`` return ``True``.
-
-Processing external refunds
-"""""""""""""""""""""""""""
-
-* If e.g. a webhook API notifies you that a payment has been disputed or refunded with the external API, you are
-  expected to call ``OrderPayment.create_external_refund(self, amount, execution_date, info='{}')`` on this payment.
-  This will create and return an appropriate ``OrderRefund`` object and send out a notification. However, it will not
-  mark the order as refunded, but will ask the event organizer for a decision.
-
-Data shredders
-""""""""""""""
-
-* The method ``BasePaymentProvider.shred_payment_info`` is no longer passed an order, but instead **either**
-  an ``OrderPayment`` **or** an ``OrderRefund``.

doc/development/api/placeholder.rst

@@ -86,7 +86,10 @@ Signals
 -------
 
 .. automodule:: pretix.base.signals
+   :no-index:
    :members: register_text_placeholders
+
 .. automodule:: pretix.base.signals
+   :no-index:
    :members: register_mail_placeholders
 

doc/development/api/plugins.rst

@@ -56,6 +56,20 @@ restricted         boolean (optional)   ``False`` by default, restricts a plugin
                                         for an event by system administrators / superusers.
 experimental       boolean (optional)   ``False`` by default, marks a plugin as an experimental feature in the plugins list.
 compatibility      string               Specifier for compatible pretix versions.
+level              string               System level the plugin can be activated at.
+                                        Set to ``pretix.base.plugins.PLUGIN_LEVEL_EVENT`` for plugins that can be activated
+                                        at event level and then be active for that event only.
+                                        Set to ``pretix.base.plugins.PLUGIN_LEVEL_ORGANIZER`` for plugins that can be
+                                        activated only for the organizer as a whole and are active for any event within
+                                        that organizer.
+                                        Set to ``pretix.base.plugins.PLUGIN_LEVEL_EVENT_ORGANIZER_HYBRID`` for plugins that
+                                        can be activated at organizer level but are considered active only within events
+                                        for which they have also been specifically activated.
+                                        More levels, e.g. user-level plugins, might be invented in the future.
+settings_links     list                 List of ``((menu name, submenu name, …), urlname, url_kwargs)`` tuples that point
+                                        to the plugin's settings.
+navigation_links   list                 List of ``((menu name, submenu name, …), urlname, url_kwargs)`` tuples that point
+                                        to the plugin's system pages.
 ================== ==================== ===========================================================
 
 A working example would be:
@@ -63,9 +77,9 @@ A working example would be:
 .. code-block:: python
 
     try:
-        from pretix.base.plugins import PluginConfig
+        from pretix.base.plugins import PluginConfig, PLUGIN_LEVEL_EVENT
     except ImportError:
-        raise RuntimeError("Please use pretix 2.7 or above to run this plugin!")
+        raise RuntimeError("Please use pretix 2025.7 or above to run this plugin!")
     from django.utils.translation import gettext_lazy as _
 
 
@@ -79,11 +93,14 @@ A working example would be:
             version = '1.0.0'
             category = 'PAYMENT'
             picture = 'pretix_paypal/paypal_logo.svg'
+            level = PLUGIN_LEVEL_EVENT
             visible = True
             featured = False
             restricted = False
             description = _("This plugin allows you to receive payments via PayPal")
             compatibility = "pretix>=2.7.0"
+            settings_links = []
+            navigation_links = []
 
 
     default_app_config = 'pretix_paypal.PaypalApp'
@@ -121,6 +138,7 @@ This will automatically make pretix discover this plugin as soon as it is instal
 through ``pip``. During development, you can just run ``python setup.py develop`` inside
 your plugin source directory to make it discoverable.
 
+.. _`signals`:
 Signals
 -------
 
@@ -139,20 +157,39 @@ method to make your receivers available:
             from . import signals  # NOQA
 
 You can optionally specify code that is executed when your plugin is activated for an event
-in the ``installed`` method:
+or organizer in the ``installed`` method:
 
 .. code-block:: python
 
     class PaypalApp(AppConfig):
         …
 
-        def installed(self, event):
+        def installed(self, event_or_organizer):
             pass  # Your code here
 
 
 Note that ``installed`` will *not* be called if the plugin is indirectly activated for an event
 because the event is created with settings copied from another event.
 
+.. _`registries`:
+Registries
+----------
+
+Many signals in pretix are used so that plugins can "register" a class, e.g. a payment provider or a
+ticket renderer.
+
+However, for some of them (types of :ref:`Log Entries <logging>`) we use a different method to keep track of them:
+In a ``Registry``, classes are collected at application startup, along with a unique key (in case
+of LogEntryType, the ``action_type``) as well as which plugin registered them.
+
+To register a class, you can use one of several decorators provided by the Registry object:
+
+.. autoclass:: pretix.base.logentrytypes.LogEntryTypeRegistry
+   :members: register, new, new_from_dict
+
+All files in which classes are registered need to be imported in the ``AppConfig.ready`` as explained
+in `Signals <signals>`_ above.
+
 Views
 -----
 
@@ -165,6 +202,28 @@ your Django app label.
    with checking that the calling user is logged in, has appropriate permissions,
    etc. We plan on providing native support for this in a later version.
 
+To make your plugin views easily discoverable, you can specify links for "Go to"
+and "Settings" buttons next to your entry on the plugin page. These links should be
+added to the ``navigation_links`` and ``settings_links``, respectively, in the
+``PretixPluginMeta`` class.
+
+Each array entry consists of a tuple ``(label, urlname, kwargs)``. For the label,
+either a string or a tuple of strings can be specified. In the latter case, the provided
+strings will be merged with a separator indicating they are successive navigation steps
+the user would need to take to reach the page via the regular menu
+(e.g. "Payment > Bank transfer" as below).
+
+.. code-block:: python
+
+        settings_links = [
+            ((_("Payment"), _("Bank transfer")), "control:event.settings.payment.provider", {"provider": "banktransfer"}),
+        ]
+        navigation_links = [
+            ((_("Bank transfer"), _("Import bank data")), "plugins:banktransfer:import", {}),
+            ((_("Bank transfer"), _("Export refunds")), "plugins:banktransfer:refunds.list", {}),
+        ]
+
+
 .. _Django app: https://docs.djangoproject.com/en/3.0/ref/applications/
 .. _signal dispatcher: https://docs.djangoproject.com/en/3.0/topics/signals/
 .. _namespace packages: https://legacy.python.org/dev/peps/pep-0420/

doc/development/concepts.rst

@@ -17,7 +17,7 @@ The project pretix is split into several components. The main components are:
     create and manage their events, items, orders and tickets.
 
 **presale**
-    This is the ticket-shop itself, containing all of the parts visible to the
+    This is the ticket shop itself, containing all of the parts visible to the
     end user. Also called "frontend" in parts of this documentation.
 
 **api**

doc/development/implementation/logging.rst

@@ -20,7 +20,8 @@ To actually log an action, you can just call the ``log_action`` method on your o
 
 .. code-block:: python
 
-   order.log_action('pretix.event.order.canceled', user=user, data={})
+   order.log_action('pretix.event.order.comment', user=user,
+                    data={"new_comment": "Hello, world."})
 
 The positional ``action`` argument should represent the type of action and should be globally unique, we
 recommend to prefix it with your package name, e.g. ``paypal.payment.rejected``. The ``user`` argument is
@@ -72,24 +73,101 @@ following ready-to-include template::
    {% include "pretixcontrol/includes/logs.html" with obj=order %}
 
 We now need a way to translate the action codes like ``pretix.event.changed`` into human-readable
-strings. The :py:attr:`pretix.base.signals.logentry_display` signals allows you to do so. A simple
+strings. The :py:attr:`pretix.base.logentrytypes.log_entry_types` :ref:`registry <registries>` allows you to do so. A simple
 implementation could look like:
 
 .. code-block:: python
 
     from django.utils.translation import gettext as _
-    from pretix.base.signals import logentry_display
+    from pretix.base.logentrytypes import log_entry_types
+
+
+    @log_entry_types.new_from_dict({
+        'pretix.event.order.comment': _('The order\'s internal comment has been updated to: {new_comment}'),
+        'pretix.event.order.paid': _('The order has been marked as paid.'),
+        # ...
+    })
+    class CoreOrderLogEntryType(OrderLogEntryType):
+        pass
+
+Please note that you always need to define your own inherited ``LogEntryType`` class in your plugin. If you would just
+register an instance of a ``LogEntryType`` class defined in pretix core, it cannot be automatically detected as belonging
+to your plugin, leading to confusing user interface situations.
+
+
+Customizing log entry display
+"""""""""""""""""""""""""""""
+
+The base ``LogEntryType`` classes allow for varying degree of customization in their descendants.
+
+If you want to add another log message for an existing core object (e.g. an :class:`Order <pretix.base.models.Order>`,
+:class:`Item <pretix.base.models.Item>`, or :class:`Voucher <pretix.base.models.Voucher>`), you can inherit
+from its predefined :class:`LogEntryType <pretix.base.logentrytypes.LogEntryType>`, e.g.
+:class:`OrderLogEntryType <pretix.base.logentrytypes.OrderLogEntryType>`, and just specify a new plaintext string.
+You can use format strings to insert information from the LogEntry's `data` object as shown in the section above.
+
+If you define a new model object in your plugin, you should make sure proper object links in the user interface are
+displayed for it. If your model object belongs logically to a pretix :class:`Event <pretix.base.models.Event>`, you can inherit from :class:`EventLogEntryType <pretix.base.logentrytypes.EventLogEntryType>`,
+and set the ``object_link_*`` fields accordingly. ``object_link_viewname`` refers to a django url name, which needs to
+accept the arguments `organizer` and `event`, containing the respective slugs, and additional arguments provided by
+``object_link_args``. The default implementation of ``object_link_args`` will return an argument named by
+````object_link_argname``, with a value of ``content_object.pk`` (the primary key of the model object).
+If you want to customize the name displayed for the object (instead of the result of calling ``str()`` on it),
+overwrite ``object_link_display_name``.
+
+
+.. code-block:: python
+
+    class ItemLogEntryType(EventLogEntryType):
+        object_link_wrapper = _('Product {val}')
+
+        # link will be generated as reverse('control:event.item', {'organizer': ..., 'event': ..., 'item': item.pk})
+        object_link_viewname = 'control:event.item'
+        object_link_argname = 'item'
+
+
+.. code-block:: python
+
+    class OrderLogEntryType(EventLogEntryType):
+        object_link_wrapper = _('Order {val}')
+
+        # link will be generated as reverse('control:event.order', {'organizer': ..., 'event': ..., 'code': order.code})
+        object_link_viewname = 'control:event.order'
+
+        def object_link_args(self, order):
+            return {'code': order.code}
+
+        def object_link_display_name(self, order):
+            return order.code
+
+To show more sophisticated message strings, e.g. varying the message depending on information from the :class:`LogEntry <pretix.base.models.log.LogEntry>`'s
+`data` object, override the `display` method:
+
+.. code-block:: python
+
+    @log_entry_types.new()
+    class PaypalEventLogEntryType(EventLogEntryType):
+        action_type = 'pretix.plugins.paypal.event'
+
+        def display(self, logentry):
+            event_type = logentry.parsed_data.get('event_type')
+            text = {
+                'PAYMENT.SALE.COMPLETED': _('Payment completed.'),
+                'PAYMENT.SALE.DENIED': _('Payment denied.'),
+                # ...
+            }.get(event_type, f"({event_type})")
+            return _('PayPal reported an event: {}').format(text)
+
+.. automethod:: pretix.base.logentrytypes.LogEntryType.display
+
+If your new model object does not belong to an :class:`Event <pretix.base.models.Event>`, you need to inherit directly from ``LogEntryType`` instead
+of ``EventLogEntryType``, providing your own implementation of ``get_object_link_info`` if object links should be
+displayed.
+
+.. autoclass:: pretix.base.logentrytypes.LogEntryType
+   :members: get_object_link_info
+
 
-    @receiver(signal=logentry_display)
-    def pretixcontrol_logentry_display(sender, logentry, **kwargs):
-        plains = {
-            'pretix.event.order.paid': _('The order has been marked as paid.'),
-            'pretix.event.order.refunded': _('The order has been refunded.'),
-            'pretix.event.order.canceled': _('The order has been canceled.'),
-            ...
-        }
-        if logentry.action_type in plains:
-            return plains[logentry.action_type]
 
 Sending notifications
 ---------------------

doc/development/index.rst

@@ -1,5 +1,5 @@
-Developer documentation
-=======================
+Plugin & core development
+=========================
 
 .. toctree::
    :maxdepth: 2

doc/development/setup.rst

@@ -5,7 +5,7 @@ Development setup
 
 This tutorial helps you to get started hacking with pretix on your own computer. You need this to
 be able to contribute to pretix, but it might also be helpful if you want to write your own plugins.
-If you want to install pretix on a server for actual usage, go to the :ref:`admindocs` instead.
+If you want to install pretix on a server for actual usage, go to the `administrator documentation`_ instead.
 
 Obtain a copy of the source code
 --------------------------------
@@ -18,7 +18,7 @@ External Dependencies
 ---------------------
 Your should install the following on your system:
 
-* Python 3.5 or newer
+* Python 3.9 or newer
 * ``pip`` for Python 3 (Debian package: ``python3-pip``)
 * ``python-dev`` for Python 3 (Debian package: ``python3-dev``)
 * On Debian/Ubuntu: ``python-venv`` for Python 3 (Debian package: ``python3-venv``)
@@ -33,7 +33,7 @@ Your should install the following on your system:
 Your local python environment
 -----------------------------
 
-Please execute ``python -V`` or ``python3 -V`` to make sure you have Python 3.4
+Please execute ``python -V`` or ``python3 -V`` to make sure you have Python 3.9
 (or newer) installed. Also make sure you have pip for Python 3 installed, you can
 execute ``pip3 -V`` to check. Then use Python's internal tools to create a virtual
 environment and activate it for your current session::
@@ -136,9 +136,7 @@ It is a good idea to put this command into your git hook ``.git/hooks/pre-commit
 for example, to check for any errors in any staged files when committing::
 
     #!/bin/bash
-    cd $GIT_DIR/../src
-    export GIT_WORK_TREE=../
-    export GIT_DIR=../.git
+
     source ../env/bin/activate  # Adjust to however you activate your virtual environment
     for file in $(git diff --cached --name-only | grep -E '\.py$' | grep -Ev "migrations|mt940\.py|pretix/settings\.py|make_testdata\.py|testutils/settings\.py|tests/settings\.py|pretix/base/models/__init__\.py|.*_pb2\.py")
     do
@@ -223,3 +221,4 @@ your virtual environment.::
 
 .. _Django's documentation: https://docs.djangoproject.com/en/1.11/ref/django-admin/#runserver
 .. _pretixdroid: https://github.com/pretix/pretixdroid
+.. _administrator documentation: https://docs.pretix.eu/self-hosting/

doc/images/logo-white.svg

@@ -1 +1,29 @@
-<svg xmlns="http://www.w3.org/2000/svg" xml:space="preserve" width="254.156" height="109.594" version="1.1"><g transform="scale(1.9856)"><path d="M36.29 23.21c-.35 0-.61.06-.83.13v8.29c.19.06.45.13.77.13 1.73 0 2.46-1.44 2.46-4.26s-.64-4.29-2.4-4.29z" fill="#f8f8f8"/><path d="M61.22 23.15c-1.44 0-2.21 1.31-2.08 3.71l3.9-.58c.03-2.11-.58-3.14-1.82-3.14z" fill="#f8f8f8"/><path d="M127.39 17.1c.35-.03.61-.29.61-.64V.64c0-.35-.29-.64-.64-.64H75.94v2.48c0 .62-.5 1.12-1.12 1.12-.62 0-1.12-.5-1.12-1.12V0H.64C.29 0 0 .29 0 .64v15.82c0 .35.26.61.61.64 5.47.32 9.82 4.86 9.82 10.43 0 5.57-4.35 10.08-9.82 10.37-.35.03-.61.29-.61.64v15.82c0 .35.29.64.64.64h73.22-.16v-2.48c0-.63.49-1.12 1.12-1.12.63 0 1.12.5 1.12 1.12V55h-.16 51.58c.35 0 .64-.29.64-.64V38.54c0-.35-.26-.61-.61-.64-5.47-.32-9.82-4.83-9.82-10.4s4.35-10.11 9.82-10.4zM37.41 34.57c-.86 0-1.6-.1-1.95-.19v5.54H30.6v-18.5c1.31-.61 3.07-1.06 5.73-1.06 4.26 0 7.17 2.27 7.17 7.1 0 4.35-2.53 7.1-6.08 7.1zm15.58-10.78c-.9-.45-1.76-.45-2.4-.22v10.85h-4.86V21.43c1.41-.7 3.55-1.09 6.69-1.06.45 0 .93.03 1.41.06L53 23.79Zm14.56 4.26-8.03 1.12c.32 1.47 1.09 2.21 2.85 2.21 1.63 0 2.91-.35 3.68-.74l1.09 2.98c-1.22.58-2.82 1.06-5.38 1.06-4.51 0-6.88-3.04-6.88-7.17s2.21-7.1 6.53-7.1c4.35-.03 6.4 2.98 6.14 7.65zm8.38 18.56c0 .62-.5 1.12-1.12 1.12-.62 0-1.12-.5-1.12-1.12v-5.12c0-.62.5-1.12 1.12-1.12.62 0 1.12.52 1.12 1.12zm0-11.07c0 .6-.52 1.12-1.12 1.12-.6 0-1.12-.52-1.12-1.12v-5.12c0-.63.49-1.12 1.12-1.12.63 0 1.12.5 1.12 1.12zm0-11.01c0 .62-.5 1.12-1.12 1.12-.62 0-1.12-.5-1.12-1.12v-5.12c0-.62.5-1.12 1.12-1.12.62 0 1.12.52 1.12 1.12zm0-11.07c0 .6-.52 1.12-1.12 1.12-.6 0-1.12-.52-1.12-1.12V8.34c0-.63.49-1.12 1.12-1.12.63 0 1.12.5 1.12 1.12zM90.11 23.8h-2.02v6.18c0 1.02.35 1.41 1.09 1.41.35 0 .54-.06.93-.19v2.98c-.35.19-1.22.48-2.34.48-3.1 0-4.51-1.89-4.51-4.26v-6.59h-1.44v-3.17h1.44v-2.82l4.86-1.22v4.03h1.98v3.17zm7.07 10.62h-4.86V20.66h4.86zm-2.43-15.58c-1.38 0-2.5-.99-2.5-2.21s1.12-2.18 2.5-2.18 2.53.96 2.53 2.18c0 1.22-1.12 2.21-2.53 2.21zm12.35 15.58-1.76-3.81h-.06l-1.82 3.81h-4.9l4.32-7.1-3.87-6.66h5.06l1.66 3.46h.06l1.82-3.46h4.51l-4 6.37 4.38 7.42-5.41-.03z" fill="#f8f8f8"/></g></svg>
+<?xml version="1.0" encoding="UTF-8"?>
+<svg id="Ebene_1" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 128 69">
+    <defs>
+        <style>.cls-1{fill:#f8f8f8;}</style>
+    </defs>
+    <path class="cls-1"
+          d="m45.94,31.18l1.72,12.27,4.59-.65-1.44-10.24c.57-.3,1.39-.41,2.3-.11l.34-3.28c-.46.03-.91.07-1.34.13-2.97.39-4.94,1.03-6.17,1.88Z"/>
+    <path class="cls-1"
+          d="m85.33,20.99l-4.43,1.79.37,2.66-1.36.19.42,2.99,1.36-.19.87,6.22c.31,2.24,1.89,3.83,4.83,3.42,1.06-.15,1.84-.54,2.14-.76l-.39-2.81c-.35.17-.52.26-.85.3-.69.1-1.08-.22-1.21-1.19l-.82-5.83,1.87-.26h.03s-.42-3-.42-3l-1.87.26-.54-3.81Z"/>
+    <rect class="cls-1" x="90.72" y="23.89" width="4.64" height="13.12" transform="translate(-3.33 13.25) rotate(-8)"/>
+    <path class="cls-1"
+          d="m91.3,18.09c-1.3.18-2.23,1.24-2.07,2.39s1.35,1.94,2.65,1.75,2.26-1.27,2.09-2.42-1.35-1.91-2.68-1.72Z"/>
+    <polygon class="cls-1"
+             points="108.53 21.65 104.27 22.25 103.01 25.75 102.95 25.76 100.92 22.72 96.15 23.39 100.69 29.16 97.55 36.44 102.17 35.79 103.39 31.95 103.45 31.94 105.62 35.31 105.62 35.34 110.73 34.62 105.6 28.19 108.53 21.65"/>
+    <path class="cls-1"
+          d="m36.92,31.44c-2.51.35-4.11,1.01-5.27,1.76l2.45,17.46,4.59-.65-.73-5.23c.35.04,1.05.04,1.87-.08,3.35-.47,5.38-3.41,4.8-7.51-.64-4.56-3.69-6.32-7.71-5.76Zm1.42,10.77c-.3.04-.55.02-.74-.02l-1.1-7.83c.2-.09.44-.18.77-.23,1.66-.23,2.45,1.01,2.84,3.73s-.13,4.12-1.76,4.35Z"/>
+    <path class="cls-1"
+          d="m60.61,28.14c-4.08.57-5.77,3.68-5.22,7.57s3.19,6.45,7.45,5.86c2.42-.34,3.86-1.01,4.94-1.71l-1.42-2.67c-.67.46-1.84.97-3.38,1.18-1.66.23-2.48-.36-2.98-1.71l7.44-2.12c-.38-4.45-2.71-7.01-6.82-6.41Zm-1.29,6.4c-.44-2.25.11-3.59,1.47-3.78,1.18-.17,1.89.72,2.14,2.72l-3.61,1.06Z"/>
+    <path class="cls-1"
+          d="m122.48,16.27c.33-.08.54-.35.49-.68l-2.1-14.94c-.05-.33-.36-.57-.69-.52L.53,16.94c-.33.05-.57.36-.52.69l2.1,14.94c.05.33.32.54.66.52,5.21-.42,9.92,3.29,10.66,8.55s-2.77,10.1-7.9,11.09c-.33.08-.54.35-.49.68l2.1,14.94c.05.33.36.57.69.52l119.65-16.82c.33-.05.57-.36.52-.69l-2.1-14.94c-.05-.33-.32-.54-.66-.52-5.21.42-9.92-3.26-10.66-8.52s2.77-10.13,7.9-11.12Zm-9.71,11.38c.81,5.77,5.72,10.04,11.47,10.13l1.78,12.64-47.53,6.68-.33-2.34c-.07-.48-.52-.82-1-.75s-.82.5-.75,1l.33,2.34-67.95,9.55-1.78-12.64c5.5-1.64,9.05-7.06,8.24-12.87s-5.73-10.07-11.47-10.16l-1.78-12.64,67.95-9.55.33,2.34c.07.48.52.82,1,.75s.82-.52.75-1l-.33-2.34,47.53-6.68,1.78,12.64c-5.5,1.64-9.05,7.09-8.23,12.9Z"/>
+    <path class="cls-1"
+          d="m75.82,44.49c-.48.07-.82.52-.75,1l.59,4.23c.07.48.52.82,1,.75s.82-.52.75-1l-.59-4.23c-.07-.47-.53-.82-1-.75Z"/>
+    <path class="cls-1"
+          d="m74.46,34.86c-.5.07-.82.5-.75,1l.59,4.23c.07.47.53.82,1,.75s.82-.53.75-1l-.59-4.23c-.07-.48-.52-.82-1-.75Z"/>
+    <path class="cls-1"
+          d="m73.11,25.23c-.48.07-.82.52-.75,1l.59,4.23c.07.48.52.82,1,.75s.82-.52.75-1l-.59-4.23c-.07-.47-.53-.82-1-.75Z"/>
+    <path class="cls-1"
+          d="m71.76,15.6c-.5.07-.82.5-.75,1l.59,4.23c.07.47.53.82,1,.75s.82-.53.75-1l-.59-4.23c-.07-.48-.52-.82-1-.75Z"/>
+</svg>

doc/license/faq.rst

@@ -1,177 +0,0 @@
-.. spelling:word-list::
-
-   AGPL
-   AGPLv3
-   GPL
-   LGPL
-   Apache
-   BSD
-   MIT
-   CLA
-   django
-   i18nfields
-   hierarkey
-   rami.io
-   rami
-   io
-   GmbH
-
-License FAQ
-===========
-
-.. warning::
-
-   This FAQ tries to explain in simpler terms what the license of the pretix open source project does and does not
-   allow. It is based on our interpretation of the license and is not legal advice. The contents of this page are not
-   legally binding, only the original text of the license in the `license file`_ is legally binding.
-
-How is pretix licensed?
------------------------
-
-pretix follows the popular dual licensing model. It is available under the `GNU Affero General Public License 3`_ (AGPL)
-plus some additional terms, as well as under a proprietary license ("pretix Enterprise license") on request.
-
-How can it be AGPL if there are additional terms?
--------------------------------------------------
-
-Even though it is fairly unknown, the AGPL's section 7 is titled "Additional Terms" and outlines specific conditions
-under which additional terms can be imposed on an AGPL-licensed work. In our case, we add three additional terms.
-
-The first additional term for pretix is an additional **permission**. It allows you to do something that the AGPL would
-generally not allow. As it doesn't restrict your freedoms granted by AGPL, if you don't like it, you can ignore it, and
-if you distribute pretix further, you can remove it.
-
-The second and third additional term for pretix are additional terms that restrict or specify other provisions of the
-license. AGPL specifically requires that these terms can only restrict or specify very specific things and we believe
-our additional terms are in compliance with that and are thus valid and may not be removed.
-
-Why did you choose this license model?
---------------------------------------
-
-pretix was born in the open source community and we're deeply committed to building the best open source ticketing
-solution in the world. It is important to us that pretix is available with a comprehensive feature set under term that
-are compatible with the `Open Source Definition`_. This enables event organizers from all industries and regions
-to have access to a self-hosted, privacy-friendly and secure option to host their events.
-
-However, developing and maintaining pretix is a lot of work. Between 2014 and 2021, we've received external
-contributions from more than 150 individuals. Not counting translations over 90 % of the development was
-done by staff engineers of rami.io GmbH, the company that started pretix. While we're very happy to receive many more
-contributions in the future, we also want to ensure that we continue to be able to pay people working on pretix
-full-time.
-
-We believe our model creates a good balance between ensuring pretix is available freely as well as protecting our
-business interests. Unlike licenses chosen by other projects recently, such as the Server-Side Public License, our
-choice does not restrict using pretix for any possible use case, it just sets a few rules that you have to play by
-if you do.
-
-What do I need to do if I use pretix unmodified?
-------------------------------------------------
-
-If you use pretix without any modifications or plugins, you can use it for whatever you want, as long as you keep
-all copyright notices (including the link to pretix at the bottom of the site) intact.
-
-You are also allowed to make copies of the unmodified source code and distribute them to others as long as you keep
-all copyright and license information intact.
-
-If you install **plugins**, you must follow the same terms as when using a **modified** version (see below).
-
-What do I need to do if I modify pretix?
-----------------------------------------
-
-If you want to modify pretix, you have the right to do so. However, you need to follow the following rules:
-
-* If you **run it for your own events** (events run by you or your company as well as companies from the same
-  corporate groups) our additional permission allows you to do so **without needing to share your source code
-  modifications** as long as you keep the link to pretix at the bottom of the site intact.
-
-* If you **run it for others**, for example as part of a Software-as-a-Service offering or a managed hosting service
-  you **must** make the source code **including all your modifications and all installed plugins** available under the
-  same license as pretix to every visitor of your site. You need to do so in a prominent place such as a link at the bottom of the
-  site. You also **must** keep the existing link intact.
-  You **may not** add additional restrictions on the result as a whole. You **may** add additional permissions, but
-  only on the parts you added. You **must** make clear which changes you made and you must not give the impression that
-  your modified version is an official version of pretix.
-
-* If you **distribute** the modified version, for example as a source code or software package, you **must** license it
-  under the AGPL license with the same additional terms. You **may not** add additional restrictions on the result as a
-  whole. You **may** add additional permissions, but only on the parts you added. You **must** make clear which changes
-  you made and you must not give the impression that your modified version is an official version of pretix.
-
-Does the AGPL copyleft mechanism extend to plugins?
----------------------------------------------------
-
-Yes. pretix plugins are tightly integrated with pretix, so when running pretix together with a plugin in the same
-environment they form a `combined work`_ and the copyleft mechanism of AGPL applies.
-
-Can I create proprietary or secret plugins?
--------------------------------------------
-
-Yes, you can create a proprietary or secret plugin, but it may only ever be **used** in an environment that is covered
-by the additional permission from our license. As soon as the plugin is installed in an installation that is not covered
-by our additional permission (e.g. when it is used in a SaaS environment) or covered by an active pretix Enterprise
-license it **must** be released to the visitors of the site under the same license as pretix (like a modified version
-of pretix).
-
-What licenses can plugins use?
-------------------------------
-
-Technically, you can distribute a plugin under any free or proprietary license as long as it is distributed separately.
-However, once it is either **distributed together with pretix or used in an environment not covered by our
-additional permission** or an active pretix Enterprise license, you **must** release it to all recipients of the
-distribution or all visitors of your site under the same license as pretix (like a modified version of pretix).
-
-If you release a plugin publicly, it is therefore most practical to use a license that is `compatible to AGPL`_.
-This includes most open source licenses such as AGPL, GPL, Apache, 3-clause BSD or MIT.
-
-Note however that when you license a plugin with pure AGPL, it will be incompatible with our additional permission.
-Therefore, if you want to use an AGPL-licensed plugin, you'll need to publish the source code of **all** your plugins
-under AGPL terms **even if you only use it for your own events**. A plugin would add its `own additional permission`_
-to its license to allow combining it with pretix for this use case.
-
-To make things less complicated, if you want to distribute a plugin freely, we therefore recommend distributing the
-plugin under **Apache License 2.0**, like we do for most plugins we distribute as open source.
-
-What do I need to do if I want to contribute my changes back?
--------------------------------------------------------------
-
-In order to retain the possibility for us to offer pretix in a dual licensing model, we unfortunately need you to sign
-a Contributor License Agreement (CLA) that gives us permission to use your contribution in all present and future
-distributions of pretix. We know the bureaucracy sucks. Sorry.
-
-What if I want to re-use a minor part of pretix in my project?
---------------------------------------------------------------
-
-This is the main part we dislike about AGPL: If you see a specific thing in pretix that you'd like to use in another
-project, you'll need to distribute your other project under AGPL terms as well which is often not practical.
-
-In this case, feel free to get in touch with us! We're happy to grant you special permission or pull the component
-out into a separately, permissively licensed repository. We already did that with `django-hierarkey`_ and
-`django-i18nfield`_ which have previously been parts of pretix.
-
-What can I use the name "pretix" for?
--------------------------------------
-
-The name pretix is a registered trademark by rami.io GmbH.
-
-* You **may** use it to **indicate copyright**, such as in the "powered by pretix" or "based on pretix" line, or when
-  indicating that a distribution is based on pretix.
-
-* You **may** use it to **indicate compatibility**, for example you are allowed to name your plugin "<name> for pretix"
-  or you may state that an external service is compatible with pretix.
-
-* You **may not** give the impression that your modified version, plugin or compatible service is official or authorized
-  by rami.io GmbH or pretix unless we specifically allowed you to do so.
-
-* You **may not** use it to name your modified version of pretix. End-users must be able to easily identify whether
-  a version of pretix is distributed by us.
-
-* You **may not** use any variations of the name, such as "MyPretix".
-
-.. _license file: https://github.com/pretix/pretix/blob/master/LICENSE
-.. _GNU Affero General Public License 3: https://www.gnu.org/licenses/agpl-3.0.en.html
-.. _compatible to AGPL: https://www.gnu.org/licenses/license-list.en.html#GPLCompatibleLicenses
-.. _Open Source Definition: https://opensource.org/osd
-.. _combined work: https://www.gnu.org/licenses/gpl-faq.html#GPLPlugins
-.. _own additional permission: https://www.gnu.org/licenses/gpl-faq.html#GPLIncompatibleLibs
-.. _django-hierarkey: https://github.com/raphaelm/django-hierarkey
-.. _django-i18nfield: https://github.com/raphaelm/django-i18nfield

doc/plugins/epaybl.rst

@@ -1,143 +0,0 @@
-ePayBL
-======
-
-.. note::
-
-    Since ePayBL is only available to german federal, provincial and communal entities, the following page is also
-    only provided in german. Should you require assistance with ePayBL and do not speak this language, please feel free
-    reach out to support@pretix.eu.
-
-
-Einführung
-----------
-
-.. note::
-
-    Sollten Sie lediglich schnell entscheiden wollen, welcher Kontierungsmodus in den Einstellungen des pretix
-    ePayBL-plugins gewählt werden soll, so springen Sie direkt zur Sektion :ref:`Kontierungsmodus`.
-
-
-`ePayBL`_ - das ePayment-System von Bund und Länder - ist das am weitesten verbreitete Zahlungssystem für Bundes-, Länder-
-sowie kommunale Aufgabenträger. Während es nur wie eines von vielen anderen Zahlungssystemen scheint, so bietet es
-seinen Nutzern besondere Vorteile, wie die automatische Erfassung von Zahlungsbelegen, dem Übertragen von Buchungen in
-Haushaltskassen/-systeme sowie die automatische Erfassung von Kontierungen und Steuermerkmalen.
-
-Rein technisch gesehen ist ePayBL hierbei nicht ein eigenständiger Zahlungsdienstleister sondern nur ein eine Komponente
-im komplexen System, dass die Zahlungsabwicklung für Kommunen und Behörden ist.
-
-Im folgenden der schematische Aufbau einer Umgebung, in welcher ePayBL zum Einsatz kommt:
-
-.. figure:: img/epaybl_flowchart.png
-   :class: screenshot
-
-   Quelle: Integrationshandbuch ePayBL-Konnektor, DResearch Digital Media Systems GmbH
-
-
-In diesem Schaubild stellt pretix, bzw. die von Ihnen als Veranstalter angelegten Ticketshops, das Fachverfahren dar.
-
-ePayBL stellt das Bindeglied zwischen den Fachverfahren, Haushaltssystemen und dem eigentlichen Zahlungsdienstleister,
-dem sog. ZV-Provider dar. Dieser ZV-Provider ist die Stelle, welche die eigentlichen Kundengelder einzieht und an den
-Händler auszahlt. Das Gros der Zahlungsdienstleister unterstützt pretix hierbei auch direkt; sprich: Sollten Sie die
-Anbindung an Ihre Haushaltssysteme nicht benötigen, kann eine direkte Anbindung in der Regel ebenso - und dies bei meist
-vermindertem Aufwand - vorgenommen werden.
-
-In der Vergangenheit zeigte sich jedoch schnell, dass nicht jeder IT-Dienstleister immer sofort die neueste Version von
-ePayBL seinen Nutzern angeboten hat. Die Gründe hierfür sind mannigfaltig: Von fest vorgegebenen Update-Zyklen bis hin
-zu Systeme mit speziellen Anpassungen, kann leider nicht davon ausgegangen werden, dass alle ePayBL-Systeme exakt gleich
-ansprechbar sind - auch wenn es sich dabei eigentlich um einen standardisierten Dienst handelt.
-
-Aus diesem Grund gibt es mit dem ePayBL-Konnektor eine weitere Abstraktionsschicht welche optional zwischen den
-Fachverfahren und dem ePayBL-Server sitzt. Dieser Konnektor wird so gepflegt, dass er zum einen eine dauerhaft
-gleichartige Schnittstelle den Fachverfahren bietet aber gleichzeitig auch mit jeder Version des ePayBL-Servers
-kommunizieren kann - egal wie neu oder alt, wie regulär oder angepasst diese ist.
-
-Im Grunde müsste daher eigentlich immer gesagt werden, dass pretix eine Anbindung an den ePayBL-Konnektor bietet; nicht
-an "ePayBL" oder den "ePayBL-Server". Diese Unterscheidung kann bei der Ersteinrichtung und Anforderung von Zugangsdaten
-von Relevanz sein. Da in der Praxis jedoch beide Begriffe gleichbedeutend genutzt werden, wird im Folgenden auch nur von
-einer ePayBL-Anbindung die Rede sein - auch wenn explizit der Konnektor gemeint ist.
-
-
-.. _`Kontierungsmodus`:
-
-Kontierungsmodus
-----------------
-
-ePayBL ist ein Produkt, welches für die Abwicklung von Online-Zahlungsvorgängen in der Verwaltung geschaffen wurde. Ein
-Umfeld, in dem klar definiert ist, was ein Kunde gerade bezahlt und wohin das Geld genau fließt. Diese Annahmen lassen
-sich in einem Ticketshop wie pretix jedoch nur teilweise genauso abbilden.
-
-Die ePayBL-Integration für pretix bietet daher zwei unterschiedliche Modi an, wie Buchungen erfasst und an ePayBL und
-damit auch an die dahinterliegenden Haushaltssysteme gemeldet werden können.
-
-Kontierung pro Position/Artikel
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Dieser Modus versucht den klassischen, behördentypischen ePayBL-Zahlungsvorgang abzubilden: Jede einzelne Position, die
-ein Kunde in den Warenkorb legt, wird auch genauso 1:1 an ePayBL und die Hintergrundsysteme übermittelt.
-
-Hierbei muss zwingend auch für jede Position ein Kennzeichen für Haushaltsstelle und Objektnummer, sowie optional ein
-Kontierungsobjekt (``HREF``; bspw. ``stsl=Steuerschlüssel;psp=gsb:Geschäftsbereich,auft:Innenauftrag,kst:Kostenstelle;``
-) übermittelt werden.
-
-Diese Daten sind vom Veranstalter entsprechend für jeden in der Veranstaltung angelegten Artikel innerhalb des Tabs
-"Zusätzliche Einstellungen" der Produkteinstellungen zu hinterlegen.
-
-Während diese Einstellung eine größtmögliche Menge an Kontierungsdaten überträgt und auch ein separates Verbuchen von
-Leistungen auf unterschiedliche Haushaltsstellen erlaubt, so hat diese Option auch einen großen Nachteil: Der Kunde kann
-nur eine Zahlung für seine Bestellung leisten.
-
-Während sich dies nicht nach einem großen Problem anhört, so kann dies beim Kunden zu Frust führen. pretix bietet die
-Option an, dass ein Veranstalter eine Bestellung jederzeit verändern kann: Ändern von Preisen von Positionen in einer
-aufgegebenen Bestellung, Zubuchen und Entfernen von Bestellpositionen, etc. Hat der Kunde seine ursprüngliche Bestellung
-jedoch schon bezahlt, kann pretix nicht mehr die komplette Bestellung mit den passenden Kontierungen übertragen - es
-müsste nur ein Differenz-Abbild zwischen Ursprungsbestellung und aktueller Bestellung übertragen werden. Aber auch wenn
-eine "Nachmeldung" möglich wäre, so wäre ein konkretes Auflösen für was jetzt genau gezahlt wird, nicht mehr möglich.
-
-Daher gilt bei der Nutzung der Kontierung pro Position/Artikel: Der Kunde kann nur eine (erfolgreiche) Zahlung auf seine
-Bestellung leisten.
-
-Eine weitere Einschränkung dieses Modus ist, dass aktuell keine Gebühren-Positionen (Versandkosten, Zahlungs-, Storno-
-oder Servicegebühren) in diesem Modus übertragen werden können. Bitte wenden Sie sich an uns, wenn Sie diese
-Funktionalität benötigen.
-
-
-Kontierung pro Zahlvorgang
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Dieser Modus verabschiedet sich vom behördlichen "Jede Position gehört genau zu einem Haushaltskonto und muss genau
-zugeordnet werden". Stattdessen werden alle Bestellpositionen - inklusive eventuell definierter Gebühren - vermengt und
-nur als ein großer Warenkorb, genauer gesagt: eine einzige Position an ePayBL sowie die Hintergrundsysteme gemeldet.
-
-Während im "pro Postion/Artikel"-Modus jeder Artikel einzeln übermittelt wird und damit auch korrekt pro Artikel der
-jeweilige Brutto- und Nettopreis, sowie der anfallende Steuerbetrag und ein Steuerkennzeichen (mit Hilfe des optionalen
-``HREF``-Attributs) übermittelt werden, ist dies im "pro Zahlvorgang"-Modus nicht möglich.
-
-Stattdessen übermittelt pretix nur einen Betrag für den gesamten Warenkorb: Bruttopreis == Nettopreis. Der Steuerbetrag
-wird hierbei als 0 übermittelt.
-
-Die Angabe einer Haushaltsstelle und Objektnummer, sowie optional der ``HREF``-Kontierungsinformationen ist jedoch
-weiterhin notwendig - allerdings nicht mehr individuell für jeden Artikel/jede Position sondern nur für die gesamte
-Bestellung. Diese Daten sind direkt in den ePayBL-Einstellungen der Veranstaltung unter Einstellungen -> Zahlung ->
-ePayBL vorzunehmen
-
-In der Praxis bedeutet dies, dass in einem angeschlossenen Haushaltssystem nicht nachvollzogen kann, welche Positionen
-konkret erworben und bezahlt wurden - stattdessen kann nur der Fakt, dass etwas verkauft wurde erfasst werden.
-
-Je nach Aufbau und Vorgaben der Finanzbuchhaltung kann dies jedoch ausreichend sein - wenn bspw. eine Ferienfahrt
-angeboten wird und seitens der Haushaltssysteme nicht erfasst werden muss, wie viel vom Gesamtbetrag einer Bestellung
-auf die Ferienfahrt an sich, auf einen Zubringerbus und einen Satz Bettwäsche entfallen ist, sondern (vereinfacht
-gesagt) es ausreichend ist, dass "Eine Summe X für die Haushaltsstelle/Objektnummer geflossen ist".
-
-Dieser Modus der Kontierung bietet Ihnen auch als Vorteil gegenüber dem vorhergehenden an, dass die Bestellungen der
-Kunden jederzeit erweitert und verändert werden können - auch wenn die Ursprungsbestellung schon bezahlt wurde und nur
-noch eine Differenz gezahlt wird.
-
-
-Einschränkungen
----------------
-
-Zum aktuellen Zeitpunkt erlaubt die pretix-Anbindung an ePayBL nicht das durchführen von Erstattungen von bereits
-geleisteten Zahlungen. Der Prozess hierfür unterscheidet sich von Behörde zu Behörde und muss daher händisch
-durchgeführt werden.
-
-.. _ePayBL: https://www.epaybl.de/

doc/plugins/index.rst

@@ -1,27 +0,0 @@
-.. _`plugin-docs`:
-
-Plugin documentation
-====================
-
-This part of the documentation contains information about available plugins
-that can be used to extend pretix's functionality.
-If you want to **create** a plugin, please go to the
-:ref:`Developer documentation <pluginsetup>` instead.
-
-.. toctree::
-   :maxdepth: 2
-
-   list
-   banktransfer
-   ticketoutputpdf
-   badges
-   campaigns
-   certificates
-   digital
-   epaybl
-   exhibitors
-   shipping
-   imported_secrets
-   webinar
-   presale-saml
-   kulturpass

doc/plugins/kulturpass.rst

@@ -1,193 +0,0 @@
-KulturPass
-=========
-
-.. note::
-
-    Since the KulturPass is specific to event organizers within Germany, the following page is also  only provided in
-    German. Should you require assistance with the KulturPass and do not speak this language, please feel free reach
-    out to support@pretix.eu.
-
-
-Einführung
-----------
-Der `KulturPass`_ ist ein Angebot der Bundesregierung für alle, die im laufenden Jahr ihren 18. Geburtstag feiern.
-Sie erhalten ab ihrem 18. Geburtstag ein Budget von 200 Euro, das sie für Eintrittskarten, Bücher, CDs, Platten und
-vieles andere einsetzen können. So wird Kultur vor Ort noch einfacher erlebbar. Gleichzeitig stärkt das die Nachfrage
-bei den Anbietenden.
-
-Da pretix ein Ticketing-System ist, stellen wir ausschließlich einen automatisierten Prozess für den Verkauf von
-Eintrittskarten über den KulturPass-Marktplatz bereit.
-
-
-Registrierung und Einrichtung
------------------------------
-Um als Unternehmen oder Kultureinrichtung Angebote auf dem KulturPass-Marktplatz anbieten zu können, ist zunächst eine
-Registerung und die Einrichtung eines "Shops" sowie der dazugehörigen Angebote notwendig.
-
-1. Registrierung
-    Registrieren Sie sich zunächst unter https://www.kulturpass.de/anbietende/layer als Anbieter. Im Zuge der
-    Registrierung beantworten Sie einige Fragen zu Ihrem Unternehmen/Ihrer Kultureinrichtung, hinterlegen Ihre
-    E-Mail-Adresse und beantworten Fragen zu Ihren Angebotsformen sowie Finanzierung Ihrer Einrichtung.
-
-2. Anlegen eines KulturPass Shops
-    Nach Ihrer Registrierung müssen Sie der Weitergabe Ihrer Daten an die technische Platform hinter dem KulturPass,
-    Mirakl, zustimmen. Hier benennen Sie auch Ihren Shop.
-
-3. Identifizierung mit ELSTER-Zertifikat
-    Als nächsten Schritt müssen Sie Ihr Unternehmen oder Ihre Einrichtung mit Hilfe eines sog. ELSTER-Zertifikates
-    identifizieren. Dieses Zertifikat nutzen Sie auch bereits jetzt schon, wenn Sie auf elektronischem Wege mit der
-    Finanzverwaltung kommunizieren.
-
-4. Ersteinrichtung in pretix
-    Hinterlegen Sie nun die ID-Nummer Ihres KulturPass Marktplatz-Shops sowie einen API-Key in den
-    `Einstellungen Ihres Veranstalterkontos`_ (Veranstalter-Konto -> Einstellungen -> KulturPass). Diese Daten müssen
-    Sie nur einmalig für alle Ihre Veranstaltungen angeben.
-
-    Im `KulturPass-Backend`_ finden Sie die benötigten Informationen indem Sie auf das Benutzer-Symbol in der oberen,
-    rechten Ecke klicken, "Profil" und dann "API Schlüssel" auswählen bzw. indem Sie auf "Einstellungen" in der
-    Navigation links und dann "Shop" auswählen.
-
-.. note::
-
-    Zu jedem Zeitpunkt kann nur ein Hintergrundsystem mit dem KulturPass-System verbunden sein. Werden
-    unterschiedliche Systeme oder gar mehrere pretix-Veranstalterkonten mit dem gleichen KulturPass-System verbunden,
-    können keine Bestellungen mehr verarbeitet werden und Angebote nicht automatisiert an den KulturPass-Marktplatz
-    übermittelt werden. Eingehende Bestellungen von Jugendlichen werden in diesem Fall automatisch abgelehnt, da diese
-    nicht eindeutig zugeordnet werden können. Ebenso überschreibt die Bereitstellung der Angebote eines Systems die
-    Angebote eines anderen Systems.
-
-    Wenn Sie mehrere Systeme haben, die den KulturPass-Marktplatz bedienen sollen, wenden Sie sich bitte an den
-    KulturPass-Support, um sich einen weiteren Shop einrichten zu lassen.
-
-5. Aktivierung der KulturPass-Erweiterungen
-    Alle Veranstaltungen, die Sie über den KulturPass anbieten möchten, benötigen die `KulturPass-Erweiterung`_.
-    Aktivieren Sie diese bitte in jeder relevanten Veranstaltung über Einstellungen -> Erweiterungen -> Tab
-    "Integrationen" -> KulturPass.
-
-6. Konfiguration der Artikel
-    Nachdem die KulturPass-Erweiterung aktiviert wurde, müssen Sie sich entscheiden, welche Produkte Sie über den
-    KulturPass-Marktplatz anbieten möchten. In der Bearbeitungs-Ansicht des jeweiligen Produktes finden Sie hierzu im
-    Tab "Zusätzliche Einstellungen" eine Checkbox "Das Produkt kann mit dem KulturPass erworben werden".
-
-.. note::
-
-    Die Eigenschaft, dass ein Produkt durch den KulturPass-Marktplatz erworben werden kann, kann für beliebig viele
-    Produkte aktiviert werden. Auf Grund der Funktionsweise des KulturPasses sollten Sie jedoch gerade bei vielen
-    Artikeln mit unterschiedlich hohen Preisen darauf achten, dass die Preisspanne nicht zu hoch ausfällt.
-
-    Aktivieren Sie die Option für drei Produkte für 1, 10 und 100 Euro, so wird Ihr Angebot im KulturPass-Marktplatz
-    für 100 Euro gelistet werden. Dies bedeutet im Umkehrschluss auch, dass das KulturPass-Guthaben eines Jugendlichen
-    auch mindestens 100 Euro betragen muss, damit er Ihr Angebot in Anspruch nehmen kann - auch wenn die betroffene
-    Person lediglich das 1 Euro-Angebot wahrnehmen möchte. Erst mit dem 100 Euro KulturPass-Einlösecode wählt die
-    kaufende Person in Ihrem pretix-Shop aus, welches Produkt erworben werden soll. Ein Restguthaben wird nach dem Kauf
-    automatisch zurückerstattet und dem KulturPass-Konto wieder gutgeschrieben.
-
-7. Konfiguration des Marktplatz-Eintrages
-    Je nach dem, ob es sich bei Ihrer Veranstaltung um eine Einzelveranstaltung oder eine Veranstaltungsreihe handelt,
-    müssen Sie die folgende Einstellung einmalig oder pro Veranstaltungstermin vornehmen.
-
-    Einzelveranstaltungen konfigurieren Sie über den Menüpunkt "KulturPass" in den Einstellungen Ihrer Veranstaltung;
-    Veranstaltungsreihen beim Anlegen oder Editieren eines jeden einzelnen Termins am Ende der Seite.
-
-    Um eine Veranstaltung oder einen Veranstaltungstermin im KulturPass-Marktplatz anzubieten, aktivieren Sie zunächst
-    die Option "Diese Veranstaltung via KulturPass anbieten". Geben Sie im folgenden die benötigten Informationen an.
-
-    Bitte beachten Sie, dass Sie bei den Angaben präzise Titel und Beschreibungen verwenden, da der KulturPass-
-    Marktplatz ausschließlich die Informationen aus diesem Bereich verwendet. Etwaige andere Informationen die Sie
-    bspw. in den "Text auf Startseite"-Felder eingeben haben, erreichen das KulturPass-System nicht.
-
-.. note::
-
-    Gerade bei Veranstaltungsreihen nutzen viele pretix-Veranstalter gerne verkürzte Termin-Namen. Ein Schwimmbad würde
-    beispielsweise Ihre Veranstaltungsreihe "Freibad Musterstadt" und die einzelnen Termine nur "Schwimmen" nennen.
-
-    Während dies im pretix-Shop in einem gemeinsamen Kontext wunderbar funktioniert, würde eine Veranstaltung mit dem
-    Titel "Schwimmen" im KulturPass-Marktplatz Informationen vermissen lassen. Wählen Sie daher für das Eingabefeld
-    "Veranstaltungstitel" in der KulturPass-Konfiguration einen sprechenden Wert.
-
-8. Übermittlung der Angebote
-    Sobald Sie Ihre ersten Veranstaltungen konfiguriert und live geschaltet haben, übermittelt pretix automatisch in
-    regelmäßigen Abständen alle von Ihnen angebotenen Veranstaltungen an das KulturPass System (Mirakl). Bitte beachten
-    Sie jedoch, dass der Import der Produkte und Angebote einige Zeit in Anspruch nehmen kann. Zum einen müssen
-    Angebote initial händisch von den Betreibern der KulturPass-Platform freigegeben werden, zum anderen muss auch eine
-    Synchronisation zwischen dem Hintergrundsystem und der KulturPass-App erfolgen. Auf die Dauer dieser Prozesse hat
-    pretix keinen Einfluss.
-
-9. Freischalten des Marktplatz-Shops
-    Nachdem pretix erstmalig Angebote an das KulturPass-System übermittelt hat, müssen Sie Ihren Shop KulturPass-Shop
-    einmalig freischalten. Loggen Sie sich hierzu in das `KulturPass-Backend`_ ein.
-
-
-Verwalten von KulturPass-Bestellungen
--------------------------------------
-Durch die Nutzung der pretix-Integration mit dem KulturPass-System müssen Sie sich - bis auf die Kennzeichnung von
-Produkten, die per KulturPass erworben werden dürfen, sowie die Bereitstellung von Veranstaltungs-Informationen für den
-KulturPass-Marktplatz - um nichts kümmern: pretix übermittelt automatisch Ihre Veranstaltungen, wickelt die Einlösung
-der Tickets ab und führt die Abrechnung mit dem Hintergrund-System durch.
-
-Für Ihre Kunden verhält sich der KulturPass wie eine Zahlungsmethode im Bestellprozess und wird dort neben Ihren
-anderen Zahlungsmethoden mit angeboten.
-
-Die Gelder für mit dem KulturPass bezahlte Tickets erhalten Sie in Form einer Sammel-Überweisung von der Stiftung
-Digitale Chancen auf das von Ihnen beim KulturPass Onboarding angegeben Bankkonto.
-
-In Ihrem `KulturPass-Backend`_ können Sie über den Menüpunkt "Buchhaltung" Ihre bereits erfolgten und kommenden
-Auszahlungen betrachten.
-
-.. note::
-
-    Es ist von äußerster Wichtigkeit, dass Sie weder die eingehenden Bestellungen noch die Produkte und Angebote im
-    KulturPass-Backend händisch bearbeiten - auch wenn dies möglich wäre.
-
-    Bei händischen Änderungen riskieren Sie, dass die Datenbasis zwischen pretix und dem KulturPass-System divergiert
-    und es zu fehlerhaften Buchungen kommt. Wann immer möglich, sollten Sie Korrekturbuchungen und Änderungen
-    ausschließlich über pretix vornehmen.
-
-    Sollte eine händische Änderung/Korrektur notwendig werden, wenden Sie sich bitte an den pretix-Support, damit wir
-    die Auswirkungen evaluieren und vorab mit Ihnen besprechen können!
-
-Erstattungen für Stornos und Absagen können Sie wie gehabt über das pretix-Backend vornehmen. Der jeweilige Betrag wird
-dem KulturPass-Konto dann automatisch gutgeschrieben.
-
-Da nach Ausgabe eines KulturPass Einlöse-Codes dieser vom Kunden jederzeit oder vom System bei
-Nicht-(Komplett)Einlösung binnen 48 Stunden storniert werden kann, kann das im KulturPass-Backend angezeigte,
-auszuzahlende Guthaben fluktuieren. Da in der Regel Auszahlungen frühestens 48 Stunden nach der Aufgabe einer
-KulturPass-Bestellungen erfolgen, sollte Ihr Guthaben in der Regel nicht ins Negative gehen.
-
-Ablauf für Kunden
------------------
-Ihre Kunden erhalten - nachdem sie sich ein eigenes Konto in der KulturPass-App angelegt und sich mit ihrem
-elektronischen Personalausweis identifiziert haben - ein Guthaben von 200 Euro, welches für Leistungen aus dem
-KulturPass-Marktplatz eingelöst werden kann.
-
-Im Falle von Veranstaltungen, die per pretix verkauft werden, wählt der Kunde ein Angebot aus und erhält im folgenden
-binnen kurzer Zeit (ca. 10-20 Minuten) einen Code und einen Link, um diesen einzulösen. Der Link bringt den Kunden direkt auf die Seite der
-betreffenden pretix-Veranstaltung. Hier wird der Kunde darauf hingewiesen, für welche Produkte der Code genutzt werden
-kann.
-
-Im Bezahlschritt des Verkaufsprozesses wird dem Kunden vorgeschlagen, seinen KulturPass Einlösecode nun zu nutzen, um
-die gewünschte Leistung zu erhalten.
-
-Wurde ein Artikel gewählt, welcher günstiger als der Wert des Einlösecodes war, wird das Restguthaben automatisch auf
-das KulturPass-Konto erstattet.
-
-Wurden hingegen mehrere Artikel in den Warenkorb gelegt, so kann die Differenz mit einem anderen, regulären
-Zahlungsmittel erfolgen.
-
-Einlösecodes, die vom Kunden nicht binnen 48 Stunden eingelöst werden, werden automatisch storniert und dem
-KulturPass-Konto wieder gutgeschrieben. Dieser Mechanismus greift auch, wenn eine Veranstaltung mittlerweile
-ausverkauft ist und daher der Einlösecode nicht mehr Nutzbar ist.
-
-
-Unterstützung
--------------
-Weitergehende Informationen zum KulturPass finden Sie auch auf der `Webseite des KulturPasses`_, sowie im
-`KulturPass Serviceportal`_.
-
-
-.. _KulturPass: https://www.kulturpass.de/
-.. _Einstellungen Ihres Veranstalterkontos: https://pretix.eu/control/organizer/-/settings/kulturpass
-.. _KulturPass-Erweiterung: https://pretix.eu/control/event/-/-/settings/plugins#tab-0-2-open
-.. _KulturPass-Backend: https://kulturpass-de.mirakl.net/
-.. _Webseite des KulturPasses: https://www.kulturpass.de/
-.. _KulturPass Serviceportal: https://service.kulturpass.de/help/

doc/plugins/list.rst

@@ -1,10 +0,0 @@
-.. spelling:word-list::
-   Analytics
-
-List of plugins
-===============
-
-A detailed list of plugins that are available for pretix can be found on the
-`pretix Marketplace`_.
-
-.. _pretix Marketplace: https://marketplace.pretix.eu

doc/plugins/presale-saml.rst

@@ -1,405 +0,0 @@
-.. highlight:: ini
-.. spelling:word-list::
-
-   IdP
-   skIDentity
-   ePA
-   NPA
-
-Presale SAML Authentication
-===========================
-
-The Presale SAML Authentication plugin is an advanced plugin, which most event
-organizers will not need to use. However, for the select few  who do require
-strong customer authentication that cannot be covered by the built-in customer
-account functionality, this plugin allows pretix to connect to a SAML IdP and
-perform authentication and retrieval of user information.
-
-Usage of the plugin is governed by two separate sets of settings: The plugin
-installation, the Service Provider (SP) configuration and the event
-configuration.
-
-Plugin installation and initial configuration
----------------------------------------------
-
-.. note:: If you are a customer of our hosted `pretix.eu`_ offering, you can
-          skip this section.
-
-The plugin is installed as any other plugin in the pretix ecosystem. As a
-pretix system administrator, please follow the instructions in the the
-:ref:`Administrator documentation <admindocs>`.
-
-Once installed, you will need to assess, if you want (or need) your pretix
-instance to be a single SP for all organizers and events or if every event
-organizer has to provide their own SP.
-
-Take the example of a university which runs pretix under an pretix Enterprise
-agreement. Since they only provide ticketing services to themselves (every
-organizer is still just a different department of the same university), a
-single SP should be enough.
-
-On the other hand, a reseller such as `pretix.eu`_ who services a multitude
-of clients would not work that way. Here, every organizer is a separate
-legal entity and as such will also need to provide their own SP configuration:
-Company A will expect their SP to reflect their company - and not a generalized
-"pretix SP".
-
-Once you have decided on the mode of operation, the :ref:`Configuration file
-<config>` needs to be extended to reflect your choice.
-
-Example::
-
-    [presale-saml]
-    level=global
-
-``level``
-    ``global`` to use only a single, system-wide SP, ``organizer`` for multiple
-    SPs, configured on the organizer-level. Defaults to ``organizer``.
-
-Service Provider configuration
-------------------------------
-
-Global Level
-^^^^^^^^^^^^
-
-.. note:: If you are a customer of our hosted `pretix.eu`_ offering, you can
-          skip this section and follow the instructions on the upcoming
-          Organizer Level settings.
-
-As a user with administrative privileges, please activate them by clicking the
-`Admin Mode` button in the top right hand corner.
-
-You should now see a new menu-item titled `SAML` appear.
-
-Organizer Level
-^^^^^^^^^^^^^^^
-
-Navigate to the organizer settings in the pretix backend. In the navigation
-bar, you will find a menu-item titled `SAML` if your user has the `Can
-change organizer settings` permission.
-
-
-.. note:: If you are a customer of our hosted `pretix.eu`_ offering, the menu
-          will only appear once one of our friendly customer service agents
-          has enabled the Presale SAML Authentication plugin for at least one
-          of your events. Feel free to get in touch with us!
-
-Setting up the SP
-^^^^^^^^^^^^^^^^^
-
-No matter where your SP configuration lives, you will be greeted by a very
-long list of fields of which almost all of them will need to be filled. Please
-don't be discouraged - most of the settings don't need to be decided by yourself
-and/or are already preset with a sensible default setting.
-
-If you are not sure what setting you should choose for any of the fields, you
-should reach out to your IdP operator as they can tell you exactly what the IdP
-expects and - more importantly - supports.
-
-``IdP Metadata URL``
-    Please provide the URL where your IdP outputs its metadata. For most IdPs,
-    this URL is static and the same for all SPs. If you are a member of the
-    DFN-AAI, you can find the meta-data for the `Test-, Basic- and
-    Advanced-Federation`_ on their website. Please do talk with your local
-    IdP operator though, as you might not even need to go through the DFN-AAI
-    and might just use your institutions local IdP which will also host their
-    metadata on a different URL.
-
-    The URL needs to be publicly accessible, as saving the settings form will
-    fail if the IdP metadata cannot be retrieved. pretix will also automatically
-    refresh the IdP metadata on a regular basis.
-
-``SP Entity Id``
-    By default, we recommend that you use the system-proposed metadata-URL as
-    the Entity Id of your SP. However, if so desired or required by your IdP,
-    you can also set any other, arbitrary URL as the SP Entity Id.
-
-``SP Name / SP Decription``
-    Most IdP will display the name and description of your SP to the users
-    during authentication. The description field can be used to explain to the
-    users how their data is being used.
-
-``SP X.509 Certificate / SP X.509 Private Key``
-    Your SP needs a certificate and a private key for said certificate. Please
-    coordinate with your IdP, if you are supposed to generate these yourself or
-    if they are provided to you.
-
-``SP X.509 New Certificate``
-    As certificates have an expiry date, they need to be renewed on a regular
-    basis. In order to facilitate the rollover from the expiring to the new
-    certificate, you can provide the new certificate already before the expiration
-    of the existing one. That way, the system will automatically use the correct
-    one. Once the old certificate has expired and is not used anymore at all,
-    you can move the new certificate into the slot of the normal certificate and
-    keep the new slot empty for your next renewal process.
-
-``Requested Attributes``
-    An IdP can hold a variety of attributes of an authenticating user. While
-    your IdP will dictate which of the available attributes your SP can consume
-    in theory, you will still need to define exactly which attributes the SP
-    should request.
-
-    The notation is a JSON list of objects with 5 attributes each:
-
-      * ``attributeValue``: Can be defaulted to ``[]``.
-      * ``friendlyName``: String used in the upcoming event-level settings to
-        retrieve the attributes data.
-      * ``isRequired``: Boolean indicating whether the IdP must enforce the
-        transmission of this attribute. In most cases, ``true`` is the best
-        choice.
-      * ``name``: String of the internal, technical name of the requested
-        attribute. Often starting with ``urn:mace:dir:attribute-def:``,
-        ``urn:oid:`` or ``http://``/``https://``.
-      * ``nameFormat``: String describing the type of ``name`` that has been
-        set in the previous section. Often starting with
-        ``urn:mace:shibboleth:1.0:`` or ``urn:oasis:names:tc:SAML:2.0:``.
-
-    Your IdP can provide you with a list of available attributes. See below
-    for a sample configuration in an academic context.
-
-    Note, that you can have multiple attributes with the same ``friendlyName``
-    but different ``name``s. This is often used in systems, where the same
-    information (for example a persons name) is saved in different fields -
-    for example because one institution is returning SAML 1.0 and other
-    institutions are returning SAML 2.0 style attributes. Typically, this only
-    occurs in mix environments like the DFN-AAI with a large number of
-    participants. If you are only using your own institutions IdP and not
-    authenticating anyone outside of your realm, this should not be a common
-    sight.
-
-``Encrypt/Sign/Require ...``
-    Does what is says on the box - please inquire with your IdP for the
-    necessary settings. Most settings can be turned on as they increase security,
-    however some IdPs might stumble over some of them.
-
-``Signature / Digest Algorithm``
-    Please chose appropriate algorithms, that both pretix/your SP and the IdP
-    can communicate with. A common source of issues when connecting to a
-    Shibboleth-based IdP is the Digest Algorithm: pretix does not support
-    ``http://www.w3.org/2009/xmlenc11#rsa-oaep`` and authentication will fail
-    if the IdP enforces this.
-
-``Technical/Support Contacts``
-    Those contacts are encoded into the SPs public meta data and might be
-    displayed to users having trouble authenticating. It is recommended to
-    provide a dedicated point of contact for technical issues, as those will
-    be the ones to change the configuration for the SP.
-
-Event / Authentication configuration
-------------------------------------
-
-Basic settings
-^^^^^^^^^^^^^^
-
-Once the plugin has been enabled for a pretix event using the Plugins-menu from
-the event's settings, a new *SAML* menu item will show up.
-
-On this page, the actual authentication can be configured.
-
-``Checkout Explanation``
-    Since most users probably won't be familiar with why they have to authenticate
-    to buy a ticket, you can provide them a small blurb here. Markdown is supported.
-
-``Attribute RegEx``
-    By default, any successful authentication with the IdP will allow the user to
-    proceed with their purchase. Should the allowed audience needed to be restricted
-    further, a set of regular Expressions can be used to do this.
-
-    An Attribute RegEx of ``{}`` will allow any authenticated user to pass.
-
-    A RegEx of ``{ "affiliation": "^(employee@pretix.eu|staff@pretix.eu)$" }`` will
-    only allow user to pass which have the ``affiliation`` attribute and whose
-    attribute either matches ``employee@pretix.eu`` or ``staff@pretix.eu``.
-
-    Please make sure that the attribute you are querying is also requested from the
-    IdP in the first place - for a quick check you can have a look at the top of
-    the page where all currently configured attributes are listed.
-
-``RegEx Fail Explanation``
-    Only used in conjunction with the above Attribute RegEx. Should the user not
-    pass the restrictions imposed by the regular expression, the user is shown
-    this error-message.
-
-    If you are - for example in an university context - restricting access to
-    students only, you might want to explain here that Employees are not allowed
-    to book tickets.
-
-``Ticket Secret SAML Attribute``
-    In very specific instances, it might be desirable that the ticket-secret is
-    not the randomly one generated by pretix but rather based on one of the
-    users attributes - for example their unique ID or access card number.
-
-    To achieve this, the name of a SAML-attribute can be specified here.
-
-    It is however necessary to note, that even with this setting in use,
-    ticket-secrets need to be unique. This is why when this setting is enabled,
-    the default, pretix-generated ticket-secret is prefixed with the attributes
-    value.
-
-    Example: A users ``cardid`` attribute has the value of ``01189998819991197253``.
-    The default random ticket secret would have been
-    ``yczygpw9877akz2xwdhtdyvdqwkv7npj``. The resulting new secret will now be
-    ``01189998819991197253_yczygpw9877akz2xwdhtdyvdqwkv7npj``.
-
-    That way, the ticket secret is still unique, but when checking into an event,
-    the user can easily be searched and found using their identifier.
-
-IdP-provided E-Mail addresses, names
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-By default, pretix will only authenticate the user and not process the received
-data any further.
-
-However, there are a few exceptions to this rule.
-
-There are a few `magic` attributes that pretix will use to automatically populate
-the corresponding fields within the checkout process **and lock them out from
-user editing**.
-
-  * ``givenName`` and ``sn``: If both of those attributes are present and pretix
-    is configured to collect the users name, these attributes' values are used
-    for the given and family name respectively.
-  * ``email``: If this attribute is present, the E-Mail-address of the users will
-    be set to the one transmitted through the attributes.
-
-The latter might pose a problem, if the IdP is transmitting an ``email`` attribute
-which does contain a system-level mail address which is only used as an internal
-identifier but not as a real mailbox. In this case, please consider setting the
-``friendlyName`` of the attribute to a different value than ``email`` or removing
-this field from the list of requested attributes altogether.
-
-Saving attributes to questions
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-By setting the ``internal identifier`` of a user-defined question to the same name
-as a SAML attribute, pretix will save the value of said attribute into the question.
-
-All the same as in the above section on E-Mail addresses, those fields become
-non-editable by the user.
-
-Please be aware that some specialty question types might not be compatible with
-the SAML attributes due to specific format requirements. If in doubt (or if the
-checkout fails/the information is not properly saved), try setting the question
-type to a simple type like "Text (one line)".
-
-Notes and configuration examples
---------------------------------
-
-Requesting SAML 1.0 and 2.0 attributes from an academic IdP
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-This requests the ``eduPersonPrincipalName`` (also sometimes called EPPN),
-``email``, ``givenName`` and ``sn`` both in SAML 1.0 and SAML 2.0 attributes.
-
-.. sourcecode:: json
-
-    [
-        {
-            "attributeValue": [],
-            "friendlyName": "eduPersonPrincipalName",
-            "isRequired": true,
-            "name": "urn:mace:dir:attribute-def:eduPersonPrincipalName",
-            "nameFormat": "urn:mace:shibboleth:1.0:attributeNamespace:uri"
-        },
-        {
-            "attributeValue": [],
-            "friendlyName": "eduPersonPrincipalName",
-            "isRequired": true,
-            "name": "urn:oid:1.3.6.1.4.1.5923.1.1.1.6",
-            "nameFormat": "urn:oasis:names:tc:SAML:2.0:attrname-format:uri"
-        },
-        {
-            "attributeValue": [],
-            "friendlyName": "email",
-            "isRequired": true,
-            "name": "urn:mace:dir:attribute-def:mail",
-            "nameFormat": "urn:mace:shibboleth:1.0:attributeNamespace:uri"
-        },
-        {
-            "attributeValue": [],
-            "friendlyName": "email",
-            "isRequired": true,
-            "name": "urn:oid:0.9.2342.19200300.100.1.3",
-            "nameFormat": "urn:oasis:names:tc:SAML:2.0:attrname-format:uri"
-        },
-        {
-            "attributeValue": [],
-            "friendlyName": "givenName",
-            "isRequired": true,
-            "name": "urn:mace:dir:attribute-def:givenName",
-            "nameFormat": "urn:mace:shibboleth:1.0:attributeNamespace:uri"
-        },
-        {
-            "attributeValue": [],
-            "friendlyName": "givenName",
-            "isRequired": true,
-            "name": "urn:oid:2.5.4.42",
-            "nameFormat": "urn:oasis:names:tc:SAML:2.0:attrname-format:uri"
-        },
-        {
-            "attributeValue": [],
-            "friendlyName": "sn",
-            "isRequired": true,
-            "name": "urn:mace:dir:attribute-def:sn",
-            "nameFormat": "urn:mace:shibboleth:1.0:attributeNamespace:uri"
-        },
-        {
-            "attributeValue": [],
-            "friendlyName": "sn",
-            "isRequired": true,
-            "name": "urn:oid:2.5.4.4",
-            "nameFormat": "urn:oasis:names:tc:SAML:2.0:attrname-format:uri"
-        }
-    ]
-
-skIDentity IdP Metadata URL
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Since the IdP Metadata URL for `skIDentity`_ is not readily documented/visible
-in their backend, we document it here:
-``https://service.skidentity.de/fs/saml/metadata``
-
-Requesting skIDentity attributes for electronic identity cards
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-This requests the basic ``eIdentifier``, ``IDType``, ``IDIssuer``, and
-``NameID`` from the `skIDentity`_ SAML service, which are available for
-electronic ID cards such as the German ePA/NPA. (Other attributes such as
-the name and address are available at additional cost from the IdP).
-
-.. sourcecode:: json
-
-    [
-        {
-            "attributeValue": [],
-            "friendlyName": "eIdentifier",
-            "isRequired": true,
-            "name": "http://www.skidentity.de/att/eIdentifier",
-            "nameFormat": "urn:oasis:names:tc:SAML:2.0:attrname-format:uri"
-        },
-        {
-            "attributeValue": [],
-            "friendlyName": "IDType",
-            "isRequired": true,
-            "name": "http://www.skidentity.de/att/IDType",
-            "nameFormat": "urn:oasis:names:tc:SAML:2.0:attrname-format:uri"
-        },
-        {
-            "attributeValue": [],
-            "friendlyName": "IDIssuer",
-            "isRequired": true,
-            "name": "http://www.skidentity.de/att/IDIssuer",
-            "nameFormat": "urn:oasis:names:tc:SAML:2.0:attrname-format:uri"
-        },
-        {
-            "attributeValue": [],
-            "friendlyName": "NameID",
-            "isRequired": true,
-            "name": "http://www.skidentity.de/att/NameID",
-            "nameFormat": "urn:oasis:names:tc:SAML:2.0:attrname-format:uri"
-        }
-    ]
-
-.. _pretix.eu: https://pretix.eu
-.. _Test-, Basic- and Advanced-Federation: https://doku.tid.dfn.de/en:metadata
-.. _skIDentity: https://www.skidentity.de/

doc/plugins/webinar.rst

@@ -1,43 +0,0 @@
-pretix Webinar
-==============
-
-Fetch host URLs
----------------
-
-.. http:get:: /api/v1/organizers/(organizer)/events/(event)/webinars/
-
-   Returns a list of all currently available webinar calls configured for an event.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      GET /api/v1/organizers/bigevents/events/sampleconf/webinars/ HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-
-   **Example response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 200 OK
-      Vary: Accept
-      Content-Type: application/json
-
-      [
-        {
-          "name": "Webinar B – Sept. 8th, 2020",
-          "hosturl": "http://pretix.eu/demo/museum/webinar/host/a9aded3d7bd4df60/30611a34f9fee5d3/"
-        },
-        {
-          "name": "Webinar A – Sept. 8, 2020",
-          "hosturl": "http://pretix.eu/demo/museum/webinar/host/e714x7d4a4a36a04/b9cc444665xxx757/"
-        }
-      ]
-
-   :query subevent: Limit the result to the webinar(s) for a specific subevent.
-   :param organizer: The ``slug`` field of a valid organizer
-   :param event: The ``slug`` field of the event to fetch
-   :statuscode 200: no error
-   :statuscode 401: Authentication failure
-   :statuscode 403: The requested organizer or event does not exist **or** you have no permission to view it.

doc/requirements.rtd.txt

@@ -1,4 +1,4 @@
-sphinx==7.3.*
+sphinx==7.4.*
 jinja2==3.1.*
 sphinx-rtd-theme
 sphinxcontrib-httpdomain
@@ -6,5 +6,4 @@ sphinxcontrib-images
 sphinxcontrib-jquery
 sphinxcontrib-spelling==8.*
 sphinxemoji
-pygments-markdown-lexer
-pyenchant==3.2.*
+pyenchant==3.3.*

doc/requirements.txt

@@ -1,5 +1,5 @@
 -e ../
-sphinx==7.3.*
+sphinx==7.4.*
 jinja2==3.1.*
 sphinx-rtd-theme
 sphinxcontrib-httpdomain
@@ -7,5 +7,4 @@ sphinxcontrib-images
 sphinxcontrib-jquery
 sphinxcontrib-spelling==8.*
 sphinxemoji
-pygments-markdown-lexer
-pyenchant==3.2.*
+pyenchant==3.3.*