add back sort button disabled state management

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

@@ -6,10 +6,13 @@
 version: 2
 updates:
   - package-ecosystem: "pip"
-    directory: "/src"
+    directory: "/"
     schedule:
       interval: "daily"
+    versioning-strategy: increase
+    open-pull-requests-limit: 10
   - package-ecosystem: "npm"
     directory: "/src/pretix/static/npm_dir"
     schedule:
       interval: "monthly"
+    open-pull-requests-limit: 5

.github/workflows/build.yml

@@ -0,0 +1,49 @@
+name: Build
+
+on:
+  push:
+    branches: [ master ]
+    paths-ignore:
+      - 'doc/**'
+      - 'src/pretix/locale/**'
+  pull_request:
+    branches: [ master ]
+    paths-ignore:
+      - 'doc/**'
+      - 'src/pretix/locale/**'
+
+permissions:
+  contents: read  #  to fetch code (actions/checkout)
+
+env:
+  FORCE_COLOR: 1
+
+jobs:
+  test:
+    runs-on: ubuntu-22.04
+    name: Packaging
+    strategy:
+      matrix:
+        python-version: ["3.11"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - uses: actions/cache@v4
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+      - name: Install system dependencies
+        run: sudo apt update && sudo apt install gettext unzip
+      - name: Install Python dependencies
+        run: pip3 install -U setuptools build pip check-manifest
+      - name: Run check-manifest
+        run: check-manifest
+      - name: Run build
+        run: python -m build
+      - name: Check files
+        run: unzip -l dist/pretix*whl | grep node_modules || exit 1

.github/workflows/docs.yml

@@ -14,24 +14,30 @@ 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
-        uses: actions/setup-python@v1
+      - uses: actions/checkout@v4
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
         with:
-          python-version: 3.8
-      - uses: actions/cache@v1
+          python-version: 3.11
+      - uses: actions/cache@v4
         with:
           path: ~/.cache/pip
           key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
           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,17 +12,23 @@ 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
-        uses: actions/setup-python@v1
+      - uses: actions/checkout@v4
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
         with:
-          python-version: 3.8
-      - uses: actions/cache@v1
+          python-version: 3.11
+      - uses: actions/cache@v4
         with:
           path: ~/.cache/pip
           key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
@@ -32,7 +38,6 @@ jobs:
         run: sudo apt update && sudo apt install gettext
       - name: Install Dependencies
         run: pip3 install -e ".[dev]"
-        working-directory: ./src
       - name: Compile messages
         run: python manage.py compilemessages
         working-directory: ./src
@@ -40,25 +45,24 @@ 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
-        uses: actions/setup-python@v1
+      - uses: actions/checkout@v4
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
         with:
-          python-version: 3.8
-      - uses: actions/cache@v1
+          python-version: 3.11
+      - uses: actions/cache@v4
         with:
           path: ~/.cache/pip
           key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
           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
       - name: Spellcheck translations
         run: potypo
         working-directory: ./src

.github/workflows/style.yml

@@ -12,58 +12,62 @@ 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
-        uses: actions/setup-python@v1
+      - uses: actions/checkout@v4
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
         with:
-          python-version: 3.8
-      - uses: actions/cache@v1
+          python-version: 3.11
+      - uses: actions/cache@v4
         with:
           path: ~/.cache/pip
           key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
           restore-keys: |
             ${{ runner.os }}-pip-
       - name: Install Dependencies
-        run: pip3 install -e ".[dev]" mysqlclient psycopg2-binary
-        working-directory: ./src
+        run: pip3 install -e ".[dev]" psycopg2-binary
       - name: Run isort
         run: isort -c .
         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
-        uses: actions/setup-python@v1
+      - uses: actions/checkout@v4
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
         with:
-          python-version: 3.8
-      - uses: actions/cache@v1
+          python-version: 3.11
+      - uses: actions/cache@v4
         with:
           path: ~/.cache/pip
           key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
           restore-keys: |
             ${{ runner.os }}-pip-
       - name: Install Dependencies
-        run: pip3 install -e ".[dev]" mysqlclient psycopg2-binary
-        working-directory: ./src
+        run: pip3 install -e ".[dev]" psycopg2-binary
       - name: Run flake8
         run: flake8 .
         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
-        uses: actions/setup-python@v1
+      - uses: actions/checkout@v4
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
         with:
-          python-version: 3.8
+          python-version: 3.11
       - name: Install Dependencies
         run: pip3 install licenseheaders
       - name: Run licenseheaders

.github/workflows/tests.yml

@@ -12,53 +12,48 @@ 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.7", "3.8", "3.9"]
-        database: [sqlite, postgres, mysql]
+        python-version: ["3.9", "3.10", "3.11"]
+        database: [sqlite, postgres]
         exclude:
-          - database: mysql
-            python-version: "3.8"
-          - database: mysql
+          - database: sqlite
             python-version: "3.9"
           - database: sqlite
-            python-version: "3.7"
-          - database: sqlite
-            python-version: "3.8"
+            python-version: "3.10"
     steps:
-      - uses: actions/checkout@v2
-      - uses: getong/mariadb-action@v1.1
-        with:
-          mariadb version: '10.4'
-          mysql database: 'pretix'
-          mysql root password: ''
-        if: matrix.database == 'mysql'
+      - uses: actions/checkout@v4
       - uses: harmon758/postgresql-action@v1
         with:
-          postgresql version: '11'
+          postgresql version: '15'
           postgresql db: 'pretix'
           postgresql user: 'postgres'
           postgresql password: 'postgres'
         if: matrix.database == 'postgres'
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
-      - uses: actions/cache@v1
+      - uses: actions/cache@v4
         with:
           path: ~/.cache/pip
           key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
           restore-keys: |
             ${{ runner.os }}-pip-
       - name: Install system dependencies
-        run: sudo apt update && sudo apt install gettext mariadb-client
+        run: sudo apt update && sudo apt install gettext
       - name: Install Python dependencies
-        run: pip3 install -e ".[dev]" mysqlclient psycopg2-binary
-        working-directory: ./src
+        run: pip3 install --ignore-requires-python -e ".[dev]" psycopg2-binary  # We ignore that flake8 needs newer python as we don't run flake8 during tests
       - name: Run checks
         run: python manage.py check
         working-directory: ./src
@@ -71,9 +66,14 @@ jobs:
       - name: Run tests
         working-directory: ./src
         run: PRETIX_CONFIG_FILE=tests/travis_${{ matrix.database }}.cfg py.test -n 3 -p no:sugar --cov=./ --cov-report=xml --reruns 3 tests --maxfail=100
+      - name: Run concurrency tests
+        working-directory: ./src
+        run: PRETIX_CONFIG_FILE=tests/travis_${{ matrix.database }}.cfg py.test tests/concurrency_tests/ --reruns 0 --reuse-db
+        if: matrix.database == 'postgres'
       - name: Upload coverage
         uses: codecov/codecov-action@v1
         with:
           file: src/coverage.xml
+          token: ${{ secrets.CODECOV_TOKEN }}
           fail_ci_if_error: true
-        if: matrix.database == 'postgres' && matrix.python-version == '3.8'
+        if: matrix.database == 'postgres' && matrix.python-version == '3.11'

.gitignore

@@ -1,4 +1,6 @@
 env/
+build/
+dist/
 .coverage
 htmlcov/
 .ropeproject

.gitlab-ci.yml

@@ -1,44 +1,45 @@
-before_script:
 tests:
+    image:
+        name: pretix/ci-image
     stage: test
+    before_script:
+        - pip install -U pip uv
+        - uv pip install --system -U wheel setuptools
     script:
-        - virtualenv env
-        - source env/bin/activate
-        - pip install -U pip wheel setuptools
+        - uv pip install --system -e ".[dev]"
         - cd src
-        - XDG_CACHE_HOME=/cache pip3 install -e ".[dev]"
         - python manage.py check
         - make all compress
-        - py.test --reruns 3 -n 3 tests
-    tags:
-        - python3
+        - PRETIX_CONFIG_FILE=tests/travis_sqlite.cfg py.test --reruns 3 -n 3 tests --maxfail=100
     except:
         - pypi
 pypi:
     stage: release
+    image:
+        name: pretix/ci-image
+    before_script:
+        - cat $PYPIRC > ~/.pypirc
+        - pip install -U pip uv
+        - uv pip install --system -U wheel setuptools twine build pretix-plugin-build check-manifest
     script:
-        - cp /keys/.pypirc ~/.pypirc
-        - virtualenv env
-        - source env/bin/activate
-        - pip install -U pip wheel setuptools check-manifest twine
-        - cd src
-        - XDG_CACHE_HOME=/cache pip3 install -e ".[dev]"
+        - uv pip install --system -e ".[dev]"
         - python setup.py sdist
-        - pip install dist/pretix-*.tar.gz
+        - uv pip install --system dist/pretix-*.tar.gz
         - python -m pretix migrate
         - python -m pretix check
-        - check-manifest
+        - cd src
         - make npminstall
-        - python setup.py sdist bdist_wheel
+        - cd ..
+        - check-manifest
+        - python -m build
         - twine check dist/*
         - twine upload dist/*
-    tags:
-        - python3
     only:
         - pypi
     artifacts:
         paths:
             - src/dist/
+
 stages:
     - test
     - build

.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

@@ -1,9 +1,8 @@
-FROM python:3.9-bullseye
+FROM python:3.11-bookworm
 
 RUN apt-get update && \
     apt-get install -y --no-install-recommends \
             build-essential \
-            libmariadb-dev \
             gettext \
             git \
             libffi-dev \
@@ -19,38 +18,27 @@ RUN apt-get update && \
             python3-dev \
             sudo \
             supervisor \
-            zlib1g-dev && \
+            libmaxminddb0 \
+            libmaxminddb-dev \
+            zlib1g-dev \
+            nodejs  \
+            npm && \
     apt-get clean && \
     rm -rf /var/lib/apt/lists/* && \
-    dpkg-reconfigure locales && \
-	locale-gen C.UTF-8 && \
-	/usr/sbin/update-locale LANG=C.UTF-8 && \
+    dpkg-reconfigure locales &&  \
+    locale-gen C.UTF-8 &&  \
+    /usr/sbin/update-locale LANG=C.UTF-8 && \
     mkdir /etc/pretix && \
     mkdir /data && \
     useradd -ms /bin/bash -d /pretix -u 15371 pretixuser && \
     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 - && \
-    apt-get install -y nodejs && \
-    curl -qL https://www.npmjs.com/install.sh | sh
+    mkdir /etc/supervisord
 
 
 ENV LC_ALL=C.UTF-8 \
     DJANGO_SETTINGS_MODULE=production_settings
 
-# To copy only the requirements files needed to install from PIP
-COPY src/setup.py /pretix/src/setup.py
-RUN pip3 install -U \
-        pip \
-        setuptools \
-        wheel && \
-    cd /pretix/src && \
-    PRETIX_DOCKER_BUILD=TRUE pip3 install \
-        -e ".[memcached,mysql]" \
-        gunicorn django-extensions ipython && \
-    rm -rf ~/.cache/pip
-
 COPY deployment/docker/pretix.bash /usr/local/bin/pretix
 COPY deployment/docker/supervisord /etc/supervisord
 COPY deployment/docker/supervisord.all.conf /etc/supervisord.all.conf
@@ -58,17 +46,27 @@ COPY deployment/docker/supervisord.web.conf /etc/supervisord.web.conf
 COPY deployment/docker/nginx.conf /etc/nginx/nginx.conf
 COPY deployment/docker/nginx-max-body-size.conf /etc/nginx/conf.d/nginx-max-body-size.conf
 COPY deployment/docker/production_settings.py /pretix/src/production_settings.py
+COPY pyproject.toml /pretix/pyproject.toml
+COPY _build /pretix/_build
 COPY src /pretix/src
 
-RUN cd /pretix/src && python setup.py install
+RUN pip3 install -U \
+        pip \
+        setuptools \
+        wheel && \
+    cd /pretix && \
+    PRETIX_DOCKER_BUILD=TRUE pip3 install \
+        -e ".[memcached]" \
+        gunicorn django-extensions ipython && \
+    rm -rf ~/.cache/pip
 
 RUN chmod +x /usr/local/bin/pretix && \
     rm /etc/nginx/sites-enabled/default && \
     cd /pretix/src && \
-    rm -f pretix.cfg && \
-	mkdir -p data && \
-    chown -R pretixuser:pretixuser /pretix /data data && \
-	sudo -u pretixuser make production
+    rm -f pretix.cfg &&  \
+    mkdir -p data && \
+    chown -R pretixuser:pretixuser /pretix /data data &&  \
+    sudo -u pretixuser make production
 
 USER pretixuser
 VOLUME ["/etc/pretix", "/data"]

MANIFEST.in

@@ -0,0 +1,48 @@
+include LICENSE
+include README.rst
+include src/Makefile
+include _build/backend.py
+global-include *.proto
+recursive-include src/pretix/static *
+recursive-include src/pretix/static.dist *
+recursive-include src/pretix/locale *
+recursive-include src/pretix/helpers/locale *
+recursive-include src/pretix/base/templates *
+recursive-include src/pretix/control/templates *
+recursive-include src/pretix/presale/templates *
+recursive-include src/pretix/plugins/banktransfer/templates *
+recursive-include src/pretix/plugins/banktransfer/static *
+recursive-include src/pretix/plugins/manualpayment/templates *
+recursive-include src/pretix/plugins/manualpayment/static *
+recursive-include src/pretix/plugins/paypal/templates *
+recursive-include src/pretix/plugins/paypal/static *
+recursive-include src/pretix/plugins/paypal2/templates *
+recursive-include src/pretix/plugins/paypal2/static *
+recursive-include src/pretix/plugins/src/pretixdroid/templates *
+recursive-include src/pretix/plugins/src/pretixdroid/static *
+recursive-include src/pretix/plugins/sendmail/templates *
+recursive-include src/pretix/plugins/statistics/templates *
+recursive-include src/pretix/plugins/statistics/static *
+recursive-include src/pretix/plugins/stripe/templates *
+recursive-include src/pretix/plugins/stripe/static *
+recursive-include src/pretix/plugins/ticketoutputpdf/templates *
+recursive-include src/pretix/plugins/ticketoutputpdf/static *
+recursive-include src/pretix/plugins/badges/templates *
+recursive-include src/pretix/plugins/badges/static *
+recursive-include src/pretix/plugins/returnurl/templates *
+recursive-include src/pretix/plugins/returnurl/static *
+recursive-include src/pretix/plugins/webcheckin/templates *
+recursive-include src/pretix/plugins/webcheckin/static *
+recursive-include src *.cfg
+recursive-include src *.csv
+recursive-include src *.gitkeep
+recursive-include src *.jpg
+recursive-include src *.json
+recursive-include src *.py
+recursive-include src *.svg
+recursive-include src *.txt
+recursive-include src Makefile
+
+recursive-exclude doc *
+recursive-exclude deployment *
+recursive-exclude res *

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).

_build/backend.py

@@ -0,0 +1,12 @@
+import tomli
+from setuptools import build_meta as _orig
+from setuptools.build_meta import *
+
+
+def get_requires_for_build_wheel(config_settings=None):
+    with open("pyproject.toml", "rb") as f:
+        p = tomli.load(f)
+    return [
+        *_orig.get_requires_for_build_wheel(config_settings),
+        *p['project']['dependencies']
+    ]

deployment/docker/pretix.bash

@@ -5,7 +5,7 @@ export DATA_DIR=/data/
 export HOME=/pretix
 
 AUTOMIGRATE=${AUTOMIGRATE:-yes}
-NUM_WORKERS_DEFAULT=$((2 * $(nproc --all)))
+NUM_WORKERS_DEFAULT=$((2 * $(nproc)))
 export NUM_WORKERS=${NUM_WORKERS:-$NUM_WORKERS_DEFAULT}
 
 if [ ! -d /data/logs ]; then

deployment/docker/production_settings.py

@@ -1,4 +1,4 @@
 from pretix.settings import *
 
 LOGGING['handlers']['mail_admins']['include_html'] = True
-STATICFILES_STORAGE = 'django.contrib.staticfiles.storage.ManifestStaticFilesStorage'
+STORAGES["staticfiles"]["BACKEND"] = 'django.contrib.staticfiles.storage.ManifestStaticFilesStorage'

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

@@ -18,67 +18,82 @@
   <title>{{ title|striptags|e }}{{ titlesuffix }}</title>
   {% endblock %}
 
-  {# FAVICON #}
-  {% if favicon %}
-    <link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}"/>
-  {% endif %}
-  {# CANONICAL URL #}
-  {% if theme_canonical_url %}
+
+  {#- CSS #}
+  {%- for css in css_files %}
+    {%- if css|attr("rel") %}
+      <link rel="{{ css.rel }}" href="{{ pathto(css.filename, 1) }}" type="text/css"{% if css.title is not none %} title="{{ css.title }}"{% endif %} />
+    {%- else %}
+      <link rel="stylesheet" href="{{ pathto(css, 1) }}" type="text/css" />
+    {%- endif %}
+  {%- endfor %}
+
+  {%- for cssfile in extra_css_files %}
+    <link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" />
+  {%- endfor -%}
+
+  {#- FAVICON
+      favicon_url is the only context var necessary since Sphinx 4.
+      In Sphinx<4, we use favicon but need to prepend path info.
+  #}
+  {%- set _favicon_url = favicon_url | default(pathto('_static/' + (favicon or ""), 1)) %}
+  {%- if favicon_url or favicon %}
+    <link rel="shortcut icon" href="{{ _favicon_url }}"/>
+  {%- endif %}
+
+  {#- CANONICAL URL (deprecated) #}
+  {%- if theme_canonical_url and not pageurl %}
     <link rel="canonical" href="{{ theme_canonical_url }}{{ pagename }}.html"/>
-  {% endif %}
+  {%- endif -%}
 
-  {# CSS #}
+  {#- CANONICAL URL #}
+  {%- if pageurl %}
+    <link rel="canonical" href="{{ pageurl|e }}" />
+  {%- endif -%}
 
-  {# OPENSEARCH #}
-  {% if not embedded %}
-    {% if use_opensearch %}
-      <link rel="search" type="application/opensearchdescription+xml" title="{% trans docstitle=docstitle|e %}Search within {{ docstitle }}{% endtrans %}" href="{{ pathto('_static/opensearch.xml', 1) }}"/>
-    {% endif %}
+  {#- JAVASCRIPTS #}
+  {%- block scripts %}
+  <!--[if lt IE 9]>
+    <script src="{{ pathto('_static/js/html5shiv.min.js', 1) }}"></script>
+  <![endif]-->
+  {%- if not embedded %}
+  {# XXX Sphinx 1.8.0 made this an external js-file, quick fix until we refactor the template to inherert more blocks directly from sphinx #}
+      {%- for scriptfile in script_files %}
+        {{ js_tag(scriptfile) }}
+      {%- endfor %}
+    <script src="{{ pathto('_static/js/theme.js', 1) }}"></script>
 
-  {% endif %}
-
-  {# RTD hosts this file, so just load on non RTD builds #}
-    <link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" />
-
-  {% for cssfile in css_files %}
-    <link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" />
-  {% endfor %}
-
-  {% for cssfile in extra_css_files %}
-    <link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" />
-  {% endfor %}
+    {#- OPENSEARCH #}
+    {%- if use_opensearch %}
+    <link rel="search" type="application/opensearchdescription+xml"
+          title="{% trans docstitle=docstitle|e %}Search within {{ docstitle }}{% endtrans %}"
+          href="{{ pathto('_static/opensearch.xml', 1) }}"/>
+    {%- endif %}
+  {%- endif %}
+  {%- endblock %}
 
   {%- block linktags %}
     {%- if hasdoc('about') %}
-        <link rel="author" title="{{ _('About these documents') }}"
-              href="{{ pathto('about') }}"/>
+    <link rel="author" title="{{ _('About these documents') }}" href="{{ pathto('about') }}" />
     {%- endif %}
     {%- if hasdoc('genindex') %}
-        <link rel="index" title="{{ _('Index') }}"
-              href="{{ pathto('genindex') }}"/>
+    <link rel="index" title="{{ _('Index') }}" href="{{ pathto('genindex') }}" />
     {%- endif %}
     {%- if hasdoc('search') %}
-        <link rel="search" title="{{ _('Search') }}" href="{{ pathto('search') }}"/>
+    <link rel="search" title="{{ _('Search') }}" href="{{ pathto('search') }}" />
     {%- endif %}
     {%- if hasdoc('copyright') %}
-        <link rel="copyright" title="{{ _('Copyright') }}" href="{{ pathto('copyright') }}"/>
-    {%- endif %}
-    <link rel="top" title="{{ docstitle|e }}" href="{{ pathto('index') }}"/>
-    {%- if parents %}
-        <link rel="up" title="{{ parents[-1].title|striptags|e }}" href="{{ parents[-1].link|e }}"/>
+    <link rel="copyright" title="{{ _('Copyright') }}" href="{{ pathto('copyright') }}" />
     {%- endif %}
     {%- if next %}
-        <link rel="next" title="{{ next.title|striptags|e }}" href="{{ next.link|e }}"/>
+    <link rel="next" title="{{ next.title|striptags|e }}" href="{{ next.link|e }}" />
     {%- endif %}
     {%- if prev %}
-        <link rel="prev" title="{{ prev.title|striptags|e }}" href="{{ prev.link|e }}"/>
+    <link rel="prev" title="{{ prev.title|striptags|e }}" href="{{ prev.link|e }}" />
     {%- endif %}
   {%- endblock %}
   {%- block extrahead %} {% endblock %}
 
-  {# Keep modernizr in head - http://modernizr.com/docs/#installing #}
-  <script src="{{ pathto('_static/js/modernizr.min.js', 1) }}"></script>
-
 </head>
 
 <body class="wy-body-for-nav" role="document">
@@ -92,16 +107,14 @@
         <div class="wy-side-nav-search">
           {% block sidebartitle %}
 
-          {% if logo and theme_logo_only %}
-            <a href="{{ pathto('index') }}">
-          {% else %}
-            <a href="{{ pathto('index') }}" class="icon icon-home"> {{ project }}
-          {% endif %}
-
-          {% if logo %}
-            {# Not strictly valid HTML, but it's the only way to display/scale it properly, without weird scripting or heaps of work #}
-            <img src="{{ pathto('_static/' + logo, 1) }}" class="logo" />
-          {% endif %}
+          {# the logo helper function was removed in Sphinx 6 and deprecated since Sphinx 4 #}
+          {# the master_doc variable was renamed to root_doc in Sphinx 4 (master_doc still exists in later Sphinx versions) #}
+          {%- set _logo_url = logo_url|default(pathto('_static/' + (logo or ""), 1)) %}
+          {%- set _root_doc = root_doc|default(master_doc) %}
+          <a href="{{ pathto(_root_doc) }}"{% if not theme_logo_only %} class="icon icon-home"{% endif %}>
+            {%- if logo or logo_url %}
+              <img src="{{ _logo_url }}" class="logo" alt="{{ _('Logo') }}"/>
+            {%- endif %}
           </a>
 
           {% include "searchbox.html" %}
@@ -157,7 +170,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/search.html

@@ -5,31 +5,37 @@
     Template for the search page.
 
     :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
+    :license: BSD, see https://github.com/sphinx-doc/sphinx/blob/master/LICENSE for details.
 #}
 {%- extends "layout.html" %}
 {% set title = _('Search') %}
-{% set script_files = script_files + ['_static/searchtools.js'] %}
+{% set display_vcs_links = False %}
+{%- block scripts %}
+    {{ super() }}
+    <script src="{{ pathto('_static/searchtools.js', 1) }}"></script>
+    <script src="{{ pathto('_static/language_data.js', 1) }}"></script>
+{%- endblock %}
 {% block footer %}
-  <script type="text/javascript">
+  <script>
     jQuery(function() { Search.loadIndex("{{ pathto('searchindex.js', 1) }}"); });
   </script>
   {# this is used when loading the search index using $.ajax fails,
      such as on Chrome for documents on localhost #}
-  <script type="text/javascript" id="searchindexloader"></script>
+  <script id="searchindexloader"></script>
   {{ super() }}
 {% endblock %}
 {% block body %}
   <noscript>
   <div id="fallback" class="admonition warning">
     <p class="last">
-      {% trans %}Please activate JavaScript to enable the search
+      {% trans trimmed %}Please activate JavaScript to enable the search
       functionality.{% endtrans %}
     </p>
   </div>
   </noscript>
 
   {% if search_performed %}
+    {# Translators: Search is a noun, not a verb #}
     <h2>{{ _('Search Results') }}</h2>
     {% if not search_results %}
       <p>{{ _('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.') }}</p>
@@ -47,4 +53,4 @@
     </ul>
   {% endif %}
   </div>
-{% endblock %}
+{% endblock %}

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

@@ -2,7 +2,7 @@
 
 .. _`config`:
 
-.. spelling:: Galera
+.. spelling:word-list:: Galera
 
 Configuration file
 ==================
@@ -42,7 +42,6 @@ Example::
     currency=EUR
     datadir=/data
     plugins_default=pretix.plugins.sendmail,pretix.plugins.statistics
-    cookie_domain=.pretix.de
 
 ``instance_name``
     The name of this installation. Default: ``pretix.de``
@@ -53,10 +52,18 @@ Example::
 ``currency``
     The default currency as a three-letter code. Defaults to ``EUR``.
 
+``cachedir``
+    The local path to a directory where temporary files will be stored.
+    Defaults to the ``cache`` directory below the ``datadir``.
+
 ``datadir``
     The local path to a data directory that will be used for storing user uploads and similar
     data. Defaults to the value of the environment variable ``DATA_DIR`` or ``data``.
 
+``logdir``
+    The local path to a directory where log files will be stored.
+    Defaults to the ``logs`` directory below the ``datadir``.
+
 ``plugins_default``
     A comma-separated list of plugins that are enabled by default for all new events.
     Defaults to ``pretix.plugins.sendmail,pretix.plugins.statistics``.
@@ -71,11 +78,8 @@ Example::
 ``auth_backends``
     A comma-separated list of available auth backends. Defaults to ``pretix.base.auth.NativeAuthBackend``.
 
-``cookie_domain``
-    The cookie domain to be set. Defaults to ``None``.
-
 ``registration``
-    Enables or disables the registration of new admin users. Defaults to ``on``.
+    Enables or disables the registration of new admin users. Defaults to ``off``.
 
 ``password_reset``
     Enables or disables password reset. Defaults to ``on``.
@@ -84,7 +88,7 @@ Example::
     Enables or disables the "keep me logged in" button. Defaults to ``on``.
 
 ``ecb_rates``
-    By default, pretix periodically downloads a XML file from the European Central Bank to retrieve exchange rates
+    By default, pretix periodically downloads currency rates from the European Central Bank as well as other authorities
     that are used to print tax amounts in the customer currency on invoices for some currencies. Set to ``off`` to
     disable this feature. Defaults to ``on``.
 
@@ -93,8 +97,9 @@ Example::
     Defaults to ``off``.
 
 ``obligatory_2fa``
-    Enables or disables obligatory usage of Two-Factor Authentication for users of the pretix backend.
-    Defaults to ``False``
+    Enables or disables obligatory usage of two-factor authentication for users of the pretix backend.
+    Can be ``True`` to make two-factor authentication obligatory for all users or ``staff`` to make it only
+    obligatory to users with admin permissions. Defaults to ``False``.
 
 ``trust_x_forwarded_for``
     Specifies whether the ``X-Forwarded-For`` header can be trusted. Only set to ``on`` if you have a reverse
@@ -106,6 +111,11 @@ Example::
     proxy that actively removes and re-adds the header to make sure the correct value is set.
     Defaults to ``off``.
 
+``trust_x_forwarded_host``
+    Specifies whether the ``X-Forwarded-Host`` header can be trusted. Only set to ``on`` if you have a reverse
+    proxy that actively removes and re-adds the header to make sure the correct value is set.
+    Defaults to ``off``.
+
 ``csp_log``
     Log violations of the Content Security Policy (CSP). Defaults to ``on``.
 
@@ -117,6 +127,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
 ---------------
 
@@ -138,30 +151,44 @@ Database settings
 Example::
 
     [database]
-    backend=mysql
+    backend=postgresql
     name=pretix
     user=pretix
     password=abcd
     host=localhost
     port=3306
+    advisory_lock_index=1
+    disable_server_side_cursors=0
+    sslmode=require
+    sslrootcert=/etc/pretix/postgresql-ca.crt
+    sslcert=/etc/pretix/postgresql-client-crt.crt
+    sslkey=/etc/pretix/postgresql-client-key.key
 
 ``backend``
-    One of ``mysql``, ``sqlite3``, ``oracle`` and ``postgresql``.
+    One of ``sqlite3`` and ``postgresql``.
     Default: ``sqlite3``.
 
-    If you use MySQL, be sure to create your database using
-    ``CREATE DATABASE <dbname> CHARACTER SET utf8;``. Otherwise, Unicode
-    support will not properly work.
-
 ``name``
     The database's name. Default: ``db.sqlite3``.
 
 ``user``, ``password``, ``host``, ``port``
     Connection details for the database connection. Empty by default.
 
-``galera``
-    Indicates if the database backend is a MySQL/MariaDB Galera cluster and
-    turns on some optimizations/special case handlers. Default: ``False``
+``advisory_lock_index``
+    On PostgreSQL, pretix uses the "advisory lock" feature. However, advisory locks use a server-wide name space and
+    and are not scoped to a specific database. If you run multiple pretix applications with the same PostgreSQL server,
+    you should set separate values for this setting (integers up to 256).
+
+``disable_server_side_cursors``
+    On PostgreSQL pretix might use server side cursors for certain operations. This is generally fine but will break in
+    specific circumstances, for example when connecting to PostgreSQL through a PGBouncer configured with a transaction
+    pool mode. Off by default (i.e. by default server side cursors will be used).
+
+``sslmode``, ``sslrootcert``
+    Connection TLS details for the PostgreSQL database connection. Possible values of ``sslmode`` are ``disable``, ``allow``, ``prefer``, ``require``, ``verify-ca``, and ``verify-full``. ``sslrootcert`` should be the accessible path of the ca certificate. Both values are empty by default.
+
+``sslcert``, ``sslkey``
+    Connection mTLS details for the PostgreSQL database connection. It's also necessary to specify ``sslmode`` and ``sslrootcert`` parameters, please check the correct values from the TLS part. ``sslcert`` should be the accessible path of the client certificate.  ``sslkey`` should be the accessible path of the client key. All values are empty by default.
 
 .. _`config-replica`:
 
@@ -191,7 +218,7 @@ Example::
 
     [urls]
     media=/media/
-    static=/media/
+    static=/static/
 
 ``media``
     The URL to be used to serve user-uploaded content. You should not need to modify
@@ -324,12 +351,16 @@ to speed up various operations::
             ["sentinel_host_3", 26379]
         ]
     password=password
+    ssl_cert_reqs=required
+    ssl_ca_certs=/etc/pretix/redis-ca.pem
+    ssl_keyfile=/etc/pretix/redis-client-crt.pem
+    ssl_certfile=/etc/pretix/redis-client-key.key
 
 ``location``
     The location of redis, as a URL of the form ``redis://[:password]@localhost:6379/0``
     or ``unix://[:password]@/path/to/socket.sock?db=0``
 
-``session``
+``sessions``
     When this is set to ``True``, redis will be used as the session storage.
 
 ``sentinels``
@@ -347,6 +378,22 @@ to speed up various operations::
     If your redis setup doesn't require a password or you already specified it in the location you can omit this option.
     If this is set it will be passed to redis as the connection option PASSWORD.
 
+``ssl_cert_reqs``
+    If this is set it will be passed to redis as the connection option ``SSL_CERT_REQS``.
+    Possible values are ``none``, ``optional``, and ``required``.
+
+``ssl_ca_certs``
+    If your redis setup doesn't require TLS you can omit this option.
+    If this is set it will be passed to redis as the connection option ``SSL_CA_CERTS``. Possible value is the ca path.
+
+``ssl_keyfile``
+    If your redis setup doesn't require mTLS you can omit this option.
+    If this is set it will be passed to redis as the connection option ``SSL_KEYFILE``. Possible value is the keyfile path.
+
+``ssl_certfile``
+    If your redis setup doesn't require mTLS you can omit this option.
+    If this is set it will be passed to redis as the connection option ``SSL_CERTFILE``. Possible value is the certfile path.
+
 If redis is not configured, pretix will store sessions and locks in the database. If memcached
 is configured, memcached will be used for caching instead of redis.
 
@@ -396,9 +443,11 @@ 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``
+It is possible the use Redis with TLS/mTLS for the broker or the backend. To do so, it is necessary to specify the TLS identifier ``rediss``, the ssl mode ``ssl_cert_reqs`` and optionally specify the CA (TLS) ``ssl_ca_certs``, cert ``ssl_certfile`` and key ``ssl_keyfile`` (mTLS) path as encoded string. the following uri describes the format and possible parameters ``rediss://0.0.0.0:6379/1?ssl_cert_reqs=required&ssl_ca_certs=%2Fetc%2Fpretix%2Fredis-ca.pem&ssl_certfile=%2Fetc%2Fpretix%2Fredis-client-crt.pem&ssl_keyfile=%2Fetc%2Fpretix%2Fredis-client-key.key``
+
+To use redis with sentinels set the broker or backend to ``sentinel://sentinel_host_1:26379;sentinel_host_2:26379/0``
 and the respective transport_options to ``{"master_name":"mymaster"}``.
-If your redis instances behind the sentinel have a password use ``sentinel://:my_password@sentinel_host_1:26379;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
@@ -473,3 +522,18 @@ You can configure the maximum file size for uploading various files::
     ; Max upload size for other files in MiB, defaults to 10 MiB
     ; This includes all file upload type order questions
     max_size_other = 100
+
+
+GeoIP
+-----
+
+pretix can optionally make use of a GeoIP database for some features. It needs a file in ``mmdb`` format, for example
+`GeoLite2`_ or `GeoAcumen`_::
+
+    [geoip]
+    path=/var/geoipdata/
+    filename_country=GeoLite2-Country.mmdb
+
+
+.. _GeoAcumen: https://github.com/geoacumen/geoacumen-country
+.. _GeoLite2: https://dev.maxmind.com/geoip/geolite2-free-geolocation-data

doc/admin/index.rst

@@ -14,4 +14,5 @@ This documentation is for everyone who wants to install pretix on a server.
    maintainance
    scaling
    errors
+   mysql2postgres
    indexes

doc/admin/indexes.rst

@@ -45,8 +45,8 @@ Here is the currently recommended set of commands::
     CREATE INDEX CONCURRENTLY pretix_addidx_order_comment
         ON pretixbase_order
         USING gin (upper("comment") gin_trgm_ops);
-    CREATE INDEX CONCURRENTLY pretix_addidx_order_event_date
-        ON public.pretixbase_order (event_id, datetime);
+    CREATE INDEX CONCURRENTLY pretix_addidx_order_event_date_id
+        ON public.pretixbase_order (event_id, datetime, id);
     CREATE INDEX CONCURRENTLY pretix_addidx_orderpos_name
         ON pretixbase_orderposition
         USING gin (upper("attendee_name_cached") gin_trgm_ops);
@@ -66,10 +66,10 @@ Here is the currently recommended set of commands::
         ON public.pretixbase_orderposition (upper((attendee_email)::text));
     CREATE INDEX CONCURRENTLY pretix_addidx_voucher_code_upper
         ON public.pretixbase_voucher (upper((code)::text));
-    CREATE INDEX CONCURRENTLY pretix_addidx_logentry_event_date
-        ON public.pretixbase_logentry (event_id, datetime);
-    CREATE INDEX CONCURRENTLY pretix_addidx_logentry_event_cid_date
-        ON public.pretixbase_logentry (event_id, content_type_id, datetime);
+    CREATE INDEX CONCURRENTLY pretix_addidx_logentry_event_date_id
+        ON public.pretixbase_logentry (event_id, datetime, id);
+    CREATE INDEX CONCURRENTLY pretix_addidx_logentry_event_cid_date_id
+        ON public.pretixbase_logentry (event_id, content_type_id, datetime, id);
 
 
 Also, if you use our ``pretix-shipping`` plugin::

doc/admin/installation/community.rst

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

doc/admin/installation/dev_version.rst

@@ -16,7 +16,7 @@ Manual installation
 You can use ``pip`` to update pretix directly to the development branch. Then, upgrade as usual::
 
     $ source /var/pretix/venv/bin/activate
-    (venv)$ pip3 install -U "git+https://github.com/pretix/pretix.git#egg=pretix&subdirectory=src"
+    (venv)$ pip3 install -U "git+https://github.com/pretix/pretix.git#egg=pretix"
     (venv)$ python -m pretix migrate
     (venv)$ python -m pretix rebuild
     (venv)$ python -m pretix updatestyles

doc/admin/installation/docker_smallscale.rst

@@ -14,7 +14,7 @@ This has some trade-offs in terms of performance and isolation but allows a rath
              get it right. If you're not feeling comfortable managing a Linux server, check out our hosting and service
              offers at `pretix.eu`_.
 
-We tested this guide on the Linux distribution **Debian 8.0** but it should work very similar on other
+We tested this guide on the Linux distribution **Debian 11.0** but it should work very similar on other
 modern distributions, especially on all systemd-based ones.
 
 Requirements
@@ -26,7 +26,7 @@ installation guides):
 * `Docker`_
 * A SMTP server to send out mails, e.g. `Postfix`_ on your machine or some third-party server you have credentials for
 * A HTTP reverse proxy, e.g. `nginx`_ or Apache to allow HTTPS connections
-* A `PostgreSQL`_ 9.6+, `MySQL`_ 5.7+, or MariaDB 10.2.7+ database server
+* A `PostgreSQL`_ 12+ database server
 * A `redis`_ server
 
 We also recommend that you use a firewall, although this is not a pretix-specific recommendation. If you're new to
@@ -58,9 +58,6 @@ 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::
@@ -86,13 +83,6 @@ Restart PostgreSQL after you changed these files::
 
 If you have a firewall running, you should also make sure that port 5432 is reachable from the ``172.17.0.1/16`` subnet.
 
-For MySQL, you can either also use network-based connections or mount the ``/var/run/mysqld/mysqld.sock`` socket into the docker container.
-When using MySQL, make sure you set the character set of the database to ``utf8mb4``, e.g. like this::
-
-    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
 -----
 
@@ -152,15 +142,13 @@ Fill the configuration file ``/etc/pretix/pretix.cfg`` with the following conten
     trust_x_forwarded_proto=on
 
     [database]
-    ; Replace postgresql with mysql for MySQL
     backend=postgresql
     name=pretix
     user=pretix
     ; Replace with the password you chose above
     password=*********
     ; In most docker setups, 172.17.0.1 is the address of the docker host. Adjust
-    ; this to wherever your database is running, e.g. the name of a linked container
-    ; or of a mounted MySQL socket.
+    ; this to wherever your database is running, e.g. the name of a linked container.
     host=172.17.0.1
 
     [mail]
@@ -212,8 +200,6 @@ named ``/etc/systemd/system/pretix.service`` with the following content::
     [Install]
     WantedBy=multi-user.target
 
-When using MySQL and socket mounting, you'll need the additional flag ``-v /var/run/mysqld:/var/run/mysqld`` in the command.
-
 You can now run the following commands
 to enable and start the service::
 
@@ -240,6 +226,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;
@@ -287,7 +276,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.
+Make sure to also read :ref:`update_notes` and the release notes of the version you are updating to. Pay special
+attention to the "Runtime and server environment" section of all release notes between your current and new version.
 
 .. _`docker_plugininstall`:
 
@@ -332,12 +322,11 @@ workers, e.g. ``docker run … taskworker -Q notifications --concurrency 32``.
 
 
 .. _Docker: https://docs.docker.com/engine/installation/linux/debian/
-.. _Postfix: https://www.digitalocean.com/community/tutorials/how-to-install-and-configure-postfix-as-a-send-only-smtp-server-on-ubuntu-16-04
+.. _Postfix: https://www.digitalocean.com/community/tutorials/how-to-install-and-configure-postfix-as-a-send-only-smtp-server-on-ubuntu-22-04
 .. _nginx: https://botleg.com/stories/https-with-lets-encrypt-and-nginx/
 .. _Let's Encrypt: https://letsencrypt.org/
 .. _pretix.eu: https://pretix.eu/
-.. _MySQL: https://dev.mysql.com/doc/refman/5.7/en/linux-installation-apt-repo.html
-.. _PostgreSQL: https://www.digitalocean.com/community/tutorials/how-to-install-and-use-postgresql-on-ubuntu-20-04
+.. _PostgreSQL: https://www.digitalocean.com/community/tutorials/how-to-install-and-use-postgresql-on-ubuntu-22-04
 .. _redis: https://blog.programster.org/debian-8-install-redis-server/
 .. _ufw: https://en.wikipedia.org/wiki/Uncomplicated_Firewall
 .. _redis website: https://redis.io/topics/security

doc/admin/installation/enterprise.rst

@@ -68,7 +68,7 @@ generated key and installs the plugin from the URL we told you::
         mkdir -p /etc/ssh && \
         ssh-keyscan -t rsa -p 10022 code.rami.io >> /root/.ssh/known_hosts && \
         echo StrictHostKeyChecking=no >> /root/.ssh/config && \
-        DJANGO_SETTINGS_MODULE=pretix.settings pip3 install -U "git+ssh://git@code.rami.io:10022/pretix/pretix-slack.git@stable#egg=pretix-slack" && \
+        DJANGO_SETTINGS_MODULE= pip3 install -U "git+ssh://git@code.rami.io:10022/pretix/pretix-slack.git@stable#egg=pretix-slack" && \
         cd /pretix/src && \
         sudo -u pretixuser make production
     USER pretixuser

doc/admin/installation/general.rst

@@ -1,6 +1,6 @@
 .. highlight:: ini
 
-.. spelling:: SQL
+.. spelling:word-list:: SQL
 
 General remarks
 ===============
@@ -16,14 +16,11 @@ To use pretix, you will need the following things:
 * A periodic task runner, e.g. ``cron``
 
 * **A database**. This needs to be a SQL-based that is supported by Django. We highly recommend to either
-  go for **PostgreSQL** or **MySQL/MariaDB**. If you do not provide one, pretix will run on SQLite, which is useful
+  go for **PostgreSQL**. If you do not provide one, pretix will run on SQLite, which is useful
   for evaluation and development purposes.
 
   .. warning:: Do not ever use SQLite in production. It will break.
 
-  .. 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**.
-
 * A **reverse proxy**. pretix needs to deliver some static content to your users (e.g. CSS, images, ...). While pretix
   is capable of doing this, having this handled by a proper web server like **nginx** or **Apache** will be much
   faster. Also, you need a proxying web server in front to provide SSL encryption.

doc/admin/installation/index.rst

@@ -14,3 +14,4 @@ for your needs.
    manual_smallscale
    dev_version
    enterprise
+   community

doc/admin/installation/manual_smallscale.rst

@@ -12,7 +12,7 @@ solution with many things readily set-up, look at :ref:`dockersmallscale`.
              get it right. If you're not feeling comfortable managing a Linux server, check out our hosting and service
              offers at `pretix.eu`_.
 
-We tested this guide on the Linux distribution **Debian 10.0** but it should work very similar on other
+We tested this guide on the Linux distribution **Debian 12** but it should work very similar on other
 modern distributions, especially on all systemd-based ones.
 
 Requirements
@@ -21,9 +21,10 @@ Requirements
 Please set up the following systems beforehand, we'll not explain them here in detail (but see these links for external
 installation guides):
 
+* A python 3.9+ installation
 * A SMTP server to send out mails, e.g. `Postfix`_ on your machine or some third-party server you have credentials for
 * A HTTP reverse proxy, e.g. `nginx`_ or Apache to allow HTTPS connections
-* A `PostgreSQL`_ 9.6+, `MySQL`_ 5.7+, or MariaDB 10.2.7+ database server
+* A `PostgreSQL`_ 12+ database server
 * A `redis`_ server
 * A `nodejs`_ installation
 
@@ -47,9 +48,6 @@ 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::
@@ -61,20 +59,14 @@ For PostgreSQL database creation, we would do::
     # sudo -u postgres createuser pretix
     # sudo -u postgres createdb -O pretix pretix
 
-When using MySQL, make sure you set the character set of the database to ``utf8mb4``, e.g. like this::
-
-    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
 --------------------
 
 To build and run pretix, you will need the following debian packages::
 
-    # apt-get install git build-essential python-dev python3-venv python3 python3-pip \
+    # apt-get install git build-essential python3-dev python3-venv python3 python3-pip \
                       python3-dev libxml2-dev libxslt1-dev libffi-dev zlib1g-dev libssl-dev \
-                      gettext libpq-dev libmariadb-dev libjpeg-dev libopenjp2-7-dev
+                      gettext libpq-dev libjpeg-dev libopenjp2-7-dev
 
 Config file
 -----------
@@ -97,16 +89,12 @@ Fill the configuration file ``/etc/pretix/pretix.cfg`` with the following conten
     trust_x_forwarded_proto=on
 
     [database]
-    ; For MySQL, replace with "mysql"
     backend=postgresql
     name=pretix
     user=pretix
-    ; For MySQL, enter the user password. For PostgreSQL on the same host,
-    ; we don't need one because we can use peer authentification if our
-    ; PostgreSQL user matches our unix user.
+    ; For PostgreSQL on the same host, we don't need a password because we can use
+    ; peer authentication if our PostgreSQL user matches our unix user.
     password=
-    ; For MySQL, use local socket, e.g. /var/run/mysqld/mysqld.sock
-    ; For a remote host, supply an IP address
     ; For local postgres authentication, you can leave it empty
     host=
 
@@ -132,6 +120,7 @@ Now we will install pretix itself. The following steps are to be executed as the
 actually install pretix, we will create a virtual environment to isolate the python packages from your global
 python installation::
 
+    # sudo -u pretix -s
     $ python3 -m venv /var/pretix/venv
     $ source /var/pretix/venv/bin/activate
     (venv)$ pip3 install -U pip setuptools wheel
@@ -140,15 +129,12 @@ We now install pretix, its direct dependencies and gunicorn::
 
     (venv)$ pip3 install pretix gunicorn
 
-If you're running MySQL, also install the client library::
+Note that you need Python 3.9 or newer. You can find out your Python version using ``python -V``.
 
-    (venv)$ pip3 install mysqlclient
-
-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::
+We also need to create a data directory and allow your webserver to traverse to the root directory::
 
     (venv)$ mkdir -p /var/pretix/data/media
+    (venv)$ chmod +x /var/pretix
 
 Finally, we compile static files and translation data and create the database structure::
 
@@ -225,6 +211,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;
@@ -261,14 +250,14 @@ The following snippet is an example on how to configure a nginx proxy for pretix
         }
 
         location /static/ {
-            alias /var/pretix/venv/lib/python3.10/site-packages/pretix/static.dist/;
+            alias /var/pretix/venv/lib/python3.11/site-packages/pretix/static.dist/;
             access_log off;
             expires 365d;
             add_header Cache-Control "public";
         }
     }
 
-.. note:: Remember to replace the ``python3.10`` in the ``/static/`` path in the config
+.. note:: Remember to replace the ``python3.11`` in the ``/static/`` path in the config
           above with your python version.
 
 We recommend reading about setting `strong encryption settings`_ for your web server.
@@ -291,6 +280,7 @@ Updates
 
 To upgrade to a new pretix release, pull the latest code changes and run the following commands::
 
+    # sudo -u pretix -s
     $ source /var/pretix/venv/bin/activate
     (venv)$ pip3 install -U --upgrade-strategy eager pretix gunicorn
     (venv)$ python -m pretix migrate
@@ -298,7 +288,8 @@ 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.
+Make sure to also read :ref:`update_notes` and the release notes of the version you are updating to. Pay special
+attention to the "Runtime and server environment" section of all release notes between your current and new version.
 
 .. _`manual_plugininstall`:
 
@@ -315,13 +306,33 @@ example::
     (venv)$ python -m pretix rebuild
     # systemctl restart pretix-web pretix-worker
 
+System updates
+--------------
 
-.. _Postfix: https://www.digitalocean.com/community/tutorials/how-to-install-and-configure-postfix-as-a-send-only-smtp-server-on-ubuntu-16-04
+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-22-04
 .. _nginx: https://botleg.com/stories/https-with-lets-encrypt-and-nginx/
 .. _Let's Encrypt: https://letsencrypt.org/
 .. _pretix.eu: https://pretix.eu/
-.. _MySQL: https://dev.mysql.com/doc/refman/5.7/en/linux-installation-apt-repo.html
-.. _PostgreSQL: https://www.digitalocean.com/community/tutorials/how-to-install-and-use-postgresql-on-ubuntu-20-04
+.. _PostgreSQL: https://www.digitalocean.com/community/tutorials/how-to-install-and-use-postgresql-on-ubuntu-22-04
 .. _redis: https://blog.programster.org/debian-8-install-redis-server/
 .. _ufw: https://en.wikipedia.org/wiki/Uncomplicated_Firewall
 .. _strong encryption settings: https://mozilla.github.io/server-side-tls/ssl-config-generator/

doc/admin/maintainance.rst

@@ -17,11 +17,11 @@ Backups
 There are essentially two things which you should create backups of:
 
 Database
-    Your SQL database (MySQL or PostgreSQL). This is critical and you should **absolutely
-    always create automatic backups of your database**. There are tons of tutorials on the
-    internet on how to do this, and the exact process depends on the choice of your database.
-    For MySQL, see ``mysqldump`` and for PostgreSQL, see the ``pg_dump`` tool. You probably
-    want to create a cronjob that does the backups for you on a regular schedule.
+    Your SQL database. This is critical and you should **absolutely always create automatic
+    backups of your database**. There are tons of tutorials on the internet on how to do this,
+    and the exact process depends on the choice of your database. For PostgreSQL, see the
+    ``pg_dump`` tool. You probably want to create a cronjob that does the backups for you on a
+    regular schedule.
 
 Data directory
     The data directory of your pretix configuration might contain some things that you should
@@ -103,6 +103,12 @@ pretix_celery_tasks_queued_count
 pretix_celery_tasks_queued_age_seconds
     The age of the longest-waiting in the worker queue in seconds, labeled with ``queue``.
 
+pretix_logins_successful
+    Counter. The number of successful backend logins.
+
+pretix_logins_failed
+    Counter. The number of failed backend logins, labeled with ``reason``.
+
 .. _metric types: https://prometheus.io/docs/concepts/metric_types/
 .. _Prometheus: https://prometheus.io/
 .. _cProfile: https://docs.python.org/3/library/profile.html

doc/admin/mysql2postgres.rst

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

doc/admin/scaling.rst

@@ -25,7 +25,7 @@ and what you should think of.
 Scaling reasons
 ---------------
 
-There's mainly two reasons to scale up a pretix installation beyond a single server:
+There are two main reasons for scaling up a pretix installation beyond a single server:
 
 * **Availability:** Distributing pretix over multiple servers can allow you to survive failure of one or more single machines, leading to a higher uptime and reliability of your system.
 
@@ -42,7 +42,7 @@ A pretix installation usually consists of the following components which run per
 
 * ``pretix-worker`` is a Celery-based application that processes tasks that should be run asynchronously outside of the web application process.
 
-* A **SQL database** keeps all the important data and processes the actual transactions. We recommend using PostgreSQL, but MySQL/MariaDB works as well.
+* A **PostgreSQL database** keeps all the important data and processes the actual transactions.
 
 * A **web server** that terminates TLS and HTTP connections and forwards them to ``pretix-web``. In some cases, e.g. when serving static files, the web servers might return a response directly. We recommend using ``nginx``.
 
@@ -74,7 +74,7 @@ We recommend reading up on tuning your web server for high concurrency. For ngin
 processes and the number of connections each worker process accepts. Double-check that TLS session caching works, because TLS
 handshakes can get really expensive.
 
-During a traffic peak, your web server will be able to make us of more CPU resources, while memory usage will stay comparatively low,
+During a traffic peak, your web server will be able to make use of more CPU resources, while memory usage will stay comparatively low,
 so if you invest in more hardware here, invest in more and faster CPU cores.
 
 Make sure that pretix' static files (such as CSS and JavaScript assets) as well as user-uploaded media files (event logos, etc)
@@ -92,7 +92,7 @@ them from a different URL <config-urls>`.
 pretix-web
 """"""""""
 
-The ``pretix-web`` process does not carry any internal state can be easily started on as many machines as you like, and you can
+The ``pretix-web`` process does not carry any internal state and can be easily started on as many machines as you like, and you can
 use the load balancing features of your frontend web server to redirect to all of them.
 
 You can adjust the number of processes in the ``gunicorn`` command line, and we recommend choosing roughly two times the number
@@ -154,7 +154,7 @@ files, otherwise you **will** run into errors with the user interface.
 The easiest solution for this is probably to store them on a NFS server that you mount
 on each of the other servers.
 
-Since we use Django's file storage mechanism internally, you can in theory also use a object-storage solution like Amazon S3, Ceph, or Minio to store these files, although we currently do not expose this through pretix' configuration file and this would require you to ship your own variant of ``pretix/settings.py`` and reference it through the ``DJANGO_SETTINGS_MODULE`` environment variable.
+Since we use Django's file storage mechanism internally, you can in theory also use an object-storage solution like Amazon S3, Ceph, or Minio to store these files, although we currently do not expose this through pretix' configuration file and this would require you to ship your own variant of ``pretix/settings.py`` and reference it through the ``DJANGO_SETTINGS_MODULE`` environment variable.
 
 At pretix.eu, we use a custom-built `object storage cluster`_.
 
@@ -171,12 +171,12 @@ you configure, so make sure to set this memory usage as high as you can afford.
 memory available allows your database to make more use of caching, which is usually good.
 
 Scaling your database to multiple machines needs to be treated with great caution. It's a
-good to have a replica of your database for availability reasons. In case your primary
+good idea to have a replica of your database for availability reasons. In case your primary
 database server fails, you can easily switch over to the replica and continue working.
 
-However, using database replicas for performance gains is much more complicated. When using
+However, using database replicas for performance gain is much more complicated. When using
 replicated database systems, you are always trading in consistency or availability to get
-additional performance and the consequences of this can be subtle and it is important
+additional performance and the consequences of this can be subtle. It is important
 that you have a deep understanding of the semantics of your replication mechanism.
 
 .. warning::
@@ -187,7 +187,7 @@ that you have a deep understanding of the semantics of your replication mechanis
    As an example, if you buy a ticket, pretix first needs to calculate how many tickets
    are left to sell. If this calculation is done on a database replica that lags behind
    even for fractions of a second, the decision to allow selling the ticket will be made
-   on out-of-data data and you can end up with more tickets sold than configured. Similarly,
+   on stale data and you can end up with more tickets sold than configured. Similarly,
    you could imagine situations leading to double payments etc.
 
 If you do have a replica, you *can* tell pretix about it :ref:`in your configuration <config-replica>`.
@@ -204,9 +204,9 @@ redis
 While redis is a very important part that glues together some of the components, it isn't used
 heavily and can usually handle a fairly large pretix installation easily on a single modern
 CPU core.
-Having some memory available is good in case of e.g. lots of tasks queuing up during a traffic peak, but we wouldn't expect ever needing more than a gigabyte of it.
+Having some memory available is good, e.g. if lots of tasks queue up during a traffic peak, but we wouldn't expect ever needing more than a gigabyte of it.
 
-Feel free to set up a redis cluster for availability – but you won't need it for performance in a long time.
+Feel free to set up a redis cluster for availability – but you probably won't need it for performance.
 
 The limitations
 ---------------
@@ -228,9 +228,9 @@ if you add more hardware.
 If you have an unlimited number of tickets, we can apply fewer locking and we've reached **approx.
 1500 orders per minute per event** in benchmarks, although even more should be possible.
 
-We're working to reduce the number of cases in which this is relevant and thereby improve the possible
+We're working on reducing the number of cases in which this is relevant and thereby improve the possible
 throughput. If you want to use pretix for an event with 10,000+ tickets that are likely to be sold out
 within minutes, please get in touch to discuss possible solutions. We'll work something out for you!
 
 
-.. _object storage cluster: https://behind.pretix.eu/2018/03/20/high-available-cdn/
+.. _object storage cluster: https://behind.pretix.eu/2018/03/20/high-available-cdn/

doc/admin/updates.rst

@@ -47,5 +47,30 @@ Or, with a docker installation::
 
     $ docker exec -it pretix.service pretix create_order_transactions
 
+Upgrade to 2023.6.0 or newer
+""""""""""""""""""""""""""""
+
+MariaDB and MySQL are no longer supported.
+
+Upgrade to 2023.8.0 or newer
+""""""""""""""""""""""""""""
+
+PostgreSQL 11 is now required.
+
+Upgrade to 2023.9.0 or newer
+""""""""""""""""""""""""""""
+
+This release includes a migration that changes the `id` column of all core database tables from `integer`
+to `bigint`. If you have a large database, the migration step of the upgrade might take significantly longer than
+usual, so plan the update accordingly.
+
+The default value for the `registration` setting in `pretix.cfg` has changed to `false`.
+
+Upgrade to 2023.10.0 or newer
+"""""""""""""""""""""""""""""
+
+This release includes a migration that changes retroactively fills an `organizer` column in the table
+`pretixbase_logentry`. If you have a large database, the migration step of the upgrade might take significantly
+longer than usual, so plan the update accordingly.
 
 .. _blog: https://pretix.eu/about/en/blog/

doc/api/deviceauth.rst

@@ -32,10 +32,16 @@ as well as the type of underlying hardware. Example:
        "token": "kpp4jn8g2ynzonp6",
        "hardware_brand": "Samsung",
        "hardware_model": "Galaxy S",
+       "os_name": "Android",
+       "os_version": "2.3.6",
        "software_brand": "pretixdroid",
-       "software_version": "4.0.0"
+       "software_version": "4.0.0",
+       "rsa_pubkey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqh…nswIDAQAB\n-----END PUBLIC KEY-----\n"
    }
 
+The ``rsa_pubkey`` is optional any only required for certain fatures such as working with reusable
+media and NFC cryptography.
+
 Every initialization token can only be used once. On success, you will receive a response containing
 information on your device as well as your API token:
 
@@ -98,6 +104,8 @@ following endpoint:
    {
        "hardware_brand": "Samsung",
        "hardware_model": "Galaxy S",
+       "os_name": "Android",
+       "os_version": "2.3.6",
        "software_brand": "pretixdroid",
        "software_version": "4.1.0",
        "info": {"arbitrary": "data"}
@@ -105,6 +113,57 @@ following endpoint:
 
 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"
+       }
+     },
+     "server": {
+       "version": {
+         "pretix": "3.6.0.dev0",
+         "pretix_numeric": 30060001000
+       }
+     },
+     "medium_key_sets": [
+       {
+         "public_id": 3456349,
+         "organizer": "foo",
+         "active": true,
+         "media_type": "nfc_mf0aes",
+         "uid_key": "base64-encoded-encrypted-key",
+         "diversification_key": "base64-encoded-encrypted-key",
+       }
+     ]
+   }
+
+``"medium_key_sets`` will always be empty if you did not set an ``rsa_pubkey``.
+The individual keys in the key sets are encrypted with the device's ``rsa_pubkey``
+using ``RSA/ECB/PKCS1Padding``.
+
 Creating a new API key
 ----------------------
 
@@ -190,8 +249,10 @@ You can get three response codes:
    Content-Type: application/json
 
    {
-      "event": "democon",
+      "event": {
+        "name": "Demo Conference",
+        "slug": "democon"
+      },
       "subevent": 23,
       "checkinlist": 5
    }
-

doc/api/fundamentals.rst

@@ -48,10 +48,11 @@ Possible permissions are:
 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:
@@ -60,6 +61,7 @@ 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*:
@@ -190,6 +192,9 @@ Relative date         *either* String in ISO 8601  ``"2017-12-27"``,
 File                  URL in responses, ``file:``  ``"https://…"``, ``"file:…"``
                       specifiers in requests
                       (see below).
+Date range            *either* two dates separated ``2022-03-18/2022-03-23``, ``2022-03-18/``,
+                      by ``/`` *or* the name of a  ``/2022-03-23``, ``week_this``, ``week_next``,
+                      defined range.               ``month_this``
 ===================== ============================ ===================================
 
 Query parameters

doc/api/guides/custom_checkout.rst

@@ -94,7 +94,9 @@ If you want the user to return to your application after the payment is complete
 "Plugins". Enable the plugin "Redirection from order page". Then, go to the new page "Settings", then "Redirection".
 Enter the base URL of your web application. This will allow you to redirect to pages under this base URL later on.
 For example, if you want users to be redirected to ``https://example.org/order/return?tx_id=1234``, you could now
-either enter ``https://example.org`` or ``https://example.org/order/``.
+either enter ``https://example.org/order/`` or ``https://example.org/``.
+Please note that in the latter case the trailing slash is required, ``https://example.org`` is not allowed to prevent.
+Only base URLs with a secure (``https://``) or local (``http://localhost``) origin are permitted.
 
 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**. We will append an ``error=…`` query parameter with an error

doc/api/oauth.rst

@@ -107,9 +107,9 @@ You can supply a valid access token as a ``Bearer``-type token in the ``Authoriz
 .. sourcecode:: http
    :emphasize-lines: 3
 
-       GET /api/v1/organizers/ HTTP/1.1
-       Host: pretix.eu
-       Authorization: Bearer i3ytqTSRWsKp16fqjekHXa4tdM4qNC
+   GET /api/v1/organizers/ HTTP/1.1
+   Host: pretix.eu
+   Authorization: Bearer i3ytqTSRWsKp16fqjekHXa4tdM4qNC
 
 Refreshing an access token
 --------------------------

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,362 @@
+.. spelling:word-list:: 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.
+
+.. versionchanged:: 4.18
+
+    The ``source_type`` parameter has 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.
+
+   :query string expand: Expand a field inside the ``position`` object into a full object. Currently ``subevent``, ``item``, ``variation``, and ``answers.question`` are supported. Can be passed multiple times.
+   :<json string secret: Scanned QR code corresponding to the ``secret`` attribute of a ticket.
+   :<json string source_type: Type of source the ``secret`` was obtained form. Defaults to ``"barcode"``.
+   :<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 list checkin_texts: List of additional texts to show to the user.
+   :>json object list: Excerpt of information about the matching :ref:`check-in list <rest-checkinlists>` (if any was found),
+                       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",
+        "source_type": "barcode",
+        "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,
+        "checkin_texts": [],
+        "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,
+        "checkin_texts": [],
+        "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,
+            "show_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,
+        "checkin_texts": []
+      }
+
+   **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,
+        "checkin_texts": [],
+        "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.
+   * ``blocked`` - Ticket has been blocked.
+   * ``invalid_time`` - Ticket is not valid at this time.
+   * ``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.
+   * ``unapproved`` - Order has not yet been approved.
+   * ``error`` - Internal error.
+
+   In case of reason ``rules`` and ``invalid_time``, 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,4 +1,6 @@
-.. spelling:: checkin
+.. spelling:word-list:: checkin
+
+.. _rest-checkinlists:
 
 Check-in lists
 ==============
@@ -34,24 +36,18 @@ 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.
+ignore_in_statistics                  boolean                    If ``true``, check-ins on this list will be ignored in most reporting features.
+consider_tickets_used                 boolean                    If ``true`` (default), tickets checked in on this list will be considered "used" by other functionality, i.e. when checking if they can still be canceled.
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 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.
+    The ``addon_match`` attribute has been added.
 
-.. versionchanged:: 3.11
+.. versionchanged:: 2023.9
 
-    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 ``ignore_in_statistics`` and ``consider_tickets_used`` attributes have been added.
 
 Endpoints
 ---------
@@ -94,6 +90,7 @@ Endpoints
             "allow_entry_after_exit": true,
             "exit_all_at": null,
             "rules": {},
+            "addon_match": false,
             "auto_checkin_sales_channels": [
               "pretixpos"
             ]
@@ -107,6 +104,8 @@ Endpoints
    :query string ends_after: Exclude all check-in lists attached to a sub-event that is already in the past at the given time.
    :query string expand: Expand a field into a full object. Currently only ``subevent`` is supported. Can be passed multiple times.
    :query string exclude: Exclude a field from the output, e.g. ``checkin_count``. Can be used as a performance optimization. Can be passed multiple times.
+   :query string ordering: Manually set the ordering of results. Valid fields to be used are ``id``, ``name``, and ``subevent__date_from``,
+                           Default: ``subevent__date_from,name``
    :param organizer: The ``slug`` field of the organizer to fetch
    :param event: The ``slug`` field of the event to fetch
    :statuscode 200: no error
@@ -146,6 +145,7 @@ Endpoints
         "allow_entry_after_exit": true,
         "exit_all_at": null,
         "rules": {},
+        "addon_match": false,
         "auto_checkin_sales_channels": [
           "pretixpos"
         ]
@@ -245,6 +245,7 @@ Endpoints
         "subevent": null,
         "allow_multiple_entries": false,
         "allow_entry_after_exit": true,
+        "addon_match": false,
         "auto_checkin_sales_channels": [
           "pretixpos"
         ]
@@ -269,6 +270,7 @@ Endpoints
         "subevent": null,
         "allow_multiple_entries": false,
         "allow_entry_after_exit": true,
+        "addon_match": false,
         "auto_checkin_sales_channels": [
           "pretixpos"
         ]
@@ -323,6 +325,7 @@ Endpoints
         "subevent": null,
         "allow_multiple_entries": false,
         "allow_entry_after_exit": true,
+        "addon_match": false,
         "auto_checkin_sales_channels": [
           "pretixpos"
         ]
@@ -367,7 +370,7 @@ Endpoints
    Stores a failed check-in. Only necessary for statistical purposes if you perform scan validation offline.
 
    :<json boolean error_reason: One of ``canceled``, ``invalid``, ``unpaid``, ``product``, ``rules``, ``revoked``,
-                                ``incomplete``, ``already_redeemed``, or ``error``. Required.
+                                ``incomplete``, ``already_redeemed``, ``blocked``, ``invalid_time``, or ``error``. Required.
    :<json raw_barcode: The raw barcode you scanned. Required.
    :<json datetime: Date and time of the scan. Optional.
    :<json type: Type of scan, defaults to ``"entry"``.
@@ -415,6 +418,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
@@ -492,7 +498,7 @@ Order position endpoints
                            ``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 string expand: Expand a field into a full object. Currently ``subevent``, ``item``, ``variation``, and ``answers.question`` 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.
@@ -604,21 +610,30 @@ 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
                                        to ``true``.
    :<json boolean canceled_supported: When this parameter is set to ``true``, the response code ``canceled`` may be
-                                      returned. Otherwise, canceled orders will return ``unpaid``.
+                                      returned. Otherwise, canceled orders will return ``unpaid``. (**Deprecated**, in
+                                      the future, this will be ignored and ``canceled`` may always be returned.)
    :<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,
@@ -692,6 +707,7 @@ Order position endpoints
             "position": 1,
             "identifier": "WY3TP9SL",
             "ask_during_checkin": true,
+            "show_during_checkin": true,
             "options": [
               {
                 "id": 1,
@@ -733,15 +749,21 @@ 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.
+   * ``blocked`` - Ticket has been blocked.
+   * ``invalid_time`` - Ticket is not valid at this time.
+   * ``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.
+   * ``unapproved`` - Order has not yet been approved.
 
-   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``.
+   In case of reason ``rules`` or ``invalid_time``, 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
    :param event: The ``slug`` field of the event to fetch
@@ -752,3 +774,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,7 +14,12 @@ 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
+phone                                 string                     Customer phone number
 name                                  string                     Name of this customer (or ``null``)
 name_parts                            object of strings          Decomposition of name (i.e. given name, family name)
 is_active                             boolean                    Whether this account is active
@@ -24,10 +29,21 @@ 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.
+
+.. versionchanged:: 2024.3
+
+   The attribute ``phone`` has been added.
+
 Endpoints
 ---------
 
@@ -58,7 +74,9 @@ Endpoints
         "results": [
           {
             "identifier": "8WSAJCJ",
+            "external_identifier": null,
             "email": "customer@example.org",
+            "phone": "+493012345678",
             "name": "John Doe",
             "name_parts": {
                 "_scheme": "full",
@@ -69,7 +87,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,7 +122,9 @@ Endpoints
 
       {
         "identifier": "8WSAJCJ",
+        "external_identifier": null,
         "email": "customer@example.org",
+        "phone": "+493012345678",
         "name": "John Doe",
         "name_parts": {
             "_scheme": "full",
@@ -114,7 +135,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 +147,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 +161,10 @@ Endpoints
       Content-Type: application/json
 
       {
-        "email": "test@example.org"
+        "email": "test@example.org",
+        "phone": "+493012345678",
+        "password": "verysecret",
+        "send_email": true
       }
 
    **Example response**:
@@ -150,7 +177,9 @@ Endpoints
 
       {
         "identifier": "8WSAJCJ",
+        "external_identifier": null,
         "email": "test@example.org",
+        "phone": "+493012345678",
         ...
       }
 
@@ -166,8 +195,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,7 +222,9 @@ Endpoints
 
       {
         "identifier": "8WSAJCJ",
+        "external_identifier": null,
         "email": "test@example.org",
+        "phone": "+493012345678",
         …
       }
 
@@ -226,7 +257,9 @@ Endpoints
 
       {
         "identifier": "8WSAJCJ",
+        "external_identifier": null,
         "email": null,
+        "phone": null,
         …
       }
 

doc/api/resources/devices.rst

@@ -1,4 +1,4 @@
-.. spelling:: fullname
+.. spelling:word-list:: fullname
 
 .. _`rest-devices`:
 
@@ -24,6 +24,8 @@ all_events                            boolean                    Whether this de
 limit_events                          list                       List of event slugs this device has access to
 hardware_brand                        string                     Device hardware manufacturer (read-only)
 hardware_model                        string                     Device hardware model (read-only)
+os_name                               string                     Device operating system name (read-only)
+os_version                            string                     Device operating system version (read-only)
 software_brand                        string                     Device software product (read-only)
 software_version                      string                     Device software version (read-only)
 created                               datetime                   Creation time
@@ -76,6 +78,8 @@ Device endpoints
             "security_profile": "full",
             "hardware_brand": "Zebra",
             "hardware_model": "TC25",
+            "os_name": "Android",
+            "os_version": "8.1.0",
             "software_brand": "pretixSCAN",
             "software_version": "1.5.1"
           }
@@ -123,6 +127,8 @@ Device endpoints
         "security_profile": "full",
         "hardware_brand": "Zebra",
         "hardware_model": "TC25",
+        "os_name": "Android",
+        "os_version": "8.1.0",
         "software_brand": "pretixSCAN",
         "software_version": "1.5.1"
       }
@@ -173,6 +179,8 @@ Device endpoints
         "initialized": null
         "hardware_brand": null,
         "hardware_model": null,
+        "os_name": null,
+        "os_version": null,
         "software_brand": null,
         "software_version": null
       }

doc/api/resources/discounts.rst

@@ -0,0 +1,337 @@
+.. _`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 condition applies to all items.
+condition_limit_products                 list of integers           If ``condition_all_products`` is not set, this is a list
+                                                                    of internal item IDs that the discount condition applies to.
+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``.
+benefit_same_products                    boolean                    If ``true``, the discount benefit applies to the same set of items
+                                                                    as the condition (see above).
+benefit_limit_products                   list of integers           If ``benefit_same_products`` is not set, this is a list
+                                                                    of internal item IDs that the discount benefit applies to.
+benefit_apply_to_addons                  boolean                    (Only used if ``benefit_same_products`` is ``false``.)
+                                                                    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.
+benefit_ignore_voucher_discounted        boolean                    (Only used if ``benefit_same_products`` is ``false``.)
+                                                                    If ``true``, the discount does not apply to products which have
+                                                                    been discounted by a voucher.
+======================================== ========================== =======================================================
+
+
+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_same_products": true,
+            "benefit_limit_products": [],
+            "benefit_apply_to_addons": true,
+            "benefit_ignore_voucher_discounted": false,
+            "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_same_products": true,
+        "benefit_limit_products": [],
+        "benefit_apply_to_addons": true,
+        "benefit_ignore_voucher_discounted": false,
+        "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_same_products": true,
+        "benefit_limit_products": [],
+        "benefit_apply_to_addons": true,
+        "benefit_ignore_voucher_discounted": false,
+        "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_same_products": true,
+        "benefit_limit_products": [],
+        "benefit_apply_to_addons": true,
+        "benefit_ignore_voucher_discounted": false,
+        "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_same_products": true,
+        "benefit_limit_products": [],
+        "benefit_apply_to_addons": true,
+        "benefit_ignore_voucher_discounted": false,
+        "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

@@ -1,4 +1,4 @@
-.. spelling::
+.. spelling:word-list::
 
    geo
    lat
@@ -36,6 +36,8 @@ geo_lon                               float                      Longitude of th
 has_subevents                         boolean                    ``true`` if the event series feature is active for this
                                                                  event. Cannot change after event is created.
 meta_data                             object                     Values set for organizer-specific meta data parameters.
+                                                                 The allowed keys need to be set up as meta properties
+                                                                 in the organizer configuration.
 plugins                               list                       A list of package names of the enabled plugins for this
                                                                  event.
 seating_plan                          integer                    If reserved seating is in use, the ID of a seating
@@ -49,37 +51,13 @@ valid_keys                            object                     Cryptographic k
                                                                  only contained in detail views. Value can be cached.
 sales_channels                        list                       A list of sales channels this event is available for
                                                                  sale on.
+public_url                            string                     The public, customer-facing URL of the event (read-only).
 ===================================== ========================== =======================================================
 
 
-.. 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.
@@ -90,6 +68,15 @@ Endpoints
 
     The ``search`` query parameter has been added to filter events by their slug, name, or location in any language.
 
+.. versionchanged:: 4.17
+
+    The ``public_url`` field has been added.
+
+.. versionchanged:: 5.0
+
+    The ``date_from_before``, ``date_from_after``, ``date_to_before``, and ``date_to_after`` query parameters have been
+    added.
+
 .. http:get:: /api/v1/organizers/(organizer)/events/
 
    Returns a list of all events within a given organizer the authenticated user/token has access to.
@@ -148,7 +135,8 @@ Endpoints
               "web",
               "pretixpos",
               "resellers"
-            ]
+            ],
+            "public_url": "https://pretix.eu/bigevents/sampleconf/"
           }
         ]
       }
@@ -156,9 +144,14 @@ Endpoints
    :query page: The page number in case of a multi-page result set, default is 1
    :query is_public: If set to ``true``/``false``, only events with a matching value of ``is_public`` are returned.
    :query live: If set to ``true``/``false``, only events with a matching value of ``live`` are returned.
+   :query testmode: If set to ``true``/``false``, only events with a matching value of ``testmode`` are returned.
    :query has_subevents: If set to ``true``/``false``, only events with a matching value of ``has_subevents`` are returned.
    :query is_future: If set to ``true`` (``false``), only events that happen currently or in the future are (not) returned. Event series are never (always) returned.
    :query is_past: If set to ``true`` (``false``), only events that are over are (not) returned. Event series are never (always) returned.
+   :query date_from_after: If set to a date and time, only events that start at or after the given time are returned.
+   :query date_from_before: If set to a date and time, only events that start at or before the given time are returned.
+   :query date_to_after: If set to a date and time, only events that have an end date and end at or after the given time are returned.
+   :query date_to_before: If set to a date and time, only events that have an end date and end at or before the given time are returned.
    :query ends_after: If set to a date and time, only events that happen during of after the given time are returned. Event series are never returned.
    :query string ordering: Manually set the ordering of results. Valid fields to be used are ``date_from`` and
                            ``slug``. Keep in mind that ``date_from`` of event series does not really tell you anything.
@@ -236,7 +229,8 @@ Endpoints
           "web",
           "pretixpos",
           "resellers"
-        ]
+        ],
+        "public_url": "https://pretix.eu/bigevents/sampleconf/"
       }
 
    :param organizer: The ``slug`` field of the organizer to fetch
@@ -332,7 +326,8 @@ Endpoints
           "web",
           "pretixpos",
           "resellers"
-        ]
+        ],
+        "public_url": "https://pretix.eu/bigevents/sampleconf/"
       }
 
    :param organizer: The ``slug`` field of the organizer of the event to create.
@@ -350,8 +345,8 @@ Endpoints
    Creates a new event with properties as set in the request body. The properties that are copied are: ``is_public``,
    ``testmode``, ``has_subevents``, settings, plugin settings, items, variations, add-ons, quotas, categories, tax rules, questions.
 
-   If the ``plugins``, ``has_subevents`` and/or ``is_public`` fields are present in the post body this will determine their
-   value. Otherwise their value will be copied from the existing event.
+   If the ``plugins``, ``has_subevents``, ``meta_data`` and/or ``is_public`` fields are present in the post body this will
+   determine their  value. Otherwise their value will be copied from the existing event.
 
    Please note that you can only copy from events under the same organizer this way. Use the ``clone_from`` parameter
    when creating a new event for this instead.
@@ -436,7 +431,8 @@ Endpoints
           "web",
           "pretixpos",
           "resellers"
-        ]
+        ],
+        "public_url": "https://pretix.eu/bigevents/sampleconf/"
       }
 
    :param organizer: The ``slug`` field of the organizer of the event to create.
@@ -510,7 +506,8 @@ Endpoints
           "web",
           "pretixpos",
           "resellers"
-        ]
+        ],
+        "public_url": "https://pretix.eu/bigevents/sampleconf/"
       }
 
    :param organizer: The ``slug`` field of the organizer of the event to update
@@ -561,15 +558,16 @@ Therefore, we're also not including a list of the options here, but instead reco
 to see available options. The ``explain=true`` flag enables a verbose mode that provides you with human-readable
 information about the properties.
 
+Note that some settings are read-only, e.g. because they can be read on event level but currently only be changed on
+organizer level.
+
 .. note:: Please note that this is not a complete representation of all event settings. You will find more settings
           in the web interface.
 
 .. 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.
+.. note:: When authenticating with :ref:`rest-deviceauth`, only a limited subset of settings is available.
 
 .. http:get:: /api/v1/organizers/(organizer)/events/(event)/settings/
 
@@ -611,6 +609,7 @@ information about the properties.
           {
             "value": "https://pretix.eu",
             "label": "Imprint URL",
+            "readonly": false,
             "help_text": "This should point e.g. to a part of your website that has your contact details and legal information."
           }
         },
@@ -624,6 +623,10 @@ information about the properties.
    :statuscode 401: Authentication failure
    :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
 
+   .. versionchanged:: 4.18
+
+       The ``readonly`` flag has been added.
+
 .. http:patch:: /api/v1/organizers/(organizer)/events/(event)/settings/
 
    Updates event settings. Note that ``PUT`` is not allowed here, only ``PATCH``.

doc/api/resources/exporters.rst

@@ -1,4 +1,6 @@
-.. spelling:: checkin
+.. spelling:word-list:: checkin
+
+.. _rest-exporters:
 
 Data exporters
 ==============
@@ -6,10 +8,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
@@ -115,7 +113,7 @@ Listing available exporters
             "input_parameters": [
               {
                 "name": "events",
-                "required": true
+                "required": false
               },
               {
                 "name": "_format",
@@ -182,7 +180,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

@@ -20,6 +20,12 @@ currency                              string                     Currency of the
 testmode                              boolean                    Whether this is a test gift card
 expires                               datetime                   Expiry date (or ``null``)
 conditions                            string                     Special terms and conditions for this card (or ``null``)
+owner_ticket                          integer                    Internal ID of an order position that is the "owner" of
+                                                                 this gift card and can view all transactions. When setting
+                                                                 this field, you can also give the ``secret`` of an order
+                                                                 position.
+issuer                                string                     Organizer slug of the organizer who created this gift
+                                                                 card and is responsible for it.
 ===================================== ========================== =======================================================
 
 The gift card transaction resource contains the following public fields:
@@ -35,15 +41,20 @@ value                                 money (string)             Transaction amo
 event                                 string                     Event slug, if the gift card was used in the web shop (or ``null``)
 order                                 string                     Order code, if the gift card was used in the web shop (or ``null``)
 text                                  string                     Custom text of the transaction (or ``null``)
+info                                  object                     Additional data about the transaction (or ``null``)
+acceptor                              string                     Organizer slug of the organizer who created this transaction
+                                                                 (can be ``null`` for all transactions performed before
+                                                                 this field was added.)
 ===================================== ========================== =======================================================
 
+.. versionchanged:: 4.20
+
+    The ``owner_ticket`` and ``issuer`` attributes of the gift card and the ``info`` and ``acceptor`` attributes of the
+    gift card transaction resource have been added.
+
 Endpoints
 ---------
 
-.. 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.
@@ -76,6 +87,8 @@ Endpoints
             "testmode": false,
             "expires": null,
             "conditions": null,
+            "owner_ticket": null,
+            "issuer": "bigevents",
             "value": "13.37"
           }
         ]
@@ -85,6 +98,10 @@ Endpoints
    :query string secret: Only show gift cards with the given secret.
    :query boolean testmode: Filter for gift cards that are (not) in test mode.
    :query boolean include_accepted: Also show gift cards issued by other organizers that are accepted by this organizer.
+   :query string expand: If you pass ``"owner_ticket"``, the respective field will be shown as a nested value instead of just an ID.
+                         The nested objects are identical to the respective resources, except that the ``owner_ticket``
+                         will have an attribute of the format ``"order": {"code": "ABCDE", "event": "eventslug"}`` to make
+                         matching easier. The parameter can be given multiple times.
    :param organizer: The ``slug`` field of the organizer to fetch
    :statuscode 200: no error
    :statuscode 401: Authentication failure
@@ -117,6 +134,8 @@ Endpoints
         "testmode": false,
         "expires": null,
         "conditions": null,
+        "owner_ticket": null,
+        "issuer": "bigevents",
         "value": "13.37"
       }
 
@@ -161,10 +180,16 @@ Endpoints
         "currency": "EUR",
         "expires": null,
         "conditions": null,
+        "owner_ticket": null,
+        "issuer": "bigevents",
         "value": "13.37"
       }
 
    :param organizer: The ``slug`` field of the organizer to create a gift card for
+   :query string expand: If you pass ``"owner_ticket"``, the respective field will be shown as a nested value instead of just an ID.
+                         The nested objects are identical to the respective resources, except that the ``owner_ticket``
+                         will have an attribute of the format ``"order": {"code": "ABCDE", "event": "eventslug"}`` to make
+                         matching easier. The parameter can be given multiple times.
    :statuscode 201: no error
    :statuscode 400: The gift card could not be created due to invalid submitted data.
    :statuscode 401: Authentication failure
@@ -209,6 +234,8 @@ Endpoints
         "currency": "EUR",
         "expires": null,
         "conditions": null,
+        "owner_ticket": null,
+        "issuer": "bigevents",
         "value": "14.00"
       }
 
@@ -254,13 +281,11 @@ Endpoints
         "testmode": false,
         "expires": null,
         "conditions": null,
+        "owner_ticket": null,
+        "issuer": "bigevents",
         "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.
@@ -301,7 +326,11 @@ Endpoints
             "value": "50.00",
             "event": "democon",
             "order": "FXQYW",
-            "text": null
+            "text": null,
+            "acceptor": "bigevents",
+            "info": {
+              "created_by": "plugin1"
+            }
           }
         ]
       }

doc/api/resources/index.rst

@@ -18,24 +18,30 @@ at :ref:`plugin-docs`.
    item_variations
    item_bundles
    item_add-ons
+   item_meta_properties
    questions
    question_options
    quotas
    orders
    invoices
    vouchers
+   discounts
+   checkin
    checkinlists
    waitinglist
    customers
    membershiptypes
    memberships
    giftcards
+   reusablemedia
    carts
    teams
    devices
    webhooks
    seatingplans
    exporters
+   scheduled_exports
+   shredders
    sendmail_rules
    billing_invoices
    billing_var

doc/api/resources/invoices.rst

@@ -12,6 +12,7 @@ The invoice resource contains the following public fields:
 Field                                 Type                       Description
 ===================================== ========================== =======================================================
 number                                string                     Invoice number (with prefix)
+event                                 string                     The slug of the parent event
 order                                 string                     Order code of the order this invoice belongs to
 is_cancellation                       boolean                    ``true``, if this invoice is the cancellation of a
                                                                  different invoice.
@@ -42,6 +43,7 @@ introductory_text                     string                     Text to be prin
 additional_text                       string                     Text to be printed below the product list
 payment_provider_text                 string                     Text to be printed below the product list with
                                                                  payment information
+payment_provider_stamp                string                     Short text to be visibly printed to indicate payment status
 footer_text                           string                     Text to be printed in the page footer area
 lines                                 list of objects            The actual invoice contents
 ├ position                            integer                    Number of the line within an invoice.
@@ -108,16 +110,6 @@ 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.
@@ -130,9 +122,13 @@ internal_reference                    string                     Customer's refe
 
    The attribute ``lines.subevent`` has been added.
 
+.. versionchanged:: 2023.8
 
-Endpoints
----------
+   The ``event`` attribute has been added. The organizer-level endpoint has been added.
+
+
+List of all invoices
+--------------------
 
 .. http:get:: /api/v1/organizers/(organizer)/events/(event)/invoices/
 
@@ -161,6 +157,7 @@ Endpoints
         "results": [
           {
             "number": "SAMPLECONF-00001",
+            "event": "sampleconf",
             "order": "ABC12",
             "is_cancellation": false,
             "invoice_from_name": "Big Events LLC",
@@ -188,6 +185,7 @@ Endpoints
             "internal_reference": "",
             "additional_text": "We are looking forward to see you on our conference!",
             "payment_provider_text": "Please transfer the money to our account ABC…",
+            "payment_provider_stamp": null,
             "footer_text": "Big Events LLC - Registration No. 123456 - VAT ID: EU0987654321",
             "lines": [
               {
@@ -229,6 +227,50 @@ Endpoints
    :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)/invoices/
+
+   Returns a list of all invoices within all events of a given organizer (with sufficient access permissions).
+
+   Supported query parameters and output format of this endpoint are identical to the list endpoint within an event.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/invoices/ 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": [
+          {
+            "number": "SAMPLECONF-00001",
+            "event": "sampleconf",
+            "order": "ABC12",
+            ...
+        ]
+      }
+
+   :param organizer: The ``slug`` field of the organizer 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.
+
+
+Fetching individual invoices
+----------------------------
+
 .. http:get:: /api/v1/organizers/(organizer)/events/(event)/invoices/(number)/
 
    Returns information on one invoice, identified by its invoice number.
@@ -251,6 +293,7 @@ Endpoints
 
       {
         "number": "SAMPLECONF-00001",
+        "event": "sampleconf",
         "order": "ABC12",
         "is_cancellation": false,
         "invoice_from_name": "Big Events LLC",
@@ -278,6 +321,7 @@ Endpoints
         "internal_reference": "",
         "additional_text": "We are looking forward to see you on our conference!",
         "payment_provider_text": "Please transfer the money to our account ABC…",
+        "payment_provider_stamp": null,
         "footer_text": "Big Events LLC - Registration No. 123456 - VAT ID: EU0987654321",
         "lines": [
           {
@@ -344,6 +388,12 @@ Endpoints
    :statuscode 409: The file is not yet ready and will now be prepared. Retry the request after waiting for a few
                     seconds.
 
+
+Modifying invoices
+------------------
+
+Invoices cannot be edited directly, but the following actions can be triggered:
+
 .. http:post:: /api/v1/organizers/(organizer)/events/(event)/invoices/(invoice_no)/reissue/
 
    Cancels the invoice and creates a new one.

doc/api/resources/item_meta_properties.rst

@@ -0,0 +1,211 @@
+Item Meta Properties
+====================
+
+Resource description
+--------------------
+
+An Item Meta Property is used to include (event internally relevant) meta information with every item (product). This
+could be internal categories like booking positions.
+
+The Item Meta Properties resource contains the following public fields:
+
+.. rst-class:: rest-resource-table
+
+===================================== ========================== =======================================================
+Field                                 Type                       Description
+===================================== ========================== =======================================================
+id                                    integer                    Unique ID for this property
+name                                  string                     Name of the property
+default                               string                     Value of the default option
+required                              boolean                    If ``true``, this property will have to be assigned a
+                                                                 value in all items of the related event
+allowed_values                        list                       List of all permitted values for this property,
+                                                                 or ``null`` for no limitation
+===================================== ========================== =======================================================
+
+Endpoints
+---------
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/item_meta_properties/
+
+   Returns a list of all Item Meta Properties within a given event.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/item_meta_properties/ 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": "Color",
+            "default": "red",
+            "required": true,
+            "allowed_values": ["red", "green", "blue"]
+          }
+        ]
+      }
+
+   :param organizer: The ``slug`` field of the organizer
+   :param event: The ``slug`` field of the event
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to view this resource.
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/item_meta_properties/(id)/
+
+   Returns information on one property, identified by its id.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/item_meta_properties/1/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      {
+        "id": 1,
+        "name": "Color",
+        "default": "red",
+        "required": true,
+        "allowed_values": ["red", "green", "blue"]
+      }
+
+   :param organizer: The ``slug`` field of the organizer
+   :param event: The ``slug`` field of the event
+   :param id: The ``id`` field of the item meta property to retrieve
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to view this resource.
+
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/item_meta_properties/
+
+   Creates a new item meta property
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/item_meta_properties/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+
+      {
+        "name": "ref-code",
+        "default": "abcde",
+        "required": true,
+        "allowed_values": null
+      }
+
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+    {
+        "id": 2,
+        "name": "ref-code",
+        "default": "abcde",
+        "required": true,
+        "allowed_values": null
+    }
+
+   :param organizer: The ``slug`` field of the organizer
+   :param event: The ``slug`` field of the event
+   :statuscode 201: no error
+   :statuscode 400: The item meta property could not be created due to invalid submitted data.
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to create this resource.
+
+.. http:patch:: /api/v1/organizers/(organizer)/events/(event)/item_meta_properties/(id)/
+
+   Update an item meta property. 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/item_meta_properties/2/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+      Content-Length: 94
+
+      {
+        "required": false
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "id": 2,
+        "name": "ref-code",
+        "default": "abcde",
+        "required": false,
+        "allowed_values": []
+      }
+
+   :param organizer: The ``slug`` field of the organizer
+   :param event: The ``slug`` field of the event
+   :param id: The ``id`` field of the item meta property to modify
+   :statuscode 200: no error
+   :statuscode 400: The property could not be modified due to invalid submitted data
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to change this resource.
+
+.. http:delete:: /api/v1/organizers/(organizer)/events/(event)/item_meta_properties/(id)/
+
+   Delete an item meta property.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      DELETE /api/v1/organizers/bigevents/events/sampleconf/item_meta_properties/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
+   :param event: The ``slug`` field of the event
+   :param id: The ``id`` field of the item meta property to delete
+   :statuscode 204: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to delete this resource.

doc/api/resources/item_variations.rst

@@ -18,12 +18,19 @@ default_price                         money (string)             The price set d
 price                                 money (string)             The price used for this variation. This is either the
                                                                  same as ``default_price`` if that value is set or equal
                                                                  to the item's ``default_price`` (read-only).
+free_price_suggestion                 money (string)             A suggested price, used as a default value if
+                                                                 ``Item.free_price`` is set (or ``null``).
 original_price                        money (string)             An original price, shown for comparison, not used
                                                                  for price calculations (or ``null``).
 active                                boolean                    If ``false``, this variation will not be sold or shown.
 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
+checkin_attention                     boolean                    If ``true``, the check-in app should show a warning
+                                                                 that this ticket requires special attention if such
+                                                                 a variation is being scanned.
+checkin_text                          string                     Text that will be shown if a ticket of this type is
+                                                                 scanned (or ``null``).
 require_approval                      boolean                    If ``true``, orders with this variation will need to be
                                                                  approved by the event organizer before they can be
                                                                  paid.
@@ -38,13 +45,32 @@ sales_channels                        list of strings            Sales channels
                                                                  available.
 available_from                        datetime                   The first date time at which this variation can be bought
                                                                  (or ``null``).
+available_from_mode                   string                     If ``hide`` (the default), this variation is hidden in the shop
+                                                                 if unavailable due to the available_from setting.
+                                                                 If ``info``, the variation is visible, but can't be purchased,
+                                                                 and a note explaining the unavailability is displayed.
 available_until                       datetime                   The last date time at which this variation can be bought
                                                                  (or ``null``).
+available_until_mode                  string                     If ``hide`` (the default), this variation is hidden in the shop
+                                                                 if unavailable due to the available_until setting.
+                                                                 If ``info``, the variation is visible, but can't be purchased,
+                                                                 and a note explaining the unavailability is displayed.
 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`` and ``checkin_attention`` attributes have been added.
+
+.. versionchanged:: 2023.10
+
+   The ``free_price_suggestion`` attribute has been added.
+   The ``checkin_text`` attribute has been added.
+
+
 Endpoints
 ---------
 
@@ -79,13 +105,17 @@ Endpoints
               "en": "S"
             },
             "active": true,
+            "checkin_attention": false,
+            "checkin_text": null,
             "require_approval": false,
             "require_membership": false,
             "require_membership_hidden": false,
             "require_membership_types": [],
             "sales_channels": ["web"],
             "available_from": null,
+            "available_from_mode": "hide",
             "available_until": null,
+            "available_until_mode": "hide",
             "hide_without_voucher": false,
             "description": {
               "en": "Test2"
@@ -94,6 +124,8 @@ Endpoints
             "default_price": "223.00",
             "price": 223.0,
             "original_price": null,
+            "free_price_suggestion": null,
+            "meta_data": {}
           },
           {
             "id": 3,
@@ -101,14 +133,25 @@ Endpoints
               "en": "L"
             },
             "active": true,
+            "checkin_attention": false,
+            "checkin_text": null,
             "require_approval": false,
             "require_membership": false,
             "require_membership_hidden": false,
             "require_membership_types": [],
+            "sales_channels": ["web"],
+            "available_from": null,
+            "available_from_mode": "hide",
+            "available_until": null,
+            "available_until_mode": "hide",
+            "hide_without_voucher": false,
             "description": {},
             "position": 1,
-            "default_price": null,
-            "price": 15.0
+            "default_price": "223.00",
+            "price": 223.0,
+            "original_price": null,
+            "free_price_suggestion": null,
+            "meta_data": {}
           }
         ]
       }
@@ -151,17 +194,23 @@ Endpoints
         "default_price": "10.00",
         "price": "10.00",
         "original_price": null,
+        "free_price_suggestion": null,
         "active": true,
+        "checkin_attention": false,
+        "checkin_text": null,
         "require_approval": false,
         "require_membership": false,
         "require_membership_hidden": false,
         "require_membership_types": [],
         "sales_channels": ["web"],
         "available_from": null,
+        "available_from_mode": "hide",
         "available_until": null,
+        "available_until_mode": "hide",
         "hide_without_voucher": false,
         "description": null,
-        "position": 0
+        "position": 0,
+        "meta_data": {}
       }
 
    :param organizer: The ``slug`` field of the organizer to fetch
@@ -189,16 +238,21 @@ Endpoints
         "value": {"en": "Student"},
         "default_price": "10.00",
         "active": true,
+        "checkin_attention": false,
+        "checkin_text": null,
         "require_approval": false,
         "require_membership": false,
         "require_membership_hidden": false,
         "require_membership_types": [],
         "sales_channels": ["web"],
         "available_from": null,
+        "available_from_mode": "hide",
         "available_until": null,
+        "available_until_mode": "hide",
         "hide_without_voucher": false,
         "description": null,
-        "position": 0
+        "position": 0,
+        "meta_data": {}
       }
 
    **Example response**:
@@ -215,17 +269,23 @@ Endpoints
         "default_price": "10.00",
         "price": "10.00",
         "original_price": null,
+        "free_price_suggestion": null,
         "active": true,
+        "checkin_attention": false,
+        "checkin_text": null,
         "require_approval": false,
         "require_membership": false,
         "require_membership_hidden": false,
         "require_membership_types": [],
         "sales_channels": ["web"],
         "available_from": null,
+        "available_from_mode": "hide",
         "available_until": null,
+        "available_until_mode": "hide",
         "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
@@ -273,17 +333,23 @@ Endpoints
         "default_price": "10.00",
         "price": "10.00",
         "original_price": null,
+        "free_price_suggestion": null,
         "active": false,
+        "checkin_attention": false,
+        "checkin_text": null,
         "require_approval": false,
         "require_membership": false,
         "require_membership_hidden": false,
         "require_membership_types": [],
         "sales_channels": ["web"],
         "available_from": null,
+        "available_from_mode": "hide",
         "available_until": null,
+        "available_until_mode": "hide",
         "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

@@ -11,148 +11,195 @@ The item resource contains the following public fields:
 
 .. rst-class:: rest-resource-table
 
-===================================== ========================== =======================================================
-Field                                 Type                       Description
-===================================== ========================== =======================================================
-id                                    integer                    Internal ID of the item
-name                                  multi-lingual string       The item's visible name
-internal_name                         string                     An optional name that is only used in the backend
-default_price                         money (string)             The item price that is applied if the price is not
-                                                                 overwritten by variations or other options.
-category                              integer                    The ID of the category this item belongs to
-                                                                 (or ``null``).
-active                                boolean                    If ``false``, the item is hidden from all public lists
-                                                                 and will not be sold.
-description                           multi-lingual string       A public description of the item. May contain Markdown
-                                                                 syntax or can be ``null``.
-free_price                            boolean                    If ``true``, customers can change the price at which
-                                                                 they buy the product (however, the price can't be set
-                                                                 lower than the price defined by ``default_price`` or
-                                                                 otherwise).
-tax_rate                              decimal (string)           The VAT rate to be applied for this item (read-only,
-                                                                 set through ``tax_rule``).
-tax_rule                              integer                    The internal ID of the applied tax rule (or ``null``).
-admission                             boolean                    ``true`` for items that grant admission to the event
-                                                                 (such as primary tickets) and ``false`` for others
-                                                                 (such as add-ons or merchandise).
-position                              integer                    An integer, used for sorting
-picture                               file                       A product picture to be displayed in the shop
-                                                                 (can be ``null``).
-sales_channels                        list of strings            Sales channels this product is available on, such as
-                                                                 ``"web"`` or ``"resellers"``. Defaults to ``["web"]``.
-available_from                        datetime                   The first date time at which this item can be bought
-                                                                 (or ``null``).
-available_until                       datetime                   The last date time at which this item can be bought
-                                                                 (or ``null``).
-hidden_if_available                   integer                    The internal ID of a quota object, or ``null``. If
-                                                                 set, this item won't be shown publicly as long as this
-                                                                 quota is available.
-require_voucher                       boolean                    If ``true``, this item can only be bought using a
-                                                                 voucher that is specifically assigned to this item.
-hide_without_voucher                  boolean                    If ``true``, this item is only shown during the voucher
-                                                                 redemption process, but not in the normal shop
-                                                                 frontend.
-allow_cancel                          boolean                    If ``false``, customers cannot cancel orders containing
-                                                                 this item.
-min_per_order                         integer                    This product can only be bought if it is included at
-                                                                 least this many times in the order (or ``null`` for no
-                                                                 limitation).
-max_per_order                         integer                    This product can only be bought if it is included at
-                                                                 most this many times in the order (or ``null`` for no
-                                                                 limitation).
-checkin_attention                     boolean                    If ``true``, the check-in app should show a warning
-                                                                 that this ticket requires special attention if such
-                                                                 a product is being scanned.
-original_price                        money (string)             An original price, shown for comparison, not used
-                                                                 for price calculations (or ``null``).
-require_approval                      boolean                    If ``true``, orders with this product will need to be
-                                                                 approved by the event organizer before they can be
-                                                                 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.
-grant_membership_duration_like_event  boolean                    If ``true``, the membership created through ``grant_membership_type`` will derive
-                                                                 its term from ``date_from`` to ``date_to`` of the purchased (sub)event.
-grant_membership_duration_days        integer                    If ``grant_membership_duration_like_event`` is ``false``, this sets the number of
-                                                                 days for the membership.
-grant_membership_duration_months      integer                    If ``grant_membership_duration_like_event`` is ``false``, this sets the number of
-                                                                 calendar months for the membership.
-generate_tickets                      boolean                    If ``false``, tickets are never generated for this
-                                                                 product, regardless of other settings. If ``true``,
-                                                                 tickets are generated even if this is a
-                                                                 non-admission or add-on product, regardless of event
-                                                                 settings. If this is ``null``, regular ticketing
-                                                                 rules apply.
-allow_waitinglist                     boolean                    If ``false``, no waiting list will be shown for this
-                                                                 product when it is sold out.
-issue_giftcard                        boolean                    If ``true``, buying this product will yield a gift card.
-show_quota_left                       boolean                    Publicly show how many tickets are still available.
-                                                                 If this is ``null``, the event default is used.
-has_variations                        boolean                    Shows whether or not this item has variations.
-variations                            list of objects            A list with one object for each variation of this item.
-                                                                 Can be empty. Only writable during creation,
-                                                                 use separate endpoint to modify this later.
-├ id                                  integer                    Internal ID of the variation
-├ value                               multi-lingual string       The "name" of the variation
-├ default_price                       money (string)             The price set directly for this variation or ``null``
-├ price                               money (string)             The price used for this variation. This is either the
-                                                                 same as ``default_price`` if that value is set or equal
-                                                                 to the item's ``default_price``.
-├ original_price                      money (string)             An original price, shown for comparison, not used
-                                                                 for price calculations (or ``null``).
-├ 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
-                                                                 ``"web"`` or ``"resellers"``. Defaults to all existing sales channels.
-                                                                 The item-level list takes precedence, i.e. a sales
-                                                                 channel needs to be on both lists for the item to be
-                                                                 available.
-├ available_from                      datetime                   The first date time at which this variation can be bought
-                                                                 (or ``null``).
-├ available_until                     datetime                   The last date time at which this variation can be bought
-                                                                 (or ``null``).
-├ hide_without_voucher                boolean                    If ``true``, this variation is only shown during the voucher
-                                                                 redemption process, but not in the normal shop
-                                                                 frontend.
-└ 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,
-                                                                 use separate endpoint to modify this later.
-├ addon_category                      integer                    Internal ID of the item category the add-on can be
-                                                                 chosen from.
-├ min_count                           integer                    The minimal number of add-ons that need to be chosen.
-├ max_count                           integer                    The maximal number of add-ons that can be chosen.
-├ position                            integer                    An integer, used for sorting
-├ multi_allowed                       boolean                    Adding the same item multiple times is allowed
-└ price_included                      boolean                    Adding this add-on to the item is free
-bundles                               list of objects            Definition of bundles that are included in this item.
-                                                                 Only writable during creation,
-                                                                 use separate endpoint to modify this later.
-├ bundled_item                        integer                    Internal ID of the item that is included.
-├ bundled_variation                   integer                    Internal ID of the variation of the item (or ``null``).
-├ count                               integer                    Number of items included
-└ designated_price                    money (string)             Designated price of the bundled product. This will be
-                                                                 used to split the price of the base item e.g. for mixed
-                                                                 taxation. This is not added to the price.
-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``.
+======================================= ========================== =======================================================
+Field                                   Type                       Description
+======================================= ========================== =======================================================
+id                                      integer                    Internal ID of the item
+name                                    multi-lingual string       The item's visible name
+internal_name                           string                     An optional name that is only used in the backend
+default_price                           money (string)             The item price that is applied if the price is not
+                                                                   overwritten by variations or other options.
+category                                integer                    The ID of the category this item belongs to
+                                                                   (or ``null``).
+active                                  boolean                    If ``false``, the item is hidden from all public lists
+                                                                   and will not be sold.
+description                             multi-lingual string       A public description of the item. May contain Markdown
+                                                                   syntax or can be ``null``.
+free_price                              boolean                    If ``true``, customers can change the price at which
+                                                                   they buy the product (however, the price can't be set
+                                                                   lower than the price defined by ``default_price`` or
+                                                                   otherwise).
+free_price_suggestion                   money (string)             A suggested price, used as a default value if
+                                                                   ``free_price`` is set (or ``null``).
+tax_rate                                decimal (string)           The VAT rate to be applied for this item (read-only,
+                                                                   set through ``tax_rule``).
+tax_rule                                integer                    The internal ID of the applied tax rule (or ``null``).
+admission                               boolean                    ``true`` for items that grant admission to the event
+                                                                   (such as primary tickets) and ``false`` for others
+                                                                   (such as add-ons or merchandise).
+personalized                            boolean                    ``true`` for items that require personalization according
+                                                                   to event settings. Only affects system-level fields, not
+                                                                   custom questions. Currently only allowed for products with
+                                                                   ``admission`` set to ``true``. For backwards compatibility,
+                                                                   when creating new items and this field is not given, it defaults
+                                                                   to the same value as ``admission``.
+position                                integer                    An integer, used for sorting
+picture                                 file                       A product picture to be displayed in the shop
+                                                                   (can be ``null``).
+sales_channels                          list of strings            Sales channels this product is available on, such as
+                                                                   ``"web"`` or ``"resellers"``. Defaults to ``["web"]``.
+available_from                          datetime                   The first date time at which this item can be bought
+                                                                   (or ``null``).
+available_from_mode                     string                     If ``hide`` (the default), this item is hidden in the shop
+                                                                   if unavailable due to the ``available_from`` setting.
+                                                                   If ``info``, the item is visible, but can't be purchased,
+                                                                   and a note explaining the unavailability is displayed.
+available_until                         datetime                   The last date time at which this item can be bought
+                                                                   (or ``null``).
+available_until_mode                    string                     If ``hide`` (the default), this item is hidden in the shop
+                                                                   if unavailable due to the ``available_until`` setting.
+                                                                   If ``info``, the item is visible, but can't be purchased,
+                                                                   and a note explaining the unavailability is displayed.
+hidden_if_available                     integer                    **DEPRECATED** The internal ID of a quota object, or ``null``. If
+                                                                   set, this item won't be shown publicly as long as this
+                                                                   quota is available.
+hidden_if_item_available                integer                    The internal ID of a different item, or ``null``. If
+                                                                   set, this item won't be shown publicly as long as this
+                                                                   other item is available.
+require_voucher                         boolean                    If ``true``, this item can only be bought using a
+                                                                   voucher that is specifically assigned to this item.
+hide_without_voucher                    boolean                    If ``true``, this item is only shown during the voucher
+                                                                   redemption process, but not in the normal shop
+                                                                   frontend.
+allow_cancel                            boolean                    If ``false``, customers cannot cancel orders containing
+                                                                   this item.
+min_per_order                           integer                    This product can only be bought if it is included at
+                                                                   least this many times in the order (or ``null`` for no
+                                                                   limitation).
+max_per_order                           integer                    This product can only be bought if it is included at
+                                                                   most this many times in the order (or ``null`` for no
+                                                                   limitation).
+checkin_attention                       boolean                    If ``true``, the check-in app should show a warning
+                                                                   that this ticket requires special attention if such
+                                                                   a product is being scanned.
+checkin_text                            string                     Text that will be shown if a ticket of this type is
+                                                                   scanned (or ``null``).
+original_price                          money (string)             An original price, shown for comparison, not used
+                                                                   for price calculations (or ``null``).
+require_approval                        boolean                    If ``true``, orders with this product will need to be
+                                                                   approved by the event organizer before they can be
+                                                                   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.
+grant_membership_duration_like_event    boolean                    If ``true``, the membership created through ``grant_membership_type`` will derive
+                                                                   its term from ``date_from`` to ``date_to`` of the purchased (sub)event.
+grant_membership_duration_days          integer                    If ``grant_membership_duration_like_event`` is ``false``, this sets the number of
+                                                                   days for the membership.
+grant_membership_duration_months        integer                    If ``grant_membership_duration_like_event`` is ``false``, this sets the number of
+                                                                   calendar months for the membership.
+validity_mode                           string                     If ``null``, tickets generated for this product do not
+                                                                   have special validity behavior, but follow event configuration and
+                                                                   can be limited e.g. through check-in rules. Other values are ``"fixed"`` and ``"dynamic"``
+validity_fixed_from                     datetime                   If ``validity_mode`` is ``"fixed"``, this is the start of validity for issued tickets.
+validity_fixed_until                    datetime                   If ``validity_mode`` is ``"fixed"``, this is the end of validity for issued tickets.
+validity_dynamic_duration_minutes       integer                    If ``validity_mode`` is ``"dynamic"``, this is the "minutes" component of the ticket validity duration.
+validity_dynamic_duration_hours         integer                    If ``validity_mode`` is ``"dynamic"``, this is the "hours" component of the ticket validity duration.
+validity_dynamic_duration_days          integer                    If ``validity_mode`` is ``"dynamic"``, this is the "days" component of the ticket validity duration.
+validity_dynamic_duration_months        integer                    If ``validity_mode`` is ``"dynamic"``, this is the "months" component of the ticket validity duration.
+validity_dynamic_start_choice           boolean                    If ``validity_mode`` is ``"dynamic"`` and this is ``true``, customers can choose the start of validity.
+validity_dynamic_start_choice_day_limit boolean                    If ``validity_mode`` is ``"dynamic"`` and ``validity_dynamic_start_choice`` is ``true``,
+                                                                   this is the maximum number of days the start can be in the future.
+generate_tickets                        boolean                    If ``false``, tickets are never generated for this
+                                                                   product, regardless of other settings. If ``true``,
+                                                                   tickets are generated even if this is a
+                                                                   non-admission or add-on product, regardless of event
+                                                                   settings. If this is ``null``, regular ticketing
+                                                                   rules apply.
+allow_waitinglist                       boolean                    If ``false``, no waiting list will be shown for this
+                                                                   product when it is sold out.
+issue_giftcard                          boolean                    If ``true``, buying this product will yield a gift card.
+media_policy                            string                     Policy on how to handle reusable media (experimental feature).
+                                                                   Possible values are ``null``, ``"new"``, ``"reuse"``, and ``"reuse_or_new"``.
+media_type                              string                     Type of reusable media to work on (experimental feature). See :ref:`rest-reusablemedia` for possible choices.
+show_quota_left                         boolean                    Publicly show how many tickets are still available.
+                                                                   If this is ``null``, the event default is used.
+has_variations                          boolean                    Shows whether or not this item has variations.
+variations                              list of objects            A list with one object for each variation of this item.
+                                                                   Can be empty. Only writable during creation,
+                                                                   use separate endpoint to modify this later.
+├ id                                    integer                    Internal ID of the variation
+├ value                                 multi-lingual string       The "name" of the variation
+├ default_price                         money (string)             The price set directly for this variation or ``null``
+├ price                                 money (string)             The price used for this variation. This is either the
+                                                                   same as ``default_price`` if that value is set or equal
+                                                                   to the item's ``default_price``.
+├ free_price_suggestion                 money (string)             A suggested price, used as a default value if
+                                                                   ``free_price`` is set (or ``null``).
+├ original_price                        money (string)             An original price, shown for comparison, not used
+                                                                   for price calculations (or ``null``).
+├ active                                boolean                    If ``false``, this variation will not be sold or shown.
+├ description                           multi-lingual string       A public description of the variation. May contain
+├ checkin_attention                     boolean                    If ``true``, the check-in app should show a warning
+                                                                   that this ticket requires special attention if such
+                                                                   a variation is being scanned.
+├ checkin_text                          string                     Text that will be shown if a ticket of this type is
+                                                                   scanned (or ``null``).
+├ 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``
+                                                                   Markdown syntax or can be ``null``.
+├ sales_channels                        list of strings            Sales channels this variation is available on, such as
+                                                                   ``"web"`` or ``"resellers"``. Defaults to all existing sales channels.
+                                                                   The item-level list takes precedence, i.e. a sales
+                                                                   channel needs to be on both lists for the item to be
+                                                                   available.
+├ available_from                        datetime                   The first date time at which this variation can be bought
+                                                                   (or ``null``).
+├ available_from_mode                   string                     If ``hide`` (the default), this variation is hidden in the shop
+                                                                   if unavailable due to the ``available_from`` setting.
+                                                                   If ``info``, the variation is visible, but can't be purchased,
+                                                                   and a note explaining the unavailability is displayed.
+├ available_until                       datetime                   The last date time at which this variation can be bought
+                                                                   (or ``null``).
+├ available_until_mode                  string                     If ``hide`` (the default), this variation is hidden in the shop
+                                                                   if unavailable due to the ``available_until`` setting.
+                                                                   If ``info``, the variation is visible, but can't be purchased,
+                                                                   and a note explaining the unavailability is displayed.
+├ 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,
+                                                                   use separate endpoint to modify this later.
+├ addon_category                        integer                    Internal ID of the item category the add-on can be
+                                                                   chosen from.
+├ min_count                             integer                    The minimal number of add-ons that need to be chosen.
+├ max_count                             integer                    The maximal number of add-ons that can be chosen.
+├ position                              integer                    An integer, used for sorting
+├ multi_allowed                         boolean                    Adding the same item multiple times is allowed
+└ price_included                        boolean                    Adding this add-on to the item is free
+bundles                                 list of objects            Definition of bundles that are included in this item.
+                                                                   Only writable during creation,
+                                                                   use separate endpoint to modify this later.
+├ bundled_item                          integer                    Internal ID of the item that is included.
+├ bundled_variation                     integer                    Internal ID of the variation of the item (or ``null``).
+├ count                                 integer                    Number of items included
+└ designated_price                      money (string)             Designated price of the bundled product. This will be
+                                                                   used to split the price of the base item e.g. for mixed
+                                                                   taxation. This is not added to the price.
+meta_data                               object                     Values set for event-specific meta data parameters.
+======================================= ========================== =======================================================
 
 .. versionchanged:: 4.0
 
@@ -163,6 +210,29 @@ meta_data                             object                     Values set for
 
    The attributes ``require_membership_hidden`` attribute has been added.
 
+.. versionchanged:: 4.16
+
+   The ``variations[x].meta_data`` and ``variations[x].checkin_attention`` attributes have been added.
+   The ``personalized`` attribute has been added.
+
+.. versionchanged:: 4.17
+
+   The ``validity_*`` attributes have been added.
+
+.. versionchanged:: 4.18
+
+   The ``media_policy`` and ``media_type`` attributes have been added.
+
+.. versionchanged:: 2023.10
+
+   The ``checkin_text`` and ``variations[x].checkin_text`` attributes have been added.
+   The ``free_price_suggestion`` and ``variations[x].free_price_suggestion`` attributes have been added.
+
+.. versionchanged:: 2023.10
+
+   The ``hidden_if_item_available`` attributes has been added, the ``hidden_if_available`` attribute has been
+   deprecated.
+
 Notes
 -----
 
@@ -213,22 +283,30 @@ Endpoints
             "active": true,
             "description": null,
             "free_price": false,
+            "free_price_suggestion": null,
             "tax_rate": "0.00",
             "tax_rule": 1,
             "admission": false,
+            "personalized": false,
             "issue_giftcard": false,
+            "media_policy": null,
+            "media_type": null,
             "meta_data": {},
             "position": 0,
             "picture": null,
             "available_from": null,
+            "available_from_mode": "hide",
             "available_until": null,
+            "available_until_mode": "hide",
             "hidden_if_available": null,
+            "hidden_if_item_available": null,
             "require_voucher": false,
             "hide_without_voucher": false,
             "allow_cancel": true,
             "min_per_order": null,
             "max_per_order": null,
             "checkin_attention": false,
+            "checkin_text": null,
             "has_variations": false,
             "generate_tickets": null,
             "allow_waitinglist": true,
@@ -241,20 +319,35 @@ Endpoints
             "grant_membership_duration_like_event": true,
             "grant_membership_duration_days": 0,
             "grant_membership_duration_months": 0,
+            "validity_fixed_from": null,
+            "validity_fixed_until": null,
+            "validity_dynamic_duration_minutes": null,
+            "validity_dynamic_duration_hours": null,
+            "validity_dynamic_duration_days": null,
+            "validity_dynamic_duration_months": null,
+            "validity_dynamic_start_choice": false,
+            "validity_dynamic_start_choice_day_limit": null,
             "variations": [
               {
                  "value": {"en": "Student"},
                  "default_price": "10.00",
                  "price": "10.00",
                  "original_price": null,
+                 "free_price_suggestion": null,
                  "active": true,
+                 "checkin_attention": false,
+                 "checkin_text": null,
+                 "require_approval": false,
                  "require_membership": false,
                  "require_membership_types": [],
                  "sales_channels": ["web"],
                  "available_from": null,
+                 "available_from_mode": "hide",
                  "available_until": null,
+                 "available_until_mode": "hide",
                  "hide_without_voucher": false,
                  "description": null,
+                 "meta_data": {},
                  "position": 0
               },
               {
@@ -262,14 +355,21 @@ Endpoints
                  "default_price": null,
                  "price": "23.00",
                  "original_price": null,
+                 "free_price_suggestion": null,
                  "active": true,
+                 "checkin_attention": false,
+                 "checkin_text": null,
+                 "require_approval": false,
                  "require_membership": false,
                  "require_membership_types": [],
                  "sales_channels": ["web"],
                  "available_from": null,
+                 "available_from_mode": "hide",
                  "available_until": null,
+                 "available_until_mode": "hide",
                  "hide_without_voucher": false,
                  "description": null,
+                 "meta_data": {},
                  "position": 1
               }
             ],
@@ -327,16 +427,23 @@ Endpoints
         "active": true,
         "description": null,
         "free_price": false,
+        "free_price_suggestion": null,
         "tax_rate": "0.00",
         "tax_rule": 1,
         "admission": false,
+        "personalized": false,
         "issue_giftcard": false,
+        "media_policy": null,
+        "media_type": null,
         "meta_data": {},
         "position": 0,
         "picture": null,
         "available_from": null,
+        "available_from_mode": "hide",
         "available_until": null,
+        "available_until_mode": "hide",
         "hidden_if_available": null,
+        "hidden_if_item_available": null,
         "require_voucher": false,
         "hide_without_voucher": false,
         "allow_cancel": true,
@@ -346,6 +453,7 @@ Endpoints
         "min_per_order": null,
         "max_per_order": null,
         "checkin_attention": false,
+        "checkin_text": null,
         "has_variations": false,
         "require_approval": false,
         "require_bundling": false,
@@ -355,20 +463,35 @@ Endpoints
         "grant_membership_duration_like_event": true,
         "grant_membership_duration_days": 0,
         "grant_membership_duration_months": 0,
+        "validity_fixed_from": null,
+        "validity_fixed_until": null,
+        "validity_dynamic_duration_minutes": null,
+        "validity_dynamic_duration_hours": null,
+        "validity_dynamic_duration_days": null,
+        "validity_dynamic_duration_months": null,
+        "validity_dynamic_start_choice": false,
+        "validity_dynamic_start_choice_day_limit": null,
         "variations": [
           {
              "value": {"en": "Student"},
              "default_price": "10.00",
              "price": "10.00",
              "original_price": null,
+             "free_price_suggestion": null,
              "active": true,
+             "checkin_attention": false,
+             "checkin_text": null,
+             "require_approval": false,
              "require_membership": false,
              "require_membership_types": [],
              "description": null,
              "sales_channels": ["web"],
              "available_from": null,
+             "available_from_mode": "hide",
              "available_until": null,
+             "available_until_mode": "hide",
              "hide_without_voucher": false,
+             "meta_data": {},
              "position": 0
           },
           {
@@ -376,14 +499,21 @@ Endpoints
              "default_price": null,
              "price": "23.00",
              "original_price": null,
+             "free_price_suggestion": null,
              "active": true,
+             "checkin_attention": false,
+             "checkin_text": null,
+             "require_approval": false,
              "require_membership": false,
              "require_membership_types": [],
              "sales_channels": ["web"],
              "available_from": null,
+             "available_from_mode": "hide",
              "available_until": null,
+             "available_until_mode": "hide",
              "hide_without_voucher": false,
              "description": null,
+             "meta_data": {},
              "position": 1
           }
         ],
@@ -422,16 +552,23 @@ Endpoints
         "active": true,
         "description": null,
         "free_price": false,
+        "free_price_suggestion": null,
         "tax_rate": "0.00",
         "tax_rule": 1,
         "admission": false,
+        "personalized": false,
         "issue_giftcard": false,
+        "media_policy": null,
+        "media_type": null,
         "meta_data": {},
         "position": 0,
         "picture": null,
         "available_from": null,
+        "available_from_mode": "hide",
         "available_until": null,
+        "available_until_mode": "hide",
         "hidden_if_available": null,
+        "hidden_if_item_available": null,
         "require_voucher": false,
         "hide_without_voucher": false,
         "allow_cancel": true,
@@ -441,6 +578,7 @@ Endpoints
         "min_per_order": null,
         "max_per_order": null,
         "checkin_attention": false,
+        "checkin_text": null,
         "require_approval": false,
         "require_bundling": false,
         "require_membership": false,
@@ -449,20 +587,35 @@ Endpoints
         "grant_membership_duration_like_event": true,
         "grant_membership_duration_days": 0,
         "grant_membership_duration_months": 0,
+        "validity_fixed_from": null,
+        "validity_fixed_until": null,
+        "validity_dynamic_duration_minutes": null,
+        "validity_dynamic_duration_hours": null,
+        "validity_dynamic_duration_days": null,
+        "validity_dynamic_duration_months": null,
+        "validity_dynamic_start_choice": false,
+        "validity_dynamic_start_choice_day_limit": null,
         "variations": [
           {
              "value": {"en": "Student"},
              "default_price": "10.00",
              "price": "10.00",
              "original_price": null,
+             "free_price_suggestion": null,
              "active": true,
+             "checkin_attention": false,
+             "checkin_text": null,
+             "require_approval": false,
              "require_membership": false,
              "require_membership_types": [],
              "sales_channels": ["web"],
              "available_from": null,
+             "available_from_mode": "hide",
              "available_until": null,
+             "available_until_mode": "hide",
              "hide_without_voucher": false,
              "description": null,
+             "meta_data": {},
              "position": 0
           },
           {
@@ -470,14 +623,21 @@ Endpoints
              "default_price": null,
              "price": "23.00",
              "original_price": null,
+             "free_price_suggestion": null,
              "active": true,
+             "checkin_attention": false,
+             "checkin_text": null,
+             "require_approval": false,
              "require_membership": false,
              "require_membership_types": [],
              "sales_channels": ["web"],
              "available_from": null,
+             "available_from_mode": "hide",
              "available_until": null,
+             "available_until_mode": "hide",
              "hide_without_voucher": false,
              "description": null,
+             "meta_data": {},
              "position": 1
           }
         ],
@@ -504,16 +664,23 @@ Endpoints
         "active": true,
         "description": null,
         "free_price": false,
+        "free_price_suggestion": null,
         "tax_rate": "0.00",
         "tax_rule": 1,
         "admission": false,
+        "personalized": false,
         "issue_giftcard": false,
+        "media_policy": null,
+        "media_type": null,
         "meta_data": {},
         "position": 0,
         "picture": null,
         "available_from": null,
+        "available_from_mode": "hide",
         "available_until": null,
+        "available_until_mode": "hide",
         "hidden_if_available": null,
+        "hidden_if_item_available": null,
         "require_voucher": false,
         "hide_without_voucher": false,
         "allow_cancel": true,
@@ -523,6 +690,7 @@ Endpoints
         "allow_waitinglist": true,
         "show_quota_left": null,
         "checkin_attention": false,
+        "checkin_text": null,
         "has_variations": true,
         "require_approval": false,
         "require_bundling": false,
@@ -532,20 +700,35 @@ Endpoints
         "grant_membership_duration_like_event": true,
         "grant_membership_duration_days": 0,
         "grant_membership_duration_months": 0,
+        "validity_fixed_from": null,
+        "validity_fixed_until": null,
+        "validity_dynamic_duration_minutes": null,
+        "validity_dynamic_duration_hours": null,
+        "validity_dynamic_duration_days": null,
+        "validity_dynamic_duration_months": null,
+        "validity_dynamic_start_choice": false,
+        "validity_dynamic_start_choice_day_limit": null,
         "variations": [
           {
              "value": {"en": "Student"},
              "default_price": "10.00",
              "price": "10.00",
              "original_price": null,
+             "free_price_suggestion": null,
              "active": true,
+             "checkin_attention": false,
+             "checkin_text": null,
+             "require_approval": false,
              "require_membership": false,
              "require_membership_types": [],
              "sales_channels": ["web"],
              "available_from": null,
+             "available_from_mode": "hide",
              "available_until": null,
+             "available_until_mode": "hide",
              "hide_without_voucher": false,
              "description": null,
+             "meta_data": {},
              "position": 0
           },
           {
@@ -553,14 +736,21 @@ Endpoints
              "default_price": null,
              "price": "23.00",
              "original_price": null,
+             "free_price_suggestion": null,
              "active": true,
+             "checkin_attention": false,
+             "checkin_text": null,
+             "require_approval": false,
              "require_membership": false,
              "require_membership_types": [],
              "sales_channels": ["web"],
              "available_from": null,
+             "available_from_mode": "hide",
              "available_until": null,
+             "available_until_mode": "hide",
              "hide_without_voucher": false,
              "description": null,
+             "meta_data": {},
              "position": 1
           }
         ],
@@ -618,16 +808,23 @@ Endpoints
         "active": true,
         "description": null,
         "free_price": false,
+        "free_price_suggestion": null,
         "tax_rate": "0.00",
         "tax_rule": 1,
         "admission": false,
+        "personalized": false,
         "issue_giftcard": false,
+        "media_policy": null,
+        "media_type": null,
         "meta_data": {},
         "position": 0,
         "picture": null,
         "available_from": null,
+        "available_from_mode": "hide",
         "available_until": null,
+        "available_until_mode": "hide",
         "hidden_if_available": null,
+        "hidden_if_item_available": null,
         "require_voucher": false,
         "hide_without_voucher": false,
         "generate_tickets": null,
@@ -637,6 +834,7 @@ Endpoints
         "min_per_order": null,
         "max_per_order": null,
         "checkin_attention": false,
+        "checkin_text": null,
         "has_variations": true,
         "require_approval": false,
         "require_bundling": false,
@@ -646,20 +844,35 @@ Endpoints
         "grant_membership_duration_like_event": true,
         "grant_membership_duration_days": 0,
         "grant_membership_duration_months": 0,
+        "validity_fixed_from": null,
+        "validity_fixed_until": null,
+        "validity_dynamic_duration_minutes": null,
+        "validity_dynamic_duration_hours": null,
+        "validity_dynamic_duration_days": null,
+        "validity_dynamic_duration_months": null,
+        "validity_dynamic_start_choice": false,
+        "validity_dynamic_start_choice_day_limit": null,
         "variations": [
           {
              "value": {"en": "Student"},
              "default_price": "10.00",
              "price": "10.00",
              "original_price": null,
+             "free_price_suggestion": null,
              "active": true,
+             "checkin_attention": false,
+             "checkin_text": null,
+             "require_approval": false,
              "require_membership": false,
              "require_membership_types": [],
              "sales_channels": ["web"],
              "available_from": null,
+             "available_from_mode": "hide",
              "available_until": null,
+             "available_until_mode": "hide",
              "hide_without_voucher": false,
              "description": null,
+             "meta_data": {},
              "position": 0
           },
           {
@@ -667,14 +880,21 @@ Endpoints
              "default_price": null,
              "price": "23.00",
              "original_price": null,
+             "free_price_suggestion": null,
              "active": true,
+             "checkin_attention": false,
+             "checkin_text": null,
+             "require_approval": false,
              "require_membership": false,
              "require_membership_types": [],
              "sales_channels": ["web"],
              "available_from": null,
+             "available_from_mode": "hide",
              "available_until": null,
+             "available_until_mode": "hide",
              "hide_without_voucher": false,
              "description": null,
+             "meta_data": {},
              "position": 1
           }
         ],

doc/api/resources/orders.rst

@@ -1,4 +1,4 @@
-.. spelling::
+.. spelling:word-list::
 
    checkins
    pdf
@@ -20,6 +20,7 @@ The order resource contains the following public fields:
 Field                                 Type                       Description
 ===================================== ========================== =======================================================
 code                                  string                     Order code
+event                                 string                     The slug of the parent event
 status                                string                     Order status, one of:
 
                                                                  * ``n`` – pending
@@ -45,6 +46,8 @@ custom_followup_at                    date                       Internal date f
 checkin_attention                     boolean                    If ``true``, the check-in app should show a warning
                                                                  that this ticket requires special attention if a ticket
                                                                  of this order is scanned.
+checkin_text                          string                     Text that will be shown if a ticket of this order is
+                                                                 scanned (or ``null``).
 invoice_address                       object                     Invoice address information (can be ``null``)
 ├ last_modified                       datetime                   Last modification date of the address
 ├ company                             string                     Customer company name
@@ -60,6 +63,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
@@ -90,6 +94,10 @@ require_approval                      boolean                    If ``true`` and
                                                                  needs approval by an organizer before it can
                                                                  continue. If ``true`` and the order is canceled,
                                                                  this order has been denied by the event organizer.
+valid_if_pending                      boolean                    If ``true`` and the order is pending, this order
+                                                                 is still treated like a paid order for most purposes,
+                                                                 such as check-in. This may be used e.g. for trusted
+                                                                 customers who only need to pay after the event.
 url                                   string                     The full URL to the order confirmation page
 payments                              list of objects            List of payment processes (see below)
 refunds                               list of objects            List of refund processes (see below)
@@ -97,30 +105,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.
@@ -141,6 +125,30 @@ last_modified                         datetime                   Last modificati
 
    The ``order.fees.id`` attribute has been added.
 
+.. versionchanged:: 4.15
+
+   The ``include`` query parameter has been added.
+
+.. versionchanged:: 4.16
+
+   The ``valid_if_pending`` attribute has been added.
+
+.. versionchanged:: 2023.8
+
+   The ``event`` attribute has been added. The organizer-level endpoint has been added.
+
+.. versionchanged:: 2023.9
+
+   The ``customer`` query parameter has been added.
+
+.. versionchanged:: 2023.10
+
+   The ``checkin_text`` attribute has been added.
+
+.. versionchanged:: 2024.1
+
+   The ``expires`` attribute can now be passed during order creation.
+
 
 .. _order-position-resource:
 
@@ -171,12 +179,21 @@ country                               string                     Attendee countr
 state                                 string                     Attendee state (ISO 3166-2 code). Only supported in
                                                                  AU, BR, CA, CN, MY, MX, and US, otherwise ``null``.
 voucher                               integer                    Internal ID of the voucher used for this position (or ``null``)
+voucher_budget_use                    money (string)             Amount of money discounted by the voucher, corresponding
+                                                                 to how much of the ``budget`` of the voucher is consumed.
+                                                                 **Important:** Do not rely on this amount to be a useful
+                                                                 value if the position's price, product or voucher
+                                                                 are changed *after* the order was created. Can be ``null``.
 tax_rate                              decimal (string)           VAT rate applied for this position
 tax_value                             money (string)             VAT included in this position
 tax_rule                              integer                    The ID of the used tax rule (or ``null``)
 secret                                string                     Secret code printed on the tickets for validation
 addon_to                              integer                    Internal ID of the position this position is an add-on for (or ``null``)
 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``).
+blocked                               list of strings            A list of strings, or ``null``. Whenever not ``null``, the ticket may not be used (e.g. for check-in).
+valid_from                            datetime                   The ticket will not be valid before this time. Can be ``null``.
+valid_until                           datetime                   The ticket will not be valid after this time. Can be ``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
@@ -204,26 +221,9 @@ pdf_data                              object                     Data object req
                                                                  ``pdf_data=true`` query parameter to your request.
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 3.3
+.. versionchanged:: 4.16
 
-  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.
+   The attributes ``blocked``, ``valid_from`` and ``valid_until`` have been added.
 
 .. _order-payment-resource:
 
@@ -271,15 +271,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.
@@ -308,6 +313,7 @@ List of all orders
         "results": [
           {
             "code": "ABC12",
+            "event": "sampleconf",
             "status": "p",
             "testmode": false,
             "secret": "k24fiuwvu8kxz3y1",
@@ -327,7 +333,9 @@ List of all orders
             "comment": "",
             "custom_followup_at": null,
             "checkin_attention": false,
+            "checkin_text": null,
             "require_approval": false,
+            "valid_if_pending": false,
             "invoice_address": {
                 "last_modified": "2017-12-01T10:00:00Z",
                 "is_business": true,
@@ -364,12 +372,17 @@ List of all orders
                 "country": "DE",
                 "state": null,
                 "voucher": null,
+                "voucher_budget_use": null,
                 "tax_rate": "0.00",
                 "tax_value": "0.00",
                 "tax_rule": null,
                 "secret": "z3fsn8jyufm5kpk768q69gkbyr5f4h6w",
                 "addon_to": null,
                 "subevent": null,
+                "valid_from": null,
+                "valid_until": null,
+                "blocked": null,
+                "discount": null,
                 "pseudonymization_id": "MQLJvANO3B",
                 "seat": null,
                 "checkins": [
@@ -427,7 +440,8 @@ 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 string customer: Only show orders linked to the given customer.
    :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``
@@ -446,6 +460,7 @@ List of all orders
    :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
@@ -454,13 +469,51 @@ List of all orders
    :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)/orders/
+
+   Returns a list of all orders within all events of a given organizer (with sufficient access permissions).
+
+   Supported query parameters and output format of this endpoint are identical to the list endpoint within an event,
+   with the exception that the ``pdf_data`` parameter is not supported here.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/orders/ 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
+      X-Page-Generated: 2017-12-01T10:00:00Z
+
+      {
+        "count": 1,
+        "next": null,
+        "previous": null,
+        "results": [
+          {
+            "code": "ABC12",
+            "event": "sampleconf",
+            ...
+          }
+        ]
+      }
+
+   :param organizer: The ``slug`` field of the organizer 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.
+
 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.
@@ -483,6 +536,7 @@ Fetching individual orders
 
       {
         "code": "ABC12",
+        "event": "sampleconf",
         "status": "p",
         "testmode": false,
         "secret": "k24fiuwvu8kxz3y1",
@@ -502,7 +556,9 @@ Fetching individual orders
         "comment": "",
         "custom_followup_at": null,
         "checkin_attention": false,
+        "checkin_text": null,
         "require_approval": false,
+        "valid_if_pending": false,
         "invoice_address": {
             "last_modified": "2017-12-01T10:00:00Z",
             "company": "Sample company",
@@ -539,12 +595,17 @@ Fetching individual orders
             "country": "DE",
             "state": null,
             "voucher": null,
+            "voucher_budget_use": null,
             "tax_rate": "0.00",
             "tax_rule": null,
             "tax_value": "0.00",
             "secret": "z3fsn8jyufm5kpk768q69gkbyr5f4h6w",
             "addon_to": null,
             "subevent": null,
+            "valid_from": null,
+            "valid_until": null,
+            "blocked": null,
+            "discount": null,
             "pseudonymization_id": "MQLJvANO3B",
             "seat": null,
             "checkins": [
@@ -609,13 +670,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.
 
@@ -663,6 +728,8 @@ Updating order fields
 
    * ``checkin_attention``
 
+   * ``checkin_text``
+
    * ``locale``
 
    * ``comment``
@@ -671,6 +738,10 @@ Updating order fields
 
    * ``invoice_address`` (you always need to supply the full object, or ``null`` to delete the current address)
 
+   * ``valid_if_pending``
+
+   * ``expires``
+
    **Example request**:
 
    .. sourcecode:: http
@@ -846,9 +917,10 @@ Creating orders
 
        * does not support or validate memberships
 
+
    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
@@ -875,7 +947,9 @@ Creating orders
    * ``comment`` (optional)
    * ``custom_followup_at`` (optional)
    * ``checkin_attention`` (optional)
+   * ``checkin_text`` (optional)
    * ``require_approval`` (optional)
+   * ``valid_if_pending`` (optional)
    * ``invoice_address`` (optional)
 
       * ``company``
@@ -911,6 +985,10 @@ Creating orders
       * ``secret`` (optional)
       * ``addon_to`` (optional, see below)
       * ``subevent`` (optional)
+      * ``valid_from`` (optional, if both ``valid_from`` and ``valid_until`` are **missing** (not ``null``) the availability will be computed from the given product)
+      * ``valid_until`` (optional, if both ``valid_from`` and ``valid_until`` are **missing** (not ``null``) the availability will be computed from the given product)
+      * ``requested_valid_from`` (optional, can be set **instead** of ``valid_from`` and ``valid_until`` to signal a user choice for the start time that may or may not be respected)
+      * ``use_reusable_medium`` (optional, causes the new ticket to take over the given reusable medium, identified by its ID)
       * ``answers``
 
         * ``question``
@@ -981,7 +1059,7 @@ Creating orders
           "street": "Sesam Street 12",
           "zipcode": "12345",
           "city": "Sample City",
-          "country": "UK",
+          "country": "GB",
           "state": "",
           "internal_reference": "",
           "vat_id": ""
@@ -1030,10 +1108,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.
@@ -1082,6 +1156,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
@@ -1093,6 +1170,7 @@ Order state operations
 
       {
           "send_email": true,
+          "comment": "Event was canceled.",
           "cancellation_fee": null
       }
 
@@ -1431,10 +1509,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.
@@ -1474,14 +1548,19 @@ List of all order positions
             },
             "attendee_email": null,
             "voucher": null,
+            "voucher_budget_use": null,
             "tax_rate": "0.00",
             "tax_rule": null,
             "tax_value": "0.00",
             "secret": "z3fsn8jyufm5kpk768q69gkbyr5f4h6w",
+            "discount": null,
             "pseudonymization_id": "MQLJvANO3B",
             "seat": null,
             "addon_to": null,
             "subevent": null,
+            "valid_from": null,
+            "valid_until": null,
+            "blocked": null,
             "checkins": [
               {
                 "list": 44,
@@ -1517,6 +1596,7 @@ List of all order positions
                            ``order__datetime,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 customer: Only show orders linked to the given customer.
    :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.
@@ -1582,12 +1662,17 @@ Fetching individual positions
         },
         "attendee_email": null,
         "voucher": null,
+        "voucher_budget_use": null,
         "tax_rate": "0.00",
         "tax_rule": null,
         "tax_value": "0.00",
         "secret": "z3fsn8jyufm5kpk768q69gkbyr5f4h6w",
         "addon_to": null,
         "subevent": null,
+        "valid_from": null,
+        "valid_until": null,
+        "blocked": null,
+        "discount": null,
         "pseudonymization_id": "MQLJvANO3B",
         "seat": null,
         "checkins": [
@@ -1631,6 +1716,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.
@@ -1642,7 +1731,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.
@@ -1683,15 +1772,15 @@ Order position ticket download
 Manipulating individual positions
 ---------------------------------
 
-.. versionchanged:: 3.15
-
-   The ``PATCH`` method has been added for individual positions.
-
 .. versionchanged:: 4.8
 
    The ``PATCH`` method now supports changing items, variations, subevents, seats, prices, and tax rules.
    The ``POST`` endpoint to add individual positions has been added.
 
+.. versionadded:: 4.16
+
+   The endpoints to manage blocks have been added.
+
 .. http:patch:: /api/v1/organizers/(organizer)/events/(event)/orderpositions/(id)/
 
    Updates specific fields on an order position. Currently, only the following fields are supported:
@@ -1730,6 +1819,10 @@ Manipulating individual positions
 
    * ``tax_rule``
 
+   * ``valid_from``
+
+   * ``valid_until``
+
    Changing parameters such as ``item`` or ``price`` will **not** automatically trigger creation of a new invoice,
    you need to take care of that yourself.
 
@@ -1804,6 +1897,10 @@ 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.
 
+   * ``valid_from``
+
+   * ``valid_until``
+
    This will **not** automatically trigger creation of a new invoice, you need to take care of that yourself.
 
    **Example request**:
@@ -1867,6 +1964,82 @@ 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.
 
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/orderpositions/(id)/add_block/
+
+   Blocks an order position from being used. The block name either needs to be ``"admin"`` or start with ``"api:"``. It
+   may only contain letters, numbers, dots and underscores. ``"admin"`` represents the regular block that can be set
+   in the backend user interface.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/orderpositions/23/add_block/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+
+     {
+       "name": "api:block1"
+     }
+
+   **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.
+
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/orderpositions/(id)/remove_block/
+
+   Unblocks an order position from being used. The block name either needs to be ``"admin"`` or start with ``"api:"``. It
+   may only contain letters, numbers, dots and underscores. ``"admin"`` represents the regular block that can be set
+   in the backend user interface. Blocks set by plugins cannot be lifted through this API.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/orderpositions/23/remove_block/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+
+     {
+       "name": "api:block1"
+     }
+
+   **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.
+
 Changing order contents
 -----------------------
 
@@ -1885,7 +2058,7 @@ otherwise, such as splitting an order or changing fees.
 
    * ``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``).
+     ``price``, ``tax_rule``, ``valid_from``, ``valid_until``).
 
    * ``cancel_positions``: A list of objects with the single key ``position`` specifying an order position ID.
 
@@ -1912,7 +2085,7 @@ otherwise, such as splitting an order or changing fees.
 
    .. sourcecode:: http
 
-      POST /api/v1/organizers/bigevents/events/sampleconf/orders/ABC12/ HTTP/1.1
+      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
@@ -1993,14 +2166,6 @@ otherwise, such as splitting an order or changing fees.
 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.
@@ -2306,6 +2471,7 @@ Order refund endpoints
             "created": "2017-12-01T10:00:00Z",
             "execution_date": "2017-12-04T12:13:12Z",
             "comment": "Cancellation",
+            "details": {},
             "provider": "banktransfer"
           }
         ]
@@ -2349,6 +2515,7 @@ Order refund endpoints
         "created": "2017-12-01T10:00:00Z",
         "execution_date": "2017-12-04T12:13:12Z",
         "comment": "Cancellation",
+        "details": {},
         "provider": "banktransfer"
       }
 
@@ -2406,6 +2573,7 @@ Order refund endpoints
         "created": "2017-12-01T10:00:00Z",
         "execution_date": null,
         "comment": "Cancellation",
+        "details": {},
         "provider": "manual"
       }
 
@@ -2535,10 +2703,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.
@@ -2583,3 +2747,57 @@ With some non-default ticket secret generation methods, a list of revoked ticket
    :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.
+
+Blocked ticket secrets
+----------------------
+
+With some non-default ticket secret generation methods, a list of blocked ticket secrets is required for proper validation.
+This endpoint returns all secrets that are currently blocked **or have been blocked before and are now unblocked**, so
+be sure to check the ``blocked`` attribute for its actual value. The list is currently always ordered with the most
+recently updated ones first.
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/blockedsecrets/
+
+   Returns a list of all blocked or historically blocked secrets within a given event.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/blockedsecrets/ 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
+      X-Page-Generated: 2017-12-01T10:00:00Z
+
+      {
+        "count": 1,
+        "next": null,
+        "previous": null,
+        "results": [
+          {
+            "id": 1234,
+            "secret": "k24fiuwvu8kxz3y1",
+            "blocked": true,
+            "updated": "2017-12-01T10:00:00Z",
+          }
+        ]
+      }
+
+   :query integer page: The page number in case of a multi-page result set, default is 1
+   :query datetime updated_since: Only return records that have been updated since the given date.
+   :query boolean blocked: Only return blocked / non-blocked records.
+   :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
+                                differences, this is the value you want to use as ``updated_since`` in your next call.
+   :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.

doc/api/resources/organizers.rst

@@ -17,12 +17,18 @@ Field                                 Type                       Description
 name                                  string                     The organizer's full name, i.e. the name of an
                                                                  organization or company.
 slug                                  string                     A short form of the name, used e.g. in URLs.
+public_url                            string                     The public, customer-facing URL of the organizer, where
+                                                                 the list of all events can be found (read-only).
 ===================================== ========================== =======================================================
 
 
 Endpoints
 ---------
 
+.. versionchanged:: 4.17
+
+    The ``public_url`` field has been added.
+
 .. http:get:: /api/v1/organizers/
 
    Returns a list of all organizers the authenticated user/token has access to.
@@ -51,6 +57,7 @@ Endpoints
           {
             "name": "Big Events LLC",
             "slug": "Big Events",
+            "public_url": "https://pretix.eu/bigevents/"
           }
         ]
       }
@@ -84,6 +91,7 @@ Endpoints
       {
         "name": "Big Events LLC",
         "slug": "Big Events",
+        "public_url": "https://pretix.eu/bigevents/"
       }
 
    :param organizer: The ``slug`` field of the organizer to fetch
@@ -109,10 +117,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.
@@ -153,6 +157,7 @@ information about the properties.
           {
             "value": "calendar",
             "label": "Default overview style",
+            "readonly": false,
             "help_text": "If your event series has more than 50 dates in the future, only the month or week calendar can be used."
           }
         },

doc/api/resources/questions.rst

@@ -1,4 +1,4 @@
-.. spelling::
+.. spelling:word-list::
 
    checkin
    datetime
@@ -44,6 +44,8 @@ identifier                            string                     An arbitrary st
 ask_during_checkin                    boolean                    If ``true``, this question will not be asked while
                                                                  buying the ticket, but will show up when redeeming
                                                                  the ticket instead.
+show_during_checkin                   boolean                    If ``true``, the answer to the question will be shown
+                                                                 during check-in (if the check-in client supports it).
 hidden                                boolean                    If ``true``, the question will only be shown in the
                                                                  backend.
 print_on_invoice                      boolean                    If ``true``, the question will only be shown on
@@ -63,6 +65,7 @@ valid_date_max                        date                       Maximum value f
 valid_datetime_min                    datetime                   Minimum value for date and time questions (optional)
 valid_datetime_max                    datetime                   Maximum value for date and time questions (optional)
 valid_file_portrait                   boolean                    Turn on file validation for portrait photos
+valid_string_length_max               integer                    Maximum length for string questions (optional)
 dependency_question                   integer                    Internal ID of a different question. The current
                                                                  question will only be shown if the question given in
                                                                  this attribute is set to the value given in
@@ -76,26 +79,13 @@ dependency_value                      string                     An old version
                                                                  for one value. **Deprecated.**
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 3.5
+.. versionchanged:: 2023.8
 
-  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.
+   The ``show_during_checkin`` attribute has 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.
@@ -131,6 +121,7 @@ Endpoints
             "position": 1,
             "identifier": "WY3TP9SL",
             "ask_during_checkin": false,
+            "show_during_checkin": false,
             "hidden": false,
             "print_on_invoice": false,
             "valid_number_min": null,
@@ -139,6 +130,7 @@ Endpoints
             "valid_date_max": null,
             "valid_datetime_min": null,
             "valid_datetime_max": null,
+            "valid_string_length_max": null,
             "valid_file_portrait": false,
             "dependency_question": null,
             "dependency_value": null,
@@ -209,6 +201,7 @@ Endpoints
         "position": 1,
         "identifier": "WY3TP9SL",
         "ask_during_checkin": false,
+        "show_during_checkin": false,
         "hidden": false,
         "print_on_invoice": false,
         "valid_number_min": null,
@@ -218,6 +211,7 @@ Endpoints
         "valid_datetime_min": null,
         "valid_datetime_max": null,
         "valid_file_portrait": false,
+        "valid_string_length_max": null,
         "dependency_question": null,
         "dependency_value": null,
         "dependency_values": [],
@@ -271,6 +265,7 @@ Endpoints
         "items": [1, 2],
         "position": 1,
         "ask_during_checkin": false,
+        "show_during_checkin": false,
         "hidden": false,
         "print_on_invoice": false,
         "dependency_question": null,
@@ -307,6 +302,7 @@ Endpoints
         "position": 1,
         "identifier": "WY3TP9SL",
         "ask_during_checkin": false,
+        "show_during_checkin": false,
         "hidden": false,
         "print_on_invoice": false,
         "dependency_question": null,
@@ -319,6 +315,7 @@ Endpoints
         "valid_datetime_min": null,
         "valid_datetime_max": null,
         "valid_file_portrait": false,
+        "valid_string_length_max": null,
         "options": [
           {
             "id": 1,
@@ -361,7 +358,7 @@ Endpoints
 
    .. sourcecode:: http
 
-      PATCH /api/v1/organizers/bigevents/events/sampleconf/items/1/ HTTP/1.1
+      PATCH /api/v1/organizers/bigevents/events/sampleconf/questions/1/ HTTP/1.1
       Host: pretix.eu
       Accept: application/json, text/javascript
       Content-Type: application/json
@@ -389,6 +386,7 @@ Endpoints
         "position": 2,
         "identifier": "WY3TP9SL",
         "ask_during_checkin": false,
+        "show_during_checkin": false,
         "hidden": false,
         "print_on_invoice": false,
         "dependency_question": null,
@@ -401,6 +399,7 @@ Endpoints
         "valid_datetime_min": null,
         "valid_datetime_max": null,
         "valid_file_portrait": false,
+        "valid_string_length_max": null,
         "options": [
           {
             "id": 1,
@@ -427,7 +426,7 @@ Endpoints
    :param event: The ``slug`` field of the event to modify
    :param id: The ``id`` field of the question to modify
    :statuscode 200: no error
-   :statuscode 400: The item could not be modified due to invalid submitted data
+   :statuscode 400: The question 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.
 
@@ -439,7 +438,7 @@ Endpoints
 
    .. sourcecode:: http
 
-      DELETE /api/v1/organizers/bigevents/events/sampleconf/items/1/ HTTP/1.1
+      DELETE /api/v1/organizers/bigevents/events/sampleconf/questions/1/ HTTP/1.1
       Host: pretix.eu
       Accept: application/json, text/javascript
 
@@ -452,7 +451,7 @@ Endpoints
 
    :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 item to delete
+   :param id: The ``id`` field of the question 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/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/reusablemedia.rst

@@ -0,0 +1,327 @@
+.. _`rest-reusablemedia`:
+
+Reusable media
+==============
+
+Reusable media represent things, typically physical tokens like plastic cards or NFC wristbands, which can represent
+other entities inside the system. For example, a medium can link to an order position or to a gift card and can be used
+in their place. Later, the medium might be reused for a different ticket.
+
+Resource description
+--------------------
+
+The reusable medium resource contains the following public fields:
+
+.. rst-class:: rest-resource-table
+
+===================================== ========================== =======================================================
+Field                                 Type                       Description
+===================================== ========================== =======================================================
+id                                    integer                    Internal ID of the medium
+type                                  string                     Type of medium, e.g. ``"barcode"``, ``"nfc_uid"`` or ``"nfc_mf0aes"``.
+organizer                             string                     Organizer slug of the organizer who "owns" this medium.
+identifier                            string                     Unique identifier of the medium. The format depends on the ``type``.
+active                                boolean                    Whether this medium may be used.
+created                               datetime                   Date of creation
+updated                               datetime                   Date of last modification
+expires                               datetime                   Expiry date (or ``null``)
+customer                              string                     Identifier of a customer account this medium belongs to.
+linked_orderposition                  integer                    Internal ID of a ticket this medium is linked to.
+linked_giftcard                       integer                    Internal ID of a gift card this medium is linked to.
+info                                  object                     Additional data, content depends on the ``type``. Consider
+                                                                 this internal to the system and don't use it for your own data.
+notes                                 string                     Internal notes and comments (or ``null``)
+===================================== ========================== =======================================================
+
+Existing media types are:
+
+- ``barcode``
+- ``nfc_uid``
+- ``nfc_mf0aes``
+
+Endpoints
+---------
+
+.. http:get:: /api/v1/organizers/(organizer)/reusablemedia/
+
+   Returns a list of all media issued by a given organizer.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/reusablemedia/ 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,
+            "organizer": "bigevents",
+            "identifier": "ABCDEFGH",
+            "created": "2021-04-06T13:44:22.809377Z",
+            "updated": "2021-04-06T13:44:22.809377Z",
+            "type": "barcode",
+            "active": True,
+            "expires": None,
+            "customer": None,
+            "linked_orderposition": None,
+            "linked_giftcard": None,
+            "notes": None,
+            "info": {}
+          }
+        ]
+      }
+
+   :query integer page: The page number in case of a multi-page result set, default is 1.
+   :query string identifier: Only show media with the given identifier. Note that you should use the lookup endpoint described below for most use cases.
+   :query string type: Only show media with the given type.
+   :query boolean active: Only show media that are (not) active.
+   :query string customer: Only show media linked to the given customer.
+   :query string created_since: Only show media created since a given date.
+   :query string updated_since: Only show media updated since a given date.
+   :query integer linked_orderposition: Only show media linked to the given ticket.
+   :query integer linked_giftcard: Only show media linked to the given gift card.
+   :query string expand: If you pass ``"linked_giftcard"``, ``"linked_giftcard.owner_ticket"``, ``"linked_orderposition"``,
+                         or ``"customer"``, the respective field will be shown as a nested value instead of just an ID.
+                         The nested objects are identical to the respective resources, except that order positions
+                         will have an attribute of the format ``"order": {"code": "ABCDE", "event": "eventslug"}`` to make
+                         matching easier. The parameter can be given multiple times.
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to view this resource.
+
+.. http:get:: /api/v1/organizers/(organizer)/reusablemedia/(id)/
+
+   Returns information on one medium, identified by its ID.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/reusablemedia/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,
+        "organizer": "bigevents",
+        "identifier": "ABCDEFGH",
+        "created": "2021-04-06T13:44:22.809377Z",
+        "updated": "2021-04-06T13:44:22.809377Z",
+        "type": "barcode",
+        "active": True,
+        "expires": None,
+        "customer": None,
+        "linked_orderposition": None,
+        "linked_giftcard": None,
+        "notes": None,
+        "info": {}
+      }
+
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :param id: The ``id`` field of the medium to fetch
+   :query string expand: If you pass ``"linked_giftcard"``, ``"linked_giftcard.owner_ticket"``, ``"linked_orderposition"``,
+                         or ``"customer"``, the respective field will be shown as a nested value instead of just an ID.
+                         The nested objects are identical to the respective resources, except that order positions
+                         will have an attribute of the format ``"order": {"code": "ABCDE", "event": "eventslug"}`` to make
+                         matching easier. The parameter can be given multiple times.
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to view this resource.
+
+.. http:post:: /api/v1/organizers/(organizer)/reusablemedia/lookup/
+
+   Look up a new reusable medium by its identifier. In some cases, this might lead to the automatic creation of a new
+   medium behind the scenes.
+
+   This endpoint, and this endpoint only, might return media from a different organizer if there is a cross-acceptance
+   agreement. In this case, only linked gift cards will be returned, no order position or customer records,
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/reusablemedia/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+
+      {
+        "identifier": "ABCDEFGH",
+        "type": "barcode",
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "id": 1,
+        "organizer": "bigevents",
+        "identifier": "ABCDEFGH",
+        "created": "2021-04-06T13:44:22.809377Z",
+        "updated": "2021-04-06T13:44:22.809377Z",
+        "type": "barcode",
+        "active": True,
+        "expires": None,
+        "customer": None,
+        "linked_orderposition": None,
+        "linked_giftcard": None,
+        "notes": None,
+        "info": {}
+      }
+
+   :param organizer: The ``slug`` field of the organizer to look up a medium for
+   :query string expand: If you pass ``"linked_giftcard"``, ``"linked_orderposition"``, oder ``"customer"``, the respective
+                         field will be shown as a nested value instead of just an ID. The nested objects are identical to
+                         the respective resources, except that the ``linked_orderposition`` will have an attribute of the
+                         format ``"order": {"code": "ABCDE", "event": "eventslug"}`` to make matching easier. The parameter
+                         can be given multiple times.
+   :statuscode 201: no error
+   :statuscode 400: The medium could not be looked up due to invalid submitted data.
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to create this resource.
+
+.. http:post:: /api/v1/organizers/(organizer)/reusablemedia/
+
+   Creates a new reusable medium.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/reusablemedia/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+
+      {
+        "identifier": "ABCDEFGH",
+        "type": "barcode",
+        "active": True,
+        "expires": None,
+        "customer": None,
+        "linked_orderposition": None,
+        "linked_giftcard": None,
+        "notes": None,
+        "info": {}
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 201 Created
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "id": 1,
+        "organizer": "bigevents",
+        "identifier": "ABCDEFGH",
+        "created": "2021-04-06T13:44:22.809377Z",
+        "updated": "2021-04-06T13:44:22.809377Z",
+        "type": "barcode",
+        "active": True,
+        "expires": None,
+        "customer": None,
+        "linked_orderposition": None,
+        "linked_giftcard": None,
+        "notes": None,
+        "info": {}
+      }
+
+   :param organizer: The ``slug`` field of the organizer to create a medium for
+   :query string expand: If you pass ``"linked_giftcard"``, ``"linked_orderposition"``, oder ``"customer"``, the respective
+                         field will be shown as a nested value instead of just an ID. The nested objects are identical to
+                         the respective resources, except that the ``linked_orderposition`` will have an attribute of the
+                         format ``"order": {"code": "ABCDE", "event": "eventslug"}`` to make matching easier. The parameter
+                         can be given multiple times.
+   :statuscode 201: no error
+   :statuscode 400: The medium could not be created due to invalid submitted data.
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to create this resource.
+
+.. http:patch:: /api/v1/organizers/(organizer)/reusablemedia/(id)/
+
+   Update a reusable medium. 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``, ``identifier`` and ``type`` fields.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      PATCH /api/v1/organizers/bigevents/reusablemedia/1/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+      Content-Length: 94
+
+      {
+        "linked_orderposition": 13
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "id": 1,
+        "organizer": "bigevents",
+        "identifier": "ABCDEFGH",
+        "created": "2021-04-06T13:44:22.809377Z",
+        "updated": "2021-04-06T13:44:22.809377Z",
+        "type": "barcode",
+        "active": True,
+        "expires": None,
+        "customer": None,
+        "linked_orderposition": 13,
+        "linked_giftcard": None,
+        "notes": None,
+        "info": {}
+      }
+
+   :param organizer: The ``slug`` field of the organizer to modify
+   :param id: The ``id`` field of the medium to modify
+   :query string expand: If you pass ``"linked_giftcard"``, ``"linked_orderposition"``, oder ``"customer"``, the respective
+                         field will be shown as a nested value instead of just an ID. The nested objects are identical to
+                         the respective resources, except that the ``linked_orderposition`` will have an attribute of the
+                         format ``"order": {"code": "ABCDE", "event": "eventslug"}`` to make matching easier. The parameter
+                         can be given multiple times.
+   :statuscode 200: no error
+   :statuscode 400: The medium could not be modified due to invalid submitted data
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to change this resource.

doc/api/resources/scheduled_exports.rst

@@ -0,0 +1,556 @@
+.. spelling:word-list:: checkin
+
+Scheduled data exports
+======================
+
+pretix and it's plugins include a number of data exporters that allow you to bulk download various data from pretix in
+different formats. You should read :ref:`rest-exporters` first to get an understanding of the basic mechanism.
+
+Exports can be scheduled to be sent at specific times automatically, both on organizer level and event level.
+
+Scheduled export resource
+-------------------------
+
+The scheduled export contains the following public fields:
+
+.. rst-class:: rest-resource-table
+
+===================================== ========================== =======================================================
+Field                                 Type                       Description
+===================================== ========================== =======================================================
+id                                    integer                    Internal ID of the schedule
+owner                                 string                     Email address of the user who created this schedule (read-only).
+                                                                 This address will always receive the export and the export
+                                                                 will only contain data that this user has permission
+                                                                 to access at the time of the export. **We consider this
+                                                                 field experimental, it's behaviour might change in the future.
+                                                                 Note that the email address of a user can change at any time.**
+export_identifier                     string                     Identifier of the export to run, see :ref:`rest-exporters`
+export_form_data                      object                     Input data for the export, format depends on the export,
+                                                                 see :ref:`rest-exporters` for more details.
+locale                                string                     Language to run the export in
+mail_additional_recipients            string                     Email addresses to receive the export, comma-separated (or empty string)
+mail_additional_recipients_cc         string                     Email addresses to receive the export in copy, comma-separated (or empty string)
+mail_additional_recipients_bcc        string                     Email addresses to receive the exportin blind copy, comma-separated (or empty string)
+mail_subject                          string                     Subject to use for the email (currently no variables supported)
+mail_template                         string                     Text to use for the email (currently no variables supported)
+schedule_rrule                        string                     Recurrence specification to determine the **days** this
+                                                                 schedule runs on in ``RRULE`` syntax following `RFC 5545`_
+                                                                 with some restrictions. Only one rule is allowed, only
+                                                                 one occurrence per day is allowed, and some features
+                                                                 are not supported (``BYMONTHDAY``, ``BYYEARDAY``,
+                                                                 ``BYEASTER``, ``BYWEEKNO``).
+schedule_rrule_time                   time                       Time of day to run this on on the specified days.
+                                                                 Will be interpreted as local time of the event for event-level
+                                                                 exports. For organizer-level exports, the timezone is given
+                                                                 in the field ``timezone``. The export will never run **before**
+                                                                 this time but it **may** run **later**.
+timezone                              string                     Time zone to interpret the schedule in (only for organizer-level exports)
+schedule_next_run                     datetime                   Next planned execution (read-only, computed by server)
+error_counter                         integer                    Number of consecutive times this export failed (read-only).
+                                                                 After a number of failures (currently 5), the schedule no
+                                                                 longer is executed. Changing parameters resets the value.
+===================================== ========================== =======================================================
+
+Special notes on permissions
+----------------------------
+
+Permission handling for scheduled exports is more complex than for most other objects. The reason for this is that
+there are two levels of access control involved here: First, you need permission to access or change the configuration
+of the scheduled exports in the moment you are doing it. Second, you **continuously** need permission to access the
+**data** that is exported as part of the schedule. For this reason, scheduled exports always need one user account
+to be their **owner**.
+
+Therefore, scheduled exports **must** be created by an API client using :ref:`OAuth authentication <rest-oauth>`.
+It is impossible to create a scheduled export using token authentication. After the export is created, it can also be
+modified using token authentication.
+
+A user or token with the "can change settings" permission for a given organizer or event can see and change
+**all** scheduled exports created for the respective organizer or event, regardless of who created them.
+A user without this permission can only see **their own** scheduled exports.
+A token without this permission can not see scheduled exports as all.
+
+
+
+Endpoints for event exports
+---------------------------
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/scheduled_exports/
+
+   Returns a list of all scheduled exports the client has access to.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/scheduled_exports/ 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,
+            "owner": "john@example.com",
+            "export_identifier": "orderlist",
+            "export_form_data": {"_format": "xlsx", "date_range": "week_previous"},
+            "locale": "en",
+            "mail_additional_recipients": "mary@example.org",
+            "mail_additional_recipients_cc": "",
+            "mail_additional_recipients_bcc": "",
+            "mail_subject": "Order list",
+            "mail_template": "Here is last week's order list\n\nCheers\nJohn",
+            "schedule_rrule": "DTSTART:20230118T000000\nRRULE:FREQ=WEEKLY;BYDAY=TU,WE,TH",
+            "schedule_rrule_time": "04:00:00",
+            "schedule_next_run": "2023-10-26T02:00:00Z",
+            "error_counter": 0
+          }
+        ]
+      }
+
+   :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``, ``export_identifier``, and ``schedule_next_run``.
+                           Default: ``id``
+   :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)/scheduled_exports/(id)/
+
+   Returns information on one scheduled export, identified by its ID.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/scheduled_exports/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,
+        "owner": "john@example.com",
+        "export_identifier": "orderlist",
+        "export_form_data": {"_format": "xlsx", "date_range": "week_previous"},
+        "locale": "en",
+        "mail_additional_recipients": "mary@example.org",
+        "mail_additional_recipients_cc": "",
+        "mail_additional_recipients_bcc": "",
+        "mail_subject": "Order list",
+        "mail_template": "Here is last week's order list\n\nCheers\nJohn",
+        "schedule_rrule": "DTSTART:20230118T000000\nRRULE:FREQ=WEEKLY;BYDAY=TU,WE,TH",
+        "schedule_rrule_time": "04:00:00",
+        "schedule_next_run": "2023-10-26T02:00:00Z",
+        "error_counter": 0
+      }
+
+   :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 scheduled export 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)/scheduled_exports/
+
+   Schedule a new export.
+
+   .. note:: See above for special notes on permissions.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/scheduled_exports/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+
+      {
+        "export_identifier": "orderlist",
+        "export_form_data": {"_format": "xlsx", "date_range": "week_previous"},
+        "locale": "en",
+        "mail_additional_recipients": "mary@example.org",
+        "mail_additional_recipients_cc": "",
+        "mail_additional_recipients_bcc": "",
+        "mail_subject": "Order list",
+        "mail_template": "Here is last week's order list\n\nCheers\nJohn",
+        "schedule_rrule": "DTSTART:20230118T000000\nRRULE:FREQ=WEEKLY;BYDAY=TU,WE,TH",
+        "schedule_rrule_time": "04:00:00"
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 201 Created
+      Vary: Accept
+      Content-Type: application/json
+
+
+      {
+        "id": 1,
+        "owner": "john@example.com",
+        "export_identifier": "orderlist",
+        "export_form_data": {"_format": "xlsx", "date_range": "week_previous"},
+        "locale": "en",
+        "mail_additional_recipients": "mary@example.org",
+        "mail_additional_recipients_cc": "",
+        "mail_additional_recipients_bcc": "",
+        "mail_subject": "Order list",
+        "mail_template": "Here is last week's order list\n\nCheers\nJohn",
+        "schedule_rrule": "DTSTART:20230118T000000\nRRULE:FREQ=WEEKLY;BYDAY=TU,WE,TH",
+        "schedule_rrule_time": "04:00:00",
+        "schedule_next_run": "2023-10-26T02:00:00Z",
+        "error_counter": 0
+      }
+
+   :param organizer: The ``slug`` field of the organizer of the event to create an item for
+   :param event: The ``slug`` field of the event to create an item for
+   :statuscode 201: no error
+   :statuscode 400: The item 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)/scheduled_exports/(id)/
+
+   Update a scheduled export. 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/scheduled_exports/1/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+      Content-Length: 94
+
+      {
+        "export_form_data": {"_format": "xlsx", "date_range": "week_this"},
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "id": 1,
+        "owner": "john@example.com",
+        "export_identifier": "orderlist",
+        "export_form_data": {"_format": "xlsx", "date_range": "week_this"},
+        "locale": "en",
+        "mail_additional_recipients": "mary@example.org",
+        "mail_additional_recipients_cc": "",
+        "mail_additional_recipients_bcc": "",
+        "mail_subject": "Order list",
+        "mail_template": "Here is last week's order list\n\nCheers\nJohn",
+        "schedule_rrule": "DTSTART:20230118T000000\nRRULE:FREQ=WEEKLY;BYDAY=TU,WE,TH",
+        "schedule_rrule_time": "04:00:00",
+        "schedule_next_run": "2023-10-26T02:00:00Z",
+        "error_counter": 0
+      }
+
+   :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 export to modify
+   :statuscode 200: no error
+   :statuscode 400: The export 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)/scheduled_exports/(id)/
+
+   Delete a scheduled export.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      DELETE /api/v1/organizers/bigevents/events/sampleconf/scheduled_exports/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 export 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.
+
+Endpoints for organizer exports
+---------------------------
+
+.. http:get:: /api/v1/organizers/(organizer)/scheduled_exports/
+
+   Returns a list of all scheduled exports the client has access to.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/scheduled_exports/ 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,
+            "owner": "john@example.com",
+            "export_identifier": "orderlist",
+            "export_form_data": {"_format": "xlsx", "date_range": "week_previous"},
+            "locale": "en",
+            "mail_additional_recipients": "mary@example.org",
+            "mail_additional_recipients_cc": "",
+            "mail_additional_recipients_bcc": "",
+            "mail_subject": "Order list",
+            "mail_template": "Here is last week's order list\n\nCheers\nJohn",
+            "schedule_rrule": "DTSTART:20230118T000000\nRRULE:FREQ=WEEKLY;BYDAY=TU,WE,TH",
+            "schedule_rrule_time": "04:00:00",
+            "schedule_next_run": "2023-10-26T02:00:00Z",
+            "timezone": "Europe/Berlin",
+            "error_counter": 0
+          }
+        ]
+      }
+
+   :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``, ``export_identifier``, and ``schedule_next_run``.
+                           Default: ``id``
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to view this resource.
+
+.. http:get:: /api/v1/organizers/(organizer)/scheduled_exports/(id)/
+
+   Returns information on one scheduled export, identified by its ID.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/scheduled_exports/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,
+        "owner": "john@example.com",
+        "export_identifier": "orderlist",
+        "export_form_data": {"_format": "xlsx", "date_range": "week_previous"},
+        "locale": "en",
+        "mail_additional_recipients": "mary@example.org",
+        "mail_additional_recipients_cc": "",
+        "mail_additional_recipients_bcc": "",
+        "mail_subject": "Order list",
+        "mail_template": "Here is last week's order list\n\nCheers\nJohn",
+        "schedule_rrule": "DTSTART:20230118T000000\nRRULE:FREQ=WEEKLY;BYDAY=TU,WE,TH",
+        "schedule_rrule_time": "04:00:00",
+        "schedule_next_run": "2023-10-26T02:00:00Z",
+        "timezone": "Europe/Berlin",
+        "error_counter": 0
+      }
+
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :param id: The ``id`` field of the scheduled export to fetch
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to view this resource.
+
+.. http:post:: /api/v1/organizers/(organizer)/scheduled_exports/
+
+   Schedule a new export.
+
+   .. note:: See above for special notes on permissions.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/scheduled_exports/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+
+      {
+        "export_identifier": "orderlist",
+        "export_form_data": {"_format": "xlsx", "date_range": "week_previous"},
+        "locale": "en",
+        "mail_additional_recipients": "mary@example.org",
+        "mail_additional_recipients_cc": "",
+        "mail_additional_recipients_bcc": "",
+        "mail_subject": "Order list",
+        "mail_template": "Here is last week's order list\n\nCheers\nJohn",
+        "schedule_rrule": "DTSTART:20230118T000000\nRRULE:FREQ=WEEKLY;BYDAY=TU,WE,TH",
+        "schedule_rrule_time": "04:00:00",
+        "timezone": "Europe/Berlin"
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 201 Created
+      Vary: Accept
+      Content-Type: application/json
+
+
+      {
+        "id": 1,
+        "owner": "john@example.com",
+        "export_identifier": "orderlist",
+        "export_form_data": {"_format": "xlsx", "date_range": "week_previous"},
+        "locale": "en",
+        "mail_additional_recipients": "mary@example.org",
+        "mail_additional_recipients_cc": "",
+        "mail_additional_recipients_bcc": "",
+        "mail_subject": "Order list",
+        "mail_template": "Here is last week's order list\n\nCheers\nJohn",
+        "schedule_rrule": "DTSTART:20230118T000000\nRRULE:FREQ=WEEKLY;BYDAY=TU,WE,TH",
+        "schedule_rrule_time": "04:00:00",
+        "schedule_next_run": "2023-10-26T02:00:00Z",
+        "timezone": "Europe/Berlin",
+        "error_counter": 0
+      }
+
+   :param organizer: The ``slug`` field of the organizer of the event to create an item for
+   :statuscode 201: no error
+   :statuscode 400: The item could not be created due to invalid submitted data.
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to create this resource.
+
+.. http:patch:: /api/v1/organizers/(organizer)/scheduled_exports/(id)/
+
+   Update a scheduled export. 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/scheduled_exports/1/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+      Content-Length: 94
+
+      {
+        "export_form_data": {"_format": "xlsx", "date_range": "week_this"},
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "id": 1,
+        "owner": "john@example.com",
+        "export_identifier": "orderlist",
+        "export_form_data": {"_format": "xlsx", "date_range": "week_this"},
+        "locale": "en",
+        "mail_additional_recipients": "mary@example.org",
+        "mail_additional_recipients_cc": "",
+        "mail_additional_recipients_bcc": "",
+        "mail_subject": "Order list",
+        "mail_template": "Here is last week's order list\n\nCheers\nJohn",
+        "schedule_rrule": "DTSTART:20230118T000000\nRRULE:FREQ=WEEKLY;BYDAY=TU,WE,TH",
+        "schedule_rrule_time": "04:00:00",
+        "schedule_next_run": "2023-10-26T02:00:00Z",
+        "timezone": "Europe/Berlin",
+        "error_counter": 0
+      }
+
+   :param organizer: The ``slug`` field of the organizer to modify
+   :param id: The ``id`` field of the export to modify
+   :statuscode 200: no error
+   :statuscode 400: The export could not be modified due to invalid submitted data
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to change this resource.
+
+.. http:delete:: /api/v1/organizers/(organizer)/scheduled_exports/(id)/
+
+   Delete a scheduled export.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      DELETE /api/v1/organizers/bigevents/scheduled_exports/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 id: The ``id`` field of the export to delete
+   :statuscode 204: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to delete this resource.
+
+
+.. _RFC 5545: https://datatracker.ietf.org/doc/html/rfc5545#section-3.8.5.3

doc/api/resources/sendmail_rules.rst

@@ -1,10 +1,10 @@
-Automated email rules
+Scheduled email rules
 =====================
 
 Resource description
 --------------------
 
-Automated email rules that specify emails that the system will send automatically at a specific point in time, e.g.
+Scheduled 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
@@ -18,8 +18,19 @@ subject                               multi-lingual string       The subject of
 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``,
+[**DEPRECATED**] include_pending      boolean                    If ``true``, the email is sent to pending orders. If ``false``,
                                                                  only paid orders are considered.
+restrict_to_status                    list                       List of order states to restrict recipients to. Valid
+                                                                 entries are ``p`` for paid, ``e`` for expired, ``c`` for canceled,
+                                                                 ``n__pending_approval`` for pending approval,
+                                                                 ``n__not_pending_approval_and_not_valid_if_pending`` for payment
+                                                                 pending, ``n__valid_if_pending`` for payment pending but already confirmed,
+                                                                 and ``n__pending_overdue`` for pending with payment overdue.
+                                                                 The default is ``["p", "n__valid_if_pending"]``.
+checked_in_status                     string                     Check-in status to restrict recipients to. Valid strings are:
+                                                                 ``null`` for no filtering (default), ``checked_in`` for
+                                                                 limiting to attendees that are or have been checked in, and
+                                                                 ``no_checkin`` for limiting to attendees who have not checked in.
 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
@@ -37,7 +48,10 @@ send_to                               string                     Can be ``"order
                                                                  or ``"both"``.
                                                                  date. Otherwise it is relative to the event start date.
 ===================================== ========================== =======================================================
+.. versionchanged:: 2023.7
 
+    The ``include_pending`` field has been  deprecated.
+    The ``restrict_to_status`` field has been added.
 
 Endpoints
 ---------
@@ -74,7 +88,12 @@ Endpoints
             "template": {"en": "Don't forget your tickets, download them at {url}"},
             "all_products": true,
             "limit_products": [],
-            "include_pending": false,
+            "restrict_to_status": [
+                "p",
+                "n__not_pending_approval_and_not_valid_if_pending",
+                "n__valid_if_pending"
+            ],
+            "checked_in_status": null,
             "send_date": null,
             "send_offset_days": 1,
             "send_offset_time": "18:00",
@@ -120,7 +139,12 @@ Endpoints
         "template": {"en": "Don't forget your tickets, download them at {url}"},
         "all_products": true,
         "limit_products": [],
-        "include_pending": false,
+        "restrict_to_status": [
+            "p",
+            "n__not_pending_approval_and_not_valid_if_pending",
+            "n__valid_if_pending"
+        ],
+        "checked_in_status": null,
         "send_date": null,
         "send_offset_days": 1,
         "send_offset_time": "18:00",
@@ -157,7 +181,12 @@ Endpoints
         "template": {"en": "Don't forget your tickets, download them at {url}"},
         "all_products": true,
         "limit_products": [],
-        "include_pending": false,
+        "restrict_to_status": [
+            "p",
+            "n__not_pending_approval_and_not_valid_if_pending",
+            "n__valid_if_pending"
+        ],
+        "checked_in_status": "checked_in",
         "send_date": null,
         "send_offset_days": 1,
         "send_offset_time": "18:00",
@@ -182,7 +211,12 @@ Endpoints
         "template": {"en": "Don't forget your tickets, download them at {url}"},
         "all_products": true,
         "limit_products": [],
-        "include_pending": false,
+        "restrict_to_status": [
+            "p",
+            "n__not_pending_approval_and_not_valid_if_pending",
+            "n__valid_if_pending"
+        ],
+        "checked_in_status": "checked_in",
         "send_date": null,
         "send_offset_days": 1,
         "send_offset_time": "18:00",
@@ -235,7 +269,12 @@ Endpoints
         "template": {"en": "Don't forget your tickets, download them at {url}"},
         "all_products": true,
         "limit_products": [],
-        "include_pending": false,
+        "restrict_to_status": [
+            "p",
+            "n__not_pending_approval_and_not_valid_if_pending",
+            "n__valid_if_pending"
+        ],
+        "checked_in_status": "checked_in",
         "send_date": null,
         "send_offset_days": 1,
         "send_offset_time": "18:00",

doc/api/resources/shredders.rst

@@ -0,0 +1,177 @@
+.. spelling:word-list:: 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

@@ -1,4 +1,4 @@
-.. spelling::
+.. spelling:word-list::
 
    geo
    lat
@@ -59,29 +59,22 @@ 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.
+    The ``search`` query parameter has been added to filter sub-events by their name or location in any language.
 
-.. versionchanged:: 3.10
+.. versionchanged:: 5.0
 
-   The ``disabled`` attribute has been added to ``item_price_overrides`` and ``variation_price_overrides``.
+    The ``date_from_before``, ``date_from_after``, ``date_to_before``, and ``date_to_after`` query parameters have been
+    added.
 
-.. versionchanged:: 3.12
+.. versionchanged:: 2023.8.0
 
-   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``.
+    For the organizer-wide endpoint, the ``search`` query parameter has been modified to filter sub-events by their parent events slug too.
 
 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.
@@ -146,7 +139,12 @@ Endpoints
    :query active: If set to ``true``/``false``, only events with a matching value of ``active`` are returned.
    :query is_future: If set to ``true`` (``false``), only events that happen currently or in the future are (not) returned.
    :query is_past: If set to ``true`` (``false``), only events that are over are (not) returned.
+   :query date_from_after: If set to a date and time, only events that start at or after the given time are returned.
+   :query date_from_before: If set to a date and time, only events that start at or before the given time are returned.
+   :query date_to_after: If set to a date and time, only events that have an end date and end at or after the given time are returned.
+   :query date_to_before: If set to a date and time, only events that have an end date and end at or before the given time are 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
@@ -473,7 +471,13 @@ Endpoints
    :query event__live: If set to ``true``/``false``, only events with a matching value of ``live`` on the parent event are returned.
    :query is_future: If set to ``true`` (``false``), only events that happen currently or in the future are (not) returned.
    :query is_past: If set to ``true`` (``false``), only events that are over are (not) returned.
+   :query date_from_after: If set to a date and time, only events that start at or after the given time are returned.
+   :query date_from_before: If set to a date and time, only events that start at or before the given time are returned.
+   :query date_to_after: If set to a date and time, only events that have an end date and end at or after the given time are returned.
+   :query date_to_before: If set to a date and time, only events that have an end date and end at or before the given time are 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.
+   :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

@@ -20,11 +20,16 @@ internal_name                         string                     An optional nam
 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
+eu_reverse_charge                     boolean                    If ``true``, EU reverse charge rules are applied. Will
+                                                                 be ignored if custom rules are set.
 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``)
+custom_rules                          object                     Dynamic rules specification. Each list element
+                                                                 corresponds to one rule that will be processed in order.
+                                                                 The current version of the schema in use can be found
+                                                                 `here`_.
 ===================================== ========================== =======================================================
 
 
@@ -32,6 +37,10 @@ keep_gross_if_rate_changes            boolean                    If ``true``, ch
 
     The ``internal_name`` and ``keep_gross_if_rate_changes`` attributes have been added.
 
+.. versionchanged:: 2023.6
+
+    The ``custom_rules`` attribute has been added.
+
 Endpoints
 ---------
 
@@ -68,6 +77,7 @@ Endpoints
             "price_includes_tax": true,
             "eu_reverse_charge": false,
             "keep_gross_if_rate_changes": false,
+            "custom_rules": null,
             "home_country": "DE"
           }
         ]
@@ -108,6 +118,7 @@ Endpoints
         "price_includes_tax": true,
         "eu_reverse_charge": false,
         "keep_gross_if_rate_changes": false,
+        "custom_rules": null,
         "home_country": "DE"
       }
 
@@ -156,6 +167,7 @@ Endpoints
         "price_includes_tax": true,
         "eu_reverse_charge": false,
         "keep_gross_if_rate_changes": false,
+        "custom_rules": null,
         "home_country": "DE"
       }
 
@@ -203,6 +215,7 @@ Endpoints
         "price_includes_tax": true,
         "eu_reverse_charge": false,
         "keep_gross_if_rate_changes": false,
+        "custom_rules": null,
         "home_country": "DE"
       }
 
@@ -242,3 +255,5 @@ Endpoints
    :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 tax rule cannot be deleted since it is currently in use.
+
+.. _here: https://github.com/pretix/pretix/blob/master/src/pretix/static/schema/tax-rules-custom.schema.json

doc/api/resources/teams.rst

@@ -1,4 +1,4 @@
-.. spelling:: fullname checkin
+.. spelling:word-list:: fullname checkin
 
 .. _`rest-teams`:
 
@@ -22,10 +22,13 @@ id                                    integer                    Internal ID of
 name                                  string                     Team name
 all_events                            boolean                    Whether this team has access to all events
 limit_events                          list                       List of event slugs this team has access to
+require_2fa                           boolean                    Whether members of this team are required to use
+                                                                 two-factor authentication
 can_create_events                     boolean
 can_change_teams                      boolean
 can_change_organizer_settings         boolean
 can_manage_customers                  boolean
+can_manage_reusable_media             boolean
 can_manage_gift_cards                 boolean
 can_change_event_settings             boolean
 can_change_items                      boolean
@@ -36,6 +39,10 @@ can_change_vouchers                   boolean
 can_checkin_orders                    boolean
 ===================================== ========================== =======================================================
 
+.. versionchanged:: 4.18
+
+    The ``can_manage_reusable_media`` permission has been added.
+
 Team member resource
 --------------------
 
@@ -117,6 +124,7 @@ Team endpoints
             "name": "Admin team",
             "all_events": true,
             "limit_events": [],
+            "require_2fa": true,
             "can_create_events": true,
             ...
           }
@@ -154,6 +162,7 @@ Team endpoints
         "name": "Admin team",
         "all_events": true,
         "limit_events": [],
+        "require_2fa": true,
         "can_create_events": true,
         ...
       }
@@ -181,6 +190,7 @@ Team endpoints
         "name": "Admin team",
         "all_events": true,
         "limit_events": [],
+        "require_2fa": true,
         "can_create_events": true,
         ...
       }
@@ -198,6 +208,7 @@ Team endpoints
         "name": "Admin team",
         "all_events": true,
         "limit_events": [],
+        "require_2fa": true,
         "can_create_events": true,
         ...
       }
@@ -241,6 +252,7 @@ Team endpoints
         "name": "Admin team",
         "all_events": true,
         "limit_events": [],
+        "require_2fa": true,
         "can_create_events": true,
         ...
       }

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
@@ -43,13 +47,11 @@ tag                                   string                     A string that i
 comment                               string                     An internal comment on the voucher
 subevent                              integer                    ID of the date inside an event series this voucher belongs to (or ``null``).
 show_hidden_items                     boolean                    Only if set to ``true``, this voucher allows to buy products with the property ``hide_without_voucher``. Defaults to ``true``.
+all_addons_included                   boolean                    If set to ``true``, all add-on products for the product purchased with this voucher are included in the base price.
+all_bundles_included                  boolean                    If set to ``true``, all bundled products for the product purchased with this voucher are added without their designated price.
 ===================================== ========================== =======================================================
 
 
-.. versionchanged:: 3.4
-
-   The attribute ``seat`` has been added.
-
 Endpoints
 ---------
 
@@ -95,6 +97,9 @@ Endpoints
             "comment": "",
             "seat": null,
             "subevent": null,
+            "show_hidden_items": false,
+            "all_addons_included": false,
+            "all_bundles_included": false
           }
         ]
       }
@@ -161,7 +166,10 @@ Endpoints
         "tag": "testvoucher",
         "comment": "",
         "seat": null,
-        "subevent": null
+        "subevent": null,
+        "show_hidden_items": false,
+        "all_addons_included": false,
+        "all_bundles_included": false
       }
 
    :param organizer: The ``slug`` field of the organizer to fetch
@@ -198,7 +206,10 @@ Endpoints
         "quota": null,
         "tag": "testvoucher",
         "comment": "",
-        "subevent": null
+        "subevent": null,
+        "show_hidden_items": false,
+        "all_addons_included": false,
+        "all_bundles_included": false
       }
 
    **Example response**:
@@ -225,7 +236,10 @@ Endpoints
         "tag": "testvoucher",
         "comment": "",
         "seat": null,
-        "subevent": null
+        "subevent": null,
+        "show_hidden_items": false,
+        "all_addons_included": false,
+        "all_bundles_included": false
       }
 
    :param organizer: The ``slug`` field of the organizer to create a voucher for
@@ -264,7 +278,10 @@ Endpoints
           "quota": null,
           "tag": "testvoucher",
           "comment": "",
-          "subevent": null
+          "subevent": null,
+          "show_hidden_items": false,
+          "all_addons_included": false,
+          "all_bundles_included": false
         },
         {
           "code": "ASDKLJCYXCASDASD",
@@ -279,7 +296,10 @@ Endpoints
           "quota": null,
           "tag": "testvoucher",
           "comment": "",
-          "subevent": null
+          "subevent": null,
+          "show_hidden_items": false,
+          "all_addons_included": false,
+          "all_bundles_included": false
         },
 
    **Example response**:
@@ -353,7 +373,10 @@ Endpoints
         "tag": "testvoucher",
         "comment": "",
         "seat": null,
-        "subevent": null
+        "subevent": null,
+        "show_hidden_items": false,
+        "all_addons_included": false,
+        "all_bundles_included": false
       }
 
    :param organizer: The ``slug`` field of the organizer to modify

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

@@ -26,6 +26,7 @@ limit_events                          list of strings            If ``all_events
 action_types                          list of strings            A list of action type filters that limit the
                                                                  notifications sent to this webhook. See below for
                                                                  valid values
+comment                               string                     Internal comment on this webhook, default ``null``
 ===================================== ========================== =======================================================
 
 The following values for ``action_types`` are valid with pretix core:
@@ -36,12 +37,23 @@ 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.payment.confirmed``
     * ``pretix.event.order.approved``
     * ``pretix.event.order.denied``
+    * ``pretix.event.orders.waitinglist.added``
+    * ``pretix.event.orders.waitinglist.changed``
+    * ``pretix.event.orders.waitinglist.deleted``
+    * ``pretix.event.orders.waitinglist.voucher_assigned``
     * ``pretix.event.checkin``
     * ``pretix.event.checkin.reverted``
     * ``pretix.event.added``
@@ -50,6 +62,14 @@ The following values for ``action_types`` are valid with pretix core:
     * ``pretix.subevent.added``
     * ``pretix.subevent.changed``
     * ``pretix.subevent.deleted``
+    * ``pretix.event.item.*``
+    * ``pretix.event.live.activated``
+    * ``pretix.event.live.deactivated``
+    * ``pretix.event.testmode.activated``
+    * ``pretix.event.testmode.deactivated``
+    * ``pretix.customer.created``
+    * ``pretix.customer.changed``
+    * ``pretix.customer.anonymized``
 
 Installed plugins might register more valid values.
 
@@ -88,7 +108,8 @@ Endpoints
             "target_url": "https://httpstat.us/200",
             "all_events": false,
             "limit_events": ["democon"],
-            "action_types": ["pretix.event.order.modified", "pretix.event.order.changed.*"]
+            "action_types": ["pretix.event.order.modified", "pretix.event.order.changed.*"],
+            "comment": null
           }
         ]
       }
@@ -125,7 +146,8 @@ Endpoints
         "target_url": "https://httpstat.us/200",
         "all_events": false,
         "limit_events": ["democon"],
-        "action_types": ["pretix.event.order.modified", "pretix.event.order.changed.*"]
+        "action_types": ["pretix.event.order.modified", "pretix.event.order.changed.*"],
+        "comment": null
       }
 
    :param organizer: The ``slug`` field of the organizer to fetch
@@ -152,7 +174,8 @@ Endpoints
         "target_url": "https://httpstat.us/200",
         "all_events": false,
         "limit_events": ["democon"],
-        "action_types": ["pretix.event.order.modified", "pretix.event.order.changed.*"]
+        "action_types": ["pretix.event.order.modified", "pretix.event.order.changed.*"],
+        "comment": "Called for changes"
       }
 
    **Example response**:
@@ -169,7 +192,8 @@ Endpoints
         "target_url": "https://httpstat.us/200",
         "all_events": false,
         "limit_events": ["democon"],
-        "action_types": ["pretix.event.order.modified", "pretix.event.order.changed.*"]
+        "action_types": ["pretix.event.order.modified", "pretix.event.order.changed.*"],
+        "comment": "Called for changes"
       }
 
    :param organizer: The ``slug`` field of the organizer to create a webhook for
@@ -214,7 +238,8 @@ Endpoints
         "target_url": "https://httpstat.us/200",
         "all_events": false,
         "limit_events": ["democon"],
-        "action_types": ["pretix.event.order.modified", "pretix.event.order.changed.*"]
+        "action_types": ["pretix.event.order.modified", "pretix.event.order.changed.*"],
+        "comment": null
       }
 
    :param organizer: The ``slug`` field of the organizer to modify

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/conf.py

@@ -13,10 +13,6 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-from docutils.parsers.rst.directives.admonitions import BaseAdmonition
-from sphinx.util import compat
-compat.make_admonition = BaseAdmonition  # See https://github.com/spinus/sphinxcontrib-images/issues/41
-
 import sys
 import os
 
@@ -28,12 +24,13 @@ from datetime import date
 sys.path.insert(0, os.path.abspath('../src'))
 
 import django
+
 os.environ.setdefault("DJANGO_SETTINGS_MODULE", "pretix.testutils.settings")
 django.setup()
 
-
 try:
-    import enchant
+    import enchant  # noqa
+
     HAS_PYENCHANT = True
 except:
     HAS_PYENCHANT = False
@@ -41,7 +38,7 @@ except:
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
+# needs_sphinx = '1.0'
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@@ -52,6 +49,7 @@ extensions = [
     'sphinx.ext.coverage',
     'sphinxcontrib.httpdomain',
     'sphinxcontrib.images',
+    'sphinxcontrib.jquery',
     'sphinxemoji.sphinxemoji',
 ]
 if HAS_PYENCHANT:
@@ -64,7 +62,7 @@ templates_path = ['_templates']
 source_suffix = '.rst'
 
 # The encoding of source files.
-#source_encoding = 'utf-8-sig'
+# source_encoding = 'utf-8-sig'
 
 # The master toctree document.
 master_doc = 'index'
@@ -79,19 +77,20 @@ copyright = '2014-{}, Raphael Michel'.format(date.today().year)
 #
 # The short X.Y version.
 from pretix import __version__
+
 version = '.'.join(__version__.split('.')[:2])
 # The full version, including alpha/beta/rc tags.
 release = __version__
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
-#language = None
+# language = None
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
-#today = ''
+# today = ''
 # Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
+# today_fmt = '%B %d, %Y'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -99,34 +98,34 @@ exclude_patterns = ['_build']
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
-#default_role = None
+# default_role = None
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
+# add_function_parentheses = True
 
 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
-#add_module_names = True
+# add_module_names = True
 
 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
-#show_authors = False
+# show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
 
 # A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
+# modindex_common_prefix = []
 
 # If true, keep warnings as "system message" paragraphs in the built documents.
-#keep_warnings = False
+# keep_warnings = False
 
 
 # -- Options for HTML output ----------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-#html_theme = ""
+# html_theme = ""
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -136,14 +135,14 @@ html_theme_options = {
 }
 
 # Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
+# html_theme_path = []
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-#html_title = None
+# html_title = None
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
-#html_short_title = None
+# html_short_title = None
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
@@ -152,7 +151,7 @@ html_logo = 'images/logo-white.svg'
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
-#html_favicon = None
+# html_favicon = None
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
@@ -166,18 +165,18 @@ html_static_path = [
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied
 # directly to the root of the documentation.
-#html_extra_path = []
+# html_extra_path = []
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
+# html_last_updated_fmt = '%b %d, %Y'
 
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
-#html_use_smartypants = True
+# html_use_smartypants = True
 
 # Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
+# html_sidebars = {}
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
@@ -192,24 +191,24 @@ html_domain_indices = False
 html_use_index = False
 
 # If true, the index is split into individual pages for each letter.
-#html_split_index = False
+# html_split_index = False
 
 # If true, links to the reST sources are added to the pages.
 html_show_sourcelink = True
 
 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
+# html_show_sphinx = True
 
 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
+# html_show_copyright = True
 
 # If true, an OpenSearch description file will be output, and all pages will
 # contain a <link> tag referring to it.  The value of this option must be the
 # base URL from which the finished HTML is served.
-#html_use_opensearch = ''
+# html_use_opensearch = ''
 
 # This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
+# html_file_suffix = None
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'pretixdoc'
@@ -217,47 +216,46 @@ htmlhelp_basename = 'pretixdoc'
 html_theme = 'pretix_theme'
 html_theme_path = [os.path.abspath('_themes')]
 
-
 # -- Options for LaTeX output ---------------------------------------------
 
 latex_elements = {
-# The paper size ('letterpaper' or 'a4paper').
+    # The paper size ('letterpaper' or 'a4paper').
     'papersize': 'a4paper',
 
-# The font size ('10pt', '11pt' or '12pt').
+    # The font size ('10pt', '11pt' or '12pt').
     'pointsize': '10pt',
 
-# Additional stuff for the LaTeX preamble.
-#'preamble': '',
+    # Additional stuff for the LaTeX preamble.
+    # 'preamble': '',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-  ('index', 'pretix.tex', 'pretix Documentation',
-   'Raphael Michel', 'manual'),
+    ('index', 'pretix.tex', 'pretix Documentation',
+     'Raphael Michel', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
-#latex_logo = None
+# latex_logo = None
 
 # For "manual" documents, if this is true, then toplevel headings are parts,
 # not chapters.
-#latex_use_parts = False
+# latex_use_parts = False
 
 # If true, show page references after internal links.
-#latex_show_pagerefs = False
+# latex_show_pagerefs = False
 
 # If true, show URL addresses after external links.
-#latex_show_urls = False
+# latex_show_urls = False
 
 # Documents to append as an appendix to all manuals.
-#latex_appendices = []
+# latex_appendices = []
 
 # If false, no module index is generated.
-#latex_domain_indices = True
+# latex_domain_indices = True
 
 
 # -- Options for manual page output ---------------------------------------
@@ -270,7 +268,7 @@ man_pages = [
 ]
 
 # If true, show URL addresses after external links.
-#man_show_urls = False
+# man_show_urls = False
 
 
 # -- Options for Texinfo output -------------------------------------------
@@ -279,22 +277,22 @@ man_pages = [
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  ('index', 'pretix', 'pretix Documentation',
-   'Raphael Michel', 'pretix', 'One line description of project.',
-   'Miscellaneous'),
+    ('index', 'pretix', 'pretix Documentation',
+     'Raphael Michel', 'pretix', 'One line description of project.',
+     'Miscellaneous'),
 ]
 
 # Documents to append as an appendix to all manuals.
-#texinfo_appendices = []
+# texinfo_appendices = []
 
 # If false, no module index is generated.
-#texinfo_domain_indices = True
+# texinfo_domain_indices = True
 
 # How to display URL addresses: 'footnote', 'no', or 'inline'.
-#texinfo_show_urls = 'footnote'
+# texinfo_show_urls = 'footnote'
 
 # If true, do not generate a @detailmenu in the "Top" node's menu.
-#texinfo_no_detailmenu = False
+# texinfo_no_detailmenu = False
 
 
 images_config = {
@@ -314,12 +312,13 @@ if HAS_PYENCHANT:
     # String specifying a file containing a list of words known to be spelled
     # correctly but that do not appear in the language dictionary selected by
     # spelling_lang. The file should contain one word per line.
-    spelling_word_list_filename='spelling_wordlist.txt'
+    spelling_word_list_filename = 'spelling_wordlist.txt'
 
     # Boolean controlling whether suggestions for misspelled words are printed.
     # Defaults to False.
-    spelling_show_suggestions=True
+    spelling_show_suggestions = True
 
     # List of filter classes to be added to the tokenizer that produces words to be checked.
     from checkin_filter import CheckinFilter
-    spelling_filters=[CheckinFilter]
+
+    spelling_filters = [CheckinFilter]

doc/development/algorithms/index.rst

@@ -9,5 +9,6 @@ ticket scanning apps and we want to ensure the implementations are as similar as
 .. 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/customview.rst

@@ -18,13 +18,13 @@ If you want to add a custom view to the control area of an event, just register
 
 .. code-block:: python
 
-    from django.conf.urls import url
+    from django.urls import re_path
 
     from . import views
 
     urlpatterns = [
-        url(r'^control/event/(?P<organizer>[^/]+)/(?P<event>[^/]+)/mypluginname/',
-            views.admin_view, name='backend'),
+        re_path(r'^control/event/(?P<organizer>[^/]+)/(?P<event>[^/]+)/mypluginname/',
+                views.admin_view, name='backend'),
     ]
 
 It is required that your URL parameters are called ``organizer`` and ``event``. If you want to

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
 
@@ -70,6 +76,10 @@ The exporter class
 
       This is an abstract attribute, you **must** override this!
 
+   .. autoattribute:: description
+
+   .. autoattribute:: category
+
    .. autoattribute:: export_form_fields
 
    .. automethod:: render

doc/development/api/general.rst

@@ -11,9 +11,10 @@ Core
 ----
 
 .. automodule:: pretix.base.signals
-   :members: periodic_task, event_live_issues, event_copy_data, email_filter, register_notification_types,
+   :members: periodic_task, event_live_issues, event_copy_data, email_filter, register_notification_types, notification,
       item_copy_data, register_sales_channels, register_global_settings, quota_availability, global_email_filter,
-      register_ticket_secret_generators
+      register_ticket_secret_generators, gift_card_transaction_display,
+      register_text_placeholders, register_mail_placeholders
 
 Order events
 """"""""""""
@@ -21,7 +22,7 @@ Order events
 There are multiple signals that will be sent out in the ordering cycle:
 
 .. automodule:: pretix.base.signals
-   :members: validate_cart, validate_cart_addons, validate_order, order_fee_calculation, order_paid, order_placed, order_canceled, order_reactivated, order_expired, order_modified, order_changed, order_approved, order_denied, order_fee_type_name, allow_ticket_download, order_split, order_gracefully_delete, invoice_line_text
+   :members: validate_cart, validate_cart_addons, validate_order, order_valid_if_pending, order_fee_calculation, order_paid, order_placed, order_canceled, order_reactivated, order_expired, order_modified, order_changed, order_approved, order_denied, order_fee_type_name, allow_ticket_download, order_split, order_gracefully_delete, invoice_line_text
 
 Check-ins
 """""""""
@@ -61,7 +62,7 @@ Backend
              item_formsets, order_search_filter_q, order_search_forms
 
 .. automodule:: pretix.base.signals
-   :members: logentry_display, logentry_object_link, requiredaction_display, timeline_events
+   :members: logentry_display, logentry_object_link, requiredaction_display, timeline_events, orderposition_blocked_display, customer_created, customer_signed_in
 
 Vouchers
 """"""""

doc/development/api/import.rst

@@ -3,11 +3,12 @@
 
 .. _`importcol`:
 
-Extending the order import process
-==================================
+Extending the import process
+============================
 
-It's possible through the backend to import orders into pretix, for example from a legacy ticketing system. If your
-plugins defines additional data structures around orders, it might be useful to make it possible to import them as well.
+It's possible through the backend to import objects into pretix, for example orders from a legacy ticketing system. If
+your plugin defines additional data structures around those objects, it might be useful to make it possible to import
+them as well.
 
 Import process
 --------------
@@ -40,7 +41,7 @@ Column registration
 
 The import API does not make a lot of usage from signals, however, it
 does use a signal to get a list of all available import columns. Your plugin
-should listen for this signal and return the subclass of ``pretix.base.orderimport.ImportColumn``
+should listen for this signal and return the subclass of ``pretix.base.modelimport.ImportColumn``
 that we'll provide in this plugin:
 
 .. sourcecode:: python
@@ -56,10 +57,16 @@ that we'll provide in this plugin:
             EmailColumn(sender),
         ]
 
+Similar signals exist for other objects:
+
+.. automodule:: pretix.base.signals
+   :members: voucher_import_columns
+
+
 The column class API
 --------------------
 
-.. class:: pretix.base.orderimport.ImportColumn
+.. class:: pretix.base.modelimport.ImportColumn
 
    The central object of each import extension is the subclass of ``ImportColumn``.
 

doc/development/api/invoice.rst

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

doc/development/api/payment.rst

@@ -70,6 +70,8 @@ The provider class
 
    .. autoattribute:: settings_form_fields
 
+   .. autoattribute:: walletqueries
+
    .. automethod:: settings_form_clean
 
    .. automethod:: settings_content_render
@@ -102,6 +104,8 @@ The provider class
 
    .. automethod:: render_invoice_text
 
+   .. automethod:: render_invoice_stamp
+
    .. automethod:: order_change_allowed
 
    .. automethod:: payment_prepare
@@ -120,14 +124,20 @@ The provider class
 
    .. automethod:: refund_control_render
 
+   .. automethod:: refund_control_render_short
+
    .. automethod:: new_refund_control_form_render
 
    .. automethod:: new_refund_control_form_process
 
    .. automethod:: api_payment_details
 
+   .. automethod:: api_refund_details
+
    .. automethod:: matching_id
 
+   .. automethod:: refund_matching_id
+
    .. automethod:: shred_payment_info
 
    .. automethod:: cancel_payment
@@ -136,6 +146,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/placeholder.rst

@@ -1,10 +1,11 @@
 .. highlight:: python
    :linenothreshold: 5
 
-Writing an e-mail placeholder plugin
-====================================
+Writing a template placeholder plugin
+=====================================
 
-An email placeholder is a dynamic value that pretix users can use in their email templates.
+A template placeholder is a dynamic value that pretix users can use in their email templates and in other
+configurable texts.
 
 Please read :ref:`Creating a plugin <pluginsetup>` first, if you haven't already.
 
@@ -12,31 +13,31 @@ Placeholder registration
 ------------------------
 
 The placeholder API does not make a lot of usage from signals, however, it
-does use a signal to get a list of all available email placeholders. Your plugin
-should listen for this signal and return an instance of a subclass of ``pretix.base.email.BaseMailTextPlaceholder``:
+does use a signal to get a list of all available placeholders. Your plugin
+should listen for this signal and return an instance of a subclass of ``pretix.base.services.placeholders.BaseTextPlaceholder``:
 
 .. code-block:: python
 
     from django.dispatch import receiver
 
-    from pretix.base.signals import register_mail_placeholders
+    from pretix.base.signals import register_text_placeholders
 
 
-    @receiver(register_mail_placeholders, dispatch_uid="placeholder_custom")
-    def register_mail_renderers(sender, **kwargs):
-        from .email import MyPlaceholderClass
+    @receiver(register_text_placeholders, dispatch_uid="placeholder_custom")
+    def register_placeholder_renderers(sender, **kwargs):
+        from .placeholders import MyPlaceholderClass
         return MyPlaceholder()
 
 
 Context mechanism
 -----------------
 
-Emails are sent in different "contexts" within pretix. For example, many emails are sent in the
-the context of an order, but some are not, such as the notification of a waiting list voucher.
+Templates are used in different "contexts" within pretix. For example, many emails are rendered from
+templates in the context of an order, but some are not, such as the notification of a waiting list voucher.
 
-Not all placeholders make sense in every email, and placeholders usually depend some parameters
+Not all placeholders make sense everywhere, and placeholders usually depend on some parameters
 themselves, such as the ``Order`` object. Therefore, placeholders are expected to explicitly declare
-what values they depend on and they will only be available in an email if all those dependencies are
+what values they depend on and they will only be available in a context where all those dependencies are
 met. Currently, placeholders can depend on the following context parameters:
 
 * ``event``
@@ -51,7 +52,7 @@ There are a few more that are only to be used internally but not by plugins.
 The placeholder class
 ---------------------
 
-.. class:: pretix.base.email.BaseMailTextPlaceholder
+.. class:: pretix.base.services.placeholders.BaseTextPlaceholder
 
    .. autoattribute:: identifier
 
@@ -77,7 +78,15 @@ functions:
 
 .. code-block:: python
 
-     placeholder = SimpleFunctionalMailTextPlaceholder(
+     placeholder = SimpleFunctionalTextPlaceholder(
          'code', ['order'], lambda order: order.code, sample='F8VVL'
      )
 
+Signals
+-------
+
+.. automodule:: pretix.base.signals
+   :members: register_text_placeholders
+.. automodule:: pretix.base.signals
+   :members: register_mail_placeholders
+

doc/development/api/plugins.rst

@@ -55,7 +55,6 @@ visible            boolean (optional)   ``True`` by default, can hide a plugin s
 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.
 ================== ==================== ===========================================================
 

doc/development/contribution/style.rst

@@ -1,4 +1,4 @@
-.. spelling:: Rebase rebasing
+.. spelling:word-list:: Rebase rebasing
 
 Coding style and quality
 ========================

doc/development/implementation/i18n.rst

@@ -37,7 +37,7 @@ you to execute a piece of code with a different locale:
 This is very useful e.g. when sending an email to a user that has a different language than the user performing the
 action that causes the mail to be sent.
 
-.. _translation features: https://docs.djangoproject.com/en/1.9/topics/i18n/translation/
+.. _translation features: https://docs.djangoproject.com/en/4.2/topics/i18n/translation/
 .. _GNU gettext: https://www.gnu.org/software/gettext/
 .. _strings: https://django-i18nfield.readthedocs.io/en/latest/strings.html
 .. _database fields: https://django-i18nfield.readthedocs.io/en/latest/quickstart.html

doc/development/implementation/index.rst

@@ -18,3 +18,5 @@ Contents:
    email
    permissions
    logging
+   locking
+   timemachine

doc/development/implementation/locking.rst

@@ -0,0 +1,69 @@
+.. highlight:: python
+
+Resource locking
+================
+
+.. versionchanged:: 2023.8
+
+   Our locking mechanism changed heavily in version 2023.8. Read `this PR`_ for background information.
+
+One of pretix's core objectives as a ticketing system could be described as the management of scarce resources.
+Specifically, the following types of scarce-ness exist in pretix:
+
+- Quotas can limit the number of tickets available
+- Seats can only be booked once
+- Vouchers can only be used a limited number of times
+- Some memberships can only be used a limited number of times
+
+For all of these, it is critical that we prevent race conditions.
+While for some events it wouldn't be a big deal to sell a ticket more or less, for some it would be problematic and selling the same seat twice would always be catastrophic.
+
+We therefore implement a standardized locking approach across the system to limit concurrency in cases where it could
+be problematic.
+
+To acquire a lock on a set of quotas to create a new order that uses that quota, you should follow the following pattern::
+
+    with transaction.atomic(durable=True):
+        quotas = Quota.objects.filter(...)
+        lock_objects(quotas, shared_lock_objects=[event])
+        check_quota(quotas)
+        create_ticket()
+
+The lock will automatically be released at the end of your database transaction.
+
+Generally, follow the following guidelines during your development:
+
+- **Always** acquire a lock on every **quota**, **voucher** or **seat** that you "use" during your transaction. "Use"
+  here means any action after which the quota, voucher or seat will be **less available**, such as creating a cart
+  position, creating an order, creating a blocking voucher, etc.
+
+  - There is **no need** to acquire a lock if you **free up** capacity, e.g. by canceling an order, deleting a voucher, etc.
+
+- **Always** acquire a shared lock on the ``event`` you are working in whenever you acquire a lock on a quota, voucher,
+  or seat.
+
+- Only call ``lock_objects`` **once** per transaction. If you violate this rule, `deadlocks`_ become possible.
+
+- For best performance, call ``lock_objects`` as **late** in your transaction as possible, but always before you check
+  if the desired resource is still available in sufficient quantity.
+
+Behind the scenes, the locking is implemented through `PostgreSQL advisory locks`_. You should also be aware of the following
+properties of our system:
+
+- In some situations, an exclusive lock on the ``event`` is used, such as when the system can't determine for sure which
+  seats will become unavailable after the transaction.
+
+- An exclusive lock on the event is also used if you pass more than 20 objects to ``lock_objects``. This is a performance
+  trade-off because it would take long to acquire all of the individual locks.
+
+- If ``lock_objects`` is unable to acquire a lock within 3 seconds, a ``LockTimeoutException`` will be thrown.
+
+.. note::
+
+   We currently do not use ``lock_objects`` for memberships. Instead, we use ``select_for_update()`` on the membership
+   model. This might change in the future, but you should usually not be concerned about it since
+   ``validate_memberships_in_order(lock=True)`` will handle it for you.
+
+.. _this PR: https://github.com/pretix/pretix/pull/2408
+.. _deadlocks: https://www.postgresql.org/docs/current/explicit-locking.html#LOCKING-DEADLOCKS
+.. _PostgreSQL advisory locks: https://www.postgresql.org/docs/11/explicit-locking.html#ADVISORY-LOCKS

doc/development/implementation/models.rst

@@ -1,7 +1,7 @@
 .. highlight:: python
    :linenothreshold: 5
 
-.. spelling:: answ contrib
+.. spelling:word-list:: answ contrib
 
 Data model
 ==========

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/implementation/settings.rst

@@ -15,7 +15,7 @@ includes serializers for serializing the following types:
 * Built-in types: ``int``, ``float``, ``decimal.Decimal``, ``dict``, ``list``, ``bool``
 * ``datetime.date``, ``datetime.datetime``, ``datetime.time``
 * ``LazyI18nString``
-* References to Django ``File`` objects that are already stored in a storage backend
+* References to Django ``File`` objects that are already stored in a storage backend [#f1]_
 * References to model instances
 
 In code, we recommend to always use the ``.get()`` method on the settings object to access a value, but for
@@ -55,6 +55,9 @@ You can simply use it like this:
                        "preserve his reservation."),
        )
 
+
+.. _settings-defaults-in-plugins:
+
 Defaults in plugins
 -------------------
 
@@ -70,3 +73,9 @@ Make sure that you include this code in a module that is imported at app loading
 
 .. _django-hierarkey: https://github.com/raphaelm/django-hierarkey
 .. _documentation: https://django-hierarkey.readthedocs.io/en/latest/
+
+.. rubric:: Footnotes
+
+.. [#f1] If you store ``File`` instances in per-event settings, make sure to always register them with ``add_default``
+         as described above in :ref:`settings-defaults-in-plugins`. Otherwise, the file won't get copied properly if the
+         user copies the settings of an existing event to a new one.

doc/development/implementation/timemachine.rst

@@ -0,0 +1,32 @@
+Time machine mode
+=================
+
+In test mode, pretix provides a "time machine" feature which allows event organizers
+to test their shop as if it were a different date and time. To enable this feature, they can
+click on the "time machine"-link in the test mode warning box on the event page.
+
+Internally, this time machine mode is implemented by calling our custom :py:meth:`time_machine_now()`
+function instead of :py:meth:`django.utils.timezone.now()` in all places where the fake time should be
+taken into account. If you add code that uses the current date and time for checking whether some
+product can be bought, you should use :py:meth:`time_machine_now`.
+
+.. autofunction:: pretix.base.timemachine.time_machine_now
+
+Background tasks
+----------------
+
+The time machine datetime is passed through the request flow via a thread-local variable (ContextVar).
+Therefore, if you call a background task in the order process, where time_machine_now should be
+respected, you need to pass it through manually as shown in the example below:
+
+.. code-block:: python
+
+    @app.task()
+    def my_task(self, override_now_dt: datetime=None) -> None:
+        with time_machine_now_assigned(override_now_dt):
+            # ...do something that uses time_machine_now()
+
+    my_task.apply_async(kwargs={'override_now_dt': time_machine_now(default=None)})
+
+
+.. autofunction:: pretix.base.timemachine.time_machine_now_assigned

doc/development/implementation/urlconfig.rst

@@ -15,33 +15,41 @@ and the admin panel is available at ``https://pretix.eu/control/event/bigorg/awe
 
 If the organizer now configures a custom domain like ``tickets.bigorg.com``, his event will
 from now on be available on ``https://tickets.bigorg.com/awesomecon/``. The former URL at
-``pretix.eu`` will redirect there. However, the admin panel will still only be available
-on ``pretix.eu`` for convenience and security reasons.
+``pretix.eu`` will redirect there. It's also possible to do this for just an event, in which
+case the event will be available on ``https://tickets.awesomecon.org/``.
+
+However, the admin panel will still only be available on ``pretix.eu`` for convenience and security reasons.
 
 URL routing
 -----------
 
 The hard part about implementing this URL routing in Django is that
 ``https://pretix.eu/bigorg/awesomecon/`` contains two parameters of nearly arbitrary content
-and ``https://tickets.bigorg.com/awesomecon/`` contains only one. The only robust way to do
-this is by having *separate* URL configuration for those two cases. In pretix, we call the
-former our ``maindomain`` config and the latter our ``subdomain`` config. For pretix's core
-modules we do some magic to avoid duplicate configuration, but for a fairly simple plugin with
-only a handful of routes, we recommend just configuring the two URL sets separately.
+and ``https://tickets.bigorg.com/awesomecon/`` contains only one and ``https://tickets.awesomecon.org/`` does not contain any.
+The only robust way to do this is by having *separate* URL configuration for those three cases.
 
+In pretix, we therefore do not have a global URL configuration, but three, living in the following modules:
+
+- ``pretix.multidomain.maindomain_urlconf``
+- ``pretix.multidomain.organizer_domain_urlconf``
+- ``pretix.multidomain.event_domain_urlconf``
+
+We provide some helper utilities to work with these to avoid duplicate configuration of the individual URLs.
 The file ``urls.py`` inside your plugin package will be loaded and scanned for URL configuration
 automatically and should be provided by any plugin that provides any view.
+However, unlike plain Django, we look not only for a ``urlpatterns`` attribute on the module but support other
+attributes like ``event_patterns`` and ``organizer_patterns`` as well.
 
-A very basic example that provides one view in the admin panel and one view in the frontend
-could look like this::
+For example, for a simple plugin that adds one URL to the backend and one event-level URL to the frontend, you can
+create the following configuration in your ``urls.py``::
 
-    from django.conf.urls import url
+    from django.urls import re_path
 
     from . import views
 
     urlpatterns = [
-        url(r'^control/event/(?P<organizer>[^/]+)/(?P<event>[^/]+)/mypluginname/',
-            views.AdminView.as_view(), name='backend'),
+        re_path(r'^control/event/(?P<organizer>[^/]+)/(?P<event>[^/]+)/mypluginname/',
+                views.AdminView.as_view(), name='backend'),
     ]
 
     event_patterns = [
@@ -52,7 +60,7 @@ could look like this::
     As you can see, the view in the frontend is not included in the standard Django ``urlpatterns``
     setting but in a separate list with the name ``event_patterns``. This will automatically prepend
     the appropriate parameters to the regex (e.g. the event or the event and the organizer, depending
-    on the called domain).
+    on the called domain). For organizer-level views, ``organizer_patterns`` works the same way.
 
 If you only provide URLs in the admin area, you do not need to provide a ``event_patterns`` attribute.
 
@@ -71,12 +79,21 @@ is a python method that emulates a behavior similar to ``reverse``:
 
 .. autofunction:: pretix.multidomain.urlreverse.eventreverse
 
+If you need to communicate the URL externally, you can use a different method to ensure that it is always an absolute URL:
+
+.. autofunction:: pretix.multidomain.urlreverse.build_absolute_uri
+
 In addition, there is a template tag that works similar to ``url`` but takes an event or organizer object
 as its first argument and can be used like this::
 
     {% load eventurl %}
     <a href="{% eventurl request.event "presale:event.checkout" step="payment" %}">Pay</a>
+    <a href="{% abseventurl request.event "presale:event.checkout" step="payment" %}">Pay</a>
 
+To generate absolute URLs on the main domain, you can use the ``absurl`` template tag::
+
+    {% load eventurl %}
+    <a href="{% absmainurl "control:event.settings" organizer=request.event.organizer.slug event=request.event.slug %}">Event settings</a>
 
 Implementation details
 ----------------------

doc/development/index.rst

@@ -12,3 +12,4 @@ Developer documentation
    api/index
    structure
    translation/index
+   nfc/index

doc/development/nfc/index.rst

@@ -0,0 +1,15 @@
+NFC media
+=========
+
+pretix supports using NFC chips as "reusable media", for example to store gift cards or tickets.
+
+Most of this implementation currently lives in our proprietary app pretixPOS, but in the future might also become part of our open-source pretixSCAN solution.
+Either way, we want this to be an open ecosystem and therefore document the exact mechanisms in use on the following pages.
+
+We support multiple implementations of NFC media, each documented on its own page:
+
+.. toctree::
+   :maxdepth: 2
+
+   uid
+   mf0aes

doc/development/nfc/mf0aes.rst

@@ -0,0 +1,113 @@
+Mifare Ultralight AES
+=====================
+
+We offer an implementation that provides a higher security level than the UID-based approach and uses the `Mifare Ultralight AES`_ chip sold by NXP.
+We believe the security model of this approach is adequate to the situation where this will usually be used and we'll outline known risks below.
+
+If you want to dive deeper into the properties of the Mifare Ultralight AES chip, we recommend reading the `data sheet`_.
+
+Random UIDs
+-----------
+
+Mifare Ultralight AES supports a feature that returns a randomized UID every time a non-authenticated user tries to
+read the UID. This has a strong privacy benefit, since no unauthorized entity can use the NFC chips to track users.
+On the other hand, this reduces interoperability of the system. For example, this prevents you from using the same NFC
+chips for a different purpose where you only need the UID. This will also prevent your guests from reading their UID
+themselves with their phones, which might be useful e.g. in debugging situations.
+
+Since there's no one-size-fits-all choice here, you can enable or disable this feature in the pretix organizer
+settings. If you change it, the change will apply to all newly encoded chips after the change.
+
+Key management
+--------------
+
+For every organizer, the server will generate create a "key set", which consists of a publicly known ID (random 32-bit integer) and two 16-byte keys ("diversification key" and "UID key").
+
+Using our :ref:`Device authentication mechanism <rest-deviceauth>`, an authorized device can submit a locally generated RSA public key to the server.
+This key can no longer changed on the server once it is set, thus protecting against the attack scenario of a leaked device API token.
+
+The server will then include key sets in the response to ``/api/v1/device/info``, encrypted with the device's RSA key.
+This includes all key sets generated for the organizer the device belongs to, as well as all keys of organizers that have granted sufficient access to this organizer.
+
+The device will decrypt the key sets using its RSA key and store the key sets locally.
+
+.. warning:: The device **will** have access to the raw key sets. Therefore, there is a risk of leaked master keys if an
+             authorized device is stolen or abused. Our implementation in pretixPOS attempts to make this very hard on
+             modern, non-rooted Android devices by keeping them encrypted with the RSA key and only storing the RSA key
+             in the hardware-backed keystore of the device. A sufficiently motivated attacker, however, will likely still
+             be able to extract the keys from a stolen device.
+
+Encoding a chip
+---------------
+
+When a new chip is encoded, the following steps will be taken:
+
+- The UID of the chip is retrieved.
+
+- A chip-specific key is generated using the mechanism documented in `AN10922`_ using the "diversification key" from the
+  organizer's key set as the CMAC key and the diversification input concatenated in the from of ``0x01 + UID + APPID + SYSTEMID``
+  with the following values:
+
+  - The UID of the chip as ``UID``
+
+  - ``"eu.pretix"`` (``0x65 0x75 0x2e 0x70 0x72 0x65 0x74 0x69 0x78``) as ``APPID``
+
+  - The ``public_id`` from the organizer's key set as a 4-byte big-endian value as ``SYSTEMID``
+
+- The chip-specific key is written to the chip as the "data protection key" (config pages 0x30 to 0x33)
+
+- The UID key from the organizer's key set is written to the chip as the "UID retrieval key" (config pages 0x34 to 0x37)
+
+- The config page 0x29 is set like this:
+
+  - ``RID_ACT`` (random UID) to ``1`` or ``0`` based on the organizer's configuration
+  - ``SEC_MSG_ACT`` (secure messaging) to ``1``
+  - ``AUTH0`` (first page that needs authentication) to 0x04 (first non-UID page)
+
+- The config page 0x2A is set like this:
+
+  - ``PROT`` to ``0`` (only write access restricted, not read access)
+  - ``AUTHLIM`` to ``256`` (maximum number of wrong authentications before "self-desctruction")
+  - Everything else to its default value (no lock bits are set)
+
+- The ``public_id`` of the key set will be written to page 0x04 as a big-endian value
+
+- The UID of the chip will be registered as a reusable medium on the server.
+
+.. warning:: During encoding, the chip-specific key and the UID key are transmitted in plain text over the air. The
+             security model therefore relies on the encoding of chips being performed in a trusted physical environment
+             to prevent a nearby attacker from sniffing the keys with a strong antenna.
+
+.. note:: If an attacker tries to authenticate with the chip 256 times using the wrong key, the chip will become
+          unusable. A chip may also become unusable if it is detached from the reader in the middle of the encoding
+          process (even though we've tried to implement it in a way that makes this unlikely).
+
+Usage
+-----
+
+When a chip is presented to the NFC reader, the following steps will be taken:
+
+- Command ``GET_VERSION`` is used to determine if it is a Mifare Ultralight AES chip (if not, abort).
+
+- Page 0x04 is read. If it is all zeroes, the chip is considered un-encoded (abort). If it contains a value that
+  corresponds to the ``public_id`` of a known key set, this key set is used for all further operations. If it contains
+  a different value, we consider this chip to belong to a different organizer or not to a pretix system at all (abort).
+
+- An authentication with the chip using the UID key is performed.
+
+- The UID of the chip will be read.
+
+- The chip-specific key will be derived using the mechanism described above in the encoding step.
+
+- An authentication with the chip using the chip-specific key is performed. If this is fully successful, this step
+  proves that the chip knows the same chip-specific key as we do and is therefore an authentic chip encoded by us and
+  we can trust its UID value.
+
+- The UID is transmitted to the server to fetch the correct medium.
+
+During these steps, the keys are never transmitted in plain text and can thus not be sniffed by a nearby attacker
+with a strong antenna.
+
+.. _Mifare Ultralight AES: https://www.nxp.com/products/rfid-nfc/mifare-hf/mifare-ultralight/mifare-ultralight-aes-enhanced-security-for-limited-use-contactless-applications:MF0AESx20
+.. _data sheet: https://www.nxp.com/docs/en/data-sheet/MF0AES(H)20.pdf
+.. _AN10922: https://www.nxp.com/docs/en/application-note/AN10922.pdf

doc/development/nfc/uid.rst

@@ -0,0 +1,10 @@
+UID-based
+=========
+
+With UID-based NFC, only the unique ID (UID) of the NFC chip is used for identification purposes.
+This can be used with virtually all NFC chips that provide compatibility with the NFC reader in use, typically at least all chips that comply with ISO/IEC 14443-3A.
+
+We make only one restriction: The UID may not start with ``08``, since that usually signifies a randomized UID that changes on every read (which would not be very useful).
+
+.. warning:: The UID-based approach provides only a very low level of security. It is easy to clone a chip with the same
+             UID and impersonate someone else.

doc/development/setup.rst

@@ -58,11 +58,11 @@ If you do not have a recent installation of ``nodejs``, install it now::
 
 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]"
 
 Next, you need to copy the SCSS files from the source folder to the STATIC_ROOT directory::
 
+    cd src/
     python manage.py collectstatic --noinput
 
 Then, create the local database::
@@ -96,6 +96,20 @@ http://localhost:8000/control/ for the admin view.
           port (for example because you develop on `pretixdroid`_), you can check
           `Django's documentation`_ for more options.
 
+When running the local development webserver, ensure Celery is not configured
+in ``pretix.cfg``. i.e., you should remove anything such as::
+
+    [celery]
+    backend=redis://redis:6379/2
+    broker=redis://redis:6379/2
+
+If you choose to use Celery for development, you must also start a Celery worker
+process::
+
+    celery -A pretix.celery_app worker -l info
+
+However, beware that code changes will not auto-reload within Celery.
+
 .. _`checksandtests`:
 
 Code checks and unit tests
@@ -150,6 +164,13 @@ Add this to your ``src/pretix.cfg``::
 
 Then execute ``python -m smtpd -n -c DebuggingServer localhost:1025``.
 
+Working with periodic tasks
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Periodic tasks (like sendmail rules) are run when an external scheduler (like cron)
+triggers the ``runperiodic`` command.
+
+To run periodic tasks, execute ``python manage.py runperiodic``.
+
 Working with translations
 ^^^^^^^^^^^^^^^^^^^^^^^^^
 If you want to translate new strings that are not yet known to the translation system,
@@ -190,5 +211,15 @@ with the documentation a lot, you might find it useful to use sphinx-autobuild::
 Then, go to http://localhost:8081 for a version of the documentation that automatically re-builds
 whenever you change a source file.
 
+Working with frontend assets
+----------------------------
+
+To update the frontend styles of shops with a custom styling, run the following commands inside
+your virtual environment.::
+
+    python -m pretix collectstatic --noinput
+    python -m pretix updatestyles
+
+
 .. _Django's documentation: https://docs.djangoproject.com/en/1.11/ref/django-admin/#runserver
 .. _pretixdroid: https://github.com/pretix/pretixdroid

doc/development/structure.rst

@@ -31,7 +31,7 @@ pretix/
         Additional code implementing our customized :ref:`URL handling <urlconf>`.
 
     static/
-        Contains all static files (CSS/SASS, JavaScript, images) of pretix' core
+        Contains all static files (CSS/SASS, JavaScript, images) of pretix' core.
         We use libsass as a preprocessor for CSS. Our own sass code is built in the same
         step as Bootstrap and FontAwesome, so their mixins etc. are fully available.
 
@@ -41,6 +41,6 @@ pretix/
 
 tests/
     This is the root directory for all test codes. It includes subdirectories ``api``, ``base``,
-    ``control``, ``presale``, ``helpers`, ``multidomain`` and ``plugins`` to mirror the structure
+    ``control``, ``presale``, ``helpers``, ``multidomain`` and ``plugins`` to mirror the structure
     of the pretix source code as well as ``testdummy``, which is a pretix plugin used during
     testing.

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,34 +2,71 @@
 
 
 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?"
+        -down->[yes] "Is one or more block set on the ticket?"
         --> if "" then
-            -right->[no] "Return error PRODUCT"
+            -right->[yes] "Return error BLOCKED"
         else
-            -down->[yes] "Is the subevent part of the check-in list?"
+            -down->[no] "Is the order in status PENDING and not yet approved?"
             --> if "" then
-                -right->[no] "Return error INVALID"
-                note bottom: TODO\ninconsistent\nwith online\ncheck
+                -right->[yes] "Return error UNAPPROVED"
             else
-                -down->[yes] "Is the order in status PAID?"
+                -down->[no] "If this is not an exit, is the valid_from/valid_until\nconstraint on the ticket fulfilled?"
                 --> if "" then
-                    -right->[no] "Does the check-in list include pending orders?"
+                    -right->[no] "Return error INVALID_TIME"
+                else
+                    -down->[yes] "Is the product part of the check-in list?"
                     --> if "" then
-                        -right->[no] "Return error UNPAID "
+                        -right->[no] "Return error PRODUCT"
                     else
-                        -down->[yes] "Is ignore_unpaid set?\n(Has the operator confirmed\nthe checkin?)"
+                        -down->[yes] "Is the subevent part of the check-in list?"
                         --> if "" then
-                            -right->[no] "Return error UNPAID "
+                            -right->[no] "Return error INVALID"
+                            note bottom: TODO\ninconsistent\nwith online\ncheck
                         else
-                            -down->[yes] "Is this an entry or exit?"
+                            -down->[yes] "Is the order in status PAID?"
+                            --> if "" then
+                                -right->[no] "Is Order.valid_if_pending set?"
+                                --> if "" then
+                                    -->[yes] "Is this an entry or exit?"
+                                else
+                                    -->[no] "Does the check-in list include pending orders?"
+                                    --> if "" then
+                                        -->[no] "Return error UNPAID "
+                                    else
+                                        -->[yes] "Is ignore_unpaid set on the request?\n(Has the operator confirmed\nthe checkin?)"
+                                        --> if "" then
+                                            -->[no] "Return error UNPAID "
+                                        else
+                                            -->[yes] "Is this an entry or exit?"
+                                        endif
+                                    endif
+                                endif
+                            else
+                                -down->[yes] "Is this an entry or exit?"
+                            endif
                         endif
                     endif
-                else
-                    -down->[yes] "Is this an entry or exit?"
                 endif
             endif
         endif
@@ -81,16 +118,26 @@ partition "dataless check" {
         --> if "" then
             -right->[yes] "Return error REVOKED"
         else
-            -down->[no] "Is the product part of the check-in list? "
+            -down->[yes] "Is the ticket secret on the block list?"
             --> if "" then
-                -right->[no] "Return error PRODUCT "
+                -right->[yes] "Return error BLOCKED "
             else
-                -down->[yes] "Is the subevent part of the check-in list? "
+                -down->[yes] "If this is not an exit, is the valid_from/valid_until\nconstraint on the ticket fulfilled? "
                 --> if "" then
-                    -right->[no] "Return error INVALID  "
-                    note bottom: TODO\ninconsistent\nwith online\ncheck
+                    -right->[no] "Return error INVALID_TIME "
                 else
-                  --> "Is this an entry or exit? "
+                    -down->[no] "Is the product part of the check-in list? "
+                    --> if "" then
+                        -right->[no] "Return error PRODUCT "
+                    else
+                        -down->[yes] "Is the subevent part of the check-in list? "
+                        --> if "" then
+                            -right->[no] "Return error INVALID  "
+                            note bottom: TODO\ninconsistent\nwith online\ncheck
+                        else
+                          --> "Is this an entry or exit? "
+                        endif
+                    endif
                 endif
             endif
         endif