Item variations

Resource description

Variations of items can be use for products (items) that are available in different sizes, colors or other variations of the same product. The variations resource contains the following public fields:

Field

Type

Description

id

integer

Internal ID of the variation

default_price

money (string)

The price set directly for this variation or null

price

money (string)

The price used for this variation. This is either the same as default_price if that value is set or equal to the item’s default_price (read-only).

original_price

money (string)

An original price, shown for comparison, not used for price calculations (or null).

active

boolean

If false, this variation will not be sold or shown.

description

multi-lingual string

A public description of the variation. May contain Markdown syntax or can be null.

position

integer

An integer, used for sorting

require_membership

boolean

If true, booking this variation requires an active membership.

require_membership_hidden

boolean

If true and require_membership is set, this variation will be hidden from users without a valid membership.

require_membership_types

list of integers

Internal IDs of membership types valid if require_membership is true

sales_channels

list of strings

Sales channels this variation is available on, such as "web" or "resellers". Defaults to all existing sales channels. The item-level list takes precedence, i.e. a sales channel needs to be on both lists for the item to be available.

available_from

datetime

The first date time at which this variation can be bought (or null).

available_until

datetime

The last date time at which this variation can be bought (or null).

hide_without_voucher

boolean

If true, this variation is only shown during the voucher redemption process, but not in the normal shop frontend.

Endpoints

GET /api/v1/organizers/(organizer)/events/(event)/items/(item)/variations/

Returns a list of all variations for a given item.

Example request:

GET /api/v1/organizers/bigevents/events/sampleconf/items/11/variations/ 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": 2,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 1,
      "value": {
        "en": "S"
      },
      "active": true,
      "require_membership": false,
      "require_membership_hidden": false,
      "require_membership_types": [],
      "sales_channels": ["web"],
      "available_from": null,
      "available_until": null,
      "hide_without_voucher": false,
      "description": {
        "en": "Test2"
      },
      "position": 0,
      "default_price": "223.00",
      "price": 223.0,
      "original_price": null,
    },
    {
      "id": 3,
      "value": {
        "en": "L"
      },
      "active": true,
      "require_membership": false,
      "require_membership_hidden": false,
      "require_membership_types": [],
      "description": {},
      "position": 1,
      "default_price": null,
      "price": 15.0
    }
  ]
}
Query Parameters
  • page (integer) – The page number in case of a multi-page result set, default is 1

  • active (boolean) – If set to true or false, only items with this value for the field active will be returned.

Parameters
  • organizer – The slug field of the organizer to fetch

  • event – The slug field of the event to fetch

  • item – The id field of the item to fetch

Status Codes
  • 200 OK – no error

  • 401 Unauthorized – Authentication failure

  • 403 Forbidden – The requested organizer/event/item does not exist or you have no permission to view this resource.

GET /api/v1/organizers/(organizer)/events/(event)/items/(item)/variations/(id)/

Returns information on one variation, identified by its ID.

Example request:

GET /api/v1/organizers/bigevents/events/sampleconf/items/1/variations/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

{
  "id": 3,
  "value": {
        "en": "Student"
  },
  "default_price": "10.00",
  "price": "10.00",
  "original_price": null,
  "active": true,
  "require_membership": false,
  "require_membership_hidden": false,
  "require_membership_types": [],
  "sales_channels": ["web"],
  "available_from": null,
  "available_until": null,
  "hide_without_voucher": false,
  "description": null,
  "position": 0
}
Parameters
  • organizer – The slug field of the organizer to fetch

  • event – The slug field of the event to fetch

  • item – The id field of the item to fetch

  • id – The id field of the variation 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.

POST /api/v1/organizers/(organizer)/events/(event)/items/(item)/variations/

Creates a new variation

Example request:

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

{
  "value": {"en": "Student"},
  "default_price": "10.00",
  "active": true,
  "require_membership": false,
  "require_membership_hidden": false,
  "require_membership_types": [],
  "sales_channels": ["web"],
  "available_from": null,
  "available_until": null,
  "hide_without_voucher": false,
  "description": null,
  "position": 0
}

Example response:

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

{
  "id": 1,
  "value": {"en": "Student"},
  "default_price": "10.00",
  "price": "10.00",
  "original_price": null,
  "active": true,
  "require_membership": false,
  "require_membership_hidden": false,
  "require_membership_types": [],
  "sales_channels": ["web"],
  "available_from": null,
  "available_until": null,
  "hide_without_voucher": false,
  "description": null,
  "position": 0
}
Parameters
  • organizer – The slug field of the organizer of the event/item to create a variation for

  • event – The slug field of the event to create a variation for

  • item – The id field of the item to create a variation for

Status Codes
PATCH /api/v1/organizers/(organizer)/events/(event)/items/(item)/variations/(id)/

Update a variation. You can also use PUT instead of PATCH. With PUT, you have to provide all fields of the resource, other fields will be reset to default. With PATCH, you only need to provide the fields that you want to change.

You can change all fields of the resource except the id and the price field.

Example request:

PATCH /api/v1/organizers/bigevents/events/sampleconf/items/1/variations/1/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript
Content-Type: application/json
Content-Length: 94

{
  "active": false,
  "position": 1
}

Example response:

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

{
  "id": 1,
  "value": {"en": "Student"},
  "default_price": "10.00",
  "price": "10.00",
  "original_price": null,
  "active": false,
  "require_membership": false,
  "require_membership_hidden": false,
  "require_membership_types": [],
  "sales_channels": ["web"],
  "available_from": null,
  "available_until": null,
  "hide_without_voucher": false,
  "description": null,
  "position": 1
}
Parameters
  • organizer – The slug field of the organizer to modify

  • event – The slug field of the event to modify

  • id – The id field of the item to modify

  • id – The id field of the variation to modify

Status Codes
  • 200 OK – no error

  • 400 Bad Request – The variation could not be modified due to invalid submitted data

  • 401 Unauthorized – Authentication failure

  • 403 Forbidden – The requested organizer/event does not exist or you have no permission to change this resource.

DELETE /api/v1/organizers/(organizer)/events/(event)/items/(id)/variations/(id)/

Delete a variation.

Example request:

DELETE /api/v1/organizers/bigevents/events/sampleconf/items/1/variations/1/ 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

  • id – The id field of the item to modify

  • id – The id field of the variation to delete

Status Codes