Orders¶

Order resource¶

The order resource contains the following public fields:

Field	Type	Description
code	string	Order code
event	string	The slug of the parent event
status	string	Order status, one of: `n` – pending `p` – paid `e` – expired `c` – canceled
testmode	boolean	If `true`, this order was created when the event was in test mode. Only orders in test mode can be deleted.
secret	string	The secret contained in the link sent to the customer
email	string	The customer email address
phone	string	The customer phone number
customer	string	The customer account identifier (or `null`)
locale	string	The locale used for communication with this customer
sales_channel	string	Channel this sale was created through, such as `"web"`.
datetime	datetime	Time of order creation
expires	datetime	The order will expire, if it is still pending by this time
payment_date	date	DEPRECATED AND INACCURATE Date of payment receipt
payment_provider	string	DEPRECATED AND INACCURATE Payment provider used for this order
total	money (string)	Total value of this order
comment	string	Internal comment on this order
api_meta	object	Meta data for that order. Only available through API, no guarantees on the content structure. You can use this to save references to your system.
custom_followup_at	date	Internal date for a custom follow-up action
checkin_attention	boolean	If `true`, the check-in app should show a warning that this ticket requires special attention if a ticket of this order is scanned.
checkin_text	string	Text that will be shown if a ticket of this order is scanned (or `null`).
invoice_address	object	Invoice address information (can be `null`)
├ last_modified	datetime	Last modification date of the address
├ company	string	Customer company name
├ is_business	boolean	Business or individual customers (always `false` for orders created before pretix 1.7, do not rely on it).
├ name	string	Customer name
├ name_parts	object of strings	Customer name decomposition
├ street	string	Customer street
├ zipcode	string	Customer ZIP code
├ city	string	Customer city
├ country	string	Customer country code
├ state	string	Customer state (ISO 3166-2 code). Only supported in AU, BR, CA, CN, MY, MX, and US.
├ internal_reference	string	Customer’s internal reference to be printed on the invoice
├ custom_field	string	Custom invoice address field
├ vat_id	string	Customer VAT ID
└ vat_id_validated	string	`true`, if the VAT ID has been validated against the EU VAT service and validation was successful. This only happens in rare cases.
positions	list of objects	List of order positions (see below). By default, only non-canceled positions are included.
fees	list of objects	List of fees included in the order total. By default, only non-canceled fees are included.
├ id	integer	Internal ID of the fee record
├ fee_type	string	Type of fee (currently `payment`, `passbook`, `other`)
├ value	money (string)	Fee amount
├ description	string	Human-readable string with more details (can be empty)
├ internal_type	string	Internal string (i.e. ID of the payment provider), can be empty
├ tax_rate	decimal (string)	VAT rate applied for this fee
├ tax_value	money (string)	VAT included in this fee
├ tax_rule	integer	The ID of the used tax rule (or `null`)
└ canceled	boolean	Whether or not this fee has been canceled.
downloads	list of objects	List of ticket download options for order-wise ticket downloading. This might be a multi-page PDF or a ZIP file of tickets for outputs that do not support multiple tickets natively. See also order position download options.
├ output	string	Ticket output provider (e.g. `pdf`, `passbook`)
└ url	string	Download URL
require_approval	boolean	If `true` and the order is pending, this order needs approval by an organizer before it can continue. If `true` and the order is canceled, this order has been denied by the event organizer.
valid_if_pending	boolean	If `true` and the order is pending, this order is still treated like a paid order for most purposes, such as check-in. This may be used e.g. for trusted customers who only need to pay after the event.
url	string	The full URL to the order confirmation page
payments	list of objects	List of payment processes (see below)
refunds	list of objects	List of refund processes (see below)
last_modified	datetime	Last modification of this object
cancellation_date	datetime	Time of order cancellation (or `null`). Note: Will not be set for partial cancellations and is not reliable for orders that have been cancelled, reactivated and cancelled again.

Changed in version 4.0: The customer attribute has been added.

Changed in version 4.1: The custom_followup_at attribute has been added.

Changed in version 4.4: The item and variation query parameters have been added.

Changed in version 4.6: The subevent query parameters has been added.

Changed in version 4.8: The order.fees.id attribute has been added.

Changed in version 4.15: The include query parameter has been added.

Changed in version 4.16: The valid_if_pending attribute has been added.

Changed in version 2023.8: The event attribute has been added. The organizer-level endpoint has been added.

Changed in version 2023.9: The customer query parameter has been added.

Changed in version 2023.10: The checkin_text attribute has been added.

Changed in version 2024.1: The expires attribute can now be passed during order creation.

Changed in version 2024.11: The cancellation_date attribute has been added and can also be used as an ordering key.

Order position resource¶

Field	Type	Description
id	integer	Internal ID of the order position
order	string	Order code of the order the position belongs to
positionid	integer	Number of the position within the order
canceled	boolean	Whether or not this position has been canceled. Note that by default, only non-canceled positions are shown.
item	integer	ID of the purchased item
variation	integer	ID of the purchased variation (or `null`)
price	money (string)	Price of this position
attendee_name	string	Specified attendee name for this position (or `null`)
attendee_name_parts	object of strings	Decomposition of attendee name (i.e. given name, family name)
attendee_email	string	Specified attendee email address for this position (or `null`)
company	string	Attendee company name (or `null`)
street	string	Attendee street (or `null`)
zipcode	string	Attendee ZIP code (or `null`)
city	string	Attendee city (or `null`)
country	string	Attendee country code (or `null`)
state	string	Attendee state (ISO 3166-2 code). Only supported in AU, BR, CA, CN, MY, MX, and US, otherwise `null`.
voucher	integer	Internal ID of the voucher used for this position (or `null`)
voucher_budget_use	money (string)	Amount of money discounted by the voucher, corresponding to how much of the `budget` of the voucher is consumed. Important: Do not rely on this amount to be a useful value if the position’s price, product or voucher are changed after the order was created. Can be `null`.
tax_rate	decimal (string)	VAT rate applied for this position
tax_value	money (string)	VAT included in this position
tax_rule	integer	The ID of the used tax rule (or `null`)
secret	string	Secret code printed on the tickets for validation
addon_to	integer	Internal ID of the position this position is an add-on for (or `null`)
subevent	integer	ID of the date inside an event series this position belongs to (or `null`).
discount	integer	ID of a discount that has been used during the creation of this position in some way (or `null`).
blocked	list of strings	A list of strings, or `null`. Whenever not `null`, the ticket may not be used (e.g. for check-in).
valid_from	datetime	The ticket will not be valid before this time. Can be `null`.
valid_until	datetime	The ticket will not be valid after this time. Can be `null`.
pseudonymization_id	string	A random ID, e.g. for use in lead scanning apps
checkins	list of objects	List of successful check-ins with this ticket
├ id	integer	Internal ID of the check-in event
├ list	integer	Internal ID of the check-in list
├ datetime	datetime	Time of check-in
├ type	string	Type of scan (defaults to `entry`)
├ gate	integer	Internal ID of the gate. Can be `null`.
├ device	integer	Internal ID of the device. Can be `null`. Deprecated, since this ID is not otherwise used in the API and is therefore not very useful.
├ device_id	integer	Attribute `device_id` of the device. Can be `null`.
└ auto_checked_in	boolean	Indicates if this check-in been performed automatically by the system
print_logs	list of objects	List of print jobs recorded e.g. by the pretix apps
├ id	integer	Internal ID of the print job
├ successful	boolean	Whether the print job successfully resulted in a print. This is not expected to be 100 % reliable information (since printer feedback is never perfect) and there is no guarantee that unsuccessful jobs will be logged.
├ device_id	integer	Attribute `device_id` of the device that recorded the print. Can be `null`.
├ datetime	datetime	Time of printing
├ source	string	Source of print job, e.g. name of the app used.
├ type	string	Type of print (currently `badge`, `ticket`, `certificate`, or `other`)
└ info	object	Additional data with client-dependent structure.
downloads	list of objects	List of ticket download options
├ output	string	Ticket output provider (e.g. `pdf`, `passbook`)
└ url	string	Download URL
answers	list of objects	Answers to user-defined questions
├ question	integer	Internal ID of the answered question
├ answer	string	Text representation of the answer (URL if answer is a file)
├ question_identifier	string	The question’s `identifier` field
├ options	list of integers	Internal IDs of selected option(s)s (only for choice types)
└ option_identifiers	list of strings	The `identifier` fields of the selected option(s)s
seat	objects	The assigned seat. Can be `null`.
├ 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
pdf_data	object	Data object required for ticket PDF generation. By default, this field is missing. It will be added only if you add the `pdf_data=true` query parameter to your request.

Changed in version 4.16: The attributes blocked, valid_from and valid_until have been added.

Changed in version 2024.9: The attribute print_logs has been added.

Order payment resource¶

Field	Type	Description
local_id	integer	Internal ID of this payment, starts at 1 for every order
state	string	Payment state, one of `created`, `pending`, `confirmed`, `canceled`, `pending`, `failed`, or `refunded`
amount	money (string)	Payment amount
created	datetime	Date and time of creation of this payment
payment_date	datetime	Date and time of completion of this payment (or `null`)
provider	string	Identification string of the payment provider
payment_url	string	The URL where an user can continue with the payment (or `null`)
details	object	Payment-specific information. This is a dictionary with various fields that can be different between payment providers, versions, payment states, etc. If you read this field, you always need to be able to deal with situations where values that you expect are missing. Mostly, the field contains various IDs that can be used for matching with other systems. If a payment provider does not implement this feature, the object is empty.

Order refund resource¶

Field	Type	Description
local_id	integer	Internal ID of this payment, starts at 1 for every order
state	string	Payment state, one of `created`, `transit`, `external`, `canceled`, `failed`, or `done`
source	string	How this refund has been created, one of `buyer`, `admin`, or `external`
amount	money (string)	Payment amount
created	datetime	Date and time of creation of this payment
comment	string	Reason for refund (shown to the customer in some cases, can be `null`).
execution_date	datetime	Date and time of completion of this refund (or `null`)
provider	string	Identification string of the payment provider
details	object	Refund-specific information. This is a dictionary with various fields that can be different between payment providers, versions, payment states, etc. If you read this field, you always need to be able to deal with situations where values that you expect are missing. Mostly, the field contains various IDs that can be used for matching with other systems. If a payment provider does not implement this feature, the object is empty.

List of all orders¶

GET /api/v1/organizers/(organizer)/events/(event)/orders/¶

Returns a list of all orders within a given event.

Example request:

GET /api/v1/organizers/bigevents/events/sampleconf/orders/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json
X-Page-Generated: 2017-12-01T10:00:00Z

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "code": "ABC12",
      "event": "sampleconf",
      "status": "p",
      "testmode": false,
      "secret": "k24fiuwvu8kxz3y1",
      "url": "https://test.pretix.eu/dummy/dummy/order/ABC12/k24fiuwvu8kxz3y1/",
      "email": "tester@example.org",
      "phone": "+491234567",
      "customer": null,
      "locale": "en",
      "sales_channel": "web",
      "datetime": "2017-12-01T10:00:00Z",
      "expires": "2017-12-10T10:00:00Z",
      "last_modified": "2017-12-01T10:00:00Z",
      "payment_date": "2017-12-05",
      "payment_provider": "banktransfer",
      "fees": [],
      "total": "23.00",
      "comment": "",
      "custom_followup_at": null,
      "checkin_attention": false,
      "checkin_text": null,
      "require_approval": false,
      "valid_if_pending": false,
      "invoice_address": {
          "last_modified": "2017-12-01T10:00:00Z",
          "is_business": true,
          "company": "Sample company",
          "name": "John Doe",
          "name_parts": {"full_name": "John Doe"},
          "street": "Test street 12",
          "zipcode": "12345",
          "city": "Testington",
          "country": "DE",
          "state": "",
          "internal_reference": "",
          "vat_id": "EU123456789",
          "vat_id_validated": false
      },
      "positions": [
        {
          "id": 23442,
          "order": "ABC12",
          "positionid": 1,
          "canceled": false,
          "item": 1345,
          "variation": null,
          "price": "23.00",
          "attendee_name": "Peter",
          "attendee_name_parts": {
            "full_name": "Peter",
          },
          "attendee_email": null,
          "company": "Sample company",
          "street": "Test street 12",
          "zipcode": "12345",
          "city": "Testington",
          "country": "DE",
          "state": null,
          "voucher": null,
          "voucher_budget_use": null,
          "tax_rate": "0.00",
          "tax_value": "0.00",
          "tax_rule": null,
          "secret": "z3fsn8jyufm5kpk768q69gkbyr5f4h6w",
          "addon_to": null,
          "subevent": null,
          "valid_from": null,
          "valid_until": null,
          "blocked": null,
          "discount": null,
          "pseudonymization_id": "MQLJvANO3B",
          "seat": null,
          "checkins": [
            {
              "list": 44,
              "type": "entry",
              "gate": null,
              "device": 2,
              "device_id": 1,
              "datetime": "2017-12-25T12:45:23Z",
              "auto_checked_in": false
            }
          ],
          "print_logs": [
            {
              "id": 1,
              "type": "badge",
              "datetime": "2017-12-25T12:45:23Z",
              "device_id": 1,
              "source": "pretixSCAN",
              "info": {}
            }
          ],
          "answers": [
            {
              "question": 12,
              "question_identifier": "WY3TP9SL",
              "answer": "Foo",
              "option_idenfiters": [],
              "options": []
            }
          ],
          "downloads": [
            {
              "output": "pdf",
              "url": "https://pretix.eu/api/v1/organizers/bigevents/events/sampleconf/orderpositions/23442/download/pdf/"
            }
          ]
        }
      ],
      "downloads": [
        {
          "output": "pdf",
          "url": "https://pretix.eu/api/v1/organizers/bigevents/events/sampleconf/orders/ABC12/download/pdf/"
        }
      ],
      "payments": [
        {
          "local_id": 1,
          "state": "confirmed",
          "amount": "23.00",
          "created": "2017-12-01T10:00:00Z",
          "payment_date": "2017-12-04T12:13:12Z",
          "payment_url": null,
          "details": {},
          "provider": "banktransfer"
        }
      ],
      "refunds": [],
      "cancellation_date": null
    }
  ]
}

Query Parameters:

page (integer) – The page number in case of a multi-page result set, default is 1
ordering (string) – Manually set the ordering of results. Valid fields to be used are datetime, code, last_modified, status and cancellation_date. Default: datetime
code (string) – Only return orders that match the given order code
status (string) – Only return orders in the given order status (see above)
search (string) – Only return orders matching a given search query (matching for names, email addresses, and company names)
customer (string) – Only show orders linked to the given customer.
item (integer) – Only return orders with a position that contains this item ID. Warning: Result will also include orders if they contain mixed items, and it will even return orders where the item is only contained in a canceled position.
variation (integer) – Only return orders with a position that contains this variation ID. Warning: Result will also include orders if they contain mixed items and variations, and it will even return orders where the variation is only contained in a canceled position.
testmode (boolean) – Only return orders with testmode set to true or false
require_approval (boolean) – If set to true or false, only categories with this value for the field require_approval will be returned.
include_canceled_positions – If set to true, the output will contain canceled order positions. Note that this only affects position-level cancellations, not fully-canceled orders.
include_canceled_fees – If set to true, the output will contain canceled order fees.
email (string) – Only return orders created with the given email address
locale (string) – Only return orders with the given customer locale
modified_since (datetime) – Only return orders that have changed since the given date. Be careful: We only recommend using this in combination with testmode=false, since test mode orders can vanish at any time and you will not notice it using this method.
created_since (datetime) – Only return orders that have been created since the given date (inclusive).
created_before (datetime) – Only return orders that have been created before the given date (exclusive).
subevent (integer) – Only return orders with a position that contains this subevent ID. Warning: Result will also include orders if they contain mixed subevents, and it will even return orders where the subevent is only contained in a canceled position.
subevent_after (datetime) – Only return orders that contain a ticket for a subevent taking place after the given date. This is an exclusive after, and it considers the end of the subevent (or its start, if the end is not set).
subevent_before (datetime) – Only return orders that contain a ticket for a subevent taking place after the given date. This is an exclusive before, and it considers the start of the subevent.
sales_channel (string) – Only return orders with the given sales channel identifier (e.g. "web").
payment_provider (string) – Only return orders that contain a payment using the given payment provider. Note that this also searches for partial incomplete, or failed payments within the order and is not useful to get a sum of payment amounts without further processing.
exclude (string) – Exclude a field from the output, e.g. fees or positions.downloads. Can be used as a performance optimization. Can be passed multiple times.
include (string) – Include only the given field in the output, e.g. fees or positions.downloads. Can be used as a performance optimization. Can be passed multiple times. include is applied before exclude, so exclude takes precedence.

Parameters:

organizer – The slug field of the organizer to fetch
event – The slug field of the event to fetch

Response Headers:

X-Page-Generated – The server time at the beginning of the operation. If you’re using this API to fetch differences, this is the value you want to use as modified_since in your next call.

Status Codes:

200 OK – no error
401 Unauthorized – Authentication failure
403 Forbidden – The requested organizer/event does not exist or you have no permission to view this resource.

GET /api/v1/organizers/(organizer)/orders/¶

Returns a list of all orders within all events of a given organizer (with sufficient access permissions).

Supported query parameters and output format of this endpoint are identical to the list endpoint within an event, with the exception that the pdf_data parameter is not supported here.

Example request:

GET /api/v1/organizers/bigevents/orders/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json
X-Page-Generated: 2017-12-01T10:00:00Z

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "code": "ABC12",
      "event": "sampleconf",
      ...
    }
  ]
}

Parameters:

organizer – The slug field of the organizer to fetch

Status Codes:

200 OK – no error
401 Unauthorized – Authentication failure
403 Forbidden – The requested organizer/event does not exist or you have no permission to view this resource.

Fetching individual orders¶

GET /api/v1/organizers/(organizer)/events/(event)/orders/(code)/¶

Returns information on one order, identified by its order code.

Example request:

GET /api/v1/organizers/bigevents/events/sampleconf/orders/ABC12/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
  "code": "ABC12",
  "event": "sampleconf",
  "status": "p",
  "testmode": false,
  "secret": "k24fiuwvu8kxz3y1",
  "url": "https://test.pretix.eu/dummy/dummy/order/ABC12/k24fiuwvu8kxz3y1/",
  "email": "tester@example.org",
  "phone": "+491234567",
  "customer": null,
  "locale": "en",
  "sales_channel": "web",
  "datetime": "2017-12-01T10:00:00Z",
  "expires": "2017-12-10T10:00:00Z",
  "last_modified": "2017-12-01T10:00:00Z",
  "payment_date": "2017-12-05",
  "payment_provider": "banktransfer",
  "fees": [],
  "total": "23.00",
  "comment": "",
  "api_meta": {},
  "custom_followup_at": null,
  "checkin_attention": false,
  "checkin_text": null,
  "require_approval": false,
  "valid_if_pending": false,
  "invoice_address": {
      "last_modified": "2017-12-01T10:00:00Z",
      "company": "Sample company",
      "is_business": true,
      "name": "John Doe",
      "name_parts": {"full_name": "John Doe"},
      "street": "Test street 12",
      "zipcode": "12345",
      "city": "Testington",
      "country": "DE",
      "state": "",
      "internal_reference": "",
      "vat_id": "EU123456789",
      "vat_id_validated": false
  },
  "positions": [
    {
      "id": 23442,
      "order": "ABC12",
      "positionid": 1,
      "canceled": false,
      "item": 1345,
      "variation": null,
      "price": "23.00",
      "attendee_name": "Peter",
      "attendee_name_parts": {
        "full_name": "Peter",
      },
      "attendee_email": null,
      "company": "Sample company",
      "street": "Test street 12",
      "zipcode": "12345",
      "city": "Testington",
      "country": "DE",
      "state": null,
      "voucher": null,
      "voucher_budget_use": null,
      "tax_rate": "0.00",
      "tax_rule": null,
      "tax_value": "0.00",
      "secret": "z3fsn8jyufm5kpk768q69gkbyr5f4h6w",
      "addon_to": null,
      "subevent": null,
      "valid_from": null,
      "valid_until": null,
      "blocked": null,
      "discount": null,
      "pseudonymization_id": "MQLJvANO3B",
      "seat": null,
      "checkins": [
        {
          "list": 44,
          "type": "entry",
          "gate": null,
          "device": 2,
          "device_id": 1,
          "datetime": "2017-12-25T12:45:23Z",
          "auto_checked_in": false
        }
      ],
      "print_logs": [
        {
          "id": 1,
          "type": "badge",
          "successful": true,
          "datetime": "2017-12-25T12:45:23Z",
          "device_id": 1,
          "source": "pretixSCAN",
          "info": {}
        }
      ],
      "answers": [
        {
          "question": 12,
          "question_identifier": "WY3TP9SL",
          "answer": "Foo",
          "option_idenfiters": [],
          "options": []
        }
      ],
      "downloads": [
        {
          "output": "pdf",
          "url": "https://pretix.eu/api/v1/organizers/bigevents/events/sampleconf/orderpositions/23442/download/pdf/"
        }
      ]
    }
  ],
  "downloads": [
    {
      "output": "pdf",
      "url": "https://pretix.eu/api/v1/organizers/bigevents/events/sampleconf/orders/ABC12/download/pdf/"
    }
  ],
  "payments": [
    {
      "local_id": 1,
      "state": "confirmed",
      "amount": "23.00",
      "created": "2017-12-01T10:00:00Z",
      "payment_date": "2017-12-04T12:13:12Z",
      "payment_url": null,
      "details": {},
      "provider": "banktransfer"
    }
  ],
  "refunds": [],
  "cancellation_date": null
}

Parameters:

organizer – The slug field of the organizer to fetch
event – The slug field of the event to fetch
code – The code field of the order to fetch

Query Parameters:

include_canceled_positions – If set to true, the output will contain canceled order positions. Note that this only affects position-level cancellations, not fully-canceled orders.
include_canceled_fees – If set to true, the output will contain canceled order fees.

Status Codes:

200 OK – no error
401 Unauthorized – Authentication failure
403 Forbidden – The requested organizer/event does not exist or you have no permission to view this resource.
404 Not Found – The requested order does not exist.

Order ticket download¶

Changed in version 4.10: The API now supports ticket downloads for pending orders if allowed by the event settings.

GET /api/v1/organizers/(organizer)/events/(event)/orders/(code)/download/(output)/¶

Download tickets for an order, identified by its order code. Depending on the chosen output, the response might be a ZIP file, PDF file or something else. The order details response contains a list of output options for this particular order.

Tickets can only be downloaded if ticket downloads are active and – depending on event settings – the order is either paid or pending. Note that in some cases the ticket file might not yet have been created. In that case, you will receive a status code 409 Conflict and you are expected to retry the request after a short period of waiting.

Example request:

GET /api/v1/organizers/bigevents/events/sampleconf/orders/ABC12/download/pdf/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/pdf

...

Parameters:

organizer – The slug field of the organizer to fetch
event – The slug field of the event to fetch
code – The code field of the order to fetch
output – The internal name of the output provider to use

Status Codes:

200 OK – no error
401 Unauthorized – Authentication failure
403 Forbidden – The requested organizer/event does not exist or you have no permission to view this resource or downloads are not available for this order at this time. The response content will contain more details.
404 Not Found – The requested order or output provider does not exist.
409 Conflict – The file is not yet ready and will now be prepared. Retry the request after waiting for a few seconds.

Updating order fields¶

PATCH /api/v1/organizers/(organizer)/events/(event)/orders/(code)/¶

Updates specific fields on an order. Currently, only the following fields are supported:

email
phone
checkin_attention
checkin_text
locale
comment
api_meta
custom_followup_at
invoice_address (you always need to supply the full object, or null to delete the current address)
valid_if_pending
expires

Example request:

PATCH /api/v1/organizers/bigevents/events/sampleconf/orders/ABC12/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript
Content-Type: application/json

{
  "email": "other@example.org",
  "locale": "de",
  "comment": "Foo",
  "checkin_attention": true
}

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

(Full order resource, see above.)

Parameters:

organizer – The slug field of the organizer of the event
event – The slug field of the event
code – The code field of the order to update

Status Codes:

200 OK – no error
400 Bad Request – The order could not be updated due to invalid submitted data.
401 Unauthorized – Authentication failure
403 Forbidden – The requested organizer/event does not exist or you have no permission to update this order.

Generating new secrets¶

POST /api/v1/organizers/(organizer)/events/(event)/orders/(code)/regenerate_secrets/¶

Triggers generation of new secret attributes for both the order and all order positions.

Example request:

POST /api/v1/organizers/bigevents/events/sampleconf/orders/ABC12/regenerate_secrets/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

(Full order resource, see above.)

Parameters:

organizer – The slug field of the organizer of the event
event – The slug field of the event
code – The code field of the order to update

Status Codes:

200 OK – no error
400 Bad Request – The order could not be updated due to invalid submitted data.
401 Unauthorized – Authentication failure
403 Forbidden – The requested organizer/event does not exist or you have no permission to update this order.

POST /api/v1/organizers/(organizer)/events/(event)/orderpositions/(id)/regenerate_secrets/¶

Triggers generation of a new secret attribute for a single order position.

Example request:

POST /api/v1/organizers/bigevents/events/sampleconf/orderpositions/23/regenerate_secrets/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

(Full order position resource, see above.)

Parameters:

organizer – The slug field of the organizer of the event
event – The slug field of the event
code – The id field of the order position to update

Status Codes:

200 OK – no error
400 Bad Request – The order position could not be updated due to invalid submitted data.
401 Unauthorized – Authentication failure
403 Forbidden – The requested organizer/event does not exist or you have no permission to update this order position.

Deleting orders¶

DELETE /api/v1/organizers/(organizer)/events/(event)/orders/(code)/¶

Deletes an order. Works only if the order has testmode set to true.

Example request:

DELETE /api/v1/organizers/bigevents/events/sampleconf/orders/ABC12/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript

Example response:

HTTP/1.1 204 No Content
Vary: Accept
Content-Type: application/json

Parameters:

organizer – The slug field of the organizer to fetch
event – The slug field of the event to fetch
code – The code field of the order to delete

Status Codes:

204 No Content – no error
401 Unauthorized – Authentication failure
403 Forbidden – The requested organizer/event does not exist or you have no permission to delete this resource or the order may not be deleted.
404 Not Found – The requested order does not exist.

Creating orders¶

POST /api/v1/organizers/(organizer)/events/(event)/orders/¶

Creates a new order.

Warning

This endpoint is intended for advanced users. It is not designed to be used to build your own shop frontend, it’s rather intended to import attendees from external sources etc. There is a lot that it does not or can not do, and you will need to be careful using it. It allows to bypass many of the restrictions imposed when creating an order through the regular shop.

Specifically, this endpoint currently

does not validate if products are only to be sold in a specific time frame
does not validate if products are only to be sold on other sales channels
does not validate if the event’s ticket sales are already over or haven’t started
does not validate the number of items per order or the number of times an item can be included in an order
does not validate any requirements related to add-on products and does not add bundled products automatically
does not check prices but believes any prices you send
does not prevent you from buying items that can only be bought with a voucher
does not calculate fees automatically
does not allow to pass data to plugins and will therefore cause issues with some plugins like the shipping module
does not support file upload questions
does not support redeeming gift cards
does not support or validate memberships

You can supply the following fields of the resource:

code (optional) – Only A-Z and 0-9, but without O and 1.
status (optional) – Defaults to pending for non-free orders and paid for free orders. You can only set this to "n" for pending or "p" for paid. We will create a payment object for this order either in state created or in state confirmed, depending on this value. If you create a paid order, the order_paid signal will not be sent out to plugins and no email will be sent. If you want that behavior, create an unpaid order and then call the mark_paid API method.
customer (optional) – Customer identifier or null
testmode (optional) – Defaults to false
consume_carts (optional) – A list of cart IDs. All cart positions with these IDs will be deleted if the order creation is successful. Any quotas or seats that become free by this operation will be credited to your order creation.
email (optional)
locale
sales_channel (optional)
payment_provider (optional) – The identifier of the payment provider set for this order. This needs to be an existing payment provider. You should use "free" for free orders, and we strongly advise to use "manual" for all orders you create as paid. This field is optional when the order status is "n" or the order total is zero, otherwise it is required.
payment_info (optional) – You can pass a nested JSON object that will be set as the internal info value of the payment object that will be created. How this value is handled is up to the payment provider and you should only use this if you know the specific payment provider in detail. Please keep in mind that the payment provider will not be called to do anything about this (i.e. if you pass a bank account to a debit provider, no charge will be created), this is just informative in case you handled the payment already.
payment_date (optional) – Date and time of the completion of the payment.
comment (optional)
custom_followup_at (optional)
checkin_attention (optional)
checkin_text (optional)
require_approval (optional)
valid_if_pending (optional)
invoice_address (optional)
- company
- is_business
- name or name_parts
- street
- zipcode
- city
- country
- state
- internal_reference
- vat_id
- vat_id_validated (optional) – If you need support for reverse charge (rarely the case), you need to check
  yourself if the passed VAT ID is a valid EU VAT ID. In that case, set this to true. Only valid VAT IDs will trigger reverse charge taxation. Don’t forget to set is_business as well!
positions
- positionid (optional, see below)
- item
- variation (optional)
- price (optional, if set to null or missing the price will be computed from the given product)
- 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)
- voucher (optional, the code attribute of a valid voucher)
- attendee_email (optional)
- company (optional)
- street (optional)
- zipcode (optional)
- city (optional)
- country (optional)
- state (optional)
- secret (optional)
- addon_to (optional, see below)
- subevent (optional)
- valid_from (optional, if both valid_from and valid_until are missing (not null) the availability will be computed from the given product)
- valid_until (optional, if both valid_from and valid_until are missing (not null) the availability will be computed from the given product)
- requested_valid_from (optional, can be set instead of valid_from and valid_until to signal a user choice for the start time that may or may not be respected)
- use_reusable_medium (optional, causes the new ticket to take over the given reusable medium, identified by its ID)
- answers
  - question
  - answer
  - options
fees
- fee_type
- value
- description
- internal_type
- tax_rule
- _treat_value_as_percentage (Optional convenience flag. If set to true, your value parameter will be treated as a percentage and the fee will be calculated using that percentage and the sum of all product prices. Note that this will not include other fees and is calculated once during order generation and will not be respected automatically when the order changes later.)
- _split_taxes_like_products (Optional convenience flag. If set to true, your tax_rule will be ignored and the fee will be taxed like the products in the order. If the products have multiple tax rates, multiple fees will be generated with weights adjusted to the net price of the products. Note that this will be calculated once during order generation and is not respected automatically when the order changes later.)
force (optional). If set to true, quotas will be ignored.
send_email (optional). If set to true, the same emails will be sent as for a regular order, regardless of whether these emails are enabled for certain sales channels. If set to null, behavior will be controlled by pretix’ settings based on the sales channels (added in pretix 4.7). Defaults to false. Used to be send_mail before pretix 3.14.

If you want to use add-on products, you need to set the positionid fields of all positions manually to incrementing integers starting with 1. Then, you can reference one of these IDs in the addon_to field of another position. Note that all add_ons for a specific position need to come immediately after the position itself.

Starting with pretix 3.7, you can add "simulate": true to the body to do a “dry run” of your order. This will validate your order and return you an order object with the resulting prices, but will not create an actual order. You can use this for testing or to look up prices. In this case, some attributes are ignored, such as whether to send an email or what payment provider will be used. Note that some returned fields will contain empty values (e.g. all id fields of positions will be zero) and some will contain fake values (e.g. the order code will always be PREVIEW). pretix plugins will not be triggered, so some special behavior might be missing as well.

Example request:

POST /api/v1/organizers/bigevents/events/sampleconf/orders/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript
Content-Type: application/json

{
  "email": "dummy@example.org",
  "locale": "en",
  "sales_channel": "web",
  "fees": [
    {
      "fee_type": "payment",
      "value": "0.25",
      "description": "",
      "internal_type": "",
      "tax_rule": 2
    }
  ],
  "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": "GB",
    "state": "",
    "internal_reference": "",
    "vat_id": ""
  },
  "positions": [
    {
      "positionid": 1,
      "item": 1,
      "variation": null,
      "price": "23.00",
      "attendee_name_parts": {
        "full_name": "Peter"
      },
      "attendee_email": null,
      "addon_to": null,
      "answers": [
        {
          "question": 1,
          "answer": "23",
          "options": []
        }
      ],
      "subevent": null
    }
  ]
}

Example response:

HTTP/1.1 201 Created
Vary: Accept
Content-Type: application/json

(Full order resource, see above.)

Parameters:

organizer – The slug field of the organizer of the event to create an order for
event – The slug field of the event to create an order for

Status Codes:

201 Created – no error
400 Bad Request – The order could not be created due to invalid submitted data or lack of quota.
401 Unauthorized – Authentication failure
403 Forbidden – The requested organizer/event does not exist or you have no permission to create this order.

Order state operations¶

POST /api/v1/organizers/(organizer)/events/(event)/orders/(code)/mark_paid/¶

Marks a pending or expired order as successfully paid.

Example request:

POST /api/v1/organizers/bigevents/events/sampleconf/orders/ABC12/mark_paid/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript
Content-Type: application/json

{
    "send_email": true
}

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
  "code": "ABC12",
  "status": "p",
  ...
}

Parameters:

organizer – The slug field of the organizer to modify
event – The slug field of the event to modify
code – The code field of the order to modify

Status Codes:

200 OK – no error
400 Bad Request – The order cannot be marked as paid, either because the current order status does not allow it or because no quota is left to perform the operation.
401 Unauthorized – Authentication failure
403 Forbidden – The requested organizer/event does not exist or you have no permission to view this resource.
404 Not Found – The requested order does not exist.
409 Conflict – The server was unable to acquire a lock and could not process your request. You can try again after a short waiting period.

POST /api/v1/organizers/(organizer)/events/(event)/orders/(code)/mark_canceled/¶

Cancels an order. For a pending order, this will set the order to status c. For a paid order, this will set the order to status c if no cancellation_fee is passed. If you do pass a cancellation_fee, the order will instead stay paid, but all positions will be removed (or marked as canceled) and replaced by the cancellation fee as the only component of the order.

You can control whether the customer is notified through send_email (defaults to true). You can pass a comment that can be visible to the user if it is used in the email template.

Example request:

POST /api/v1/organizers/bigevents/events/sampleconf/orders/ABC12/mark_canceled/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript
Content-Type: text/json

{
    "send_email": true,
    "comment": "Event was canceled.",
    "cancellation_fee": null
}

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
  "code": "ABC12",
  "status": "c",
  ...
}

Parameters:

organizer – The slug field of the organizer to modify
event – The slug field of the event to modify
code – The code field of the order to modify

Status Codes:

200 OK – no error
400 Bad Request – The order cannot be marked as canceled since the current order status does not allow it.
401 Unauthorized – Authentication failure
403 Forbidden – The requested organizer/event does not exist or you have no permission to view this resource.
404 Not Found – The requested order does not exist.

POST /api/v1/organizers/(organizer)/events/(event)/orders/(code)/reactivate/¶

Reactivates a canceled order. This will set the order to pending or paid state. Only possible if all products are still available.

Example request:

POST /api/v1/organizers/bigevents/events/sampleconf/orders/ABC12/reactivate/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
  "code": "ABC12",
  "status": "n",
  ...
}

Parameters:

organizer – The slug field of the organizer to modify
event – The slug field of the event to modify
code – The code field of the order to modify

Status Codes:

200 OK – no error
400 Bad Request – The order cannot be reactivated
401 Unauthorized – Authentication failure
403 Forbidden – The requested organizer/event does not exist or you have no permission to view this resource.
404 Not Found – The requested order does not exist.

POST /api/v1/organizers/(organizer)/events/(event)/orders/(code)/mark_pending/¶

Marks a paid order as unpaid.

Example request:

POST /api/v1/organizers/bigevents/events/sampleconf/orders/ABC12/mark_pending/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
  "code": "ABC12",
  "status": "n",
  ...
}

Parameters:

organizer – The slug field of the organizer to modify
event – The slug field of the event to modify
code – The code field of the order to modify

Status Codes:

200 OK – no error
400 Bad Request – The order cannot be marked as unpaid since the current order status does not allow it.
401 Unauthorized – Authentication failure
403 Forbidden – The requested organizer/event does not exist or you have no permission to view this resource.
404 Not Found – The requested order does not exist.

POST /api/v1/organizers/(organizer)/events/(event)/orders/(code)/mark_expired/¶

Marks an unpaid order as expired.

Example request:

POST /api/v1/organizers/bigevents/events/sampleconf/orders/ABC12/mark_expired/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
  "code": "ABC12",
  "status": "e",
  ...
}

Parameters:

organizer – The slug field of the organizer to modify
event – The slug field of the event to modify
code – The code field of the order to modify

Status Codes:

200 OK – no error
400 Bad Request – The order cannot be marked as expired since the current order status does not allow it.
401 Unauthorized – Authentication failure
403 Forbidden – The requested organizer/event does not exist or you have no permission to view this resource.
404 Not Found – The requested order does not exist.

POST /api/v1/organizers/(organizer)/events/(event)/orders/(code)/extend/¶

Extends the payment deadline of a pending order. If the order is already expired and quota is still available, its state will be changed to pending.

The only required parameter of this operation is expires, which should contain a date in the future. Note that only a date is expected, not a datetime, since pretix will always set the deadline to the end of the day in the event’s timezone.

You can pass the optional parameter force. If it is set to true, the operation will be performed even if it leads to an overbooked quota because the order was expired and the tickets have been sold again.

Example request:

POST /api/v1/organizers/bigevents/events/sampleconf/orders/ABC12/extend/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript
Content-Type: text/json

{
    "expires": "2017-10-28",
    "force": false
}

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
  "code": "ABC12",
  "status": "n",
  "expires": "2017-10-28T23:59:59Z",
  ...
}

Parameters:

organizer – The slug field of the organizer to modify
event – The slug field of the event to modify
code – The code field of the order to modify

Status Codes:

200 OK – no error
400 Bad Request – The order cannot be extended since the current order status does not allow it or no quota is available or the submitted date is invalid.
401 Unauthorized – Authentication failure
403 Forbidden – The requested organizer/event does not exist or you have no permission to view this resource.
404 Not Found – The requested order does not exist.

POST /api/v1/organizers/(organizer)/events/(event)/orders/(code)/approve/¶

Approve an order that is pending approval.

Example request:

POST /api/v1/organizers/bigevents/events/sampleconf/orders/ABC12/approve/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
  "code": "ABC12",
  "status": "n",
  "require_approval": false,
  ...
}

Parameters:

organizer – The slug field of the organizer to modify
event – The slug field of the event to modify
code – The code field of the order to modify

Status Codes:

200 OK – no error
400 Bad Request – The order cannot be approved, likely because the current order status does not allow it.
401 Unauthorized – Authentication failure
403 Forbidden – The requested organizer/event does not exist or you have no permission to view this resource.
404 Not Found – The requested order does not exist.
409 Conflict – The server was unable to acquire a lock and could not process your request. You can try again after a short waiting period.

POST /api/v1/organizers/(organizer)/events/(event)/orders/(code)/deny/¶

Marks an order that is pending approval as denied.

Example request:

POST /api/v1/organizers/bigevents/events/sampleconf/orders/ABC12/deny/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript
Content-Type: text/json

{
    "send_email": true,
    "comment": "You're not a business customer!"
}

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
  "code": "ABC12",
  "status": "c",
  "require_approval": true,
  ...
}

Parameters:

organizer – The slug field of the organizer to modify
event – The slug field of the event to modify
code – The code field of the order to modify

Status Codes:

200 OK – no error
400 Bad Request – The order cannot be marked as denied since the current order status does not allow it.
401 Unauthorized – Authentication failure
403 Forbidden – The requested organizer/event does not exist or you have no permission to update this resource.
404 Not Found – The requested order does not exist.

Generating invoices¶

POST /api/v1/organizers/(organizer)/events/(event)/orders/(code)/create_invoice/¶

Creates an invoice for an order which currently does not have an invoice. Returns the invoice object.

Example request:

POST /api/v1/organizers/bigevents/events/sampleconf/orders/ABC12/create_invoice/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
  "order": "FOO",
  "number": "DUMMY-00001",
  "is_cancellation": false,
  ...
}

Parameters:

organizer – The slug field of the organizer to modify
event – The slug field of the event to modify
code – The code field of the order to create an invoice for

Status Codes:

200 OK – no error
400 Bad Request – The invoice can not be created (invoicing disabled, the order already has an invoice, …)
401 Unauthorized – Authentication failure
403 Forbidden – The requested organizer/event does not exist or you have no permission to view this resource.
404 Not Found – The requested order does not exist.

Sending e-mails¶

POST /api/v1/organizers/(organizer)/events/(event)/orders/(code)/resend_link/¶

Sends an email to the buyer with the link to the order page.

Example request:

POST /api/v1/organizers/bigevents/events/sampleconf/orders/ABC12/resend_link/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript

Example response:

HTTP/1.1 204 No Content
Vary: Accept

Parameters:

organizer – The slug field of the organizer to modify
event – The slug field of the event to modify
code – The code field of the order to send an email for

Status Codes:

200 OK – no error
400 Bad Request – The order does not have an email address associated
401 Unauthorized – Authentication failure
403 Forbidden – The requested organizer/event does not exist or you have no permission to view this resource.
404 Not Found – The requested order does not exist.
503 Service Unavailable – The email could not be sent.

List of all order positions¶

GET /api/v1/organizers/(organizer)/events/(event)/orderpositions/¶

Returns a list of all order positions within a given event.

Example request:

GET /api/v1/organizers/bigevents/events/sampleconf/orderpositions/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 23442,
      "order": "ABC12",
      "positionid": 1,
      "canceled": false,
      "item": 1345,
      "variation": null,
      "price": "23.00",
      "attendee_name": "Peter",
      "attendee_name_parts": {
        "full_name": "Peter"
      },
      "attendee_email": null,
      "voucher": null,
      "voucher_budget_use": null,
      "tax_rate": "0.00",
      "tax_rule": null,
      "tax_value": "0.00",
      "secret": "z3fsn8jyufm5kpk768q69gkbyr5f4h6w",
      "discount": null,
      "pseudonymization_id": "MQLJvANO3B",
      "seat": null,
      "addon_to": null,
      "subevent": null,
      "valid_from": null,
      "valid_until": null,
      "blocked": null,
      "checkins": [
        {
          "list": 44,
          "type": "entry",
          "gate": null,
          "device": 2,
          "device_id": 1,
          "datetime": "2017-12-25T12:45:23Z",
          "auto_checked_in": false
        }
      ],
      "print_logs": [
        {
          "id": 1,
          "type": "badge",
          "successful": true,
          "datetime": "2017-12-25T12:45:23Z",
          "device_id": 1,
          "source": "pretixSCAN",
          "info": {}
        }
      ],
      "answers": [
        {
          "question": 12,
          "question_identifier": "WY3TP9SL",
          "answer": "Foo",
          "option_idenfiters": [],
          "options": []
        }
      ],
      "downloads": [
        {
          "output": "pdf",
          "url": "https://pretix.eu/api/v1/organizers/bigevents/events/sampleconf/orderpositions/23442/download/pdf/"
        }
      ]
    }
  ]
}

Query Parameters:

page (integer) – The page number in case of a multi-page result set, default is 1
ordering (string) – Manually set the ordering of results. Valid fields to be used are order__code, order__datetime, positionid, attendee_name, and order__status. Default: order__datetime,positionid
order (string) – Only return positions of the order with the given order code
search (string) – Fuzzy search matching the attendee name, order code, invoice address name as well as to the beginning of the secret.
customer (string) – Only show orders linked to the given customer.
item (integer) – Only return positions with the purchased item matching the given ID.
item__in (integer) – Only return positions with the purchased item matching one of the given comma-separated IDs.
variation (integer) – Only return positions with the purchased item variation matching the given ID.
variation__in (integer) – Only return positions with one of the purchased item variation matching the given comma-separated IDs.
attendee_name (string) – 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.
secret (string) – Only return positions with the given ticket secret.
pseudonymization_id (string) – Only return positions with the given pseudonymization ID.
order__status (string) – Only return positions with the given order status.
order__status__in (string) – Only return positions with one the given comma-separated order status.
has_checkin (boolean) – If set to true or false, only return positions that have or have not been checked in already.
subevent (integer) – Only return positions of the sub-event with the given ID
subevent__in (integer) – Only return positions of one of the sub-events with the given comma-separated IDs
addon_to (integer) – Only return positions that are add-ons to the position with the given ID.
addon_to__in (integer) – Only return positions that are add-ons to one of the positions with the given comma-separated IDs.
voucher (string) – Only return positions with a specific voucher.
voucher__code (string) – Only return positions with a specific voucher code.
include_canceled_positions – If set to true, the output will contain canceled order positions. Note that this only affects position-level cancellations, not fully-canceled orders.

Parameters:

organizer – The slug field of the organizer to fetch
event – The slug field of the event to fetch

Status Codes:

200 OK – no error
401 Unauthorized – Authentication failure
403 Forbidden – The requested organizer/event does not exist or you have no permission to view this resource.

Fetching individual positions¶

GET /api/v1/organizers/(organizer)/events/(event)/orderpositions/(id)/¶

Returns information on one order position, identified by its internal ID.

Example request:

GET /api/v1/organizers/bigevents/events/sampleconf/orderpositions/23442/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
  "id": 23442,
  "order": "ABC12",
  "positionid": 1,
  "canceled": false,
  "item": 1345,
  "variation": null,
  "price": "23.00",
  "attendee_name": "Peter",
  "attendee_name_parts": {
    "full_name": "Peter",
  },
  "attendee_email": null,
  "voucher": null,
  "voucher_budget_use": null,
  "tax_rate": "0.00",
  "tax_rule": null,
  "tax_value": "0.00",
  "secret": "z3fsn8jyufm5kpk768q69gkbyr5f4h6w",
  "addon_to": null,
  "subevent": null,
  "valid_from": null,
  "valid_until": null,
  "blocked": null,
  "discount": null,
  "pseudonymization_id": "MQLJvANO3B",
  "seat": null,
  "checkins": [
    {
      "list": 44,
      "type": "entry",
      "gate": null,
      "device": 2,
      "device_id": 1,
      "datetime": "2017-12-25T12:45:23Z",
      "auto_checked_in": false
    }
  ],
  "print_logs": [
    {
      "id": 1,
      "type": "badge",
      "successful": true,
      "datetime": "2017-12-25T12:45:23Z",
      "device_id": 1,
      "source": "pretixSCAN",
      "info": {}
    }
  ],
  "answers": [
    {
      "question": 12,
      "question_identifier": "WY3TP9SL",
      "answer": "Foo",
      "option_idenfiters": [],
      "options": []
    }
  ],
  "downloads": [
    {
      "output": "pdf",
      "url": "https://pretix.eu/api/v1/organizers/bigevents/events/sampleconf/orderpositions/23442/download/pdf/"
    }
  ]
}

Parameters:

organizer – The slug field of the organizer to fetch
event – The slug field of the event to fetch
id – The id field of the order position to fetch

Query Parameters:

include_canceled_positions – If set to true, canceled positions may be returned (otherwise, they return 404).

Status Codes:

200 OK – no error
401 Unauthorized – Authentication failure
403 Forbidden – The requested organizer/event does not exist or you have no permission to view this resource.
404 Not Found – The requested order position does not exist.

Order position ticket download¶

Changed in version 4.10: The API now supports ticket downloads for pending orders if allowed by the event settings.

GET /api/v1/organizers/(organizer)/events/(event)/orderpositions/(id)/download/(output)/¶

Download tickets for one order position, identified by its internal ID. Depending on the chosen output, the response might be a ZIP file, PDF file or something else. The order details response contains a list of output options for this particular order position.

Be aware that the output does not have to be a file, but can also be a regular HTTP response with a Content-Type set to text/uri-list. In this case, the user is expected to navigate to that URL in order to access their ticket. The referenced URL can provide a download or a regular, human-viewable website - so it is advised to open this URL in a webbrowser and leave it up to the user to handle the result.

Tickets can only be downloaded if ticket downloads are active and – depending on event settings – the order is either paid or pending. Also, depending on event configuration downloads might be only unavailable for add-on products or non-admission products. Note that in some cases the ticket file might not yet have been created. In that case, you will receive a status code 409 Conflict and you are expected to retry the request after a short period of waiting.

Example request:

GET /api/v1/organizers/bigevents/events/sampleconf/orderpositions/23442/download/pdf/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/pdf

...

Parameters:

organizer – The slug field of the organizer to fetch
event – The slug field of the event to fetch
id – The id field of the order position to fetch
output – The internal name of the output provider to use

Status Codes:

200 OK – no error
401 Unauthorized – Authentication failure
403 Forbidden – 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.
404 Not Found – The requested order position or download provider does not exist.
409 Conflict – The file is not yet ready and will now be prepared. Retry the request after waiting for a few seconds.

Manipulating individual positions¶

Changed in version 4.8: The PATCH method now supports changing items, variations, subevents, seats, prices, and tax rules. The POST endpoint to add individual positions has been added.

Added in version 4.16: The endpoints to manage blocks have been added.

Changed in version 2024.9: The API now supports logging ticket and badge prints.

PATCH /api/v1/organizers/(organizer)/events/(event)/orderpositions/(id)/¶

Updates specific fields on an order position. Currently, only the following fields are supported:

attendee_email
attendee_name_parts or attendee_name
company
street
zipcode
city
country
state
answers: If specified, you will need to provide all answers for this order position. Validation is handled the same way as when creating orders through the API. You are therefore expected to provide question, answer, and possibly options. question_identifier and option_identifiers will be ignored. As a special case, you can submit the magic value "file:keep" as the answer to a file question to keep the current value without re-uploading it.
item
variation
subevent
seat (specified as a string mapping to a string_guid)
price
tax_rule
valid_from
valid_until

Changing parameters such as item or price will not automatically trigger creation of a new invoice, you need to take care of that yourself.

Example request:

PATCH /api/v1/organizers/bigevents/events/sampleconf/orderpositions/23442/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript
Content-Type: application/json

{
  "attendee_email": "other@example.org"
}

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

(Full order position resource, see above.)

Parameters:

organizer – The slug field of the organizer of the event
event – The slug field of the event
id – The id field of the order position to update

Status Codes:

200 OK – no error
400 Bad Request – The order could not be updated due to invalid submitted data.
401 Unauthorized – Authentication failure
403 Forbidden – The requested organizer/event does not exist or you have no permission to update this order.

POST /api/v1/organizers/(organizer)/events/(event)/orderpositions/¶

Adds a new position to an order. Currently, only the following fields are supported:

order (mandatory, specified as a string mapping to a code)
addon_to (optional, specified as an integer mapping to the positionid of the parent position)
item (mandatory)
variation (mandatory depending on item)
subevent (mandatory depending on event)
seat (specified as a string mapping to a string_guid, mandatory depending on event and item)
price (default price will be used if unset)
attendee_email
attendee_name_parts or attendee_name
company
street
zipcode
city
country
state
answers: Validation is handled the same way as when creating orders through the API. You are therefore expected to provide question, answer, and possibly options. question_identifier and option_identifiers will be ignored. As a special case, you can submit the magic value "file:keep" as the answer to a file question to keep the current value without re-uploading it.
valid_from
valid_until

This will not automatically trigger creation of a new invoice, you need to take care of that yourself.

Example request:

POST /api/v1/organizers/bigevents/events/sampleconf/orderpositions/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript
Content-Type: application/json

{
  "order": "ABC12",
  "item": 5,
  "addon_to": 1
}

Example response:

HTTP/1.1 201 Created
Vary: Accept
Content-Type: application/json

(Full order position resource, see above.)

Parameters:

organizer – The slug field of the organizer of the event
event – The slug field of the event

Status Codes:

200 OK – no error
400 Bad Request – The position could not be created due to invalid submitted data.
401 Unauthorized – Authentication failure
403 Forbidden – The requested organizer/event does not exist or you have no permission to create this position.

DELETE /api/v1/organizers/(organizer)/events/(event)/orderpositions/(id)/¶

Cancels an order position, identified by its internal ID.

Example request:

DELETE /api/v1/organizers/bigevents/events/sampleconf/orderpositions/23442/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript

Example response:

HTTP/1.1 204 No Content
Vary: Accept

Parameters:

organizer – The slug field of the organizer to fetch
event – The slug field of the event to fetch
id – The id field of the order position to delete

Status Codes:

204 No Content – no error
400 Bad Request – This position cannot be deleted (e.g. last position in order)
401 Unauthorized – Authentication failure
403 Forbidden – The requested organizer/event does not exist or you have no permission to view this resource.
404 Not Found – The requested order position does not exist.

POST /api/v1/organizers/(organizer)/events/(event)/orderpositions/(id)/add_block/¶

Blocks an order position from being used. The block name either needs to be "admin" or start with "api:". It may only contain letters, numbers, dots and underscores. "admin" represents the regular block that can be set in the backend user interface.

Example request:

 POST /api/v1/organizers/bigevents/events/sampleconf/orderpositions/23/add_block/ HTTP/1.1
 Host: pretix.eu
 Accept: application/json, text/javascript
 Content-Type: application/json

{
  "name": "api:block1"
}

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

(Full order position resource, see above.)

Parameters:

organizer – The slug field of the organizer of the event
event – The slug field of the event
code – The id field of the order position to update

Status Codes:

200 OK – no error
400 Bad Request – The order position could not be updated due to invalid submitted data.
401 Unauthorized – Authentication failure
403 Forbidden – The requested organizer/event does not exist or you have no permission to update this order position.

POST /api/v1/organizers/(organizer)/events/(event)/orderpositions/(id)/remove_block/¶

Unblocks an order position from being used. The block name either needs to be "admin" or start with "api:". It may only contain letters, numbers, dots and underscores. "admin" represents the regular block that can be set in the backend user interface. Blocks set by plugins cannot be lifted through this API.

Example request:

 POST /api/v1/organizers/bigevents/events/sampleconf/orderpositions/23/remove_block/ HTTP/1.1
 Host: pretix.eu
 Accept: application/json, text/javascript
 Content-Type: application/json

{
  "name": "api:block1"
}

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

(Full order position resource, see above.)

Parameters:

organizer – The slug field of the organizer of the event
event – The slug field of the event
code – The id field of the order position to update

Status Codes:

200 OK – no error
400 Bad Request – The order position could not be updated due to invalid submitted data.
401 Unauthorized – Authentication failure
403 Forbidden – The requested organizer/event does not exist or you have no permission to update this order position.

POST /api/v1/organizers/(organizer)/events/(event)/orderpositions/(id)/printlog/¶

Creates a print log, stating that this ticket has been printed.

Example request:

 POST /api/v1/organizers/bigevents/events/sampleconf/orderpositions/23442/printlog/ HTTP/1.1
 Host: pretix.eu
 Accept: application/json, text/javascript
 Content-Type: application/json

{
  "datetime": "2024-09-19T13:37:00+02:00",
  "source": "pretixPOS",
  "type": "badge",
  "info": {
    "cashier": 1234
  }
}

Example response:

 HTTP/1.1 201 Created
 Vary: Accept
 Content-Type: application/pdf

{
  "id": 1234,
  "device_id": null,
  "datetime": "2024-09-19T13:37:00+02:00",
  "source": "pretixPOS",
  "type": "badge",
  "info": {
    "cashier": 1234
  }
}

Parameters:

organizer – The slug field of the organizer to create a log for
event – The slug field of the event to create a log for
id – The id field of the order position to create a log for

Status Codes:

201 Created – no error
401 Unauthorized – Authentication failure
403 Forbidden – 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.
404 Not Found – The requested order position or download provider does not exist.
409 Conflict – The file is not yet ready and will now be prepared. Retry the request after waiting for a few seconds.

Changing order contents¶

While you can change positions individually sometimes it is necessary to make multiple changes to an order at once within one transaction. This makes it possible to e.g. swap the seats of two attendees in an order without running into conflicts. This interface also offers some possibilities not available otherwise, such as splitting an order or changing fees.

Changed in version 4.8: This endpoint has been added to the system.

POST /api/v1/organizers/(organizer)/events/(event)/orders/(code)/change/¶

Performs a change operation on an order. You can supply the following fields:

patch_positions: A list of objects with the two keys position specifying an order position ID and body specifying the desired changed values of the position (item, variation, subevent, seat, price, tax_rule, valid_from, valid_until).
cancel_positions: A list of objects with the single key position specifying an order position ID.
split_positions: A list of objects with the single key position specifying an order position ID.
create_positions: A list of objects describing new order positions with the same fields supported as when creating them individually through the POST …/orderpositions/ endpoint.
patch_fees: A list of objects with the two keys fee specifying an order fee ID and body specifying the desired changed values of the position (value).
cancel_fees: A list of objects with the single key fee specifying an order fee ID.
recalculate_taxes: If set to "keep_net", all taxes will be recalculated based on the tax rule and invoice address, the net price will be kept. If set to "keep_gross", the gross price will be kept. If set to null (the default) the taxes are not recalculated.
send_email: If set to true, the customer will be notified about the change. Defaults to false.
reissue_invoice: If set to true and an invoice exists for the order, it will be canceled and a new invoice will be issued. Defaults to true.

Example request:

POST /api/v1/organizers/bigevents/events/sampleconf/orders/ABC12/change/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript
Content-Type: application/json

{
  "cancel_positions": [
    {
      "position": 12373
    }
  ],
  "patch_positions": [
    {
      "position": 12374,
      "body": {
        "item": 12,
        "variation": None,
        "subevent": 562,
        "seat": "seat-guid-2",
        "price": "99.99",
        "tax_rule": 15
      }
    }
  ],
  "split_positions": [
    {
      "position": 12375
    }
  ],
  "create_positions": [
    {
      "item": 12,
      "variation": None,
      "subevent": 562,
      "seat": "seat-guid-2",
      "price": "99.99",
      "addon_to": 12374,
      "attendee_name": "Peter",
    }
  ],
  "cancel_fees": [
    {
      "fee": 49
    }
  ],
  "change_fees": [
    {
      "fee": 51,
      "body": {
        "value": "12.00"
      }
    }
  ],
  "reissue_invoice": true,
  "send_email": true,
  "recalculate_taxes": "keep_gross"
}

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

(Full order position resource, see above.)

Parameters:

organizer – The slug field of the organizer of the event
event – The slug field of the event
code – The code field of the order to update

Status Codes:

200 OK – no error
400 Bad Request – The order could not be updated due to invalid submitted data.
401 Unauthorized – Authentication failure
403 Forbidden – The requested organizer/event does not exist or you have no permission to update this order.

Order payment endpoints¶

GET /api/v1/organizers/(organizer)/events/(event)/orders/(code)/payments/¶

Returns a list of all payments for an order.

Example request:

GET /api/v1/organizers/bigevents/events/sampleconf/orders/ABC12/payments/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "local_id": 1,
      "state": "confirmed",
      "amount": "23.00",
      "created": "2017-12-01T10:00:00Z",
      "payment_date": "2017-12-04T12:13:12Z",
      "payment_url": null,
      "details": {},
      "provider": "banktransfer"
    }
  ]
}

Query Parameters:

page (integer) – The page number in case of a multi-page result set, default is 1

Parameters:

organizer – The slug field of the organizer to fetch
event – The slug field of the event to fetch
order – The code field of the order to fetch

Status Codes:

200 OK – no error
401 Unauthorized – Authentication failure
403 Forbidden – The requested organizer/event does not exist or you have no permission to view this resource.
404 Not Found – The requested order does not exist.

GET /api/v1/organizers/(organizer)/events/(event)/orders/(code)/payments/(local_id)/¶

Returns information on one payment, identified by its order-local ID.

Example request:

GET /api/v1/organizers/bigevents/events/sampleconf/orders/ABC12/payments/1/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
  "local_id": 1,
  "state": "confirmed",
  "amount": "23.00",
  "created": "2017-12-01T10:00:00Z",
  "payment_date": "2017-12-04T12:13:12Z",
  "payment_url": null,
  "details": {},
  "provider": "banktransfer"
}

Parameters:

organizer – The slug field of the organizer to fetch
event – The slug field of the event to fetch
code – The code field of the order to fetch
local_id – The local_id field of the payment to fetch

Status Codes:

200 OK – no error
401 Unauthorized – Authentication failure
403 Forbidden – The requested organizer/event does not exist or you have no permission to view this resource.
404 Not Found – The requested order or payment does not exist.

POST /api/v1/organizers/(organizer)/events/(event)/orders/(code)/payments/(local_id)/confirm/¶

Marks a payment as confirmed. Only allowed in states pending and created.

Example request:

POST /api/v1/organizers/bigevents/events/sampleconf/orders/ABC12/payments/1/confirm/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript
Content-Type: application/json

{
    "send_email": true,
    "force": false
}

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
  "local_id": 1,
  "state": "confirmed",
  ...
}

Parameters:

organizer – The slug field of the organizer to fetch
event – The slug field of the event to fetch
code – The code field of the order to fetch
local_id – The local_id field of the payment to modify

Status Codes:

200 OK – no error
400 Bad Request – Invalid request or payment state
401 Unauthorized – Authentication failure
403 Forbidden – The requested organizer/event does not exist or you have no permission to view this resource.
404 Not Found – The requested order or payment does not exist.

POST /api/v1/organizers/(organizer)/events/(event)/orders/(code)/payments/(local_id)/cancel/¶

Marks a payment as canceled. Only allowed in states pending and created.

Example request:

POST /api/v1/organizers/bigevents/events/sampleconf/orders/ABC12/payments/1/cancel/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
  "local_id": 1,
  "state": "canceled",
  ...
}

Parameters:

organizer – The slug field of the organizer to fetch
event – The slug field of the event to fetch
code – The code field of the order to fetch
local_id – The local_id field of the payment to modify

Status Codes:

200 OK – no error
400 Bad Request – Invalid request or payment state
401 Unauthorized – Authentication failure
403 Forbidden – The requested organizer/event does not exist or you have no permission to view this resource.
404 Not Found – The requested order or payment does not exist.

POST /api/v1/organizers/(organizer)/events/(event)/orders/(code)/payments/(local_id)/refund/¶

Create and execute a manual refund. Only available in confirmed state. Returns a refund resource, not a payment resource!

Example request:

POST /api/v1/organizers/bigevents/events/sampleconf/orders/ABC12/payments/1/refund/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript
Content-Type: application/json

{
  "amount": "23.00",
  "mark_canceled": false
}

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
  "local_id": 1,
  "source": "admin",
  "state": "done",
  ...
}

Parameters:

organizer – The slug field of the organizer to fetch
event – The slug field of the event to fetch
code – The code field of the order to fetch
local_id – The local_id field of the payment to modify

Status Codes:

200 OK – no error
400 Bad Request – Invalid request, payment state, or operation not supported by the payment provider
401 Unauthorized – Authentication failure
403 Forbidden – The requested organizer/event does not exist or you have no permission to view this resource.
404 Not Found – The requested order or payment does not exist.

POST /api/v1/organizers/(organizer)/events/(event)/orders/(code)/payments/¶

Creates a new payment.

Be careful with the info parameter: You can pass a nested JSON object that will be set as the internal info value of the payment object that will be created. How this value is handled is up to the payment provider and you should only use this if you know the specific payment provider in detail. Please keep in mind that the payment provider will not be called to do anything about this (i.e. if you pass a bank account to a debit provider, no charge will be created), this is just informative in case you handled the payment already.

Example request:

POST /api/v1/organizers/bigevents/events/sampleconf/orders/ABC12/payments/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript
Content-Type: application/json

{
  "state": "confirmed",
  "amount": "23.00",
  "payment_date": "2017-12-04T12:13:12Z",
  "info": {},
  "send_email": false,
  "provider": "banktransfer"
}

Example response:

HTTP/1.1 201 Created
Vary: Accept
Content-Type: application/json

{
  "local_id": 1,
  "state": "confirmed",
  "amount": "23.00",
  "created": "2017-12-01T10:00:00Z",
  "payment_date": "2017-12-04T12:13:12Z",
  "payment_url": null,
  "details": {},
  "provider": "banktransfer"
}

Parameters:

organizer – The slug field of the organizer to access
event – The slug field of the event to access
order – The code field of the order to access

Status Codes:

201 Created – no error
401 Unauthorized – Authentication failure
403 Forbidden – The requested organizer/event does not exist or you have no permission to view this resource.
404 Not Found – The requested order does not exist.

Order refund endpoints¶

GET /api/v1/organizers/(organizer)/events/(event)/orders/(code)/refunds/¶

Returns a list of all refunds for an order.

Example request:

GET /api/v1/organizers/bigevents/events/sampleconf/orders/ABC12/refunds/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "local_id": 1,
      "state": "done",
      "source": "admin",
      "amount": "23.00",
      "payment": 1,
      "created": "2017-12-01T10:00:00Z",
      "execution_date": "2017-12-04T12:13:12Z",
      "comment": "Cancellation",
      "details": {},
      "provider": "banktransfer"
    }
  ]
}

Query Parameters:

page (integer) – The page number in case of a multi-page result set, default is 1

Parameters:

organizer – The slug field of the organizer to fetch
event – The slug field of the event to fetch
order – The code field of the order to fetch

Status Codes:

200 OK – no error
401 Unauthorized – Authentication failure
403 Forbidden – The requested organizer/event does not exist or you have no permission to view this resource.
404 Not Found – The requested order does not exist.

GET /api/v1/organizers/(organizer)/events/(event)/orders/(code)/refunds/(local_id)/¶

Returns information on one refund, identified by its order-local ID.

Example request:

GET /api/v1/organizers/bigevents/events/sampleconf/orders/ABC12/refunds/1/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
  "local_id": 1,
  "state": "done",
  "source": "admin",
  "amount": "23.00",
  "payment": 1,
  "created": "2017-12-01T10:00:00Z",
  "execution_date": "2017-12-04T12:13:12Z",
  "comment": "Cancellation",
  "details": {},
  "provider": "banktransfer"
}

Parameters:

organizer – The slug field of the organizer to fetch
event – The slug field of the event to fetch
code – The code field of the order to fetch
local_id – The local_id field of the refund to fetch

Status Codes:

200 OK – no error
401 Unauthorized – Authentication failure
403 Forbidden – The requested organizer/event does not exist or you have no permission to view this resource.
404 Not Found – The requested order or refund does not exist.

POST /api/v1/organizers/(organizer)/events/(event)/orders/(code)/refunds/¶

Creates a refund manually.

Warning

We recommend to only use this endpoint for refunds with payment provider manual. This endpoint also does not check for mismatching amounts etc. Be careful!

Example request:

POST /api/v1/organizers/bigevents/events/sampleconf/orders/ABC12/refunds/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript
Content-Type: application/json

{
  "state": "created",
  "source": "admin",
  "amount": "23.00",
  "payment": 1,
  "execution_date": null,
  "comment": "Cancellation",
  "provider": "manual",
  "mark_canceled": false,
  "mark_pending": true
}

Example response:

HTTP/1.1 201 Created
Vary: Accept
Content-Type: application/json

{
  "local_id": 1,
  "state": "created",
  "source": "admin",
  "amount": "23.00",
  "payment": 1,
  "created": "2017-12-01T10:00:00Z",
  "execution_date": null,
  "comment": "Cancellation",
  "details": {},
  "provider": "manual"
}

Query Parameters:

page (integer) – The page number in case of a multi-page result set, default is 1

Parameters:

organizer – The slug field of the organizer to fetch
event – The slug field of the event to fetch
order – The code field of the order to fetch

Status Codes:

200 OK – no error
400 Bad Request – Invalid data supplied
401 Unauthorized – Authentication failure
403 Forbidden – The requested organizer/event does not exist or you have no permission to view this resource.
404 Not Found – The requested order does not exist.

POST /api/v1/organizers/(organizer)/events/(event)/orders/(code)/refunds/(local_id)/done/¶

Marks a refund as completed. Only allowed in states transit and created.

Example request:

POST /api/v1/organizers/bigevents/events/sampleconf/orders/ABC12/refunds/1/done/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
  "local_id": 1,
  "state": "done",
  ....
}

Parameters:

organizer – The slug field of the organizer to fetch
event – The slug field of the event to fetch
code – The code field of the order to fetch
local_id – The local_id field of the refund to modify

Status Codes:

200 OK – no error
400 Bad Request – Invalid request or refund state
401 Unauthorized – Authentication failure
403 Forbidden – The requested organizer/event does not exist or you have no permission to view this resource.
404 Not Found – The requested order or refund does not exist.

POST /api/v1/organizers/(organizer)/events/(event)/orders/(code)/refunds/(local_id)/process/¶

Acts on an external refund, either marks the order as canceled or pending. Only allowed in state external.

Example request:

POST /api/v1/organizers/bigevents/events/sampleconf/orders/ABC12/refunds/1/done/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript
Content-Type: application/json

{"mark_canceled": false}

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
  "local_id": 1,
  "state": "done",
  ....
}

Parameters:

organizer – The slug field of the organizer to fetch
event – The slug field of the event to fetch
code – The code field of the order to fetch
local_id – The local_id field of the refund to modify

Status Codes:

200 OK – no error
400 Bad Request – Invalid request or refund state
401 Unauthorized – Authentication failure
403 Forbidden – The requested organizer/event does not exist or you have no permission to view this resource.
404 Not Found – The requested order or refund does not exist.

POST /api/v1/organizers/(organizer)/events/(event)/orders/(code)/refunds/(local_id)/cancel/¶

Marks a refund as canceled. Only allowed in states transit, external, and created.

Example request:

POST /api/v1/organizers/bigevents/events/sampleconf/orders/ABC12/refunds/1/cancel/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
  "local_id": 1,
  "state": "canceled",
  ....
}

Parameters:

organizer – The slug field of the organizer to fetch
event – The slug field of the event to fetch
code – The code field of the order to fetch
local_id – The local_id field of the refund to modify

Status Codes:

200 OK – no error
400 Bad Request – Invalid request or refund state
401 Unauthorized – Authentication failure
403 Forbidden – The requested organizer/event does not exist or you have no permission to view this resource.
404 Not Found – The requested order or refund does not exist.

Revoked ticket secrets¶

With some non-default ticket secret generation methods, a list of revoked ticket secrets is required for proper validation.

GET /api/v1/organizers/(organizer)/events/(event)/revokedsecrets/¶

Returns a list of all revoked secrets within a given event.

Example request:

GET /api/v1/organizers/bigevents/events/sampleconf/revokedsecrets/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json
X-Page-Generated: 2017-12-01T10:00:00Z

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 1234,
      "secret": "k24fiuwvu8kxz3y1",
      "created": "2017-12-01T10:00:00Z",
    }
  ]
}

Query Parameters:

page (integer) – The page number in case of a multi-page result set, default is 1
ordering (string) – Manually set the ordering of results. Valid fields to be used are secret and created. Default: -created
created_since (datetime) – Only return revocations that have been created since the given date.

Parameters:

organizer – The slug field of the organizer to fetch
event – The slug field of the event to fetch

Response Headers:

X-Page-Generated – The server time at the beginning of the operation. If you’re using this API to fetch differences, this is the value you want to use as created_since in your next call.

Status Codes:

200 OK – no error
401 Unauthorized – Authentication failure
403 Forbidden – The requested organizer/event does not exist or you have no permission to view this resource.

Blocked ticket secrets¶

With some non-default ticket secret generation methods, a list of blocked ticket secrets is required for proper validation. This endpoint returns all secrets that are currently blocked or have been blocked before and are now unblocked, so be sure to check the blocked attribute for its actual value. The list is currently always ordered with the most recently updated ones first.

GET /api/v1/organizers/(organizer)/events/(event)/blockedsecrets/¶

Returns a list of all blocked or historically blocked secrets within a given event.

Example request:

GET /api/v1/organizers/bigevents/events/sampleconf/blockedsecrets/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json
X-Page-Generated: 2017-12-01T10:00:00Z

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 1234,
      "secret": "k24fiuwvu8kxz3y1",
      "blocked": true,
      "updated": "2017-12-01T10:00:00Z",
    }
  ]
}

Query Parameters:

page (integer) – The page number in case of a multi-page result set, default is 1
updated_since (datetime) – Only return records that have been updated since the given date.
blocked (boolean) – Only return blocked / non-blocked records.

Parameters:

organizer – The slug field of the organizer to fetch
event – The slug field of the event to fetch

Response Headers:

X-Page-Generated – The server time at the beginning of the operation. If you’re using this API to fetch differences, this is the value you want to use as updated_since in your next call.

Status Codes:

200 OK – no error
401 Unauthorized – Authentication failure
403 Forbidden – The requested organizer/event does not exist or you have no permission to view this resource.