First steps

.clabot

@@ -1,5 +0,0 @@
-{
-  "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.",
-  "label": "cla-signed"
-}

.dockerignore

@@ -1,10 +1,3 @@
 doc/
 env/
 res/
-local/
-.git/
-pretixeu/
-src/data/
-src/pretix/static.dist/
-src/dist/
-

.gitattributes

@@ -6,7 +6,6 @@ src/pretix/static/datetimepicker/* linguist-vendored
 src/pretix/static/colorpicker/* linguist-vendored
 src/pretix/static/fileupload/* linguist-vendored
 src/pretix/static/vuejs/* linguist-vendored
-src/pretix/static/d3/* linguist-vendored
 src/pretix/static/select2/* linguist-vendored
 src/pretix/static/charts/* linguist-vendored
 src/pretix/static/rrule/* linguist-vendored

.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

@@ -1,18 +0,0 @@
-# To get started with Dependabot version updates, you'll need to specify which
-# package ecosystems to update and where the package manifests are located.
-# Please see the documentation for all configuration options:
-# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
-
-version: 2
-updates:
-  - package-ecosystem: "pip"
-    directory: "/"
-    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

@@ -1,49 +0,0 @@
-name: Documentation
-
-on:
-  push:
-    branches: [ master ]
-    paths-ignore:
-      - 'src/pretix/locale/**'
-      - 'src/pretix/static/**'
-      - 'src/tests/**'
-  pull_request:
-    branches: [ master ]
-    paths-ignore:
-      - 'src/pretix/locale/**'
-      - '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
-    steps:
-      - uses: actions/checkout@v4
-      - name: Set up Python 3.11
-        uses: actions/setup-python@v5
-        with:
-          python-version: 3.11
-      - uses: actions/cache@v4
-        with:
-          path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
-          restore-keys: |
-            ${{ runner.os }}-pip-
-      - name: Install system packages
-        run: sudo apt update && sudo apt install -y enchant-2 hunspell aspell-en
-      - name: Install Dependencies
-        run: pip3 install -Ur requirements.txt
-        working-directory: ./doc
-      - name: Spellcheck docs
-        run: make spelling
-        working-directory: ./doc
-      - name:
-        run: '[ ! -s _build/spelling/output.txt ]'
-        working-directory: ./doc

.github/workflows/strings.yml

@@ -1,68 +0,0 @@
-name: Strings
-
-on:
-  push:
-    branches: [ master ]
-    paths:
-      - 'doc/**'
-      - 'src/pretix/locale/**'
-  pull_request:
-    branches: [ master ]
-    paths:
-      - 'doc/**'
-      - 'src/pretix/locale/**'
-
-permissions:
-  contents: read  #  to fetch code (actions/checkout)
-
-env:
-  FORCE_COLOR: 1
-
-jobs:
-  compile:
-    runs-on: ubuntu-22.04
-    name: Check gettext syntax
-    steps:
-      - uses: actions/checkout@v4
-      - name: Set up Python 3.11
-        uses: actions/setup-python@v5
-        with:
-          python-version: 3.11
-      - uses: actions/cache@v4
-        with:
-          path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
-          restore-keys: |
-            ${{ runner.os }}-pip-
-      - name: Install system packages
-        run: sudo apt update && sudo apt -y install gettext
-      - name: Install Dependencies
-        run: pip3 install uv && uv pip install --system -e ".[dev]"
-      - name: Compile messages
-        run: python manage.py compilemessages
-        working-directory: ./src
-      - name: Compile jsi18n
-        run: python manage.py compilejsi18n
-        working-directory: ./src
-  spelling:
-    runs-on: ubuntu-22.04
-    name: Spellcheck
-    steps:
-      - uses: actions/checkout@v4
-      - name: Set up Python 3.11
-        uses: actions/setup-python@v5
-        with:
-          python-version: 3.11
-      - uses: actions/cache@v4
-        with:
-          path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
-          restore-keys: |
-            ${{ runner.os }}-pip-
-      - name: Install system packages
-        run: sudo apt update && sudo apt install enchant-2 hunspell hunspell-de-de aspell-en aspell-de
-      - name: Install Dependencies
-        run: pip3 install uv && uv pip install --system -e ".[dev]"
-      - name: Spellcheck translations
-        run: potypo
-        working-directory: ./src

.github/workflows/style.yml

@@ -1,78 +0,0 @@
-name: Code Style
-
-on:
-  push:
-    branches: [ master ]
-    paths-ignore:
-      - 'src/pretix/locale/**'
-      - 'src/pretix/static/**'
-  pull_request:
-    branches: [ master ]
-    paths-ignore:
-      - '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
-    steps:
-      - uses: actions/checkout@v4
-      - name: Set up Python 3.11
-        uses: actions/setup-python@v5
-        with:
-          python-version: 3.11
-      - uses: actions/cache@v4
-        with:
-          path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
-          restore-keys: |
-            ${{ runner.os }}-pip-
-      - name: Install Dependencies
-        run: pip3 install uv && uv pip install --system -e ".[dev]" psycopg2-binary
-      - name: Run isort
-        run: isort -c .
-        working-directory: ./src
-  flake:
-    name: flake8
-    runs-on: ubuntu-22.04
-    steps:
-      - uses: actions/checkout@v4
-      - name: Set up Python 3.11
-        uses: actions/setup-python@v5
-        with:
-          python-version: 3.11
-      - uses: actions/cache@v4
-        with:
-          path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
-          restore-keys: |
-            ${{ runner.os }}-pip-
-      - name: Install Dependencies
-        run: pip3 install uv && uv pip install --system -e ".[dev]" psycopg2-binary
-      - name: Run flake8
-        run: flake8 .
-        working-directory: ./src
-  licenseheader:
-    name: licenseheaders
-    runs-on: ubuntu-22.04
-    steps:
-      - uses: actions/checkout@v4
-      - name: Set up Python 3.11
-        uses: actions/setup-python@v5
-        with:
-          python-version: 3.11
-      - name: Install Dependencies
-        run: pip3 install licenseheaders
-      - name: Run licenseheaders
-        run: licenseheaders -t ../.licenseheader -E .py -x "*/migrations/*.py"
-        working-directory: ./src
-      - name: Check for changes
-        run: git diff --exit-code
-        working-directory: ./src

.github/workflows/tests.yml

@@ -1,84 +0,0 @@
-name: Tests
-
-on:
-  push:
-    branches: [ master ]
-    paths-ignore:
-      - 'doc/**'
-  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: Tests
-    strategy:
-      matrix:
-        python-version: ["3.9", "3.10", "3.11"]
-        database: [sqlite, postgres]
-        exclude:
-          - database: sqlite
-            python-version: "3.9"
-          - database: sqlite
-            python-version: "3.10"
-    services:
-      postgres:
-        image: postgres:15
-        env:
-          POSTGRES_PASSWORD: postgres
-          POSTGRES_DB: pretix
-        options: >-
-          --health-cmd "pg_isready -U postgres -d pretix"
-          --health-interval 10s
-          --health-timeout 5s
-          --health-retries 5
-        ports:
-          - 5432:5432
-    steps:
-      - uses: actions/checkout@v4
-      - 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
-      - name: Install Python dependencies
-        run: pip3 install uv && uv pip install --system -e ".[dev]" psycopg2-binary
-      - name: Run checks
-        run: python manage.py check
-        working-directory: ./src
-      - name: Install JS dependencies
-        working-directory: ./src
-        run: make npminstall
-      - name: Compile
-        working-directory: ./src
-        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'
-      - name: Upload coverage
-        uses: codecov/codecov-action@v4
-        with:
-          file: src/coverage.xml
-          token: ${{ secrets.CODECOV_TOKEN }}
-          fail_ci_if_error: false
-        if: matrix.database == 'postgres' && matrix.python-version == '3.11'

.gitignore

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

.gitlab-ci.yml

@@ -1,45 +1,37 @@
+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]"
-        - cd src
-        - python manage.py check
-        - make all compress
-        - PRETIX_CONFIG_FILE=tests/ci_sqlite.cfg py.test -n 3 tests --maxfail=100
+        - virtualenv env
+        - source env/bin/activate
+        - pip install -U pip wheel setuptools
+        - XDG_CACHE_HOME=/cache bash .travis.sh 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
+        - XDG_CACHE_HOME=/cache pip3 install -Ur src/requirements.txt -r src/requirements/dev.txt
+        - cd src
         - 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
-        - twine check dist/*
-        - twine upload dist/*
+        - python setup.py sdist upload
+        - python setup.py bdist_wheel upload
+    tags:
+        - python3
     only:
         - pypi
     artifacts:
         paths:
             - src/dist/
-
 stages:
     - test
     - build

.licenseheader

@@ -1,19 +0,0 @@
-This file is part of pretix (Community Edition).
-
-Copyright (C) 2014-2020  Raphael Michel and contributors
-Copyright (C) 2020-today pretix GmbH and contributors
-
-This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General
-Public License as published by the Free Software Foundation in version 3 of the License.
-
-ADDITIONAL TERMS APPLY: Pursuant to Section 7 of the GNU Affero General Public License, additional terms are
-applicable granting you additional permissions and placing additional restrictions on your usage of this software.
-Please refer to the pretix LICENSE file to obtain the full terms applicable to this work. If you did not receive
-this file, see <https://pretix.eu/about/en/license>.
-
-This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
-warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
-details.
-
-You should have received a copy of the GNU Affero General Public License along with this program.  If not, see
-<https://www.gnu.org/licenses/>.

.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

.travis.sh

@@ -0,0 +1,68 @@
+#!/bin/bash
+set -e
+set -x
+
+echo "Executing job $1"
+
+if [ "$PRETIX_CONFIG_FILE" == "tests/travis_mysql.cfg" ]; then
+    mysql -u root -e 'CREATE DATABASE pretix DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_general_ci;'
+    pip3 install -Ur src/requirements/mysql.txt
+fi
+
+if [ "$PRETIX_CONFIG_FILE" == "tests/travis_postgres.cfg" ]; then
+    psql -c 'create database travis_ci_test;' -U postgres
+fi
+
+if [ "$1" == "style" ]; then
+	XDG_CACHE_HOME=/cache pip3 install -Ur src/requirements.txt -r src/requirements/dev.txt
+	cd src
+    flake8 .
+    isort -c -rc -df .
+fi
+if [ "$1" == "doctests" ]; then
+	XDG_CACHE_HOME=/cache pip3 install -Ur doc/requirements.txt
+	cd doc
+	make doctest
+fi
+if [ "$1" == "doc-spelling" ]; then
+	XDG_CACHE_HOME=/cache pip3 install -Ur doc/requirements.txt
+	cd doc
+	make spelling
+	if [ -s _build/spelling/output.txt ]; then
+		exit 1
+	fi
+fi
+if [ "$1" == "translation-spelling" ]; then
+	XDG_CACHE_HOME=/cache pip3 install -Ur src/requirements/dev.txt
+	cd src
+	potypo
+fi
+if [ "$1" == "tests" ]; then
+	pip3 install -r src/requirements.txt -Ur src/requirements/dev.txt
+	cd src
+	python manage.py check
+	make all compress
+	py.test --reruns 5 -n 3 tests
+fi
+if [ "$1" == "tests-cov" ]; then
+	pip3 install -r src/requirements.txt -Ur src/requirements/dev.txt
+	cd src
+	python manage.py check
+	make all compress
+	coverage run -m py.test --reruns 5 tests && codecov
+fi
+if [ "$1" == "plugins" ]; then
+	pip3 install -r src/requirements.txt -Ur src/requirements/dev.txt
+	cd src
+	python setup.py develop
+	make all compress
+
+	pushd ~
+    git clone --depth 1 https://github.com/pretix/pretix-cartshare.git
+    cd pretix-cartshare
+    python setup.py develop
+    make
+	py.test --reruns 5 tests
+    popd
+
+fi

.travis.yml

@@ -0,0 +1,46 @@
+language: python
+sudo: false
+install:
+  - pip install -U pip wheel setuptools
+script:
+  - bash .travis.sh $JOB
+cache:
+  directories:
+    - $HOME/.cache/pip
+services:
+  - mysql
+  - postgresql
+matrix:
+  include:
+    - python: 3.6
+      env: JOB=tests PRETIX_CONFIG_FILE=tests/travis_sqlite.cfg
+    - python: 3.6
+      env: JOB=tests-cov PRETIX_CONFIG_FILE=tests/travis_postgres.cfg
+    - python: 3.6
+      env: JOB=style
+    - python: 3.6
+      env: JOB=tests PRETIX_CONFIG_FILE=tests/travis_mysql.cfg
+    - python: 3.6
+      env: JOB=tests PRETIX_CONFIG_FILE=tests/travis_postgres.cfg
+    - python: 3.5
+      env: JOB=tests PRETIX_CONFIG_FILE=tests/travis_postgres.cfg
+    - python: 3.6
+      env: JOB=plugins
+    - python: 3.6
+      env: JOB=doc-spelling
+    - python: 3.6
+      env: JOB=translation-spelling
+addons:
+  postgresql: "9.4"
+  mariadb: '10.3'
+  apt:
+      packages:
+          - enchant
+          - myspell-de-de
+          - aspell-en
+          - sqlite3
+  sources:
+    - travis-ci/sqlite3
+branches:
+  except:
+  - /^weblate-.*/

AUTHORS

@@ -0,0 +1,37 @@
+Here is an inevitably incomplete list of much-appreciated contributors --
+people who have submitted patches, reported bugs, added translations, helped
+answer newbie questions, improved the documentation, and generally made pretix
+an awesome project. Thank you all!
+
+	Adam K. Sumner <asumner101@gmail.com>
+	Ahrdie <robert.deppe@me.com>
+	Alexander Brock <Brock.Alexander@web.de>
+	Brandon Pineda
+	Bolutife Lawrence
+	Christian Franke <nobody@nowhere.ws>
+	Christopher Dambamuromo <me@chridam.com>
+	chotee <chotee@openended.eu>
+	Cpt. Foo
+	Daniel Rosenblüh
+	Enrique Saez
+	Flavia Bastos
+	informancer <informancer@web.de>
+	Jakob Schnell <github@ezelo.de>
+	Jan Felix Wiebe <git@jfwie.be>
+	Jan Weiß
+	Jason Estibeiro <jasonestibeiro@live.com>
+	jlwt90
+	Jonas Große Sundrup <cherti@letopolis.de>
+	Kevin Nelson
+	Leah Oswald
+	Lukas Martini
+	Nathan Mattes
+	Nicole Klünder
+	Marc-Pascal Clement
+	Martin Gross <martin@pc-coholic.de>
+	Raphael Michel <mail@raphaelmichel.de>
+	Team MRMCD
+	Tobias Kunze <rixx@cutebit.de>
+	Oliver Knapp <github@oliverknapp.de>
+	Vishal Sodani <vishalsodani@rediffmail.com>
+	Jan Felix Wiebe <git@jfwie.be>

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 an 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.
-
-* 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/).
+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.
 

COPYRIGHT

@@ -0,0 +1,32 @@
+Copyright 2014-2016 Raphael Michel
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+This project includes the work of others, namely:
+
+* Django, (c) Django Software Foundation and contributors, BSD License
+* Font Awesome, (c) Dave Gandy, SIL Open Font License and MIT License
+* Bootstrap, (c) Twitter, Inc., MIT License
+* jQuery, (c) jQuery Foundation and contributors, MIT License
+* django-formset-js, (c) Ionata Web Solutions, BSD License
+* CleanerVersion, (c) Jean-Christophe Zulian, Brian King, Andrea Marcacci, Manuel Jeckelmann, Apache License
+* django-bootstrap3, (c) Dylan Verheul, Apache License
+* pytz, (c) Stuart Bishop, MIT License
+* python-dateutil, (c) Yaron de Leeuw, BSD License
+* startbootstrap-sb-admin-2, (c) Iron Summit Media Strategies, LLC, Apache License
+* metismenu, (c) Osman Nuri Okumus, MIT License
+* easy-thumbnails, (c) Chris Beaven and contributors
+* reportlab, (c) ReportLab Europe Ltd, BSD License
+* django-compressor, (c) Jannis Leidel and contributors, MIT License
+* static3, (c) Roman Mohr and contributors, LGPL License
+* Lightbox, (c) Lokesh Dhakar, MIT License

Dockerfile

@@ -1,8 +1,9 @@
-FROM python:3.11-bookworm
+FROM python:3.6
 
 RUN apt-get update && \
     apt-get install -y --no-install-recommends \
             build-essential \
+            default-libmysqlclient-dev \
             gettext \
             git \
             libffi-dev \
@@ -14,59 +15,55 @@ RUN apt-get update && \
             libxslt1-dev \
             locales \
             nginx \
-            python3-virtualenv \
+            python-dev \
+            python-virtualenv \
             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
-
+    echo 'pretixuser ALL=(ALL) NOPASSWD: /usr/bin/supervisord' >> /etc/sudoers && \
+    mkdir /static
 
 ENV LC_ALL=C.UTF-8 \
     DJANGO_SETTINGS_MODULE=production_settings
 
-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
-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
-
+# To copy only the requirements files needed to install from PIP
+COPY src/requirements /pretix/src/requirements
+COPY src/requirements.txt /pretix/src
 RUN pip3 install -U \
         pip \
         setuptools \
         wheel && \
-    cd /pretix && \
-    PRETIX_DOCKER_BUILD=TRUE pip3 install \
-        -e ".[memcached]" \
-        gunicorn django-extensions ipython && \
+    cd /pretix/src && \
+    pip3 install \
+        -r requirements.txt \
+        -r requirements/memcached.txt \
+        -r requirements/mysql.txt \
+        -r requirements/redis.txt \
+        gunicorn && \
     rm -rf ~/.cache/pip
 
+COPY deployment/docker/pretix.bash /usr/local/bin/pretix
+COPY deployment/docker/supervisord.conf /etc/supervisord.conf
+COPY deployment/docker/nginx.conf /etc/nginx/nginx.conf
+COPY deployment/docker/production_settings.py /pretix/src/production_settings.py
+COPY src /pretix/src
+
 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

@@ -4,11 +4,11 @@ pretix
 .. image:: https://img.shields.io/pypi/v/pretix.svg
    :target: https://pypi.python.org/pypi/pretix
 
-.. image:: https://github.com/pretix/pretix/workflows/Documentation/badge.svg
-   :target: https://docs.pretix.eu/
+.. image:: https://readthedocs.org/projects/pretix/badge/?version=latest
+   :target: https://docs.pretix.eu/en/latest/
 
-.. image:: https://github.com/pretix/pretix/workflows/Tests/badge.svg
-   :target: https://github.com/pretix/pretix/actions/workflows/tests.yml
+.. image:: https://travis-ci.org/pretix/pretix.svg?branch=master
+   :target: https://travis-ci.org/pretix/pretix
 
 .. image:: https://codecov.io/gh/pretix/pretix/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/pretix/pretix
@@ -20,8 +20,9 @@ Reinventing ticket presales, one ticket at a time.
 Project status & release cycle
 ------------------------------
 
-While there is always a lot to do and improve on, pretix by now has been in use for thousands of events
-conferences that sold millions of tickets combined. We therefore think of pretix as being stable and ready to use.
+While there is always a lot to do and improve on, pretix by now has been in use for more than a dozen
+conferences that sold over ten thousand tickets combined without major problems. We therefore think of
+pretix as being stable and ready to use.
 
 If you want to use or extend pretix, we strongly recommend to follow our `blog`_. We will announce all
 releases there. You can always find the latest stable version on PyPI or in the ``release/X.Y`` branch of
@@ -30,13 +31,9 @@ the sense that it does not break your data,  but its APIs might change without p
 
 To get started using pretix on your own server, look at the `installation guide`_ in our documentation.
 
-Support
--------
-
-This project is 100 percent free and open source software. You are welcome to ask questions in the GitHub
-repository. Private support via email or phone is only offered to customers of our pretix Hosted or pretix
-Enterprise offerings. If you are interested in commercial support, hosting services or supporting this project
-financially, please go to `pretix.eu`_ or contact us at support@pretix.eu.
+This project is 100 percent free and open source software. If you are interested in commercial support,
+hosting services or supporting this project financially, please go to `pretix.eu`_ or contact us at
+support@pretix.eu.
 
 Contributing
 ------------
@@ -53,12 +50,14 @@ including issues, pull requests, etc.
 
 License
 -------
+The code in this repository is published under the terms of the Apache License. 
+See the LICENSE file for the complete license text.
 
-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.
+This project is maintained by Raphael Michel <mail@raphaelmichel.de>. See the
+AUTHORS file for a list of all the awesome folks who contributed to this project.
 
-.. _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,22 +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 vulnerabilities.
-
-Please contact us at security@pretix.eu with full details and steps to reproduce and allow reasonable time for us to resolve the issue before publishing your findings. If you wish to encrypt your email, you can find our GPG key [here](https://pretix.eu/.well-known/security@pretix.eu.asc).
-
-Please also see our [Responsible disclosure policy](https://docs.pretix.eu/trust/security/disclosure/).
-
-## 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).
-
-Please also see our [Release cycle](https://docs.pretix.eu/trust/lifecycle/release-cycle/) documentation.

_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-max-body-size.conf

@@ -1 +0,0 @@
-client_max_body_size 100M;

deployment/docker/nginx.conf

@@ -1,13 +1,10 @@
 user www-data www-data;
-worker_processes auto;
+worker_processes 1;
 pid /var/run/nginx.pid;
 daemon off;
-worker_rlimit_nofile 262144;
 
 events {
-    worker_connections 16384;
-    multi_accept on;
-    use epoll;
+	worker_connections 768;
 }
 
 http {
@@ -16,6 +13,7 @@ http {
 	charset utf-8;
 	tcp_nopush on;
 	tcp_nodelay on;
+	client_max_body_size 100M;
 
 	log_format private '[$time_local] $host "$request" $status $body_bytes_sent';
 
@@ -32,7 +30,7 @@ http {
 
 	gzip on;
 	gzip_disable "msie6";
-	gzip_types text/plain text/css application/json application/javascript application/x-javascript text/javascript text/xml application/xml application/rss+xml application/atom+xml application/rdf+xml image/svg+xml;
+	gzip_types text/plain text/html text/css application/json application/javascript application/x-javascript text/javascript text/xml application/xml application/rss+xml application/atom+xml application/rdf+xml image/svg+xml;
 	gzip_vary on;
 	gzip_proxied any;
 	gzip_comp_level 6;
@@ -41,7 +39,7 @@ http {
 	include /etc/nginx/conf.d/*.conf;
 
     server {
-        listen 80 backlog=4096 default_server;
+        listen 80 default_server;
         listen [::]:80 ipv6only=on default_server;
         server_name _;
         index index.php index.html;
@@ -60,31 +58,14 @@ http {
             deny all;
             return 404;
         }
-        location /static/staticfiles.json {
-            deny all;
-            return 404;
-        }
-        location /static/CACHE/manifest.json {
-            deny all;
-            return 404;
-        }
         location /static/ {
             alias /pretix/src/pretix/static.dist/;
             access_log off;
             expires 365d;
             add_header Cache-Control "public";
-            add_header Access-Control-Allow-Origin "*";
-            gzip on;
         }
         location / {
-            # Very important:
-            #   proxy_pass http://unix:/tmp/pretix.sock:;
-            # is not the same as
-            #   proxy_pass http://unix:/tmp/pretix.sock:/;
-            # In the latter case, nginx will apply its URL parsing, in the former it doesn't.
-            # There are situations in which pretix' API will deal with "file names" containing %2F%2F, which
-            # nginx will normalize to %2F, which can break ticket validation.
-            proxy_pass http://unix:/tmp/pretix.sock:;
+            proxy_pass http://unix:/tmp/pretix.sock:/;
             proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
         	proxy_set_header Host $http_host;
         }

deployment/docker/pretix.bash

@@ -3,10 +3,7 @@ cd /pretix/src
 export DJANGO_SETTINGS_MODULE=production_settings
 export DATA_DIR=/data/
 export HOME=/pretix
-
-AUTOMIGRATE=${AUTOMIGRATE:-yes}
-NUM_WORKERS_DEFAULT=$((2 * $(nproc)))
-export NUM_WORKERS=${NUM_WORKERS:-$NUM_WORKERS_DEFAULT}
+export NUM_WORKERS=$((2 * $(nproc --all)))
 
 if [ ! -d /data/logs ]; then
     mkdir /data/logs;
@@ -19,16 +16,10 @@ if [ "$1" == "cron" ]; then
     exec python3 -m pretix runperiodic
 fi
 
-if [ "$AUTOMIGRATE" != "skip" ]; then
-  python3 -m pretix migrate --noinput
-fi
+python3 -m pretix migrate --noinput
 
 if [ "$1" == "all" ]; then
-    exec sudo -E /usr/bin/supervisord -n -c /etc/supervisord.all.conf
-fi
-
-if [ "$1" == "web" ]; then
-    exec sudo -E /usr/bin/supervisord -n -c /etc/supervisord.web.conf
+    exec sudo /usr/bin/supervisord -n -c /etc/supervisord.conf
 fi
 
 if [ "$1" == "webworker" ]; then
@@ -42,12 +33,17 @@ if [ "$1" == "webworker" ]; then
 fi
 
 if [ "$1" == "taskworker" ]; then
-    shift
-    exec celery -A pretix.celery_app worker -l info "$@"
+    export C_FORCE_ROOT=True
+    exec celery -A pretix.celery_app worker -l info
+fi
+
+if [ "$1" == "shell" ]; then
+    exec python3 -m pretix shell
 fi
 
 if [ "$1" == "upgrade" ]; then
-    exec python3 -m pretix updateassets
+    exec python3 -m pretix updatestyles
 fi
 
-exec python3 -m pretix "$@"
+echo "Specify argument: all|cron|webworker|taskworker|shell|upgrade"
+exit 1

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.all.conf

@@ -1,2 +0,0 @@
-[include]
-files = /etc/supervisord/*.conf

deployment/docker/supervisord.conf

@@ -0,0 +1,44 @@
+[unix_http_server]
+file=/tmp/supervisor.sock
+
+[supervisord]
+logfile=/tmp/supervisord.log
+logfile_maxbytes=50MB
+logfile_backups=10
+loglevel=info
+pidfile=/tmp/supervisord.pid
+nodaemon=false
+minfds=1024
+minprocs=200
+
+[rpcinterface:supervisor]
+supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface
+
+[supervisorctl]
+serverurl=unix:///tmp/supervisor.sock
+
+[program:pretixweb]
+command=/usr/local/bin/pretix webworker
+autostart=true
+autorestart=true
+priority=5
+user=pretixuser
+environment=HOME=/pretix
+
+[program:pretixtask]
+command=/usr/local/bin/pretix taskworker
+autostart=true
+autorestart=true
+priority=5
+user=pretixuser
+
+[program:nginx]
+command=/usr/sbin/nginx
+autostart=true
+autorestart=true
+priority=10
+stdout_events_enabled=true
+stderr_events_enabled=true
+
+[include]
+files = /etc/supervisord-*.conf

deployment/docker/supervisord.web.conf

@@ -1,2 +0,0 @@
-[include]
-files = /etc/supervisord/base.conf /etc/supervisord/nginx.conf /etc/supervisord/pretixweb.conf

deployment/docker/supervisord/base.conf

@@ -1,18 +0,0 @@
-[unix_http_server]
-file=/tmp/supervisor.sock
-
-[supervisord]
-environment = AUTOMIGRATE="skip"
-logfile=/dev/stdout
-logfile_maxbytes=0
-loglevel=info
-pidfile=/tmp/supervisord.pid
-nodaemon=false
-minfds=1024
-minprocs=200
-
-[rpcinterface:supervisor]
-supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface
-
-[supervisorctl]
-serverurl=unix:///tmp/supervisor.sock

deployment/docker/supervisord/nginx.conf

@@ -1,9 +0,0 @@
-[program:nginx]
-command=/usr/sbin/nginx
-autostart=true
-autorestart=true
-priority=10
-stdout_logfile=/dev/fd/1
-stdout_logfile_maxbytes=0
-stderr_logfile=/dev/fd/2
-stderr_logfile_maxbytes=0

deployment/docker/supervisord/pretixtask.conf

@@ -1,10 +0,0 @@
-[program:pretixtask]
-command=/usr/local/bin/pretix taskworker
-autostart=true
-autorestart=true
-priority=5
-user=pretixuser
-stdout_logfile=/dev/fd/1
-stdout_logfile_maxbytes=0
-stderr_logfile=/dev/fd/2
-stderr_logfile_maxbytes=0

deployment/docker/supervisord/pretixweb.conf

@@ -1,11 +0,0 @@
-[program:pretixweb]
-command=/usr/local/bin/pretix webworker
-autostart=true
-autorestart=true
-priority=5
-user=pretixuser
-environment=HOME=/pretix
-stdout_logfile=/dev/fd/1
-stdout_logfile_maxbytes=0
-stderr_logfile=/dev/fd/2
-stderr_logfile_maxbytes=0

doc/LICENSE.txt

@@ -1,202 +0,0 @@
-
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.

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

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

@@ -3155,14 +3155,14 @@ a .fa, a .wy-menu-vertical li span.toctree-expand, .wy-menu-vertical li a span.t
     vertical-align: -15%
 }
 
-.wy-alert, .rst-content .note, .rst-content .attention, .rst-content .caution, .rst-content .danger, .rst-content .error, .rst-content .hint, .rst-content .important, .rst-content .tip, .rst-content .warning, .rst-content .seealso, .rst-content .admonition-todo, .rst-content div.deprecated {
+.wy-alert, .rst-content .note, .rst-content .attention, .rst-content .caution, .rst-content .danger, .rst-content .error, .rst-content .hint, .rst-content .important, .rst-content .tip, .rst-content .warning, .rst-content .seealso, .rst-content .admonition-todo {
     padding: 12px;
     line-height: 24px;
     margin-bottom: 24px;
     background: #e7f2fa
 }
 
-.wy-alert-title, .rst-content .admonition-title, .rst-content .deprecated .versionmodified {
+.wy-alert-title, .rst-content .admonition-title {
     color: #fff;
     font-weight: bold;
     display: block;
@@ -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 {
@@ -6103,6 +6099,3 @@ section > a.screenshot {
 .versionchanged p:last-child {
     margin-bottom: 0;
 }
-.rst-content td > .line-block {
-    margin-left: 0 !important;
-}

doc/admin/config.rst

@@ -0,0 +1,324 @@
+.. 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.
+
+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.
+
+``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``.
+
+
+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``
+
+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
+
+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.
+
+``from``
+    The email address to set as ``From`` header in outgoing emails by the system.
+    Default: ``pretix@localhost``
+
+``tls``, ``ssl``
+    Use STARTTLS or SSL for the SMTP connection. Off by default.
+
+``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 Django's built-in local-memory caching method.
+
+.. 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
+
+``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.
+
+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.
+
+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
+
+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.
+
+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>
+
+``dsn``
+    You will be given this value by your sentry installation.
+
+
+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

doc/admin/index.rst

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

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,278 @@
+.. 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`_, `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:: We recommend **PostgreSQL**. If you go for MySQL, make sure you run **MySQL 5.7 or newer** or
+             **MariaDB 10.2.7 or newer**.
+
+On this guide
+-------------
+
+All code lines prepended with a ``#`` symbol are commands that you need to execute on your server as ``root`` user;
+all lines prepended with a ``$`` symbol can also be run by an unprivileged user.
+
+Data files
+----------
+
+First of all, you need to create a directory on your server that pretix can use to store data files and make that
+directory writable to the user that runs pretix inside the docker container::
+
+    # mkdir /var/pretix-data
+    # chown -R 15371:15371 /var/pretix-data
+
+Database
+--------
+
+Next, we need a database and a database user. We can create these with any kind of database managing tool or directly on
+our database's shell, e.g. for MySQL::
+
+    $ mysql -u root -p
+    mysql> CREATE DATABASE pretix DEFAULT CHARACTER SET utf8mb4 DEFAULT COLLATE utf8mb4_unicode_ci;
+    mysql> GRANT ALL PRIVILEGES ON pretix.* TO pretix@'localhost' IDENTIFIED BY '*********';
+    mysql> FLUSH PRIVILEGES;
+
+Replace the asterisks with a password of your own. For MySQL, we will use a unix domain socket to connect to the
+database. For PostgreSQL, be sure to configure the interface binding and your firewall so that the docker container
+can reach PostgreSQL.
+
+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
+
+.. 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
+
+    [database]
+    ; Replace mysql with postgresql_psycopg2 for PostgreSQL
+    backend=mysql
+    name=pretix
+    user=pretix
+    password=*********
+    ; Replace with host IP address for PostgreSQL
+    host=/var/run/mysqld/mysqld.sock
+
+    [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 8345:80 \
+        -v /var/pretix-data:/data \
+        -v /etc/pretix:/etc/pretix \
+        -v /var/run/redis:/var/run/redis \
+        -v /var/run/mysqld:/var/run/mysqld \
+        pretix/standalone:stable all
+    ExecStop=/usr/bin/docker stop %n
+
+    [Install]
+    WantedBy=multi-user.target
+
+You can leave the MySQL socket volume out if you're using PostgreSQL. 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.
+
+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.
+
+.. _`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.
+
+.. _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-9-4-on-debian-8
+.. _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 && \
+        pip3 install -Ue "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,14 @@
+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,305 @@
+.. 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 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 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`_, `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:: We recommend **PostgreSQL**. If you go for MySQL, make sure you run **MySQL 5.7 or newer** or
+             **MariaDB 10.2.7 or newer**.
+
+Unix user
+---------
+
+As we do not want to run pretix as root, we first create a new unprivileged user::
+
+    # adduser pretix --disabled-password --home /var/pretix
+
+In this guide, all code lines prepended with a ``#`` symbol are commands that you need to execute on your server as
+``root`` user (e.g. using ``sudo``); all lines prepended with a ``$`` symbol should be run by the unprivileged user.
+
+Database
+--------
+
+Having the database server installed, we still need a database and a database user. We can create these with any kind
+of database managing tool or directly on our database's shell, e.g. for MySQL::
+
+    $ mysql -u root -p
+    mysql> CREATE DATABASE pretix DEFAULT CHARACTER SET utf8mb4 DEFAULT COLLATE utf8mb4_unicode_ci;
+    mysql> GRANT ALL PRIVILEGES ON pretix.* TO pretix@'localhost' IDENTIFIED BY '*********';
+    mysql> FLUSH PRIVILEGES;
+
+Package dependencies
+--------------------
+
+To build and run pretix, you will need the following debian packages::
+
+    # apt-get install git build-essential python-dev python-virtualenv python3 python3-pip \
+                      python3-dev libxml2-dev libxslt1-dev libffi-dev zlib1g-dev libssl-dev \
+                      gettext libpq-dev libmysqlclient-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
+
+    [database]
+    ; Replace mysql with postgresql_psycopg2 for PostgreSQL
+    backend=mysql
+    name=pretix
+    user=pretix
+    password=*********
+    ; Replace with host IP address for PostgreSQL
+    host=/var/run/mysqld/mysqld.sock
+
+    [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::
+
+    $ virtualenv -p python3 /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. Replace ``mysql`` with ``postgres`` in the following
+command if you're running PostgreSQL::
+
+    (venv)$ pip3 install "pretix[mysql]" gunicorn
+
+Note that you need Python 3.5 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.5/site-packages/pretix/static.dist/;
+            access_log off;
+            expires 365d;
+            add_header Cache-Control "public";
+        }
+    }
+
+.. note:: Remember to replace the ``python3.5`` 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.
+
+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 (again, replace
+``mysql`` with ``postgres`` if necessary)::
+
+    $ source /var/pretix/venv/bin/activate
+    (venv)$ pip3 install -U pretix[mysql] gunicorn
+    (venv)$ python -m pretix migrate
+    (venv)$ python -m pretix rebuild
+    (venv)$ python -m pretix updatestyles
+    # systemctl restart pretix-web pretix-worker
+
+
+.. _`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-9-4-on-debian-8
+.. _redis: https://blog.programster.org/debian-8-install-redis-server/
+.. _ufw: https://en.wikipedia.org/wiki/Uncomplicated_Firewall
+.. _strong encryption settings: https://mozilla.github.io/server-side-tls/ssl-config-generator/

doc/admin/maintainance.rst

@@ -0,0 +1,99 @@
+.. 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
+-------
+
+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.
+
+.. _metric types: https://prometheus.io/docs/concepts/metric_types/
+.. _Prometheus: https://prometheus.io/
+.. _cProfile: https://docs.python.org/3/library/profile.html

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:
 
@@ -55,15 +49,11 @@ information on your device as well as your API token:
        "device_id": 5,
        "unique_serial": "HHZ9LW9JWP390VFZ",
        "api_token": "1kcsh572fonm3hawalrncam4l1gktr2rzx25a22l8g9hx108o9oi0rztpcvwnfnd",
-       "name": "Bar",
-       "gate": {
-           "id": 3,
-           "name": "South entrance"
-       }
+       "name": "Bar"
    }
 
 Please make sure that you store this ``api_token`` value. We also recommend storing your device ID, your assigned
-``unique_serial``, and the ``organizer`` you have access to, but that's up to you. ``gate`` might be ``null``.
+``unique_serial``, and the ``organizer`` you have access to, but that's up to you.
 
 In case of an error, the response will look like this:
 
@@ -104,66 +94,10 @@ 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"}
+       "software_version": "4.1.0"
    }
 
-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
 ----------------------
 
@@ -192,67 +126,12 @@ invalidate your API key. There is no way to reverse this operation.
 
 This can also be done by the user through the web interface.
 
-Permissions & security profiles
--------------------------------
+Permissions
+-----------
 
 Device authentication is currently hardcoded to grant the following permissions:
 
 * View event meta data and products etc.
-* View orders
-* Change orders
-* Manage gift cards
+* View and change orders
 
 Devices cannot change events or products and cannot access vouchers.
-
-Additionally, when creating a device through the user interface or API, a user can specify a "security profile" for
-the device. These include an allow list of specific API calls that may be made by the device. pretix ships with security
-policies for official pretix apps like pretixSCAN and pretixPOS.
-
-Removing a device
------------------
-
-If you want implement a way to to deprovision a device in your software, you can call the ``revoke`` endpoint to
-invalidate your API key. There is no way to reverse this operation.
-
-.. sourcecode:: http
-
-   POST /api/v1/device/revoke HTTP/1.1
-   Host: pretix.eu
-   Authorization: Device 1kcsh572fonm3hawalrncam4l1gktr2rzx25a22l8g9hx108o9oi0rztpcvwnfnd
-
-This can also be done by the user through the web interface.
-
-Event selection
----------------
-
-In most cases, your application should allow the user to select the event and check-in list they work with manually
-from a list. However, in some cases it is required to automatically configure the device for the correct event, for
-example in a kiosk-like situation where nobody is operating the device. In this case, the app can query the server
-for a suggestion which event should be used. You can also submit the configuration that is currently in use via
-query parameters:
-
-.. sourcecode:: http
-
-   GET /api/v1/device/eventselection?current_event=democon&current_subevent=42&current_checkinlist=542 HTTP/1.1
-   Host: pretix.eu
-   Authorization: Device 1kcsh572fonm3hawalrncam4l1gktr2rzx25a22l8g9hx108o9oi0rztpcvwnfnd
-
-You can get three response codes:
-
-* ``304`` The server things you already selected a good event
-* ``404`` The server has not found a suggestion for you
-* ``200`` The server suggests a new event (body see below)
-
-.. sourcecode:: http
-
-   HTTP/1.1 200 OK
-   Content-Type: application/json
-
-   {
-      "event": {
-        "name": "Demo Conference",
-        "slug": "democon"
-      },
-      "subevent": 23,
-      "checkinlist": 5
-   }

doc/api/fundamentals.rst

@@ -43,16 +43,13 @@ Possible permissions are:
 * Can view vouchers
 * Can change vouchers
 
-.. _`rest-compat`:
-
 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,8 +58,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*:
 
@@ -92,8 +87,7 @@ respectively, or ``null`` if there is no such page. You can use those URLs to re
 respective page.
 
 The field ``results`` contains a list of objects representing the first results. For most
-objects, every page contains 50 results. You can specify a lower pagination size using the
-``page_size`` query parameter, but no more than 50.
+objects, every page contains 50 results.
 
 Conditional fetching
 --------------------
@@ -176,25 +170,6 @@ Date                  String in ISO 8601 format    ``2017-12-27``
 Multi-lingual string  Object of strings            ``{"en": "red", "de": "rot", "de_Informal": "rot"}``
 Money                 String with decimal number   ``"23.42"``
 Currency              String with ISO 4217 code    ``"EUR"``, ``"USD"``
-Relative datetime     *either* String in ISO 8601  ``"2017-12-27T10:00:00.596934Z"``,
-                      format *or* specification of ``"RELDATE/3/12:00:00/presale_start/"``
-                      a relative datetime,
-                      constructed from a number of
-                      days before the base point,
-                      a time of day, and the base
-                      point.
-Relative date         *either* String in ISO 8601  ``"2017-12-27"``,
-                      format *or* specification of ``"RELDATE/3/-/presale_start/"``
-                      a relative date,
-                      constructed from a number of
-                      days before the base point
-                      and the base point.
-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
@@ -206,84 +181,4 @@ as the string values ``true`` and ``false``.
 If the ``ordering`` parameter is documented for a resource, you can use it to sort the result set by one of the allowed
 fields. Prepend a ``-`` to the field name to reverse the sort order.
 
-
-Idempotency
------------
-
-Our API supports an idempotency mechanism to make sure you can safely retry operations without accidentally performing
-them twice. This is useful if an API call experiences interruptions in transit, e.g. due to a network failure, and you
-do not know if it completed successfully.
-
-To perform an idempotent request, add a ``X-Idempotency-Key`` header with a random string value (we recommend a version
-4 UUID) to your request. If we see a second request with the same ``X-Idempotency-Key`` and the same ``Authorization``
-and ``Cookie`` headers, we will not perform the action for a second time but return the exact same response instead.
-
-Please note that this also goes for most error responses. For example, if we returned you a ``403 Permission Denied``
-error and you retry with the same ``X-Idempotency-Key``, you will get the same error again, even if you were granted
-permission in the meantime! This includes internal server errors on our side that might have been fixed in the meantime.
-
-There are only the following exceptions to the rule:
-
-* Responses with status code ``409 Conflict`` are not cached. If you send the request again, it will be executed as a
-  new request, since these responses are intended to be retried.
-
-* Rate-limited responses with status code ``429 Too Many Requests`` are not cached and you can safely retry them.
-
-* Responses with status code ``500 Internal Server Error`` are not cached and you can retry them. This is not guaranteed
-  to be safe in all theoretical cases,  but 500 by definition is an unforeseen situation and we need to have some way out.
-
-* Responses with status code ``503 Service Unavailable`` are not cached and you can safely retry them.
-
-If you send a request with an ``X-Idempotency-Key`` header that we have seen before but that has not yet received a
-response, you will receive a response with status code ``409 Conflict`` and are asked to retry after five seconds.
-
-We store idempotency keys for 24 hours, so you should never retry a request after a longer time period.
-
-All ``POST``, ``PUT``, ``PATCH``, or ``DELETE`` api calls support idempotency keys. Adding an idempotency key to a
-``GET``, ``HEAD``, or ``OPTIONS`` request has no effect.
-
-
-File upload
------------
-
-In some places, the API supports working with files, for example when setting the picture of a product. In this case,
-you will first need to make a separate request to our file upload endpoint:
-
-.. sourcecode:: http
-
-   POST /api/v1/upload HTTP/1.1
-   Host: pretix.eu
-   Authorization: Token e1l6gq2ye72thbwkacj7jbri7a7tvxe614ojv8ybureain92ocub46t5gab5966k
-   Content-Type: image/png
-   Content-Disposition: attachment; filename="logo.png"
-   Content-Length: 1234
-
-   <raw file content>
-
-Note that the ``Content-Type`` and ``Content-Disposition`` headers are required. If the upload was successful, you will
-receive a JSON response with the ID of the file:
-
-.. sourcecode:: http
-
-   HTTP/1.1 201 Created
-   Content-Type: application/json
-
-   {
-     "id": "file:1cd99455-1ebd-4cda-b1a2-7a7d2a969ad1"
-   }
-
-You can then use this file ID in the request you want to use it in. File IDs are currently valid for 24 hours and can only
-be used using the same authorization method and user that was used to upload them.
-
-.. sourcecode:: http
-
-   PATCH /api/v1/organizers/test/events/test/items/3/ HTTP/1.1
-   Host: pretix.eu
-   Content-Type: application/json
-
-   {
-     "picture": "file:1cd99455-1ebd-4cda-b1a2-7a7d2a969ad1"
-   }
-
-
 .. _CSRF policies: https://docs.djangoproject.com/en/1.11/ref/csrf/#ajax

doc/api/guides/custom_checkout.rst

@@ -1,135 +0,0 @@
-Creating an external checkout process
-=====================================
-
-Occasionally, we get asked whether it is possible to just use pretix' powerful backend as a ticketing engine but use
-a fully-customized checkout process that only communicates via the API. This is possible, but with a few limitations.
-If you go down this route, you will miss out on many of pretix features and safeguards, as well as the added flexibility
-by most of pretix' plugins. We strongly recommend to talk this through with us before you decide this is the way to go.
-
-However, this is really useful if you need to tightly integrate pretix into existing web applications that e.g. control
-the pricing of your products in a way that cannot be mapped to pretix' product structures.
-
-Creating orders
----------------
-
-After letting your user select the products to  buy in your application, you should create a new order object inside
-pretix. Below, you can see an example of such an order, but most fields are optional and there are some more features
-supported. Read :ref:`rest-orders-create` to learn more about this endpoint.
-
-Please note that this endpoint assumes trustworthy input for the most part. By default, the endpoint checks that
-you do not exceed any quotas, do not sell any seats twice, or do not use any redeemed vouchers. However, it will not
-complain about violation of any other availability constraints, such as violation of time frames or minimum/maximum
-amounts of either your product or event. Bundled products will not be added in automatically and fees will not be
-calculated automatically.
-
-.. sourcecode:: http
-
-    POST /api/v1/organizers/democon/events/3vjrh/orders/ HTTP/1.1
-    Host: test.pretix.eu
-    Accept: application/json, text/javascript
-    Content-Type: application/json
-    Authorization: …
-
-    {
-      "email": "dummy@example.org",
-      "locale": "en",
-      "sales_channel": "web",
-      "payment_provider": "banktransfer",
-      "invoice_address": {
-        "is_business": false,
-        "company": "Sample company",
-        "name_parts": {"full_name": "John Doe"},
-        "street": "Sesam Street 12",
-        "zipcode": "12345",
-        "city": "Sample City",
-        "country": "US",
-        "state": "NY",
-        "internal_reference": "",
-        "vat_id": ""
-      },
-      "positions": [
-        {
-          "item": 21,
-          "variation": null,
-          "attendee_name_parts": {
-            "full_name": "Peter"
-          },
-          "answers": [
-            {
-              "question": 1,
-              "answer": "23",
-              "options": []
-            }
-          ],
-          "subevent": null
-        }
-      ],
-      "fees": []
-    }
-
-You will be returned a full order object that you can inspect, store, or use to build emails or confirmation pages for
-the user. If you don't want to do that yourself, it will also contain the URL to our confirmation page in the ``url``
-attribute. If you pass the ``"send_mail": true`` option, pretix will also send order confirmations for you.
-
-Handling payments yourself
---------------------------
-
-If you want to handle payments in your application, you can either just create the orders with status "paid" or you can
-create them in "pending" state (the default) and later confirm the payment. We strongly advise to use the payment
-provider ``"manual"`` in this case to avoid interference with payment code with pretix.
-
-However, it is often unfeasible to implement the payment process yourself, and it also requires you to give up a
-lot of pretix functionality, such as automatic refunds. Therefore, it is also possible to utilize pretix' native
-payment process even in this case:
-
-Using pretix payment providers
-------------------------------
-
-If you passed a ``payment_provider`` during order creation above, pretix will have created a payment object with state
-``created`` that you can see in the returned order object. This payment object will have an attribute ``payment_url``
-that you can use to let the user pay. For example, you could link or redirect to this page.
-
-If you want the user to return to your application after the payment is complete, you can pass a query parameter
-``return_url``. To prepare your event for this, open your event in the pretix backend and go to "Settings", then
-"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.
-
-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
-message, but you should not rely on that and instead make sure you use our API to check if the payment actually
-worked! Your final URL could look like this::
-
-    https://test.pretix.eu/democon/3vjrh/order/NSLEZ/ujbrnsjzbq4dzhck/pay/123/?return_url=https%3A%2F%2Fexample.org%2Forder%2Freturn%3Ftx_id%3D1234
-
-You can also embed this page in an ``<iframe>`` instead. Note, however, that this causes problems with some payment
-methods such as PayPal which do not allow being opened in an iframe. pretix can partly work around these issues by
-opening a new window, but will only to so if you also append an ``iframe=1`` parameter to the URL::
-
-    https://test.pretix.eu/democon/3vjrh/order/NSLEZ/ujbrnsjzbq4dzhck/pay/123/?return_url=https%3A%2F%2Fexample.org%2Forder%2Freturn%3Ftx_id%3D1234&iframe=1
-
-If you did **not** pass a payment method since you want us to ask the user which payment method they want to use, you
-need to construct the URL from the ``url`` attribute of the order and the sub-path ``pay/change```. For example, you
-would end up with the following URL::
-
-    https://test.pretix.eu/democon/3vjrh/order/NSLEZ/ujbrnsjzbq4dzhck/pay/change
-
-Of course, you can also use the ``iframe`` and ``return_url`` parameters here.
-
-Optional: Cart reservations
----------------------------
-
-Creating orders is an atomic operation: The order is either created as a whole or not at all. However, pretix'
-built-in checkout automatically reserves tickets in a user's cart for a configurable amount of time to ensure users
-will actually get their tickets once they started entering all their details. If you want a similar behavior in your
-application, you need to create :ref:`rest-carts` through the API.
-
-When creating your order, you can pass a ``consume_carts`` parameter with the cart ID(s) of your user. This way, the
-quota reserved by the cart will be credited towards the order and the carts will be destroyed if (and only if) the
-order creation succeeds.
-
-Cart creation is currently even more limited than the order creation endpoints, as cart creation currently does not
-support vouchers or automatic price calculation. If you require these features, please get in touch with us.

doc/api/guides/index.rst

@@ -1,12 +0,0 @@
-.. _`rest-api-guides`:
-
-API Usage Guides
-================
-
-This part of the documentation contains how-to guides on some special use cases of our API.
-
-.. toctree::
-   :maxdepth: 2
-
-   order_lifecycle
-   custom_checkout

doc/api/guides/order_lifecycle.rst

@@ -1,56 +0,0 @@
-Understanding the life cycle of orders
-======================================
-
-When integrating pretix with other systems, it is important that you understand how orders and related objects
-such as order positions, fees, payments, refunds, and invoices work together, in order to react to their changes
-properly and map them to processes in your system.
-
-Order states
-------------
-
-Generally, an order can be in six states. For compatibility reasons, the ``status`` field only allows four values
-and the two remaining states are modeled through the ``require_approval`` field and the number of positions within
-an order. The states and their allowed changes are shown in the following graph:
-
-.. image:: /images/order_states.png
-
-
-Object types
-------------
-
-Order
-    One order represents one purchase. It's the main object you interact with and bundles all the other objects
-    together. Orders can change in many ways during their lifetime, but will never be deleted (unless ``testmode``
-    is set to ``true``).
-
-Order position
-    An order position represents one product contained in the order. Orders can usually have multiple positions.
-    There might be a parent-child relation between order positions if one position is an add-on to another position.
-    Order positions can change in many ways during their lifetime, and can also be removed or added to an order.
-
-Order fees
-    A fee represents a charge that is not related to a product. Examples include shipping fees, service fees, and
-    cancellation fees.
-    Order fees can change in many ways during their lifetime, and can also be removed or added to an order.
-
-Order payment
-    An order payment represents one payment attempt with a specific payment method and amount. An order can have
-    multiple payments attached.
-    Order payments have their own state diagram. Apart from their state and their meta information (e.g. used
-    credit card, …) they usually don't change. They may be added at any time, but will never be deleted.
-
-Order refund
-    An order payment represents one refund attempt with a specific payment method and amount. An order can have
-    multiple refunds attached.
-    Order refunds have their own state diagram. Apart from their state and their meta information (e.g. used
-    credit card, …) they usually don't change. They may be added at any time, but will never be deleted.
-
-Invoice
-    An invoice represents a legal document stating the contents of an order. While the backend technically allows
-    to update an invoice in some situations, invoices are generally considered immutable. Once they are issued,
-    they no longer change. If the order changes substantially (e.g. prices change), an invoice is canceled through
-    creation of a new invoice with the opposite amount, plus the issuance of a new invoice.
-
-Here's an example of how they all play together:
-
-.. image:: /images/order_objects.png

doc/api/index.rst

@@ -7,6 +7,9 @@ This part of the documentation contains information about the REST-style API
 exposed by pretix since version 1.5 that can be used by third-party programs
 to interact with pretix and its data structures.
 
+Currently, the API provides mostly read-only capabilities, but it will be extended
+in functionality over time.
+
 .. toctree::
    :maxdepth: 2
 
@@ -15,4 +18,3 @@ to interact with pretix and its data structures.
    resources/index
    ratelimit
    webhooks
-   guides/index

doc/api/oauth.rst

@@ -25,7 +25,7 @@ Obtaining an authorization grant
 --------------------------------
 
 To authorize a new user, link or redirect them to the ``authorize`` endpoint, passing your client ID as a query
-parameter. Additionally, you can pass a scope (currently either ``read``, ``write``, ``read write`` or ``profile``)
+parameter. Additionally, you can pass a scope (currently either ``read``, ``write``, or ``read write``)
 and an URL the user should be redirected to after successful or failed authorization. You also need to pass the
 ``response_type`` parameter with a value of ``code``. Example::
 
@@ -47,9 +47,11 @@ You will need this ``code`` parameter to perform the next step.
 
 On a failed registration, a query string like ``?error=access_denied`` will be appended to the redirection URL.
 
-.. note:: By default, the user is asked to give permission on every call to this URL. If you **only** request the
-          ``profile`` scope, i.e. no access to organizer data, you can pass the ``approval_prompt=auto`` parameter
-          to skip user interaction on subsequent calls.
+.. note:: In this step, the user is allowed to restrict your access to certain organizer accounts. If you try to
+          re-authenticate the user later, the user might be instantly redirected back to you if authorization is already
+          given and would therefore be unable to review their organizer restriction settings. You can append the
+          ``approval_prompt=force`` query parameter if you want to make sure the user actively needs to confirm the
+          authorization.
 
 Getting an access token
 -----------------------
@@ -59,7 +61,7 @@ access to the API. The ``token`` endpoint expects you to authenticate using `HTT
 ID as a username and your client secret as a password. You are also required to again supply the same ``redirect_uri``
 parameter that you used for the authorization.
 
-.. http:post:: /api/v1/oauth/token
+.. http:get:: /api/v1/oauth/token
 
    Request a new access token
 
@@ -107,9 +109,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
 --------------------------
@@ -191,11 +193,10 @@ If you need the user's meta data, you can fetch it here:
       Content-Type: application/json
 
       {
-        "email": "admin@localhost",
-        "fullname": "John Doe",
-        "locale": "de",
-        "is_staff": false,
-        "timezone": "Europe/Berlin"
+        email: "admin@localhost",
+        fullname: "John Doe",
+        locale: "de",
+        timezone: "Europe/Berlin"
       }
 
    :statuscode 200: no error

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/billing_invoices.rst

@@ -1,131 +0,0 @@
-pretix Hosted billing invoices
-==============================
-
-This endpoint allows you to access invoices you received for pretix Hosted. It only contains invoices created starting
-November 2017.
-
-.. note:: Only available on pretix Hosted, not on self-hosted pretix instances.
-
-Resource description
---------------------
-
-The resource contains the following public fields:
-
-.. rst-class:: rest-resource-table
-
-===================================== ========================== =======================================================
-Field                                 Type                       Description
-===================================== ========================== =======================================================
-invoice_number                        string                     Invoice number
-date_issued                           date                       Invoice date
-===================================== ========================== =======================================================
-
-
-Endpoints
----------
-
-.. http:get:: /api/v1/organizers/(organizer)/billing_invoices/
-
-   Returns a list of all invoices to a given organizer.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      GET /api/v1/organizers/bigevents/billing_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": [
-          {
-            "invoice_number": "R2019002",
-            "date_issued": "2019-06-03"
-          }
-        ]
-      }
-
-   :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 ``date_issued`` and
-                           its reverse, ``-date_issued``. Default: ``date_issued``.
-   :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.
-
-.. http:get:: /api/v1/organizers/(organizer)/billing_invoices/(invoice_number)/
-
-   Returns information on one invoice, identified by its invoice number.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      GET /api/v1/organizers/bigevents/billing_invoices/R2019002/ 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
-
-      {
-        "invoice_number": "R2019002",
-        "date_issued": "2019-06-03"
-      }
-
-   :param organizer: The ``slug`` field of the organizer to fetch
-   :param invoice_number: The ``invoice_number`` field of the invoice to fetch
-   :statuscode 200: no error
-   :statuscode 401: Authentication failure
-   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
-
-.. http:get:: /api/v1/organizers/(organizer)/billing_invoices/(invoice_number)/download/
-
-   Download an invoice in PDF format.
-
-   .. warning:: After we created the invoices, they are placed in review with our accounting department. You will
-                already see them in the API at this point, but you are not able to download them until they completed
-                review and are sent to you via email. This usually takes a few hours. If you try to download them
-                in this time frame, you will receive a status code :http:statuscode:`423`.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      GET /api/v1/organizers/bigevents/billing_invoices/R2019002/download/ HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-
-   **Example response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 200 OK
-      Vary: Accept
-      Content-Type: application/pdf
-
-      ...
-
-   :param organizer: The ``slug`` field of the organizer to fetch
-   :param invoice_number: The ``invoice_number`` field of the invoice to fetch
-   :statuscode 200: no error
-   :statuscode 401: Authentication failure
-   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
-   :statuscode 423: The file is not yet ready and will now be prepared. Retry the request after waiting for a few
-                    seconds.

doc/api/resources/billing_var.rst

@@ -1,148 +0,0 @@
-pretix Hosted reseller API
-==========================
-
-This API is only accessible to our `value-added reseller partners`_ on pretix Hosted.
-
-.. note:: This API is only accessible with user-level permissions, not with API tokens. Therefore, you will need to
-          create an :ref:`OAuth application <rest-oauth>` and obtain an OAuth access token for a user account that has
-          permission to your reseller account.
-
-Reseller account resource
--------------------------
-
-The resource contains the following public fields:
-
-.. rst-class:: rest-resource-table
-
-===================================== ========================== =======================================================
-Field                                 Type                       Description
-===================================== ========================== =======================================================
-id                                    integer                    Your reseller ID
-name                                  string                     Internal name of your reseller account
-public_name                           string                     Public name of your reseller account
-public_url                            string                     Public URL of your company
-support_email                         string                     Your support email address
-support_phone                         string                     Your support phone number
-communication_language                string                     Language code we use to communicate with you
-===================================== ========================== =======================================================
-
-
-Endpoints
----------
-
-.. http:get:: /api/v1/var/
-
-   Returns a list of all reseller accounts you have access to.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      GET /api/v1/var/ 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": "ticketshop.live Ltd & Co. KG",
-            "public_name": "ticketshop.live",
-            "public_url": "https://ticketshop.live",
-            "support_email": "support@ticketshop.live",
-            "support_phone": "+4962213217750",
-            "communication_language": "de"
-          }
-        ]
-      }
-
-   :query integer page: The page number in case of a multi-page result set, default is 1
-   :statuscode 200: no error
-   :statuscode 401: Authentication failure
-
-.. http:get:: /api/v1/var/(id)/
-
-   Returns information on one reseller account, identified by its ID.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      GET /api/v1/var/1/ HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-
-   **Example response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 200 OK
-      Vary: Accept
-      Content-Type: application/json
-
-      {
-        "id": 1,
-        "name": "ticketshop.live Ltd & Co. KG",
-        "public_name": "ticketshop.live",
-        "public_url": "https://ticketshop.live",
-        "support_email": "support@ticketshop.live",
-        "support_phone": "+4962213217750",
-        "communication_language": "de"
-      }
-
-   :param id: The ``id`` field of the reseller account to fetch
-   :statuscode 200: no error
-   :statuscode 401: Authentication failure
-   :statuscode 404: The requested account does not exist **or** you have no permission to view this resource.
-
-.. http:post:: /api/v1/var/(id)/create_organizer/
-
-   Creates a new organizer account that will be associated with a given reseller account.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      POST /api/v1/var/1/create_organizer/ HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-      Content-Type: application/json
-      Content-Length: 123
-
-      {
-        "name": "My new client",
-        "slug": "New client"
-      }
-
-   **Example response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 201 Created
-      Vary: Accept
-      Content-Type: application/json
-
-      {
-        "id": 1,
-        "name": "My new client",
-        "slug": "New client"
-      }
-
-   :param id: The ``id`` field of the reseller account to fetch
-   :statuscode 201: no error
-   :statuscode 400: Invalid request body, usually the slug is invalid or already taken.
-   :statuscode 401: Authentication failure
-   :statuscode 404: The requested account does not exist **or** you have no permission to view this resource.
-
-.. _value-added reseller partners: https://pretix.eu/about/en/var

doc/api/resources/campaigns.rst

@@ -1,226 +0,0 @@
-Campaigns
-=========
-
-.. note:: This API is only available when the plugin **pretix-campaigns** is installed (pretix Hosted and Enterprise only).
-
-The campaigns plugin provides a HTTP API that allows you to create new campaigns.
-
-Resource description
---------------------
-
-The campaign resource contains the following public fields:
-
-.. rst-class:: rest-resource-table
-
-===================================== ========================== =======================================================
-Field                                 Type                       Description
-===================================== ========================== =======================================================
-id                                    integer                    Internal campaign ID
-code                                  string                     The URL component of the campaign, e.g. with code ``BAR``
-                                                                 the campaign URL would to be ``https://<server>/<organizer>/<event>/c/BAR/``.
-                                                                 This value needs to be *globally unique* and we do not
-                                                                 recommend setting it manually. If you omit it, a random
-                                                                 value will be chosen.
-description                           string                     An internal, human-readable name of the campaign.
-external_target                       string                     An URL to redirect to from the tracking link. To redirect to
-                                                                 the ticket shop, use an empty string.
-order_count                           integer                    Number of orders tracked on this campaign (read-only)
-click_count                           integer                    Number of clicks tracked on this campaign (read-only)
-===================================== ========================== =======================================================
-
-Endpoints
----------
-
-.. http:get:: /api/v1/organizers/(organizer)/events/(event)/campaigns/
-
-   Returns a list of all campaigns configured for an event.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      GET /api/v1/organizers/bigevents/events/sampleconf/campaigns/ HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-
-   **Example response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 200 OK
-      Vary: Accept
-      Content-Type: application/json
-
-      {
-        "count": 1,
-        "next": null,
-        "previous": null,
-        "results": [
-          {
-            "id": 1,
-            "code": "wZnL11fjq",
-            "description": "Facebook",
-            "external_target": "",
-            "order_count:" 0,
-            "click_count:" 0
-          }
-        ]
-      }
-
-   :query page: The page number in case of a multi-page result set, default is 1
-   :param organizer: The ``slug`` field of a valid organizer
-   :param event: The ``slug`` field of the event to fetch
-   :statuscode 200: no error
-   :statuscode 401: Authentication failure
-   :statuscode 403: The requested organizer or event does not exist **or** you have no permission to view it.
-
-.. http:get:: /api/v1/organizers/(organizer)/events/(event)/campaigns/(id)/
-
-   Returns information on one campaign, identified by its ID.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      GET /api/v1/organizers/bigevents/events/sampleconf/campaigns/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,
-        "code": "wZnL11fjq",
-        "description": "Facebook",
-        "external_target": "",
-        "order_count:" 0,
-        "click_count:" 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 campaign to fetch
-   :statuscode 200: no error
-   :statuscode 401: Authentication failure
-   :statuscode 403: The requested organizer/event/campaign does not exist **or** you have no permission to view it.
-
-.. http:post:: /api/v1/organizers/(organizer)/events/(event)/campaigns/
-
-   Create a new campaign.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      POST /api/v1/organizers/bigevents/events/sampleconf/campaigns/ HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-      Content-Type: application/json
-      Content-Length: 166
-
-      {
-        "description": "Twitter"
-      }
-
-   **Example response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 201 Created
-      Vary: Accept
-      Content-Type: application/json
-
-      {
-        "id": 2,
-        "code": "IfVJQzSBL",
-        "description": "Twitter",
-        "external_target": "",
-        "order_count:" 0,
-        "click_count:" 0
-      }
-
-   :param organizer: The ``slug`` field of the organizer to create a campaign for
-   :param event: The ``slug`` field of the event to create a campaign for
-   :statuscode 201: no error
-   :statuscode 400: The campaign 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 campaigns.
-
-
-.. http:patch:: /api/v1/organizers/(organizer)/events/(event)/campaigns/(id)/
-
-   Update a campaign. 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/campaigns/1/ HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-      Content-Type: application/json
-      Content-Length: 34
-
-      {
-        "external_target": "https://mywebsite.com"
-      }
-
-   **Example response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 200 OK
-      Vary: Accept
-      Content-Type: text/javascript
-
-      {
-        "id": 2,
-        "code": "IfVJQzSBL",
-        "description": "Twitter",
-        "external_target": "https://mywebsite.com",
-        "order_count:" 0,
-        "click_count:" 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 campaign to modify
-   :statuscode 200: no error
-   :statuscode 400: The campaign could not be modified due to invalid submitted data.
-   :statuscode 401: Authentication failure
-   :statuscode 403: The requested organizer/event/campaign does not exist **or** you have no permission to change it.
-
-
-.. http:delete:: /api/v1/organizers/(organizer)/events/(event)/campaigns/(id)/
-
-   Delete a campaign and all associated data.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      DELETE /api/v1/organizers/bigevents/events/sampleconf/campaigns/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 campaign to delete
-   :statuscode 204: no error
-   :statuscode 401: Authentication failure
-   :statuscode 403: The requested organizer/event/campaign does not exist **or** you have no permission to change it

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,25 +29,20 @@ 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``)
-├ 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:: 1.17
+
+   This resource has been added.
+
+
 Cart position endpoints
 -----------------------
 
@@ -88,12 +83,10 @@ 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",
             "includes_tax": true,
-            "seat": null,
             "answers": []
           }
         ]
@@ -135,12 +128,10 @@ 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",
         "includes_tax": true,
-        "seat": null,
         "answers": []
       }
 
@@ -171,32 +162,27 @@ 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
 
+       * does not support the redemption of vouchers
+
        * does not prevent you from buying items that can only be bought with a voucher
 
        * does not support file upload questions
 
-       Note that more validation might be added in the future, so please do not rely on missing validation.
-
    You can supply the following fields of the resource:
 
    * ``cart_id`` (optional, needs to end in ``@api``)
    * ``item``
    * ``variation`` (optional)
    * ``price``
-   * ``seat`` (The ``seat_guid`` attribute of a seat. Required when the specified ``item`` requires a seat, otherwise must be ``null``.)
    * ``attendee_name`` **or** ``attendee_name_parts`` (optional)
    * ``attendee_email`` (optional)
    * ``subevent`` (optional)
    * ``expires`` (optional)
-   * ``includes_tax`` (optional, **deprecated**, do not use, will be removed)
-   * ``sales_channel`` (optional)
-   * ``voucher`` (optional, expect a voucher code)
-   * ``addons`` (optional, expect a list of nested objects of cart positions)
-   * ``bundled`` (optional, expect a list of nested objects of cart positions)
+   * ``includes_tax`` (optional)
    * ``answers``
 
       * ``question``
@@ -210,7 +196,7 @@ Cart position endpoints
       POST /api/v1/organizers/bigevents/events/sampleconf/cartpositions/ HTTP/1.1
       Host: pretix.eu
       Accept: application/json, text/javascript
-      Content-Type: application/json
+      Content: application/json
 
       {
         "item": 1,
@@ -228,12 +214,6 @@ Cart position endpoints
             "options": []
           }
         ],
-        "addons": [
-          {
-            "item": 2,
-            "variation": null,
-          }
-        ],
         "subevent": null
       }
 
@@ -245,7 +225,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
@@ -255,99 +235,6 @@ Cart position endpoints
    :statuscode 403: The requested organizer/event does not exist **or** you have no permission to create this
          order.
 
-.. 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!**
-
-   .. warning:: This endpoint is considered **experimental**. It might change at any time without prior notice.
-
-   .. warning:: The same limitations as with the regular creation endpoint apply.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      POST /api/v1/organizers/bigevents/events/sampleconf/cartpositions/bulk_create/ HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-      Content-Type: application/json
-
-      [
-        {
-          "item": 1,
-          "variation": null,
-          "price": "23.00",
-          "attendee_name_parts": {
-            "given_name": "Peter",
-            "family_name": "Miller"
-          },
-          "attendee_email": null,
-          "answers": [
-            {
-              "question": 1,
-              "answer": "23",
-              "options": []
-            }
-          ],
-          "subevent": null
-        },
-        {
-          "item": 1,
-          "variation": null,
-          "price": "23.00",
-          "attendee_name_parts": {
-            "given_name": "Maria",
-            "family_name": "Miller"
-          },
-          "attendee_email": null,
-          "answers": [
-            {
-              "question": 1,
-              "answer": "23",
-              "options": []
-            }
-          ],
-          "subevent": null
-        }
-      ]
-
-   **Example response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 200 OK
-      Vary: Accept
-      Content-Type: application/json
-
-      {
-        "results": [
-          {
-            "success": true,
-            "errors": null,
-            "data": {
-              "id": 1,
-              ...
-            },
-          },
-          {
-            "success": "false",
-            "errors": {
-              "non_field_errors": ["There is not enough quota available on quota \"Tickets\" to perform the operation."]
-            },
-            "data": null
-          }
-        ]
-      }
-
-   :param organizer: The ``slug`` field of the organizer of the event to create positions for
-   :param event: The ``slug`` field of the event to create positions for
-   :statuscode 200: See response for success
-   :statuscode 400: Your input could not be parsed
-   :statuscode 401: Authentication failure
-   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to create this
-         order.
-
 .. http:delete:: /api/v1/organizers/(organizer)/events/(event)/cartpositions/(id)/
 
    Deletes a cart position, identified by its internal ID.

doc/api/resources/categories.rst

@@ -20,27 +20,19 @@ internal_name                         string                     An optional nam
 description                           multi-lingual string       A public description (might include markdown, can
                                                                  be ``null``)
 position                              integer                    An integer, used for sorting the categories
-is_addon                              boolean                    If ``true``, items within this category are not on sale
+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.
 ===================================== ========================== =======================================================
 
+.. versionchanged:: 1.14
+
+   The operations POST, PATCH, PUT and DELETE have been added.
+
+.. versionchanged:: 1.16
+
+   The field ``internal_name`` has been added.
+
 
 Endpoints
 ---------
@@ -76,10 +68,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 +110,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
@@ -145,17 +131,14 @@ Endpoints
       POST /api/v1/organizers/bigevents/events/sampleconf/categories/ HTTP/1.1
       Host: pretix.eu
       Accept: application/json, text/javascript
-      Content-Type: application/json
+      Content: application/json
 
       {
         "name": {"en": "Tickets"},
         "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 +155,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 +201,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/certificates.rst

@@ -1,66 +0,0 @@
-Certificates of attendance
-==========================
-
-.. note:: This API is only available when the plugin **pretix-certificates** is installed (pretix Hosted and Enterprise only).
-
-The certificates plugin provides a HTTP API that allows you to download the certificate for a specific attendee.
-
-
-Certificate download
---------------------
-
-.. http:get:: /api/v1/organizers/(organizer)/events/(event)/orderpositions/(id)/certificate/
-
-   Downloads the certificate for one order position, identified by its internal ID. Download is a two-step
-   process. You will always get a :http:statuscode:`303` response with a ``Location`` header to a different
-   URL. In the background, our server starts preparing the PDF file.
-
-   If you then do a ``GET`` to the URL you were given, you will either receive a :http:statuscode:`409` response
-   indicating to retry after a few seconds, or a :http:statuscode:`200` response with the PDF file.
-
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      GET /api/v1/organizers/bigevents/events/sampleconf/orderpositions/23442/certificate/ HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-
-   **Example response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 303 See Other
-      Location: /api/v1/organizers/democon/events/3vjrh/orderpositions/426/certificate/?result=1f550651-ae7b-4911-a76c-2be8f348aaa5
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      GET /api/v1/organizers/bigevents/events/sampleconf/orderpositions/23442/certificate/?result=1f550651-ae7b-4911-a76c-2be8f348aaa5 HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-
-   **Example response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 200 OK
-      Vary: Accept
-      Content-Type: application/pdf
-
-      ...
-
-   :param organizer: The ``slug`` field of the organizer to fetch
-   :param event: The ``slug`` field of the event to fetch
-   :param id: The ``id`` field of the order position to fetch
-   :statuscode 200: File ready for download
-   :statuscode 303: Processing started
-   :statuscode 401: Authentication failure
-   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource
-                    **or** downloads are not available for this order position at this time. The response content will
-                    contain more details.
-   :statuscode 404: The requested order position or download provider does not exist.
-   :statuscode 409: The file is not yet ready and will now be prepared. Retry the request after waiting for a few
-                    seconds.

doc/api/resources/checkin.rst

@@ -1,514 +0,0 @@
-.. spelling:word-list:: checkin
-
-.. _rest-checkin:
-
-Check-in
-========
-
-This page describes special APIs built for ticket scanning apps. For managing check-in configuration or other operations,
-please also see :ref:`rest-checkinlists`. The check-in list API also contains endpoints to obtain statistics or log
-failed scans.
-
-.. _`rest-checkin-redeem`:
-
-Checking a ticket in
---------------------
-
-.. http:post:: /api/v1/organizers/(organizer)/checkinrpc/redeem/
-
-   Tries to redeem an order position, i.e. checks the attendee in (or out). This is the recommended endpoint to use
-   if you build any kind of scanning app that performs check-ins for scanned barcodes. It is safe to use with untrusted
-   inputs in the ``secret`` field.
-
-   This endpoint supports passing multiple check-in lists to perform a multi-event scan. However, each check-in list
-   passed needs to be from a distinct event.
-
-   :query string expand: Expand a field inside the ``position`` object into a full object. Currently ``subevent``, ``item``, ``variation``, and ``answers.question`` are supported. Can be passed multiple times.
-   :<json string secret: Scanned QR code corresponding to the ``secret`` attribute of a ticket.
-   :<json string source_type: Type of source the ``secret`` was obtained form. Defaults to ``"barcode"``.
-   :<json array lists: List of check-in list IDs to search on. No two check-in lists may be from the same event.
-   :<json string type: Send ``"exit"`` for an exit and ``"entry"`` (default) for an entry.
-   :<json datetime datetime: Specifies the datetime of the check-in. If not supplied, the current time will be used.
-   :<json boolean force: Specifies that the check-in should succeed regardless of revoked barcode, previous check-ins or required
-                         questions that have not been filled. This is usually used to upload offline scans that already happened,
-                         because there's no point in validating them since they happened whether they are valid or not. Defaults to ``false``.
-   :<json boolean questions_supported: When this parameter is set to ``true``, handling of questions is supported. If
-                                       you do not implement question handling in your user interface, you **must**
-                                       set this to ``false``. In that case, questions will just be ignored. Defaults
-                                       to ``true``.
-   :<json boolean ignore_unpaid: Specifies that the check-in should succeed even if the order is in pending state.
-                                 Defaults to ``false`` and only works when ``include_pending`` is set on the check-in
-                                 list.
-   :<json object answers: If questions are supported/required, you may/must supply a mapping of question IDs to their
-                          respective answers. The answers should always be strings. In case of (multiple-)choice-type
-                          answers, the string should contain the (comma-separated) IDs of the selected options.
-   :<json string nonce: You can set this parameter to a unique random value to identify this check-in. If you're sending
-                        this request twice with the same nonce, the second request will also succeed but will always
-                        create only one check-in object even when the previous request was successful as well. This
-                        allows for a certain level of idempotency and enables you to re-try after a connection failure.
-   :<json 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.
-   :>json object position: Copy of the matching order position (if any was found). The contents are the same as the
-                           :ref:`order-position-resource`, with the following differences: (1) The ``checkins`` value
-                           will only include check-ins for the selected list. (2) An additional boolean property
-                           ``require_attention`` will inform you whether either the order or the item have the
-                           ``checkin_attention`` flag set. (3) If ``attendee_name`` is empty, it may automatically fall
-                           back to values from a parent product or from invoice addresses. (4) Additional properties
-                           ``order__status``, ``order__valid_if_pending``, ``order__require_approval``, and
-                           ``order__locale`` are included with details form the order for convenience.
-   :>json boolean require_attention: Whether or not the ``require_attention`` flag is set on the item or order.
-   :>json list checkin_texts: List of additional texts to show to the user.
-   :>json object list: Excerpt of information about the matching :ref:`check-in list <rest-checkinlists>` (if any was found),
-                       including the attributes ``id``, ``name``, ``event``, ``subevent``, and ``include_pending``.
-   :>json object questions: List of questions to be answered for check-in, only set on status ``"incomplete"``.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      POST /api/v1/organizers/bigevents/checkinrpc/redeem/ HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-
-      {
-        "secret": "M5BO19XmFwAjLd4nDYUAL9ISjhti0e9q",
-        "source_type": "barcode",
-        "lists": [1],
-        "force": false,
-        "ignore_unpaid": false,
-        "nonce": "Pvrk50vUzQd0DhdpNRL4I4OcXsvg70uA",
-        "datetime": null,
-        "questions_supported": true,
-        "answers": {
-          "4": "XS"
-        }
-      }
-
-   **Example successful response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 201 Created
-      Vary: Accept
-      Content-Type: application/json
-
-      {
-        "status": "ok",
-        "position": {
-          …
-        },
-        "require_attention": false,
-        "checkin_texts": [],
-        "list": {
-          "id": 1,
-          "name": "Default check-in list",
-          "event": "sampleconf",
-          "subevent": null,
-          "include_pending": false
-        }
-      }
-
-   **Example response with required questions**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 400 Bad Request
-      Content-Type: text/json
-
-      {
-        "status": "incomplete",
-        "position": {
-          …
-        },
-        "require_attention": false,
-        "checkin_texts": [],
-        "list": {
-          "id": 1,
-          "name": "Default check-in list",
-          "event": "sampleconf",
-          "subevent": null,
-          "include_pending": false
-        },
-        "questions": [
-          {
-            "id": 1,
-            "question": {"en": "T-Shirt size"},
-            "type": "C",
-            "required": false,
-            "items": [1, 2],
-            "position": 1,
-            "identifier": "WY3TP9SL",
-            "ask_during_checkin": true,
-            "show_during_checkin": true,
-            "options": [
-              {
-                "id": 1,
-                "identifier": "LVETRWVU",
-                "position": 0,
-                "answer": {"en": "S"}
-              },
-              {
-                "id": 2,
-                "identifier": "DFEMJWMJ",
-                "position": 1,
-                "answer": {"en": "M"}
-              },
-              {
-                "id": 3,
-                "identifier": "W9AH7RDE",
-                "position": 2,
-                "answer": {"en": "L"}
-              }
-            ]
-          }
-        ]
-      }
-
-   **Example error response (invalid ticket)**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 404 Not Found
-      Content-Type: text/json
-
-      {
-        "detail": "Not found.",
-        "status": "error",
-        "reason": "invalid",
-        "reason_explanation": null,
-        "require_attention": false,
-        "checkin_texts": []
-      }
-
-   **Example error response (known, but invalid ticket)**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 200 OK
-      Content-Type: text/json
-
-      {
-        "status": "error",
-        "reason": "unpaid",
-        "reason_explanation": null,
-        "require_attention": false,
-        "checkin_texts": [],
-        "list": {
-          "id": 1,
-          "name": "Default check-in list",
-          "event": "sampleconf",
-          "subevent": null,
-          "include_pending": false
-        },
-        "position": {
-          …
-        }
-      }
-
-   Possible error reasons:
-
-   * ``invalid`` - Ticket is not known.
-   * ``unpaid`` - Ticket is not paid for.
-   * ``blocked`` - Ticket has been blocked.
-   * ``invalid_time`` - Ticket is not valid at this time.
-   * ``canceled`` – Ticket is canceled or expired.
-   * ``already_redeemed`` - Ticket already has been redeemed.
-   * ``product`` - Tickets with this product may not be scanned at this device.
-   * ``rules`` - Check-in prevented by a user-defined rule.
-   * ``ambiguous`` - Multiple tickets match scan, rejected.
-   * ``revoked`` - Ticket code has been revoked.
-   * ``unapproved`` - Order has not yet been approved.
-   * ``error`` - Internal error.
-
-   In case of reason ``rules`` and ``invalid_time``, there might be an additional response field ``reason_explanation``
-   with a human-readable description of the violated rules. However, that field can also be missing or be ``null``.
-
-   :param organizer: The ``slug`` field of the organizer to fetch
-   :statuscode 201: no error
-   :statuscode 400: Invalid or incomplete request, see above
-   :statuscode 401: Authentication failure
-   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
-   :statuscode 404: The requested order position does not exist.
-
-Performing a ticket search
---------------------------
-
-.. http:get:: /api/v1/organizers/(organizer)/checkinrpc/search/
-
-   Returns a list of all order positions matching a given search request. The result is the same as
-   the :ref:`order-position-resource`, with the following differences:
-
-   * The ``checkins`` value will only include check-ins for the selected list.
-
-   * An additional boolean property ``require_attention`` will inform you whether either the order or the item
-     have the ``checkin_attention`` flag set.
-
-   * If ``attendee_name`` is empty, it will automatically fall back to values from a parent product or from invoice
-     addresses.
-
-   This endpoint supports passing multiple check-in lists to perform a multi-event search. However, each check-in list
-   passed needs to be from a distinct event.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      GET /api/v1/organizers/bigevents/checkinrpc/search/?list=1&search=Peter HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-
-   **Example response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 200 OK
-      Vary: Accept
-      Content-Type: application/json
-
-      {
-        "count": 1,
-        "next": null,
-        "previous": null,
-        "results": [
-          {
-            "id": 23442,
-            "order": "ABC12",
-            "positionid": 1,
-            "item": 1345,
-            "variation": null,
-            "price": "23.00",
-            "attendee_name": "Peter",
-            "attendee_name_parts": {
-              "full_name": "Peter",
-            },
-            "attendee_email": null,
-            "voucher": null,
-            "tax_rate": "0.00",
-            "tax_rule": null,
-            "tax_value": "0.00",
-            "secret": "z3fsn8jyufm5kpk768q69gkbyr5f4h6w",
-            "addon_to": null,
-            "subevent": null,
-            "pseudonymization_id": "MQLJvANO3B",
-            "seat": null,
-            "checkins": [
-              {
-                "list": 1,
-                "type": "entry",
-                "gate": null,
-                "device": 2,
-                "datetime": "2017-12-25T12:45:23Z",
-                "auto_checked_in": true
-              }
-            ],
-            "answers": [
-              {
-                "question": 12,
-                "answer": "Foo",
-                "options": []
-              }
-            ],
-            "downloads": [
-              {
-                "output": "pdf",
-                "url": "https://pretix.eu/api/v1/organizers/bigevents/events/sampleconf/orderpositions/23442/download/pdf/"
-              }
-            ]
-          }
-        ]
-      }
-
-   :query string search: Fuzzy search matching the attendee name, order code, invoice address name as well as to the beginning of the secret.
-   :query integer list: The check-in list to search on, can be passed multiple times.
-   :query integer page: The page number in case of a multi-page result set, default is 1
-   :query string ignore_status: If set to ``true``, results will be returned regardless of the state of
-                                 the order they belong to and you will need to do your own filtering by order status.
-   :query string ordering: Manually set the ordering of results. Valid fields to be used are ``order__code``,
-                           ``order__datetime``, ``positionid``, ``attendee_name``, ``last_checked_in`` and ``order__email``. Default:
-                           ``attendee_name,positionid``
-   :query string order: Only return positions of the order with the given order code
-   :query string search: Fuzzy search matching the attendee name, order code, invoice address name as well as to the beginning of the secret.
-   :query string expand: Expand a field into a full object. Currently only ``subevent``, ``item``, and ``variation`` are supported. Can be passed multiple times.
-   :query integer item: Only return positions with the purchased item matching the given ID.
-   :query integer item__in: Only return positions with the purchased item matching one of the given comma-separated IDs.
-   :query integer variation: Only return positions with the purchased item variation matching the given ID.
-   :query integer variation__in: Only return positions with one of the purchased item variation matching the given
-                                 comma-separated IDs.
-   :query string attendee_name: Only return positions with the given value in the attendee_name field. Also, add-on
-                                products positions are shown if they refer to an attendee with the given name.
-   :query string secret: Only return positions with the given ticket secret.
-   :query string order__status: Only return positions with the given order status.
-   :query string order__status__in: Only return positions with one the given comma-separated order status.
-   :query boolean has_checkin: If set to ``true`` or ``false``, only return positions that have or have not been
-                               checked in already.
-   :query integer subevent: Only return positions of the sub-event with the given ID
-   :query integer subevent__in: Only return positions of one of the sub-events with the given comma-separated IDs
-   :query integer addon_to: Only return positions that are add-ons to the position with the given ID.
-   :query integer addon_to__in: Only return positions that are add-ons to one of the positions with the given
-                                      comma-separated IDs.
-   :query string voucher: Only return positions with a specific voucher.
-   :query string voucher__code: Only return positions with a specific voucher code.
-   :param organizer: The ``slug`` field of the organizer to fetch
-   :statuscode 200: no error
-   :statuscode 401: Authentication failure
-   :statuscode 403: The requested organizer or check-in list does not exist **or** you have no permission to view this resource.
-   :statuscode 404: The requested check-in list does not exist.
-
-.. _`rest-checkin-annul`:
-
-Annulment of a check-in
------------------------
-
-.. http:post:: /api/v1/organizers/(organizer)/checkinrpc/annul/
-
-   If a check-in was made in error and the person was not let in, it can be annulled. We do not recommend this to be used
-   in case of manual check-ins or user interfaces because it is too prone for human errors. It is mostly intended for
-   automated entry systems like a turnstile or automated door, where the check-in is first created, then the door is
-   opened, and then the check-in may be annulled if the system knows that the turnstile did not turn or was out of
-   order.
-
-   This endpoint supports passing multiple check-in lists for the context of a multi-event scan. However, each
-   check-in list passed needs to be from a distinct event.
-
-   Check-ins created by a device can only be annulled by the same device. The datetime of annulment may not be more than
-   15 minutes after the datetime of check-in (value subject to change).
-
-   A status code of 404 is returned if no check-in was found for the given nonce. A status code of 400 is returned when
-   multiple check-ins match the nonce, the input is invalid in another way, the annulment is made from the wrong device,
-   the check-in is already in an annulled or failed state, or the datetime constraint is not valid.
-
-   :<json string nonce: ``nonce`` value of the original check-in.
-   :<json array lists: List of check-in list IDs to search on. No two check-in lists may be from the same event.
-   :<json datetime datetime: Specifies the client-side datetime of the annulment. If not supplied, the current time will be used.
-   :<json string error_explanation: A human-readable description of why the check-in was annulled (optional).
-   :>json string status: ``"ok"``
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      POST /api/v1/organizers/bigevents/checkinrpc/annul/ HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-
-      {
-        "lists": [1],
-        "nonce": "Pvrk50vUzQd0DhdpNRL4I4OcXsvg70uA",
-        "error_explanation": "Turnstile did not turn"
-      }
-
-   **Example successful response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 200 OK
-      Vary: Accept
-      Content-Type: application/json
-
-      {
-        "status": "ok",
-      }
-
-   :param organizer: The ``slug`` field of the organizer to fetch
-   :statuscode 200: no error
-   :statuscode 400: Invalid or incomplete request, see above
-   :statuscode 401: Authentication failure
-   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
-   :statuscode 404: The requested nonce does not exist.
-
-
-Check-in history
-----------------
-
-.. rst-class:: rest-resource-table
-
-===================================== ========================== =======================================================
-Field                                 Type                       Description
-===================================== ========================== =======================================================
-id                                    integer                    Internal ID of the check-in
-successful                            boolean                    Whether the check-in was successful
-error_reason                          string                     Category of reason why the check-in was unsuccessful. Currently
-                                                                 ``"canceled"``, ``"invalid"``, ``"unpaid"`` ``"product"``,
-                                                                 ``"rules"``, ``"revoked"``, ``"incomplete"``, ``"already_redeemed"``,
-                                                                 ``"ambiguous"``, ``"error"``, ``"blocked"``, ``"unapproved"``,
-                                                                 ``"invalid_time"``, ``"annulled"`` or ``null``
-error_explanation                     string                     Additional, human-readable reason for the check-in to be unsuccessful (or ``null``)
-position                              integer                    Internal ID of the order position (or ``null`` for unknown scans)
-datetime                              datetime                   Logical time when the check-in happened
-created                               datetime                   Time when the check-in appeared on the server
-list                                  integer                    Internal ID of the check-in list
-auto_checked_in                       boolean                    Whether the check-in was performed by the system automatically
-gate                                  integer                    Internal ID of the gate (or ``null``)
-device                                integer                    Internal ID of the device (or ``null``)
-device_id                             integer                    Organizer-internal ID of the device (or ``null``)
-type                                  string                     Type of check-in, currently ``"entry"`` or ``"exit"``
-===================================== ========================== =======================================================
-
-.. http:get:: /api/v1/organizers/(organizer)/events/(event)/checkins/
-
-   Returns a list of all check-in events within a given event.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      GET /api/v1/organizers/bigevents/events/sampleconf/checkins/ 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,
-            "successful": true,
-            "error_reason": null,
-            "error_explanation": null,
-            "position": 1234,
-            "datetime": "2017-12-25T12:45:23Z",
-            "created": "2017-12-25T12:45:23Z",
-            "list": 2,
-            "auto_checked_in": false,
-            "gate": null,
-            "device": null,
-            "device_id": null,
-            "type": "entry",
-          }
-        ]
-      }
-
-   :query integer page: The page number in case of a multi-page result set, default is 1
-   :query datetime created_since: Only return check-ins that have been created since the given date (inclusive).
-   :query datetime created_before: Only return check-ins that have been created before the given date (exclusive).
-   :query datetime datetime_since: Only return check-ins that have happened since the given date (inclusive).
-   :query datetime datetime_before: Only return check-ins that have happened before the given date (exclusive).
-   :query boolean successful: Only return check-ins that have (not) been successful.
-   :query boolean error_reason: Only return check-ins with a specific error reason.
-   :query integer list: Only return check-ins from a specific list.
-   :query string type: Only return check-ins of a specific type.
-   :query integer gate: Only return check-ins from a specific gate.
-   :query integer device: Only return check-ins from a specific device.
-   :query boolean auto_checked_in: Only return check-ins that are (not) auto-checked in.
-   :query string ordering: Manually set the ordering of results. Valid fields to be used are ``datetime``, ``created``,
-                           and ``id``.
-   :param organizer: The ``slug`` field of 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.

doc/api/resources/checkinlists.rst

@@ -1,7 +1,3 @@
-.. spelling:word-list:: checkin
-
-.. _rest-checkinlists:
-
 Check-in lists
 ==============
 
@@ -31,22 +27,27 @@ 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.
-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:: 2023.9
+.. versionchanged:: 1.10
 
-    The ``ignore_in_statistics`` and ``consider_tickets_used`` attributes have been added.
+   This resource has been added.
+
+.. versionchanged:: 1.11
+
+   The ``positions`` endpoints have been added.
+
+.. versionchanged:: 1.13
+
+   The ``include_pending`` field has been added.
 
 Endpoints
 ---------
 
+.. versionchanged:: 1.15
+
+   The ``../status/`` detail endpoint has been added.
+
 .. http:get:: /api/v1/organizers/(organizer)/events/(event)/checkinlists/
 
    Returns a list of all check-in lists within a given event.
@@ -80,24 +81,13 @@ Endpoints
             "all_products": true,
             "limit_products": [],
             "include_pending": false,
-            "subevent": null,
-            "allow_multiple_entries": false,
-            "allow_entry_after_exit": true,
-            "exit_all_at": null,
-            "rules": {},
-            "addon_match": false
+            "subevent": null
           }
         ]
       }
 
    :query integer page: The page number in case of a multi-page result set, default is 1
    :query integer subevent: Only return check-in lists of the sub-event with the given ID
-   :query integer subevent_match: Only return check-in lists that are valid for the sub-event with the given ID (i.e. also lists valid for all subevents)
-   :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
@@ -132,12 +122,7 @@ Endpoints
         "all_products": true,
         "limit_products": [],
         "include_pending": false,
-        "subevent": null,
-        "allow_multiple_entries": false,
-        "allow_entry_after_exit": true,
-        "exit_all_at": null,
-        "rules": {},
-        "addon_match": false
+        "subevent": null
       }
 
    :param organizer: The ``slug`` field of the organizer to fetch
@@ -170,16 +155,15 @@ Endpoints
       {
         "checkin_count": 17,
         "position_count": 42,
-        "inside_count": 12,
         "event": {
-          "name": "Demo Conference"
+          "name": "Demo Converence",
         },
         "items": [
           {
             "name": "T-Shirt",
             "id": 1,
             "checkin_count": 1,
-            "admission": false,
+            "admission": False,
             "position_count": 1,
             "variations": [
               {
@@ -200,7 +184,7 @@ Endpoints
             "name": "Ticket",
             "id": 2,
             "checkin_count": 15,
-            "admission": true,
+            "admission": True,
             "position_count": 22,
             "variations": []
           }
@@ -225,16 +209,13 @@ Endpoints
       POST /api/v1/organizers/bigevents/events/sampleconf/checkinlists/ HTTP/1.1
       Host: pretix.eu
       Accept: application/json, text/javascript
-      Content-Type: application/json
+      Content: application/json
 
       {
         "name": "VIP entry",
         "all_products": false,
         "limit_products": [1, 2],
-        "subevent": null,
-        "allow_multiple_entries": false,
-        "allow_entry_after_exit": true,
-        "addon_match": false
+        "subevent": null
       }
 
    **Example response**:
@@ -253,10 +234,7 @@ Endpoints
         "all_products": false,
         "limit_products": [1, 2],
         "include_pending": false,
-        "subevent": null,
-        "allow_multiple_entries": false,
-        "allow_entry_after_exit": true,
-        "addon_match": false
+        "subevent": null
       }
 
    :param organizer: The ``slug`` field of the organizer of the event/item to create a list for
@@ -305,10 +283,7 @@ Endpoints
         "all_products": false,
         "limit_products": [1, 2],
         "include_pending": false,
-        "subevent": null,
-        "allow_multiple_entries": false,
-        "allow_entry_after_exit": true,
-        "addon_match": false
+        "subevent": null
       }
 
    :param organizer: The ``slug`` field of the organizer to modify
@@ -321,7 +296,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**:
 
@@ -345,61 +320,27 @@ Endpoints
    :statuscode 401: Authentication failure
    :statuscode 403: The requested organizer/event does not exist **or** you have no permission to delete this resource.
 
-.. http:post:: /api/v1/organizers/(organizer)/events/(event)/checkinlists/(list)/failed_checkins/
-
-   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.
-   :<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"``.
-   :<json position: Internal ID of an order position you matched. Optional.
-   :<json raw_item: Internal ID of an item you matched. Optional.
-   :<json raw_variation: Internal ID of an item variation you matched. Optional.
-   :<json raw_subevent: Internal ID of an event series date you matched. Optional.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      POST /api/v1/organizers/bigevents/events/sampleconf/checkinlists/1/failed_checkins/ HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-
-      {
-        "raw_barcode": "Pvrk50vUzQd0DhdpNRL4I4OcXsvg70uA",
-        "error_reason": "canceled"
-      }
-
-   :param organizer: The ``slug`` field of the organizer to fetch
-   :param event: The ``slug`` field of the event to fetch
-   :param list: The ID of the check-in list to save for
-   :statuscode 201: no error
-   :statuscode 400: Invalid request
-   :statuscode 401: Authentication failure
-   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
-   :statuscode 404: The requested order position or check-in list does not exist.
-
 
 Order position endpoints
 ------------------------
 
+.. versionchanged:: 1.15
+
+   The order positions endpoint has been extended by the filter queries ``item__in``, ``variation__in``,
+   ``order__status__in``, ``subevent__in``, ``addon_to__in``, and ``search``. The search for attendee names and order
+   codes is now case-insensitive.
+
+   The ``.../redeem/`` endpoint has been added.
+
+.. versionchanged:: 2.0
+
+   The order positions endpoint has been extended by the filter queries ``voucher`` and ``voucher__code``.
+
 .. http:get:: /api/v1/organizers/(organizer)/events/(event)/checkinlists/(list)/positions/
 
    Returns a list of all order positions within a given event. The result is the same as
-   the :ref:`order-position-resource`, with the following differences:
-
-   * The ``checkins`` value will only include check-ins for the selected list.
-
-   * An additional boolean property ``require_attention`` will inform you whether either the order or the item
-     have the ``checkin_attention`` flag set.
-
-   * If ``attendee_name`` is empty, it will automatically fall back to values from a parent product or from invoice
-     addresses.
-
-   You can use this endpoint to implement a ticket search. We also provide a dedicated search input as part of our
-   :ref:`check-in API <rest-checkin>` that supports search across multiple events.
+   the :ref:`order-position-resource`, with one important difference: the ``checkins`` value will only include
+   check-ins for the selected list.
 
    **Example request**:
 
@@ -442,15 +383,10 @@ Order position endpoints
             "addon_to": null,
             "subevent": null,
             "pseudonymization_id": "MQLJvANO3B",
-            "seat": null,
             "checkins": [
               {
                 "list": 1,
-                "type": "entry",
-                "gate": null,
-                "device": 2,
-                "datetime": "2017-12-25T12:45:23Z",
-                "auto_checked_in": true
+                "datetime": "2017-12-25T12:45:23Z"
               }
             ],
             "answers": [
@@ -471,14 +407,11 @@ Order position endpoints
       }
 
    :query integer page: The page number in case of a multi-page result set, default is 1
-   :query string ignore_status: If set to ``true``, results will be returned regardless of the state of
-                                 the order they belong to and you will need to do your own filtering by order status.
    :query string ordering: Manually set the ordering of results. Valid fields to be used are ``order__code``,
                            ``order__datetime``, ``positionid``, ``attendee_name``, ``last_checked_in`` and ``order__email``. Default:
                            ``attendee_name,positionid``
    :query string order: Only return positions of the order with the given order code
    :query string search: Fuzzy search matching the attendee name, order code, invoice address name as well as to the beginning of the secret.
-   :query string expand: Expand a field into a full object. Currently ``subevent``, ``item``, ``variation``, and ``answers.question`` are supported. Can be passed multiple times.
    :query integer item: Only return positions with the purchased item matching the given ID.
    :query integer item__in: Only return positions with the purchased item matching one of the given comma-separated IDs.
    :query integer variation: Only return positions with the purchased item variation matching the given ID.
@@ -509,15 +442,10 @@ Order position endpoints
 .. http:get:: /api/v1/organizers/(organizer)/events/(event)/checkinlists/(list)/positions/(id)/
 
    Returns information on one order position, identified by its internal ID.
-   The result is the same as the :ref:`order-position-resource`, with the following differences:
+   The result format is the same as the :ref:`order-position-resource`, with one important difference: the
+   ``checkins`` value will only include check-ins for the selected list.
 
-   * The ``checkins`` value will only include check-ins for the selected list.
-
-   * An additional boolean property ``require_attention`` will inform you whether either the order or the item
-     have the ``checkin_attention`` flag set.
-
-   * If ``attendee_name`` is empty, it will automatically fall back to values from a parent product or from invoice
-     addresses.
+   **Instead of an ID, you can also use the ``secret`` field as the lookup parameter.**
 
    **Example request**:
 
@@ -555,15 +483,10 @@ Order position endpoints
         "addon_to": null,
         "subevent": null,
         "pseudonymization_id": "MQLJvANO3B",
-        "seat": null,
         "checkins": [
           {
             "list": 1,
-            "datetime": "2017-12-25T12:45:23Z",
-            "type": "entry",
-            "gate": null,
-            "device": 2,
-            "auto_checked_in": true
+            "datetime": "2017-12-25T12:45:23Z"
           }
         ],
         "answers": [
@@ -595,33 +518,17 @@ Order position endpoints
    Tries to redeem an order position, identified by its internal ID, i.e. checks the attendee in. This endpoint
    accepts a number of optional requests in the body.
 
-   **Tip:** Instead of an ID, you can also use the ``secret`` field as the lookup parameter. In this case, you should
-   always set ``untrusted_input=true`` as a query parameter to avoid security issues.
+   **Instead of an ID, you can also use the ``secret`` field as the lookup parameter.**
 
-   .. note::
-
-      We no longer recommend using this API if you're building a ticket scanning application, as it has a few design
-      flaws that can lead to `security issues`_ or compatibility issues due to barcode content characters that are not
-      URL-safe. We recommend to use our new :ref:`check-in API <rest-checkin>` instead.
-
-   :query boolean untrusted_input: If set to true, the lookup parameter is **always** interpreted as a ``secret``, never
-                                   as an ``id``. This should be always set if you are passing through untrusted, scanned
-                                   data to avoid guessing of ticket IDs.
    :<json boolean questions_supported: When this parameter is set to ``true``, handling of questions is supported. If
                                        you do not implement question handling in your user interface, you **must**
                                        set this to ``false``. In that case, questions will just be ignored. Defaults
                                        to ``true``.
-   :<json boolean canceled_supported: When this parameter is set to ``true``, the response code ``canceled`` may be
-                                      returned. Otherwise, canceled orders will return ``unpaid``. (**Deprecated**, in
-                                      the future, this will be ignored and ``canceled`` may always be returned.)
    :<json datetime datetime: Specifies the datetime of the check-in. If not supplied, the current time will be used.
-   :<json boolean force: Specifies that the check-in should succeed regardless of revoked barcode, previous check-ins or required
-                         questions that have not been filled. This is usually used to upload offline scans that already happened,
-                         because there's no point in validating them since they happened whether they are valid or not. Defaults to ``false``.
-   :<json string type: Send ``"exit"`` for an exit and ``"entry"`` (default) for an entry.
+   :<json boolean force: Specifies that the check-in should succeed regardless of previous check-ins or required
+                         questions that have not been filled. Defaults to ``false``.
    :<json boolean ignore_unpaid: Specifies that the check-in should succeed even if the order is in pending state.
-                                 Defaults to ``false`` and only works when ``include_pending`` is set on the check-in
-                                 list.
+                                 Defaults to ``false``.
    :<json string nonce: You can set this parameter to a unique random value to identify this check-in. If you're sending
                         this request twice with the same nonce, the second request will also succeed but will always
                         create only one check-in object even when the previous request was successful as well. This
@@ -644,7 +551,6 @@ Order position endpoints
         "nonce": "Pvrk50vUzQd0DhdpNRL4I4OcXsvg70uA",
         "datetime": null,
         "questions_supported": true,
-        "canceled_supported": true,
         "answers": {
           "4": "XS"
         }
@@ -687,7 +593,6 @@ Order position endpoints
             "position": 1,
             "identifier": "WY3TP9SL",
             "ask_during_checkin": true,
-            "show_during_checkin": true,
             "options": [
               {
                 "id": 1,
@@ -729,21 +634,9 @@ Order position endpoints
 
    Possible error reasons:
 
-   * ``invalid`` - Ticket code not known.
-   * ``unpaid`` - Ticket is not paid for.
-   * ``blocked`` - Ticket has been blocked.
-   * ``invalid_time`` - Ticket is not valid at this time.
-   * ``canceled`` – Ticket is canceled or expired. This reason is only sent when your request sets.
-     ``canceled_supported`` to ``true``, otherwise these orders return ``unpaid``.
-   * ``already_redeemed`` - Ticket already has been redeemed.
-   * ``product`` - Tickets with this product may not be scanned at this device.
-   * ``rules`` - Check-in prevented by a user-defined rule.
-   * ``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``.
+   * ``unpaid`` - Ticket is not paid for or has been refunded
+   * ``already_redeemed`` - Ticket already has been redeemed
+   * ``product`` - Tickets with this product may not be scanned at this device
 
    :param organizer: The ``slug`` field of the organizer to fetch
    :param event: The ``slug`` field of the event to fetch
@@ -754,6 +647,3 @@ Order position endpoints
    :statuscode 401: Authentication failure
    :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
    :statuscode 404: The requested order position or check-in list does not exist.
-
-
-.. _security issues: https://pretix.eu/about/de/blog/20220705-release-4111/

doc/api/resources/customers.rst

@@ -1,265 +0,0 @@
-.. _`rest-customers`:
-
-Customers
-=========
-
-Resource description
---------------------
-
-The customer resource contains the following public fields:
-
-.. rst-class:: rest-resource-table
-
-===================================== ========================== =======================================================
-Field                                 Type                       Description
-===================================== ========================== =======================================================
-identifier                            string                     Internal ID of the customer
-external_identifier                   string                     External ID of the customer (or ``null``). This field can
-                                                                 be changed for customers created manually or through
-                                                                 the API, but is read-only for customers created through a
-                                                                 SSO integration.
-email                                 string                     Customer email address
-phone                                 string                     Customer phone number
-name                                  string                     Name of this customer (or ``null``)
-name_parts                            object of strings          Decomposition of name (i.e. given name, family name)
-is_active                             boolean                    Whether this account is active
-is_verified                           boolean                    Whether the email address of this account has been
-                                                                 verified
-last_login                            datetime                   Date and time of last login
-date_joined                           datetime                   Date and time of registration
-locale                                string                     Preferred language of the customer
-last_modified                         datetime                   Date and time of modification of the record
-notes                                 string                     Internal notes and comments (or ``null``)
-password                              string                     Can only be set during creation of a new customer, will
-                                                                 not be included in any responses.
-===================================== ========================== =======================================================
-
-.. versionchanged:: 2024.3
-
-   The attribute ``phone`` has been added.
-
-Endpoints
----------
-
-.. http:get:: /api/v1/organizers/(organizer)/customers/
-
-   Returns a list of all customers registered with a given organizer.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      GET /api/v1/organizers/bigevents/customers/ 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": "8WSAJCJ",
-            "external_identifier": null,
-            "email": "customer@example.org",
-            "phone": "+493012345678",
-            "name": "John Doe",
-            "name_parts": {
-                "_scheme": "full",
-                "full_name": "John Doe"
-            },
-            "is_active": true,
-            "is_verified": false,
-            "last_login": null,
-            "date_joined": "2021-04-06T13:44:22.809216Z",
-            "locale": "de",
-            "last_modified": "2021-04-06T13:44:22.809377Z",
-            "notes": null
-          }
-        ]
-      }
-
-   :query integer page: The page number in case of a multi-page result set, default is 1
-   :query string email: Only fetch customers with this email address
-   :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)/customers/(identifier)/
-
-   Returns information on one customer, identified by its identifier.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      GET /api/v1/organizers/bigevents/customers/8WSAJCJ/ 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": "8WSAJCJ",
-        "external_identifier": null,
-        "email": "customer@example.org",
-        "phone": "+493012345678",
-        "name": "John Doe",
-        "name_parts": {
-            "_scheme": "full",
-            "full_name": "John Doe"
-        },
-        "is_active": true,
-        "is_verified": false,
-        "last_login": null,
-        "date_joined": "2021-04-06T13:44:22.809216Z",
-        "locale": "de",
-        "last_modified": "2021-04-06T13:44:22.809377Z",
-        "notes": null
-      }
-
-   :param organizer: The ``slug`` field of the organizer to fetch
-   :param identifier: The ``identifier`` field of the customer 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)/customers/
-
-   Creates a new customer. In addition to the fields defined on the resource, you can pass the field ``send_email``
-   to control whether the system should send an account activation email with a password reset link (defaults to
-   ``false``).
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      POST /api/v1/organizers/bigevents/customers/ HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-      Content-Type: application/json
-
-      {
-        "email": "test@example.org",
-        "phone": "+493012345678",
-        "password": "verysecret",
-        "send_email": true
-      }
-
-   **Example response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 201 Created
-      Vary: Accept
-      Content-Type: application/json
-
-      {
-        "identifier": "8WSAJCJ",
-        "external_identifier": null,
-        "email": "test@example.org",
-        "phone": "+493012345678",
-        ...
-      }
-
-   :param organizer: The ``slug`` field of the organizer to create a customer for
-   :statuscode 201: no error
-   :statuscode 400: The customer 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)/customers/(identifier)/
-
-   Update a customer. 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``, ``last_login``, ``date_joined``,
-   ``name`` (which is auto-generated from ``name_parts``), and ``last_modified`` fields.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      PATCH /api/v1/organizers/bigevents/customers/8WSAJCJ/ HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-      Content-Type: application/json
-      Content-Length: 94
-
-      {
-        "email": "test@example.org"
-      }
-
-   **Example response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 200 OK
-      Vary: Accept
-      Content-Type: application/json
-
-      {
-        "identifier": "8WSAJCJ",
-        "external_identifier": null,
-        "email": "test@example.org",
-        "phone": "+493012345678",
-        …
-      }
-
-   :param organizer: The ``slug`` field of the organizer to modify
-   :param identifier: The ``identifier`` field of the customer to modify
-   :statuscode 200: no error
-   :statuscode 400: The customer 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:post:: /api/v1/organizers/(organizer)/customers/(identifier)/anonymize/
-
-   Anonymize a customer. Deletes personal data and disconnects from existing orders.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      POST /api/v1/organizers/bigevents/customers/8WSAJCJ/anonymize/ 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": "8WSAJCJ",
-        "external_identifier": null,
-        "email": null,
-        "phone": null,
-        …
-      }
-
-   :param organizer: The ``slug`` field of the organizer to modify
-   :param identifier: The ``identifier`` field of the customer to modify
-   :statuscode 200: no error
-   :statuscode 400: The customer 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/devices.rst

@@ -1,232 +0,0 @@
-.. spelling:word-list:: fullname
-
-.. _`rest-devices`:
-
-Devices
-=======
-
-See also :ref:`rest-deviceauth`.
-
-Device resource
-----------------
-
-The device resource contains the following public fields:
-
-.. rst-class:: rest-resource-table
-
-===================================== ========================== =======================================================
-Field                                 Type                       Description
-===================================== ========================== =======================================================
-device_id                             integer                    Internal ID of the device within this organizer
-unique_serial                         string                     Unique identifier of this device
-name                                  string                     Device name
-all_events                            boolean                    Whether this device has access to all events
-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
-initialized                           datetime                   Time of initialization (or ``null``)
-initialization_token                  string                     Token for initialization
-revoked                               boolean                    Whether this device no longer has access
-security_profile                      string                     The name of a supported security profile restricting API access
-===================================== ========================== =======================================================
-
-Device endpoints
-----------------
-
-.. http:get:: /api/v1/organizers/(organizer)/devices/
-
-   Returns a list of all devices within a given organizer.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      GET /api/v1/organizers/bigevents/devices/ 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": [
-          {
-            "device_id": 1,
-            "unique_serial": "UOS3GNZ27O39V3QS",
-            "initialization_token": "frkso3m2w58zuw70",
-            "all_events": false,
-            "limit_events": [
-              "museum"
-            ],
-            "revoked": false,
-            "name": "Scanner",
-            "created": "2020-09-18T14:17:40.971519Z",
-            "initialized": "2020-09-18T14:17:44.190021Z",
-            "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"
-          }
-        ]
-      }
-
-   :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)/devices/(device_id)/
-
-   Returns information on one device, identified by its ID.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      GET /api/v1/organizers/bigevents/devices/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
-
-      {
-        "device_id": 1,
-        "unique_serial": "UOS3GNZ27O39V3QS",
-        "initialization_token": "frkso3m2w58zuw70",
-        "all_events": false,
-        "limit_events": [
-          "museum"
-        ],
-        "revoked": false,
-        "name": "Scanner",
-        "created": "2020-09-18T14:17:40.971519Z",
-        "initialized": "2020-09-18T14:17:44.190021Z",
-        "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"
-      }
-
-   :param organizer: The ``slug`` field of the organizer to fetch
-   :param device_id: The ``device_id`` field of the device 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)/devices/
-
-   Creates a new device
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      POST /api/v1/organizers/bigevents/devices/ HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-      Content-Type: application/json
-
-      {
-        "name": "Scanner",
-        "all_events": true,
-        "limit_events": [],
-      }
-
-   **Example response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 201 Created
-      Vary: Accept
-      Content-Type: application/json
-
-      {
-        "device_id": 1,
-        "unique_serial": "UOS3GNZ27O39V3QS",
-        "initialization_token": "frkso3m2w58zuw70",
-        "all_events": true,
-        "limit_events": [],
-        "revoked": false,
-        "name": "Scanner",
-        "created": "2020-09-18T14:17:40.971519Z",
-        "security_profile": "full",
-        "initialized": null
-        "hardware_brand": null,
-        "hardware_model": null,
-        "os_name": null,
-        "os_version": null,
-        "software_brand": null,
-        "software_version": null
-      }
-
-   :param organizer: The ``slug`` field of the organizer to create a device for
-   :statuscode 201: no error
-   :statuscode 400: The device 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)/devices/(device_id)/
-
-   Update a device.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      PATCH /api/v1/organizers/bigevents/devices/1/ HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-      Content-Type: application/json
-      Content-Length: 94
-
-      {
-        "name": "Foo"
-      }
-
-   **Example response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 200 OK
-      Vary: Accept
-      Content-Type: application/json
-
-      {
-        "id": 1,
-        "name": "Foo",
-        ...
-      }
-
-   :param organizer: The ``slug`` field of the organizer to modify
-   :param device_id: The ``device_id`` field of the device to modify
-   :statuscode 200: no error
-   :statuscode 400: The device 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/digital.rst

@@ -1,366 +0,0 @@
-Digital content
-===============
-
-.. note:: This API is only available when the plugin **pretix-digital** is installed (pretix Hosted and Enterprise only).
-
-URL interpolation and JWT authentication
-----------------------------------------
-
-In the simplest case, you can use the digital content module to point users to a specific piece of content on some
-platform after their ticket purchase, or show them an embedded video or live stream. However, the full power of the
-module can be utilized by passing additional information to the target system to automatically authenticate the user
-or pre-fill some fields with their data. For example, you could use an URL like this::
-
-    https://webinars.example.com/join?as={attendee_name}&userid={order_code}-{positionid}
-
-While this is already useful, it does not provide much security – anyone could guess a valid combination for that URL.
-Therefore, the module allows you to pass information as a `JSON Web Token`_, which isn't encrypted, but signed with a
-shared secret such that nobody can create their own tokens or modify the contents. To use a token, set up a URL like this::
-
-    https://webinars.example.com/join?with_token={token}
-
-Additionally, you will need to set a JWT secret and a token template, either through the pretix interface or through the
-API (see below). pretix currently only supports tokens signed with ``HMAC-SHA256`` (``HS256``). Your token template can contain
-whatever JSON you'd like to pass on based on the same variables, for example::
-
-    {
-        "iss": "pretix.eu",
-        "aud": "webinars.example.com",
-        "user": {
-            "id": "{order_code}-{positionid}",
-            "product": "{product_id}",
-            "variation": "{variation_id}",
-            "name": "{attendee_name}"
-        }
-    }
-
-Variables can only be used in strings inside the JSON structure.
-pretix will automatically add an ``iat`` claim with the current timestamp and an ``exp`` claim with an expiration timestamp
-based on your configuration.
-
-
-List of variables
-"""""""""""""""""
-
-The following variables are currently supported:
-
-.. rst-class:: rest-resource-table
-
-=================================== ====================================================================
-Variable                            Description
-=================================== ====================================================================
-``order_code``                      Order code (alphanumerical, unique per order, not per ticket)
-``positionid``                      ID of the ticket within the order (integer, starting at 1)
-``order_email``                     E-mail address of the ticket purchaser
-``product_id``                      Internal ID of the purchased product
-``product_variation``               Internal ID of the purchased product variation (or empty)
-``secret``                          The secret ticket code, would be used as the QR code for physical tickets
-``attendee_name``                   Full name of the ticket holder (or empty)
-``attendee_name_*``                 Name parts of the ticket holder, depending on configuration, e.g. ``attendee_name_given_name`` or ``attendee_name_family_name``
-``attendee_email``                  E-mail address of the ticket holder (or empty)
-``attendee_company``                Company of the ticket holder (or empty)
-``attendee_street``                 Street of the ticket holder's address (or empty)
-``attendee_zipcode``                ZIP code of the ticket holder's address (or empty)
-``attendee_city``                   City of the ticket holder's address (or empty)
-``attendee_country``                Country code of the ticket holder's address (or empty)
-``attendee_state``                  State of the ticket holder's address (or empty)
-``answers[XYZ]``                    Answer to the custom question with identifier ``XYZ``
-``invoice_name``                    Full name of the invoice address (or empty)
-``invoice_name_*``                  Name parts of the invoice address, depending on configuration, e.g. ``invoice_name_given_name`` or ``invoice_name_family_name``
-``invoice_company``                 Company of the invoice address (or empty)
-``invoice_street``                  Street of the invoice address (or empty)
-``invoice_zipcode``                 ZIP code of the invoice address (or empty)
-``invoice_city``                    City of the invoice address (or empty)
-``invoice_country``                 Country code of the invoice address (or empty)
-``invoice_state``                   State of the invoice address (or empty)
-``meta_XYZ``                        Value of the event's ``XYZ`` meta property
-``token``                           Signed JWT (only to be used in URLs, not in tokens)
-=================================== ====================================================================
-
-
-API Resource description
--------------------------
-
-The digital content plugin provides a HTTP API that allows you to create new digital content for your ticket holders,
-such as live streams, videos, or material downloads.
-
-The digital content resource contains the following public fields:
-
-.. rst-class:: rest-resource-table
-
-===================================== ========================== =======================================================
-Field                                 Type                       Description
-===================================== ========================== =======================================================
-id                                    integer                    Internal content ID
-title                                 multi-lingual string       The content title (required)
-internal_name                         string                     An optional name that is only used in the backend
-content_type                          string                     The type of content, valid values are ``webinar``, ``video``, ``livestream``, ``link``, ``file``
-url                                   string                     The location of the digital content
-file                                  file                       A downloadable file. Either ``url`` or ``file`` must be ``null``.
-description                           multi-lingual string       A public description of the item. May contain Markdown
-                                                                 syntax and is not required.
-available_from                        datetime                   The first date time at which this content will be shown
-                                                                 (or ``null``).
-available_until                       datetime                   The last date time at which this content will b e shown
-                                                                 (or ``null``).
-all_products                          boolean                    If ``true``, the content is available to all buyers of tickets for this event. The ``limit_products`` field is ignored in this case.
-limit_products                        list of integers           List of product/item IDs. This content is only shown to buyers of these ticket types.
-position                              integer                    An integer, used for sorting
-subevent                              integer                    Date in an event series this content should be shown for. Should be ``null`` if this is not an event series or if this should be shown to all customers.
-jwt_template                          string                     Template for JWT token generation
-jwt_secret                            string                     Secret for JWT token generation
-jwt_validity                          integer                    JWT validity in days
-===================================== ========================== =======================================================
-
-API Endpoints
--------------
-
-.. http:get:: /api/v1/organizers/(organizer)/events/(event)/digitalcontents/
-
-   Returns a list of all digital content configured for an event.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      GET /api/v1/organizers/bigevents/events/sampleconf/digitalcontents/ 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,
-            "subevent": null,
-            "title": {
-                "en": "Concert livestream"
-            },
-            "content_type": "link",
-            "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
-            "file": null,
-            "description": {
-                "en": "Watch our event live here on YouTube!"
-            },
-            "all_products": true,
-            "limit_products": [],
-            "available_from": "2020-03-22T23:00:00Z",
-            "available_until": null,
-            "position": 1
-          }
-        ]
-      }
-
-   :query page: The page number in case of a multi-page result set, default is 1
-   :param organizer: The ``slug`` field of a valid organizer
-   :param event: The ``slug`` field of the event to fetch
-   :statuscode 200: no error
-   :statuscode 401: Authentication failure
-   :statuscode 403: The requested organizer or event does not exist **or** you have no permission to view it.
-
-.. http:get:: /api/v1/organizers/(organizer)/events/(event)/digitalcontents/(id)/
-
-   Returns information on one content item, identified by its ID.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      GET /api/v1/organizers/bigevents/events/sampleconf/digitalcontents/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,
-        "subevent": null,
-        "title": {
-            "en": "Concert livestream"
-        },
-        "content_type": "link",
-        "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
-        "file": null,
-        "description": {
-            "en": "Watch our event live here on YouTube!"
-        },
-        "all_products": true,
-        "limit_products": [],
-        "available_from": "2020-03-22T23:00:00Z",
-        "available_until": null,
-        "position": 1
-      }
-
-   :param organizer: The ``slug`` field of the organizer to fetch
-   :param event: The ``slug`` field of the event to fetch
-   :param id: The ``id`` field of the content to fetch
-   :statuscode 200: no error
-   :statuscode 401: Authentication failure
-   :statuscode 403: The requested organizer/event/content does not exist **or** you have no permission to view it.
-
-.. http:post:: /api/v1/organizers/(organizer)/events/(event)/digitalcontents/
-
-   Create a new digital content.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      POST /api/v1/organizers/bigevents/events/sampleconf/digitalcontents/ HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-      Content-Type: application/json
-      Content-Length: 166
-
-      {
-        "subevent": null,
-        "title": {
-            "en": "Concert livestream"
-        },
-        "content_type": "link",
-        "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
-        "file": null,
-        "description": {
-            "en": "Watch our event live here on YouTube!"
-        },
-        "all_products": true,
-        "limit_products": [],
-        "available_from": "2020-03-22T23:00:00Z",
-        "available_until": null,
-        "position": 1
-      }
-
-   **Example response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 201 Created
-      Vary: Accept
-      Content-Type: application/json
-
-      {
-        "id": 2,
-        "subevent": null,
-        "title": {
-            "en": "Concert livestream"
-        },
-        "content_type": "link",
-        "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
-        "file": null,
-        "description": {
-            "en": "Watch our event live here on YouTube!"
-        },
-        "all_products": true,
-        "limit_products": [],
-        "available_from": "2020-03-22T23:00:00Z",
-        "available_until": null,
-        "position": 1
-      }
-
-   :param organizer: The ``slug`` field of the organizer to create new content for
-   :param event: The ``slug`` field of the event to create new content for
-   :statuscode 201: no error
-   :statuscode 400: The content 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 digital contents.
-
-
-.. http:patch:: /api/v1/organizers/(organizer)/events/(event)/digitalcontents/(id)/
-
-   Update a content. You can also use ``PUT`` instead of ``PATCH``. With ``PUT``, you have to provide all fields of
-   the resource, other fields will be reset to default. With ``PATCH``, you only need to provide the fields that you
-   want to change.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      PATCH /api/v1/organizers/bigevents/events/sampleconf/digitalcontents/1/ HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-      Content-Type: application/json
-      Content-Length: 34
-
-      {
-        "url": "https://mywebsite.com"
-      }
-
-   **Example response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 200 OK
-      Vary: Accept
-      Content-Type: text/javascript
-
-      {
-        "id": 2,
-        "subevent": null,
-        "title": {
-            "en": "Concert livestream"
-        },
-        "content_type": "link",
-        "url": "https://mywebsite.com",
-        "file": null,
-        "description": {
-            "en": "Watch our event live here on YouTube!"
-        },
-        "all_products": true,
-        "limit_products": [],
-        "available_from": "2020-03-22T23:00:00Z",
-        "available_until": null,
-        "position": 1
-      }
-
-   :param organizer: The ``slug`` field of the organizer to modify
-   :param event: The ``slug`` field of the event to modify
-   :param id: The ``id`` field of the content to modify
-   :statuscode 200: no error
-   :statuscode 400: The content could not be modified due to invalid submitted data.
-   :statuscode 401: Authentication failure
-   :statuscode 403: The requested organizer/event/content does not exist **or** you have no permission to change it.
-
-
-.. http:delete:: /api/v1/organizers/(organizer)/events/(event)/digitalcontents/(id)/
-
-   Delete a digital content.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      DELETE /api/v1/organizers/bigevents/events/sampleconf/digitalcontents/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 content to delete
-   :statuscode 204: no error
-   :statuscode 401: Authentication failure
-   :statuscode 403: The requested organizer/event/content does not exist **or** you have no permission to change it
-
-.. _JSON Web Token: https://en.wikipedia.org/wiki/JSON_Web_Token

doc/api/resources/discounts.rst

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

doc/api/resources/events.rst

@@ -1,9 +1,3 @@
-.. spelling:word-list::
-
-   geo
-   lat
-   lon
-
 Events
 ======
 
@@ -31,33 +25,31 @@ is_public                             boolean                    If ``true``, th
 presale_start                         datetime                   The date at which the ticket shop opens (or ``null``)
 presale_end                           datetime                   The date at which the ticket shop closes (or ``null``)
 location                              multi-lingual string       The event location (or ``null``)
-geo_lat                               float                      Latitude of the location (or ``null``)
-geo_lon                               float                      Longitude of the location (or ``null``)
-has_subevents                         boolean                    ``true`` if the event series feature is active for this
+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.
+meta_data                             dict                       Values set for organizer-specific meta data parameters.
 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
-                                                                 plan. Otherwise ``null``.
-seat_category_mapping                 object                     An object mapping categories of the seating plan
-                                                                 (strings) to items in the event (integers or ``null``).
-timezone                              string                     Event timezone name
-item_meta_properties                  object                     Item-specific meta data parameters and default values.
-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).
 ===================================== ========================== =======================================================
 
 
+.. versionchanged:: 1.7
+
+   The ``meta_data`` field has been added.
+
+.. versionchanged:: 1.15
+
+   The ``plugins`` field has been added.
+   The operations POST, PATCH, PUT and DELETE have been added.
+
+.. versionchanged:: 2.1
+
+   Filters have been added to the list of events.
+
+.. versionchanged:: 2.5
+
+   The ``testmode`` attribute has been added.
+
 Endpoints
 ---------
 
@@ -101,28 +93,14 @@ Endpoints
             "presale_start": null,
             "presale_end": null,
             "location": null,
-            "geo_lat": null,
-            "geo_lon": null,
             "has_subevents": false,
             "meta_data": {},
-            "seating_plan": null,
-            "seat_category_mapping": {},
-            "timezone": "Europe/Berlin",
-            "item_meta_properties": {},
             "plugins": [
-              "pretix.plugins.banktransfer",
-              "pretix.plugins.stripe",
-              "pretix.plugins.paypal",
+              "pretix.plugins.banktransfer"
+              "pretix.plugins.stripe"
+              "pretix.plugins.paypal"
               "pretix.plugins.ticketoutputpdf"
-            ],
-            "all_sales_channels": false,
-            "limit_sales_channels": [
-              "web",
-              "pretixpos",
-              "resellers"
-            ],
-            "sales_channels": [],
-            "public_url": "https://pretix.eu/bigevents/sampleconf/"
+            ]
           }
         ]
       }
@@ -130,28 +108,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 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.
-                           Default: ``slug``.
-   :query array attr[meta_data_key]: By providing the key and value of a meta data attribute, the list of events will
-        only contain the events matching the set criteria. Providing ``?attr[Format]=Seminar`` would return only those
-        events having set their ``Format`` meta data to ``Seminar``, ``?attr[Format]=`` only those, that have no value
-        set. Please note that this filter will respect default values set on organizer level.
-   :query sales_channel: If set to a sales channel identifier, only events allowed to be sold on the specified sales channel are returned.
-   :query with_availability_for: If set to a sales channel identifier, the response will contain a special ``best_availability_state``
-                                 attribute with values of 100 for "tickets available", values less than 100 for "tickets sold out or reserved",
-                                 and ``null`` for "status unknown". These values might be served from a cache. This parameter can make the response
-                                 slow.
-   :query search: Only return events matching a given search query.
    :param organizer: The ``slug`` field of a valid organizer
    :statuscode 200: no error
    :statuscode 401: Authentication failure
@@ -192,33 +152,14 @@ Endpoints
         "presale_start": null,
         "presale_end": null,
         "location": null,
-        "geo_lat": null,
-        "geo_lon": null,
         "has_subevents": false,
-        "seating_plan": null,
-        "seat_category_mapping": {},
         "meta_data": {},
-        "timezone": "Europe/Berlin",
-        "item_meta_properties": {},
         "plugins": [
-          "pretix.plugins.banktransfer",
-          "pretix.plugins.stripe",
-          "pretix.plugins.paypal",
+          "pretix.plugins.banktransfer"
+          "pretix.plugins.stripe"
+          "pretix.plugins.paypal"
           "pretix.plugins.ticketoutputpdf"
-        ],
-        "valid_keys": {
-          "pretix_sig1": [
-            "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
@@ -243,7 +184,7 @@ Endpoints
       POST /api/v1/organizers/bigevents/events/ HTTP/1.1
       Host: pretix.eu
       Accept: application/json, text/javascript
-      Content-Type: application/json
+      Content: application/json
 
       {
         "name": {"en": "Sample Conference"},
@@ -257,21 +198,13 @@ Endpoints
         "is_public": false,
         "presale_start": null,
         "presale_end": null,
-        "seating_plan": null,
-        "seat_category_mapping": {},
         "location": null,
-        "geo_lat": null,
-        "geo_lon": null,
         "has_subevents": false,
         "meta_data": {},
-        "timezone": "Europe/Berlin",
-        "item_meta_properties": {},
         "plugins": [
           "pretix.plugins.stripe",
           "pretix.plugins.paypal"
-        ],
-        "all_sales_channels": true,
-        "limit_sales_channels": []
+        ]
       }
 
    **Example response**:
@@ -295,32 +228,15 @@ Endpoints
         "presale_start": null,
         "presale_end": null,
         "location": null,
-        "geo_lat": null,
-        "geo_lon": null,
-        "seating_plan": null,
-        "seat_category_mapping": {},
         "has_subevents": false,
         "meta_data": {},
-        "timezone": "Europe/Berlin",
-        "item_meta_properties": {},
         "plugins": [
           "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.
-   :query clone_from: Set to ``event_slug`` to clone data (settings, products, …) from an event with this slug in the
-                      same organizer or to ``organizer_slug/event_slug`` to clone from an event within a different
-                      organizer.
    :statuscode 201: no error
    :statuscode 400: The event could not be created due to invalid submitted data.
    :statuscode 401: Authentication failure
@@ -329,14 +245,13 @@ Endpoints
 
 .. http:post:: /api/v1/organizers/(organizer)/events/(event)/clone/
 
-   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.
+   Creates a new event with properties as set in the request body. The properties that are copied are: 'is_public',
+   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' 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.
+   Please note that you can only copy from events under the same organizer.
 
    Permission required: "Can create events"
 
@@ -347,7 +262,7 @@ Endpoints
       POST /api/v1/organizers/bigevents/events/sampleconf/clone/ HTTP/1.1
       Host: pretix.eu
       Accept: application/json, text/javascript
-      Content-Type: application/json
+      Content: application/json
 
       {
         "name": {"en": "Sample Conference"},
@@ -362,20 +277,12 @@ Endpoints
         "presale_start": null,
         "presale_end": null,
         "location": null,
-        "geo_lat": null,
-        "geo_lon": null,
-        "seating_plan": null,
-        "seat_category_mapping": {},
         "has_subevents": false,
         "meta_data": {},
-        "timezone": "Europe/Berlin",
-        "item_meta_properties": {},
         "plugins": [
           "pretix.plugins.stripe",
           "pretix.plugins.paypal"
-        ],
-        "all_sales_channels": true,
-        "limit_sales_channels": []
+        ]
       }
 
    **Example response**:
@@ -399,34 +306,20 @@ Endpoints
         "presale_start": null,
         "presale_end": null,
         "location": null,
-        "geo_lat": null,
-        "geo_lon": null,
         "has_subevents": false,
-        "seating_plan": null,
-        "seat_category_mapping": {},
         "meta_data": {},
-        "timezone": "Europe/Berlin",
-        "item_meta_properties": {},
         "plugins": [
           "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.
    :param event: The ``slug`` field of the event to copy settings and items from.
    :statuscode 201: no error
-   :statuscode 400: The event could not be updated due to invalid submitted data.
+   :statuscode 400: The event 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 update this resource.
+   :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)/
@@ -442,7 +335,7 @@ Endpoints
       PATCH /api/v1/organizers/bigevents/events/sampleconf/ HTTP/1.1
       Host: pretix.eu
       Accept: application/json, text/javascript
-      Content-Type: application/json
+      Content: application/json
 
       {
         "plugins": [
@@ -474,28 +367,14 @@ Endpoints
         "presale_start": null,
         "presale_end": null,
         "location": null,
-        "geo_lat": null,
-        "geo_lon": null,
         "has_subevents": false,
-        "seating_plan": null,
-        "seat_category_mapping": {},
         "meta_data": {},
-        "timezone": "Europe/Berlin",
-        "item_meta_properties": {},
         "plugins": [
           "pretix.plugins.banktransfer",
           "pretix.plugins.stripe",
           "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
@@ -506,7 +385,7 @@ Endpoints
    :statuscode 403: The requested organizer/event does not exist **or** you have no permission to create this resource.
 
 
-.. http:delete:: /api/v1/organizers/(organizer)/events/(event)/
+.. http:delete:: /api/v1/organizers/(organizer)/events/(event)/items/(id)/
 
    Delete an event. Note that events with orders cannot be deleted to ensure data integrity.
 
@@ -532,125 +411,3 @@ Endpoints
    :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.
-
-Event settings
---------------
-
-pretix events have lots and lots of parameters of different types that are stored in a key-value store on our system.
-Since many of these settings depend on each other in complex ways, we can not give direct access to all of these
-settings through the API. However, we do expose many of the simple and useful flags through the API.
-
-Please note that the available settings flags change between pretix versions and also between events, depending on the
-installed plugins, and we do not give a guarantee on backwards-compatibility like with other parts of the API.
-Therefore, we're also not including a list of the options here, but instead recommend to look at the endpoint output
-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.
-
-.. http:get:: /api/v1/organizers/(organizer)/events/(event)/settings/
-
-   Get current values of event settings.
-
-   Permission required: "Can change event settings" (Exception: with device auth, *some* settings can always be *read*.)
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      GET /api/v1/organizers/bigevents/events/sampleconf/settings/ HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-
-   **Example standard response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 200 OK
-      Vary: Accept
-      Content-Type: application/json
-
-      {
-        "imprint_url": "https://pretix.eu",
-        …
-      }
-
-   **Example verbose response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 200 OK
-      Vary: Accept
-      Content-Type: application/json
-
-      {
-        "imprint_url":
-          {
-            "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."
-          }
-        },
-        …
-      }
-
-   :param organizer: The ``slug`` field of the organizer of the event to access
-   :param event: The ``slug`` field of the event to access
-   :query explain: Set to ``true`` to enable verbose response mode
-   :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:patch:: /api/v1/organizers/(organizer)/events/(event)/settings/
-
-   Updates event settings. Note that ``PUT`` is not allowed here, only ``PATCH``.
-
-    .. warning::
-
-       Settings can be stored at different levels in pretix. If a value is not set on event level, a default setting
-       from a higher level (organizer, global) will be returned. If you explicitly set a setting on event level, it
-       will no longer be inherited from the higher levels. Therefore, we recommend you to send only settings that you
-       explicitly want to set on event level. To unset a settings, pass ``null``.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      PATCH /api/v1/organizers/bigevents/events/sampleconf/settings/ HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-      Content-Type: application/json
-
-      {
-        "imprint_url": "https://example.org/imprint/"
-      }
-
-   **Example response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 200 OK
-      Vary: Accept
-      Content-Type: application/json
-
-      {
-        "imprint_url": "https://example.org/imprint/",
-        …
-      }
-
-   :param organizer: The ``slug`` field of the organizer of the event to update
-   :param event: The ``slug`` field of the event to update
-   :statuscode 200: no error
-   :statuscode 400: The event could not be updated due to invalid submitted data.
-   :statuscode 401: Authentication failure
-   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to create this resource.

doc/api/resources/exhibitors.rst

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

doc/api/resources/exporters.rst

@@ -1,213 +0,0 @@
-.. spelling:word-list:: checkin
-
-.. _rest-exporters:
-
-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.
-
-.. warning::
-
-   While we consider the methods listed on this page to be a stable API, the availability and specific input field
-   requirements of individual exporters is **not considered a stable API**. Specific exporters and their input parameters
-   may change at any time without warning.
-
-Listing available exporters
----------------------------
-
-.. http:get:: /api/v1/organizers/(organizer)/events/(event)/exporters/
-
-   Returns a list of all exporters available for a given event. You will receive a list of export methods as well as their
-   supported input fields. Note that the exact type and validation requirements of the input fields are not given in the
-   response, and you might need to look into the pretix web interface to figure out the exact input required.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      GET /api/v1/organizers/bigevents/events/sampleconf/exporters/ 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": "orderlist",
-            "verbose_name": "Order data",
-            "input_parameters": [
-              {
-                "name": "_format",
-                "required": true,
-                "choices": [
-                  "xlsx",
-                  "orders:default",
-                  "orders:excel",
-                  "orders:semicolon",
-                  "positions:default",
-                  "positions:excel",
-                  "positions:semicolon",
-                  "fees:default",
-                  "fees:excel",
-                  "fees:semicolon"
-                ]
-              },
-              {
-                "name": "paid_only",
-                "required": false
-              }
-            ]
-          }
-        ]
-      }
-
-   :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.
-
-.. http:get:: /api/v1/organizers/(organizer)/exporters/
-
-   Returns a list of all cross-event exporters available for a given organizer. You will receive a list of export methods as well as their
-   supported input fields. Note that the exact type and validation requirements of the input fields are not given in the
-   response, and you might need to look into the pretix web interface to figure out the exact input required.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      GET /api/v1/organizers/bigevents/exporters/ 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": "orderlist",
-            "verbose_name": "Order data",
-            "input_parameters": [
-              {
-                "name": "events",
-                "required": false
-              },
-              {
-                "name": "_format",
-                "required": true,
-                "choices": [
-                  "xlsx",
-                  "orders:default",
-                  "orders:excel",
-                  "orders:semicolon",
-                  "positions:default",
-                  "positions:excel",
-                  "positions:semicolon",
-                  "fees:default",
-                  "fees:excel",
-                  "fees:semicolon"
-                ]
-              },
-              {
-                "name": "paid_only",
-                "required": false
-              }
-            ]
-          }
-        ]
-      }
-
-   :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/event does not exist **or** you have no permission to view this resource.
-
-Running an 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)/exporters/(identifier)/run/
-
-   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.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      POST /api/v1/organizers/bigevents/events/sampleconf/exporters/orderlist/run/ HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-      Content-Type: application/json
-
-      {
-        "_format": "xlsx"
-      }
-
-   **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/exporters/orderlist/download/29891ede-196f-4942-9e26-d055a36e98b8/3f279f13-c198-4137-b49b-9b360ce9fcce/"
-      }
-
-   :param organizer: The ``slug`` field of the organizer to fetch
-   :param event: The ``slug`` field of the event to fetch
-   :param identifier: The ``identifier`` field of the exporter to run
-   :statuscode 202: no error
-   :statuscode 400: Invalid input options
-   :statuscode 401: Authentication failure
-   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
-
-.. http:post:: /api/v1/organizers/(organizer)/exporters/(identifier)/run/
-
-   The endpoint for organizer-level exports works just like event-level exports (see above).
-
-
-Downloading the result
-----------------------
-
-When starting an export, you receive a ``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", "percentage": 40}``. ``percentage`` can be ``null`` if it is not known and ``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::
-
-   Running exports puts a lot of stress on the system, we kindly ask you not to run more than two exports at the same time.
-

doc/api/resources/giftcards.rst

@@ -1,339 +0,0 @@
-.. _`rest-giftcards`:
-
-Gift cards
-==========
-
-Resource description
---------------------
-
-The gift card resource contains the following public fields:
-
-.. rst-class:: rest-resource-table
-
-===================================== ========================== =======================================================
-Field                                 Type                       Description
-===================================== ========================== =======================================================
-id                                    integer                    Internal ID of the gift card
-secret                                string                     Gift card code (can not be modified later)
-value                                 money (string)             Current gift card value
-currency                              string                     Currency of the value (can not be modified later)
-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:
-
-.. rst-class:: rest-resource-table
-
-===================================== ========================== =======================================================
-Field                                 Type                       Description
-===================================== ========================== =======================================================
-id                                    integer                    Internal ID of the gift card transaction
-datetime                              datetime                   Creation date of the transaction
-value                                 money (string)             Transaction amount
-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.)
-===================================== ========================== =======================================================
-
-Endpoints
----------
-
-.. http:get:: /api/v1/organizers/(organizer)/giftcards/
-
-   Returns a list of all gift cards issued by a given organizer.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      GET /api/v1/organizers/bigevents/giftcards/ HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-
-   **Example response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 200 OK
-      Vary: Accept
-      Content-Type: application/json
-
-      {
-        "count": 1,
-        "next": null,
-        "previous": null,
-        "results": [
-          {
-            "id": 1,
-            "secret": "HLBYVELFRC77NCQY",
-            "currency": "EUR",
-            "testmode": false,
-            "expires": null,
-            "conditions": null,
-            "owner_ticket": null,
-            "issuer": "bigevents",
-            "value": "13.37"
-          }
-        ]
-      }
-
-   :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
-   :statuscode 403: The requested organizer does not exist **or** you have no permission to view this resource.
-
-.. http:get:: /api/v1/organizers/(organizer)/giftcards/(id)/
-
-   Returns information on one gift card, identified by its ID.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      GET /api/v1/organizers/bigevents/giftcards/1/ HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-
-   **Example response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 200 OK
-      Vary: Accept
-      Content-Type: application/json
-
-      {
-        "id": 1,
-        "secret": "HLBYVELFRC77NCQY",
-        "currency": "EUR",
-        "testmode": false,
-        "expires": null,
-        "conditions": null,
-        "owner_ticket": null,
-        "issuer": "bigevents",
-        "value": "13.37"
-      }
-
-   :param organizer: The ``slug`` field of the organizer to fetch
-   :param id: The ``id`` field of the gift card to fetch
-   :query boolean include_accepted: Also show gift cards issued by other organizers that are accepted by this organizer.
-   :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)/giftcards/
-
-   Creates a new gift card
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      POST /api/v1/organizers/bigevents/giftcards/ HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-      Content-Type: application/json
-
-      {
-        "secret": "HLBYVELFRC77NCQY",
-        "currency": "EUR",
-        "value": "13.37"
-      }
-
-   **Example response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 201 Created
-      Vary: Accept
-      Content-Type: application/json
-
-      {
-        "id": 1,
-        "secret": "HLBYVELFRC77NCQY",
-        "testmode": false,
-        "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
-   :statuscode 403: The requested organizer does not exist **or** you have no permission to create this resource.
-
-.. http:patch:: /api/v1/organizers/(organizer)/giftcards/(id)/
-
-   Update a gift card. 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``, ``secret``, ``testmode``, and ``currency`` fields. Be
-   careful when modifying the ``value`` field to avoid race conditions. We recommend to use the ``transact`` method
-   described below.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      PATCH /api/v1/organizers/bigevents/giftcards/1/ HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-      Content-Type: application/json
-      Content-Length: 94
-
-      {
-        "value": "14.00"
-      }
-
-   **Example response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 200 OK
-      Vary: Accept
-      Content-Type: application/json
-
-      {
-        "id": 1,
-        "secret": "HLBYVELFRC77NCQY",
-        "testmode": false,
-        "currency": "EUR",
-        "expires": null,
-        "conditions": null,
-        "owner_ticket": null,
-        "issuer": "bigevents",
-        "value": "14.00"
-      }
-
-   :param organizer: The ``slug`` field of the organizer to modify
-   :param id: The ``id`` field of the gift card to modify
-   :statuscode 200: no error
-   :statuscode 400: The gift card 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:post:: /api/v1/organizers/(organizer)/giftcards/(id)/transact/
-
-   Atomically change the value of a gift card. A positive amount will increase the value of the gift card,
-   a negative amount will decrease it.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      POST /api/v1/organizers/bigevents/giftcards/1/transact/ HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-      Content-Type: application/json
-      Content-Length: 79
-
-      {
-        "value": "2.00",
-        "text": "Optional value explaining the transaction"
-      }
-
-   **Example response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 200 OK
-      Vary: Accept
-      Content-Type: application/json
-
-      {
-        "id": 1,
-        "secret": "HLBYVELFRC77NCQY",
-        "currency": "EUR",
-        "testmode": false,
-        "expires": null,
-        "conditions": null,
-        "owner_ticket": null,
-        "issuer": "bigevents",
-        "value": "15.37"
-      }
-
-   :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.
-   :statuscode 200: no error
-   :statuscode 400: The gift card 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.
-   :statuscode 409: There is not sufficient credit on the gift card.
-
-.. http:get:: /api/v1/organizers/(organizer)/giftcards/(id)/transactions/
-
-   List all transactions of a gift card.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      GET /api/v1/organizers/bigevents/giftcards/1/transactions/ HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-
-   **Example response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 200 OK
-      Vary: Accept
-      Content-Type: application/json
-
-      {
-        "count": 1,
-        "next": null,
-        "previous": null,
-        "results": [
-          {
-            "id": 82,
-            "datetime": "2020-06-22T15:41:42.800534Z",
-            "value": "50.00",
-            "event": "democon",
-            "order": "FXQYW",
-            "text": null,
-            "acceptor": "bigevents",
-            "info": {
-              "created_by": "plugin1"
-            }
-          }
-        ]
-      }
-
-   :param organizer: The ``slug`` field of the organizer to view
-   :param id: The ``id`` field of the gift card to view
-   :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.

doc/api/resources/imported_secrets.rst

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

doc/api/resources/index.rst

@@ -1,11 +1,6 @@
 Resources and endpoints
 =======================
 
-With a few exceptions, this only lists resources bundled in the pretix core modules.
-Additional endpoints are provided by pretix plugins. Some of them are documented
-at :ref:`plugin-docs`.
-
-
 .. toctree::
    :maxdepth: 2
 
@@ -18,45 +13,13 @@ at :ref:`plugin-docs`.
    item_variations
    item_bundles
    item_add-ons
-   item_meta_properties
-   item_program_times
    questions
    question_options
    quotas
-   seats
    orders
    invoices
-   transactions
    vouchers
-   discounts
-   checkin
    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
-   offlinesales
-   shipping
-   billing_invoices
-   billing_var

doc/api/resources/invoices.rst

@@ -1,5 +1,3 @@
-.. _rest-invoices:
-
 Invoices
 ========
 
@@ -14,32 +12,11 @@ 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
+is_cancellation                       boolean                    ``True``, if this invoice is the cancellation of a
                                                                  different invoice.
-invoice_from_name                     string                     Sender address: Name
-invoice_from                          string                     Sender address: Address lines
-invoice_from_zipcode                  string                     Sender address: ZIP code
-invoice_from_city                     string                     Sender address: City
-invoice_from_state                    string                     Sender address: State (only used in some countries)
-invoice_from_country                  string                     Sender address: Country code
-invoice_from_tax_id                   string                     Sender address: Local Tax ID
-invoice_from_vat_id                   string                     Sender address: EU VAT ID
-invoice_to                            string                     Full recipient address
-invoice_to_is_business                boolean                    Recipient address: Business vs individual (``null`` for
-                                                                 invoices created before pretix 2025.6).
-invoice_to_company                    string                     Recipient address: Company name
-invoice_to_name                       string                     Recipient address: Person name
-invoice_to_street                     string                     Recipient address: Address lines
-invoice_to_zipcode                    string                     Recipient address: ZIP code
-invoice_to_city                       string                     Recipient address: City
-invoice_to_state                      string                     Recipient address: State (only used in some countries)
-invoice_to_country                    string                     Recipient address: Country code
-invoice_to_vat_id                     string                     Recipient address: EU VAT ID
-invoice_to_beneficiary                string                     Invoice beneficiary
-invoice_to_transmission_info          object                     Additional transmission info (see :ref:`rest-transmission-types`)
-custom_field                          string                     Custom invoice address field
+invoice_from                          string                     Sender address
+invoice_to                            string                     Receiver address
 date                                  date                       Invoice date
 refers                                string                     Invoice number of an invoice this invoice refers to
                                                                  (for example a cancellation refers to the invoice it
@@ -49,56 +26,12 @@ 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.
 ├ description                         string                     Text representing the invoice line (e.g. product name)
-├ item                                integer                    Product used to create this line. Note that everything
-                                                                 about the product might have changed since the creation
-                                                                 of the invoice. Can be ``null`` for all invoice lines
-                                                                 created before this field was introduced as well as for
-                                                                 all lines not created by a product (e.g. a shipping or
-                                                                 cancellation fee).
-├ variation                           integer                    Product variation used to create this line. Note that everything
-                                                                 about the product might have changed since the creation
-                                                                 of the invoice. Can be ``null`` for all invoice lines
-                                                                 created before this field was introduced as well as for
-                                                                 all lines not created by a product (e.g. a shipping or
-                                                                 cancellation fee).
-├ subevent                            integer                    Event series date ID used to create this line. Note that everything
-                                                                 about the subevent might have changed since the creation
-                                                                 of the invoice. Can be ``null`` for all invoice lines
-                                                                 created before this field was introduced as well as for
-                                                                 all lines not created by a product (e.g. a shipping or
-                                                                 cancellation fee) as well as for all events that are not a series.
-├ fee_type                            string                     Fee type, e.g. ``shipping``, ``service``, ``payment``,
-                                                                 ``cancellation``, ``giftcard``, or ``other. Can be ``null`` for
-                                                                 all invoice lines
-                                                                 created before this field was introduced as well as for
-                                                                 all lines not created by a fee (e.g. a product).
-├ fee_internal_type                   string                     Additional fee type, e.g. type of payment provider. Can be ``null``
-                                                                 for all invoice lines
-                                                                 created before this field was introduced as well as for
-                                                                 all lines not created by a fee (e.g. a product).
-├ period_start                        datetime                   Start date of the service or delivery period of the invoice line.
-                                                                 Can be ``null`` if not known.
-├ period_end                          datetime                   End date of the service or delivery period of the invoice line.
-                                                                 Can be ``null`` if not known.
-├ event_date_from                     datetime                   Deprecated alias of ``period_start``.
-├ event_date_to                       datetime                   Deprecated alias of ``period_end``.
-├ event_location                      string                     Location of the (sub)event this line was created for as it
-                                                                 was set during invoice creation. Can be ``null`` for all invoice
-                                                                 lines created before this was introduced as well as for lines in
-                                                                 an event series not created by a product (e.g. shipping or
-                                                                 cancellation fees) as well as whenever the respective (sub)event
-                                                                 has no location set.
-├ attendee_name                       string                     Attendee name at time of invoice creation. Can be ``null`` if no
-                                                                 name was set or if names are configured to not be added to invoices.
 ├ gross_value                         money (string)             Price including taxes
 ├ 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
@@ -109,96 +42,29 @@ foreign_currency_rate                 decimal (string)           If ``foreign_cu
 foreign_currency_rate_date            date                       If ``foreign_currency_rate`` is set, this signifies the
                                                                  date at which the currency rate was obtained.
 internal_reference                    string                     Customer's reference to be printed on the invoice.
-transmission_type                     string                     Requested transmission channel (see :ref:`rest-transmission-types`)
-transmission_provider                 string                     Selected transmission provider (depends on installed
-                                                                 plugins). ``null`` if not yet chosen.
-transmission_status                   string                     Transmission status, one of ``unknown`` (pre-2025.6),
-                                                                 ``pending``, ``inflight``, ``failed``, and ``completed``.
-transmission_date                     datetime                   Time of last change in transmission status (may be ``null``).
 ===================================== ========================== =======================================================
 
 
-.. versionchanged:: 2023.8
+.. versionchanged:: 1.6
 
-   The ``event`` attribute has been added. The organizer-level endpoint has been added.
-
-.. versionchanged:: 2024.8
-
-   The ``tax_code`` attribute has been added.
-
-.. versionchanged:: 2025.6
-
-   The attributes ``invoice_to_is_business``, ``invoice_to_transmission_info``, ``transmission_type``,
-   ``transmission_provider``, ``transmission_status``, and ``transmission_date`` have been added.
+   The attribute ``invoice_no`` has been dropped in favor of ``number`` which includes the number including the prefix,
+   since the prefix can now vary. Also, invoices now need to be identified by their ``number`` instead of the raw
+   number.
 
 
-.. _`rest-transmission-types`:
+.. versionchanged:: 1.7
 
-Transmission types
-------------------
+   The attributes ``lines.tax_name``, ``foreign_currency_display``, ``foreign_currency_rate``, and
+   ``foreign_currency_rate_date`` have been added.
 
-pretix supports multiple ways to transmit an invoice from the organizer to the invoice recipient.
-For each transmission type, different fields are supported in the ``transmission_info`` object of the
-invoice address. Currently, pretix supports the following transmission types:
 
-Email
-"""""
+.. versionchanged:: 1.9
 
-The identifier ``"email"`` represents the transmission of PDF invoices through email.
-This is the default transmission type in pretix and has some special behavior for backwards compatibility.
-Transmission is always executed through the provider ``"email_pdf"``.
-The ``transmission_info`` object may contain the following properties:
+   The attribute ``internal_reference`` has been added.
 
-.. rst-class:: rest-resource-table
 
-===================================== ========================== =======================================================
-Field                                 Type                       Description
-===================================== ========================== =======================================================
-transmission_email_address            string                     Optional. An email address other than the order address
-                                                                 that the invoice should be sent to.
-                                                                 Business customers only.
-===================================== ========================== =======================================================
-
-Peppol
-""""""
-
-The identifier ``"peppol"`` represents the transmission of XML invoices through the `Peppol`_ network.
-This is only available for business addresses.
-This is not supported by pretix out of the box and requires the use of a suitable plugin.
-The ``transmission_info`` object may contain the following properties:
-
-.. rst-class:: rest-resource-table
-
-===================================== ========================== =======================================================
-Field                                 Type                       Description
-===================================== ========================== =======================================================
-transmission_peppol_participant_id    string                     Required. The Peppol participant ID of the recipient.
-===================================== ========================== =======================================================
-
-Italian Exchange System
-"""""""""""""""""""""""
-
-The identifier ``"it_sdi"`` represents the transmission of XML invoices through the `Sistema di Interscambio`_ network used in Italy.
-This is only available for addresses with country ``"IT"``.
-This is not supported by pretix out of the box and requires the use of a suitable plugin.
-The ``transmission_info`` object may contain the following properties:
-
-.. rst-class:: rest-resource-table
-
-===================================== ========================== =======================================================
-Field                                 Type                       Description
-===================================== ========================== =======================================================
-transmission_it_sdi_codice_fiscale    string                     Required for non-business address. Fiscal code of the
-                                                                 recipient.
-transmission_it_sdi_pec               string                     Required for business addresses. Address for certified
-                                                                 electronic mail.
-transmission_it_sdi_recipient_code    string                     Required for businesses. SdI recipient code.
-===================================== ========================== =======================================================
-
-If this type is selected, ``vat_id`` is required for business addresses.
-
-List of all invoices
---------------------
+Endpoints
+---------
 
 .. http:get:: /api/v1/organizers/(organizer)/events/(event)/invoices/
 
@@ -227,30 +93,10 @@ List of all invoices
         "results": [
           {
             "number": "SAMPLECONF-00001",
-            "event": "sampleconf",
             "order": "ABC12",
             "is_cancellation": false,
-            "invoice_from_name": "Big Events LLC",
-            "invoice_from": "Demo street 12",
-            "invoice_from_zipcode":"",
-            "invoice_from_city":"Demo town",
-            "invoice_from_state":"CA",
-            "invoice_from_country":"US",
-            "invoice_from_tax_id":"",
-            "invoice_from_vat_id":"",
-            "invoice_to": "Sample company\nJohn Doe\nTest street 12\n12345 Testington\nTestikistan\nVAT-ID: EU123456789",
-            "invoice_to_company": "Sample company",
-            "invoice_to_is_business": true,
-            "invoice_to_name": "John Doe",
-            "invoice_to_street": "Test street 12",
-            "invoice_to_zipcode": "12345",
-            "invoice_to_city": "Testington",
-            "invoice_to_state": null,
-            "invoice_to_country": "TE",
-            "invoice_to_vat_id": "EU123456789",
-            "invoice_to_beneficiary": "",
-            "invoice_to_transmission_info": {},
-            "custom_field": null,
+            "invoice_from": "Big Events LLC\nDemo street 12\nDemo town",
+            "invoice_to": "Sample company\nJohn Doe\nTest street 12\n12345 Testington\nTestikistan\nVAT ID: EU123456789",
             "date": "2017-12-01",
             "refers": null,
             "locale": "en",
@@ -258,37 +104,19 @@ 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": [
               {
-                "position": 1,
                 "description": "Budget Ticket",
-                "item": 1234,
-                "variation": 245,
-                "subevent": null,
-                "fee_type": null,
-                "fee_internal_type": null,
-                "event_date_from": "2017-12-27T10:00:00Z",
-                "event_date_to": null,
-                "period_start": "2017-12-27T10:00:00Z",
-                "period_end": "2017-12-27T10:00:00Z",
-                "event_location": "Heidelberg",
-                "attendee_name": null,
                 "gross_value": "23.00",
                 "tax_value": "0.00",
                 "tax_name": "VAT",
-                "tax_code": "S/standard",
                 "tax_rate": "0.00"
               }
             ],
             "foreign_currency_display": "PLN",
             "foreign_currency_rate": "4.2408",
-            "foreign_currency_rate_date": "2017-07-24",
-            "transmission_type": "email",
-            "transmission_provider": "email_pdf",
-            "transmission_status": "completed",
-            "transmission_date": "2017-07-24T10:00:00Z"
+            "foreign_currency_rate_date": "2017-07-24"
           }
         ]
       }
@@ -297,9 +125,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
@@ -310,50 +135,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.
@@ -376,30 +157,10 @@ Fetching individual invoices
 
       {
         "number": "SAMPLECONF-00001",
-        "event": "sampleconf",
         "order": "ABC12",
         "is_cancellation": false,
-        "invoice_from_name": "Big Events LLC",
-        "invoice_from": "Demo street 12",
-        "invoice_from_zipcode":"",
-        "invoice_from_city":"Demo town",
-        "invoice_from_state":"CA",
-        "invoice_from_country":"US",
-        "invoice_from_tax_id":"",
-        "invoice_from_vat_id":"",
-        "invoice_to": "Sample company\nJohn Doe\nTest street 12\n12345 Testington\nTestikistan\nVAT-ID: EU123456789",
-        "invoice_to_company": "Sample company",
-        "invoice_to_is_business": true,
-        "invoice_to_name": "John Doe",
-        "invoice_to_street": "Test street 12",
-        "invoice_to_zipcode": "12345",
-        "invoice_to_city": "Testington",
-        "invoice_to_state": null,
-        "invoice_to_country": "TE",
-        "invoice_to_vat_id": "EU123456789",
-        "invoice_to_beneficiary": "",
-        "invoice_to_transmission_info": {},
-        "custom_field": null,
+        "invoice_from": "Big Events LLC\nDemo street 12\nDemo town",
+        "invoice_to": "Sample company\nJohn Doe\nTest street 12\n12345 Testington\nTestikistan\nVAT ID: EU123456789",
         "date": "2017-12-01",
         "refers": null,
         "locale": "en",
@@ -407,47 +168,29 @@ 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": [
           {
-            "position": 1,
             "description": "Budget Ticket",
-            "item": 1234,
-            "variation": 245,
-            "subevent": null,
-            "fee_type": null,
-            "fee_internal_type": null,
-            "event_date_from": "2017-12-27T10:00:00Z",
-            "event_date_to": null,
-            "period_start": "2017-12-27T10:00:00Z",
-            "period_end": "2017-12-27T10:00:00Z",
-            "event_location": "Heidelberg",
-            "attendee_name": null,
             "gross_value": "23.00",
             "tax_value": "0.00",
             "tax_name": "VAT",
-            "tax_code": "S/standard",
             "tax_rate": "0.00"
           }
         ],
         "foreign_currency_display": "PLN",
         "foreign_currency_rate": "4.2408",
-        "foreign_currency_rate_date": "2017-07-24",
-        "transmission_type": "email",
-        "transmission_provider": "email_pdf",
-        "transmission_status": "completed",
-        "transmission_date": "2017-07-24T10:00:00Z"
+        "foreign_currency_rate_date": "2017-07-24"
       }
 
    :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.
 
@@ -474,20 +217,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.
 
@@ -509,13 +246,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.
 
@@ -537,75 +274,8 @@ 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
    :statuscode 403: The requested organizer/event does not exist **or** you have no permission to change this resource.
-
-
-Transmitting invoices
----------------------
-
-Invoices are transmitted automatically when created during order creation or payment receipt,
-but in other cases transmission may need to be triggered manually.
-
-.. http:post:: /api/v1/organizers/(organizer)/events/(event)/invoices/(number)/transmit/
-
-   Transmits the invoice to the recipient, but only if it is in ``pending`` state.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      GET /api/v1/organizers/bigevents/events/sampleconf/invoices/00001/transmit/ HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-
-   **Example response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 204 No Content
-      Vary: Accept
-      Content-Type: application/pdf
-
-   :param organizer: The ``slug`` field of the organizer to fetch
-   :param event: The ``slug`` field of the event to fetch
-   :param number: The ``number`` field of the invoice to transmit
-   :statuscode 200: no error
-   :statuscode 401: Authentication failure
-   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to transmit this invoice **or** the invoice may not be transmitted
-   :statuscode 409: The invoice is currently in transmission
-
-.. http:post:: /api/v1/organizers/(organizer)/events/(event)/invoices/(number)/retransmit/
-
-   Transmits the invoice to the recipient even if transmission was already attempted previously.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      GET /api/v1/organizers/bigevents/events/sampleconf/invoices/00001/retransmit/ HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-
-   **Example response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 204 No Content
-      Vary: Accept
-      Content-Type: application/pdf
-
-   :param organizer: The ``slug`` field of the organizer to fetch
-   :param event: The ``slug`` field of the event to fetch
-   :param number: The ``number`` field of the invoice to transmit
-   :statuscode 200: no error
-   :statuscode 401: Authentication failure
-   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to transmit this invoice **or** the invoice may not be transmitted
-   :statuscode 409: The invoice is currently in transmission
-
-
-.. _Peppol: https://en.wikipedia.org/wiki/PEPPOL
-.. _Sistema di Interscambio: https://it.wikipedia.org/wiki/Fattura_elettronica_in_Italia

doc/api/resources/item_add-ons.rst

@@ -24,10 +24,13 @@ addon_category                        integer                    Internal ID of
 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
 ===================================== ========================== =======================================================
 
+.. versionchanged:: 1.12
+
+   This resource has been added.
+
 Endpoints
 ---------
 
@@ -62,7 +65,6 @@ Endpoints
             "min_count": 0,
             "max_count": 10,
             "position": 0,
-            "multi_allowed": false,
             "price_included": true
           },
           {
@@ -71,7 +73,6 @@ Endpoints
             "min_count": 0,
             "max_count": 10,
             "position": 1,
-            "multi_allowed": false,
             "price_included": true
           }
         ]
@@ -111,7 +112,6 @@ Endpoints
         "min_count": 0,
         "max_count": 10,
         "position": 1,
-        "multi_allowed": false,
         "price_included": true
       }
 
@@ -134,14 +134,13 @@ Endpoints
       POST /api/v1/organizers/(organizer)/events/(event)/items/(item)/addons/ HTTP/1.1
       Host: pretix.eu
       Accept: application/json, text/javascript
-      Content-Type: application/json
+      Content: application/json
 
       {
         "addon_category": 1,
         "min_count": 0,
         "max_count": 10,
         "position": 1,
-        "multi_allowed": false,
         "price_included": true
       }
 
@@ -159,7 +158,6 @@ Endpoints
         "min_count": 0,
         "max_count": 10,
         "position": 1,
-        "multi_allowed": false,
         "price_included": true
       }
 
@@ -208,7 +206,6 @@ Endpoints
         "min_count": 0,
         "max_count": 10,
         "position": 1,
-        "multi_allowed": false,
         "price_included": true
       }
 

doc/api/resources/item_bundles.rst

@@ -30,6 +30,10 @@ designated_price                      money (string)             Designated pric
                                                                  taxation. This is not added to the price.
 ===================================== ========================== =======================================================
 
+.. versionchanged:: 2.6
+
+   This resource has been added.
+
 Endpoints
 ---------
 
@@ -130,7 +134,7 @@ Endpoints
       POST /api/v1/organizers/(organizer)/events/(event)/items/(item)/bundles/ HTTP/1.1
       Host: pretix.eu
       Accept: application/json, text/javascript
-      Content-Type: application/json
+      Content: application/json
 
       {
         "bundled_item": 3,

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_program_times.rst

@@ -1,223 +0,0 @@
-Item program times
-==================
-
-Resource description
---------------------
-
-Program times for products (items) that can be set in addition to event times, e.g. to display seperate schedules within an event.
-Note that ``program_times`` are not available for items inside event series.
-The program times resource contains the following public fields:
-
-.. rst-class:: rest-resource-table
-
-===================================== ========================== =======================================================
-Field                                 Type                       Description
-===================================== ========================== =======================================================
-id                                    integer                    Internal ID of the program time
-start                                 datetime                   The start date time for this program time slot.
-end                                   datetime                   The end date time for this program time slot.
-===================================== ========================== =======================================================
-
-.. versionchanged:: TODO
-
-   The resource has been added.
-
-
-Endpoints
----------
-
-.. http:get:: /api/v1/organizers/(organizer)/events/(event)/items/(item)/program_times/
-
-   Returns a list of all program times for a given item.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      GET /api/v1/organizers/bigevents/events/sampleconf/items/11/program_times/ 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": 3,
-      "next": null,
-      "previous": null,
-      "results": [
-         {
-            "id": 2,
-            "start": "2025-08-14T22:00:00Z",
-            "end": "2025-08-15T00:00:00Z"
-         },
-         {
-            "id": 3,
-            "start": "2025-08-12T22:00:00Z",
-            "end": "2025-08-13T22:00:00Z"
-         },
-         {
-            "id": 14,
-            "start": "2025-08-15T22:00:00Z",
-            "end": "2025-08-17T22:00:00Z"
-         }
-      ]
-   }
-
-   :param organizer: The ``slug`` field of the organizer to fetch
-   :param event: The ``slug`` field of the event to fetch
-   :param item: The ``id`` field of the item to fetch
-   :statuscode 200: no error
-   :statuscode 401: Authentication failure
-   :statuscode 403: The requested organizer/event/item does not exist **or** you have no permission to view this resource.
-
-.. http:get:: /api/v1/organizers/(organizer)/events/(event)/items/(item)/program_times/(id)/
-
-   Returns information on one program time, identified by its ID.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      GET /api/v1/organizers/bigevents/events/sampleconf/items/1/program_times/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,
-         "start": "2025-08-15T22:00:00Z",
-         "end": "2025-10-27T23:00:00Z"
-      }
-
-   :param organizer: The ``slug`` field of the organizer to fetch
-   :param event: The ``slug`` field of the event to fetch
-   :param item: The ``id`` field of the item to fetch
-   :param id: The ``id`` field of the program time 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)/items/(item)/program_times/
-
-   Creates a new program time
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      POST /api/v1/organizers/bigevents/events/sampleconf/items/1/program_times/ HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-      Content-Type: application/json
-
-      {
-        "start": "2025-08-15T10:00:00Z",
-        "end": "2025-08-15T22:00:00Z"
-      }
-
-   **Example response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 201 Created
-      Vary: Accept
-      Content-Type: application/json
-
-      {
-        "id": 17,
-        "start": "2025-08-15T10:00:00Z",
-        "end": "2025-08-15T22:00:00Z"
-      }
-
-   :param organizer: The ``slug`` field of the organizer of the event/item to create a program time for
-   :param event: The ``slug`` field of the event to create a program time for
-   :param item: The ``id`` field of the item to create a program time for
-   :statuscode 201: no error
-   :statuscode 400: The program time 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)/items/(item)/program_times/(id)/
-
-   Update a program time. 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/items/1/program_times/1/ HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-      Content-Type: application/json
-      Content-Length: 94
-
-      {
-        "start": "2025-08-14T10:00:00Z"
-      }
-
-   **Example response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 200 OK
-      Vary: Accept
-      Content-Type: application/json
-
-      {
-        "id": 1,
-        "start": "2025-08-14T10:00:00Z",
-        "end": "2025-08-15T12:00:00Z"
-      }
-
-   :param organizer: The ``slug`` field of the organizer to modify
-   :param event: The ``slug`` field of the event to modify
-   :param id: The ``id`` field of the item to modify
-   :param id: The ``id`` field of the program time to modify
-   :statuscode 200: no error
-   :statuscode 400: The program time 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)/items/(id)/program_times/(id)/
-
-   Delete a program time.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      DELETE /api/v1/organizers/bigevents/events/sampleconf/items/1/program_times/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 item to modify
-   :param id: The ``id`` field of the program time 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/item_variations.rst

@@ -18,57 +18,15 @@ 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.
+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.
-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``
-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.
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 2023.10
-
-   The ``free_price_suggestion`` attribute has been added.
-   The ``checkin_text`` attribute has been added.
+.. versionchanged:: 1.12
 
+   This resource has been added.
 
 Endpoints
 ---------
@@ -104,29 +62,12 @@ 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"
             },
             "position": 0,
             "default_price": "223.00",
-            "price": 223.0,
-            "original_price": null,
-            "free_price_suggestion": null,
-            "meta_data": {}
+            "price": 223.0
           },
           {
             "id": 3,
@@ -134,33 +75,15 @@ 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
@@ -197,26 +120,9 @@ 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
@@ -238,28 +144,14 @@ Endpoints
       POST /api/v1/organizers/bigevents/events/sampleconf/items/1/variations/ HTTP/1.1
       Host: pretix.eu
       Accept: application/json, text/javascript
-      Content-Type: application/json
+      Content: application/json
 
       {
         "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"],
-        "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**:
@@ -275,26 +167,9 @@ Endpoints
         "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_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
@@ -341,26 +216,9 @@ Endpoints
         "value": {"en": "Student"},
         "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,227 +11,129 @@ 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.
-program_times                           list of objects            A list with one object for each program time of this item.
-                                                                   Can be empty. Only writable during creation,
-                                                                   use separate endpoint to modify this later.
-                                                                   Not available for items in event series.
-├ 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.
+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                               string                     A product picture to be displayed in the shop
+                                                                 (read-only, 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``).
+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.
+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.
+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``.
+├ 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
+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
+└ 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.
+===================================== ========================== =======================================================
 
-.. versionchanged:: 2023.10
+.. versionchanged:: 1.7
 
-   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.
+   The attribute ``tax_rule`` has been added. ``tax_rate`` is kept for compatibility. The attribute
+   ``checkin_attention`` has been added.
 
-.. versionchanged:: 2023.10
+.. versionchanged:: 1.12
 
-   The ``hidden_if_item_available`` attributes has been added, the ``hidden_if_available`` attribute has been
-   deprecated.
+   The write operations ``POST``, ``PATCH``, ``PUT``, and ``DELETE`` have been added.
+   The attribute ``price_included`` has been added to ``addons``.
 
-.. versionchanged:: 2025.01
+.. versionchanged:: 1.16
 
-   The ``hidden_if_item_available_mode`` attributes has been added.
+   The ``internal_name`` and ``original_price`` fields have been added.
 
-.. versionchanged:: 2025.9
+.. versionchanged:: 2.0
 
-   The ``program_times`` attribute has been added.
+   The field ``require_approval`` has been added.
+
+.. versionchanged:: 2.3
+
+   The ``sales_channels`` attribute has been added.
+
+.. versionchanged:: 2.4
+
+   The ``generate_tickets`` attribute has been added.
+
+.. versionchanged:: 2.6
+
+   The ``bundles`` and ``require_bundling`` attributes have been added.
 
 Notes
 -----
@@ -240,11 +142,9 @@ Please note that an item either always has variations or never has. Once created
 change to an item without and vice versa. To create an item with variations ensure that you POST an item with at least
 one variation.
 
-Also note that ``variations``, ``bundles``, ``addons`` and  ``program_times`` are only supported on ``POST``. To update/delete variations,
-bundles, add-ons and program times please use the dedicated nested endpoints. By design this endpoint does not support ``PATCH`` and ``PUT``
-with nested ``variations``, ``bundles``, ``addons`` and/or ``program_times``.
-
-``program_times`` is not available to items in event series.
+Also note that ``variations``, ``bundles``, and  ``addons`` are only supported on ``POST``. To update/delete variations,
+bundles, and add-ons please use the dedicated nested endpoints. By design this endpoint does not support ``PATCH`` and ``PUT``
+with nested ``variations``, ``bundles`` and/or ``addons``.
 
 Endpoints
 ---------
@@ -278,8 +178,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,
@@ -287,110 +185,48 @@ 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,
-            "show_quota_left": null,
             "require_approval": false,
             "require_bundling": false,
-            "require_membership": false,
-            "require_membership_types": [],
-            "grant_membership_type": null,
-            "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
               },
               {
                  "value": {"en": "Regular"},
                  "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
               }
             ],
             "addons": [],
-            "bundles": [],
-            "program_times": []
+            "bundles": []
           }
         ]
       }
 
    :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.
@@ -431,8 +267,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,
@@ -440,104 +274,43 @@ 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,
         "generate_tickets": null,
-        "allow_waitinglist": true,
-        "show_quota_left": null,
         "min_per_order": null,
         "max_per_order": null,
         "checkin_attention": false,
-        "checkin_text": null,
         "has_variations": false,
         "require_approval": false,
         "require_bundling": false,
-        "require_membership": false,
-        "require_membership_types": [],
-        "grant_membership_type": null,
-        "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
           },
           {
              "value": {"en": "Regular"},
              "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
           }
         ],
         "addons": [],
-        "bundles": [],
-        "program_times": []
+        "bundles": []
       }
 
    :param organizer: The ``slug`` field of the organizer to fetch
@@ -558,120 +331,55 @@ Endpoints
       POST /api/v1/organizers/bigevents/events/sampleconf/items/ HTTP/1.1
       Host: pretix.eu
       Accept: application/json, text/javascript
-      Content-Type: application/json
+      Content: application/json
 
       {
         "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,
         "generate_tickets": null,
-        "allow_waitinglist": true,
-        "show_quota_left": null,
         "min_per_order": null,
         "max_per_order": null,
         "checkin_attention": false,
-        "checkin_text": null,
         "require_approval": false,
         "require_bundling": false,
-        "require_membership": false,
-        "require_membership_types": [],
-        "grant_membership_type": null,
-        "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"],
-             "available_from": null,
-             "available_from_mode": "hide",
-             "available_until": null,
-             "available_until_mode": "hide",
-             "hide_without_voucher": false,
              "description": null,
-             "meta_data": {},
              "position": 0
           },
           {
              "value": {"en": "Regular"},
              "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"],
-             "available_from": null,
-             "available_from_mode": "hide",
-             "available_until": null,
-             "available_until_mode": "hide",
-             "hide_without_voucher": false,
              "description": null,
-             "meta_data": {},
              "position": 1
           }
         ],
         "addons": [],
-        "bundles": [],
-        "program_times": [
-          {
-            "start": "2025-08-14T22:00:00Z",
-            "end": "2025-08-15T00:00:00Z"
-          }
-        ]
+        "bundles": []
       }
 
    **Example response**:
@@ -686,8 +394,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,
@@ -695,109 +401,43 @@ 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,
         "generate_tickets": null,
-        "allow_waitinglist": true,
-        "show_quota_left": null,
         "checkin_attention": false,
-        "checkin_text": null,
         "has_variations": true,
         "require_approval": false,
         "require_bundling": false,
-        "require_membership": false,
-        "require_membership_types": [],
-        "grant_membership_type": null,
-        "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
           },
           {
              "value": {"en": "Regular"},
              "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
           }
         ],
         "addons": [],
-        "bundles": [],
-        "program_times": [
-          {
-            "start": "2025-08-14T22:00:00Z",
-            "end": "2025-08-15T00:00:00Z"
-          }
-        ]
+        "bundles": []
       }
 
    :param organizer: The ``slug`` field of the organizer of the event to create an item for
@@ -813,9 +453,8 @@ Endpoints
    the resource, other fields will be reset to default. With ``PATCH``, you only need to provide the fields that you
    want to change.
 
-   You can change all fields of the resource except the ``has_variations``, ``variations``, ``addon`` and the
-   ``program_times`` field. If you need to update/delete variations, add-ons or program times, please use the nested
-   dedicated endpoints.
+   You can change all fields of the resource except the ``has_variations``, ``variations`` and the ``addon`` field. If
+   you need to update/delete variations or add-ons please use the nested dedicated endpoints.
 
    **Example request**:
 
@@ -844,8 +483,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,
@@ -853,104 +490,43 @@ 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,
-        "allow_waitinglist": true,
-        "show_quota_left": null,
         "allow_cancel": true,
         "min_per_order": null,
         "max_per_order": null,
         "checkin_attention": false,
-        "checkin_text": null,
         "has_variations": true,
         "require_approval": false,
         "require_bundling": false,
-        "require_membership": false,
-        "require_membership_types": [],
-        "grant_membership_type": null,
-        "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
           },
           {
              "value": {"en": "Regular"},
              "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
           }
         ],
         "addons": [],
-        "bundles": [],
-        "program_times": []
+        "bundles": []
       }
 
    :param organizer: The ``slug`` field of the organizer to modify

doc/api/resources/memberships.rst

@@ -1,216 +0,0 @@
-Memberships
-===========
-
-Resource description
---------------------
-
-The membership resource contains the following public fields:
-
-.. rst-class:: rest-resource-table
-
-===================================== ========================== =======================================================
-Field                                 Type                       Description
-===================================== ========================== =======================================================
-id                                    integer                    Internal ID of the membership
-customer                              string                     Identifier of the customer associated with this membership (can't be changed)
-testmode                              boolean                    Whether this is a test membership
-membership_type                       integer                    Internal ID of the membership type
-date_start                            datetime                   Start of validity
-date_end                              datetime                   End of validity
-attendee_name_parts                   object                     JSON representation of components of an attendee name (configuration dependent)
-===================================== ========================== =======================================================
-
-Endpoints
----------
-
-.. http:get:: /api/v1/organizers/(organizer)/memberships/
-
-   Returns a list of all memberships within a given organizer.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      GET /api/v1/organizers/bigevents/memberships/ 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": 2,
-            "customer": "EGR9SYT",
-            "membership_type": 1,
-            "testmode": false,
-            "date_start": "2021-04-19T00:00:00+02:00",
-            "date_end": "2021-04-20T00:00:00+02:00",
-            "attendee_name_parts": {
-                "_scheme": "title_given_family",
-                "family_name": "Doe",
-                "given_name": "John",
-                "title": ""
-            }
-          }
-        ]
-      }
-
-   :query integer page: The page number in case of a multi-page result set, default is 1
-   :query string customer: A customer identifier to filter for
-   :query integer membership_type: A membership type ID to filter for
-   :query boolean testmode: Filter for memberships that are (not) in test mode.
-   :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)/memberships/(id)/
-
-   Returns information on one membership, identified by its ID.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      GET /api/v1/organizers/bigevents/memberships/2/ 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": 2,
-        "customer": "EGR9SYT",
-        "membership_type": 1,
-        "testmode": false,
-        "date_start": "2021-04-19T00:00:00+02:00",
-        "date_end": "2021-04-20T00:00:00+02:00",
-        "attendee_name_parts": {
-            "_scheme": "title_given_family",
-            "family_name": "Doe",
-            "given_name": "John",
-            "title": ""
-        }
-      }
-
-   :param organizer: The ``slug`` field of the organizer to fetch
-   :param id: The ``id`` field of the membership 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)/memberships/
-
-   Creates a new membership
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      POST /api/v1/organizers/bigevents/memberships/ HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-      Content-Type: application/json
-
-      {
-        "membership_type": 2,
-        "customer": "EGR9SYT",
-        "testmode": false,
-        "date_start": "2021-04-19T00:00:00+02:00",
-        "date_end": "2021-04-20T00:00:00+02:00",
-        "attendee_name_parts": {
-            "_scheme": "title_given_family",
-            "family_name": "Doe",
-            "given_name": "John",
-            "title": ""
-        }
-      }
-
-   **Example response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 201 Created
-      Vary: Accept
-      Content-Type: application/json
-
-      {
-        "id": 3,
-        "membership_type": 2,
-        "customer": "EGR9SYT",
-        "testmode": false,
-        "date_start": "2021-04-19T00:00:00+02:00",
-        "date_end": "2021-04-20T00:00:00+02:00",
-        "attendee_name_parts": {
-            "_scheme": "title_given_family",
-            "family_name": "Doe",
-            "given_name": "John",
-            "title": ""
-        }
-      }
-
-   :param organizer: The ``slug`` field of the organizer to create a membership for
-   :statuscode 201: no error
-   :statuscode 400: The membership 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)/memberships/(id)/
-
-   Update a membership. 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``, ``customer``, and ``testmode`` fields.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      PATCH /api/v1/organizers/bigevents/memberships/1/ HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-      Content-Type: application/json
-      Content-Length: 94
-
-      {
-        "membership_type": 3
-      }
-
-   **Example response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 200 OK
-      Vary: Accept
-      Content-Type: application/json
-
-      {
-        "id": 1,
-        "membership_type": 3,
-        …
-      }
-
-   :param organizer: The ``slug`` field of the organizer to modify
-   :param id: The ``id`` field of the membership to modify
-   :statuscode 200: no error
-   :statuscode 400: The membership 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/membershiptypes.rst

@@ -1,227 +0,0 @@
-Membership types
-================
-
-Resource description
---------------------
-
-The membership type resource contains the following public fields:
-
-.. rst-class:: rest-resource-table
-
-===================================== ========================== =======================================================
-Field                                 Type                       Description
-===================================== ========================== =======================================================
-id                                    integer                    Internal ID of the membership type
-name                                  multi-lingual string       Human-readable name of the type
-transferable                          boolean                    Whether a membership of this type can be used by
-                                                                 multiple persons
-allow_parallel_usage                  boolean                    Whether a membership of this type can be used for
-                                                                 multiple parallel tickets
-max_usages                            integer                    Maximum number of times a membership of this type can be
-                                                                 used.
-===================================== ========================== =======================================================
-
-Endpoints
----------
-
-.. http:get:: /api/v1/organizers/(organizer)/membershiptypes/
-
-   Returns a list of all membership types within a given organizer.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      GET /api/v1/organizers/bigevents/membershiptypes/ 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": 2,
-            "name": {
-              "de": "Wochenkarte",
-              "en": "Week pass"
-            },
-            "transferable": false,
-            "allow_parallel_usage": false,
-            "max_usages": 7
-          }
-        ]
-      }
-
-   :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)/membershiptypes/(id)/
-
-   Returns information on one membership type, identified by its ID.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      GET /api/v1/organizers/bigevents/membershiptypes/1/ HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-
-   **Example response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 200 OK
-      Vary: Accept
-      Content-Type: application/json
-
-      {
-        "id": 1,
-        "name": {
-          "de": "Wochenkarte",
-          "en": "Week pass"
-        },
-        "transferable": false,
-        "allow_parallel_usage": false,
-        "max_usages": 7
-      }
-
-   :param organizer: The ``slug`` field of the organizer to fetch
-   :param id: The ``id`` field of the membership type 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)/membershiptypes/
-
-   Creates a new membership type
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      POST /api/v1/organizers/bigevents/membershiptypes/ HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-      Content-Type: application/json
-
-      {
-        "name": {
-          "de": "Wochenkarte",
-          "en": "Week pass"
-        },
-        "transferable": false,
-        "allow_parallel_usage": false,
-        "max_usages": 7
-      }
-
-   **Example response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 201 Created
-      Vary: Accept
-      Content-Type: application/json
-
-      {
-        "id": 3,
-        "name": {
-          "de": "Wochenkarte",
-          "en": "Week pass"
-        },
-        "transferable": false,
-        "allow_parallel_usage": false,
-        "max_usages": 7
-      }
-
-   :param organizer: The ``slug`` field of the organizer to create a membership type for
-   :statuscode 201: no error
-   :statuscode 400: The membership type 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)/membershiptypes/(id)/
-
-   Update a membership type. 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/membershiptypes/2/ HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-      Content-Type: application/json
-      Content-Length: 94
-
-      {
-        "max_usages": 3
-      }
-
-   **Example response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 200 OK
-      Vary: Accept
-      Content-Type: application/json
-
-      {
-        "id": 2,
-        "name": {
-          "de": "Wochenkarte",
-          "en": "Week pass"
-        },
-        "transferable": false,
-        "allow_parallel_usage": false,
-        "max_usages": 3
-      }
-
-   :param organizer: The ``slug`` field of the organizer to modify
-   :param id: The ``id`` field of the membership type to modify
-   :statuscode 200: no error
-   :statuscode 400: The membership 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)/membershiptypes/(id)/
-
-   Delete a membership type. You can not delete types which have already been used.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      DELETE /api/v1/organizers/bigevents/membershiptype/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 type 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 membership type is currently in use.

doc/api/resources/offlinesales.rst

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

doc/api/resources/organizers.rst

@@ -17,13 +17,6 @@ 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).
-plugins                               list                       A list of package names of the enabled plugins for this
-                                                                 organizer. Note that most plugins are enabled on the
-                                                                 event level (or both levels). If you remove a plugin
-                                                                 that is also enabled on some events, it will
-                                                                 automatically be removed from all events as well.
 ===================================== ========================== =======================================================
 
 
@@ -58,17 +51,11 @@ Endpoints
           {
             "name": "Big Events LLC",
             "slug": "Big Events",
-            "public_url": "https://pretix.eu/bigevents/",
-            "plugins": [
-              "pretix_datev"
-            ]
           }
         ]
       }
 
    :query 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 ``slug`` and
-                           ``name``. Default: ``slug``.
    :statuscode 200: no error
    :statuscode 401: Authentication failure
 
@@ -95,171 +82,9 @@ Endpoints
       {
         "name": "Big Events LLC",
         "slug": "Big Events",
-        "public_url": "https://pretix.eu/bigevents/",
-        "plugins": [
-          "pretix_datev"
-        ]
       }
 
    :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 it.
-
-.. http:patch:: /api/v1/organizers/(organizer)/
-
-   Updates an organizer. Currently only the ``plugins`` field may be updated.
-
-   Permission required: "Can change organizer settings"
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      PATCH /api/v1/organizers/bigevents/ HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-      Content-Type: application/json
-
-      {
-        "plugins": [
-          "pretix_seating"
-        ]
-      }
-
-   **Example response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 200 OK
-      Vary: Accept
-      Content-Type: application/json
-
-      {
-        "name": "Big Events LLC",
-        "slug": "Big Events",
-        "public_url": "https://pretix.eu/bigevents/",
-        "plugins": [
-          "pretix_seating"
-        ]
-      }
-
-   :param organizer: The ``slug`` field of the organizer to update
-   :statuscode 200: no error
-   :statuscode 400: The organizer could not be updated due to invalid submitted data.
-   :statuscode 401: Authentication failure
-   :statuscode 403: The requested organizer does not exist **or** you have no permission to update this resource.
-
-Organizer settings
-------------------
-
-pretix organizers and events have lots and lots of parameters of different types that are stored in a key-value store on our system.
-Since many of these settings depend on each other in complex ways, we can not give direct access to all of these
-settings through the API. However, we do expose many of the simple and useful flags through the API.
-
-Please note that the available settings flags change between pretix versions, and we do not give a guarantee on backwards-compatibility like with other parts of the API.
-Therefore, we're also not including a list of the options here, but instead recommend to look at the endpoint output
-to see available options. The ``explain=true`` flag enables a verbose mode that provides you with human-readable
-information about the properties.
-
-.. note:: Please note that this is not a complete representation of all organizer 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 shops using this API by creating situations of conflicting settings. Please take care.
-
-.. http:get:: /api/v1/organizers/(organizer)/settings/
-
-   Get current values of organizer settings.
-
-   Permission required: "Can change organizer settings"
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      GET /api/v1/organizers/bigevents/settings/ HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-
-   **Example standard response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 200 OK
-      Vary: Accept
-      Content-Type: application/json
-
-      {
-        "event_list_type": "calendar",
-        …
-      }
-
-   **Example verbose response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 200 OK
-      Vary: Accept
-      Content-Type: application/json
-
-      {
-        "event_list_type":
-          {
-            "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."
-          }
-        },
-        …
-      }
-
-   :param organizer: The ``slug`` field of the organizer to access
-   :query explain: Set to ``true`` to enable verbose response mode
-   :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:patch:: /api/v1/organizers/(organizer)/settings/
-
-   Updates organizer settings. Note that ``PUT`` is not allowed here, only ``PATCH``.
-
-    .. warning::
-
-       Settings can be stored at different levels in pretix. If a value is not set on organizer level, a default setting
-       from a higher level (global) will be returned. If you explicitly set a setting on organizer level, it
-       will no longer be inherited from the higher levels. Therefore, we recommend you to send only settings that you
-       explicitly want to set on organizer level. To unset a settings, pass ``null``.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      PATCH /api/v1/organizers/bigevents/settings/ HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-      Content-Type: application/json
-
-      {
-        "event_list_type": "calendar"
-      }
-
-   **Example response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 200 OK
-      Vary: Accept
-      Content-Type: application/json
-
-      {
-        "event_list_type": "calendar",
-        …
-      }
-
-   :param organizer: The ``slug`` field of the organizer to update
-   :statuscode 200: no error
-   :statuscode 400: The organizer could not be updated due to invalid submitted data.
-   :statuscode 401: Authentication failure
-   :statuscode 403: The requested organizer does not exist **or** you have no permission to create this resource.

doc/api/resources/question_options.rst

@@ -19,6 +19,10 @@ identifier                            string                     An arbitrary st
 answer                                multi-lingual string       The displayed value of this option
 ===================================== ========================== =======================================================
 
+.. versionchanged:: 1.12
+
+   This resource has been added.
+
 Endpoints
 ---------
 

doc/api/resources/questions.rst

@@ -1,7 +1,4 @@
-.. spelling:word-list::
-
-   checkin
-   datetime
+.. spelling:: checkin
 
 .. _rest-questions:
 
@@ -21,7 +18,6 @@ Field                                 Type                       Description
 ===================================== ========================== =======================================================
 id                                    integer                    Internal ID of the question
 question                              multi-lingual string       The field label shown to the customer
-help_text                             multi-lingual string       The help text shown to the customer
 type                                  string                     The expected type of answer. Valid options:
 
                                                                  * ``N`` – number
@@ -34,22 +30,14 @@ type                                  string                     The expected ty
                                                                  * ``D`` – date
                                                                  * ``H`` – time
                                                                  * ``W`` – date and time
-                                                                 * ``CC`` – country code (ISO 3666-1 alpha-2)
-                                                                 * ``TEL`` – telephone number
-required                              boolean                    If ``true``, the question needs to be filled out.
+required                              boolean                    If ``True``, the question needs to be filled out.
 position                              integer                    An integer, used for sorting
 items                                 list of integers           List of item IDs this question is assigned to.
 identifier                            string                     An arbitrary string that can be used for matching with
                                                                  other sources.
-ask_during_checkin                    boolean                    If ``true``, this question will not be asked while
+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
-                                                                 invoices.
 options                               list of objects            In case of question type ``C`` or ``M``, this lists the
                                                                  available objects. Only writable during creation,
                                                                  use separate endpoint to modify this later.
@@ -58,34 +46,36 @@ options                               list of objects            In case of ques
 ├ identifier                          string                     An arbitrary string that can be used for matching with
                                                                  other sources.
 └ answer                              multi-lingual string       The displayed value of this option
-valid_number_min                      string                     Minimum value for number questions (optional)
-valid_number_max                      string                     Maximum value for number questions (optional)
-valid_date_min                        date                       Minimum value for date questions (optional)
-valid_date_max                        date                       Maximum value for date questions (optional)
-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
                                                                  ``dependency_value``. This cannot be combined with
                                                                  ``ask_during_checkin``.
-dependency_values                     list of strings            If ``dependency_question`` is set to a boolean
-                                                                 question, this should be ``["True"]`` or ``["False"]``.
-                                                                 Otherwise, it should be a list of ``identifier`` values
-                                                                 of question options.
-dependency_value                      string                     An old version of ``dependency_values`` that only allows
-                                                                 for one value. **Deprecated.**
+dependency_value                      string                     The value ``dependency_question`` needs to be set to.
+                                                                 If ``dependency_question`` is set to a boolean
+                                                                 question, this should be ``"True"`` or ``"False"``.
+                                                                 Otherwise, it should be the ``identifier`` of a
+                                                                 question option.
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 2023.8
+.. versionchanged:: 1.12
 
-   The ``show_during_checkin`` attribute has been added.
+  The values ``D``, ``H``, and ``W`` for the field ``type`` are now allowed and the ``ask_during_checkin`` field has
+  been added.
+
+.. versionchanged:: 1.14
+
+  Write methods have been added. The attribute ``identifier`` has been added to both the resource itself and the
+  options resource. The ``position`` attribute has been added to the options resource.
 
 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.
@@ -114,27 +104,14 @@ Endpoints
           {
             "id": 1,
             "question": {"en": "T-Shirt size"},
-            "help_text": {"en": "Choose your preferred t-shirt-size"},
             "type": "C",
             "required": false,
             "items": [1, 2],
             "position": 1,
             "identifier": "WY3TP9SL",
             "ask_during_checkin": false,
-            "show_during_checkin": false,
-            "hidden": false,
-            "print_on_invoice": false,
-            "valid_number_min": null,
-            "valid_number_max": null,
-            "valid_date_min": null,
-            "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,
-            "dependency_values": [],
             "options": [
               {
                 "id": 1,
@@ -194,27 +171,14 @@ Endpoints
       {
         "id": 1,
         "question": {"en": "T-Shirt size"},
-        "help_text": {"en": "Choose your preferred t-shirt-size"},
         "type": "C",
         "required": false,
         "items": [1, 2],
         "position": 1,
         "identifier": "WY3TP9SL",
         "ask_during_checkin": false,
-        "show_during_checkin": false,
-        "hidden": false,
-        "print_on_invoice": false,
-        "valid_number_min": null,
-        "valid_number_max": null,
-        "valid_date_min": null,
-        "valid_date_max": null,
-        "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": [],
         "options": [
           {
             "id": 1,
@@ -255,21 +219,17 @@ Endpoints
       POST /api/v1/organizers/bigevents/events/sampleconf/questions/ HTTP/1.1
       Host: pretix.eu
       Accept: application/json, text/javascript
-      Content-Type: application/json
+      Content: application/json
 
       {
         "question": {"en": "T-Shirt size"},
-        "help_text": {"en": "Choose your preferred t-shirt-size"},
         "type": "C",
         "required": false,
         "items": [1, 2],
         "position": 1,
         "ask_during_checkin": false,
-        "show_during_checkin": false,
-        "hidden": false,
-        "print_on_invoice": false,
         "dependency_question": null,
-        "dependency_values": [],
+        "dependency_value": null,
         "options": [
           {
             "answer": {"en": "S"}
@@ -295,27 +255,14 @@ Endpoints
       {
         "id": 1,
         "question": {"en": "T-Shirt size"},
-        "help_text": {"en": "Choose your preferred t-shirt-size"},
         "type": "C",
         "required": false,
         "items": [1, 2],
         "position": 1,
         "identifier": "WY3TP9SL",
         "ask_during_checkin": false,
-        "show_during_checkin": false,
-        "hidden": false,
-        "print_on_invoice": false,
         "dependency_question": null,
         "dependency_value": null,
-        "dependency_values": [],
-        "valid_number_min": null,
-        "valid_number_max": null,
-        "valid_date_min": null,
-        "valid_date_max": null,
-        "valid_datetime_min": null,
-        "valid_datetime_max": null,
-        "valid_file_portrait": false,
-        "valid_string_length_max": null,
         "options": [
           {
             "id": 1,
@@ -358,7 +305,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
@@ -379,27 +326,14 @@ Endpoints
       {
         "id": 1,
         "question": {"en": "T-Shirt size"},
-        "help_text": {"en": "Choose your preferred t-shirt-size"},
         "type": "C",
         "required": false,
         "items": [1, 2],
         "position": 2,
         "identifier": "WY3TP9SL",
         "ask_during_checkin": false,
-        "show_during_checkin": false,
-        "hidden": false,
-        "print_on_invoice": false,
         "dependency_question": null,
         "dependency_value": null,
-        "dependency_values": [],
-        "valid_number_min": null,
-        "valid_number_max": null,
-        "valid_date_min": null,
-        "valid_date_max": null,
-        "valid_datetime_min": null,
-        "valid_datetime_max": null,
-        "valid_file_portrait": false,
-        "valid_string_length_max": null,
         "options": [
           {
             "id": 1,
@@ -426,7 +360,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 +372,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 +385,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

@@ -20,27 +20,12 @@ size                                  integer                    The size of the
 items                                 list of integers           List of item IDs this quota acts on.
 variations                            list of integers           List of item variation IDs this quota acts on.
 subevent                              integer                    ID of the date inside an event series this quota belongs to (or ``null``).
-close_when_sold_out                   boolean                    If ``true``, the quota will "close" as soon as it is
-                                                                 sold out once. Even if tickets become available again,
-                                                                 they will not be sold unless the quota is set to open
-                                                                 again.
-closed                                boolean                    Whether the quota is currently closed (see above
-                                                                 field).
-release_after_exit                    boolean                    Whether the quota regains capacity as soon as some tickets
-                                                                 have been scanned at an exit.
-ignore_for_event_availability         boolean                    Whether the quota is ignored when calculating the event's
-                                                                 availability of tickets.
-available                             boolean                    Whether this quota is available. Only returned if ``with_availability=true``
-                                                                 is set on the request. Do not rely on this value for critical operations, it may be
-                                                                 slightly out of date.
-available_number                      integer                    Number of available tickets. Only returned if ``with_availability=true``
-                                                                 is set on the request. Do not rely on this value for critical operations, it may be
-                                                                 slightly out of date. ``null`` means unlimited.
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 2025.7
+.. versionchanged:: 1.10
+
+   The write operations ``POST``, ``PATCH``, ``PUT``, and ``DELETE`` have been added.
 
-    The attribute ``ignore_for_event_availability`` has been added.
 
 Endpoints
 ---------
@@ -76,10 +61,7 @@ Endpoints
             "size": 200,
             "items": [1, 2],
             "variations": [1, 4, 5, 7],
-            "subevent": null,
-            "close_when_sold_out": false,
-            "closed": false,
-            "ignore_for_event_availability": false
+            "subevent": null
           }
         ]
       }
@@ -87,10 +69,7 @@ Endpoints
    :query integer page: The page number in case of a multi-page result set, default is 1
    :query string ordering: Manually set the ordering of results. Valid fields to be used are ``id`` and ``position``.
                            Default: ``position``
-   :query integer subevent: Only return quotas of the sub-event with the given ID.
-   :query integer subevent__in: Only return quotas of sub-events with one of the given IDs (comma-separated).
-   :query integer items__in: Only return quotas that include a product with one of the given IDs (comma-separated).
-   :query string with_availability: Set to ``true`` to get availability information. Can lead to increased answer times.
+   :query integer subevent: Only return quotas of the sub-event with the given 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
@@ -123,16 +102,12 @@ Endpoints
         "size": 200,
         "items": [1, 2],
         "variations": [1, 4, 5, 7],
-        "subevent": null,
-        "close_when_sold_out": false,
-        "closed": false,
-        "ignore_for_event_availability": false
+        "subevent": null
       }
 
    :param organizer: The ``slug`` field of the organizer to fetch
    :param event: The ``slug`` field of the event to fetch
    :param id: The ``id`` field of the quota to fetch
-   :query string with_availability: Set to ``true`` to get availability information. Can lead to increased answer times.
    :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.
@@ -148,17 +123,14 @@ Endpoints
       POST /api/v1/organizers/bigevents/events/sampleconf/quotas/ HTTP/1.1
       Host: pretix.eu
       Accept: application/json, text/javascript
-      Content-Type: application/json
+      Content: application/json
 
       {
         "name": "Ticket Quota",
         "size": 200,
         "items": [1, 2],
         "variations": [1, 4, 5, 7],
-        "subevent": null,
-        "close_when_sold_out": false,
-        "closed": false,
-        "ignore_for_event_availability": false
+        "subevent": null
       }
 
    **Example response**:
@@ -175,10 +147,7 @@ Endpoints
         "size": 200,
         "items": [1, 2],
         "variations": [1, 4, 5, 7],
-        "subevent": null,
-        "close_when_sold_out": false,
-        "closed": false,
-        "ignore_for_event_availability": false
+        "subevent": null
       }
 
    :param organizer: The ``slug`` field of the organizer of the event/item to create a quota for
@@ -231,10 +200,7 @@ Endpoints
           1,
           2
         ],
-        "subevent": null,
-        "close_when_sold_out": false,
-        "closed": false,
-        "ignore_for_event_availability": false
+        "subevent": null
       }
 
    :param organizer: The ``slug`` field of the organizer to modify
@@ -297,7 +263,6 @@ Endpoints
         "total_size": 1000,
         "pending_orders": 25,
         "paid_orders": 423,
-        "exited_orders": 0,
         "cart_positions": 7,
         "blocking_vouchers": 126,
         "waiting_list": 0

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/seatingplans.rst

@@ -1,205 +0,0 @@
-.. _`rest-seatingplans`:
-
-Seating plans
-=============
-
-Resource description
---------------------
-
-The seating plan resource contains the following public fields:
-
-.. rst-class:: rest-resource-table
-
-===================================== ========================== =======================================================
-Field                                 Type                       Description
-===================================== ========================== =======================================================
-id                                    integer                    Internal ID of the plan
-name                                  string                     Human-readable name of the plan
-layout                                object                     JSON representation of the seating plan. These
-                                                                 representations follow a JSON schema that currently
-                                                                 still evolves. The version in use can be found `here`_.
-===================================== ========================== =======================================================
-
-Endpoints
----------
-
-.. http:get:: /api/v1/organizers/(organizer)/seatingplans/
-
-   Returns a list of all seating plans within a given organizer.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      GET /api/v1/organizers/bigevents/seatingplans/ 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": 2,
-            "name": "Main plan",
-            "layout": { … }
-          }
-        ]
-      }
-
-   :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)/seatingplans/(id)/
-
-   Returns information on one plan, identified by its ID.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      GET /api/v1/organizers/bigevents/seatingplans/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": 2,
-        "name": "Main plan",
-        "layout": { … }
-      }
-
-   :param organizer: The ``slug`` field of the organizer to fetch
-   :param id: The ``id`` field of the seating plan 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)/seatingplans/
-
-   Creates a new seating plan
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      POST /api/v1/organizers/bigevents/seatingplans/ HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-      Content-Type: application/json
-
-      {
-        "name": "Main plan",
-        "layout": { … }
-      }
-
-   **Example response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 201 Created
-      Vary: Accept
-      Content-Type: application/json
-
-      {
-        "id": 3,
-        "name": "Main plan",
-        "layout": { … }
-      }
-
-   :param organizer: The ``slug`` field of the organizer to create a seating plan for
-   :statuscode 201: no error
-   :statuscode 400: The seating plan 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)/seatingplans/(id)/
-
-   Update a plan. 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. **You can not change a plan while it is in use for
-   any events.**
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      PATCH /api/v1/organizers/bigevents/seatingplans/1/ HTTP/1.1
-      Host: pretix.eu
-      Accept: application/json, text/javascript
-      Content-Type: application/json
-      Content-Length: 94
-
-      {
-        "name": "Old plan"
-      }
-
-   **Example response**:
-
-   .. sourcecode:: http
-
-      HTTP/1.1 200 OK
-      Vary: Accept
-      Content-Type: application/json
-
-      {
-        "id": 1,
-        "name": "Old plan",
-        "layout": { … }
-      }
-
-   :param organizer: The ``slug`` field of the organizer to modify
-   :param id: The ``id`` field of the plan to modify
-   :statuscode 200: no error
-   :statuscode 400: The plan 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 **or** the plan is currently in use.
-
-.. http:delete:: /api/v1/organizers/(organizer)/seatingplans/(id)/
-
-   Delete a plan. You can not delete plans which are currently in use by any events.
-
-   **Example request**:
-
-   .. sourcecode:: http
-
-      DELETE /api/v1/organizers/bigevents/seatingplans/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 plan 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 plan is currently in use.
-
-
-.. _here: https://github.com/pretix/pretix/blob/master/src/pretix/static/seating/seating-plan.schema.json

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.