Bump dnspython to 2.2.*

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

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,23 +0,0 @@
----
-name: Bug report
-about: Please only create issues for bug reports. Feature requests or general questions
-  should start as a "Discussion" on GitHub.
-title: ''
-labels: ''
-assignees: ''
-
----
-
-<!-- Please only create issues for bug reports. Feature requests or general questions should start as a "Discussion" on GitHub. -->
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**Additional context**
-Add any other context about the problem here.

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,53 @@
+name: Bug report
+description: Please only create issues for bug reports. Feature requests or general questions should start as a "Discussion" on GitHub.
+body:
+  - type: markdown
+    attributes:
+      value: Please make sure to search our issues for similar bugs first! If bug has been reported already, react with a thumbs-up, and/or leave a comment providing further details.
+  - type: textarea
+    id: current
+    attributes:
+      label: Problem and impact
+      description: What problem you're running into? What impact does it have on you / your event?
+      placeholder: When trying to do ____, pretix suddenly shows me an error saying "...".
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected behaviour
+      description: Sometimes bugs are subtle and the expected behaviour may need some explanation. Leave empty if it's just "Don't be broken."
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: Steps to reproduce
+      description: "Please give as much context as possible: Are there any settings that impact this behaviour?"
+      placeholder: |
+        1.
+        2.
+        3.
+        4.
+  - type: textarea
+    id: screenshots
+    attributes:
+      label: Screenshots
+      description: If possible, show screenshots of the problem.
+  - type: input
+    id: link
+    attributes:
+      label: Link
+      description: Link to the page where the bug occurs
+  - type: input
+    id: browser
+    attributes:
+      label: Browser (software, desktop or mobile?) and version
+      description: Leave empty for backend problems
+  - type: input
+    id: os
+    attributes:
+      label: Operating system, dependency versions
+      description: Leave empty for frontend problems
+  - type: input
+    id: version
+    attributes:
+      label: Version
+      description: The pretix version in use. (Leave empty if unknown.)
+

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Community Support
+    url: https://github.com/pretix/pretix/discussions/categories/q-a
+    about: Not sure how to do Y? Please post your support requests in the Q&A section of our GitHub Discussions instead!
+  - name: Feature ideas
+    url: https://github.com/pretix/pretix/discussions/categories/ideas
+    about: Please post your idea in the Ideas section of our GitHub Discussions instead!

.github/dependabot.yml

@@ -0,0 +1,16 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/src"
+    schedule:
+      interval: "daily"
+    versioning-strategy: increase
+  - package-ecosystem: "npm"
+    directory: "/src/pretix/static/npm_dir"
+    schedule:
+      interval: "monthly"

.github/workflows/docs.yml

@@ -14,16 +14,22 @@ on:
       - 'src/pretix/static/**'
       - 'src/tests/**'
 
+permissions:
+  contents: read  #  to fetch code (actions/checkout)
+
+env:
+  FORCE_COLOR: 1
+
 jobs:
   spelling:
     name: Spellcheck
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
       - uses: actions/checkout@v2
-      - name: Set up Python 3.8
+      - name: Set up Python 3.9
         uses: actions/setup-python@v1
         with:
-          python-version: 3.8
+          python-version: 3.9
       - uses: actions/cache@v1
         with:
           path: ~/.cache/pip
@@ -31,7 +37,7 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-pip-
       - name: Install system packages
-        run: sudo apt update && sudo apt install enchant hunspell aspell-en
+        run: sudo apt update && sudo apt install enchant-2 hunspell aspell-en
       - name: Install Dependencies
         run: pip3 install -Ur requirements.txt
         working-directory: ./doc

.github/workflows/strings.yml

@@ -12,16 +12,22 @@ on:
       - 'doc/**'
       - 'src/pretix/locale/**'
 
+permissions:
+  contents: read  #  to fetch code (actions/checkout)
+
+env:
+  FORCE_COLOR: 1
+
 jobs:
   compile:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     name: Check gettext syntax
     steps:
       - uses: actions/checkout@v2
-      - name: Set up Python 3.8
+      - name: Set up Python 3.9
         uses: actions/setup-python@v1
         with:
-          python-version: 3.8
+          python-version: 3.9
       - uses: actions/cache@v1
         with:
           path: ~/.cache/pip
@@ -40,14 +46,14 @@ jobs:
         run: python manage.py compilejsi18n
         working-directory: ./src
   spelling:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     name: Spellcheck
     steps:
       - uses: actions/checkout@v2
-      - name: Set up Python 3.8
+      - name: Set up Python 3.9
         uses: actions/setup-python@v1
         with:
-          python-version: 3.8
+          python-version: 3.9
       - uses: actions/cache@v1
         with:
           path: ~/.cache/pip
@@ -55,7 +61,7 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-pip-
       - name: Install system packages
-        run: sudo apt update && sudo apt install enchant hunspell hunspell-de-de aspell-en aspell-de
+        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]"
         working-directory: ./src

.github/workflows/style.yml

@@ -12,16 +12,22 @@ on:
       - 'src/pretix/locale/**'
       - 'src/pretix/static/**'
 
+permissions:
+  contents: read  #  to fetch code (actions/checkout)
+
+env:
+  FORCE_COLOR: 1
+
 jobs:
   isort:
     name: isort
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
       - uses: actions/checkout@v2
-      - name: Set up Python 3.8
+      - name: Set up Python 3.9
         uses: actions/setup-python@v1
         with:
-          python-version: 3.8
+          python-version: 3.9
       - uses: actions/cache@v1
         with:
           path: ~/.cache/pip
@@ -36,13 +42,13 @@ jobs:
         working-directory: ./src
   flake:
     name: flake8
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
       - uses: actions/checkout@v2
-      - name: Set up Python 3.8
+      - name: Set up Python 3.9
         uses: actions/setup-python@v1
         with:
-          python-version: 3.8
+          python-version: 3.9
       - uses: actions/cache@v1
         with:
           path: ~/.cache/pip
@@ -57,13 +63,13 @@ jobs:
         working-directory: ./src
   licenseheader:
     name: licenseheaders
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
       - uses: actions/checkout@v2
-      - name: Set up Python 3.8
+      - name: Set up Python 3.9
         uses: actions/setup-python@v1
         with:
-          python-version: 3.8
+          python-version: 3.9
       - name: Install Dependencies
         run: pip3 install licenseheaders
       - name: Run licenseheaders

.github/workflows/tests.yml

@@ -12,23 +12,29 @@ on:
       - 'doc/**'
       - 'src/pretix/locale/**'
 
+permissions:
+  contents: read  #  to fetch code (actions/checkout)
+
+env:
+  FORCE_COLOR: 1
+
 jobs:
   test:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     name: Tests
     strategy:
       matrix:
-        python-version: [3.6, 3.7, 3.8]
+        python-version: ["3.7", "3.9", "3.10"]
         database: [sqlite, postgres, mysql]
         exclude:
           - database: mysql
-            python-version: 3.7
-          - database: sqlite
-            python-version: 3.7
+            python-version: "3.10"
           - database: mysql
-            python-version: 3.6
+            python-version: "3.9"
           - database: sqlite
-            python-version: 3.6
+            python-version: "3.7"
+          - database: sqlite
+            python-version: "3.10"
     steps:
       - uses: actions/checkout@v2
       - uses: getong/mariadb-action@v1.1
@@ -55,9 +61,9 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-pip-
       - name: Install system dependencies
-        run: sudo apt update && sudo apt install gettext mysql-client
+        run: sudo apt update && sudo apt install gettext mariadb-client
       - name: Install Python dependencies
-        run: pip3 install -e ".[dev]" mysqlclient psycopg2-binary
+        run: pip3 install --ignore-requires-python -e ".[dev]" mysqlclient psycopg2-binary  # We ignore that flake8 needs newer python as we don't run flake8 during tests
         working-directory: ./src
       - name: Run checks
         run: python manage.py check
@@ -76,4 +82,4 @@ jobs:
         with:
           file: src/coverage.xml
           fail_ci_if_error: true
-        if: matrix.database == 'postgres' && matrix.python-version == '3.8'
+        if: matrix.database == 'postgres' && matrix.python-version == '3.10'

.readthedocs.requirements.txt

@@ -1 +0,0 @@
--r doc/requirements.txt

.readthedocs.yaml

@@ -0,0 +1,15 @@
+version: 2
+sphinx:
+   configuration: doc/conf.py
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.8"
+    nodejs: "16"
+  apt_packages:
+    - gettext
+python:
+  install:
+    - method: pip
+      path: ./src/
+    - requirements: doc/requirements.rtd.txt

Dockerfile

@@ -31,7 +31,7 @@ RUN apt-get update && \
     echo 'pretixuser ALL=(ALL) NOPASSWD:SETENV: /usr/bin/supervisord' >> /etc/sudoers && \
     mkdir /static && \
     mkdir /etc/supervisord && \
-	curl -fsSL https://deb.nodesource.com/setup_15.x | sudo -E bash - && \
+	curl -fsSL https://deb.nodesource.com/setup_16.x | sudo -E bash - && \
     apt-get install -y nodejs && \
     curl -qL https://www.npmjs.com/install.sh | sh
 

SECURITY.md

@@ -0,0 +1,20 @@
+# Security policy
+
+## 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.
+
+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. 
+
+## Version support
+
+Security support is provided for the current stable release as well as the two previous stable releases.
+Be sure to keep your pretix installation up to date.
+
+New releases and security issues will be announced on our [blog](https://pretix.eu/about/en/blog/). If you
+subscribe to our [newsletter](https://pretix.eu/about/en/blog/) in the "News about self-hosting pretix"
+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).

deployment/docker/supervisord/base.conf

@@ -2,6 +2,7 @@
 file=/tmp/supervisor.sock
 
 [supervisord]
+environment = AUTOMIGRATE="skip"
 logfile=/dev/stdout
 logfile_maxbytes=0
 loglevel=info

doc/_themes/pretix_theme/layout.html

@@ -157,7 +157,7 @@
         <div class="rst-content">
           {% include "breadcrumbs.html" %}
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
-           <div itemprop="articleBody">
+           <div itemprop="articleBody" class="section">
             {% block body %}{% endblock %}
            </div>
            <div class="articleComments">

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

@@ -3155,14 +3155,14 @@ a .fa, a .wy-menu-vertical li span.toctree-expand, .wy-menu-vertical li a span.t
     vertical-align: -15%
 }
 
-.wy-alert, .rst-content .note, .rst-content .attention, .rst-content .caution, .rst-content .danger, .rst-content .error, .rst-content .hint, .rst-content .important, .rst-content .tip, .rst-content .warning, .rst-content .seealso, .rst-content .admonition-todo {
+.wy-alert, .rst-content .note, .rst-content .attention, .rst-content .caution, .rst-content .danger, .rst-content .error, .rst-content .hint, .rst-content .important, .rst-content .tip, .rst-content .warning, .rst-content .seealso, .rst-content .admonition-todo, .rst-content div.deprecated {
     padding: 12px;
     line-height: 24px;
     margin-bottom: 24px;
     background: #e7f2fa
 }
 
-.wy-alert-title, .rst-content .admonition-title {
+.wy-alert-title, .rst-content .admonition-title, .rst-content .deprecated .versionmodified {
     color: #fff;
     font-weight: bold;
     display: block;
@@ -6067,6 +6067,10 @@ url('../opensans_regular_macroman/OpenSans-Regular-webfont.svg#open_sansregular'
 img.screenshot, a.screenshot img {
     box-shadow: 0 4px 18px 0 rgba(0,0,0,0.1), 0 6px 20px 0 rgba(0,0,0,0.09);
 }
+section > a.screenshot {
+    display: block;
+    margin-bottom: 24px;
+}
 
 /* Changes */
 .versionchanged {

doc/admin/config.rst

@@ -65,6 +65,9 @@ Example::
     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``.
 
@@ -114,6 +117,9 @@ Example::
 ``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
 ---------------
 
@@ -220,12 +226,30 @@ Example::
 ``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``
 
-``tls``, ``ssl``
-    Use STARTTLS or SSL for the SMTP connection. Off by default.
+``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.
@@ -282,7 +306,7 @@ You can use an existing memcached server as pretix's caching backend::
 ``location``
     The location of memcached, either a host:port combination or a socket file.
 
-If no memcached is configured, pretix will use Django's built-in local-memory caching method.
+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
@@ -375,9 +399,9 @@ 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`_.
 
-To use redis with sentinels set the broker or backend to ``sentinel://sentinel_host_1:26379;sentinal_host_2:26379/0``
+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;sentinal_host_2:26379/0``.
+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
@@ -445,8 +469,10 @@ You can configure the maximum file size for uploading various files::
     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 in MiB, defaults to 10 MiB
+    ; 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

doc/admin/errors.rst

@@ -0,0 +1,40 @@
+.. _`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

@@ -9,7 +9,9 @@ This documentation is for everyone who wants to install pretix on a server.
    :maxdepth: 2
 
    installation/index
+   updates
    config
    maintainance
    scaling
+   errors
    indexes

doc/admin/indexes.rst

@@ -50,7 +50,7 @@ Here is the currently recommended set of commands::
     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_scret
+    CREATE INDEX CONCURRENTLY pretix_addidx_orderpos_secret
         ON pretixbase_orderposition
         USING gin (upper("secret") gin_trgm_ops);
     CREATE INDEX CONCURRENTLY pretix_addidx_orderpos_email

doc/admin/installation/docker_smallscale.rst

@@ -36,9 +36,6 @@ Linux and firewalls, we recommend that you start with `ufw`_.
           SSL certificates can be obtained for free these days. We also *do not* provide support for HTTP-only
           installations except for evaluation purposes.
 
-.. warning:: We recommend **PostgreSQL**. If you go for MySQL, make sure you run **MySQL 5.7 or newer** or
-             **MariaDB 10.2.7 or newer**.
-
 .. 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.
@@ -61,6 +58,9 @@ directory writable to the user that runs pretix inside the docker container::
 Database
 --------
 
+.. warning:: **Please use PostgreSQL for all new installations**. If you need to go for MySQL, make sure you run
+             **MySQL 5.7 or newer** or **MariaDB 10.2.7 or newer**.
+
 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::
@@ -91,6 +91,8 @@ When using MySQL, make sure you set the character set of the database to ``utf8m
 
     mysql > CREATE DATABASE pretix DEFAULT CHARACTER SET utf8mb4 DEFAULT COLLATE utf8mb4_unicode_ci;
 
+You will also need to make sure that ``sql_mode`` in your ``my.cnf`` file does **not** include ``ONLY_FULL_GROUP_BY``.
+
 Redis
 -----
 
@@ -106,6 +108,18 @@ 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
@@ -226,6 +240,9 @@ The following snippet is an example on how to configure a nginx proxy for pretix
         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;
@@ -256,6 +273,8 @@ create an event and start selling tickets!
 
 You should probably read :ref:`maintainance` next.
 
+.. _`docker_updates`:
+
 Updates
 -------
 
@@ -271,6 +290,8 @@ Restarting the service can take a few seconds, especially if the update requires
 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.
+
 .. _`docker_plugininstall`:
 
 Install a plugin

doc/admin/installation/manual_smallscale.rst

@@ -34,9 +34,6 @@ Linux and firewalls, we recommend that you start with `ufw`_.
           SSL certificates can be obtained for free these days. We also *do not* provide support for HTTP-only
           installations except for evaluation purposes.
 
-.. warning:: We recommend **PostgreSQL**. If you go for MySQL, make sure you run **MySQL 5.7 or newer** or
-             **MariaDB 10.2.7 or newer**.
-
 Unix user
 ---------
 
@@ -50,6 +47,9 @@ In this guide, all code lines prepended with a ``#`` symbol are commands that yo
 Database
 --------
 
+.. warning:: **Please use PostgreSQL for all new installations**. If you need to go for MySQL, make sure you run
+             **MySQL 5.7 or newer** or **MariaDB 10.2.7 or newer**.
+
 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::
@@ -65,6 +65,8 @@ When using MySQL, make sure you set the character set of the database to ``utf8m
 
     mysql > CREATE DATABASE pretix DEFAULT CHARACTER SET utf8mb4 DEFAULT COLLATE utf8mb4_unicode_ci;
 
+You will also need to make sure that ``sql_mode`` in your ``my.cnf`` file does **not** include ``ONLY_FULL_GROUP_BY``.
+
 Package dependencies
 --------------------
 
@@ -142,7 +144,7 @@ If you're running MySQL, also install the client library::
 
     (venv)$ pip3 install mysqlclient
 
-Note that you need Python 3.6 or newer. You can find out your Python version using ``python -V``.
+Note that you need Python 3.7 or newer. You can find out your Python version using ``python -V``.
 
 We also need to create a data directory::
 
@@ -223,6 +225,9 @@ The following snippet is an example on how to configure a nginx proxy for pretix
         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;
@@ -259,14 +264,14 @@ The following snippet is an example on how to configure a nginx proxy for pretix
         }
 
         location /static/ {
-            alias /var/pretix/venv/lib/python3.7/site-packages/pretix/static.dist/;
+            alias /var/pretix/venv/lib/python3.10/site-packages/pretix/static.dist/;
             access_log off;
             expires 365d;
             add_header Cache-Control "public";
         }
     }
 
-.. note:: Remember to replace the ``python3.7`` in the ``/static/`` path in the config 
+.. note:: Remember to replace the ``python3.10`` in the ``/static/`` path in the config
           above with your python version.
 
 We recommend reading about setting `strong encryption settings`_ for your web server.
@@ -280,6 +285,8 @@ create an event and start selling tickets!
 
 You should probably read :ref:`maintainance` next.
 
+.. _`manual_updates`:
+
 Updates
 -------
 
@@ -294,6 +301,7 @@ To upgrade to a new pretix release, pull the latest code changes and run the fol
     (venv)$ python -m pretix updatestyles
     # 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.
 
 .. _`manual_plugininstall`:
 
@@ -310,6 +318,27 @@ example::
     (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 updatestyles
+    # 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-16-04
 .. _nginx: https://botleg.com/stories/https-with-lets-encrypt-and-nginx/

doc/admin/maintainance.rst

@@ -9,6 +9,8 @@ If you host your own pretix instance, you also need to care about the availabili
 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
 -------
 

doc/admin/updates.rst

@@ -0,0 +1,51 @@
+.. _`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
+
+
+.. _blog: https://pretix.eu/about/en/blog/

doc/api/deviceauth.rst

@@ -99,11 +99,43 @@ following endpoint:
        "hardware_brand": "Samsung",
        "hardware_model": "Galaxy S",
        "software_brand": "pretixdroid",
-       "software_version": "4.1.0"
+       "software_version": "4.1.0",
+       "info": {"arbitrary": "data"}
    }
 
 You will receive a response equivalent to the response of your initialization request.
 
+Device Information
+------------------
+
+You can request information about your device and the server with one call:
+
+.. sourcecode:: http
+
+   GET /api/v1/device/info HTTP/1.1
+   Host: pretix.eu
+
+The response will look like this:
+
+.. sourcecode:: http
+
+   HTTP/1.1 200 OK
+   Content-Type: application/json
+
+   {
+     "device": {
+       "organizer": "foo",
+       "device_id": 5,
+       "unique_serial": "HHZ9LW9JWP390VFZ",
+       "api_token": "1kcsh572fonm3hawalrncam4l1gktr2rzx25a22l8g9hx108o9oi0rztpcvwnfnd",
+       "name": "Bar",
+       "gate": {
+         "id": 3,
+         "name": "South entrance"
+       }
+     }
+   }
+
 Creating a new API key
 ----------------------
 

doc/api/fundamentals.rst

@@ -43,13 +43,16 @@ Possible permissions are:
 * Can view vouchers
 * Can change vouchers
 
+.. _`rest-compat`:
+
 Compatibility
 -------------
 
-We currently see pretix' API as a beta-stage feature. We therefore do not give any guarantees
-for compatibility between feature releases of pretix (such as 1.5 and 1.6). However, as always,
-we try not to break things when we don't need to. Any backwards-incompatible changes will be
-prominently noted in the release notes.
+We try to avoid any breaking changes to our API to avoid hassle on your end. If possible, we'll
+build new features in a way that keeps all pre-existing API usage unchanged. In some cases,
+this might not be possible or only possible with restrictions. In these case, any
+backwards-incompatible changes will be prominently noted in the "Changes to the REST API"
+section of our release notes. If possible, we will announce them multiple releases in advance.
 
 We treat the following types of changes as *backwards-compatible* so we ask you to make sure
 that your clients can deal with them properly:
@@ -58,6 +61,8 @@ that your clients can deal with them properly:
 * Support of new HTTP methods for a given API endpoint
 * Support of new query parameters for a given API endpoint
 * New fields contained in API responses
+* New possible values of enumeration-like fields
+* Response body structure or message texts on failed requests (``4xx``, ``5xx`` response codes)
 
 We treat the following types of changes as *backwards-incompatible*:
 

doc/api/guides/custom_checkout.rst

@@ -97,7 +97,8 @@ For example, if you want users to be redirected to ``https://example.org/order/r
 either enter ``https://example.org`` or ``https://example.org/order/``.
 
 The user will be redirected back to your page instead of pretix' order confirmation page after the payment,
-**regardless of whether it was successful or not**. Make sure you use our API to check if the payment actually
+**regardless of whether it was successful or not**. We will append an ``error=…`` query parameter with an error
+message, but you should not rely on that and instead make sure you use our API to check if the payment actually
 worked! Your final URL could look like this::
 
     https://test.pretix.eu/democon/3vjrh/order/NSLEZ/ujbrnsjzbq4dzhck/pay/123/?return_url=https%3A%2F%2Fexample.org%2Forder%2Freturn%3Ftx_id%3D1234

doc/api/resources/carts.rst

@@ -17,8 +17,8 @@ The cart position resource contains the following public fields:
 Field                                 Type                       Description
 ===================================== ========================== =======================================================
 id                                    integer                    Internal ID of the cart position
-cart_id                               string                     Identifier of the cart this belongs to. Needs to end
-                                                                 in "@api" for API-created positions.
+cart_id                               string                     Identifier of the cart this belongs to, needs to end
+                                                                 in "@api" for API-created positions
 datetime                              datetime                   Time of creation
 expires                               datetime                   The cart position will expire at this time and no longer block quota
 item                                  integer                    ID of the item
@@ -29,22 +29,23 @@ attendee_name_parts                   object of strings          Composition of
 attendee_email                        string                     Specified attendee email address for this position (or ``null``)
 voucher                               integer                    Internal ID of the voucher used for this position (or ``null``)
 addon_to                              integer                    Internal ID of the position this position is an add-on for (or ``null``)
-subevent                              integer                    ID of the date inside an event series this position belongs to (or ``null``).
+is_bundled                            boolean                    If ``addon_to`` is set, this shows whether this is a bundled product or an addon product
+subevent                              integer                    ID of the date inside an event series this position belongs to (or ``null``)
 answers                               list of objects            Answers to user-defined questions
 ├ question                            integer                    Internal ID of the answered question
 ├ answer                              string                     Text representation of the answer
 ├ question_identifier                 string                     The question's ``identifier`` field
 ├ options                             list of integers           Internal IDs of selected option(s)s (only for choice types)
 └ option_identifiers                  list of strings            The ``identifier`` fields of the selected option(s)s
-seat                                  objects                    The assigned seat. Can be ``null``.
+seat                                  objects                    The assigned seat (or ``null``)
 ├ id                                  integer                    Internal ID of the seat instance
 ├ name                                string                     Human-readable seat name
 └ seat_guid                           string                     Identifier of the seat within the seating plan
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 3.0
+.. versionchanged:: 4.14
 
-   This ``seat`` attribute has been added.
+   This ``is_bundled`` attribute has been added and the cart creation endpoints have been updated.
 
 
 Cart position endpoints
@@ -87,6 +88,7 @@ Cart position endpoints
             "attendee_email": null,
             "voucher": null,
             "addon_to": null,
+            "is_bundled": false,
             "subevent": null,
             "datetime": "2018-06-11T10:00:00Z",
             "expires": "2018-06-11T10:00:00Z",
@@ -133,6 +135,7 @@ Cart position endpoints
         "attendee_email": null,
         "voucher": null,
         "addon_to": null,
+        "is_bundled": false,
         "subevent": null,
         "datetime": "2018-06-11T10:00:00Z",
         "expires": "2018-06-11T10:00:00Z",
@@ -168,16 +171,16 @@ Cart position endpoints
 
        * does not validate if the event's ticket sales are already over or haven't started
 
-       * does not support add-on products at the moment
+       * does not validate constraints on add-on products at the moment
 
        * does not check or calculate prices but believes any prices you send
 
-       * does not support the redemption of vouchers
-
        * does not prevent you from buying items that can only be bought with a voucher
 
        * does not support file upload questions
 
+       Note that more validation might be added in the future, so please do not rely on missing validation.
+
    You can supply the following fields of the resource:
 
    * ``cart_id`` (optional, needs to end in ``@api``)
@@ -189,8 +192,11 @@ Cart position endpoints
    * ``attendee_email`` (optional)
    * ``subevent`` (optional)
    * ``expires`` (optional)
-   * ``includes_tax`` (optional)
+   * ``includes_tax`` (optional, **deprecated**, do not use, will be removed)
    * ``sales_channel`` (optional)
+   * ``voucher`` (optional, expect a voucher code)
+   * ``addons`` (optional, expect a list of nested objects of cart positions)
+   * ``bundled`` (optional, expect a list of nested objects of cart positions)
    * ``answers``
 
       * ``question``
@@ -222,6 +228,12 @@ Cart position endpoints
             "options": []
           }
         ],
+        "addons": [
+          {
+            "item": 2,
+            "variation": null,
+          }
+        ],
         "subevent": null
       }
 
@@ -233,7 +245,7 @@ Cart position endpoints
       Vary: Accept
       Content-Type: application/json
 
-      (Full cart position resource, see above.)
+      (Full cart position resource, see above, with additional nested objects "addons" and "bundled".)
 
    :param organizer: The ``slug`` field of the organizer of the event to create a position for
    :param event: The ``slug`` field of the event to create a position for
@@ -245,8 +257,8 @@ Cart position endpoints
 
 .. http:post:: /api/v1/organizers/(organizer)/events/(event)/cartpositions/bulk_create/
 
-   Creates multiple new cart position. This operation is deliberately not atomic, so each cart position can succeed
-   or fail individually, so the response code of the response is not the only thing to look at!
+   Creates multiple new cart position. **This operation is deliberately not atomic, so each cart position can succeed
+   or fail individually, so the response code of the response is not the only thing to look at!**
 
    .. warning:: This endpoint is considered **experimental**. It might change at any time without prior notice.
 

doc/api/resources/checkin.rst

@@ -0,0 +1,346 @@
+.. spelling:: checkin
+
+.. _rest-checkin:
+
+Check-in
+========
+
+This page describes special APIs built for ticket scanning apps. For managing check-in configuration or other operations,
+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.
+
+.. _`rest-checkin-redeem`:
+
+Checking a ticket in
+--------------------
+
+.. http:post:: /api/v1/organizers/(organizer)/checkinrpc/redeem/
+
+   Tries to redeem an order position, i.e. checks the attendee in (or out). This is the recommended endpoint to use
+   if you build any kind of scanning app that performs check-ins for scanned barcodes. It is safe to use with untrusted
+   inputs in the ``secret`` field.
+
+   This endpoint supports passing multiple check-in lists to perform a multi-event scan. However, each check-in list
+   passed needs to be from a distinct event.
+
+   :<json string secret: Scanned QR code corresponding to the ``secret`` attribute of a ticket.
+   :<json array lists: List of check-in list IDs to search on. No two check-in lists may be from the same event.
+   :<json string type: Send ``"exit"`` for an exit and ``"entry"`` (default) for an entry.
+   :<json datetime datetime: Specifies the datetime of the check-in. If not supplied, the current time will be used.
+   :<json boolean force: Specifies that the check-in should succeed regardless of revoked barcode, previous check-ins or required
+                         questions that have not been filled. This is usually used to upload offline scans that already happened,
+                         because there's no point in validating them since they happened whether they are valid or not. Defaults to ``false``.
+   :<json boolean questions_supported: When this parameter is set to ``true``, handling of questions is supported. If
+                                       you do not implement question handling in your user interface, you **must**
+                                       set this to ``false``. In that case, questions will just be ignored. Defaults
+                                       to ``true``.
+   :<json boolean ignore_unpaid: Specifies that the check-in should succeed even if the order is in pending state.
+                                 Defaults to ``false`` and only works when ``include_pending`` is set on the check-in
+                                 list.
+   :<json object answers: If questions are supported/required, you may/must supply a mapping of question IDs to their
+                          respective answers. The answers should always be strings. In case of (multiple-)choice-type
+                          answers, the string should contain the (comma-separated) IDs of the selected options.
+   :<json string nonce: You can set this parameter to a unique random value to identify this check-in. If you're sending
+                        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 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.
+   :>json object position: Copy of the matching order position (if any was found). The contents are the same as the
+                           :ref:`order-position-resource`, with the following differences: (1) The ``checkins`` value
+                           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.
+   :>json boolean require_attention: Whether or not the ``require_attention`` flag is set on the item or order.
+   :>json object list: Excerpt of information about the matching :ref:`check-in list <rest-checkinlists>` (if any was found),
+                       including the attributes ``id``, ``name``, ``event``, ``subevent``, and ``include_pending``.
+   :>json object questions: List of questions to be answered for check-in, only set on status ``"incomplete"``.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/checkinrpc/redeem/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+      {
+        "secret": "M5BO19XmFwAjLd4nDYUAL9ISjhti0e9q",
+        "lists": [1],
+        "force": false,
+        "ignore_unpaid": false,
+        "nonce": "Pvrk50vUzQd0DhdpNRL4I4OcXsvg70uA",
+        "datetime": null,
+        "questions_supported": true,
+        "answers": {
+          "4": "XS"
+        }
+      }
+
+   **Example successful response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 201 Created
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "status": "ok",
+        "position": {
+          …
+        },
+        "require_attention": false,
+        "list": {
+          "id": 1,
+          "name": "Default check-in list",
+          "event": "sampleconf",
+          "subevent": null,
+          "include_pending": false
+        }
+      }
+
+   **Example response with required questions**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 400 Bad Request
+      Content-Type: text/json
+
+      {
+        "status": "incomplete",
+        "position": {
+          …
+        },
+        "require_attention": false,
+        "list": {
+          "id": 1,
+          "name": "Default check-in list",
+          "event": "sampleconf",
+          "subevent": null,
+          "include_pending": false
+        },
+        "questions": [
+          {
+            "id": 1,
+            "question": {"en": "T-Shirt size"},
+            "type": "C",
+            "required": false,
+            "items": [1, 2],
+            "position": 1,
+            "identifier": "WY3TP9SL",
+            "ask_during_checkin": true,
+            "options": [
+              {
+                "id": 1,
+                "identifier": "LVETRWVU",
+                "position": 0,
+                "answer": {"en": "S"}
+              },
+              {
+                "id": 2,
+                "identifier": "DFEMJWMJ",
+                "position": 1,
+                "answer": {"en": "M"}
+              },
+              {
+                "id": 3,
+                "identifier": "W9AH7RDE",
+                "position": 2,
+                "answer": {"en": "L"}
+              }
+            ]
+          }
+        ]
+      }
+
+   **Example error response (invalid ticket)**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 404 Not Found
+      Content-Type: text/json
+
+      {
+        "detail": "Not found.",
+        "status": "error",
+        "reason": "invalid",
+        "reason_explanation": null,
+        "require_attention": false
+      }
+
+   **Example error response (known, but invalid ticket)**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Content-Type: text/json
+
+      {
+        "status": "error",
+        "reason": "unpaid",
+        "reason_explanation": null,
+        "require_attention": false,
+        "list": {
+          "id": 1,
+          "name": "Default check-in list",
+          "event": "sampleconf",
+          "subevent": null,
+          "include_pending": false
+        },
+        "position": {
+          …
+        }
+      }
+
+   Possible error reasons:
+
+   * ``invalid`` - Ticket is not known.
+   * ``unpaid`` - Ticket is not paid for.
+   * ``canceled`` – Ticket is canceled or expired.
+   * ``already_redeemed`` - Ticket already has been redeemed.
+   * ``product`` - Tickets with this product may not be scanned at this device.
+   * ``rules`` - Check-in prevented by a user-defined rule.
+   * ``ambiguous`` - Multiple tickets match scan, rejected.
+   * ``revoked`` - Ticket code has been revoked.
+   * ``error`` - Internal error.
+
+   In case of reason ``rules``, there might be an additional response field ``reason_explanation`` with a human-readable
+   description of the violated rules. However, that field can also be missing or be ``null``.
+
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :statuscode 201: 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 order position does not exist.
+
+Performing a ticket search
+--------------------------
+
+.. http:get:: /api/v1/organizers/(organizer)/checkinrpc/search/
+
+   Returns a list of all order positions matching a given search request. The result is the same as
+   the :ref:`order-position-resource`, with the following differences:
+
+   * The ``checkins`` value will only include check-ins for the selected list.
+
+   * An additional boolean property ``require_attention`` will inform you whether either the order or the item
+     have the ``checkin_attention`` flag set.
+
+   * If ``attendee_name`` is empty, it will automatically fall back to values from a parent product or from invoice
+     addresses.
+
+   This endpoint supports passing multiple check-in lists to perform a multi-event search. However, each check-in list
+   passed needs to be from a distinct event.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/checkinrpc/search/?list=1&search=Peter 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": 23442,
+            "order": "ABC12",
+            "positionid": 1,
+            "item": 1345,
+            "variation": null,
+            "price": "23.00",
+            "attendee_name": "Peter",
+            "attendee_name_parts": {
+              "full_name": "Peter",
+            },
+            "attendee_email": null,
+            "voucher": null,
+            "tax_rate": "0.00",
+            "tax_rule": null,
+            "tax_value": "0.00",
+            "secret": "z3fsn8jyufm5kpk768q69gkbyr5f4h6w",
+            "addon_to": null,
+            "subevent": null,
+            "pseudonymization_id": "MQLJvANO3B",
+            "seat": null,
+            "checkins": [
+              {
+                "list": 1,
+                "type": "entry",
+                "gate": null,
+                "device": 2,
+                "datetime": "2017-12-25T12:45:23Z",
+                "auto_checked_in": true
+              }
+            ],
+            "answers": [
+              {
+                "question": 12,
+                "answer": "Foo",
+                "options": []
+              }
+            ],
+            "downloads": [
+              {
+                "output": "pdf",
+                "url": "https://pretix.eu/api/v1/organizers/bigevents/events/sampleconf/orderpositions/23442/download/pdf/"
+              }
+            ]
+          }
+        ]
+      }
+
+   :query string search: Fuzzy search matching the attendee name, order code, invoice address name as well as to the beginning of the secret.
+   :query integer list: The check-in list to search on, can be passed multiple times.
+   :query integer page: The page number in case of a multi-page result set, default is 1
+   :query string ignore_status: If set to ``true``, results will be returned regardless of the state of
+                                 the order they belong to and you will need to do your own filtering by order status.
+   :query string ordering: Manually set the ordering of results. Valid fields to be used are ``order__code``,
+                           ``order__datetime``, ``positionid``, ``attendee_name``, ``last_checked_in`` and ``order__email``. Default:
+                           ``attendee_name,positionid``
+   :query string order: Only return positions of the order with the given order code
+   :query string search: Fuzzy search matching the attendee name, order code, invoice address name as well as to the beginning of the secret.
+   :query string expand: Expand a field into a full object. Currently only ``subevent``, ``item``, and ``variation`` are supported. Can be passed multiple times.
+   :query integer item: Only return positions with the purchased item matching the given ID.
+   :query integer item__in: Only return positions with the purchased item matching one of the given comma-separated IDs.
+   :query integer variation: Only return positions with the purchased item variation matching the given ID.
+   :query integer variation__in: Only return positions with one of the purchased item variation matching the given
+                                 comma-separated IDs.
+   :query string attendee_name: Only return positions with the given value in the attendee_name field. Also, add-on
+                                products positions are shown if they refer to an attendee with the given name.
+   :query string secret: Only return positions with the given ticket secret.
+   :query string order__status: Only return positions with the given order status.
+   :query string order__status__in: Only return positions with one the given comma-separated order status.
+   :query boolean has_checkin: If set to ``true`` or ``false``, only return positions that have or have not been
+                               checked in already.
+   :query integer subevent: Only return positions of the sub-event with the given ID
+   :query integer subevent__in: Only return positions of one of the sub-events with the given comma-separated IDs
+   :query integer addon_to: Only return positions that are add-ons to the position with the given ID.
+   :query integer addon_to__in: Only return positions that are add-ons to one of the positions with the given
+                                      comma-separated IDs.
+   :query string voucher: Only return positions with a specific voucher.
+   :query string voucher__code: Only return positions with a specific voucher code.
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :statuscode 200: no error
+   :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.

doc/api/resources/checkinlists.rst

@@ -1,5 +1,7 @@
 .. spelling:: checkin
 
+.. _rest-checkinlists:
+
 Check-in lists
 ==============
 
@@ -34,24 +36,12 @@ allow_multiple_entries                boolean                    If ``true``, su
 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.
 exit_all_at                           datetime                   Automatically check out (i.e. perform an exit scan) at this point in time. After this happened, this property will automatically be set exactly one day into the future. Note that this field is considered "internal configuration" and if you pull the list with ``If-Modified-Since``, the daily change in this field will not trigger a response.
+addon_match                           boolean                    If ``true``, tickets on this list can be redeemed by scanning their parent ticket if this still leads to an unambiguous match.
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 3.9
+.. versionchanged:: 4.12
 
-    The ``subevent`` attribute may now be ``null`` inside event series. The ``allow_multiple_entries``,
-    ``allow_entry_after_exit``, and ``rules`` attributes have been added.
-
-.. versionchanged:: 3.11
-
-    The ``subevent_match`` and ``exclude`` query parameters have been added.
-
-.. versionchanged:: 3.12
-
-    The ``exit_all_at`` attribute has been added.
-
-.. versionchanged:: 3.17
-
-    The ``ends_after`` and ``expand`` query parameters have been added.
+    The ``addon_match`` attribute has been added.
 
 Endpoints
 ---------
@@ -94,6 +84,7 @@ Endpoints
             "allow_entry_after_exit": true,
             "exit_all_at": null,
             "rules": {},
+            "addon_match": false,
             "auto_checkin_sales_channels": [
               "pretixpos"
             ]
@@ -146,6 +137,7 @@ Endpoints
         "allow_entry_after_exit": true,
         "exit_all_at": null,
         "rules": {},
+        "addon_match": false,
         "auto_checkin_sales_channels": [
           "pretixpos"
         ]
@@ -245,6 +237,7 @@ Endpoints
         "subevent": null,
         "allow_multiple_entries": false,
         "allow_entry_after_exit": true,
+        "addon_match": false,
         "auto_checkin_sales_channels": [
           "pretixpos"
         ]
@@ -269,6 +262,7 @@ Endpoints
         "subevent": null,
         "allow_multiple_entries": false,
         "allow_entry_after_exit": true,
+        "addon_match": false,
         "auto_checkin_sales_channels": [
           "pretixpos"
         ]
@@ -323,6 +317,7 @@ Endpoints
         "subevent": null,
         "allow_multiple_entries": false,
         "allow_entry_after_exit": true,
+        "addon_match": false,
         "auto_checkin_sales_channels": [
           "pretixpos"
         ]
@@ -415,6 +410,9 @@ Order position endpoints
    * If ``attendee_name`` is empty, it will automatically fall back to values from a parent product or from invoice
      addresses.
 
+   You can use this endpoint to implement a ticket search. We also provide a dedicated search input as part of our
+   :ref:`check-in API <rest-checkin>` that supports search across multiple events.
+
    **Example request**:
 
    .. sourcecode:: http
@@ -604,15 +602,23 @@ Order position endpoints
    :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
    :statuscode 404: The requested order position or check-in list does not exist.
 
-.. _`rest-checkin-redeem`:
-
 .. http:post:: /api/v1/organizers/(organizer)/events/(event)/checkinlists/(list)/positions/(id)/redeem/
 
    Tries to redeem an order position, identified by its internal ID, i.e. checks the attendee in. This endpoint
    accepts a number of optional requests in the body.
 
-   **Tip:** Instead of an ID, you can also use the ``secret`` field as the lookup parameter.
+   **Tip:** Instead of an ID, you can also use the ``secret`` field as the lookup parameter. In this case, you should
+   always set ``untrusted_input=true`` as a query parameter to avoid security issues.
 
+   .. note::
+
+      We no longer recommend using this API if you're building a ticket scanning application, as it has a few design
+      flaws that can lead to `security issues`_ or compatibility issues due to barcode content characters that are not
+      URL-safe. We recommend to use our new :ref:`check-in API <rest-checkin>` instead.
+
+   :query boolean untrusted_input: If set to true, the lookup parameter is **always** interpreted as a ``secret``, never
+                                   as an ``id``. This should be always set if you are passing through untrusted, scanned
+                                   data to avoid guessing of ticket IDs.
    :<json boolean questions_supported: When this parameter is set to ``true``, handling of questions is supported. If
                                        you do not implement question handling in your user interface, you **must**
                                        set this to ``false``. In that case, questions will just be ignored. Defaults
@@ -733,12 +739,15 @@ Order position endpoints
 
    Possible error reasons:
 
-   * ``unpaid`` - Ticket is not paid for
-   * ``canceled`` – Ticket is canceled or expired. This reason is only sent when your request sets
+   * ``invalid`` - Ticket code not known.
+   * ``unpaid`` - Ticket is not paid for.
+   * ``canceled`` – Ticket is canceled or expired. This reason is only sent when your request sets.
      ``canceled_supported`` to ``true``, otherwise these orders return ``unpaid``.
-   * ``already_redeemed`` - Ticket already has been redeemed
-   * ``product`` - Tickets with this product may not be scanned at this device
-   * ``rules`` - Check-in prevented by a user-defined rule
+   * ``already_redeemed`` - Ticket already has been redeemed.
+   * ``product`` - Tickets with this product may not be scanned at this device.
+   * ``rules`` - Check-in prevented by a user-defined rule.
+   * ``ambiguous`` - Multiple tickets match scan, rejected.
+   * ``revoked`` - Ticket code has been revoked.
 
    In case of reason ``rules``, there might be an additional response field ``reason_explanation`` with a human-readable
    description of the violated rules. However, that field can also be missing or be ``null``.
@@ -752,3 +761,6 @@ Order position endpoints
    :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 order position or check-in list does not exist.
+
+
+.. _security issues: https://pretix.eu/about/de/blog/20220705-release-4111/

doc/api/resources/customers.rst

@@ -14,6 +14,10 @@ The customer resource contains the following public fields:
 Field                                 Type                       Description
 ===================================== ========================== =======================================================
 identifier                            string                     Internal ID of the customer
+external_identifier                   string                     External ID of the customer (or ``null``). This field can
+                                                                 be changed for customers created manually or through
+                                                                 the API, but is read-only for customers created through a
+                                                                 SSO integration.
 email                                 string                     Customer email address
 name                                  string                     Name of this customer (or ``null``)
 name_parts                            object of strings          Decomposition of name (i.e. given name, family name)
@@ -24,10 +28,17 @@ last_login                            datetime                   Date and time o
 date_joined                           datetime                   Date and time of registration
 locale                                string                     Preferred language of the customer
 last_modified                         datetime                   Date and time of modification of the record
+notes                                 string                     Internal notes and comments (or ``null``)
+password                              string                     Can only be set during creation of a new customer, will
+                                                                 not be included in any responses.
 ===================================== ========================== =======================================================
 
 .. versionadded:: 4.0
 
+.. versionchanged:: 4.3
+
+   Passwords can now be set through the API during customer creation.
+
 Endpoints
 ---------
 
@@ -58,6 +69,7 @@ Endpoints
         "results": [
           {
             "identifier": "8WSAJCJ",
+            "external_identifier": null,
             "email": "customer@example.org",
             "name": "John Doe",
             "name_parts": {
@@ -69,7 +81,8 @@ Endpoints
             "last_login": null,
             "date_joined": "2021-04-06T13:44:22.809216Z",
             "locale": "de",
-            "last_modified": "2021-04-06T13:44:22.809377Z"
+            "last_modified": "2021-04-06T13:44:22.809377Z",
+            "notes": null
           }
         ]
       }
@@ -103,6 +116,7 @@ Endpoints
 
       {
         "identifier": "8WSAJCJ",
+        "external_identifier": null,
         "email": "customer@example.org",
         "name": "John Doe",
         "name_parts": {
@@ -114,7 +128,8 @@ Endpoints
         "last_login": null,
         "date_joined": "2021-04-06T13:44:22.809216Z",
         "locale": "de",
-        "last_modified": "2021-04-06T13:44:22.809377Z"
+        "last_modified": "2021-04-06T13:44:22.809377Z",
+        "notes": null
       }
 
    :param organizer: The ``slug`` field of the organizer to fetch
@@ -125,7 +140,9 @@ Endpoints
 
 .. http:post:: /api/v1/organizers/(organizer)/customers/
 
-   Creates a new customer
+   Creates a new customer. In addition to the fields defined on the resource, you can pass the field ``send_email``
+   to control whether the system should send an account activation email with a password reset link (defaults to
+   ``false``).
 
    **Example request**:
 
@@ -137,7 +154,9 @@ Endpoints
       Content-Type: application/json
 
       {
-        "email": "test@example.org"
+        "email": "test@example.org",
+        "password": "verysecret",
+        "send_email": true
       }
 
    **Example response**:
@@ -150,6 +169,7 @@ Endpoints
 
       {
         "identifier": "8WSAJCJ",
+        "external_identifier": null,
         "email": "test@example.org",
         ...
       }
@@ -166,8 +186,8 @@ Endpoints
    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``, ``last_login``, ``date_joined``, ``name``,
-   and ``last_modified`` fields.
+   You can change all fields of the resource except the ``identifier``, ``last_login``, ``date_joined``,
+   ``name`` (which is auto-generated from ``name_parts``), and ``last_modified`` fields.
 
    **Example request**:
 
@@ -193,6 +213,7 @@ Endpoints
 
       {
         "identifier": "8WSAJCJ",
+        "external_identifier": null,
         "email": "test@example.org",
         …
       }
@@ -226,6 +247,7 @@ Endpoints
 
       {
         "identifier": "8WSAJCJ",
+        "external_identifier": null,
         "email": null,
         …
       }

doc/api/resources/discounts.rst

@@ -0,0 +1,306 @@
+.. _`rest-discounts`:
+
+Discounts
+=========
+
+Resource description
+--------------------
+
+Discounts provide a way to automatically reduce the price of a cart if it matches a given set of conditions.
+Discounts are available to everyone. If you want to give a discount just to specific persons, look at
+:ref:`vouchers <rest-vouchers>` instead. If you are interested in the behind-the-scenes details of how
+discounts are calculated for a specific order, have a look at :ref:`our algorithm documentation <algorithms-pricing>`.
+
+.. rst-class:: rest-resource-table
+
+======================================== ========================== =======================================================
+Field                                    Type                       Description
+======================================== ========================== =======================================================
+id                                       integer                    Internal ID of the discount rule
+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"]``.
+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
+                                                                    (or ``null``).
+subevent_mode                            strings                    Determines how the discount is handled when used in an
+                                                                    event series. Can be ``"mixed"`` (no special effect),
+                                                                    ``"same"`` (discount is only applied for groups within
+                                                                    the same date), or ``"distinct"`` (discount is only applied
+                                                                    for groups with no two same dates).
+condition_all_products                   boolean                    If ``true``, the discount 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 applies to.
+condition_apply_to_addons                boolean                    If ``true``, the discount applies to add-on products as well,
+                                                                    otherwise it only applies to top-level items. The discount never
+                                                                    applies to bundled products.
+condition_ignore_voucher_discounted      boolean                    If ``true``, the discount does not apply to products which have
+                                                                    been discounted by a voucher.
+condition_min_count                      integer                    The minimum number of matching products for the discount
+                                                                    to be activated.
+condition_min_value                      money (string)             The minimum value of matching products for the discount
+                                                                    to be activated. Cannot be combined with ``condition_min_count``,
+                                                                    or with ``subevent_mode`` set to ``distinct``.
+benefit_discount_matching_percent        decimal (string)           The percentage of price reduction for matching products.
+benefit_only_apply_to_cheapest_n_matches integer                    If set higher than 0, the discount will only be applied to
+                                                                    the cheapest matches. Useful for a "3 for 2"-style discount.
+                                                                    Cannot be combined with ``condition_min_value``.
+======================================== ========================== =======================================================
+
+
+Endpoints
+---------
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/discounts/
+
+   Returns a list of all discounts within a given event.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/discounts/ 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,
+            "active": true,
+            "internal_name": "3 for 2",
+            "position": 1,
+            "sales_channels": ["web"],
+            "available_from": null,
+            "available_until": null,
+            "subevent_mode": "mixed",
+            "condition_all_products": true,
+            "condition_limit_products": [],
+            "condition_apply_to_addons": true,
+            "condition_ignore_voucher_discounted": false,
+            "condition_min_count": 3,
+            "condition_min_value": "0.00",
+            "benefit_discount_matching_percent": "100.00",
+            "benefit_only_apply_to_cheapest_n_matches": 1
+          }
+        ]
+      }
+
+   :query integer page: The page number in case of a multi-page result set, default is 1
+   :query boolean active: If set to ``true`` or ``false``, only discounts with this value for the field ``active`` will be
+                          returned.
+   :query string ordering: Manually set the ordering of results. Valid fields to be used are ``id`` and ``position``.
+                           Default: ``position``
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :param event: The ``slug`` field of the event 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)/discounts/(id)/
+
+   Returns information on one discount, identified by its ID.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/discounts/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,
+        "active": true,
+        "internal_name": "3 for 2",
+        "position": 1,
+        "sales_channels": ["web"],
+        "available_from": null,
+        "available_until": null,
+        "subevent_mode": "mixed",
+        "condition_all_products": true,
+        "condition_limit_products": [],
+        "condition_apply_to_addons": true,
+        "condition_ignore_voucher_discounted": false,
+        "condition_min_count": 3,
+        "condition_min_value": "0.00",
+        "benefit_discount_matching_percent": "100.00",
+        "benefit_only_apply_to_cheapest_n_matches": 1
+      }
+
+   :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 discount 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:post:: /api/v1/organizers/(organizer)/events/(event)/discounts/
+
+   Creates a new discount
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/discounts/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+
+      {
+        "active": true,
+        "internal_name": "3 for 2",
+        "position": 1,
+        "sales_channels": ["web"],
+        "available_from": null,
+        "available_until": null,
+        "subevent_mode": "mixed",
+        "condition_all_products": true,
+        "condition_limit_products": [],
+        "condition_apply_to_addons": true,
+        "condition_ignore_voucher_discounted": false,
+        "condition_min_count": 3,
+        "condition_min_value": "0.00",
+        "benefit_discount_matching_percent": "100.00",
+        "benefit_only_apply_to_cheapest_n_matches": 1
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 201 Created
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "id": 1,
+        "active": true,
+        "internal_name": "3 for 2",
+        "position": 1,
+        "sales_channels": ["web"],
+        "available_from": null,
+        "available_until": null,
+        "subevent_mode": "mixed",
+        "condition_all_products": true,
+        "condition_limit_products": [],
+        "condition_apply_to_addons": true,
+        "condition_ignore_voucher_discounted": false,
+        "condition_min_count": 3,
+        "condition_min_value": "0.00",
+        "benefit_discount_matching_percent": "100.00",
+        "benefit_only_apply_to_cheapest_n_matches": 1
+      }
+
+   :param organizer: The ``slug`` field of the organizer of the event to create a discount for
+   :param event: The ``slug`` field of the event to create a discount for
+   :statuscode 201: no error
+   :statuscode 400: The discount 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 this resource.
+
+.. http:patch:: /api/v1/organizers/(organizer)/events/(event)/discounts/(id)/
+
+   Update a discount. 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 ``id`` field.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      PATCH /api/v1/organizers/bigevents/events/sampleconf/discounts/1/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+      Content-Length: 94
+
+      {
+        "active": false
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "id": 1,
+        "active": false,
+        "internal_name": "3 for 2",
+        "position": 1,
+        "sales_channels": ["web"],
+        "available_from": null,
+        "available_until": null,
+        "subevent_mode": "mixed",
+        "condition_all_products": true,
+        "condition_limit_products": [],
+        "condition_apply_to_addons": true,
+        "condition_ignore_voucher_discounted": false,
+        "condition_min_count": 3,
+        "condition_min_value": "0.00",
+        "benefit_discount_matching_percent": "100.00",
+        "benefit_only_apply_to_cheapest_n_matches": 1
+      }
+
+   :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 discount to modify
+   :statuscode 200: no error
+   :statuscode 400: The discount could not be modified due to invalid submitted data
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to change this resource.
+
+.. http:delete:: /api/v1/organizers/(organizer)/events/(event)/discount/(id)/
+
+   Delete a discount.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      DELETE /api/v1/organizers/bigevents/events/sampleconf/discount/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 discount to delete
+   :statuscode 204: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to delete this resource.

doc/api/resources/events.rst

@@ -52,34 +52,9 @@ sales_channels                        list                       A list of sales
 ===================================== ========================== =======================================================
 
 
-.. versionchanged:: 3.3
-
-   The attributes ``geo_lat`` and ``geo_lon`` have been added.
-
-.. versionchanged:: 3.4
-
-   The attribute ``timezone`` has been added.
-
-.. versionchanged:: 3.7
-
-   The attribute ``item_meta_properties`` has been added.
-
-.. versionchanged:: 3.12
-
-   The attribute ``valid_keys`` has been added.
-
-.. versionchanged:: 3.14
-
-    The attribute ``sales_channels`` has been added.
-
-
 Endpoints
 ---------
 
-.. versionchanged:: 3.3
-
-    The events resource can now be filtered by meta data attributes.
-
 .. versionchanged:: 4.0
 
     The ``clone_from`` parameter has been added to the event creation endpoint.
@@ -567,10 +542,6 @@ information about the properties.
 .. warning:: This API is intended for advanced users. Even though we take care to validate your input, you will be
              able to break your event using this API by creating situations of conflicting settings. Please take care.
 
-.. versionchanged:: 3.6
-
-   Initial support for settings has been added to the API.
-
 .. http:get:: /api/v1/organizers/(organizer)/events/(event)/settings/
 
    Get current values of event settings.

doc/api/resources/exporters.rst

@@ -6,10 +6,6 @@ Data exporters
 pretix and it's plugins include a number of data exporters that allow you to bulk download various data from pretix in
 different formats. This page shows you how to use these exporters through the API.
 
-.. versionchanged:: 3.13
-
-   This feature has been added to the API.
-
 .. warning::
 
    While we consider the methods listed on this page to be a stable API, the availability and specific input field
@@ -182,7 +178,7 @@ endpoints:
       Content-Type: application/json
 
       {
-        "download": "https://pretix.eu/api/v1/organizers/bigevents/events/sampleconf/orderlist/download/29891ede-196f-4942-9e26-d055a36e98b8/3f279f13-c198-4137-b49b-9b360ce9fcce/"
+        "download": "https://pretix.eu/api/v1/organizers/bigevents/events/sampleconf/exporters/orderlist/download/29891ede-196f-4942-9e26-d055a36e98b8/3f279f13-c198-4137-b49b-9b360ce9fcce/"
       }
 
    :param organizer: The ``slug`` field of the organizer to fetch

doc/api/resources/giftcards.rst

@@ -40,10 +40,6 @@ text                                  string                     Custom text of
 Endpoints
 ---------
 
-.. versionadded:: 3.14
-
-   The transaction list endpoint was added.
-
 .. http:get:: /api/v1/organizers/(organizer)/giftcards/
 
    Returns a list of all gift cards issued by a given organizer.
@@ -257,10 +253,6 @@ Endpoints
         "value": "15.37"
       }
 
-   .. versionchanged:: 3.5
-
-      This endpoint now returns status code ``409`` if the transaction would lead to a negative gift card value.
-
    :param organizer: The ``slug`` field of the organizer to modify
    :param id: The ``id`` field of the gift card to modify
    :query boolean include_accepted: Also show gift cards issued by other organizers that are accepted by this organizer.

doc/api/resources/index.rst

@@ -1,6 +1,11 @@
 Resources and endpoints
 =======================
 
+With a few exceptions, this only lists resources bundled in the pretix core modules.
+Additional endpoints are provided by pretix plugins. Some of them are documented
+at :ref:`plugin-docs`.
+
+
 .. toctree::
    :maxdepth: 2
 
@@ -19,6 +24,8 @@ Resources and endpoints
    orders
    invoices
    vouchers
+   discounts
+   checkin
    checkinlists
    waitinglist
    customers
@@ -31,5 +38,7 @@ Resources and endpoints
    webhooks
    seatingplans
    exporters
+   shredders
+   sendmail_rules
    billing_invoices
-   billing_var
+   billing_var

doc/api/resources/invoices.rst

@@ -58,6 +58,12 @@ lines                                 list of objects            The actual invo
                                                                  created before this field was introduced as well as for
                                                                  all lines not created by a product (e.g. a shipping or
                                                                  cancellation fee).
+├ subevent                            integer                    Event series date ID used to create this line. Note that everything
+                                                                 about the subevent might have changed since the creation
+                                                                 of the invoice. Can be ``null`` for all invoice lines
+                                                                 created before this field was introduced as well as for
+                                                                 all lines not created by a product (e.g. a shipping or
+                                                                 cancellation fee) as well as for all events that are not a series.
 ├ fee_type                            string                     Fee type, e.g. ``shipping``, ``service``, ``payment``,
                                                                  ``cancellation``, ``giftcard``, or ``other. Can be ``null`` for
                                                                  all invoice lines
@@ -78,6 +84,12 @@ lines                                 list of objects            The actual invo
                                                                  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.
+├ 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
+                                                                 an event series not created by a product (e.g. shipping or
+                                                                 cancellation fees) as well as whenever the respective (sub)event
+                                                                 has no location set.
 ├ attendee_name                       string                     Attendee name at time of invoice creation. Can be ``null`` if no
                                                                  name was set or if names are configured to not be added to invoices.
 ├ gross_value                         money (string)             Price including taxes
@@ -96,20 +108,18 @@ internal_reference                    string                     Customer's refe
 ===================================== ========================== =======================================================
 
 
-.. versionchanged:: 3.4
-
-   The attribute ``lines.number`` has been added.
-
-.. versionchanged:: 3.17
-
-   The attribute ``invoice_to_*``, ``invoice_from_*``, ``custom_field``, ``lines.item``, ``lines.variation``, ``lines.event_date_from``,
-   ``lines.event_date_to``, and ``lines.attendee_name`` have been added.
-   ``refers`` now returns an invoice number including the prefix.
-
 .. 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.
+
 
 Endpoints
 ---------
@@ -175,10 +185,12 @@ Endpoints
                 "description": "Budget Ticket",
                 "item": 1234,
                 "variation": 245,
+                "subevent": null,
                 "fee_type": null,
                 "fee_internal_type": null,
                 "event_date_from": "2017-12-27T10:00:00Z",
                 "event_date_to": null,
+                "event_location": "Heidelberg",
                 "attendee_name": null,
                 "gross_value": "23.00",
                 "tax_value": "0.00",
@@ -263,10 +275,12 @@ Endpoints
             "description": "Budget Ticket",
             "item": 1234,
             "variation": 245,
+            "subevent": null,
             "fee_type": null,
             "fee_internal_type": null,
             "event_date_from": "2017-12-27T10:00:00Z",
             "event_date_to": null,
+            "event_location": "Heidelberg",
             "attendee_name": null,
             "gross_value": "23.00",
             "tax_value": "0.00",

doc/api/resources/item_variations.rst

@@ -24,7 +24,12 @@ active                                boolean                    If ``false``, t
 description                           multi-lingual string       A public description of the variation. May contain
                                                                  Markdown syntax or can be ``null``.
 position                              integer                    An integer, used for sorting
+require_approval                      boolean                    If ``true``, orders with this variation will need to be
+                                                                 approved by the event organizer before they can be
+                                                                 paid.
 require_membership                    boolean                    If ``true``, booking this variation requires an active membership.
+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.
@@ -38,8 +43,13 @@ available_until                       datetime                   The last date t
 hide_without_voucher                  boolean                    If ``true``, this variation is only shown during the voucher
                                                                  redemption process, but not in the normal shop
                                                                  frontend.
+meta_data                             object                     Values set for event-specific meta data parameters.
 ===================================== ========================== =======================================================
 
+.. versionchanged:: 4.16
+
+   The ``meta_data`` attribute has been added.
+
 Endpoints
 ---------
 
@@ -74,7 +84,9 @@ Endpoints
               "en": "S"
             },
             "active": true,
+            "require_approval": false,
             "require_membership": false,
+            "require_membership_hidden": false,
             "require_membership_types": [],
             "sales_channels": ["web"],
             "available_from": null,
@@ -87,6 +99,7 @@ Endpoints
             "default_price": "223.00",
             "price": 223.0,
             "original_price": null,
+            "meta_data": {}
           },
           {
             "id": 3,
@@ -94,12 +107,15 @@ Endpoints
               "en": "L"
             },
             "active": true,
+            "require_approval": false,
             "require_membership": false,
+            "require_membership_hidden": false,
             "require_membership_types": [],
             "description": {},
             "position": 1,
             "default_price": null,
-            "price": 15.0
+            "price": 15.0,
+            "meta_data": {}
           }
         ]
       }
@@ -143,14 +159,17 @@ Endpoints
         "price": "10.00",
         "original_price": null,
         "active": true,
+        "require_approval": false,
         "require_membership": false,
+        "require_membership_hidden": false,
         "require_membership_types": [],
         "sales_channels": ["web"],
         "available_from": null,
         "available_until": null,
         "hide_without_voucher": false,
         "description": null,
-        "position": 0
+        "position": 0,
+        "meta_data": {}
       }
 
    :param organizer: The ``slug`` field of the organizer to fetch
@@ -178,14 +197,17 @@ Endpoints
         "value": {"en": "Student"},
         "default_price": "10.00",
         "active": true,
+        "require_approval": false,
         "require_membership": false,
+        "require_membership_hidden": false,
         "require_membership_types": [],
         "sales_channels": ["web"],
         "available_from": null,
         "available_until": null,
         "hide_without_voucher": false,
         "description": null,
-        "position": 0
+        "position": 0,
+        "meta_data": {}
       }
 
    **Example response**:
@@ -203,14 +225,17 @@ Endpoints
         "price": "10.00",
         "original_price": null,
         "active": true,
+        "require_approval": false,
         "require_membership": false,
+        "require_membership_hidden": false,
         "require_membership_types": [],
         "sales_channels": ["web"],
         "available_from": null,
         "available_until": null,
         "hide_without_voucher": false,
         "description": null,
-        "position": 0
+        "position": 0,
+        "meta_data": {}
       }
 
    :param organizer: The ``slug`` field of the organizer of the event/item to create a variation for
@@ -259,14 +284,17 @@ Endpoints
         "price": "10.00",
         "original_price": null,
         "active": false,
+        "require_approval": false,
         "require_membership": false,
+        "require_membership_hidden": false,
         "require_membership_types": [],
         "sales_channels": ["web"],
         "available_from": null,
         "available_until": null,
         "hide_without_voucher": false,
         "description": null,
-        "position": 1
+        "position": 1,
+        "meta_data": {}
       }
 
    :param organizer: The ``slug`` field of the organizer to modify

doc/api/resources/items.rst

@@ -70,6 +70,8 @@ require_approval                      boolean                    If ``true``, or
                                                                  paid.
 require_bundling                      boolean                    If ``true``, this item is only available as part of bundles.
 require_membership                    boolean                    If ``true``, booking this item requires an active membership.
+require_membership_hidden             boolean                    If ``true`` and ``require_membership`` is set, this product 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``
 grant_membership_type                 integer                    If set to the internal ID of a membership type, purchasing this item will
                                                                  create a membership of the given type.
@@ -105,6 +107,8 @@ variations                            list of objects            A list with one
 ├ active                              boolean                    If ``false``, this variation will not be sold or shown.
 ├ description                         multi-lingual string       A public description of the variation. May contain
 ├ require_membership                  boolean                    If ``true``, booking this variation requires an active membership.
+├ 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``
                                                                  Markdown syntax or can be ``null``.
 ├ sales_channels                      list of strings            Sales channels this variation is available on, such as
@@ -119,6 +123,7 @@ variations                            list of objects            A list with one
 ├ hide_without_voucher                boolean                    If ``true``, this variation is only shown during the voucher
                                                                  redemption process, but not in the normal shop
                                                                  frontend.
+├ meta_data                           object                     Values set for event-specific meta data parameters.
 └ position                            integer                    An integer, used for sorting
 addons                                list of objects            Definition of add-ons that can be chosen for this item.
                                                                  Only writable during creation,
@@ -142,19 +147,19 @@ bundles                               list of objects            Definition of b
 meta_data                             object                     Values set for event-specific meta data parameters.
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 3.7
-
-   The attribute ``meta_data`` has been added.
-
-.. versionchanged:: 3.10
-
-   The attribute ``multi_allowed`` has been added to ``addons``.
-
 .. 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`` attribute has been added.
+
 Notes
 -----
 
@@ -247,6 +252,7 @@ Endpoints
                  "available_until": null,
                  "hide_without_voucher": false,
                  "description": null,
+                 "meta_data": {},
                  "position": 0
               },
               {
@@ -262,6 +268,7 @@ Endpoints
                  "available_until": null,
                  "hide_without_voucher": false,
                  "description": null,
+                 "meta_data": {},
                  "position": 1
               }
             ],
@@ -361,6 +368,7 @@ Endpoints
              "available_from": null,
              "available_until": null,
              "hide_without_voucher": false,
+             "meta_data": {},
              "position": 0
           },
           {
@@ -376,6 +384,7 @@ Endpoints
              "available_until": null,
              "hide_without_voucher": false,
              "description": null,
+             "meta_data": {},
              "position": 1
           }
         ],
@@ -455,6 +464,7 @@ Endpoints
              "available_until": null,
              "hide_without_voucher": false,
              "description": null,
+             "meta_data": {},
              "position": 0
           },
           {
@@ -470,6 +480,7 @@ Endpoints
              "available_until": null,
              "hide_without_voucher": false,
              "description": null,
+             "meta_data": {},
              "position": 1
           }
         ],
@@ -538,6 +549,7 @@ Endpoints
              "available_until": null,
              "hide_without_voucher": false,
              "description": null,
+             "meta_data": {},
              "position": 0
           },
           {
@@ -553,6 +565,7 @@ Endpoints
              "available_until": null,
              "hide_without_voucher": false,
              "description": null,
+             "meta_data": {},
              "position": 1
           }
         ],
@@ -652,6 +665,7 @@ Endpoints
              "available_until": null,
              "hide_without_voucher": false,
              "description": null,
+             "meta_data": {},
              "position": 0
           },
           {
@@ -667,6 +681,7 @@ Endpoints
              "available_until": null,
              "hide_without_voucher": false,
              "description": null,
+             "meta_data": {},
              "position": 1
           }
         ],

doc/api/resources/orders.rst

@@ -60,6 +60,7 @@ 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
                                                                  EU VAT service and validation was successful. This only
@@ -68,6 +69,7 @@ positions                             list of objects            List of order p
                                                                  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``)
 ├ value                               money (string)             Fee amount
@@ -96,30 +98,6 @@ last_modified                         datetime                   Last modificati
 ===================================== ========================== =======================================================
 
 
-.. versionchanged:: 3.5
-
-   The ``order.fees.canceled`` attribute has been added.
-
-.. versionchanged:: 3.8
-
-   The ``reactivate`` operation has been added.
-
-.. versionchanged:: 3.10
-
-   The ``search`` query parameter has been added.
-
-.. versionchanged:: 3.11
-
-   The ``exclude`` and ``subevent_after`` query parameter has been added.
-
-.. versionchanged:: 3.13
-
-   The ``subevent_before`` query parameter has been added.
-
-.. versionchanged:: 3.14
-
-   The ``phone`` attribute has been added.
-
 .. versionchanged:: 4.0
 
    The ``customer`` attribute has been added.
@@ -132,6 +110,18 @@ last_modified                         datetime                   Last modificati
 
    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.
+
 
 .. _order-position-resource:
 
@@ -168,6 +158,7 @@ tax_rule                              integer                    The ID of the u
 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``)
 subevent                              integer                    ID of the date inside an event series this position belongs to (or ``null``).
+discount                              integer                    ID of a discount that has been used during the creation of this position in some way (or ``null``).
 pseudonymization_id                   string                     A random ID, e.g. for use in lead scanning apps
 checkins                              list of objects            List of **successful** check-ins with this ticket
 ├ id                                  integer                    Internal ID of the check-in event
@@ -195,27 +186,6 @@ pdf_data                              object                     Data object req
                                                                  ``pdf_data=true`` query parameter to your request.
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 3.3
-
-  The ``url`` of a ticket ``download`` can now also return a ``text/uri-list`` instead of a file. See
-  :ref:`order-position-ticket-download` for details.
-
-.. versionchanged:: 3.5
-
-  The attribute ``canceled`` has been added.
-
-.. versionchanged:: 3.8
-
-  The attributes ``company``, ``street``, ``zipcode``, ``city``, ``country``, and ``state`` have been added.
-
-.. versionchanged:: 3.9
-
-  The ``checkin.type`` attribute has been added.
-
-.. versionchanged:: 3.16
-
-   Answers to file questions are now returned as an URL.
-
 .. _order-payment-resource:
 
 Order payment resource
@@ -262,15 +232,20 @@ created                               datetime                   Date and time o
 comment                               string                     Reason for refund (shown to the customer in some cases, can be ``null``).
 execution_date                        datetime                   Date and time of completion of this refund (or ``null``)
 provider                              string                     Identification string of the payment provider
+details                               object                     Refund-specific information. This is a dictionary
+                                                                 with various fields that can be different between
+                                                                 payment providers, versions, payment states, etc. If
+                                                                 you read this field, you always need to be able to
+                                                                 deal with situations where values that you expect are
+                                                                 missing. Mostly, the field contains various IDs that
+                                                                 can be used for matching with other systems. If a
+                                                                 payment provider does not implement this feature,
+                                                                 the object is empty.
 ===================================== ========================== =======================================================
 
 List of all orders
 ------------------
 
-.. versionchanged:: 3.5
-
-   The ``include_canceled_positions`` and ``include_canceled_fees`` query parameters have been added.
-
 .. http:get:: /api/v1/organizers/(organizer)/events/(event)/orders/
 
    Returns a list of all orders within a given event.
@@ -361,6 +336,7 @@ List of all orders
                 "secret": "z3fsn8jyufm5kpk768q69gkbyr5f4h6w",
                 "addon_to": null,
                 "subevent": null,
+                "discount": null,
                 "pseudonymization_id": "MQLJvANO3B",
                 "seat": null,
                 "checkins": [
@@ -418,7 +394,7 @@ List of all orders
                            ``last_modified``, and ``status``. 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
+   :query string search: Only return orders matching a given search query (matching for names, email addresses, and company names)
    :query integer item: Only return orders with a position that contains this item ID. *Warning:* Result will also include orders if they contain mixed items, and it will even return orders where the item is only contained in a canceled position.
    :query integer variation: Only return orders with a position that contains this variation ID. *Warning:* Result will also include orders if they contain mixed items and variations, and it will even return orders where the variation is only contained in a canceled position.
    :query boolean testmode: Only return orders with ``testmode`` set to ``true`` or ``false``
@@ -433,9 +409,11 @@ List of all orders
        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 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 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
    :param event: The ``slug`` field of the event to fetch
    :resheader X-Page-Generated: The server time at the beginning of the operation. If you're using this API to fetch
@@ -447,10 +425,6 @@ List of all orders
 Fetching individual orders
 --------------------------
 
-.. versionchanged:: 3.5
-
-   The ``include_canceled_positions`` and ``include_canceled_fees`` query parameters have been added.
-
 .. http:get:: /api/v1/organizers/(organizer)/events/(event)/orders/(code)/
 
    Returns information on one order, identified by its order code.
@@ -535,6 +509,7 @@ Fetching individual orders
             "secret": "z3fsn8jyufm5kpk768q69gkbyr5f4h6w",
             "addon_to": null,
             "subevent": null,
+            "discount": null,
             "pseudonymization_id": "MQLJvANO3B",
             "seat": null,
             "checkins": [
@@ -599,13 +574,17 @@ 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
    be a ZIP file, PDF file or something else. The order details response contains a list of output options for this
    particular order.
 
-   Tickets can be only downloaded if the order is paid and if ticket downloads are active. Note that in some cases the
+   Tickets can only be downloaded if ticket downloads are active and – depending on event settings – the order is either paid or pending. Note that in some cases the
    ticket file might not yet have been created. In that case, you will receive a status code :http:statuscode:`409` and
    you are expected to retry the request after a short period of waiting.
 
@@ -730,6 +709,37 @@ Generating new secrets
    :statuscode 401: Authentication failure
    :statuscode 403: The requested organizer/event does not exist **or** you have no permission to update this order.
 
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/orderpositions/(id)/regenerate_secrets/
+
+   Triggers generation of a new ``secret`` attribute for a single order position.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/orderpositions/23/regenerate_secrets/ 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
+
+      (Full order position resource, see above.)
+
+   :param organizer: The ``slug`` field of the organizer of the event
+   :param event: The ``slug`` field of the event
+   :param code: The ``id`` field of the order position to update
+
+   :statuscode 200: no error
+   :statuscode 400: The order position could not be updated due to invalid submitted data.
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to update this order position.
+
 Deleting orders
 ---------------
 
@@ -807,7 +817,7 @@ Creating orders
 
    You can supply the following fields of the resource:
 
-   * ``code`` (optional)
+   * ``code`` (optional) – Only ``A-Z`` and ``0-9``, but without ``O`` and ``1``.
    * ``status`` (optional) – Defaults to pending for non-free orders and paid for free orders. You can only set this to
      ``"n"`` for pending or ``"p"`` for paid. We will create a payment object for this order either in state ``created``
      or in state ``confirmed``, depending on this value. If you create a paid order, the ``order_paid`` signal will
@@ -834,6 +844,7 @@ Creating orders
    * ``comment`` (optional)
    * ``custom_followup_at`` (optional)
    * ``checkin_attention`` (optional)
+   * ``require_approval`` (optional)
    * ``invoice_address`` (optional)
 
       * ``company``
@@ -893,8 +904,9 @@ Creating orders
 
    * ``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
-     whether these emails are enabled for certain sales channels. Defaults to
-     ``false``. Used to be ``send_mail`` before pretix 3.14.
+     whether these emails are enabled for certain sales channels. If set to ``null``, behavior will be controlled by pretix'
+     settings based on the sales channels (added in pretix 4.7). Defaults to ``false``.
+     Used to be ``send_mail`` before pretix 3.14.
 
    If you want to use add-on products, you need to set the ``positionid`` fields of all positions manually
    to incrementing integers starting with ``1``. Then, you can reference one of these
@@ -987,10 +999,6 @@ Creating orders
 Order state operations
 ----------------------
 
-.. versionchanged:: 3.12
-
-   The ``mark_paid`` operation now takes a ``send_email`` parameter.
-
 .. http:post:: /api/v1/organizers/(organizer)/events/(event)/orders/(code)/mark_paid/
 
    Marks a pending or expired order as successfully paid.
@@ -1039,6 +1047,9 @@ Order state operations
    will instead stay paid, but all positions will be removed (or marked as canceled) and replaced by the cancellation
    fee as the only component of the order.
 
+   You can control whether the customer is notified through ``send_email`` (defaults to ``true``).
+   You can pass a ``comment`` that can be visible to the user if it is used in the email template.
+
    **Example request**:
 
    .. sourcecode:: http
@@ -1050,6 +1061,7 @@ Order state operations
 
       {
           "send_email": true,
+          "comment": "Event was canceled.",
           "cancellation_fee": null
       }
 
@@ -1388,10 +1400,6 @@ Sending e-mails
 List of all order positions
 ---------------------------
 
-.. versionchanged:: 3.5
-
-   The ``include_canceled_positions`` and ``include_canceled_fees`` query parameters have been added.
-
 .. http:get:: /api/v1/organizers/(organizer)/events/(event)/orderpositions/
 
    Returns a list of all order positions within a given event.
@@ -1435,6 +1443,7 @@ List of all order positions
             "tax_rule": null,
             "tax_value": "0.00",
             "secret": "z3fsn8jyufm5kpk768q69gkbyr5f4h6w",
+            "discount": null,
             "pseudonymization_id": "MQLJvANO3B",
             "seat": null,
             "addon_to": null,
@@ -1545,6 +1554,7 @@ Fetching individual positions
         "secret": "z3fsn8jyufm5kpk768q69gkbyr5f4h6w",
         "addon_to": null,
         "subevent": null,
+        "discount": null,
         "pseudonymization_id": "MQLJvANO3B",
         "seat": null,
         "checkins": [
@@ -1588,6 +1598,10 @@ 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.
@@ -1599,7 +1613,7 @@ Order position ticket download
    The referenced URL can provide a download or a regular, human-viewable website - so it is advised to open this URL
    in a webbrowser and leave it up to the user to handle the result.
 
-   Tickets can be only downloaded if the order is paid and if ticket downloads are active. Also, depending on event
+   Tickets can only be downloaded if ticket downloads are active and – depending on event settings – the order is either paid or pending. Also, depending on event
    configuration downloads might be only unavailable for add-on products or non-admission products.
    Note that in some cases the ticket file might not yet have been created. In that case, you will receive a status
    code :http:statuscode:`409` and you are expected to retry the request after a short period of waiting.
@@ -1635,12 +1649,15 @@ Order position ticket download
    :statuscode 409: The file is not yet ready and will now be prepared. Retry the request after waiting for a few
                     seconds.
 
+.. _rest-orderpositions-manipulate:
+
 Manipulating individual positions
 ---------------------------------
 
-.. versionchanged:: 3.15
+.. versionchanged:: 4.8
 
-   The ``PATCH`` method has been added for individual positions.
+   The ``PATCH`` method now supports changing items, variations, subevents, seats, prices, and tax rules.
+   The ``POST`` endpoint to add individual positions has been added.
 
 .. http:patch:: /api/v1/organizers/(organizer)/events/(event)/orderpositions/(id)/
 
@@ -1668,6 +1685,21 @@ Manipulating individual positions
      and ``option_identifiers`` will be ignored. As a special case, you can submit the magic value
      ``"file:keep"`` as the answer to a file question to keep the current value without re-uploading it.
 
+   * ``item``
+
+   * ``variation``
+
+   * ``subevent``
+
+   * ``seat`` (specified as a string mapping to a ``string_guid``)
+
+   * ``price``
+
+   * ``tax_rule``
+
+   Changing parameters such as ``item`` or ``price`` will **not** automatically trigger creation of a new invoice,
+   you need to take care of that yourself.
+
    **Example request**:
 
    .. sourcecode:: http
@@ -1689,7 +1721,7 @@ Manipulating individual positions
       Vary: Accept
       Content-Type: application/json
 
-      (Full order resource, see above.)
+      (Full order position resource, see above.)
 
    :param organizer: The ``slug`` field of the organizer of the event
    :param event: The ``slug`` field of the event
@@ -1700,9 +1732,83 @@ 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.
 
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/orderpositions/
+
+   Adds a new position to an order. Currently, only the following fields are supported:
+
+   * ``order`` (mandatory, specified as a string mapping to a ``code``)
+
+   * ``addon_to`` (optional, specified as an integer mapping to the ``positionid`` of the parent position)
+
+   * ``item`` (mandatory)
+
+   * ``variation`` (mandatory depending on item)
+
+   * ``subevent`` (mandatory depending on event)
+
+   * ``seat`` (specified as a string mapping to a ``string_guid``, mandatory depending on event and item)
+
+   * ``price`` (default price will be used if unset)
+
+   * ``attendee_email``
+
+   * ``attendee_name_parts`` or ``attendee_name``
+
+   * ``company``
+
+   * ``street``
+
+   * ``zipcode``
+
+   * ``city``
+
+   * ``country``
+
+   * ``state``
+
+   * ``answers``: Validation is handled the same way as when creating orders through the API. You are therefore
+     expected to provide ``question``, ``answer``, and possibly ``options``. ``question_identifier``
+     and ``option_identifiers`` will be ignored. As a special case, you can submit the magic value
+     ``"file:keep"`` as the answer to a file question to keep the current value without re-uploading it.
+
+   This will **not** automatically trigger creation of a new invoice, you need to take care of that yourself.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/orderpositions/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+
+      {
+        "order": "ABC12",
+        "item": 5,
+        "addon_to": 1
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 201 Created
+      Vary: Accept
+      Content-Type: application/json
+
+      (Full order position resource, see above.)
+
+   :param organizer: The ``slug`` field of the organizer of the event
+   :param event: The ``slug`` field of the event
+
+   :statuscode 200: no error
+   :statuscode 400: The position 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 this position.
+
 .. http:delete:: /api/v1/organizers/(organizer)/events/(event)/orderpositions/(id)/
 
-   Deletes an order position, identified by its internal ID.
+   Cancels an order position, identified by its internal ID.
 
    **Example request**:
 
@@ -1728,18 +1834,132 @@ Manipulating individual positions
    :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
    :statuscode 404: The requested order position does not exist.
 
+Changing order contents
+-----------------------
+
+While you can :ref:`change positions individually <rest-orderpositions-manipulate>` sometimes it is necessary to make
+multiple changes to an order at once within one transaction. This makes it possible to e.g. swap the seats of two
+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:
+
+   * ``patch_positions``: A list of objects with the two keys ``position`` specifying an order position ID and
+     ``body`` specifying the desired changed values of the position (``item``, ``variation``, ``subevent``, ``seat``,
+     ``price``, ``tax_rule``).
+
+   * ``cancel_positions``: A list of objects with the single key ``position`` specifying an order position ID.
+
+   * ``split_positions``: A list of objects with the single key ``position`` specifying an order position ID.
+
+   * ``create_positions``: A list of objects describing new order positions with the same fields supported as when
+     creating them individually through the ``POST …/orderpositions/`` endpoint.
+
+   * ``patch_fees``: A list of objects with the two keys ``fee`` specifying an order fee ID and
+     ``body`` specifying the desired changed values of the position (``value``).
+
+   * ``cancel_fees``: A list of objects with the single key ``fee`` specifying an order fee ID.
+
+   * ``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.
+
+   * ``send_email``: If set to ``true``, the customer will be notified about the change. Defaults to ``false``.
+
+   * ``reissue_invoice``: If set to ``true`` and an invoice exists for the order, it will be canceled and a new invoice
+     will be issued. Defaults to ``true``.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/orders/ABC12/change/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+
+      {
+        "cancel_positions": [
+          {
+            "position": 12373
+          }
+        ],
+        "patch_positions": [
+          {
+            "position": 12374,
+            "body": {
+              "item": 12,
+              "variation": None,
+              "subevent": 562,
+              "seat": "seat-guid-2",
+              "price": "99.99",
+              "tax_rule": 15
+            }
+          }
+        ],
+        "split_positions": [
+          {
+            "position": 12375
+          }
+        ],
+        "create_positions": [
+          {
+            "item": 12,
+            "variation": None,
+            "subevent": 562,
+            "seat": "seat-guid-2",
+            "price": "99.99",
+            "addon_to": 12374,
+            "attendee_name": "Peter",
+          }
+        ],
+        "cancel_fees": [
+          {
+            "fee": 49
+          }
+        ],
+        "change_fees": [
+          {
+            "fee": 51,
+            "body": {
+              "value": "12.00"
+            }
+          }
+        ],
+        "reissue_invoice": true,
+        "send_email": true,
+        "recalculate_taxes": "keep_gross"
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      (Full order position resource, see above.)
+
+   :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
+
+   :statuscode 200: no error
+   :statuscode 400: The order could not be updated due to invalid submitted data.
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to update this order.
+
 
 Order payment endpoints
 -----------------------
 
-.. versionchanged:: 3.6
-
-   Payments can now be created through the API.
-
-.. versionchanged:: 3.12
-
-   The ``confirm`` operation now takes a ``send_email`` parameter.
-
 .. http:get:: /api/v1/organizers/(organizer)/events/(event)/orders/(code)/payments/
 
    Returns a list of all payments for an order.
@@ -2045,6 +2265,7 @@ Order refund endpoints
             "created": "2017-12-01T10:00:00Z",
             "execution_date": "2017-12-04T12:13:12Z",
             "comment": "Cancellation",
+            "details": {},
             "provider": "banktransfer"
           }
         ]
@@ -2088,6 +2309,7 @@ Order refund endpoints
         "created": "2017-12-01T10:00:00Z",
         "execution_date": "2017-12-04T12:13:12Z",
         "comment": "Cancellation",
+        "details": {},
         "provider": "banktransfer"
       }
 
@@ -2145,6 +2367,7 @@ Order refund endpoints
         "created": "2017-12-01T10:00:00Z",
         "execution_date": null,
         "comment": "Cancellation",
+        "details": {},
         "provider": "manual"
       }
 
@@ -2274,10 +2497,6 @@ Revoked ticket secrets
 
 With some non-default ticket secret generation methods, a list of revoked ticket secrets is required for proper validation.
 
-.. versionchanged:: 3.12
-
-   Added revocation lists.
-
 .. http:get:: /api/v1/organizers/(organizer)/events/(event)/revokedsecrets/
 
    Returns a list of all revoked secrets within a given event.

doc/api/resources/organizers.rst

@@ -109,10 +109,6 @@ information about the properties.
 .. warning:: This API is intended for advanced users. Even though we take care to validate your input, you will be
              able to break your shops using this API by creating situations of conflicting settings. Please take care.
 
-.. versionchanged:: 3.14
-
-   Initial support for settings has been added to the API.
-
 .. http:get:: /api/v1/organizers/(organizer)/settings/
 
    Get current values of organizer settings.

doc/api/resources/questions.rst

@@ -76,26 +76,9 @@ dependency_value                      string                     An old version
                                                                  for one value. **Deprecated.**
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 3.5
-
-  The attribute ``help_text`` has been added.
-
-.. versionchanged:: 3.14
-
-  The attributes ``valid_*`` have been added.
-
-.. versionchanged:: 3.18
-
-  The attribute ``valid_file_portrait`` have been added.
-
 Endpoints
 ---------
 
-.. versionchanged:: 1.15
-
-   The questions endpoint has been extended by the filter queries ``ask_during_checkin``, ``requred``, and
-   ``identifier``.
-
 .. http:get:: /api/v1/organizers/(organizer)/events/(event)/questions/
 
    Returns a list of all questions within a given event.

doc/api/resources/quotas.rst

@@ -36,10 +36,6 @@ available_number                      integer                    Number of avail
                                                                  slightly out of date. ``null`` means unlimited.
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 3.10
-
-   The attribute ``release_after_exit`` has been added.
-
 .. versionchanged:: 4.1
 
     The ``with_availability`` query parameter has been added.
@@ -89,7 +85,8 @@ Endpoints
    :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 ``id`` and ``position``.
                            Default: ``position``
-   :query integer subevent: Only return quotas of the sub-event with the given ID
+   :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 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

doc/api/resources/sendmail_rules.rst

@@ -0,0 +1,281 @@
+Automated email rules
+=====================
+
+Resource description
+--------------------
+
+Automated email rules that specify emails that the system will send automatically at a specific point in time, e.g.
+the day of the event.
+
+.. rst-class:: rest-resource-table
+
+===================================== ========================== =======================================================
+Field                                 Type                       Description
+===================================== ========================== =======================================================
+id                                    integer                    Internal ID of the rule
+enabled                               boolean                    If ``false``, the rule is ignored
+subject                               multi-lingual string       The subject of the email
+template                              multi-lingual string       The body of the email
+all_products                          boolean                    If ``true``, the email is sent to buyers of all products
+limit_products                        list of integers           List of product IDs, if ``all_products`` is not set
+include_pending                       boolean                    If ``true``, the email is sent to pending orders. If ``false``,
+                                                                 only paid orders are considered.
+date_is_absolute                      boolean                    If ``true``, the email is set at a specific point in time.
+send_date                             datetime                   If ``date_is_absolute`` is set: Date and time to send the email.
+send_offset_days                      integer                    If ``date_is_absolute`` is not set, this is the number of days
+                                                                 before/after the email is sent.
+send_offset_time                      time                       If ``date_is_absolute`` is not set, this is the time of day the
+                                                                 email is sent on the day specified by ``send_offset_days``.
+offset_to_event_end                   boolean                    If ``true``, ``send_offset_days`` is relative to the event end
+                                                                 date. Otherwise it is relative to the event start date.
+offset_is_after                       boolean                    If ``true``, ``send_offset_days`` is the number of days **after**
+                                                                 the event start or end date. Otherwise it is the number of days
+                                                                 **before**.
+send_to                               string                     Can be ``"orders"`` if the email should be sent to customers
+                                                                 (one email per order),
+                                                                 ``"attendees"`` if the email should be sent to every attendee,
+                                                                 or ``"both"``.
+                                                                 date. Otherwise it is relative to the event start date.
+===================================== ========================== =======================================================
+
+
+Endpoints
+---------
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/sendmail_rules/
+
+   Returns a list of all rules configured for an event.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/sendmail_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,
+            "enabled": true,
+            "subject": {"en": "See you tomorrow!"},
+            "template": {"en": "Don't forget your tickets, download them at {url}"},
+            "all_products": true,
+            "limit_products": [],
+            "include_pending": false,
+            "send_date": null,
+            "send_offset_days": 1,
+            "send_offset_time": "18:00",
+            "date_is_absolute": false,
+            "offset_to_event_end": false,
+            "offset_is_after": false,
+            "send_to": "orders"
+          }
+        ]
+      }
+
+   :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)/sendmail_rules/(id)/
+
+   Returns information on one rule, identified by its ID.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/sendmail_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,
+        "enabled": true,
+        "subject": {"en": "See you tomorrow!"},
+        "template": {"en": "Don't forget your tickets, download them at {url}"},
+        "all_products": true,
+        "limit_products": [],
+        "include_pending": false,
+        "send_date": null,
+        "send_offset_days": 1,
+        "send_offset_time": "18:00",
+        "date_is_absolute": false,
+        "offset_to_event_end": false,
+        "offset_is_after": false,
+        "send_to": "orders"
+      }
+
+   :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)/sendmail_rules/
+
+   Create a new rule.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/sendmail_rules/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+      Content-Length: 166
+
+      {
+        "enabled": true,
+        "subject": {"en": "See you tomorrow!"},
+        "template": {"en": "Don't forget your tickets, download them at {url}"},
+        "all_products": true,
+        "limit_products": [],
+        "include_pending": false,
+        "send_date": null,
+        "send_offset_days": 1,
+        "send_offset_time": "18:00",
+        "date_is_absolute": false,
+        "offset_to_event_end": false,
+        "offset_is_after": false,
+        "send_to": "orders"
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 201 Created
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "id": 1,
+        "enabled": true,
+        "subject": {"en": "See you tomorrow!"},
+        "template": {"en": "Don't forget your tickets, download them at {url}"},
+        "all_products": true,
+        "limit_products": [],
+        "include_pending": false,
+        "send_date": null,
+        "send_offset_days": 1,
+        "send_offset_time": "18:00",
+        "date_is_absolute": false,
+        "offset_to_event_end": false,
+        "offset_is_after": false,
+        "send_to": "orders"
+      }
+
+   :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)/sendmail_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/sendmail_rules/1/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+      Content-Length: 34
+
+      {
+        "enabled": false,
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: text/javascript
+
+      {
+        "id": 1,
+        "enabled": false,
+        "subject": {"en": "See you tomorrow!"},
+        "template": {"en": "Don't forget your tickets, download them at {url}"},
+        "all_products": true,
+        "limit_products": [],
+        "include_pending": false,
+        "send_date": null,
+        "send_offset_days": 1,
+        "send_offset_time": "18:00",
+        "date_is_absolute": false,
+        "offset_to_event_end": false,
+        "offset_is_after": false,
+        "send_to": "orders"
+      }
+
+   :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)/sendmail_rules/(id)/
+
+   Delete a rule.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      DELETE /api/v1/organizers/bigevents/events/sampleconf/sendmail_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/shredders.rst

@@ -0,0 +1,177 @@
+.. spelling:: checkin
+
+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.
+
+Listing available shredders
+---------------------------
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/shredders/
+
+   Returns a list of all exporters shredders for a given event.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/shredders/ 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": "question_answers",
+            "verbose_name": "Answers to questions"
+          }
+        ]
+      }
+
+   :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
+   :param event: The ``slug`` field of the event 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.
+
+Running an export
+-----------------
+
+Before you can delete data, you need to start a data export.
+Since exports often include large data sets, they might take longer than the duration of an HTTP request. Therefore,
+creating an export is a two-step process. First you need to start an export task with one of the following to API
+endpoints:
+
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/shredders/export/
+
+   Starts an export task. If your input parameters validate correctly, a ``202 Accepted`` status code is returned.
+   The body points you to the download URL of the result as well as the URL for the next step.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/shredders/export/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+
+      {
+        "shredders": ["question_answers"]
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 202 Accepted
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "download": "https://pretix.eu/api/v1/organizers/bigevents/events/sampleconf/shredders/download/29891ede-196f-4942-9e26-d055a36e98b8/3f279f13-c198-4137-b49b-9b360ce9fcce/",
+        "shred": "https://pretix.eu/api/v1/organizers/bigevents/events/sampleconf/shredders/shred/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 identifier: The ``identifier`` field of the exporter to run
+   :statuscode 202: no error
+   :statuscode 400: Invalid input options or event data is not ready to be deleted
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
+
+
+Downloading the result
+----------------------
+
+When starting an export, you receive a ``download`` URL for downloading the result. Running a ``GET`` request on that result 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 / belongs to a different API key.
+
+
+Shredding the data
+------------------
+
+When starting an export, you receive a ``shred`` URL for actually shredding the data.
+You can only start the actual shredding process after the export file was generated, however you are not forced to download
+the file (we'd recommend it in most cases, though).
+The download will no longer be possible after the shredding.
+Since shredding often requires deleting large data sets, it might take longer than the duration of an HTTP request.
+Therefore, shredding again is a two-step process. First you need to start a shredder task with one of the following to API
+endpoints:
+
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/shredders/shred/(id1)/(id2)/
+
+   Starts an export task. If your input parameters validate correctly, a ``202 Accepted`` status code is returned.
+   The body points you to an URL you can use to check the status.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/shredders/shred/29891ede-196f-4942-9e26-d055a36e98b8/3f279f13-c198-4137-b49b-9b360ce9fcce/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 202 Accepted
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "status": "https://pretix.eu/api/v1/organizers/bigevents/events/sampleconf/shredders/status/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 id1: Opaque value given to you in the previous response
+   :param id2: Opaque value given to you in the previous response
+   :statuscode 202: no error
+   :statuscode 400: Invalid input options
+   :statuscode 401: Authentication failure
+   :statuscode 404: The export does not exist / is expired / belongs to a different API key.
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
+   :statuscode 409: 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.
+   :statuscode 410: Either the job has timed out or running the export has failed permanently. The body will be JSON with the structure ``{"status": "failed", "message": "Error message"}``
+
+
+Checking the result
+-------------------
+
+When starting to shred, you receive a ``status`` URL for checking for success.
+Running a ``GET`` request on that result will yield one of the following status codes:
+
+* ``200 OK`` – The shredding succeeded.
+* ``409 Conflict`` – Shredding 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`` – We no longer know about this process, probably the process was started more than an hour ago. Might also occur after successful operations on small pretix installations without asynchronous task handling.
+* ``417 Expectation Failed`` – Running the export has failed permanently. The body will be JSON with the structure ``{"status": "failed", "message": "Error message"}``

doc/api/resources/subevents.rst

@@ -59,29 +59,13 @@ seat_category_mapping                 object                     An object mappi
 last_modified                         datetime                   Last modification of this object
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 3.3
+.. versionchanged:: 4.15
 
-   The attributes ``geo_lat`` and ``geo_lon`` have been added.
-
-.. versionchanged:: 3.10
-
-   The ``disabled`` attribute has been added to ``item_price_overrides`` and ``variation_price_overrides``.
-
-.. versionchanged:: 3.12
-
-   The ``last_modified`` attribute has been added.
-
-.. versionchanged:: 3.18
-
-   The ``available_from``/``available_until`` attributes have been added to ``item_price_overrides`` and ``variation_price_overrides``.
+    The ``search`` query parameter has been added to filter sub-events by their name or location in any language.
 
 Endpoints
 ---------
 
-.. versionchanged:: 3.3
-
-    The sub-events resource can now be filtered by meta data attributes.
-
 .. versionchanged:: 4.1
 
     The ``with_availability_for`` parameter has been added.
@@ -147,6 +131,7 @@ Endpoints
    :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.
    :query ends_after: If set to a date and time, only events that happen during of after the given time are returned.
+   :query search: Only return events matching a given search query.
    :param organizer: The ``slug`` field of a valid organizer
    :param event: The ``slug`` field of the main event
    :query datetime modified_since: Only return objects that have changed since the given date. Be careful: This does not
@@ -474,6 +459,7 @@ Endpoints
    :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.
    :query ends_after: If set to a date and time, only events that happen during of after the given time are returned.
+   :query sales_channel: If set to a sales channel identifier, the response will only contain subevents from events available on this sales channel.
    :param organizer: The ``slug`` field of a valid organizer
    :param event: The ``slug`` field of the event to fetch
    :statuscode 200: no error

doc/api/resources/taxrules.rst

@@ -16,15 +16,22 @@ Field                                 Type                       Description
 ===================================== ========================== =======================================================
 id                                    integer                    Internal ID of the tax rule
 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
 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
 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
+                                                                 rules keep the gross price constant (default is ``false``)
 ===================================== ========================== =======================================================
 
 
+.. versionchanged:: 4.6
+
+    The ``internal_name`` and ``keep_gross_if_rate_changes`` attributes have been added.
+
 Endpoints
 ---------
 
@@ -56,9 +63,11 @@ Endpoints
           {
             "id": 1,
             "name": {"en": "VAT"},
+            "internal_name": "VAT",
             "rate": "19.00",
             "price_includes_tax": true,
             "eu_reverse_charge": false,
+            "keep_gross_if_rate_changes": false,
             "home_country": "DE"
           }
         ]
@@ -94,9 +103,11 @@ Endpoints
       {
         "id": 1,
         "name": {"en": "VAT"},
+        "internal_name": "VAT",
         "rate": "19.00",
         "price_includes_tax": true,
         "eu_reverse_charge": false,
+        "keep_gross_if_rate_changes": false,
         "home_country": "DE"
       }
 
@@ -140,9 +151,11 @@ Endpoints
       {
         "id": 1,
         "name": {"en": "VAT"},
+        "internal_name": "VAT",
         "rate": "19.00",
         "price_includes_tax": true,
         "eu_reverse_charge": false,
+        "keep_gross_if_rate_changes": false,
         "home_country": "DE"
       }
 
@@ -185,9 +198,11 @@ Endpoints
       {
         "id": 1,
         "name": {"en": "VAT"},
+        "internal_name": "VAT",
         "rate": "20.00",
         "price_includes_tax": true,
         "eu_reverse_charge": false,
+        "keep_gross_if_rate_changes": false,
         "home_country": "DE"
       }
 

doc/api/resources/vouchers.rst

@@ -1,3 +1,5 @@
+.. _`rest-vouchers`:
+
 Vouchers
 ========
 
@@ -17,6 +19,8 @@ max_usages                            integer                    The maximum num
                                                                  redeemed (default: 1).
 redeemed                              integer                    The number of times this voucher already has been
                                                                  redeemed.
+min_usages                            integer                    The minimum number of times this voucher must be
+                                                                 redeemed on first usage (default: 1).
 valid_until                           datetime                   The voucher expiration date (or ``null``).
 block_quota                           boolean                    If ``true``, quota is blocked for this voucher.
 allow_ignore_quota                    boolean                    If ``true``, this voucher can be redeemed even if a
@@ -46,10 +50,6 @@ show_hidden_items                     boolean                    Only if set to
 ===================================== ========================== =======================================================
 
 
-.. versionchanged:: 3.4
-
-   The attribute ``seat`` has been added.
-
 Endpoints
 ---------
 

doc/api/resources/waitinglist.rst

@@ -30,12 +30,6 @@ subevent                              integer                    ID of the date
 ===================================== ========================== =======================================================
 
 
-.. versionchanged:: 1.15
-
-   The write operations ``POST``, ``PATCH``, ``PUT``, and ``DELETE`` have been added as well as a method to send out
-   vouchers.
-
-
 Endpoints
 ---------
 

doc/api/resources/webhooks.rst

@@ -36,10 +36,16 @@ The following values for ``action_types`` are valid with pretix core:
     * ``pretix.event.order.canceled``
     * ``pretix.event.order.reactivated``
     * ``pretix.event.order.expired``
+    * ``pretix.event.order.expirychanged``
     * ``pretix.event.order.modified``
     * ``pretix.event.order.contact.changed``
     * ``pretix.event.order.changed.*``
+    * ``pretix.event.order.refund.created``
     * ``pretix.event.order.refund.created.externally``
+    * ``pretix.event.order.refund.requested``
+    * ``pretix.event.order.refund.done``
+    * ``pretix.event.order.refund.canceled``
+    * ``pretix.event.order.refund.failed``
     * ``pretix.event.order.approved``
     * ``pretix.event.order.denied``
     * ``pretix.event.checkin``
@@ -50,6 +56,10 @@ The following values for ``action_types`` are valid with pretix core:
     * ``pretix.subevent.added``
     * ``pretix.subevent.changed``
     * ``pretix.subevent.deleted``
+    * ``pretix.event.live.activated``
+    * ``pretix.event.live.deactivated``
+    * ``pretix.event.testmode.activated``
+    * ``pretix.event.testmode.deactivated``
 
 Installed plugins might register more valid values.
 

doc/api/webhooks.rst

@@ -92,9 +92,10 @@ If any other status code is returned, we will assume you did not receive the cal
 or ``304 Not Modified`` response will be treated as a failure. pretix will not follow any ``301`` or ``302`` redirect
 headers and pretix will ignore all other information in your response headers or body.
 
-If we do not receive a status code in the range of ``200`` and ``299``, pretix will retry to deliver for up to three
-days with an exponential back off. Therefore, we recommend that you implement your endpoint in a way where calling it
-multiple times for the same event due to a perceived error does not do any harm.
+If we do not receive a status code in the range of ``200`` and ``299`` or do not receive any response within a 30 second
+time frame, pretix will retry to deliver for up to three days with an exponential back off. Therefore, we recommend that
+you implement your endpoint in a way where calling it multiple times for the same event due to a perceived error does
+not do any harm.
 
 There is only one exception: If status code ``410 Gone`` is returned, we will assume the
 endpoint does not exist any more and automatically disable the webhook.

doc/development/algorithms/index.rst

@@ -2,12 +2,13 @@ Algorithms
 ==========
 
 The business logic inside pretix is full of complex algorithms making decisions based on all the hundreds of settings
-and input parameters available. Some of them are documented here as graphs, either because fully understanding them is very
+and input parameters available. Some of them are documented here as graphs, either because fully understanding them is very important
 when working on features close to them, or because they also need to be re-implemented by client-side components like our
 ticket scanning apps and we want to ensure the implementations are as similar as possible to avoid confusion.
 
 .. toctree::
    :maxdepth: 2
 
+   pricing
    checkin
    layouts

doc/development/algorithms/pricing.rst

@@ -0,0 +1,180 @@
+.. _`algorithms-pricing`:
+
+Pricing algorithms
+==================
+
+With pretix being an e-commerce application, one of its core tasks is to determine the price of a purchase. With the
+complexity allowed by our range of features, this is not a trivial task and there are many edge cases that need to be
+clearly defined. The most challenging part about this is that there are many situations in which a price might change
+while the user is going through the checkout process and we're learning more information about them or their purchase.
+For example, prices change when
+
+* The cart expires and the listed prices changed in the meantime
+* The user adds an invoice address that triggers a change in taxation
+* The user chooses a custom price for an add-on product and adjusts the price later on
+* The user adds a voucher to their cart
+* An automatic discount is applied
+
+For the purposes of this page, we're making a distinction between "naive prices" (which are just a plain number like 23.00), and
+"taxed prices" (which are a combination of a net price, a tax rate, and a gross price, like 19.33 + 19% = 23.00).
+
+Computation of listed prices
+----------------------------
+
+When showing a list of products, e.g. on the event front page, we always need to show a price. This price is what we
+call the "listed price" later on.
+
+To compute the listed price, we first use the ``default_price`` attribute of the ``Item`` that is being shown.
+If we are showing an ``ItemVariation`` and that variation has a ``default_price`` set on itself, the variation's price
+takes precedence and replaces the item's price.
+If we're in an event series and there exists a ``SubEventItem`` or ``SubEventItemVariation`` with a price set, the
+subevent's price configuration takes precedence over both the item as well as the variation and replaces the listed price.
+
+Listed prices are naive prices. Before we actually show them to the user, we need to check if ``TaxRule.price_includes_tax``
+is set to determine if we need to add tax or subtract tax to get to the taxed price. We then consider the event's
+``display_net_prices`` setting to figure out which way to present the taxed price in the interface.
+
+Guarantees on listed prices
+---------------------------
+
+One goal of all further logic is that if a user sees a listed price, they are guaranteed to get the product at that
+price as long as they complete their purchase within the cart expiration time frame. For example, if the cart expiration
+time is set to 30 minutes and someone puts a item listed at €23 in their cart at 4pm, they can still complete checkout
+at €23 until 4.30pm, even if the organizer decides to raise the price to €25 at 4.10pm. If they complete checkout after
+4.30pm, their cart will be adjusted to the new price and the user will see a warning that the price has changed.
+
+Computation of cart prices
+--------------------------
+
+Input
+"""""
+
+To ensure the guarantee mentioned above, even in the light of all possible dynamic changes, the ``listed_price``
+is explicitly stored in the ``CartPosition`` model after the item has been added to the cart.
+
+If ``Item.free_price`` is set, the user is allowed to voluntarily increase the price. In this case, the user's input
+is stored as ``custom_price_input`` without much further validation for use further down below in the process.
+If ``display_net_prices`` is set, the user's input is also considered to be a net price and ``custom_price_input_is_net``
+is stored for the cart position. In any other case, the user's input is considered to be a gross price based on the tax
+rules' default tax rate.
+
+The computation of prices in the cart always starts from the ``listed_price``. The ``list_price`` is only computed
+when adding the product to the cart or when extending the cart's lifetime after it expired. All other steps such as
+creating an order based on the cart trust ``list_price`` without further checks.
+
+Vouchers
+""""""""
+
+As a first step, the cart is checked for any voucher that should be applied to the position. If such a voucher exists,
+it's discount (percentage or fixed) is applied to the listed price. The result of this is stored to ``price_after_voucher``.
+Since ``listed_price`` naive, ``price_after_voucher`` is naive as well. As a consequence, if you have a voucher configured
+to "set the price to €10", it depends on ``TaxRule.price_includes_tax`` again whether this is €10 including or excluding
+taxes.
+
+The ``price_after_voucher`` is only computed when adding the product to the cart or when extending the cart's
+lifetime after it expired. It is also checked again when the order is created, since the available discount might have
+changed due to the voucher's budget being (almost) exhausted.
+
+Line price
+""""""""""
+
+The next step computes the final price of this position if it is the only position in the cart. This happens in "reverse
+order", i.e. before the computation can be performed for a cart position, the step needs to be performed on all of its
+bundled positions. The sum of ``price_after_voucher`` of all bundled positions is now called ``bundled_sum``.
+
+First, the value from ``price_after_voucher`` will be processed by the applicable ``TaxRule.tax()`` (which is complex
+in itself but is not documented here in detail at the moment).
+
+If ``custom_price_input`` is not set, ``bundled_sum`` will be subtracted from the gross price and the net price is
+adjusted accordingly. The result is stored as ``tax_rate`` and ``line_price_gross`` in the cart position.
+
+If ``custom_price_input`` is set, the value will be compared to either the gross or the net value of the ``tax()``
+result, depending on ``custom_price_input_is_net``. If the comparison yields that the custom price is higher, ``tax()``
+will be called again . Then, ``bundled_sum`` will be subtracted from the gross price and the result is stored like
+above.
+
+The computation of ``line_price_gross`` from ``price_after_voucher``, ``custom_price_input``, and tax settings
+is repeated after every change of anything in the cart or after every change of the invoice address.
+
+Discounts
+---------
+
+After ``line_price_gross`` has been computed for all positions, the discount engine will run to apply any automatic
+discounts. Organizers can add rules for automatic discounts in the pretix backend. These rules are ordered and
+will be applied in order. Every cart position can only be "used" by one discount rule. "Used" can either mean that
+the price of the position was actually discounted, but it can also mean that the position was required to enable
+a discount for a different position, e.g. in case of a "buy 3 for the price of 2" offer.
+
+The algorithm for applying an individual discount rule first starts with eliminating all products that do not match
+the rule based on its product scope. Then, the algorithm is handled differently for different configurations.
+
+Case 1: Discount based on minimum value without respect to subevents
+""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+
+* Check whether the gross sum of all positions is at least ``condition_min_value``, otherwise abort.
+
+* Reduce the price of all positions by ``benefit_discount_matching_percent``.
+
+* Mark all positions as "used" to hide them from further rules
+
+Case 2: Discount based on minimum number of tickets without respect to subevents
+""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+
+* Check whether the number of all positions is at least ``condition_min_count``, otherwise abort.
+
+* If ``benefit_only_apply_to_cheapest_n_maches`` is set,
+
+    * Sort all positions by price.
+    * Reduce the price of the first ``n_positions // condition_min_count * benefit_only_apply_to_cheapest_n_matches`` positions by ``benefit_discount_matching_percent``.
+    * Mark the first ``n_positions // condition_min_count * condition_min_count`` as "used" to hide them from further rules.
+    * Mark all positions as "used" to hide them from further rules.
+
+* Else,
+
+    * Reduce the price of all positions by ``benefit_discount_matching_percent``.
+    * Mark all positions as "used" to hide them from further rules.
+
+Case 3: Discount only for products of the same subevent
+"""""""""""""""""""""""""""""""""""""""""""""""""""""""
+
+* Split the cart into groups based on the subevent.
+
+* Proceed with case 1 or 2 for every group.
+
+Case 4: Discount only for products of distinct subevents
+""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+
+* Let ``subevents`` be a list of distinct subevents in the cart.
+
+* Let ``positions[subevent]`` be a list of positions for every subevent.
+
+* Let ``current_group`` be the current group and ``groups`` the list of all groups.
+
+* Repeat
+
+    * Order ``subevents`` by the length of their ``positions[subevent]`` list, starting with the longest list.
+      Do not count positions that are part of ``current_group`` already.
+
+    * Let ``candidates`` be the concatenation of all ``positions[subevent]`` lists with the same length as the
+      longest list.
+
+    * If ``candidates`` is empty, abort the repetition.
+
+    * Order ``candidates`` by their price, starting with the lowest price.
+
+    * Pick one entry from ``candidates`` and put it into ``current_group``. If ``current_group`` is shorter than
+      ``benefit_only_apply_to_cheapest_n_matches``, we pick from the start (lowest price), otherwise we pick from
+      the end (highest price)
+
+    * If ``current_group`` is now ``condition_min_count``, remove all entries from ``current_group`` from
+      ``positions[…]``, add ``current_group`` to ``groups``, and reset ``current_group`` to an empty group.
+
+* For every position still left in a ``positions[…]`` list, try if there is any ``group`` in groups that it can
+  still be added to without violating the rule of distinct subevents
+
+* For every group in ``groups``, proceed with case 1 or 2.
+
+Flowchart
+---------
+
+.. image:: /images/cart_pricing.png

doc/development/api/auth.rst

@@ -20,20 +20,31 @@ Basically, three pre-defined flows are supported:
 * Authentication mechanisms that rely on **redirection**, e.g. to an OAuth provider. These can be implemented by
   supplying a ``authentication_url`` method and implementing a custom return view.
 
-Authentication backends are *not* collected through a signal. Instead, they must explicitly be set through the
-``auth_backends`` directive in the ``pretix.cfg`` :ref:`configuration file <config>`.
+For security reasons, authentication backends are *not* automatically discovered through a signal. Instead, they must
+explicitly be set through the ``auth_backends`` directive in the ``pretix.cfg`` :ref:`configuration file <config>`.
 
-In each of these methods (``form_authenticate``, ``request_authenticate`` or your custom view) you are supposed to
-either get an existing :py:class:`pretix.base.models.User` object from the database or create a new one. There are a
-few rules you need to follow:
+In each of these methods (``form_authenticate``, ``request_authenticate``, or your custom view) you are supposed to
+use ``User.objects.get_or_create_for_backend`` to get a :py:class:`pretix.base.models.User` object from the database
+or create a new one.
 
-* You **MUST** only return users with the ``auth_backend`` attribute set to the ``identifier`` value of your backend.
+There are a few rules you need to follow:
 
-* You **MUST** create new users with the ``auth_backend`` attribute set to the ``identifier`` value of your backend.
+* You **MUST** have some kind of identifier for a user that is globally unique and **SHOULD** never change, even if the
+  user's name or email address changes. This could e.g. be the ID of the user in an external database. The identifier
+  must not be longer than 190 characters. If you worry your backend might generated longer identifiers, consider
+  using a hash function to trim them to a constant length.
+
+* You **SHOULD** not allow users created by other authentication backends to log in through your code, and you **MUST**
+  only create, modify or return users with ``auth_backend`` set to your backend.
 
 * Every user object **MUST** have an email address. Email addresses are globally unique. If the email address is
   already registered to a user who signs in through a different backend, you **SHOULD** refuse the login.
 
+``User.objects.get_or_create_for_backend`` will follow these rules for you automatically. It works like this:
+
+.. autoclass:: pretix.base.models.auth.UserManager
+   :members: get_or_create_for_backend
+
 The backend interface
 ---------------------
 
@@ -59,6 +70,7 @@ The backend interface
 
    .. automethod:: authentication_url
 
+
 Logging users in
 ----------------
 
@@ -68,3 +80,45 @@ recommend that you use the following utility method to correctly set session val
 authentication (if activated):
 
 .. autofunction:: pretix.control.views.auth.process_login
+
+A custom view that is called after a redirect from an external identity provider could look like this::
+
+   from django.contrib import messages
+   from django.shortcuts import redirect
+   from django.urls import reverse
+
+   from pretix.base.models import User
+   from pretix.base.models.auth import EmailAddressTakenError
+   from pretix.control.views.auth import process_login
+
+
+   def return_view(request):
+       # Verify validity of login with the external provider's API
+       api_response = my_verify_login_function(
+           code=request.GET.get('code')
+       )
+
+       try:
+           u = User.objects.get_or_create_for_backend(
+               'my_backend_name',
+               api_response['userid'],
+               api_response['email'],
+               set_always={
+                   'fullname': '{} {}'.format(
+                       api_response.get('given_name', ''),
+                       api_response.get('family_name', ''),
+                   ),
+               },
+               set_on_creation={
+                   'locale': api_response.get('locale').lower()[:2],
+                   'timezone': api_response.get('zoneinfo', 'UTC'),
+               }
+           )
+       except EmailAddressTakenError:
+           messages.error(
+               request, _('We cannot create your user account as a user account in this system '
+                          'already exists with the same email address.')
+           )
+           return redirect(reverse('control:auth.login'))
+       else:
+           return process_login(request, u, keep_logged_in=False)

doc/development/api/cookieconsent.rst

@@ -0,0 +1,119 @@
+.. highlight:: python
+   :linenothreshold: 5
+
+.. _`cookieconsent`:
+
+Handling cookie consent
+=======================
+
+pretix includes an optional feature to handle cookie consent explicitly to comply with EU regulations.
+If your plugin sets non-essential cookies or includes a third-party service that does so, you should
+integrate with this feature.
+
+Server-side integration
+-----------------------
+
+First, you need to declare that you are using non-essential cookies by responding to the following
+signal:
+
+.. automodule:: pretix.presale.signals
+   :members: register_cookie_providers
+
+You are expected to return a list of ``CookieProvider`` objects instantiated from the following class:
+
+.. class:: pretix.presale.cookies.CookieProvider
+
+   .. py:attribute:: CookieProvider.identifier
+
+      A short and unique identifier used to distinguish this cookie provider form others (required).
+
+   .. py:attribute:: CookieProvider.provider_name
+
+      A human-readable name of the entity of feature responsible for setting the cookie (required).
+
+   .. py:attribute:: CookieProvider.usage_classes
+
+      A list of enum values from the ``pretix.presale.cookies.UsageClass`` enumeration class, such as
+      ``UsageClass.ANALYTICS``, ``UsageClass.MARKETING``, or ``UsageClass.SOCIAL`` (required).
+
+   .. py:attribute:: CookieProvider.privacy_url
+
+      A link to a privacy policy (optional).
+
+Here is an example of such a receiver:
+
+.. code-block:: python
+
+   @receiver(register_cookie_providers)
+   def recv_cookie_providers(sender, request, **kwargs):
+       return [
+           CookieProvider(
+               identifier='google_analytics',
+               provider_name='Google Analytics',
+               usage_classes=[UsageClass.ANALYTICS],
+           )
+       ]
+
+JavaScript-side integration
+---------------------------
+
+The server-side integration only causes the cookie provider to show up in the cookie dialog. You still
+need to care about actually enforcing the consent state.
+
+You can access the consent state through the ``window.pretix.cookie_consent`` variable. Whenever the
+value changes, a ``pretix:cookie-consent:change`` event is fired on the ``document`` object.
+
+The variable will generally have one of the following states:
+
+.. rst-class:: rest-resource-table
+
+================================================================ =====================================================
+State                                                            Interpretation
+================================================================ =====================================================
+``pretix === undefined || pretix.cookie_consent === undefined``  Your JavaScript has loaded before the cookie consent
+                                                                 script. Wait for the event to be fired, then try again,
+                                                                 do not yet set a cookie.
+``pretix.cookie_consent === null``                               The cookie consent mechanism has not been enabled. This
+                                                                 usually means that you can set cookies however you like.
+``pretix.cookie_consent[identifier] === undefined``              The cookie consent mechanism is loaded, but has no data
+                                                                 on your cookie yet, wait for the event to be fired, do not
+                                                                 yet set a cookie.
+``pretix.cookie_consent[identifier] === true``                   The user has consented to your cookie.
+``pretix.cookie_consent[identifier] === false``                  The user has actively rejected your cookie.
+================================================================ =====================================================
+
+If you are integrating e.g. a tracking provider with native cookie consent support such
+as Facebook's Pixel, you can integrate it like this:
+
+.. code-block:: javascript
+
+     var consent = (window.pretix || {}).cookie_consent;
+     if (consent !== null && !(consent || {}).facebook) {
+         fbq('consent', 'revoke');
+     }
+     fbq('init', ...);
+     document.addEventListener('pretix:cookie-consent:change', function (e) {
+         fbq('consent', (e.detail || {}).facebook ? 'grant' : 'revoke');
+     })
+
+If you have a JavaScript function that you only want to load if consent for a specific ``identifier``
+is given, you can wrap it like this:
+
+.. code-block:: javascript
+
+     var consent_identifier = "youridentifier";
+     var consent = (window.pretix || {}).cookie_consent;
+     if (consent === null || (consent || {})[consent_identifier] === true) {
+         // Cookie consent tool is either disabled or consent is given
+         addScriptElement(src);
+         return;
+     }
+
+     // Either cookie consent tool has not loaded yet or consent is not given
+     document.addEventListener('pretix:cookie-consent:change', function onChange(e) {
+         var consent = e.detail || {};
+         if (consent === null || consent[consent_identifier] === true) {
+             addScriptElement(src);
+             document.removeEventListener('pretix:cookie-consent:change', onChange);
+         }
+     })

doc/development/api/exporter.rst

@@ -60,7 +60,13 @@ The exporter class
    .. py:attribute:: BaseExporter.event
 
       The default constructor sets this property to the event we are currently
-      working for.
+      working for. This will be ``None`` if the exporter is run for multiple
+      events.
+
+   .. py:attribute:: BaseExporter.events
+
+      The default constructor sets this property to the list of events to work
+      on, regardless of whether the exporter is called for one or multiple events.
 
    .. autoattribute:: identifier
 

doc/development/api/index.rst

@@ -17,6 +17,7 @@ Contents:
    shredder
    import
    customview
+   cookieconsent
    auth
    general
    quality

doc/development/api/payment.rst

@@ -62,6 +62,8 @@ The provider class
 
    .. autoattribute:: public_name
 
+   .. autoattribute:: confirm_button_name
+
    .. autoattribute:: is_enabled
 
    .. autoattribute:: priority
@@ -124,6 +126,8 @@ The provider class
 
    .. automethod:: api_payment_details
 
+   .. automethod:: api_refund_details
+
    .. automethod:: matching_id
 
    .. automethod:: shred_payment_info
@@ -134,6 +138,10 @@ The provider class
 
    .. autoattribute:: is_meta
 
+   .. autoattribute:: execute_payment_needs_user
+
+   .. autoattribute:: multi_use_supported
+
    .. autoattribute:: test_mode_message
 
    .. autoattribute:: requires_invoice_immediately

doc/development/api/plugins.rst

@@ -45,13 +45,17 @@ Attribute          Type                 Description
 name               string               The human-readable name of your plugin
 author             string               Your name
 version            string               A human-readable version code of your plugin
-description        string               A more verbose description of what your plugin does.
+description        string               A more verbose description of what your plugin does. May contain HTML.
 category           string               Category of a plugin. Either one of ``"FEATURE"``, ``"PAYMENT"``,
                                         ``"INTEGRATION"``, ``"CUSTOMIZATION"``, ``"FORMAT"``, or ``"API"``,
                                         or any other string.
+picture            string (optional)    Path to a picture resolvable through the static file system.
+featured           boolean (optional)   ``False`` by default, can promote a plugin if it's something many users will want, use carefully.
 visible            boolean (optional)   ``True`` by default, can hide a plugin so it cannot be normally activated.
 restricted         boolean (optional)   ``False`` by default, restricts a plugin such that it can only be enabled
                                         for an event by system administrators / superusers.
+experimental       boolean (optional)   ``False`` by default, marks a plugin as an experimental feature in the plugins list.
+picture            string (optional)    Path to a picture resolvable through the static file system.
 compatibility      string               Specifier for compatible pretix versions.
 ================== ==================== ===========================================================
 
@@ -74,8 +78,10 @@ A working example would be:
             name = _("PayPal")
             author = _("the pretix team")
             version = '1.0.0'
-            category = 'PAYMENT
+            category = 'PAYMENT'
+            picture = 'pretix_paypal/paypal_logo.svg'
             visible = True
+            featured = False
             restricted = False
             description = _("This plugin allows you to receive payments via PayPal")
             compatibility = "pretix>=2.7.0"
@@ -92,6 +98,7 @@ those will be displayed but not block the plugin execution.
 
 The ``AppConfig`` class may implement a method ``is_available(event)`` that checks if a plugin
 is available for a specific event. If not, it will not be shown in the plugin list of that event.
+You should not define ``is_available`` and ``restricted`` on the same plugin.
 
 Plugin registration
 -------------------

doc/development/contribution/style.rst

@@ -1,6 +1,11 @@
+.. spelling:: Rebase rebasing
+
 Coding style and quality
 ========================
 
+Code
+----
+
 * Basically, we want all python code to follow the `PEP 8`_ standard. There are a few exceptions where
   we see things differently or just aren't that strict. The ``setup.cfg`` file in the project's source
   folder contains definitions that allow `flake8`_ to check for violations automatically. See :ref:`checksandtests`
@@ -20,8 +25,62 @@ Coding style and quality
   test suite are in the style of Python's unit test module. If you extend those files, you might continue in this style,
   but please use ``pytest`` style for any new test files.
 
-* Please keep the first line of your commit messages short. When referencing an issue, please phrase it like
-  ``Fix #123 -- Problems with order creation`` or ``Refs #123 -- Fix this part of that bug``.
+Commits and Pull Requests
+-------------------------
+
+
+
+Most commits should start as pull requests, therefore this applies to the titles of pull requests as well since
+the pull request title will become the commit message on merge. We prefer merging with GitHub's "Squash and merge"
+feature if the PR contains multiple commits that do not carry value to keep. If there is value in keeping the
+individual commits, we use "Rebase and merge" instead. Merge commits should be avoided.
+
+* The commit message should start with a single subject line and can optionally be followed by a commit message body.
+
+  * The subject line should be the shortest possible representation of what the commit changes. Someone who reviewed
+    the commit should able to immediately remember the commit in a couple of weeks based on the subject line and tell
+    it apart from other commits.
+
+  * If there's additional useful information that we should keep, such as reasoning behind the commit, you can
+    add a longer body, separated from the first line by a blank line.
+
+  * The body should explain **what** you changed and more importantly **why** you changed it. There's no need to iterate
+    **how** you changed something.
+
+* The subject line should be capitalized ("Add new feature" instead of "add new feature") and should not end with a period
+  ("Add new feature" instead of "Add new feature.")
+
+* The subject line should be written in imperative mood, as if you were giving a command what the computer should do if the
+  commit is applied. This is how generated commit messages by git itself are already written ("Merge branch …", "Revert …")
+  and makes for short and consistent messages.
+
+  * Good: "Fix typo in template"
+  * Good: "Add Chinese translation"
+  * Good: "Remove deprecated method"
+  * Good: "Bump version to 4.4.0"
+  * Bad: "Fixed bug with …"
+  * Bad: "Fixes bug with …"
+  * Bad: "Fixing bug …"
+
+* If all changes in your commit are in context of a single feature or e.g. a bundled plugin, it makes sense to prefix the
+  subject line with the name of that feature. Examples:
+
+  * "API: Add support for PATCH on customers"
+  * "Docs: Add chapter on alpaca feeding"
+  * "Stripe: Fix duplicate payments"
+  * "Order change form: Fix incorrect validation"
+
+* If your commit references a GitHub issue that is fully resolved by your commit, start your subject line with the issue
+  ID in the form of "Fix #1234 -- Crash in order list". In this case, you can omit the verb "Fix" at the beginning of the
+  second part of the message to avoid repetition of the word "fix". If your commit only partially resolves the issue, use
+  "Refs #1234 -- Crash in order list" instead.
+
+* Applies to pretix employees only: If your commit references a sentry issue, please put it in parentheses at the end
+  of the subject line or inside the body ("Fix crash in order list (PRETIXEU-ABC)"). If your commit references a support
+  ticket, please put it in parentheses at the end of the subject line with a "Z#" prefix ("Fix crash in order list (Z#12345)").
+
+* If your PR was open for a while and might cause conflicts on merge, please prefer rebasing it (``git rebase -i master``)
+  over merging ``master`` into your branch unless it is prohibitively complicated.
 
 
 .. _PEP 8: https://legacy.python.org/dev/peps/pep-0008/

doc/development/implementation/models.rst

@@ -92,6 +92,9 @@ Carts and Orders
 .. autoclass:: pretix.base.models.OrderRefund
    :members:
 
+.. autoclass:: pretix.base.models.Transaction
+   :members:
+
 .. autoclass:: pretix.base.models.CartPosition
    :members:
 

doc/development/implementation/permissions.rst

@@ -184,11 +184,6 @@ Most of these methods work identically on :class:`pretix.base.models.TeamAPIToke
 Staff sessions
 --------------
 
-.. versionchanged:: 1.14
-
-   In 1.14, the ``User.is_superuser`` attribute has been deprecated and statically set to return ``False``. Staff
-   sessions have been newly introduced.
-
 System administrators of a pretix instance are identified by the ``is_staff`` attribute on the user model. By default,
 the regular permission rules apply for users with ``is_staff = True``. The only difference is that such users can
 temporarily turn on "staff mode" via a button in the user interface that grants them **all permissions** as long as

doc/development/setup.rst

@@ -26,7 +26,7 @@ Your should install the following on your system:
 * ``libssl`` (Debian package: ``libssl-dev``)
 * ``libxml2`` (Debian package ``libxml2-dev``)
 * ``libxslt`` (Debian package ``libxslt1-dev``)
-* ``libenchant1c2a`` (Debian package ``libenchant1c2a``)
+* ``libenchant-2-2`` (Debian package ``libenchant-2-2``)
 * ``msgfmt`` (Debian package ``gettext``)
 * ``git``
 
@@ -51,7 +51,12 @@ the dependencies might fail::
 
 Working with the code
 ---------------------
-The first thing you need are all the main application's dependencies::
+If you do not have a recent installation of ``nodejs``, install it now::
+
+    curl -sL https://deb.nodesource.com/setup_17.x | sudo -E bash -
+    sudo apt install nodejs
+
+To make sure it is on your path variable, close and reopen your terminal. Now, install the Python-level dependencies of pretix::
 
     cd src/
     pip3 install -e ".[dev]"

doc/images/cart_pricing.puml

@@ -0,0 +1,28 @@
+@startuml
+
+partition "For every cart position" {
+    (*) --> "Get default price from product"
+    --> if "Product has variations?" then
+        -->[yes] "Override with price from variation"
+        --> if "Event series?" then
+            -->[yes] "Override with price from subevent"
+            -down-> "Store as listed_price"
+        else
+            -down->[no] "Store as listed_price"
+        endif
+    else
+        -down->[no] "Store as listed_price"
+    endif
+    --> if "Voucher applied?" then
+        -->[yes] "Apply voucher pricing"
+        --> "Store as price_after_voucher"
+    else
+        -->[no] "Store as price_after_voucher"
+    endif
+    --> "Apply custom price if product allows\nApply tax rule\nSubtract bundled products"
+    --> "Store as line_price (gross), tax_rate"
+}
+--> "Apply discount engine"
+--> "Store as price (gross)"
+
+@enduml

doc/images/checkin_offline.puml

@@ -2,8 +2,25 @@
 
 
 partition "data-based check" {
-    "Check based on local database" --> "Is the order in status PAID or PENDING\nand is the position not canceled?"
+    "Check based on local database" -down-> "Is addon_match set to true?"
     --> if "" then
+        -down->[no] "Is the order in status PAID or PENDING\nand is the position not canceled?"
+    else
+        -right->[yes] "Build a list that includes the position\nas well as all its add-ons"
+        -down-> "Filter list for products that are part of the check-in list"
+        --> if "" then
+            -down->[one found] Proceed with the matching position
+            --> "Is the order in status PAID or PENDING\nand is the position not canceled?"
+        else
+            --> if "" then
+                -right->[none found] "Return error PRODUCT  "
+            else
+                -down->[multiple found] Return error AMBIGUOUS
+            endif
+        endif
+    endif
+
+    "Is the order in status PAID or PENDING\nand is the position not canceled?" --> if "" then
         -right->[no] "Return error CANCELED"
     else
         -down->[yes] "Is the product part of the check-in list?"

doc/images/checkin_online.puml

@@ -19,8 +19,25 @@ else
 endif
 
 
-===CHECK=== -down-> "Is the order in status PAID or PENDING\nand is the position not canceled?"
+===CHECK=== -down-> "Is addon_match set to true?"
 --> if "" then
+    -down->[no] "Is the order in status PAID or PENDING\nand is the position not canceled?"
+else
+    -right->[yes] "Build a list that includes the position\nas well as all its add-ons"
+    -down-> "Filter list for products that are part of the check-in list"
+    --> if "" then
+        -down->[one found] Proceed with the matching position
+        --> "Is the order in status PAID or PENDING\nand is the position not canceled?"
+    else
+        --> if "" then
+            -right->[none found] "Return error PRODUCT  "
+        else
+            -down->[multiple found] Return error AMBIGUOUS
+        endif
+    endif
+endif
+
+"Is the order in status PAID or PENDING\nand is the position not canceled?" --> if "" then
     -right->[no] "Return error CANCELED"
 else
     -down->[yes] "Is the product part of the check-in list?"

doc/plugins/digital.rst

@@ -52,6 +52,7 @@ Variable                            Description
 ``order_email``                     E-mail address of the ticket purchaser
 ``product_id``                      Internal ID of the purchased product
 ``product_variation``               Internal ID of the purchased product variation (or empty)
+``secret``                          The secret ticket code, would be used as the QR code for physical tickets
 ``attendee_name``                   Full name of the ticket holder (or empty)
 ``attendee_name_*``                 Name parts of the ticket holder, depending on configuration, e.g. ``attendee_name_given_name`` or ``attendee_name_family_name``
 ``attendee_email``                  E-mail address of the ticket holder (or empty)
@@ -61,7 +62,7 @@ Variable                            Description
 ``attendee_city``                   City of the ticket holder's address (or empty)
 ``attendee_country``                Country code of the ticket holder's address (or empty)
 ``attendee_state``                  State of the ticket holder's address (or empty)
-``answer[XYZ]``                     Answer to the custom question with identifier ``XYZ``
+``answers[XYZ]``                    Answer to the custom question with identifier ``XYZ``
 ``invoice_name``                    Full name of the invoice address (or empty)
 ``invoice_name_*``                  Name parts of the invoice address, depending on configuration, e.g. ``invoice_name_given_name`` or ``invoice_name_family_name``
 ``invoice_company``                 Company of the invoice address (or empty)
@@ -90,8 +91,10 @@ Field                                 Type                       Description
 ===================================== ========================== =======================================================
 id                                    integer                    Internal content ID
 title                                 multi-lingual string       The content title (required)
+internal_name                         string                     An optional name that is only used in the backend
 content_type                          string                     The type of content, valid values are ``webinar``, ``video``, ``livestream``, ``link``, ``file``
 url                                   string                     The location of the digital content
+file                                  file                       A downloadable file. Either ``url`` or ``file`` must be ``null``.
 description                           multi-lingual string       A public description of the item. May contain Markdown
                                                                  syntax and is not required.
 available_from                        datetime                   The first date time at which this content will be shown
@@ -143,6 +146,7 @@ API Endpoints
             },
             "content_type": "link",
             "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
+            "file": null,
             "description": {
                 "en": "Watch our event live here on YouTube!"
             },
@@ -190,6 +194,7 @@ API Endpoints
         },
         "content_type": "link",
         "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
+        "file": null,
         "description": {
             "en": "Watch our event live here on YouTube!"
         },
@@ -228,6 +233,7 @@ API Endpoints
         },
         "content_type": "link",
         "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
+        "file": null,
         "description": {
             "en": "Watch our event live here on YouTube!"
         },
@@ -254,6 +260,7 @@ API Endpoints
         },
         "content_type": "link",
         "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
+        "file": null,
         "description": {
             "en": "Watch our event live here on YouTube!"
         },
@@ -308,6 +315,7 @@ API Endpoints
         },
         "content_type": "link",
         "url": "https://mywebsite.com",
+        "file": null,
         "description": {
             "en": "Watch our event live here on YouTube!"
         },

doc/plugins/exhibitors.rst

@@ -0,0 +1,734 @@
+Exhibitors
+==========
+
+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.
+
+.. note:: On pretix Hosted, using the lead scanning feature of the exhibitors plugin can add additional costs
+          depending on your contract.
+
+The plugin exposes two APIs. One (REST API) is intended for bulk-data operations from the admin side, and one
+(App API) that is used by the pretixLEAD app.
+
+REST API
+---------
+
+The REST API for exhibitors requires the usual :ref:`rest-auth`.
+
+Resources
+"""""""""
+
+The exhibitors plugin provides a HTTP API that allows you to create new exhibitors.
+
+The exhibitors resource contains the following public fields:
+
+.. rst-class:: rest-resource-table
+
+===================================== ========================== =======================================================
+Field                                 Type                       Description
+===================================== ========================== =======================================================
+id                                    integer                    Internal exhibitor ID in pretix
+name                                  string                     Exhibitor name
+internal_id                           string                     Can be used for the ID in your exhibition system, your customer ID, etc. Can be ``null``. Maximum 255 characters.
+contact_name                          string                     Contact person (or ``null``)
+contact_name_parts                    object of strings          Decomposition of contact name (i.e. given name, family name)
+contact_email                         string                     Contact person email address (or ``null``)
+booth                                 string                     Booth number (or ``null``). Maximum 100 characters.
+locale                                string                     Locale for communication with the exhibitor (or ``null``).
+access_code                           string                     Access code for the exhibitor to access their data or use the lead scanning app (read-only).
+allow_lead_scanning                   boolean                    Enables lead scanning app
+allow_lead_access                     boolean                    Enables access to data gathered by the lead scanning app
+allow_voucher_access                  boolean                    Enables access to data gathered by exhibitor vouchers
+comment                               string                     Internal comment, not shown to exhibitor
+===================================== ========================== =======================================================
+
+You can also access the scanned leads through the API which contains the following public fields:
+
+.. rst-class:: rest-resource-table
+
+===================================== ========================== =======================================================
+Field                                 Type                       Description
+===================================== ========================== =======================================================
+attendee_order                        string                     Order code of the order the scanned attendee belongs to
+attendee_positionid                   integer                    ``positionid`` if the attendee within the order specified by ``attendee_order``
+rating                                integer                    A rating of 0 to 5 stars (or ``null``)
+notes                                 string                     A note taken by the exhibitor after scanning
+tags                                  list of strings            Additional tags selected by the exhibitor
+first_upload                          datetime                   Date and time of the first upload of this lead
+data                                  list of objects            Attendee data set that may be shown to the exhibitor based o
+                                                                 the event's configuration. Each entry contains the fields ``id``,
+                                                                 ``label``, ``value``, and ``details``. ``details`` is usually empty
+                                                                 except in a few cases where it contains an additional list of objects
+                                                                 with ``value`` and ``label`` keys (e.g. splitting of names).
+device_name                           string                     User-defined name for the device used for scanning (or ``null``).
+===================================== ========================== =======================================================
+
+Endpoints
+"""""""""
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/exhibitors/
+
+   Returns a list of all exhibitors configured for an event.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/exhibitors/ 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,
+            "name": "Aperture Science",
+            "internal_id": null,
+            "contact_name": "Dr Cave Johnson",
+            "contact_name_parts": {
+                "_scheme": "salutation_title_given_family",
+                "family_name": "Johnson",
+                "given_name": "Cave",
+                "salutation": "",
+                "title": "Dr"
+            },
+            "contact_email": "johnson@as.example.org",
+            "booth": "A2",
+            "locale": "de",
+            "access_code": "VKHZ2FU8",
+            "allow_lead_scanning": true,
+            "allow_lead_access": true,
+            "allow_voucher_access": true,
+            "comment": ""
+          }
+        ]
+      }
+
+   :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 or event does not exist **or** you have no permission to view it.
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/exhibitors/(id)/
+
+   Returns information on one exhibitor, identified by its ID.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/exhibitors/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,
+        "name": "Aperture Science",
+        "internal_id": null,
+        "contact_name": "Dr Cave Johnson",
+        "contact_name_parts": {
+            "_scheme": "salutation_title_given_family",
+            "family_name": "Johnson",
+            "given_name": "Cave",
+            "salutation": "",
+            "title": "Dr"
+        },
+        "contact_email": "johnson@as.example.org",
+        "booth": "A2",
+        "locale": "de",
+        "access_code": "VKHZ2FU8",
+        "allow_lead_scanning": true,
+        "allow_lead_access": true,
+        "allow_voucher_access": true,
+        "comment": ""
+      }
+
+   :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 exhibitor to fetch
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event/exhibitor does not exist **or** you have no permission to view it.
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/exhibitors/(id)/leads/
+
+   Returns a list of all scanned leads of an exhibitor.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/exhibitors/1/leads/ 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": [
+          {
+            "attendee_order": "T0E7E",
+            "attendee_positionid": 1,
+            "rating": 1,
+            "notes": "",
+            "tags": [],
+            "first_upload": "2021-07-06T11:03:31.414491+01:00",
+            "data": [
+              {
+                "id": "attendee_name",
+                "label": "Attendee name",
+                "value": "Peter Miller",
+                "details": [
+                  {"label": "Given name", "value": "Peter"},
+                  {"label": "Family name", "value": "Miller"},
+                ]
+              }
+            ]
+          }
+        ]
+      }
+
+   :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
+   :param id: The ``id`` field of the exhibitor to fetch
+   :statuscode 200: no error
+   :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:get:: /api/v1/organizers/(organizer)/events/(event)/exhibitors/(id)/vouchers/
+
+   Returns a list of all vouchers connected to an exhibitor. The response contains the same data as described in
+   :ref:`rest-vouchers`.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/exhibitors/1/vouchers/ 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,
+            "code": "43K6LKM37FBVR2YG",
+            "max_usages": 1,
+            "redeemed": 0,
+            "valid_until": null,
+            "block_quota": false,
+            "allow_ignore_quota": false,
+            "price_mode": "set",
+            "value": "12.00",
+            "item": 1,
+            "variation": null,
+            "quota": null,
+            "tag": "testvoucher",
+            "comment": "",
+            "seat": null,
+            "subevent": null
+          }
+        ]
+      }
+
+   :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
+   :param id: The ``id`` field of the exhibitor to fetch
+   :statuscode 200: no error
+   :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/attach/
+
+   Attaches an **existing** voucher to an exhibitor. You need to send either the ``id`` **or** the ``code`` field of
+   the voucher.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/exhibitors/1/vouchers/attach/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+     {
+       "id": 15
+     }
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/exhibitors/1/vouchers/attach/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+     {
+       "code": "43K6LKM37FBVR2YG"
+     }
+
+   **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.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/exhibitors/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+      Content-Length: 166
+
+      {
+        "name": "Aperture Science",
+        "internal_id": null,
+        "contact_name_parts": {
+            "_scheme": "salutation_title_given_family",
+            "family_name": "Johnson",
+            "given_name": "Cave",
+            "salutation": "",
+            "title": "Dr"
+        },
+        "contact_email": "johnson@as.example.org",
+        "booth": "A2",
+        "locale": "de",
+        "access_code": "VKHZ2FU8",
+        "allow_lead_scanning": true,
+        "allow_lead_access": true,
+        "allow_voucher_access": true,
+        "comment": ""
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 201 Created
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "id": 1,
+        "name": "Aperture Science",
+        "internal_id": null,
+        "contact_name": "Dr Cave Johnson",
+        "contact_name_parts": {
+            "_scheme": "salutation_title_given_family",
+            "family_name": "Johnson",
+            "given_name": "Cave",
+            "salutation": "",
+            "title": "Dr"
+        },
+        "contact_email": "johnson@as.example.org",
+        "booth": "A2",
+        "locale": "de",
+        "access_code": "VKHZ2FU8",
+        "allow_lead_scanning": true,
+        "allow_lead_access": true,
+        "allow_voucher_access": true,
+        "comment": ""
+      }
+
+   :param organizer: The ``slug`` field of the organizer to create new exhibitor for
+   :param event: The ``slug`` field of the event to create new exhibitor for
+   :statuscode 201: no error
+   :statuscode 400: The exhibitor 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 exhibitors.
+
+
+.. http:patch:: /api/v1/organizers/(organizer)/events/(event)/exhibitors/(id)/
+
+   Update an exhibitor. 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/digitalcontents/1/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+      Content-Length: 34
+
+      {
+        "internal_id": "ABC"
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: text/javascript
+
+      {
+        "id": 1,
+        "name": "Aperture Science",
+        "internal_id": "ABC",
+        "contact_name": "Dr Cave Johnson",
+        "contact_name_parts": {
+            "_scheme": "salutation_title_given_family",
+            "family_name": "Johnson",
+            "given_name": "Cave",
+            "salutation": "",
+            "title": "Dr"
+        },
+        "contact_email": "johnson@as.example.org",
+        "booth": "A2",
+        "locale": "de",
+        "access_code": "VKHZ2FU8",
+        "allow_lead_scanning": true,
+        "allow_lead_access": true,
+        "allow_voucher_access": true,
+        "comment": ""
+      }
+
+   :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 exhibitor to modify
+   :statuscode 200: no error
+   :statuscode 400: The exhibitor could not be modified due to invalid submitted data.
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event/exhibitor does not exist **or** you have no permission to change it.
+
+
+.. http:delete:: /api/v1/organizers/(organizer)/events/(event)/exhibitors/(id)/
+
+   Delete an exhibitor.
+
+   .. warning:: This deletes all lead scan data and removes all connections to vouchers (the vouchers are not deleted).
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      DELETE /api/v1/organizers/bigevents/events/sampleconf/exhibitors/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 exhibitor to delete
+   :statuscode 204: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event/exhibitor does not exist **or** you have no permission to change it
+
+
+App API
+-------
+
+The App API is used for communication between the pretixLEAD app and the pretix server.
+
+.. warning:: We consider this an internal API, it is not intended for external use. You may still use it, but
+             our :ref:`compatibility commitment <rest-compat>` does not apply.
+
+Authentication
+""""""""""""""
+
+Every exhibitor has an "access code", usually consisting of 8 alphanumeric uppercase characters.
+This access code is communicated to event exhibitors by the event organizers, so this is also what
+exhibitors should enter into a login screen.
+
+All API requests need to contain this access code as a header like this::
+
+    Authorization: Exhibitor ABCDE123
+
+Exhibitor profile
+"""""""""""""""""
+
+Upon login and in regular intervals after that, the API should fetch the exhibitors profile.
+This serves two purposes:
+
+* Checking if the authorization code is actually valid
+
+* Obtaining information that can be shown in the app
+
+The resource consists of the following fields:
+
+.. rst-class:: rest-resource-table
+
+===================================== ========================== =======================================================
+Field                                 Type                       Description
+===================================== ========================== =======================================================
+name                                  string                     Exhibitor name
+booth                                 string                     Booth number (or ``null``)
+event                                 object                     Object describing the event
+├ name                                multi-lingual string       Event name
+├ imprint_url                         string                     URL to legal notice page. If not ``null``, a button in the app should link to this page.
+├ privacy_url                         string                     URL to privacy notice page. If not ``null``, a button in the app should link to this page.
+├ help_url                            string                     URL to help page. If not ``null``, a button in the app should link to this page.
+├ terms_url                           string                     URL to terms of service. If not ``null``, a button in the app should link to this page.
+├ logo_url                            string                     URL to event logo. If not ``null``, this logo may be shown in the app.
+├ slug                                string                     Event short form
+└ organizer                           string                     Organizer short form
+notes                                 boolean                    Specifies whether the exhibitor is allowed to take notes on leads
+tags                                  list of strings            List of tags the exhibitor can assign to their leads
+scan_types                            list of objects            Only used for a special case, fixed value that external API consumers should ignore
+===================================== ========================== =======================================================
+
+.. http:get:: /exhibitors/api/v1/profile
+
+   **Example request:**
+
+   .. sourcecode:: http
+
+    GET /exhibitors/api/v1/profile HTTP/1.1
+    Authorization: Exhibitor ABCDE123
+    Accept: application/json, text/javascript
+
+   **Example response:**
+
+   .. sourcecode:: http
+
+    HTTP/1.1 200 OK
+    Vary: Accept
+    Content-Type: application/json
+
+    {
+      "name": "Aperture Science",
+      "booth": "A2",
+      "event": {
+        "name": {"en": "Sample conference", "de": "Beispielkonferenz"},
+        "slug": "bigevents",
+        "imprint_url": null,
+        "privacy_url": null,
+        "help_url": null,
+        "terms_url": null,
+        "logo_url": null,
+        "organizer": "sampleconf"
+      },
+      "notes": true,
+      "tags": ["foo", "bar"],
+      "scan_types": [
+        {
+          "key": "lead",
+          "label": "Lead Scanning"
+        }
+      ]
+    }
+
+   :statuscode 200: no error
+   :statuscode 401: Invalid authentication code
+
+Submitting a lead
+"""""""""""""""""
+
+After a ticket/badge is scanned, it should immediately be submitted to the server
+so the scan is stored and information about the person can be shown in the app. The same
+code can be submitted multiple times, so it's no problem to just submit it again after the
+exhibitor set a note or a rating (0-5) inside the app.
+
+On the request, you should set the following properties:
+
+* ``code`` with the scanned barcode
+* ``notes`` with the exhibitor's notes
+* ``scanned`` with the date and time of the actual scan (not the time of the upload)
+* ``scan_type`` set to ``lead`` statically
+* ``tags`` with the list of selected tags
+* ``rating`` with the rating assigned by the exhibitor
+* ``device_name`` with a user-specified name of the device used for scanning (max. 190 characters), or ``null``
+
+If you submit ``tags`` and ``rating`` to be ``null`` and ``notes`` to be ``""``, the server
+responds with the previously saved information and will not delete that information. If you
+supply other values, the information saved on the server will be overridden.
+
+The response will also contain ``tags``, ``rating``, and ``notes``. Additionally,
+it will include ``attendee`` with a list of ``fields`` that can be shown to the
+user. Each field has an internal ``id``, a human-readable ``label``, and a ``value`` (all strings).
+
+Note that the ``fields`` array can contain any number of dynamic keys!
+Depending on the exhibitors permission and event configuration this might be empty,
+or contain lots of details. The app should dynamically show these values (read-only)
+with the labels sent by the server.
+
+The request for this looks like this:
+
+.. http:post:: /exhibitors/api/v1/leads/
+
+   **Example request:**
+
+   .. sourcecode:: http
+
+    POST /exhibitors/api/v1/leads/ HTTP/1.1
+    Authorization: Exhibitor ABCDE123
+    Accept: application/json, text/javascript
+    Content-Type: application/json
+
+    {
+      "code": "qrcodecontent",
+      "notes": "Great customer, wants our newsletter",
+      "scanned": "2020-10-18T12:24:23.000+00:00",
+      "scan_type": "lead",
+      "tags": ["foo"],
+      "rating": 4,
+      "device_name": "DEV1"
+    }
+
+   **Example response:**
+
+   .. sourcecode:: http
+
+    HTTP/1.1 201 Created
+    Vary: Accept
+    Content-Type: application/json
+
+    {
+      "attendee": {
+        "fields": [
+          {
+            "id": "attendee_name",
+            "label": "Name",
+            "value": "Jon Doe",
+            "details": [
+              {"label": "Given name", "value": "John"},
+              {"label": "Family name", "value": "Doe"},
+            ]
+          },
+          {
+            "id": "attendee_email",
+            "label": "Email",
+            "value": "test@example.com",
+            "details": []
+          }
+         ]
+        },
+        "rating": 4,
+        "tags": ["foo"],
+        "notes": "Great customer, wants our newsletter"
+    }
+
+   :statuscode 200: No error, leads was not scanned for the first time
+   :statuscode 201: No error, leads was scanned for the first time
+   :statuscode 400: Invalid data submitted
+   :statuscode 401: Invalid authentication code
+
+You can also fetch existing leads (if you are authorized to do so):
+
+.. http:get:: /exhibitors/api/v1/leads/
+
+   **Example request:**
+
+   .. sourcecode:: http
+
+    GET /exhibitors/api/v1/leads/ HTTP/1.1
+    Authorization: Exhibitor ABCDE123
+    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": [
+        {
+          "attendee": {
+            "fields": [
+              {
+                "id": "attendee_name",
+                "label": "Name",
+                "value": "Jon Doe",
+                "details": [
+                  {"label": "Given name", "value": "John"},
+                  {"label": "Family name", "value": "Doe"},
+                ]
+              },
+              {
+                "id": "attendee_email",
+                "label": "Email",
+                "value": "test@example.com",
+                "details": []
+              }
+           ]
+          },
+          "rating": 4,
+          "tags": ["foo"],
+          "notes": "Great customer, wants our newsletter"
+        }
+      ]
+    }
+
+   :statuscode 200: No error
+   :statuscode 401: Invalid authentication code
+   :statuscode 403: Not permitted to access bulk data

doc/plugins/imported_secrets.rst

@@ -0,0 +1,301 @@
+Secrets Import
+==============
+
+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`.
+
+With the "Secrets Import" plugin, you can upload your own list of secrets to be used instead. This is useful for
+integrating with third-party check-in systems.
+
+
+API Resource description
+-------------------------
+
+The secrets import plugin provides a HTTP API that allows you to create new secrets.
+
+The imported secret resource contains the following public fields:
+
+.. rst-class:: rest-resource-table
+
+===================================== ========================== =======================================================
+Field                                 Type                       Description
+===================================== ========================== =======================================================
+id                                    integer                    Internal ID of the secret
+secret                                string                     Actual string content of the secret (QR code content)
+used                                  boolean                    Whether the secret was already used for a ticket. If ``true``,
+                                                                 the secret can no longer be deleted. Secrets are never used
+                                                                 twice, even if an order is canceled or deleted.
+item                                  integer                    Internal ID of a product, or ``null``. If set, the secret
+                                                                 will only be used for tickets of this product.
+variation                             integer                    Internal ID of a product variation, or ``null``. If set, the secret
+                                                                 will only be used for tickets of this product variation.
+subevent                              integer                    Internal ID of an event series date, or ``null``. If set, the secret
+                                                                 will only be used for tickets of this event series date.
+===================================== ========================== =======================================================
+
+API Endpoints
+-------------
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/imported_secrets/
+
+   Returns a list of all secrets imported for an event.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/imported_secrets/ 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,
+            "secret": "foobar",
+            "used": false,
+            "item": null,
+            "variation": null,
+            "subevent": null
+          }
+        ]
+      }
+
+   :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 or event does not exist **or** you have no permission to view it.
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/imported_secrets/(id)/
+
+   Returns information on one secret, identified by its ID.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/imported_secrets/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,
+        "secret": "foobar",
+        "used": false,
+        "item": null,
+        "variation": null,
+        "subevent": null
+      }
+
+   :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 secret to fetch
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event/secret does not exist **or** you have no permission to view it.
+
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/imported_secrets/
+
+   Create a new secret.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/imported_secrets/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+      Content-Length: 166
+
+      {
+        "secret": "foobar",
+        "used": false,
+        "item": null,
+        "variation": null,
+        "subevent": null
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 201 Created
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "id": 1,
+        "secret": "foobar",
+        "used": false,
+        "item": null,
+        "variation": null,
+        "subevent": null
+      }
+
+   :param organizer: The ``slug`` field of the organizer to a create new secret for
+   :param event: The ``slug`` field of the event to create a new secret for
+   :statuscode 201: no error
+   :statuscode 400: The secret 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 secrets.
+
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/imported_secrets/bulk_create/
+
+   Create new secrets in bulk (up to 500 per request). The request either succeeds or fails entirely.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/imported_secrets/bulk_create/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+      Content-Length: 166
+
+      [
+        {
+          "secret": "foobar",
+          "used": false,
+          "item": null,
+          "variation": null,
+          "subevent": null
+        },
+        {
+          "secret": "baz",
+          "used": false,
+          "item": null,
+          "variation": null,
+          "subevent": null
+        }
+      ]
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      [
+        {
+          "id": 1,
+          "secret": "foobar",
+          "used": false,
+          "item": null,
+          "variation": null,
+          "subevent": null
+        },
+        {
+          "id": 2,
+          "secret": "baz",
+          "used": false,
+          "item": null,
+          "variation": null,
+          "subevent": null
+        }
+      ]
+
+   :param organizer: The ``slug`` field of the organizer to create new secrets for
+   :param event: The ``slug`` field of the event to create new secrets for
+   :statuscode 201: no error
+   :statuscode 400: The secrets 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 secrets.
+
+
+.. http:patch:: /api/v1/organizers/(organizer)/events/(event)/imported_secrets/(id)/
+
+   Update a secret. 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/imported_secrets/1/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+      Content-Length: 34
+
+      {
+        "item": 2
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: text/javascript
+
+      {
+        "id": 1,
+        "secret": "foobar",
+        "used": false,
+        "item": 2,
+        "variation": null,
+        "subevent": null
+      }
+
+   :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 secret to modify
+   :statuscode 200: no error
+   :statuscode 400: The secret could not be modified due to invalid submitted data.
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event/secret does not exist **or** you have no permission to change it.
+
+
+.. http:delete:: /api/v1/organizers/(organizer)/events/(event)/imported_secrets/(id)/
+
+   Delete a secret. You can only delete secrets that have not yet been used.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      DELETE /api/v1/organizers/bigevents/events/sampleconf/imported_secrets/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 secret to delete
+   :statuscode 204: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event/secret does not exist **or** you have no permission to change it **or** the secret has already been used
+

doc/plugins/index.rst

@@ -1,3 +1,5 @@
+.. _`plugin-docs`:
+
 Plugin documentation
 ====================
 
@@ -10,11 +12,14 @@ If you want to **create** a plugin, please go to the
    :maxdepth: 2
 
    list
-   pretixdroid
    banktransfer
    ticketoutputpdf
    badges
    campaigns
    certificates
    digital
+   exhibitors
+   shipping
+   imported_secrets
    webinar
+   presale-saml

doc/plugins/list.rst

@@ -5,6 +5,6 @@ List of plugins
 ===============
 
 A detailed list of plugins that are available for pretix can be found on the
-`project website`_.
+`pretix Marketplace`_.
 
-.. _project website: https://pretix.eu/about/en/plugins
+.. _pretix Marketplace: https://marketplace.pretix.eu

doc/plugins/presale-saml.rst

@@ -0,0 +1,405 @@
+.. highlight:: ini
+.. spelling::
+
+   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/pretixdroid.rst

@@ -1,368 +0,0 @@
-pretixdroid HTTP API
-====================
-
-The pretixdroid plugin provides a HTTP API that the `pretixdroid Android app`_
-uses to communicate with the pretix server.
-
-.. warning:: This API is **DEPRECATED** and will probably go away soon. It is used **only** to serve the pretixdroid
-             Android app. There are no backwards compatibility guarantees on this API. We will not add features that
-             are not required for the  Android App. There is a general-purpose :ref:`rest-api` that provides all
-             features that you need to check in.
-
-.. versionchanged:: 1.12
-
-   Support for check-in-time questions has been added. The new API features are fully backwards-compatible and
-   negotiated live, so clients which do not need this feature can ignore the change. For this reason, the API version
-   has not been increased and is still set to 3.
-
-.. versionchanged:: 1.13
-
-   Support for checking in unpaid tickets has been added.
-
-
-.. http:post:: /pretixdroid/api/(organizer)/(event)/redeem/
-
-   Redeems a ticket, i.e. checks the user in.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      POST /pretixdroid/api/demoorga/democon/redeem/?key=ABCDEF HTTP/1.1
-      Host: demo.pretix.eu
-      Accept: application/json, text/javascript
-      Content-Type: application/x-www-form-urlencoded
-
-      secret=az9u4mymhqktrbupmwkvv6xmgds5dk3&questions_supported=true
-
-   You **must** set the parameter secret.
-
-   You **must** set the parameter ``questions_supported`` to ``true`` **if** you support asking questions
-   back to the app operator. You **must not** set it if you do not support this feature. In that case, questions
-   will just be ignored.
-
-   You **may** set the additional parameter ``datetime`` in the body containing an ISO8601-encoded
-   datetime of the entry attempt. If you don"t, the current date and time will be used.
-
-   You **may** set the additional parameter ``force`` to indicate that the request should be logged
-   regardless of previous check-ins for the same ticket. This might be useful if you made the entry decision offline.
-   Questions will also always be ignored in this case (i.e. supplied answers will be saved, but no error will be
-   thrown if they are missing or invalid).
-
-   You **may** set the additional parameter ``nonce`` with a globally unique random value to identify this
-   check-in. This is meant to be used to prevent duplicate check-ins when you are just retrying after a connection
-   failure.
-
-   You **may** set the additional parameter ``ignore_unpaid`` to indicate that the check-in should be performed even
-   if the order is in pending state.
-
-   If questions are supported and required, you will receive a dictionary ``questions`` containing details on the
-   particular questions to ask. To answer them, just re-send your redemption request with additional parameters of
-   the form ``answer_<question>=<answer>``, e.g. ``answer_12=24``.
-
-   **Example successful response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 200 OK
-      Content-Type: text/json
-
-      {
-        "status": "ok"
-        "version": 3,
-        "data": {
-          "secret": "az9u4mymhqktrbupmwkvv6xmgds5dk3",
-          "order": "ABCDE",
-          "item": "Standard ticket",
-          "item_id": 1,
-          "variation": null,
-          "variation_id": null,
-          "attendee_name": "Peter Higgs",
-          "attention": false,
-          "redeemed": true,
-          "checkin_allowed": true,
-          "addons_text": "Parking spot",
-          "paid": true
-        }
-      }
-
-   **Example response with required questions**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 200 OK
-      Content-Type: text/json
-
-      {
-        "status": "incomplete"
-        "version": 3
-        "data": {
-          "secret": "az9u4mymhqktrbupmwkvv6xmgds5dk3",
-          "order": "ABCDE",
-          "item": "Standard ticket",
-          "item_id": 1,
-          "variation": null,
-          "variation_id": null,
-          "attendee_name": "Peter Higgs",
-          "attention": false,
-          "redeemed": true,
-          "checkin_allowed": true,
-          "addons_text": "Parking spot",
-          "paid": true
-        },
-        "questions": [
-          {
-            "id": 12,
-            "type": "C",
-            "question": "Choose a shirt size",
-            "required": true,
-            "position": 2,
-            "items": [1],
-            "options": [
-              {
-                "id": 24,
-                "answer": "M"
-              },
-              {
-                "id": 25,
-                "answer": "L"
-              }
-            ]
-          }
-        ]
-      }
-
-   **Example error response with data**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 200 OK
-      Content-Type: text/json
-
-      {
-        "status": "error",
-        "reason": "already_redeemed",
-        "version": 3,
-        "data": {
-          "secret": "az9u4mymhqktrbupmwkvv6xmgds5dk3",
-          "order": "ABCDE",
-          "item": "Standard ticket",
-          "item_id": 1,
-          "variation": null,
-          "variation_id": null,
-          "attendee_name": "Peter Higgs",
-          "attention": false,
-          "redeemed": true,
-          "checkin_allowed": true,
-          "addons_text": "Parking spot",
-          "paid": true
-        }
-      }
-
-   **Example error response without data**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 200 OK
-      Content-Type: text/json
-
-      {
-        "status": "error",
-        "reason": "unkown_ticket",
-        "version": 3
-      }
-
-   Possible error reasons:
-
-   * ``unpaid`` - Ticket is not paid for or has been refunded
-   * ``already_redeemed`` - Ticket already has been redeemed
-   * ``product`` - Tickets with this product may not be scanned at this device
-   * ``unknown_ticket`` - Secret does not match a ticket in the database
-
-   :query key: Secret API key
-   :statuscode 200: Valid request
-   :statuscode 404: Unknown organizer or event
-   :statuscode 403: Invalid authorization key
-
-.. http:get:: /pretixdroid/api/(organizer)/(event)/search/
-
-   Searches for a ticket.
-   At most 25 results will be returned. **Queries with less than 4 characters will always return an empty result set.**
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      GET /pretixdroid/api/demoorga/democon/search/?key=ABCDEF&query=Peter HTTP/1.1
-      Host: demo.pretix.eu
-      Accept: application/json, text/javascript
-
-   **Example response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 200 OK
-      Content-Type: text/json
-
-      {
-        "results": [
-          {
-            "secret": "az9u4mymhqktrbupmwkvv6xmgds5dk3",
-            "order": "ABCE6",
-            "item": "Standard ticket",
-            "variation": null,
-            "attendee_name": "Peter Higgs",
-            "redeemed": false,
-            "attention": false,
-            "checkin_allowed": true,
-            "addons_text": "Parking spot",
-            "paid": true
-          },
-          ...
-        ],
-        "version": 3
-      }
-
-   :query query: Search query
-   :query key: Secret API key
-   :statuscode 200: Valid request
-   :statuscode 404: Unknown organizer or event
-   :statuscode 403: Invalid authorization key
-
-.. http:get:: /pretixdroid/api/(organizer)/(event)/download/
-
-   Download data for all tickets.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      GET /pretixdroid/api/demoorga/democon/download/?key=ABCDEF HTTP/1.1
-      Host: demo.pretix.eu
-      Accept: application/json, text/javascript
-
-   **Example response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 200 OK
-      Content-Type: text/json
-
-      {
-        "version": 3,
-        "results": [
-          {
-            "secret": "az9u4mymhqktrbupmwkvv6xmgds5dk3",
-            "order": "ABCE6",
-            "item": "Standard ticket",
-            "variation": null,
-            "attendee_name": "Peter Higgs",
-            "redeemed": false,
-            "attention": false,
-            "checkin_allowed": true,
-            "paid": true
-          },
-          ...
-        ],
-        "questions": [
-          {
-            "id": 12,
-            "type": "C",
-            "question": "Choose a shirt size",
-            "required": true,
-            "position": 2,
-            "items": [1],
-            "options": [
-              {
-                "id": 24,
-                "answer": "M"
-              },
-              {
-                "id": 25,
-                "answer": "L"
-              }
-            ]
-          }
-        ]
-      }
-
-   :query key: Secret API key
-   :statuscode 200: Valid request
-   :statuscode 404: Unknown organizer or event
-   :statuscode 403: Invalid authorization key
-
-.. http:get:: /pretixdroid/api/(organizer)/(event)/status/
-
-   Returns status information, such as the total number of tickets and the
-   number of performed check-ins.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      GET /pretixdroid/api/demoorga/democon/status/?key=ABCDEF HTTP/1.1
-      Host: demo.pretix.eu
-      Accept: application/json, text/javascript
-
-   **Example response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 200 OK
-      Content-Type: text/json
-
-      {
-        "checkins": 17,
-        "total": 42,
-        "version": 3,
-        "event": {
-          "name": "Demo Conference",
-          "slug": "democon",
-          "date_from": "2016-12-27T17:00:00Z",
-          "date_to": "2016-12-30T18:00:00Z",
-          "timezone": "UTC",
-          "url": "https://demo.pretix.eu/demoorga/democon/",
-          "organizer": {
-            "name": "Demo Organizer",
-            "slug": "demoorga"
-          },
-        },
-        "items": [
-          {
-            "name": "T-Shirt",
-            "id": 1,
-            "checkins": 1,
-            "admission": False,
-            "total": 1,
-            "variations": [
-              {
-                "name": "Red",
-                "id": 1,
-                "checkins": 1,
-                "total": 12
-              },
-              {
-               "name": "Blue",
-                "id": 2,
-                "checkins": 4,
-                "total": 8
-              }
-            ]
-          },
-          {
-            "name": "Ticket",
-            "id": 2,
-            "checkins": 15,
-            "admission": True,
-            "total": 22,
-            "variations": []
-          }
-        ]
-      }
-
-   :query key: Secret API key
-   :statuscode 200: Valid request
-   :statuscode 404: Unknown organizer or event
-   :statuscode 403: Invalid authorization key
-
-.. _pretixdroid Android app: https://github.com/pretix/pretixdroid

doc/plugins/shipping.rst

@@ -0,0 +1,235 @@
+Shipping
+========
+
+The shipping plugin provides a HTTP API that exposes the various layouts used to generate PDF badges.
+
+Shipping address resource
+-------------------------
+
+The shipping address resource contains the following public fields:
+
+.. rst-class:: rest-resource-table
+
+===================================== ========================== =======================================================
+Field                                 Type                       Description
+===================================== ========================== =======================================================
+company                               string                     Customer company name
+name                                  string                     Customer name
+street                                string                     Customer street
+zipcode                               string                     Customer ZIP code
+city                                  string                     Customer city
+country                               string                     Customer country code
+state                                 string                     Customer state (ISO 3166-2 code). Only supported in
+                                                                 AU, BR, CA, CN, MY, MX, and US.
+gift                                  boolean                    Request by customer to not disclose prices in the shipping
+===================================== ========================== =======================================================
+
+Shipping status resource
+------------------------
+
+The shipping status resource contains the following public fields:
+
+.. rst-class:: rest-resource-table
+
+===================================== ========================== =======================================================
+Field                                 Type                       Description
+===================================== ========================== =======================================================
+method                                integer                    Internal ID of shipping method
+status                                string                     Status, one of ``"new"`` or ``"shipped"``
+method_type                           string                     Method type, one of ``"ship"``, ``"online"``, or ``"collect"``
+===================================== ========================== =======================================================
+
+Print job resource
+------------------
+
+The print job resource contains the following public fields:
+
+.. rst-class:: rest-resource-table
+
+===================================== ========================== =======================================================
+Field                                 Type                       Description
+===================================== ========================== =======================================================
+code                                  string                     Order code of the ticket order
+event                                 string                     Event slug
+status                                string                     Status, one of ``"new"`` or ``"shipped"``
+method                                string                     Method type, one of ``"ship"``, ``"online"``, or ``"collect"``
+===================================== ========================== =======================================================
+
+Endpoints
+---------
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/orders/(code)/shippingaddress/
+
+   Returns the shipping address of an order
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/democon/orders/ABC12/shippingaddress/ 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
+
+      {
+        "company": "ACME Corp",
+        "name": "John Doe",
+        "street": "Sesame Street 12\nAp. 5",
+        "zipcode": "12345",
+        "city": "Berlin",
+        "country": "DE",
+        "state": "",
+        "gift": false
+      }
+
+   :param organizer: The ``slug`` field of a valid organizer
+   :param event: The ``slug`` field of a valid event
+   :param order: The ``code`` field of a valid order
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to view it.
+   :statuscode 404: The order does not exist or no shipping address is attached.
+
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/orders/(code)/shippingaddress/
+
+   Returns the shipping status of an order
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/democon/orders/ABC12/shippingstatus/ 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
+
+      {
+        "method": 23,
+        "method_type": "ship",
+        "status": "new"
+      }
+
+   :param organizer: The ``slug`` field of a valid organizer
+   :param event: The ``slug`` field of a valid event
+   :param order: The ``code`` field of a valid order
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to view it.
+   :statuscode 404: The order does not exist or no shipping address is attached.
+
+.. http:get:: /api/v1/organizers/(organizer)/printjobs/
+
+   Returns a list of ticket orders, only useful with some query filters
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/printjobs/?method=ship&status=new 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": [
+          {
+            "event": "democon",
+            "order": "ABC12",
+            "method": "ship",
+            "status": "new"
+          }
+        ]
+      }
+
+   :query string method: Filter by response field ``method`` (can be passed multiple times)
+   :query string status: Filter by response field ``status``
+   :query string event: Filter by response field ``event``
+   :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)/printjobs/poll/
+
+   Returns the PDF file for the next job to print.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/printjobs/poll/?method=ship&status=new 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/pdf
+      X-Pretix-Order-Code: ABC12
+
+      ...
+
+   :query string method: Filter by response field ``method`` (can be passed multiple times)
+   :query string status: Filter by response field ``status``
+   :query string event: Filter by response field ``event``
+   :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:post:: /api/v1/organizers/(organizer)/printjobs/(order)/ack/
+
+   Change an order's status to "shipped".
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/printjobs/ABC12/ack/ 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 a valid organizer
+   :param event: The ``slug`` field of a valid event
+   :param order: The ``code`` field of a valid order
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to view it.
+   :statuscode 404: The order does not exist.

doc/requirements.rtd.txt

@@ -0,0 +1,10 @@
+sphinx==2.3.*
+jinja2==3.0.*
+sphinx-rtd-theme
+sphinxcontrib-httpdomain
+sphinxcontrib-images
+sphinxcontrib-spelling==4.*
+sphinxemoji
+pygments-markdown-lexer
+# See https://github.com/rfk/pyenchant/pull/130
+git+https://github.com/raphaelm/pyenchant.git@patch-1#egg=pyenchant

doc/requirements.txt

@@ -1,5 +1,6 @@
 -e ../src/
 sphinx==2.3.*
+jinja2==3.0.*
 sphinx-rtd-theme
 sphinxcontrib-httpdomain
 sphinxcontrib-images

doc/spelling_wordlist.txt

@@ -17,6 +17,7 @@ bic
 BIC
 boolean
 booleans
+bugfix
 cancelled
 casted
 Ceph
@@ -65,6 +66,7 @@ iterable
 Jimdo
 jwt
 JWT
+JWTs
 libpretixprint
 libsass
 linters
@@ -77,6 +79,7 @@ mixin
 mixins
 multi
 multidomain
+multiplicator
 namespace
 namespaced
 namespaces
@@ -86,7 +89,9 @@ nginx
 nodejs
 NotificationType
 npm
+OIDC
 ons
+OpenID
 optimizations
 overpayment
 param
@@ -101,6 +106,7 @@ prepending
 preprocessor
 presale
 pretix
+pretixLEAD
 pretixSCAN
 pretixdroid
 pretixPOS
@@ -130,6 +136,7 @@ serializer
 serializers
 sexualized
 SQL
+SSO
 startup
 stdout
 stylesheet
@@ -156,6 +163,8 @@ untrusted
 uptime
 username
 url
+URI
+URIs
 validator
 versa
 versioning

doc/user/customers/index.rst

@@ -0,0 +1,210 @@
+.. _customers:
+
+Customer accounts
+=================
+
+By default, pretix only offers guest checkout, i.e. ticket buyers do not sign up and sign back in, but create a new
+checkout session every time. In some situations it may be convenient to allow ticket buyers to create
+accounts that they can later log in to again. Working with customer accounts is even required for some advanced
+use cases such as described in the :ref:`seasontickets` article.
+
+Enabling customer accounts
+--------------------------
+
+To enable customer accounts, head to your organizer page in the backend and then select "Settings" → "General" →
+"Customer accounts" and turn on the checkbox "Allow customers to create accounts".
+
+Using the other settings on the same tab you can fine-tune how the customer account system behaves:
+
+.. thumbnail:: ../../screens/organizer/edit_customer.png
+   :align: center
+   :class: screenshot
+
+Allow customers to log in with email address and password
+    In all simple setups, this option should be checked. If this checkbox is removed, it is impossible to log in or
+    sign up unless you connect a SSO provider (see below).
+
+Match orders based on email address
+    If this option is selected, customers will see orders made with their email address within their account even if
+    they did not make those orders while logged in.
+
+Name format, Allowed titles
+    This controls how we'll ask your customers for their name, similar to the respective settings on event level.
+
+Managing customer accounts
+--------------------------
+
+After customer accounts have been enabled, you will find a new menu option "Customer accounts" in the organizer-level
+main menu. The first sub-item, "Customers", allows you to search and inspect the list of your customer accounts, as well
+as to create a new customer account from the backend:
+
+.. thumbnail:: ../../screens/organizer/customers.png
+   :align: center
+   :class: screenshot
+
+If you click on a customer ID, you can see all details of this customer account, including registration information,
+active memberships, past ticket orders, and account history:
+
+.. thumbnail:: ../../screens/organizer/customer.png
+   :align: center
+   :class: screenshot
+
+You can also perform various actions from this view, such as:
+
+- Send a password reset link
+- Change registration information
+- Anonymize the customer account (does not anonymize connected orders)
+
+When creating or changing a customer, you will be presented with the following form:
+
+.. thumbnail:: ../../screens/organizer/customer_edit.png
+   :align: center
+   :class: screenshot
+
+Most fields, such as name, e-mail address, phone number, and language should be self-explanatory. The following fields
+might require some explanation:
+
+Account active
+    If this checkbox is removed, the customer will not be able to log in.
+
+External identifier
+    This field can be used to cross-reference your customer database with other sources. For example, if the customer
+    already has a number in another system, you can insert that number here. This can be especially powerful if you
+    use our API for synchronization with an external system.
+
+Verified email address
+    This checkbox signifies whether you have verified that this customer in fact controls the given email address.
+    This will automatically be checked after a successful registration or after a successful password reset. Before it
+    is checked, the customer will not be able to log in. You should usually not modify this field manually.
+
+Notes
+    Entries in this field will only be visible to you and your team, not to the customer.
+
+Single-Sign-On (SSO)
+--------------------
+
+"Single-Sign-On" (SSO) is a technical term for a situation in which a person can log in to multiple systems using just
+one login. This can be convenient if you have multiple applications that are exposed to your customers: They won't have
+to remember multiple passwords or understand how your application landscape is structured, they can just always log in
+with the same credentials whenever they see your brand.
+
+In this scenario, pretix can be **either** the "SSO provider" **or** the "SSO client".
+If pretix is the SSO provider, pretix will be the central source of truth for your customer accounts and your other
+applications can connect to pretix to use pretix's login functionality.
+If pretix is the SSO client, one of your existing systems will be the source of truth for the customer accounts and
+pretix will use that system's login functionality.
+
+All SSO support for customer accounts in pretix is currently built on the `OpenID Connect`_ standard, a modern and
+widely accepted standard for SSO in all industries.
+
+Connecting SSO clients (pretix as the SSO provider)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+To connect an external application as a SSO client, go to "Customer accounts" → "SSO clients" → "Create a new SSO client"
+in your organizer account.
+
+.. thumbnail:: ../../screens/organizer/customer_ssoclient_add.png
+   :align: center
+   :class: screenshot
+
+You will need to fill out the following fields:
+
+Active
+    If this checkbox is removed, the SSO client can not be used.
+
+Application name
+    The name of your external application, e.g. "digital event marketplace".
+
+Client type
+    For a server-side application which is able to store a secret that will be inaccessible to end users, chose
+    "confidential". For a client-side application, such as many mobile apps, choose "public".
+
+Grant type
+    This value depends on the OpenID Connect implementation of your software.
+
+Redirection URIs
+    One or multiple URIs that the user might be redirected to after the successful or failed login.
+
+Allowed access scopes
+    The types of data the SSO client may access about the customer.
+
+After you submitted all data, you will receive a client ID as well as a client secret. The client secret is shown
+in the green success message and will only ever be shown once. If you need it again, use the option "Invalidate old
+client secret and generate a new one".
+
+You will need the client ID and client secret to configure your external application. The application will also likely
+need some other information from you, such as your **issuer URI**. If you use pretix Hosted and your organizer account
+does not have a custom domain, your issuer will be ``https://pretix.eu/myorgname``, where ``myorgname`` is the short
+form of your organizer account. If you use a custom domain, such as ``tickets.mycompany.net``, then your issuer will be
+``https://tickets.mycompany.net``.
+
+Technical details
+"""""""""""""""""
+
+We implement `OpenID Connect Core 1.0`_, except for some optional parts that do not make sense for pretix or bring no
+additional value. For example, we do not currently support encrypted tokens, offline access, refresh tokens, or passing
+request parameters as JWTs.
+
+We implement the provider metadata section from `OpenID Connect Discovery 1.0`_. You can find the endpoint relative
+to the issuer URI as described above, for example ``http://pretix.eu/demo/.well-known/openid-configuration``.
+
+We implement all three OpenID Connect Core flows:
+
+- Authorization Code Flow (response type ``code``)
+- Implicit Flow (response types ``id_token token`` and ``id_token``)
+- Hybrid Flow (response types ``code id_token``, ``code id_token token``, and ``code token``)
+
+We implement the response modes ``query`` and ``fragment``.
+
+We currently offer the following scopes: ``openid``, ``profile``, ``email``, ``phone``
+
+As well as the following standardized claims: ``iss``, ``aud``, ``exp``, ``iat``, ``auth_time``, ``nonce``, ``c_hash``,
+``at_hash``, ``sub``, ``locale``, ``name``, ``given_name``, ``family_name``, ``middle_name``, ``nickname``, ``email``,
+``email_verified``, ``phone_number``.
+
+The various endpoints are located relative to the issuer URI as described above:
+
+- Authorization: ``<issuer>/oauth2/v1/authorize``
+- Token: ``<issuer>/oauth2/v1/token``
+- User info: ``<issuer>/oauth2/v1/userinfo``
+- Keys: ``<issuer>/oauth2/v1/keys``
+
+We currently do not reproduce their documentation here as they follow the OpenID Connect and OAuth specifications
+without any special behavior.
+
+Connecting SSO providers (pretix as the SSO client)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+To connect an external application as a SSO client, go to "Customer accounts" → "SSO providers" → "Create a new SSO provider"
+in your organizer account.
+
+.. thumbnail:: ../../screens/organizer/customer_ssoprovider_add.png
+   :align: center
+   :class: screenshot
+
+The "Provider name" and "Login button label" is what we'll use to show the new login option to the user. For the actual
+connection, we will require information such as the issuer URL, client ID, client secret, scope, and field (or claim)
+names that you will receive from your SSO provider.
+
+.. note::
+
+   If you want your customers to *only* use your SSO provider, it makes sense to turn off the "Allow customers to log in
+   with email address and password" settings option (see above).
+
+Technical details
+"""""""""""""""""
+
+We assume that SSO providers fulfill the following requirements:
+
+- Implementation according to `OpenID Connect Core 1.0`_.
+
+- Published meta-data document at ``<issuer>/.well-known/openid-configuration`` as specified in `OpenID Connect Discovery 1.0`_.
+
+- Support for Authorization code flow (``response_type=code``) with ``response_mode=query``.
+
+- Support for client authentication using client ID and client secret and without public key cryptography.
+
+
+.. _OpenID Connect: https://en.wikipedia.org/wiki/OpenID#OpenID_Connect_(OIDC)
+.. _OpenID Connect Core 1.0: https://openid.net/specs/openid-connect-core-1_0.html
+.. _OpenID Connect Discovery 1.0: https://openid.net/specs/openid-connect-discovery-1_0.html

doc/user/events/email.rst

@@ -203,4 +203,4 @@ Then, please contact support@pretix.eu and we will enable DKIM for your domain o
 
 
 .. _Sender Policy Framework: https://en.wikipedia.org/wiki/Sender_Policy_Framework
-.. _SPF specification: http://www.openspf.org/SPF_Record_Syntax
+.. _SPF specification: http://www.open-spf.org/SPF_Record_Syntax

doc/user/events/guides/groups.rst

@@ -1,20 +1,44 @@
 Use case: Group discounts
 -------------------------
 
-Often times, you want to give discounts for whole groups attending your event. pretix can't automatically discount based on volume, but there's still some ways you can set up group tickets.
+Often times, you want to give discounts for whole groups attending your event.
 
-Flexible group sizes
+Automatic discounts
+"""""""""""""""""""
+
+pretix can automatically grant discounts if a certain condition is met, such as a specific group size. To set this up,
+head to **Products**, **Discounts** in the event navigation and **Create a new discount**. You can choose a name so you
+can later find this again. You can also optionally restrict the discount to a specific time frame or a specific sales
+channel.
+
+Next, either select **Apply to all products** or create a selection of products that are eligible for the discount.
+
+For a **percentual group discount** similar to "if you buy at least 5 tickets, you get 20 percent off", set
+**Minimum number of matching products** to "5" and **Percentual discount on matching products** to "20.00".
+
+For a **buy-X-get-Y discount**, e.g. "if you buy 5 tickets, you get one free", set
+**Minimum number of matching products** to "5", **Percentual discount on matching products** to "100.00", and
+**Apply discount only to this number of matching products** to "1".
+
+Fixed group packages
 """"""""""""""""""""
 
-If you want to give out discounted tickets to groups starting at a given size, but still billed per person, you can do so by creating a special **Group ticket** at the per-person price and set the **Minimum amount per order** option of the ticket to the minimal group size.
+If you want to sell group tickets in fixed sizes, e.g. a table of eight at your gala dinner, you can use product bundles.
+Assuming you already set up a ticket for admission of single persons, you then set up a second product **Table (8 persons)**
+with a discounted full price. Then, head to the **Bundled products** tab of that product and add one bundle configuration
+to include the single admission product **eight times**. Next, create an unlimited quota mapped to the new product.
+
+This way, the purchase of a table will automatically create eight tickets, leading to a correct calculation of your total
+quota and, as expected, eight persons on your check-in list. You can even ask for the individual names of the persons
+during checkout.
+
+Minimum order amount
+""""""""""""""""""""
+
+If you want to promote discounted group tickets in your price list, you can also do so by creating a special
+**Group ticket** at the reduced per-person price and set the **Minimum amount per order** option of the ticket to the minimal
+group size.
 
 For more complex use cases, you can also use add-on products that can be chosen multiple times.
 
 This way, your ticket can be bought an arbitrary number of times – but no less than the given minimal amount per order.
-
-Fixed group sizes
-"""""""""""""""""
-
-If you want to sell group tickets in fixed sizes, e.g. a table of eight at your gala dinner, you can use product bundles. Assuming you already set up a ticket for admission of single persons, you then set up a second product **Table (8 persons)** with a discounted full price. Then, head to the **Bundled products** tab of that product and add one bundle configuration to include the single admission product **eight times**. Next, create an unlimited quota mapped to the new product.
-
-This way, the purchase of a table will automatically create eight tickets, leading to a correct calculation of your total quota and, as expected, eight persons on your check-in list. You can even ask for the individual names of the persons during checkout.

doc/user/events/ticket_secrets.rst

@@ -1,3 +1,5 @@
+.. _secret_generators:
+
 Ticket secret generators
 ========================
 
@@ -76,7 +78,7 @@ Synchronization setting                         any
 ----------------------------------------------- ----------------------------------- ----------------------------------------------------------------------- -----------------------------------------------------------------------
 Ticket secrets                                  any                                 Random                              Signed                              Random                            Signed
 =============================================== =================================== =================================== =================================== ================================= =====================================
-Scenario supported on platforms                 Android, Desktop, iOS               Android, Desktop, iOS               Android, Desktop                    Android, Desktop                  Android, Desktop
+Scenario supported on platforms                 Android, Desktop, iOS               Android, Desktop, iOS               Android, Desktop                    Android, Desktop, iOS             Android, Desktop, iOS
 Synchronization speed for large data sets                                           slow                                slow                                fast                              fast
 Tickets can be scanned                          yes                                 yes                                 yes                                 no                                yes
 Ticket is valid after sale                      immediately                         next sync (~5 minutes)              immediately                         never                             immediately
@@ -88,6 +90,7 @@ Name and seat visible on scanner                yes
 Order-specific check-in attention flag          yes                                 yes                                 yes (except directly after sale)    n/a                               no
 Ticket search by order code or name             yes                                 yes                                 yes (except directly after sale)    no                                no
 Check-in statistics on scanner                  yes                                 yes                                 mostly accurate                     no                                no
+Support for add-on check-in with main ticket    yes                                 yes                                 yes (except directly after sale)    no                                no
 =============================================== =================================== =================================== =================================== ================================= =====================================
 
 .. _EdDSA: https://en.wikipedia.org/wiki/EdDSA#Ed25519

doc/user/events/widget.rst

@@ -135,6 +135,10 @@ Alternatively, you can select one or more categories to be shown::
 
    <pretix-widget event="https://pretix.eu/demo/democon/" categories="12,25"></pretix-widget>
 
+Or variation IDs::
+
+   <pretix-widget event="https://pretix.eu/demo/democon/" variations="15,2,68"></pretix-widget>
+
 Multi-event selection
 ---------------------
 
@@ -253,18 +257,21 @@ If you want, you can suppress us loading the widget and/or modify the user data
 
 If you then later want to trigger loading the widgets, just call ``window.PretixWidget.buildWidgets()``.
 
-Waiting for the widget to load
-------------------------------
+Waiting for the widget to load or close
+---------------------------------------
 
-If you want to run custom JavaScript once the widget is fully loaded, you can register a callback function. Note that
-this function might be run multiple times, for example if you have multiple widgets on a page or if the user switches
-e.g. from an event list to an event detail view::
+If you want to run custom JavaScript once the widget is fully loaded or when it is closed, you can register callback
+functions. Note that these function might be run multiple times, for example if you have multiple widgets on a page
+or if the user switches e.g. from an event list to an event detail view::
 
     <script type="text/javascript">
     window.pretixWidgetCallback = function () {
         window.PretixWidget.addLoadListener(function () {
             console.log("Widget has loaded!");
         });
+        window.PretixWidget.addCloseListener(function () {
+            console.log("Widget has been closed!");
+        });
     }
     </script>
 
@@ -309,6 +316,10 @@ Currently, the following attributes are understood by pretix itself:
   always be modified. Note that this is not a security feature and can easily be overridden by users, so do not rely
   on this for authentication.
 
+* If ``data-consent="…"`` is given, the cookie consent mechanism will be initialized with consent for the given cookie
+  providers. All other providers will be disabled, no consent dialog will be shown. This is useful if you already
+  asked the user for consent and don't want them to be asked again. Example: ``data-consent="facebook,google_analytics"``
+
 Any configured pretix plugins might understand more data fields. For example, if the appropriate plugins on pretix
 Hosted or pretix Enterprise are active, you can pass the following fields:
 
@@ -400,7 +411,7 @@ Hosted or pretix Enterprise are active, you can pass the following fields:
         };
     </script>
 
-  If you use ```analytics.js` (Universal Analytics)::
+  If you use ``analytics.js`` (Universal Analytics)::
 
     <script>
         (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
@@ -436,8 +447,4 @@ Hosted or pretix Enterprise are active, you can pass the following fields:
     </script>
 
 
-.. versionchanged:: 3.6
-
-   Dynamically opening the widget has been added in pretix 3.6.
-
 .. _Let's Encrypt: https://letsencrypt.org/

doc/user/glossary.rst

@@ -84,7 +84,9 @@ going to develop around pretix, for example connect to pretix through our API, y
      - A voucher is a code that can be used for multiple purposes: To grant a discount to specific customers, to only
        show certain products to certain customers, or to keep a seat open for someone specific even though you are
        sold out. If a voucher is used to apply a discount, the price of the purchased product is reduced by the
-       discounted amount. Vouchers are connected to a specific event.
+   * - | |:gb:| **(Automatic) Discount**
+       | |:de:| (Automatischer) Rabatt
+     - Discounts can be used to automatically provide discounts to customers if their cart satisfies a certain condition.
    * - | |:gb:| **Gift card**
        | |:de:| Wertgutschein
      - A :ref:`gift card <giftcards>` is a coupon representing an exact amount of money that can be used for purchases

doc/user/index.rst

@@ -12,6 +12,7 @@ wanting to use pretix to sell tickets.
    events/settings
    events/structureguide
    events/widget
+   customers/index
    events/giftcards
    faq
    markdown

readthedocs.yml

@@ -1,6 +0,0 @@
-
-build:
-  image: latest
-
-python:
-  version: 3.6

src/.update-locales

@@ -34,5 +34,7 @@ git push
 # Unlock Weblate
 for c in $COMPONENTS; do
 	wlc unlock $c;
+done
+for c in $COMPONENTS; do
 	wlc pull $c;
 done

src/MANIFEST.in

@@ -13,6 +13,9 @@ recursive-include pretix/plugins/banktransfer/static *
 recursive-include pretix/plugins/manualpayment/templates *
 recursive-include pretix/plugins/manualpayment/static *
 recursive-include pretix/plugins/paypal/templates *
+recursive-include pretix/plugins/paypal/static *
+recursive-include pretix/plugins/paypal2/templates *
+recursive-include pretix/plugins/paypal2/static *
 recursive-include pretix/plugins/pretixdroid/templates *
 recursive-include pretix/plugins/pretixdroid/static *
 recursive-include pretix/plugins/sendmail/templates *

src/pretix/__init__.py

@@ -19,4 +19,4 @@
 # You should have received a copy of the GNU Affero General Public License along with this program.  If not, see
 # <https://www.gnu.org/licenses/>.
 #
-__version__ = "4.4.0.dev0"
+__version__ = "4.16.0.dev0"

src/pretix/api/auth/devicesecurity.py

@@ -45,6 +45,8 @@ class PretixScanSecurityProfile(AllowListSecurityProfile):
     allowlist = (
         ('GET', 'api-v1:version'),
         ('GET', 'api-v1:device.eventselection'),
+        ('GET', 'api-v1:idempotency.query'),
+        ('GET', 'api-v1:device.info'),
         ('POST', 'api-v1:device.update'),
         ('POST', 'api-v1:device.revoke'),
         ('POST', 'api-v1:device.roll'),
@@ -67,6 +69,8 @@ class PretixScanSecurityProfile(AllowListSecurityProfile):
         ('GET', 'api-v1:orderposition-pdf_image'),
         ('GET', 'api-v1:event.settings'),
         ('POST', 'api-v1:upload'),
+        ('POST', 'api-v1:checkinrpc.redeem'),
+        ('GET', 'api-v1:checkinrpc.search'),
     )
 
 
@@ -76,6 +80,8 @@ class PretixScanNoSyncNoSearchSecurityProfile(AllowListSecurityProfile):
     allowlist = (
         ('GET', 'api-v1:version'),
         ('GET', 'api-v1:device.eventselection'),
+        ('GET', 'api-v1:idempotency.query'),
+        ('GET', 'api-v1:device.info'),
         ('POST', 'api-v1:device.update'),
         ('POST', 'api-v1:device.revoke'),
         ('POST', 'api-v1:device.roll'),
@@ -96,6 +102,8 @@ class PretixScanNoSyncNoSearchSecurityProfile(AllowListSecurityProfile):
         ('GET', 'api-v1:orderposition-pdf_image'),
         ('GET', 'api-v1:event.settings'),
         ('POST', 'api-v1:upload'),
+        ('POST', 'api-v1:checkinrpc.redeem'),
+        ('GET', 'api-v1:checkinrpc.search'),
     )
 
 
@@ -105,6 +113,8 @@ class PretixScanNoSyncSecurityProfile(AllowListSecurityProfile):
     allowlist = (
         ('GET', 'api-v1:version'),
         ('GET', 'api-v1:device.eventselection'),
+        ('GET', 'api-v1:idempotency.query'),
+        ('GET', 'api-v1:device.info'),
         ('POST', 'api-v1:device.update'),
         ('POST', 'api-v1:device.revoke'),
         ('POST', 'api-v1:device.roll'),
@@ -126,6 +136,8 @@ class PretixScanNoSyncSecurityProfile(AllowListSecurityProfile):
         ('GET', 'api-v1:orderposition-pdf_image'),
         ('GET', 'api-v1:event.settings'),
         ('POST', 'api-v1:upload'),
+        ('POST', 'api-v1:checkinrpc.redeem'),
+        ('GET', 'api-v1:checkinrpc.search'),
     )
 
 
@@ -135,6 +147,8 @@ class PretixPosSecurityProfile(AllowListSecurityProfile):
     allowlist = (
         ('GET', 'api-v1:version'),
         ('GET', 'api-v1:device.eventselection'),
+        ('GET', 'api-v1:idempotency.query'),
+        ('GET', 'api-v1:device.info'),
         ('POST', 'api-v1:device.update'),
         ('POST', 'api-v1:device.revoke'),
         ('POST', 'api-v1:device.roll'),
@@ -151,6 +165,8 @@ class PretixPosSecurityProfile(AllowListSecurityProfile):
         ('GET', 'api-v1:ticketlayoutitem-list'),
         ('GET', 'api-v1:badgelayout-list'),
         ('GET', 'api-v1:badgeitem-list'),
+        ('GET', 'api-v1:voucher-list'),
+        ('GET', 'api-v1:voucher-detail'),
         ('GET', 'api-v1:order-list'),
         ('POST', 'api-v1:order-list'),
         ('GET', 'api-v1:order-detail'),
@@ -167,6 +183,8 @@ class PretixPosSecurityProfile(AllowListSecurityProfile):
         ('GET', 'api-v1:checkinlist-list'),
         ('POST', 'api-v1:checkinlistpos-redeem'),
         ('POST', 'plugins:pretix_posbackend:order.posprintlog'),
+        ('POST', 'plugins:pretix_posbackend:order.poslock'),
+        ('DELETE', 'plugins:pretix_posbackend:order.poslock'),
         ('DELETE', 'api-v1:cartposition-detail'),
         ('GET', 'api-v1:giftcard-list'),
         ('POST', 'api-v1:giftcard-transact'),
@@ -174,8 +192,12 @@ class PretixPosSecurityProfile(AllowListSecurityProfile):
         ('POST', 'plugins:pretix_posbackend:posreceipt-list'),
         ('POST', 'plugins:pretix_posbackend:posclosing-list'),
         ('POST', 'plugins:pretix_posbackend:posdebugdump-list'),
+        ('POST', 'plugins:pretix_posbackend:posdebuglogentry-list'),
+        ('POST', 'plugins:pretix_posbackend:posdebuglogentry-bulk-create'),
         ('GET', 'plugins:pretix_posbackend:poscashier-list'),
         ('POST', 'plugins:pretix_posbackend:stripeterminal.token'),
+        ('POST', 'plugins:pretix_posbackend:stripeterminal.paymentintent'),
+        ('PUT', 'plugins:pretix_posbackend:file.upload'),
         ('GET', 'api-v1:revokedsecrets-list'),
         ('GET', 'api-v1:event.settings'),
         ('GET', 'plugins:pretix_seating:event.event'),
@@ -183,6 +205,8 @@ class PretixPosSecurityProfile(AllowListSecurityProfile):
         ('GET', 'plugins:pretix_seating:event.plan'),
         ('GET', 'plugins:pretix_seating:selection.simple'),
         ('POST', 'api-v1:upload'),
+        ('POST', 'api-v1:checkinrpc.redeem'),
+        ('GET', 'api-v1:checkinrpc.search'),
     )
 
 

src/pretix/api/exception.py

@@ -19,11 +19,17 @@
 # You should have received a copy of the GNU Affero General Public License along with this program.  If not, see
 # <https://www.gnu.org/licenses/>.
 #
+import logging
+
+import ujson
+from rest_framework import exceptions
 from rest_framework.response import Response
 from rest_framework.views import exception_handler, status
 
 from pretix.base.services.locking import LockTimeoutException
 
+logger = logging.getLogger(__name__)
+
 
 def custom_exception_handler(exc, context):
     response = exception_handler(exc, context)
@@ -37,4 +43,7 @@ def custom_exception_handler(exc, context):
             }
         )
 
+    if isinstance(exc, exceptions.APIException):
+        logger.info(f'API Exception [{exc.status_code}]: {ujson.dumps(exc.detail)}')
+
     return response

src/pretix/api/migrations/0008_webhookcallretry.py

@@ -0,0 +1,29 @@
+# Generated by Django 3.2.12 on 2022-09-13 14:48
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('pretixbase', '0218_checkinlist_addon_match'),
+        ('pretixapi', '0007_alter_webhookcall_target_url'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='WebHookCallRetry',
+            fields=[
+                ('id', models.BigAutoField(primary_key=True, serialize=False)),
+                ('retry_not_before', models.DateTimeField(auto_now_add=True)),
+                ('retry_count', models.PositiveIntegerField(default=0)),
+                ('action_type', models.CharField(max_length=255)),
+                ('logentry', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='webhook_retries', to='pretixbase.logentry')),
+                ('webhook', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='retries', to='pretixapi.webhook')),
+            ],
+            options={
+                'unique_together': {('webhook', 'logentry')},
+            },
+        ),
+    ]

src/pretix/api/migrations/0009_auto_20221217_1847.py

@@ -0,0 +1,77 @@
+# Generated by Django 3.2.16 on 2022-12-17 18:47
+
+import uuid
+
+import django.db.models.deletion
+import oauth2_provider.generators
+import oauth2_provider.models
+from django.conf import settings
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('pretixbase', '0226_itemvariationmetavalue'),
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ('pretixapi', '0008_webhookcallretry'),
+    ]
+    run_before = [
+        ('oauth2_provider', '0002_auto_20190406_1805'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='oauthapplication',
+            name='algorithm',
+            field=models.CharField(default='', max_length=5),
+        ),
+        migrations.AddField(
+            model_name='oauthgrant',
+            name='claims',
+            field=models.TextField(default=''),
+            preserve_default=False,
+        ),
+        migrations.AddField(
+            model_name='oauthgrant',
+            name='code_challenge',
+            field=models.CharField(default='', max_length=128),
+        ),
+        migrations.AddField(
+            model_name='oauthgrant',
+            name='code_challenge_method',
+            field=models.CharField(default='', max_length=10),
+        ),
+        migrations.AddField(
+            model_name='oauthgrant',
+            name='nonce',
+            field=models.CharField(default='', max_length=255),
+        ),
+        migrations.AlterField(
+            model_name='oauthapplication',
+            name='client_secret',
+            field=oauth2_provider.models.ClientSecretField(db_index=True, default=oauth2_provider.generators.generate_client_secret, max_length=255),
+        ),
+        migrations.CreateModel(
+            name='OAuthIDToken',
+            fields=[
+                ('id', models.BigAutoField(primary_key=True, serialize=False)),
+                ('jti', models.UUIDField(default=uuid.uuid4, unique=True)),
+                ('expires', models.DateTimeField()),
+                ('scope', models.TextField()),
+                ('created', models.DateTimeField(auto_now_add=True)),
+                ('updated', models.DateTimeField(auto_now=True)),
+                ('application', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to=settings.OAUTH2_PROVIDER_APPLICATION_MODEL)),
+                ('organizers', models.ManyToManyField(to='pretixbase.Organizer')),
+                ('user', models.ForeignKey(null=True, on_delete=django.db.models.deletion.CASCADE, related_name='pretixapi_oauthidtoken', to=settings.AUTH_USER_MODEL)),
+            ],
+            options={
+                'abstract': False,
+            },
+        ),
+        migrations.AddField(
+            model_name='oauthaccesstoken',
+            name='id_token',
+            field=models.OneToOneField(null=True, on_delete=django.db.models.deletion.CASCADE, related_name='access_token', to='pretixapi.oauthidtoken'),
+        ),
+    ]