Clear error message from Check-In API

[yaxit24]

Fixes : #809

Summary by Sourcery

Improve error feedback in the Check-In API by surfacing the specific exception message and code in the response.

Bug Fixes:

• Use the actual exception message instead of a generic 'unknown' explanation
• Standardize error responses to return status 'error' with the exception code as 'reason' and the detailed message in 'message'

[sourcery-ai]

Reviewer's Guide

Replace hard-coded error placeholders in the Check-In API _redeem_process response with dynamic error codes and messages derived from the exception.

Sequence diagram for updated error handling in Check-In API

sequenceDiagram
    participant Client
    participant API as Check-In API (_redeem_process)
    participant Exception as Exception (e)

    Client->>API: Redeem check-in request
    API->>Exception: Error occurs (raises e)
    API-->>Client: Response { status: 'error', reason: e.code, message: str(e.msg) }

Loading

Class diagram for updated Check-In API error response

classDiagram
    class _redeem_process {
        +Response()
        -reason_explanation: str  // changed from 'unknown' to str(e.msg)
        -reason: str  // changed from 'Already checked in' to e.code
        -message: str  // new, set to str(e.msg)
    }

Loading

File-Level Changes

Change	Details	Files
Use dynamic error message for reason_explanation	Replaced placeholder 'unkown' with str(e.msg) in reason_explanation	src/pretix/api/views/checkin.py
Standardize error response for redemption failures	Removed static 'redeemed' status and 'Already checked in' reason Set status to 'error' and reason to e.code Added message field with str(e.msg)	src/pretix/api/views/checkin.py

Possibly linked issues

• Clear error message from Check-In API #809: The PR adds clear error messages to the Check-In API, directly addressing the issue of unclear error messages and allowing proper display of check-in errors.

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @yaxit24 - I've reviewed your changes and found some issues that need to be addressed.

Blocking issues:

• There is an unintended space in 'e. code' which may cause a NameError. (link)

Prompt for AI Agents

Please address the comments from this code review:
## Individual Comments

### Comment 1
<location> `src/pretix/api/views/checkin.py:703` </location>
<code_context>
-                    'status': 'redeemed',
-                    'reason': 'Already checked in',
+                    'status': 'error'
+                    'reason': e. code,
+                    'message': str(e.msg),
                     'require_attention': op.require_checkin_attention,
</code_context>

<issue_to_address>
There is an unintended space in 'e. code' which may cause a NameError.

Remove the space so it reads 'e.code' to prevent a NameError at runtime.
</issue_to_address>

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[yaxit24]

Screen.Recording.2025-07-29.at.1.48.15.AM.mov

[Sak1012]

Could you add a screenshot from the badge station page that shows the pop up.

[yaxit24]

thank-you @Sak1012, also chanegs are made in Checkin(issue #36).

Screen.Recording.2025-07-30.at.5.39.10.PM.mov