From 0f7ee1dc3ba06603d0b8f6fb49b18050997aa98d Mon Sep 17 00:00:00 2001
From: Mira Weller <weller@rami.io>
Date: Thu, 26 Jun 2025 17:11:48 +0200
Subject: [PATCH] Add explanation for mapping.id

---
 src/pretix/base/datasync/datasync.py | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/src/pretix/base/datasync/datasync.py b/src/pretix/base/datasync/datasync.py
index 1d2ffd1e6d..298d01a61e 100644
--- a/src/pretix/base/datasync/datasync.py
+++ b/src/pretix/base/datasync/datasync.py
@@ -195,7 +195,8 @@ class OutboundSyncProvider:
 
         :return: The returned objects must have at least the following properties:
 
-                - `id`: Unique identifier
+                - `id`: Unique identifier for this mapping. If the mappings are Django models, the database primary key
+                  should be used. This may be referenced in other mappings, to establish relations between objects.
                 - `pretix_model`: Which pretix model to use as data source in this mapping. Possible values are
                   the keys of ``sourcefields.AVAILABLE_MODELS``
                 - `external_object_type`: Destination object type in the target system. opaque string of maximum 128 characters.