Invoice renderer: Print gift card amount even on paid orders if partial payments should be printed

.clabot

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

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,23 @@
+---
+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

@@ -1,53 +0,0 @@
-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

@@ -1,8 +0,0 @@
-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,13 +6,10 @@
 version: 2
 updates:
   - package-ecosystem: "pip"
-    directory: "/"
+    directory: "/src"
     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

@@ -1,49 +0,0 @@
-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 -y 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,30 +14,24 @@ 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-22.04
+    runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - name: Set up Python 3.11
-        uses: actions/setup-python@v5
+      - uses: actions/checkout@v2
+      - name: Set up Python 3.8
+        uses: actions/setup-python@v1
         with:
-          python-version: 3.11
-      - uses: actions/cache@v4
+          python-version: 3.8
+      - uses: actions/cache@v1
         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 -y enchant-2 hunspell aspell-en
+        run: sudo apt update && sudo apt install enchant hunspell aspell-en
       - name: Install Dependencies
         run: pip3 install -Ur requirements.txt
         working-directory: ./doc

.github/workflows/strings.yml

@@ -12,32 +12,27 @@ on:
       - 'doc/**'
       - 'src/pretix/locale/**'
 
-permissions:
-  contents: read  #  to fetch code (actions/checkout)
-
-env:
-  FORCE_COLOR: 1
-
 jobs:
   compile:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-latest
     name: Check gettext syntax
     steps:
-      - uses: actions/checkout@v4
-      - name: Set up Python 3.11
-        uses: actions/setup-python@v5
+      - uses: actions/checkout@v2
+      - name: Set up Python 3.8
+        uses: actions/setup-python@v1
         with:
-          python-version: 3.11
-      - uses: actions/cache@v4
+          python-version: 3.8
+      - uses: actions/cache@v1
         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 -y install gettext
+        run: sudo apt update && sudo apt install gettext
       - name: Install Dependencies
-        run: pip3 install uv && uv pip install --system -e ".[dev]"
+        run: pip3 install -e ".[dev]"
+        working-directory: ./src
       - name: Compile messages
         run: python manage.py compilemessages
         working-directory: ./src
@@ -45,24 +40,25 @@ jobs:
         run: python manage.py compilejsi18n
         working-directory: ./src
   spelling:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-latest
     name: Spellcheck
     steps:
-      - uses: actions/checkout@v4
-      - name: Set up Python 3.11
-        uses: actions/setup-python@v5
+      - uses: actions/checkout@v2
+      - name: Set up Python 3.8
+        uses: actions/setup-python@v1
         with:
-          python-version: 3.11
-      - uses: actions/cache@v4
+          python-version: 3.8
+      - uses: actions/cache@v1
         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-2 hunspell hunspell-de-de aspell-en aspell-de
+        run: sudo apt update && sudo apt install enchant hunspell hunspell-de-de aspell-en aspell-de
       - name: Install Dependencies
-        run: pip3 install uv && uv pip install --system -e ".[dev]"
+        run: pip3 install -e ".[dev]"
+        working-directory: ./src
       - name: Spellcheck translations
         run: potypo
         working-directory: ./src

.github/workflows/style.yml

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

.github/workflows/tests.yml

@@ -5,60 +5,60 @@ on:
     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
+    runs-on: ubuntu-latest
     name: Tests
     strategy:
       matrix:
-        python-version: ["3.9", "3.10", "3.11"]
-        database: [sqlite, postgres]
+        python-version: ["3.7", "3.8", "3.9"]
+        database: [sqlite, postgres, mysql]
         exclude:
-          - database: sqlite
+          - database: mysql
+            python-version: "3.8"
+          - database: mysql
             python-version: "3.9"
           - database: sqlite
-            python-version: "3.10"
-    services:
-      postgres:
-        image: postgres:15
-        env:
-          POSTGRES_PASSWORD: postgres
-          POSTGRES_DB: pretix
-        options: >-
-          --health-cmd "pg_isready -U postgres -d pretix"
-          --health-interval 10s
-          --health-timeout 5s
-          --health-retries 5
-        ports:
-          - 5432:5432
+            python-version: "3.7"
+          - database: sqlite
+            python-version: "3.8"
     steps:
-      - uses: actions/checkout@v4
+      - 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: harmon758/postgresql-action@v1
+        with:
+          postgresql version: '11'
+          postgresql db: 'pretix'
+          postgresql user: 'postgres'
+          postgresql password: 'postgres'
+        if: matrix.database == 'postgres'
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v1
         with:
           python-version: ${{ matrix.python-version }}
-      - uses: actions/cache@v4
+      - uses: actions/cache@v1
         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 -y gettext
+        run: sudo apt update && sudo apt install gettext mariadb-client-10.3
       - name: Install Python dependencies
-        run: pip3 install uv && uv pip install --system -e ".[dev]" psycopg2-binary
+        run: pip3 install -e ".[dev]" mysqlclient psycopg2-binary
+        working-directory: ./src
       - name: Run checks
         run: python manage.py check
         working-directory: ./src
@@ -70,15 +70,10 @@ jobs:
         run: make all compress
       - name: Run tests
         working-directory: ./src
-        run: PRETIX_CONFIG_FILE=tests/ci_${{ matrix.database }}.cfg py.test -n 3 -p no:sugar --cov=./ --cov-report=xml tests --maxfail=100
-      - name: Run concurrency tests
-        working-directory: ./src
-        run: PRETIX_CONFIG_FILE=tests/ci_${{ matrix.database }}.cfg py.test tests/concurrency_tests/ --reuse-db
-        if: matrix.database == 'postgres'
+        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: Upload coverage
-        uses: codecov/codecov-action@v4
+        uses: codecov/codecov-action@v1
         with:
           file: src/coverage.xml
-          token: ${{ secrets.CODECOV_TOKEN }}
-          fail_ci_if_error: false
-        if: matrix.database == 'postgres' && matrix.python-version == '3.11'
+          fail_ci_if_error: true
+        if: matrix.database == 'postgres' && matrix.python-version == '3.8'

.gitignore

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

.gitlab-ci.yml

@@ -1,45 +1,44 @@
+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:
-        - uv pip install --system -e ".[dev]"
+        - virtualenv env
+        - source env/bin/activate
+        - pip install -U pip wheel setuptools
         - cd src
+        - XDG_CACHE_HOME=/cache pip3 install -e ".[dev]"
         - python manage.py check
         - make all compress
-        - PRETIX_CONFIG_FILE=tests/ci_sqlite.cfg py.test -n 3 tests --maxfail=100
+        - py.test --reruns 3 -n 3 tests
+    tags:
+        - python3
     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:
-        - uv pip install --system -e ".[dev]"
+        - 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]"
         - python setup.py sdist
-        - uv pip install --system dist/pretix-*.tar.gz
+        - pip install dist/pretix-*.tar.gz
         - python -m pretix migrate
         - python -m pretix check
-        - cd src
-        - make npminstall
-        - cd ..
         - check-manifest
-        - python -m build
+        - make npminstall
+        - python setup.py sdist bdist_wheel
         - twine check dist/*
         - twine upload dist/*
+    tags:
+        - python3
     only:
         - pypi
     artifacts:
         paths:
             - src/dist/
-
 stages:
     - test
     - build

.node-version

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

.readthedocs.requirements.txt

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

.readthedocs.yaml

@@ -1,15 +0,0 @@
-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

CODE_OF_CONDUCT.md

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

CONTRIBUTING.md

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

Dockerfile

@@ -1,8 +1,9 @@
-FROM python:3.11-bookworm
+FROM python:3.9-bullseye
 
 RUN apt-get update && \
     apt-get install -y --no-install-recommends \
             build-essential \
+            libmariadb-dev \
             gettext \
             git \
             libffi-dev \
@@ -18,27 +19,38 @@ RUN apt-get update && \
             python3-dev \
             sudo \
             supervisor \
-            libmaxminddb0 \
-            libmaxminddb-dev \
-            zlib1g-dev \
-            nodejs  \
-            npm && \
+            zlib1g-dev && \
     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
+    mkdir /etc/supervisord && \
+	curl -fsSL https://deb.nodesource.com/setup_16.x | sudo -E bash - && \
+    apt-get install -y nodejs && \
+    curl -qL https://www.npmjs.com/install.sh | sh
 
 
 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
@@ -46,27 +58,17 @@ 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 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 cd /pretix/src && python setup.py install
 
 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

@@ -1,50 +0,0 @@
-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/autocheckin/templates *
-recursive-include src/pretix/plugins/autocheckin/static *
-recursive-include src/pretix/plugins/banktransfer/templates *
-recursive-include src/pretix/plugins/banktransfer/static *
-recursive-include src/pretix/plugins/manualpayment/templates *
-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 *

README.rst

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

SECURITY.md

@@ -1,20 +0,0 @@
-# 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

@@ -1,12 +0,0 @@
-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/nginx.conf

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

deployment/docker/pretix.bash

@@ -5,7 +5,7 @@ export DATA_DIR=/data/
 export HOME=/pretix
 
 AUTOMIGRATE=${AUTOMIGRATE:-yes}
-NUM_WORKERS_DEFAULT=$((2 * $(nproc)))
+NUM_WORKERS_DEFAULT=$((2 * $(nproc --all)))
 export NUM_WORKERS=${NUM_WORKERS:-$NUM_WORKERS_DEFAULT}
 
 if [ ! -d /data/logs ]; then
@@ -47,7 +47,7 @@ if [ "$1" == "taskworker" ]; then
 fi
 
 if [ "$1" == "upgrade" ]; then
-    exec python3 -m pretix updateassets
+    exec python3 -m pretix updatestyles
 fi
 
 exec python3 -m pretix "$@"

deployment/docker/production_settings.py

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

deployment/docker/supervisord/base.conf

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

doc/_templates/index.html

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

doc/_themes/pretix_theme/layout.html

@@ -18,82 +18,67 @@
   <title>{{ title|striptags|e }}{{ titlesuffix }}</title>
   {% endblock %}
 
-
-  {#- 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 %}
+  {# FAVICON #}
+  {% if favicon %}
+    <link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}"/>
+  {% endif %}
+  {# CANONICAL URL #}
+  {% if theme_canonical_url %}
     <link rel="canonical" href="{{ theme_canonical_url }}{{ pagename }}.html"/>
-  {%- endif -%}
+  {% endif %}
 
-  {#- CANONICAL URL #}
-  {%- if pageurl %}
-    <link rel="canonical" href="{{ pageurl|e }}" />
-  {%- endif -%}
+  {# CSS #}
 
-  {#- 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>
+  {# 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 %}
 
-    {#- 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 %}
+  {% 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 %}
 
   {%- 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') }}" />
+        <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 }}"/>
     {%- 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">
@@ -107,15 +92,16 @@
         <div class="wy-side-nav-search">
           {% block sidebartitle %}
 
-          {# 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 %}
-            Developer Documentation
+          {% 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 %}
           </a>
 
           {% include "searchbox.html" %}

doc/_themes/pretix_theme/search.html

@@ -5,37 +5,31 @@
     Template for the search page.
 
     :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS.
-    :license: BSD, see https://github.com/sphinx-doc/sphinx/blob/master/LICENSE for details.
+    :license: BSD, see LICENSE for details.
 #}
 {%- extends "layout.html" %}
 {% set title = _('Search') %}
-{% 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 %}
+{% set script_files = script_files + ['_static/searchtools.js'] %}
 {% block footer %}
-  <script>
+  <script type="text/javascript">
     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 id="searchindexloader"></script>
+  <script type="text/javascript" id="searchindexloader"></script>
   {{ super() }}
 {% endblock %}
 {% block body %}
   <noscript>
   <div id="fallback" class="admonition warning">
     <p class="last">
-      {% trans trimmed %}Please activate JavaScript to enable the search
+      {% trans %}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>
@@ -53,4 +47,4 @@
     </ul>
   {% endif %}
   </div>
-{% endblock %}
+{% endblock %}

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

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

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

doc/admin/errors.rst

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

doc/admin/index.rst

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

doc/admin/indexes.rst

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

doc/admin/installation/dev_version.rst

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

doc/admin/installation/docker_smallscale.rst

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

doc/admin/installation/enterprise.rst

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

doc/admin/installation/general.rst

@@ -0,0 +1,42 @@
+.. highlight:: ini
+
+.. spelling:: SQL
+
+General remarks
+===============
+
+Requirements
+------------
+To use pretix, you will need the following things:
+
+* **pretix** and the python packages it depends on
+
+* An **WSGI application server** (we recommend gunicorn)
+
+* A periodic task runner, e.g. ``cron``
+
+* **A database**. This needs to be a SQL-based that is supported by Django. We highly recommend to either
+  go for **PostgreSQL** or **MySQL/MariaDB**. 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.
+
+  .. warning:: Do not ever run without SSL in production. Your users deserve encrypted connections and thanks to
+               `Let's Encrypt`_ SSL certificates can be obtained for free these days.
+
+* A **redis** server. This will be used for caching, session storage and task queuing.
+
+  .. warning:: pretix can run without redis, however this is only intended for development and should never be
+               used in production.
+
+* Optionally: RabbitMQ or memcached. Both of them might provide speedups, but if they are not present,
+  redis will take over their job.
+
+.. _Let's Encrypt: https://letsencrypt.org/

doc/admin/installation/index.rst

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

doc/admin/installation/manual_smallscale.rst

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

doc/admin/maintainance.rst

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

doc/admin/scaling.rst

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

doc/admin/updates.rst

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

doc/api/deviceauth.rst

@@ -32,16 +32,10 @@ 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",
-       "rsa_pubkey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqh…nswIDAQAB\n-----END PUBLIC KEY-----\n"
+       "software_version": "4.0.0"
    }
 
-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:
 
@@ -104,8 +98,6 @@ 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"}
@@ -113,57 +105,6 @@ 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
 ----------------------
 
@@ -249,10 +190,8 @@ You can get three response codes:
    Content-Type: application/json
 
    {
-      "event": {
-        "name": "Demo Conference",
-        "slug": "democon"
-      },
+      "event": "democon",
       "subevent": 23,
       "checkinlist": 5
    }
+

doc/api/fundamentals.rst

@@ -48,11 +48,10 @@ Possible permissions are:
 Compatibility
 -------------
 
-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 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 treat the following types of changes as *backwards-compatible* so we ask you to make sure
 that your clients can deal with them properly:
@@ -61,7 +60,6 @@ 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*:
@@ -192,9 +190,6 @@ 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,9 +94,7 @@ 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/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.
+either enter ``https://example.org`` or ``https://example.org/order/``.
 
 The user will be redirected back to your page instead of pretix' order confirmation page after the payment,
 **regardless of whether it was successful or not**. 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/auto_checkin_rules.rst

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

doc/api/resources/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,28 +29,22 @@ 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``)
-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``)
+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 (or ``null``)
+seat                                  objects                    The assigned seat. Can be ``null``.
 ├ id                                  integer                    Internal ID of the seat instance
 ├ name                                string                     Human-readable seat name
-├ zone_name                           string                     Name of the zone the seat is in
-├ row_name                            string                     Name/number of the row the seat is in
-├ row_label                           string                     Additional label of the row (or ``null``)
-├ seat_number                         string                     Number of the seat within the row
-├ seat_label                          string                     Additional label of the seat (or ``null``)
 └ seat_guid                           string                     Identifier of the seat within the seating plan
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 4.14
+.. versionchanged:: 3.0
 
-   This ``is_bundled`` attribute has been added and the cart creation endpoints have been updated.
+   This ``seat`` attribute has been added.
 
 
 Cart position endpoints
@@ -93,7 +87,6 @@ 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",
@@ -140,7 +133,6 @@ 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",
@@ -176,7 +168,7 @@ Cart position endpoints
 
        * does not validate if the event's ticket sales are already over or haven't started
 
-       * does not validate constraints on add-on products at the moment
+       * does not support add-on products at the moment
 
        * does not check or calculate prices but believes any prices you send
 
@@ -184,8 +176,6 @@ Cart position endpoints
 
        * 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``)
@@ -200,8 +190,6 @@ Cart position endpoints
    * ``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``
@@ -233,12 +221,6 @@ Cart position endpoints
             "options": []
           }
         ],
-        "addons": [
-          {
-            "item": 2,
-            "variation": null,
-          }
-        ],
         "subevent": null
       }
 
@@ -250,7 +232,7 @@ Cart position endpoints
       Vary: Accept
       Content-Type: application/json
 
-      (Full cart position resource, see above, with additional nested objects "addons" and "bundled".)
+      (Full cart position resource, see above.)
 
    :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
@@ -262,8 +244,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/categories.rst

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

doc/api/resources/checkin.rst

@@ -1,4 +1,4 @@
-.. spelling:word-list:: checkin
+.. spelling:: checkin
 
 .. _rest-checkin:
 
@@ -13,10 +13,6 @@ failed scans.
 
     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
@@ -31,9 +27,7 @@ Checking a ticket in
    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.
@@ -54,11 +48,6 @@ Checking a ticket in
                         this request twice with the same nonce, the second request will also succeed but will always
                         create only one check-in object even when the previous request was successful as well. This
                         allows for a certain level of idempotency and enables you to re-try after a connection failure.
-   :<json boolean use_order_locale: Specifies that pretix should use the customer's language (``locale`` field from the
-                                    order) when building texts (currently only the ``reason_explanation`` response field).
-                                    Defaults to ``false`` in which case the server will determine the language (currently
-                                    the event default language, might change in the future with support for the
-                                    ``Accept-Language`` header).
    :>json string status: ``"ok"``, ``"incomplete"``, or ``"error"``
    :>json string reason: Reason code, only set on status ``"error"``, see below for possible values.
    :>json string reason_explanation: Human-readable explanation, only set on status ``"error"`` and reason ``"rules"``, can be null.
@@ -67,11 +56,8 @@ Checking a ticket in
                            will only include check-ins for the selected list. (2) An additional boolean property
                            ``require_attention`` will inform you whether either the order or the item have the
                            ``checkin_attention`` flag set. (3) If ``attendee_name`` is empty, it may automatically fall
-                           back to values from a parent product or from invoice addresses. (4) Additional properties
-                           ``order__status``, ``order__valid_if_pending``, ``order__require_approval``, and
-                           ``order__locale`` are included with details form the order for convenience.
+                           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"``.
@@ -86,7 +72,6 @@ Checking a ticket in
 
       {
         "secret": "M5BO19XmFwAjLd4nDYUAL9ISjhti0e9q",
-        "source_type": "barcode",
         "lists": [1],
         "force": false,
         "ignore_unpaid": false,
@@ -112,7 +97,6 @@ Checking a ticket in
           …
         },
         "require_attention": false,
-        "checkin_texts": [],
         "list": {
           "id": 1,
           "name": "Default check-in list",
@@ -135,7 +119,6 @@ Checking a ticket in
           …
         },
         "require_attention": false,
-        "checkin_texts": [],
         "list": {
           "id": 1,
           "name": "Default check-in list",
@@ -153,7 +136,6 @@ Checking a ticket in
             "position": 1,
             "identifier": "WY3TP9SL",
             "ask_during_checkin": true,
-            "show_during_checkin": true,
             "options": [
               {
                 "id": 1,
@@ -190,8 +172,7 @@ Checking a ticket in
         "status": "error",
         "reason": "invalid",
         "reason_explanation": null,
-        "require_attention": false,
-        "checkin_texts": []
+        "require_attention": false
       }
 
    **Example error response (known, but invalid ticket)**:
@@ -206,7 +187,6 @@ Checking a ticket in
         "reason": "unpaid",
         "reason_explanation": null,
         "require_attention": false,
-        "checkin_texts": [],
         "list": {
           "id": 1,
           "name": "Default check-in list",
@@ -223,19 +203,16 @@ Checking a ticket in
 
    * ``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``.
+   In case of reason ``rules``, there might be an additional response field ``reason_explanation`` with a human-readable
+   description of the violated rules. However, that field can also be missing or be ``null``.
 
    :param organizer: The ``slug`` field of the organizer to fetch
    :statuscode 201: no error

doc/api/resources/checkinlists.rst

@@ -1,4 +1,4 @@
-.. spelling:word-list:: checkin
+.. spelling:: checkin
 
 .. _rest-checkinlists:
 
@@ -31,23 +31,35 @@ subevent                              integer                    ID of the date
 position_count                        integer                    Number of tickets that match this list (read-only).
 checkin_count                         integer                    Number of check-ins performed on this list (read-only).
 include_pending                       boolean                    If ``true``, the check-in list also contains tickets from orders in pending state.
+auto_checkin_sales_channels           list of strings            All items on the check-in list will be automatically marked as checked-in when purchased through any of the listed sales channels.
 allow_multiple_entries                boolean                    If ``true``, subsequent scans of a ticket on this list should not show a warning but instead be stored as an additional check-in.
 allow_entry_after_exit                boolean                    If ``true``, subsequent scans of a ticket on this list are valid if the last scan of the ticket was an exit scan.
 rules                                 object                     Custom check-in logic. The contents of this field are currently not considered a stable API and modifications through the API are highly discouraged.
 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
+
+    The ``subevent`` attribute may now be ``null`` inside event series. The ``allow_multiple_entries``,
+    ``allow_entry_after_exit``, and ``rules`` attributes have been added.
+
+.. versionchanged:: 3.11
+
+    The ``subevent_match`` and ``exclude`` query parameters have been added.
+
+.. versionchanged:: 3.12
+
+    The ``exit_all_at`` attribute has been added.
+
+.. versionchanged:: 3.17
+
+    The ``ends_after`` and ``expand`` query parameters have been added.
+
 .. versionchanged:: 4.12
 
     The ``addon_match`` attribute has been added.
 
-.. versionchanged:: 2023.9
-
-    The ``ignore_in_statistics`` and ``consider_tickets_used`` attributes have been added.
-
 Endpoints
 ---------
 
@@ -89,7 +101,10 @@ Endpoints
             "allow_entry_after_exit": true,
             "exit_all_at": null,
             "rules": {},
-            "addon_match": false
+            "addon_match": false,
+            "auto_checkin_sales_channels": [
+              "pretixpos"
+            ]
           }
         ]
       }
@@ -100,8 +115,6 @@ 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
@@ -141,7 +154,10 @@ Endpoints
         "allow_entry_after_exit": true,
         "exit_all_at": null,
         "rules": {},
-        "addon_match": false
+        "addon_match": false,
+        "auto_checkin_sales_channels": [
+          "pretixpos"
+        ]
       }
 
    :param organizer: The ``slug`` field of the organizer to fetch
@@ -238,7 +254,10 @@ Endpoints
         "subevent": null,
         "allow_multiple_entries": false,
         "allow_entry_after_exit": true,
-        "addon_match": false
+        "addon_match": false,
+        "auto_checkin_sales_channels": [
+          "pretixpos"
+        ]
       }
 
    **Example response**:
@@ -260,7 +279,10 @@ Endpoints
         "subevent": null,
         "allow_multiple_entries": false,
         "allow_entry_after_exit": true,
-        "addon_match": false
+        "addon_match": false,
+        "auto_checkin_sales_channels": [
+          "pretixpos"
+        ]
       }
 
    :param organizer: The ``slug`` field of the organizer of the event/item to create a list for
@@ -312,7 +334,10 @@ Endpoints
         "subevent": null,
         "allow_multiple_entries": false,
         "allow_entry_after_exit": true,
-        "addon_match": false
+        "addon_match": false,
+        "auto_checkin_sales_channels": [
+          "pretixpos"
+        ]
       }
 
    :param organizer: The ``slug`` field of the organizer to modify
@@ -325,7 +350,7 @@ Endpoints
 
 .. http:delete:: /api/v1/organizers/(organizer)/events/(event)/checkinlist/(id)/
 
-   Delete a check-in list. **Note that this also deletes the information on all check-ins performed via this list.**
+   Delete a check-in list. Note that this also deletes the information on all check-ins performed via this list.
 
    **Example request**:
 
@@ -354,7 +379,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``, ``blocked``, ``invalid_time``, or ``error``. Required.
+                                ``incomplete``, ``already_redeemed``, 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"``.
@@ -482,7 +507,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 ``subevent``, ``item``, ``variation``, and ``answers.question`` are supported. Can be passed multiple times.
+   :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.
@@ -616,8 +641,7 @@ Order position endpoints
                                        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``. (**Deprecated**, in
-                                      the future, this will be ignored and ``canceled`` may always be returned.)
+                                      returned. Otherwise, canceled orders will return ``unpaid``.
    :<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,
@@ -691,7 +715,6 @@ Order position endpoints
             "position": 1,
             "identifier": "WY3TP9SL",
             "ask_during_checkin": true,
-            "show_during_checkin": true,
             "options": [
               {
                 "id": 1,
@@ -735,8 +758,6 @@ Order position endpoints
 
    * ``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.
@@ -744,10 +765,9 @@ Order position endpoints
    * ``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`` 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``.
+   In case of reason ``rules``, there might be an additional response field ``reason_explanation`` with a human-readable
+   description of the violated rules. However, that field can also be missing or be ``null``.
 
    :param organizer: The ``slug`` field of the organizer to fetch
    :param event: The ``slug`` field of the event to fetch
@@ -760,4 +780,4 @@ Order position endpoints
    :statuscode 404: The requested order position or check-in list does not exist.
 
 
-.. _security issues: https://pretix.eu/about/de/blog/20220705-release-4111/
+.. _security issues: https://pretix.eu/about/de/blog/20220705-release-4111/

doc/api/resources/customers.rst

@@ -14,12 +14,8 @@ 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.
+external_identifier                   string                     External ID of the customer (or ``null``)
 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
@@ -30,20 +26,10 @@ date_joined                           datetime                   Date and time o
 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
 ---------
 
@@ -76,7 +62,6 @@ Endpoints
             "identifier": "8WSAJCJ",
             "external_identifier": null,
             "email": "customer@example.org",
-            "phone": "+493012345678",
             "name": "John Doe",
             "name_parts": {
                 "_scheme": "full",
@@ -124,7 +109,6 @@ Endpoints
         "identifier": "8WSAJCJ",
         "external_identifier": null,
         "email": "customer@example.org",
-        "phone": "+493012345678",
         "name": "John Doe",
         "name_parts": {
             "_scheme": "full",
@@ -162,8 +146,6 @@ Endpoints
 
       {
         "email": "test@example.org",
-        "phone": "+493012345678",
-        "password": "verysecret",
         "send_email": true
       }
 
@@ -179,7 +161,6 @@ Endpoints
         "identifier": "8WSAJCJ",
         "external_identifier": null,
         "email": "test@example.org",
-        "phone": "+493012345678",
         ...
       }
 
@@ -224,7 +205,6 @@ Endpoints
         "identifier": "8WSAJCJ",
         "external_identifier": null,
         "email": "test@example.org",
-        "phone": "+493012345678",
         …
       }
 
@@ -259,7 +239,6 @@ Endpoints
         "identifier": "8WSAJCJ",
         "external_identifier": null,
         "email": null,
-        "phone": null,
         …
       }
 

doc/api/resources/devices.rst

@@ -1,4 +1,4 @@
-.. spelling:word-list:: fullname
+.. spelling:: fullname
 
 .. _`rest-devices`:
 
@@ -24,8 +24,6 @@ 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
@@ -78,8 +76,6 @@ 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"
           }
@@ -127,8 +123,6 @@ 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"
       }
@@ -179,8 +173,6 @@ 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

@@ -20,12 +20,8 @@ id                                       integer                    Internal ID
 active                                   boolean                    The discount will be ignored if this is ``false``
 internal_name                            string                     A name for the rule used in the backend
 position                                 integer                    An integer, used for sorting the rules which are applied in order
-all_sales_channels                       boolean                    If ``true`` (default), the discount is available on all sales channels
-                                                                    that support discounts.
-limit_sales_channels                     list of strings            List of sales channel identifiers the discount is available on
-                                                                    if ``all_sales_channels`` is ``false``.
-sales_channels                           list of strings            **DEPRECATED.** Legacy interface, use ``all_sales_channels``
-                                                                    and ``limit_sales_channels`` instead.
+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
@@ -35,13 +31,9 @@ subevent_mode                            strings                    Determines h
                                                                     ``"same"`` (discount is only applied for groups within
                                                                     the same date), or ``"distinct"`` (discount is only applied
                                                                     for groups with no two same dates).
-subevent_date_from                       datetime                   The first date time of a subevent to which this discount can be applied
-                                                                    (or ``null``). Ignored in non-series events.
-subevent_date_until                      datetime                   The last date time of a subevent to which this discount can be applied
-                                                                    (or ``null``). Ignored in non-series events.
-condition_all_products                   boolean                    If ``true``, the discount condition applies to all items.
+condition_all_products                   boolean                    If ``true``, the discount applies to all items.
 condition_limit_products                 list of integers           If ``condition_all_products`` is not set, this is a list
-                                                                    of internal item IDs that the discount condition applies to.
+                                                                    of internal item IDs that the discount applies to.
 condition_apply_to_addons                boolean                    If ``true``, the discount applies to add-on products as well,
                                                                     otherwise it only applies to top-level items. The discount never
                                                                     applies to bundled products.
@@ -56,17 +48,6 @@ benefit_discount_matching_percent        decimal (string)           The percenta
 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.
 ======================================== ========================== =======================================================
 
 
@@ -103,24 +84,16 @@ Endpoints
             "active": true,
             "internal_name": "3 for 2",
             "position": 1,
-            "all_sales_channels": false,
-            "limit_sales_channels": ["web"],
             "sales_channels": ["web"],
             "available_from": null,
             "available_until": null,
             "subevent_mode": "mixed",
-            "subevent_date_from": null,
-            "subevent_date_until": null,
             "condition_all_products": true,
             "condition_limit_products": [],
             "condition_apply_to_addons": true,
             "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
           }
@@ -163,24 +136,16 @@ Endpoints
         "active": true,
         "internal_name": "3 for 2",
         "position": 1,
-        "all_sales_channels": false,
-        "limit_sales_channels": ["web"],
         "sales_channels": ["web"],
         "available_from": null,
         "available_until": null,
         "subevent_mode": "mixed",
-        "subevent_date_from": null,
-        "subevent_date_until": null,
         "condition_all_products": true,
         "condition_limit_products": [],
         "condition_apply_to_addons": true,
         "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
       }
@@ -209,24 +174,16 @@ Endpoints
         "active": true,
         "internal_name": "3 for 2",
         "position": 1,
-        "all_sales_channels": false,
-        "limit_sales_channels": ["web"],
         "sales_channels": ["web"],
         "available_from": null,
         "available_until": null,
         "subevent_mode": "mixed",
-        "subevent_date_from": null,
-        "subevent_date_until": null,
         "condition_all_products": true,
         "condition_limit_products": [],
         "condition_apply_to_addons": true,
         "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
       }
@@ -244,24 +201,16 @@ Endpoints
         "active": true,
         "internal_name": "3 for 2",
         "position": 1,
-        "all_sales_channels": false,
-        "limit_sales_channels": ["web"],
         "sales_channels": ["web"],
         "available_from": null,
         "available_until": null,
         "subevent_mode": "mixed",
-        "subevent_date_from": null,
-        "subevent_date_until": null,
         "condition_all_products": true,
         "condition_limit_products": [],
         "condition_apply_to_addons": true,
         "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
       }
@@ -308,24 +257,16 @@ Endpoints
         "active": false,
         "internal_name": "3 for 2",
         "position": 1,
-        "all_sales_channels": false,
-        "limit_sales_channels": ["web"],
         "sales_channels": ["web"],
         "available_from": null,
         "available_until": null,
         "subevent_mode": "mixed",
-        "subevent_date_from": null,
-        "subevent_date_until": null,
         "condition_all_products": true,
         "condition_limit_products": [],
         "condition_apply_to_addons": true,
         "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
       }

doc/api/resources/events.rst

@@ -1,4 +1,4 @@
-.. spelling:word-list::
+.. spelling::
 
    geo
    lat
@@ -36,8 +36,6 @@ 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,18 +47,39 @@ item_meta_properties                  object                     Item-specific m
 valid_keys                            object                     Cryptographic keys for non-default signature schemes.
                                                                  For performance reason, value is omitted in lists and
                                                                  only contained in detail views. Value can be cached.
-all_sales_channels                    boolean                    If ``true`` (default), the event is available on all sales channels.
-limit_sales_channels                  list of strings            List of sales channel identifiers the event is available on
-                                                                 if ``all_sales_channels`` is ``false``.
-sales_channels                        list of strings            **DEPRECATED.** Legacy interface, use ``all_sales_channels``
-                                                                 and ``limit_sales_channels`` instead.
-public_url                            string                     The public, customer-facing URL of the event (read-only).
+sales_channels                        list                       A list of sales channels this event is available for
+                                                                 sale on.
 ===================================== ========================== =======================================================
 
 
+.. 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.
@@ -71,15 +90,6 @@ 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.
@@ -134,14 +144,11 @@ Endpoints
               "pretix.plugins.paypal",
               "pretix.plugins.ticketoutputpdf"
             ],
-            "all_sales_channels": false,
-            "limit_sales_channels": [
+            "sales_channels": [
               "web",
               "pretixpos",
               "resellers"
-            ],
-            "sales_channels": [],
-            "public_url": "https://pretix.eu/bigevents/sampleconf/"
+            ]
           }
         ]
       }
@@ -149,14 +156,9 @@ 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.
@@ -230,14 +232,11 @@ Endpoints
             "LS0tLS1CRUdJTiBQVUJMSUMgS0VZLS0tLS0KTUNvd0JRWURLMlZ3QXlFQTdBRDcvdkZBMzNFc1k0ejJQSHI3aVpQc1o4bjVkaDBhalA4Z3l6Tm1tSXM9Ci0tLS0tRU5EIFBVQkxJQyBLRVktLS0tLQo="
           ]
         },
-        "all_sales_channels": true,
-        "limit_sales_channels": [],
         "sales_channels": [
           "web",
           "pretixpos",
           "resellers"
-        ],
-        "public_url": "https://pretix.eu/bigevents/sampleconf/"
+        ]
       }
 
    :param organizer: The ``slug`` field of the organizer to fetch
@@ -289,8 +288,11 @@ Endpoints
           "pretix.plugins.stripe",
           "pretix.plugins.paypal"
         ],
-        "all_sales_channels": true,
-        "limit_sales_channels": []
+        "sales_channels": [
+          "web",
+          "pretixpos",
+          "resellers"
+        ]
       }
 
    **Example response**:
@@ -326,14 +328,11 @@ Endpoints
           "pretix.plugins.stripe",
           "pretix.plugins.paypal"
         ],
-        "all_sales_channels": true,
-        "limit_sales_channels": [],
         "sales_channels": [
           "web",
           "pretixpos",
           "resellers"
-        ],
-        "public_url": "https://pretix.eu/bigevents/sampleconf/"
+        ]
       }
 
    :param organizer: The ``slug`` field of the organizer of the event to create.
@@ -351,8 +350,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``, ``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.
+   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.
 
    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.
@@ -393,8 +392,11 @@ Endpoints
           "pretix.plugins.stripe",
           "pretix.plugins.paypal"
         ],
-        "all_sales_channels": true,
-        "limit_sales_channels": []
+        "sales_channels": [
+          "web",
+          "pretixpos",
+          "resellers"
+        ]
       }
 
    **Example response**:
@@ -430,14 +432,11 @@ Endpoints
           "pretix.plugins.stripe",
           "pretix.plugins.paypal"
         ],
-        "all_sales_channels": true,
-        "limit_sales_channels": [],
         "sales_channels": [
           "web",
           "pretixpos",
           "resellers"
-        ],
-        "public_url": "https://pretix.eu/bigevents/sampleconf/"
+        ]
       }
 
    :param organizer: The ``slug`` field of the organizer of the event to create.
@@ -507,14 +506,11 @@ Endpoints
           "pretix.plugins.paypal",
           "pretix.plugins.pretixdroid"
         ],
-        "all_sales_channels": true,
-        "limit_sales_channels": [],
         "sales_channels": [
           "web",
           "pretixpos",
           "resellers"
-        ],
-        "public_url": "https://pretix.eu/bigevents/sampleconf/"
+        ]
       }
 
    :param organizer: The ``slug`` field of the organizer of the event to update
@@ -565,16 +561,15 @@ 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.
 
-.. note:: When authenticating with :ref:`rest-deviceauth`, only a limited subset of settings is available.
+.. versionchanged:: 3.6
+
+   Initial support for settings has been added to the API.
 
 .. http:get:: /api/v1/organizers/(organizer)/events/(event)/settings/
 
@@ -616,7 +611,6 @@ organizer level.
           {
             "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."
           }
         },
@@ -630,10 +624,6 @@ organizer level.
    :statuscode 401: Authentication failure
    :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
 
-   .. versionchanged:: 4.18
-
-       The ``readonly`` flag has been added.
-
 .. http:patch:: /api/v1/organizers/(organizer)/events/(event)/settings/
 
    Updates event settings. Note that ``PUT`` is not allowed here, only ``PATCH``.

doc/api/resources/exporters.rst

@@ -1,6 +1,4 @@
-.. spelling:word-list:: checkin
-
-.. _rest-exporters:
+.. spelling:: checkin
 
 Data exporters
 ==============
@@ -8,6 +6,10 @@ 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
@@ -113,7 +115,7 @@ Listing available exporters
             "input_parameters": [
               {
                 "name": "events",
-                "required": false
+                "required": true
               },
               {
                 "name": "_format",
@@ -180,7 +182,7 @@ endpoints:
       Content-Type: application/json
 
       {
-        "download": "https://pretix.eu/api/v1/organizers/bigevents/events/sampleconf/exporters/orderlist/download/29891ede-196f-4942-9e26-d055a36e98b8/3f279f13-c198-4137-b49b-9b360ce9fcce/"
+        "download": "https://pretix.eu/api/v1/organizers/bigevents/events/sampleconf/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,12 +20,6 @@ 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:
@@ -41,20 +35,15 @@ 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.
@@ -87,8 +76,6 @@ Endpoints
             "testmode": false,
             "expires": null,
             "conditions": null,
-            "owner_ticket": null,
-            "issuer": "bigevents",
             "value": "13.37"
           }
         ]
@@ -96,14 +83,8 @@ Endpoints
 
    :query integer page: The page number in case of a multi-page result set, default is 1
    :query string secret: Only show gift cards with the given secret.
-   :query string value: Only show gift cards with the given value.
-   :query boolean expired: Filter for gift cards that are (not) expired.
    :query boolean testmode: Filter for gift cards that are (not) in test mode.
    :query boolean include_accepted: Also show gift cards issued by other organizers that are accepted by this organizer.
-   :query string expand: If you pass ``"owner_ticket"``, the respective field will be shown as a nested value instead of just an ID.
-                         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
@@ -136,8 +117,6 @@ Endpoints
         "testmode": false,
         "expires": null,
         "conditions": null,
-        "owner_ticket": null,
-        "issuer": "bigevents",
         "value": "13.37"
       }
 
@@ -182,16 +161,10 @@ 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
@@ -236,8 +209,6 @@ Endpoints
         "currency": "EUR",
         "expires": null,
         "conditions": null,
-        "owner_ticket": null,
-        "issuer": "bigevents",
         "value": "14.00"
       }
 
@@ -283,11 +254,13 @@ 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.
@@ -328,11 +301,7 @@ Endpoints
             "value": "50.00",
             "event": "democon",
             "order": "FXQYW",
-            "text": null,
-            "acceptor": "bigevents",
-            "info": {
-              "created_by": "plugin1"
-            }
+            "text": null
           }
         ]
       }

doc/api/resources/index.rst

@@ -18,11 +18,9 @@ at :ref:`plugin-docs`.
    item_variations
    item_bundles
    item_add-ons
-   item_meta_properties
    questions
    question_options
    quotas
-   seats
    orders
    invoices
    vouchers
@@ -31,29 +29,15 @@ at :ref:`plugin-docs`.
    checkinlists
    waitinglist
    customers
-   saleschannels
    membershiptypes
    memberships
    giftcards
-   reusablemedia
    carts
    teams
    devices
    webhooks
    seatingplans
    exporters
-   scheduled_exports
-   shredders
-   banktransfer
-   ticketoutputpdf
-   badges
    sendmail_rules
-   auto_checkin_rules
-   campaigns
-   certificates
-   digital
-   exhibitors
-   imported_secrets
-   shipping
    billing_invoices
-   billing_var
+   billing_var

doc/api/resources/invoices.rst

@@ -12,7 +12,6 @@ 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.
@@ -43,7 +42,6 @@ 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.
@@ -97,7 +95,6 @@ lines                                 list of objects            The actual invo
 ├ gross_value                         money (string)             Price including taxes
 ├ tax_value                           money (string)             Tax amount included
 ├ tax_name                            string                     Name of used tax rate (e.g. "VAT")
-├ tax_code                            string                     Codified reason for tax rate (or ``null``), see :ref:`rest-taxcodes`.
 └ tax_rate                            decimal (string)           Used tax rate
 foreign_currency_display              string                     If the invoice should also show the total and tax
                                                                  amount in a different currency, this contains the
@@ -111,6 +108,16 @@ 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.
@@ -123,17 +130,9 @@ internal_reference                    string                     Customer's refe
 
    The attribute ``lines.subevent`` has been added.
 
-.. versionchanged:: 2023.8
 
-   The ``event`` attribute has been added. The organizer-level endpoint has been added.
-
-.. versionchanged:: 2024.8
-
-   The ``tax_code`` attribute has been added.
-
-
-List of all invoices
---------------------
+Endpoints
+---------
 
 .. http:get:: /api/v1/organizers/(organizer)/events/(event)/invoices/
 
@@ -162,7 +161,6 @@ List of all invoices
         "results": [
           {
             "number": "SAMPLECONF-00001",
-            "event": "sampleconf",
             "order": "ABC12",
             "is_cancellation": false,
             "invoice_from_name": "Big Events LLC",
@@ -190,7 +188,6 @@ List of all invoices
             "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": [
               {
@@ -208,7 +205,6 @@ List of all invoices
                 "gross_value": "23.00",
                 "tax_value": "0.00",
                 "tax_name": "VAT",
-                "tax_code": "S/standard",
                 "tax_rate": "0.00"
               }
             ],
@@ -223,9 +219,6 @@ List of all invoices
    :query boolean is_cancellation: If set to ``true`` or ``false``, only invoices with this value for the field
                                    ``is_cancellation`` will be returned.
    :query string order: If set, only invoices belonging to the order with the given order code will be returned.
-                        This parameter may be given multiple times. In this case, all invoices matching one of the inputs will be returned.
-   :query string number: If set, only invoices with the given invoice number will be returned.
-                        This parameter may be given multiple times. In this case, all invoices matching one of the inputs will be returned.
    :query string refers: If set, only invoices referring to the given invoice will be returned.
    :query string locale: If set, only invoices with the given locale will be returned.
    :query string ordering: Manually set the ordering of results. Valid fields to be used are ``date`` and
@@ -236,50 +229,6 @@ List of all invoices
    :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.
@@ -302,7 +251,6 @@ Fetching individual invoices
 
       {
         "number": "SAMPLECONF-00001",
-        "event": "sampleconf",
         "order": "ABC12",
         "is_cancellation": false,
         "invoice_from_name": "Big Events LLC",
@@ -330,7 +278,6 @@ Fetching individual invoices
         "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": [
           {
@@ -348,7 +295,6 @@ Fetching individual invoices
             "gross_value": "23.00",
             "tax_value": "0.00",
             "tax_name": "VAT",
-            "tax_code": "S/standard",
             "tax_rate": "0.00"
           }
         ],
@@ -359,12 +305,12 @@ Fetching individual invoices
 
    :param organizer: The ``slug`` field of the organizer to fetch
    :param event: The ``slug`` field of the event to fetch
-   :param number: The ``number`` field of the invoice to fetch
+   :param invoice_no: The ``invoice_no`` field of the invoice to fetch
    :statuscode 200: no error
    :statuscode 401: Authentication failure
    :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
 
-.. http:get:: /api/v1/organizers/(organizer)/events/(event)/invoices/(number)/download/
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/invoices/(invoice_no)/download/
 
    Download an invoice in PDF format.
 
@@ -391,20 +337,14 @@ Fetching individual invoices
 
    :param organizer: The ``slug`` field of the organizer to fetch
    :param event: The ``slug`` field of the event to fetch
-   :param number: The ``number`` field of the invoice to fetch
+   :param invoice_no: The ``invoice_no`` field of the invoice to fetch
    :statuscode 200: no error
    :statuscode 401: Authentication failure
    :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
    :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/(number)/reissue/
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/invoices/(invoice_no)/reissue/
 
    Cancels the invoice and creates a new one.
 
@@ -426,13 +366,13 @@ Invoices cannot be edited directly, but the following actions can be triggered:
 
    :param organizer: The ``slug`` field of the organizer to fetch
    :param event: The ``slug`` field of the event to fetch
-   :param number: The ``number`` field of the invoice to reissue
+   :param invoice_no: The ``invoice_no`` field of the invoice to reissue
    :statuscode 200: no error
    :statuscode 400: The invoice has already been canceled
    :statuscode 401: Authentication failure
    :statuscode 403: The requested organizer/event does not exist **or** you have no permission to change this resource.
 
-.. http:post:: /api/v1/organizers/(organizer)/events/(event)/invoices/(number)/regenerate/
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/invoices/(invoice_no)/regenerate/
 
    Re-generates the invoice from order data.
 
@@ -454,7 +394,7 @@ Invoices cannot be edited directly, but the following actions can be triggered:
 
    :param organizer: The ``slug`` field of the organizer to fetch
    :param event: The ``slug`` field of the event to fetch
-   :param number: The ``number`` field of the invoice to regenerate
+   :param invoice_no: The ``invoice_no`` field of the invoice to regenerate
    :statuscode 200: no error
    :statuscode 400: The invoice has already been canceled
    :statuscode 401: Authentication failure

doc/api/resources/item_meta_properties.rst

@@ -1,211 +0,0 @@
-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,19 +18,12 @@ 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,42 +31,20 @@ require_membership                    boolean                    If ``true``, bo
 require_membership_hidden             boolean                    If ``true`` and ``require_membership`` is set, this variation will
                                                                  be hidden from users without a valid membership.
 require_membership_types              list of integers           Internal IDs of membership types valid if ``require_membership`` is ``true``
-all_sales_channels                    boolean                    If ``true`` (default), the variation is available on all sales channels.
-limit_sales_channels                  list of strings            List of sales channel identifiers the variation is available on
-                                                                 if ``all_sales_channels`` is ``false``.
+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 variation to be
-                                                                 available (unless ``all_sales_channels`` is used).
-sales_channels                        list of strings            **DEPRECATED.** Legacy interface, use ``all_sales_channels``
-                                                                 and ``limit_sales_channels`` instead.
+                                                                 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.
 ===================================== ========================== =======================================================
 
-.. 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
 ---------
 
@@ -108,19 +79,13 @@ Endpoints
               "en": "S"
             },
             "active": true,
-            "checkin_attention": false,
-            "checkin_text": null,
             "require_approval": false,
             "require_membership": false,
             "require_membership_hidden": false,
             "require_membership_types": [],
-            "all_sales_channels": false,
-            "limit_sales_channels": ["web"],
             "sales_channels": ["web"],
             "available_from": null,
-            "available_from_mode": "hide",
             "available_until": null,
-            "available_until_mode": "hide",
             "hide_without_voucher": false,
             "description": {
               "en": "Test2"
@@ -129,8 +94,6 @@ Endpoints
             "default_price": "223.00",
             "price": 223.0,
             "original_price": null,
-            "free_price_suggestion": null,
-            "meta_data": {}
           },
           {
             "id": 3,
@@ -138,33 +101,19 @@ Endpoints
               "en": "L"
             },
             "active": true,
-            "checkin_attention": false,
-            "checkin_text": null,
             "require_approval": false,
             "require_membership": false,
             "require_membership_hidden": false,
             "require_membership_types": [],
-            "all_sales_channels": false,
-            "limit_sales_channels": ["web"],
-            "sales_channels": ["web"],
-            "available_from": null,
-            "available_from_mode": "hide",
-            "available_until": null,
-            "available_until_mode": "hide",
-            "hide_without_voucher": false,
             "description": {},
             "position": 1,
-            "default_price": "223.00",
-            "price": 223.0,
-            "original_price": null,
-            "free_price_suggestion": null,
-            "meta_data": {}
+            "default_price": null,
+            "price": 15.0
           }
         ]
       }
 
    :query integer page: The page number in case of a multi-page result set, default is 1
-   :query string search: Filter the list by the value of the variation (substring search).
    :query boolean active: If set to ``true`` or ``false``, only items with this value for the field ``active`` will be
                           returned.
    :param organizer: The ``slug`` field of the organizer to fetch
@@ -202,25 +151,17 @@ 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": [],
-        "all_sales_channels": false,
-        "limit_sales_channels": ["web"],
         "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,
-        "meta_data": {}
+        "position": 0
       }
 
    :param organizer: The ``slug`` field of the organizer to fetch
@@ -248,22 +189,16 @@ 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": [],
-        "all_sales_channels": false,
-        "limit_sales_channels": ["web"],
+        "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,
-        "meta_data": {}
+        "position": 0
       }
 
    **Example response**:
@@ -280,25 +215,17 @@ 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": [],
-        "all_sales_channels": false,
-        "limit_sales_channels": ["web"],
         "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,
-        "meta_data": {}
+        "position": 0
       }
 
    :param organizer: The ``slug`` field of the organizer of the event/item to create a variation for
@@ -346,25 +273,17 @@ 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": [],
-        "all_sales_channels": false,
-        "limit_sales_channels": ["web"],
         "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,
-        "meta_data": {}
+        "position": 1
       }
 
    :param organizer: The ``slug`` field of the organizer to modify

doc/api/resources/items.rst

@@ -11,205 +11,148 @@ 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).
-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``).
-all_sales_channels                      boolean                    If ``true`` (default), the item is available on all sales channels.
-limit_sales_channels                    list of strings            List of sales channel identifiers the item is available on
-                                                                   if ``all_sales_channels`` is ``false``.
-sales_channels                          list of strings            **DEPRECATED.** Legacy interface, use ``all_sales_channels``
-                                                                   and ``limit_sales_channels`` instead.
-available_from                          datetime                   The first date time at which this item can be bought
-                                                                   (or ``null``).
-available_from_mode                     string                     If ``hide`` (the default), this item is hidden in the shop
-                                                                   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.
-hidden_if_item_available_mode           string                     If ``hide`` (the default), this item is hidden in the shop
-                                                                   if unavailable due to the ``hidden_if_item_available`` setting.
-                                                                   If ``info``, the item is visible, but can't be purchased,
-                                                                   and a note explaining the unavailability is displayed.
-require_voucher                         boolean                    If ``true``, this item can only be bought using a
-                                                                   voucher that is specifically assigned to this item.
-hide_without_voucher                    boolean                    If ``true``, this item is only shown during the voucher
-                                                                   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``.
-├ all_sales_channels                    boolean                    If ``true`` (default), the variation is available on all sales channels.
-├ limit_sales_channels                  list of strings            List of sales channel identifiers the variation is available on
-                                                                   if ``all_sales_channels`` is ``false``.
-                                                                   The item-level list takes precedence, i.e. a sales
-                                                                   channel needs to be on both lists for the variation to be
-                                                                   available (unless ``all_sales_channels`` is used).
-├ sales_channels                        list of strings            **DEPRECATED.** Legacy interface, use ``all_sales_channels``
-                                                                   and ``limit_sales_channels`` instead.
-├ available_from                        datetime                   The first date time at which this variation can be bought
-                                                                   (or ``null``).
-├ available_from_mode                   string                     If ``hide`` (the default), this variation is hidden in the shop
-                                                                   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.
-======================================= ========================== =======================================================
+===================================== ========================== =======================================================
+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``.
 
 .. versionchanged:: 4.0
 
@@ -220,33 +163,6 @@ meta_data                               object                     Values set fo
 
    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.
-
-.. versionchanged:: 2025.01
-
-   The ``hidden_if_item_available_mode`` attributes has been added.
-
 Notes
 -----
 
@@ -290,8 +206,6 @@ Endpoints
             "id": 1,
             "name": {"en": "Standard ticket"},
             "internal_name": "",
-            "all_sales_channels": false,
-            "limit_sales_channels": ["web"],
             "sales_channels": ["web"],
             "default_price": "23.00",
             "original_price": null,
@@ -299,31 +213,22 @@ 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,
-            "hidden_if_item_available_mode": "hide",
             "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,
@@ -336,37 +241,20 @@ 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": [],
-                 "all_sales_channels": false,
-                 "limit_sales_channels": ["web"],
                  "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
               },
               {
@@ -374,23 +262,14 @@ 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": [],
-                 "all_sales_channels": false,
-                 "limit_sales_channels": ["web"],
                  "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
               }
             ],
@@ -401,7 +280,6 @@ Endpoints
       }
 
    :query integer page: The page number in case of a multi-page result set, default is 1
-   :query string search: Filter the list by internal name or name of the item (substring search).
    :query boolean active: If set to ``true`` or ``false``, only items with this value for the field ``active`` will be
                           returned.
    :query integer category: If set to the ID of a category, only items within that category will be returned.
@@ -442,8 +320,6 @@ Endpoints
         "id": 1,
         "name": {"en": "Standard ticket"},
         "internal_name": "",
-        "all_sales_channels": false,
-        "limit_sales_channels": ["web"],
         "sales_channels": ["web"],
         "default_price": "23.00",
         "original_price": null,
@@ -451,24 +327,16 @@ 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,
-        "hidden_if_item_available_mode": "hide",
         "require_voucher": false,
         "hide_without_voucher": false,
         "allow_cancel": true,
@@ -478,7 +346,6 @@ Endpoints
         "min_per_order": null,
         "max_per_order": null,
         "checkin_attention": false,
-        "checkin_text": null,
         "has_variations": false,
         "require_approval": false,
         "require_bundling": false,
@@ -488,37 +355,20 @@ 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,
-             "all_sales_channels": false,
-             "limit_sales_channels": ["web"],
              "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
           },
           {
@@ -526,23 +376,14 @@ 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": [],
-             "all_sales_channels": false,
-             "limit_sales_channels": ["web"],
              "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
           }
         ],
@@ -574,32 +415,23 @@ Endpoints
         "id": 1,
         "name": {"en": "Standard ticket"},
         "internal_name": "",
-        "all_sales_channels": false,
-        "limit_sales_channels": ["web"],
+        "sales_channels": ["web"],
         "default_price": "23.00",
         "original_price": null,
         "category": null,
         "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,
-        "hidden_if_item_available_mode": "hide",
         "require_voucher": false,
         "hide_without_voucher": false,
         "allow_cancel": true,
@@ -609,7 +441,6 @@ Endpoints
         "min_per_order": null,
         "max_per_order": null,
         "checkin_attention": false,
-        "checkin_text": null,
         "require_approval": false,
         "require_bundling": false,
         "require_membership": false,
@@ -618,36 +449,20 @@ 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": [],
-             "all_sales_channels": false,
-             "limit_sales_channels": ["web"],
+             "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
           },
           {
@@ -655,22 +470,14 @@ 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": [],
-             "all_sales_channels": false,
-             "limit_sales_channels": ["web"],
+             "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
           }
         ],
@@ -690,8 +497,6 @@ Endpoints
         "id": 1,
         "name": {"en": "Standard ticket"},
         "internal_name": "",
-        "all_sales_channels": false,
-        "limit_sales_channels": ["web"],
         "sales_channels": ["web"],
         "default_price": "23.00",
         "original_price": null,
@@ -699,24 +504,16 @@ 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,
-        "hidden_if_item_available_mode": "hide",
         "require_voucher": false,
         "hide_without_voucher": false,
         "allow_cancel": true,
@@ -726,7 +523,6 @@ Endpoints
         "allow_waitinglist": true,
         "show_quota_left": null,
         "checkin_attention": false,
-        "checkin_text": null,
         "has_variations": true,
         "require_approval": false,
         "require_bundling": false,
@@ -736,37 +532,20 @@ 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": [],
-             "all_sales_channels": false,
-             "limit_sales_channels": ["web"],
              "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
           },
           {
@@ -774,23 +553,14 @@ 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": [],
-             "all_sales_channels": false,
-             "limit_sales_channels": ["web"],
              "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
           }
         ],
@@ -841,8 +611,6 @@ Endpoints
         "id": 1,
         "name": {"en": "Ticket"},
         "internal_name": "",
-        "all_sales_channels": false,
-        "limit_sales_channels": ["web"],
         "sales_channels": ["web"],
         "default_price": "25.00",
         "original_price": null,
@@ -850,24 +618,16 @@ 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,
-        "hidden_if_item_available_mode": "hide",
         "require_voucher": false,
         "hide_without_voucher": false,
         "generate_tickets": null,
@@ -877,7 +637,6 @@ Endpoints
         "min_per_order": null,
         "max_per_order": null,
         "checkin_attention": false,
-        "checkin_text": null,
         "has_variations": true,
         "require_approval": false,
         "require_bundling": false,
@@ -887,37 +646,20 @@ 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": [],
-             "all_sales_channels": false,
-             "limit_sales_channels": ["web"],
              "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
           },
           {
@@ -925,23 +667,14 @@ 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": [],
-             "all_sales_channels": false,
-             "limit_sales_channels": ["web"],
              "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/organizers.rst

@@ -17,18 +17,12 @@ 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.
@@ -57,7 +51,6 @@ Endpoints
           {
             "name": "Big Events LLC",
             "slug": "Big Events",
-            "public_url": "https://pretix.eu/bigevents/"
           }
         ]
       }
@@ -91,7 +84,6 @@ Endpoints
       {
         "name": "Big Events LLC",
         "slug": "Big Events",
-        "public_url": "https://pretix.eu/bigevents/"
       }
 
    :param organizer: The ``slug`` field of the organizer to fetch
@@ -117,6 +109,10 @@ 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.
@@ -157,7 +153,6 @@ 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:word-list::
+.. spelling::
 
    checkin
    datetime
@@ -44,8 +44,6 @@ 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
@@ -65,7 +63,6 @@ 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
@@ -79,13 +76,26 @@ dependency_value                      string                     An old version
                                                                  for one value. **Deprecated.**
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 2023.8
+.. versionchanged:: 3.5
 
-   The ``show_during_checkin`` attribute has been added.
+  The attribute ``help_text`` has been added.
+
+.. versionchanged:: 3.14
+
+  The attributes ``valid_*`` have been added.
+
+.. versionchanged:: 3.18
+
+  The attribute ``valid_file_portrait`` have been added.
 
 Endpoints
 ---------
 
+.. versionchanged:: 1.15
+
+   The questions endpoint has been extended by the filter queries ``ask_during_checkin``, ``requred``, and
+   ``identifier``.
+
 .. http:get:: /api/v1/organizers/(organizer)/events/(event)/questions/
 
    Returns a list of all questions within a given event.
@@ -121,7 +131,6 @@ Endpoints
             "position": 1,
             "identifier": "WY3TP9SL",
             "ask_during_checkin": false,
-            "show_during_checkin": false,
             "hidden": false,
             "print_on_invoice": false,
             "valid_number_min": null,
@@ -130,7 +139,6 @@ 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,
@@ -201,7 +209,6 @@ Endpoints
         "position": 1,
         "identifier": "WY3TP9SL",
         "ask_during_checkin": false,
-        "show_during_checkin": false,
         "hidden": false,
         "print_on_invoice": false,
         "valid_number_min": null,
@@ -211,7 +218,6 @@ 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": [],
@@ -265,7 +271,6 @@ Endpoints
         "items": [1, 2],
         "position": 1,
         "ask_during_checkin": false,
-        "show_during_checkin": false,
         "hidden": false,
         "print_on_invoice": false,
         "dependency_question": null,
@@ -302,7 +307,6 @@ Endpoints
         "position": 1,
         "identifier": "WY3TP9SL",
         "ask_during_checkin": false,
-        "show_during_checkin": false,
         "hidden": false,
         "print_on_invoice": false,
         "dependency_question": null,
@@ -315,7 +319,6 @@ Endpoints
         "valid_datetime_min": null,
         "valid_datetime_max": null,
         "valid_file_portrait": false,
-        "valid_string_length_max": null,
         "options": [
           {
             "id": 1,
@@ -358,7 +361,7 @@ Endpoints
 
    .. sourcecode:: http
 
-      PATCH /api/v1/organizers/bigevents/events/sampleconf/questions/1/ HTTP/1.1
+      PATCH /api/v1/organizers/bigevents/events/sampleconf/items/1/ HTTP/1.1
       Host: pretix.eu
       Accept: application/json, text/javascript
       Content-Type: application/json
@@ -386,7 +389,6 @@ Endpoints
         "position": 2,
         "identifier": "WY3TP9SL",
         "ask_during_checkin": false,
-        "show_during_checkin": false,
         "hidden": false,
         "print_on_invoice": false,
         "dependency_question": null,
@@ -399,7 +401,6 @@ Endpoints
         "valid_datetime_min": null,
         "valid_datetime_max": null,
         "valid_file_portrait": false,
-        "valid_string_length_max": null,
         "options": [
           {
             "id": 1,
@@ -426,7 +427,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 question could not be modified due to invalid submitted data
+   :statuscode 400: The item 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.
 
@@ -438,7 +439,7 @@ Endpoints
 
    .. sourcecode:: http
 
-      DELETE /api/v1/organizers/bigevents/events/sampleconf/questions/1/ HTTP/1.1
+      DELETE /api/v1/organizers/bigevents/events/sampleconf/items/1/ HTTP/1.1
       Host: pretix.eu
       Accept: application/json, text/javascript
 
@@ -451,7 +452,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 question to delete
+   :param id: The ``id`` field of the item 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,6 +36,10 @@ 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.

doc/api/resources/reusablemedia.rst

@@ -1,327 +0,0 @@
-.. _`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/saleschannels.rst

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

doc/api/resources/scheduled_exports.rst

@@ -1,556 +0,0 @@
-.. 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/seats.rst

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

doc/api/resources/sendmail_rules.rst

@@ -1,12 +1,10 @@
-Scheduled email rules
+Automated email rules
 =====================
 
-This feature requires the bundled ``pretix.plugins.sendmail`` plugin to be active for the event in order to work properly.
-
 Resource description
 --------------------
 
-Scheduled email rules that specify emails that the system will send automatically at a specific point in time, e.g.
+Automated email rules that specify emails that the system will send automatically at a specific point in time, e.g.
 the day of the event.
 
 .. rst-class:: rest-resource-table
@@ -20,19 +18,8 @@ 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
-[**DEPRECATED**] include_pending      boolean                    If ``true``, the email is sent to pending orders. If ``false``,
+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
@@ -51,10 +38,6 @@ send_to                               string                     Can be ``"order
                                                                  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
 ---------
@@ -91,12 +74,7 @@ Endpoints
             "template": {"en": "Don't forget your tickets, download them at {url}"},
             "all_products": true,
             "limit_products": [],
-            "restrict_to_status": [
-                "p",
-                "n__not_pending_approval_and_not_valid_if_pending",
-                "n__valid_if_pending"
-            ],
-            "checked_in_status": null,
+            "include_pending": false,
             "send_date": null,
             "send_offset_days": 1,
             "send_offset_time": "18:00",
@@ -142,12 +120,7 @@ Endpoints
         "template": {"en": "Don't forget your tickets, download them at {url}"},
         "all_products": true,
         "limit_products": [],
-        "restrict_to_status": [
-            "p",
-            "n__not_pending_approval_and_not_valid_if_pending",
-            "n__valid_if_pending"
-        ],
-        "checked_in_status": null,
+        "include_pending": false,
         "send_date": null,
         "send_offset_days": 1,
         "send_offset_time": "18:00",
@@ -184,12 +157,7 @@ Endpoints
         "template": {"en": "Don't forget your tickets, download them at {url}"},
         "all_products": true,
         "limit_products": [],
-        "restrict_to_status": [
-            "p",
-            "n__not_pending_approval_and_not_valid_if_pending",
-            "n__valid_if_pending"
-        ],
-        "checked_in_status": "checked_in",
+        "include_pending": false,
         "send_date": null,
         "send_offset_days": 1,
         "send_offset_time": "18:00",
@@ -214,12 +182,7 @@ Endpoints
         "template": {"en": "Don't forget your tickets, download them at {url}"},
         "all_products": true,
         "limit_products": [],
-        "restrict_to_status": [
-            "p",
-            "n__not_pending_approval_and_not_valid_if_pending",
-            "n__valid_if_pending"
-        ],
-        "checked_in_status": "checked_in",
+        "include_pending": false,
         "send_date": null,
         "send_offset_days": 1,
         "send_offset_time": "18:00",
@@ -272,12 +235,7 @@ Endpoints
         "template": {"en": "Don't forget your tickets, download them at {url}"},
         "all_products": true,
         "limit_products": [],
-        "restrict_to_status": [
-            "p",
-            "n__not_pending_approval_and_not_valid_if_pending",
-            "n__valid_if_pending"
-        ],
-        "checked_in_status": "checked_in",
+        "include_pending": false,
         "send_date": null,
         "send_offset_days": 1,
         "send_offset_time": "18:00",

doc/api/resources/shredders.rst

@@ -1,177 +0,0 @@
-.. 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:word-list::
+.. spelling::
 
    geo
    lat
@@ -59,22 +59,29 @@ seat_category_mapping                 object                     An object mappi
 last_modified                         datetime                   Last modification of this object
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 4.15
+.. versionchanged:: 3.3
 
-    The ``search`` query parameter has been added to filter sub-events by their name or location in any language.
+   The attributes ``geo_lat`` and ``geo_lon`` have been added.
 
-.. versionchanged:: 5.0
+.. versionchanged:: 3.10
 
-    The ``date_from_before``, ``date_from_after``, ``date_to_before``, and ``date_to_after`` query parameters have been
-    added.
+   The ``disabled`` attribute has been added to ``item_price_overrides`` and ``variation_price_overrides``.
 
-.. versionchanged:: 2023.8.0
+.. versionchanged:: 3.12
 
-    For the organizer-wide endpoint, the ``search`` query parameter has been modified to filter sub-events by their parent events slug too.
+   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``.
 
 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.
@@ -136,16 +143,10 @@ Endpoints
       }
 
    :query page: The page number in case of a multi-page result set, default is 1
-   :query is_public: If set to ``true``/``false``, only subevents with a matching value of ``is_public`` are returned.
    :query active: If set to ``true``/``false``, only events with a matching value of ``active`` are returned.
    :query is_future: If set to ``true`` (``false``), only events that happen currently or in the future are (not) returned.
    :query is_past: If set to ``true`` (``false``), only events that are over are (not) returned.
-   :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
@@ -468,17 +469,11 @@ Endpoints
       }
 
    :query page: The page number in case of a multi-page result set, default is 1
-   :query is_public: If set to ``true``/``false``, only subevents with a matching value of ``is_public`` are returned.
    :query active: If set to ``true``/``false``, only events with a matching value of ``active`` are returned.
    :query event__live: If set to ``true``/``false``, only events with a matching value of ``live`` on the parent event are returned.
    :query is_future: If set to ``true`` (``false``), only events that happen currently or in the future are (not) returned.
    :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

doc/api/resources/taxrules.rst

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

doc/api/resources/teams.rst

@@ -1,4 +1,4 @@
-.. spelling:word-list:: fullname checkin
+.. spelling:: fullname checkin
 
 .. _`rest-teams`:
 
@@ -22,13 +22,10 @@ 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
@@ -39,10 +36,6 @@ can_change_vouchers                   boolean
 can_checkin_orders                    boolean
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 4.18
-
-    The ``can_manage_reusable_media`` permission has been added.
-
 Team member resource
 --------------------
 
@@ -124,7 +117,6 @@ Team endpoints
             "name": "Admin team",
             "all_events": true,
             "limit_events": [],
-            "require_2fa": true,
             "can_create_events": true,
             ...
           }
@@ -162,7 +154,6 @@ Team endpoints
         "name": "Admin team",
         "all_events": true,
         "limit_events": [],
-        "require_2fa": true,
         "can_create_events": true,
         ...
       }
@@ -190,7 +181,6 @@ Team endpoints
         "name": "Admin team",
         "all_events": true,
         "limit_events": [],
-        "require_2fa": true,
         "can_create_events": true,
         ...
       }
@@ -208,7 +198,6 @@ Team endpoints
         "name": "Admin team",
         "all_events": true,
         "limit_events": [],
-        "require_2fa": true,
         "can_create_events": true,
         ...
       }
@@ -252,7 +241,6 @@ Team endpoints
         "name": "Admin team",
         "all_events": true,
         "limit_events": [],
-        "require_2fa": true,
         "can_create_events": true,
         ...
       }

doc/api/resources/ticketoutputpdf.rst

@@ -1,342 +0,0 @@
-PDF ticket output
-=================
-
-The build-in PDF ticket output plugin provides a HTTP API that exposes the various layouts used
-to generate PDF tickets.
-
-Resource description
---------------------
-
-The ticket layout resource contains the following public fields:
-
-.. rst-class:: rest-resource-table
-
-===================================== ========================== =======================================================
-Field                                 Type                       Description
-===================================== ========================== =======================================================
-id                                    integer                    Internal layout ID
-name                                  string                     Internal layout description
-default                               boolean                    ``true`` if this is the default layout
-layout                                list                       Dynamic layout specification. Each list element
-                                                                 corresponds to one dynamic element of the layout.
-                                                                 The current version of the schema in use can be found
-                                                                 `here`_.
-                                                                 Submitting invalid content can lead to application errors.
-background                            URL                        Background PDF file
-item_assignments                      list of objects            Products this layout is assigned to (currently read-only)
-├ sales_channel                       string                     Sales channel (defaults to ``web``).
-└ item                                integer                    Item ID
-===================================== ========================== =======================================================
-
-
-Layout endpoints
-----------------
-
-.. http:get:: /api/v1/organizers/(organizer)/events/(event)/ticketlayouts/
-
-   Returns a list of all ticket layouts
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      GET /api/v1/organizers/bigevents/events/democon/ticketlayouts/ HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-
-   **Example response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 200 OK
-      Vary: Accept
-      Content-Type: text/javascript
-
-      {
-        "count": 1,
-        "next": null,
-        "previous": null,
-        "results": [
-          {
-            "id": 1,
-            "name": "Default layout",
-            "default": true,
-            "layout": {…},
-            "background": null,
-            "item_assignments": []
-          }
-        ]
-      }
-
-   :query page: The page number in case of a multi-page result set, default is 1
-   :param organizer: The ``slug`` field of a valid organizer
-   :param event: The ``slug`` field of a valid event
-   :statuscode 200: no error
-   :statuscode 401: Authentication failure
-   :statuscode 403: The requested organizer does not exist **or** you have no permission to view it.
-
-.. http:get:: /api/v1/organizers/(organizer)/events/(event)/ticketlayouts/(id)/
-
-   Returns information on layout.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      GET /api/v1/organizers/bigevents/events/democon/ticketlayouts/1/ HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-
-   **Example response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 200 OK
-      Vary: Accept
-      Content-Type: text/javascript
-
-      {
-        "id": 1,
-        "name": "Default layout",
-        "default": true,
-        "layout": {…},
-        "background": null,
-        "item_assignments": []
-      }
-
-   :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 layout to fetch
-   :statuscode 200: no error
-   :statuscode 401: Authentication failure
-   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view it.
-
-.. http:get:: /api/v1/organizers/(organizer)/events/(event)/ticketlayoutitems/
-
-   Returns a list of all assignments of items to layouts
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      GET /api/v1/organizers/bigevents/events/democon/ticketlayoutitems/ HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-
-   **Example response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 200 OK
-      Vary: Accept
-      Content-Type: text/javascript
-
-      {
-        "count": 1,
-        "next": null,
-        "previous": null,
-        "results": [
-          {
-            "id": 1,
-            "layout": 2,
-            "item": 3,
-            "sales_channel": web
-          }
-        ]
-      }
-
-   :query page: The page number in case of a multi-page result set, default is 1
-   :param organizer: The ``slug`` field of a valid organizer
-   :param event: The ``slug`` field of a valid event
-   :statuscode 200: no error
-   :statuscode 401: Authentication failure
-   :statuscode 403: The requested organizer does not exist **or** you have no permission to view it.
-
-.. http:post:: /api/v1/organizers/(organizer)/events/(event)/ticketlayouts/
-
-   Creates a new ticket layout
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      POST /api/v1/organizers/bigevents/events/sampleconf/ticketlayouts/ HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-      Content-Type: application/json
-
-      {
-        "name": "Default layout",
-        "default": true,
-        "layout": […],
-        "background": null,
-        "item_assignments": []
-      }
-
-   **Example response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 201 Created
-      Vary: Accept
-      Content-Type: application/json
-
-      {
-        "id": 1,
-        "name": "Default layout",
-        "default": true,
-        "layout": […],
-        "background": null,
-        "item_assignments": []
-      }
-
-   :param organizer: The ``slug`` field of the organizer of the event to create a layout for
-   :param event: The ``slug`` field of the event to create a layout for
-   :statuscode 201: no error
-   :statuscode 400: The layout 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)/ticketlayouts/(id)/
-
-   Update a layout. 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/ticketlayouts/1/ HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-      Content-Type: application/json
-      Content-Length: 94
-
-      {
-        "name": "Default layout"
-      }
-
-   **Example response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 200 OK
-      Vary: Accept
-      Content-Type: application/json
-
-      {
-        "id": 1,
-        "name": "Default layout",
-        "default": true,
-        "layout": […],
-        "background": null,
-        "item_assignments": []
-      }
-
-   :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 layout to modify
-   :statuscode 200: no error
-   :statuscode 400: The layout 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)/ticketlayouts/(id)/
-
-   Delete a layout.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      DELETE /api/v1/organizers/bigevents/events/sampleconf/ticketlayouts/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 layout 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.
-
-Ticket rendering endpoint
------------------------------
-
-.. http:post:: /api/v1/organizers/(organizer)/events/(event)/ticketpdfrenderer/render_batch/
-
-   With this API call, you can instruct the system to render a set of tickets into one combined PDF file. To specify
-   which tickets to render, you need to submit a list of "parts". For every part, the following fields are supported:
-
-   * ``orderposition`` (``integer``, required): The ID of the order position to render.
-   * ``override_channel`` (``string``, optional): The sales channel ID to be used for layout selection instead of the
-     original channel of the order.
-   * ``override_layout`` (``integer``, optional): The ticket layout ID to be used instead of the auto-selected one.
-
-   If your input parameters validate correctly, a ``202 Accepted`` status code is returned.
-   The body points you to the download URL of the result. Running a ``GET`` request on that result URL will
-   yield one of the following status codes:
-
-    * ``200 OK`` – The export succeeded. The body will be your resulting file. Might be large!
-    * ``409 Conflict`` – Your export is still running. The body will be JSON with the structure ``{"status": "running"}``. ``status`` can be ``waiting`` before the task is actually being processed. Please retry, but wait at least one second before you do.
-    * ``410 Gone`` – Running the export has failed permanently. The body will be JSON with the structure ``{"status": "failed", "message": "Error message"}``
-    * ``404 Not Found`` – The export does not exist / is expired.
-
-   .. warning:: This endpoint is considered **experimental**. It might change at any time without prior notice.
-
-   .. note:: To avoid performance issues, a maximum number of 1000 parts is currently allowed.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      POST /api/v1/organizers/bigevents/events/sampleconf/ticketpdfrenderer/render_batch/ HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-      Content-Type: application/json
-
-      {
-        "parts": [
-          {
-            "orderposition": 55412
-          },
-          {
-            "orderposition": 55412,
-            "override_channel": "web"
-          },
-          {
-            "orderposition": 55412,
-            "override_layout": 56
-          }
-        ]
-      }
-
-   **Example response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 200 OK
-      Vary: Accept
-      Content-Type: application/json
-
-      {
-        "download": "https://pretix.eu/api/v1/organizers/bigevents/events/sampleconf/ticketpdfrenderer/download/29891ede-196f-4942-9e26-d055a36e98b8/3f279f13-c198-4137-b49b-9b360ce9fcce/"
-      }
-
-   :param organizer: The ``slug`` field of the organizer to fetch
-   :param event: The ``slug`` field of the event to fetch
-   :statuscode 202: no error
-   :statuscode 400: Invalid input options
-   :statuscode 401: Authentication failure
-   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
-
-
-.. _here: https://github.com/pretix/pretix/blob/master/src/pretix/static/schema/pdf-layout.schema.json

doc/api/resources/vouchers.rst

@@ -19,8 +19,6 @@ 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
@@ -47,11 +45,13 @@ 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
 ---------
 
@@ -97,9 +97,6 @@ Endpoints
             "comment": "",
             "seat": null,
             "subevent": null,
-            "show_hidden_items": false,
-            "all_addons_included": false,
-            "all_bundles_included": false
           }
         ]
       }
@@ -166,10 +163,7 @@ Endpoints
         "tag": "testvoucher",
         "comment": "",
         "seat": null,
-        "subevent": null,
-        "show_hidden_items": false,
-        "all_addons_included": false,
-        "all_bundles_included": false
+        "subevent": null
       }
 
    :param organizer: The ``slug`` field of the organizer to fetch
@@ -206,10 +200,7 @@ Endpoints
         "quota": null,
         "tag": "testvoucher",
         "comment": "",
-        "subevent": null,
-        "show_hidden_items": false,
-        "all_addons_included": false,
-        "all_bundles_included": false
+        "subevent": null
       }
 
    **Example response**:
@@ -236,10 +227,7 @@ Endpoints
         "tag": "testvoucher",
         "comment": "",
         "seat": null,
-        "subevent": null,
-        "show_hidden_items": false,
-        "all_addons_included": false,
-        "all_bundles_included": false
+        "subevent": null
       }
 
    :param organizer: The ``slug`` field of the organizer to create a voucher for
@@ -278,10 +266,7 @@ Endpoints
           "quota": null,
           "tag": "testvoucher",
           "comment": "",
-          "subevent": null,
-          "show_hidden_items": false,
-          "all_addons_included": false,
-          "all_bundles_included": false
+          "subevent": null
         },
         {
           "code": "ASDKLJCYXCASDASD",
@@ -296,10 +281,7 @@ Endpoints
           "quota": null,
           "tag": "testvoucher",
           "comment": "",
-          "subevent": null,
-          "show_hidden_items": false,
-          "all_addons_included": false,
-          "all_bundles_included": false
+          "subevent": null
         },
 
    **Example response**:
@@ -373,10 +355,7 @@ Endpoints
         "tag": "testvoucher",
         "comment": "",
         "seat": null,
-        "subevent": null,
-        "show_hidden_items": false,
-        "all_addons_included": false,
-        "all_bundles_included": false
+        "subevent": null
       }
 
    :param organizer: The ``slug`` field of the organizer to modify

doc/api/resources/waitinglist.rst

@@ -30,6 +30,12 @@ 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,7 +26,6 @@ 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:
@@ -37,24 +36,12 @@ 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.deleted`` (can only occur for test mode orders)
-    * ``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``
@@ -63,14 +50,6 @@ 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.
 
@@ -109,14 +88,12 @@ Endpoints
             "target_url": "https://httpstat.us/200",
             "all_events": false,
             "limit_events": ["democon"],
-            "action_types": ["pretix.event.order.modified", "pretix.event.order.changed.*"],
-            "comment": null
+            "action_types": ["pretix.event.order.modified", "pretix.event.order.changed.*"]
           }
         ]
       }
 
    :query integer page: The page number in case of a multi-page result set, default is 1
-   :query boolean enabled: Only show webhooks that are or are not enabled
    :param organizer: The ``slug`` field of the organizer to fetch
    :statuscode 200: no error
    :statuscode 401: Authentication failure
@@ -148,8 +125,7 @@ Endpoints
         "target_url": "https://httpstat.us/200",
         "all_events": false,
         "limit_events": ["democon"],
-        "action_types": ["pretix.event.order.modified", "pretix.event.order.changed.*"],
-        "comment": null
+        "action_types": ["pretix.event.order.modified", "pretix.event.order.changed.*"]
       }
 
    :param organizer: The ``slug`` field of the organizer to fetch
@@ -176,8 +152,7 @@ Endpoints
         "target_url": "https://httpstat.us/200",
         "all_events": false,
         "limit_events": ["democon"],
-        "action_types": ["pretix.event.order.modified", "pretix.event.order.changed.*"],
-        "comment": "Called for changes"
+        "action_types": ["pretix.event.order.modified", "pretix.event.order.changed.*"]
       }
 
    **Example response**:
@@ -194,8 +169,7 @@ Endpoints
         "target_url": "https://httpstat.us/200",
         "all_events": false,
         "limit_events": ["democon"],
-        "action_types": ["pretix.event.order.modified", "pretix.event.order.changed.*"],
-        "comment": "Called for changes"
+        "action_types": ["pretix.event.order.modified", "pretix.event.order.changed.*"]
       }
 
    :param organizer: The ``slug`` field of the organizer to create a webhook for
@@ -240,8 +214,7 @@ Endpoints
         "target_url": "https://httpstat.us/200",
         "all_events": false,
         "limit_events": ["democon"],
-        "action_types": ["pretix.event.order.modified", "pretix.event.order.changed.*"],
-        "comment": null
+        "action_types": ["pretix.event.order.modified", "pretix.event.order.changed.*"]
       }
 
    :param organizer: The ``slug`` field of the organizer to modify

doc/api/webhooks.rst

@@ -92,10 +92,9 @@ 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`` 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.
+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.
 
 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,6 +13,10 @@
 # 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
 
@@ -24,13 +28,12 @@ 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  # noqa
 
+try:
+    import enchant
     HAS_PYENCHANT = True
 except:
     HAS_PYENCHANT = False
@@ -38,7 +41,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
@@ -49,7 +52,6 @@ extensions = [
     'sphinx.ext.coverage',
     'sphinxcontrib.httpdomain',
     'sphinxcontrib.images',
-    'sphinxcontrib.jquery',
     'sphinxemoji.sphinxemoji',
 ]
 if HAS_PYENCHANT:
@@ -62,14 +64,14 @@ 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'
 
 # General information about the project.
 project = 'pretix'
-copyright = '2014-{}, rami.io GmbH'.format(date.today().year)
+copyright = '2014-{}, Raphael Michel'.format(date.today().year)
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -77,20 +79,19 @@ copyright = '2014-{}, rami.io GmbH'.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.
@@ -98,34 +99,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
@@ -135,14 +136,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.
@@ -151,7 +152,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,
@@ -165,18 +166,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.
@@ -191,24 +192,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'
@@ -216,46 +217,47 @@ 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 Developer Documentation',
-     'rami.io GmbH', '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 ---------------------------------------
@@ -263,12 +265,12 @@ latex_documents = [
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'pretix', 'pretix Developer Documentation',
-     ['rami.io GmbH'], 1)
+    ('index', 'pretix', 'pretix Documentation',
+     ['Raphael Michel'], 1)
 ]
 
 # If true, show URL addresses after external links.
-# man_show_urls = False
+#man_show_urls = False
 
 
 # -- Options for Texinfo output -------------------------------------------
@@ -277,22 +279,22 @@ man_pages = [
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    ('index', 'pretix', 'pretix Developer Documentation',
-     'rami.io GmbH', '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 = {
@@ -312,13 +314,12 @@ 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/contents.rst

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

doc/development/api/cookieconsent.rst

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

doc/development/api/customview.rst

@@ -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.urls import re_path
+    from django.conf.urls import url
 
     from . import views
 
     urlpatterns = [
-        re_path(r'^control/event/(?P<organizer>[^/]+)/(?P<event>[^/]+)/mypluginname/',
-                views.admin_view, name='backend'),
+        url(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,13 +60,7 @@ The exporter class
    .. py:attribute:: BaseExporter.event
 
       The default constructor sets this property to the event we are currently
-      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.
+      working for.
 
    .. autoattribute:: identifier
 
@@ -76,10 +70,6 @@ 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,10 +11,9 @@ Core
 ----
 
 .. automodule:: pretix.base.signals
-   :members: periodic_task, event_live_issues, event_copy_data, email_filter, register_notification_types, notification,
-      item_copy_data, register_sales_channel_types, register_global_settings, quota_availability, global_email_filter,
-      register_ticket_secret_generators, gift_card_transaction_display,
-      register_text_placeholders, register_mail_placeholders, device_info_updated
+   :members: periodic_task, event_live_issues, event_copy_data, email_filter, register_notification_types,
+      item_copy_data, register_sales_channels, register_global_settings, quota_availability, global_email_filter,
+      register_ticket_secret_generators
 
 Order events
 """"""""""""
@@ -22,14 +21,12 @@ Order events
 There are multiple signals that will be sent out in the ordering cycle:
 
 .. automodule:: pretix.base.signals
-   :no-index:
-   :members: validate_cart, validate_cart_addons, validate_order, order_valid_if_pending, order_fee_calculation, order_paid, order_placed, order_canceled, order_reactivated, order_expired, order_expiry_changed, order_modified, order_changed, order_approved, order_denied, order_fee_type_name, allow_ticket_download, order_split, order_gracefully_delete, invoice_line_text
+   :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
 
 Check-ins
 """""""""
 
 .. automodule:: pretix.base.signals
-   :no-index:
    :members: checkin_created
 
 
@@ -37,25 +34,22 @@ Frontend
 --------
 
 .. automodule:: pretix.presale.signals
-   :members: html_head, html_footer, footer_link, global_footer_link, front_page_top, front_page_bottom, front_page_bottom_widget, fee_calculation_for_cart, contact_form_fields, question_form_fields, contact_form_fields_overrides, question_form_fields_overrides, checkout_confirm_messages, checkout_confirm_page_content, checkout_all_optional, html_page_header, render_seating_plan, checkout_flow_steps, position_info, position_info_top, item_description, global_html_head, global_html_footer, global_html_page_header, seatingframe_html_head
+   :members: html_head, html_footer, footer_link, global_footer_link, front_page_top, front_page_bottom, front_page_bottom_widget, fee_calculation_for_cart, contact_form_fields, question_form_fields, contact_form_fields_overrides, question_form_fields_overrides, checkout_confirm_messages, checkout_confirm_page_content, checkout_all_optional, html_page_header, sass_preamble, sass_postamble, render_seating_plan, checkout_flow_steps, position_info, position_info_top, item_description, global_html_head, global_html_footer, global_html_page_header
 
 
 .. automodule:: pretix.presale.signals
-   :no-index:
-   :members: order_info, order_info_top, order_meta_from_request, order_api_meta_from_request
+   :members: order_info, order_info_top, order_meta_from_request
 
 Request flow
 """"""""""""
 
 .. automodule:: pretix.presale.signals
-   :no-index:
    :members: process_request, process_response
 
 Vouchers
 """"""""
 
 .. automodule:: pretix.presale.signals
-   :no-index:
    :members: voucher_redeem_info
 
 Backend
@@ -67,28 +61,24 @@ Backend
              item_formsets, order_search_filter_q, order_search_forms
 
 .. automodule:: pretix.base.signals
-   :no-index:
-   :members: logentry_display, logentry_object_link, requiredaction_display, timeline_events, orderposition_blocked_display, customer_created, customer_signed_in
+   :members: logentry_display, logentry_object_link, requiredaction_display, timeline_events
 
 Vouchers
 """"""""
 
 .. automodule:: pretix.control.signals
-   :no-index:
    :members: item_forms, voucher_form_class, voucher_form_html, voucher_form_validation
 
 Dashboards
 """"""""""
 
 .. automodule:: pretix.control.signals
-   :no-index:
    :members: event_dashboard_widgets, user_dashboard_widgets, event_dashboard_top
 
 Ticket designs
 """"""""""""""
 
 .. automodule:: pretix.base.signals
-   :no-index:
    :members: layout_text_variables, layout_image_variables
 
 .. automodule:: pretix.plugins.ticketoutputpdf.signals
@@ -98,9 +88,4 @@ API
 ---
 
 .. automodule:: pretix.base.signals
-   :no-index:
    :members: validate_event_settings, api_event_settings_fields
-
-.. automodule:: pretix.api.signals
-   :no-index:
-   :members: register_device_security_profile, order_api_details, orderposition_api_details

doc/development/api/import.rst

@@ -3,12 +3,11 @@
 
 .. _`importcol`:
 
-Extending the import process
-============================
+Extending the order import process
+==================================
 
-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.
+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.
 
 Import process
 --------------
@@ -41,7 +40,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.modelimport.ImportColumn``
+should listen for this signal and return the subclass of ``pretix.base.orderimport.ImportColumn``
 that we'll provide in this plugin:
 
 .. sourcecode:: python
@@ -57,17 +56,10 @@ that we'll provide in this plugin:
             EmailColumn(sender),
         ]
 
-Similar signals exist for other objects:
-
-.. automodule:: pretix.base.signals
-   :no-index:
-   :members: voucher_import_columns
-
-
 The column class API
 --------------------
 
-.. class:: pretix.base.modelimport.ImportColumn
+.. class:: pretix.base.orderimport.ImportColumn
 
    The central object of each import extension is the subclass of ``ImportColumn``.
 

doc/development/api/payment.rst

@@ -70,8 +70,6 @@ The provider class
 
    .. autoattribute:: settings_form_fields
 
-   .. autoattribute:: walletqueries
-
    .. automethod:: settings_form_clean
 
    .. automethod:: settings_content_render
@@ -104,8 +102,6 @@ The provider class
 
    .. automethod:: render_invoice_text
 
-   .. automethod:: render_invoice_stamp
-
    .. automethod:: order_change_allowed
 
    .. automethod:: payment_prepare
@@ -124,20 +120,14 @@ 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
@@ -146,10 +136,6 @@ 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,11 +1,10 @@
 .. highlight:: python
    :linenothreshold: 5
 
-Writing a template placeholder plugin
-=====================================
+Writing an e-mail placeholder plugin
+====================================
 
-A template placeholder is a dynamic value that pretix users can use in their email templates and in other
-configurable texts.
+An email placeholder is a dynamic value that pretix users can use in their email templates.
 
 Please read :ref:`Creating a plugin <pluginsetup>` first, if you haven't already.
 
@@ -13,31 +12,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 placeholders. Your plugin
-should listen for this signal and return an instance of a subclass of ``pretix.base.services.placeholders.BaseTextPlaceholder``:
+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``:
 
 .. code-block:: python
 
     from django.dispatch import receiver
 
-    from pretix.base.signals import register_text_placeholders
+    from pretix.base.signals import register_mail_placeholders
 
 
-    @receiver(register_text_placeholders, dispatch_uid="placeholder_custom")
-    def register_placeholder_renderers(sender, **kwargs):
-        from .placeholders import MyPlaceholderClass
+    @receiver(register_mail_placeholders, dispatch_uid="placeholder_custom")
+    def register_mail_renderers(sender, **kwargs):
+        from .email import MyPlaceholderClass
         return MyPlaceholder()
 
 
 Context mechanism
 -----------------
 
-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.
+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.
 
-Not all placeholders make sense everywhere, and placeholders usually depend on some parameters
+Not all placeholders make sense in every email, and placeholders usually depend 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 a context where all those dependencies are
+what values they depend on and they will only be available in an email if all those dependencies are
 met. Currently, placeholders can depend on the following context parameters:
 
 * ``event``
@@ -52,7 +51,7 @@ There are a few more that are only to be used internally but not by plugins.
 The placeholder class
 ---------------------
 
-.. class:: pretix.base.services.placeholders.BaseTextPlaceholder
+.. class:: pretix.base.email.BaseMailTextPlaceholder
 
    .. autoattribute:: identifier
 
@@ -78,18 +77,7 @@ functions:
 
 .. code-block:: python
 
-     placeholder = SimpleFunctionalTextPlaceholder(
+     placeholder = SimpleFunctionalMailTextPlaceholder(
          'code', ['order'], lambda order: order.code, sample='F8VVL'
      )
 
-Signals
--------
-
-.. automodule:: pretix.base.signals
-   :no-index:
-   :members: register_text_placeholders
-
-.. automodule:: pretix.base.signals
-   :no-index:
-   :members: register_mail_placeholders
-

doc/development/api/plugins.rst

@@ -55,6 +55,7 @@ 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.
 ================== ==================== ===========================================================
 
@@ -84,8 +85,6 @@ A working example would be:
             restricted = False
             description = _("This plugin allows you to receive payments via PayPal")
             compatibility = "pretix>=2.7.0"
-            settings_links = []
-            navigation_links = []
 
 
     default_app_config = 'pretix_paypal.PaypalApp'
@@ -123,7 +122,6 @@ This will automatically make pretix discover this plugin as soon as it is instal
 through ``pip``. During development, you can just run ``python setup.py develop`` inside
 your plugin source directory to make it discoverable.
 
-.. _`signals`:
 Signals
 -------
 
@@ -156,25 +154,6 @@ in the ``installed`` method:
 Note that ``installed`` will *not* be called if the plugin is indirectly activated for an event
 because the event is created with settings copied from another event.
 
-.. _`registries`:
-Registries
-----------
-
-Many signals in pretix are used so that plugins can "register" a class, e.g. a payment provider or a
-ticket renderer.
-
-However, for some of them (types of :ref:`Log Entries <logging>`) we use a different method to keep track of them:
-In a ``Registry``, classes are collected at application startup, along with a unique key (in case
-of LogEntryType, the ``action_type``) as well as which plugin registered them.
-
-To register a class, you can use one of several decorators provided by the Registry object:
-
-.. autoclass:: pretix.base.logentrytypes.LogEntryTypeRegistry
-   :members: register, new, new_from_dict
-
-All files in which classes are registered need to be imported in the ``AppConfig.ready`` as explained
-in `Signals <signals>`_ above.
-
 Views
 -----
 
@@ -187,28 +166,6 @@ your Django app label.
    with checking that the calling user is logged in, has appropriate permissions,
    etc. We plan on providing native support for this in a later version.
 
-To make your plugin views easily discoverable, you can specify links for "Go to"
-and "Settings" buttons next to your entry on the plugin page. These links should be
-added to the ``navigation_links`` and ``settings_links``, respectively, in the
-``PretixPluginMeta`` class.
-
-Each array entry consists of a tuple ``(label, urlname, kwargs)``. For the label,
-either a string or a tuple of strings can be specified. In the latter case, the provided
-strings will be merged with a separator indicating they are successive navigation steps
-the user would need to take to reach the page via the regular menu
-(e.g. "Payment > Bank transfer" as below).
-
-.. code-block:: python
-
-        settings_links = [
-            ((_("Payment"), _("Bank transfer")), "control:event.settings.payment.provider", {"provider": "banktransfer"}),
-        ]
-        navigation_links = [
-            ((_("Bank transfer"), _("Import bank data")), "plugins:banktransfer:import", {}),
-            ((_("Bank transfer"), _("Export refunds")), "plugins:banktransfer:refunds.list", {}),
-        ]
-
-
 .. _Django app: https://docs.djangoproject.com/en/3.0/ref/applications/
 .. _signal dispatcher: https://docs.djangoproject.com/en/3.0/topics/signals/
 .. _namespace packages: https://legacy.python.org/dev/peps/pep-0420/

doc/development/concepts.rst

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

doc/development/contribution/style.rst

@@ -1,4 +1,4 @@
-.. spelling:word-list:: Rebase rebasing
+.. spelling:: 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/4.2/topics/i18n/translation/
+.. _translation features: https://docs.djangoproject.com/en/1.9/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,5 +18,3 @@ Contents:
    email
    permissions
    logging
-   locking
-   timemachine

doc/development/implementation/locking.rst

@@ -1,69 +0,0 @@
-.. 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/logging.rst

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

doc/development/implementation/models.rst

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

doc/development/implementation/permissions.rst

@@ -184,6 +184,11 @@ 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 [#f1]_
+* References to Django ``File`` objects that are already stored in a storage backend
 * 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,9 +55,6 @@ You can simply use it like this:
                        "preserve his reservation."),
        )
 
-
-.. _settings-defaults-in-plugins:
-
 Defaults in plugins
 -------------------
 
@@ -73,9 +70,3 @@ 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.