mirror of
https://github.com/pretix/pretix.git
synced 2025-12-23 17:02:26 +00:00
94be46ffdb
- [x] attendee names - [x] Invoice address names - [x] Data migration - [x] API serializers - [x] orderposition - [x] cartposition - [x] invoiceaddress - [x] checkinlistposition - [x] position API search - [x] invoice API search - [x] business/individual required toggle - [x] Split columns in CSV exports - [x] ticket editor - [x] shredder - [x] ticket/invoice sample data - [x] order search - [x] Handle changed naming scheme - [x] tests - [x] make use in: - [x] Boabee - [x] Certificate download order - [x] Badge download order - [x] Ticket download order - [x] Document new MySQL requirement - [x] Plugins
265 lines
9.6 KiB
ReStructuredText
265 lines
9.6 KiB
ReStructuredText
.. _rest-carts:
|
|
|
|
Cart positions
|
|
==============
|
|
|
|
The API provides limited access to the cart position data model. This API currently only allows creating and deleting
|
|
cart positions to reserve quota.
|
|
|
|
Cart position resource
|
|
----------------------
|
|
|
|
The cart position resource contains the following public fields:
|
|
|
|
.. rst-class:: rest-resource-table
|
|
|
|
===================================== ========================== =======================================================
|
|
Field Type Description
|
|
===================================== ========================== =======================================================
|
|
id integer Internal ID of the cart position
|
|
cart_id string Identifier of the cart this belongs to. Needs to end
|
|
in "@api" for API-created positions.
|
|
datetime datetime Time of creation
|
|
expires datetime The cart position will expire at this time and no longer block quota
|
|
item integer ID of the item
|
|
variation integer ID of the 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 Composition of attendee name (i.e. first name, last name, …)
|
|
attendee_email string Specified attendee email address for this position (or ``null``)
|
|
voucher integer Internal ID of the voucher used for this position (or ``null``)
|
|
addon_to integer Internal ID of the position this position is an add-on for (or ``null``)
|
|
subevent integer ID of the date inside an event series this position belongs to (or ``null``).
|
|
answers list of objects Answers to user-defined questions
|
|
├ question integer Internal ID of the answered question
|
|
├ answer string Text representation of the answer
|
|
├ question_identifier string The question's ``identifier`` field
|
|
├ options list of integers Internal IDs of selected option(s)s (only for choice types)
|
|
└ option_identifiers list of strings The ``identifier`` fields of the selected option(s)s
|
|
===================================== ========================== =======================================================
|
|
|
|
.. versionchanged:: 1.17
|
|
|
|
This resource has been added.
|
|
|
|
|
|
Cart position endpoints
|
|
-----------------------
|
|
|
|
.. http:get:: /api/v1/organizers/(organizer)/events/(event)/cartpositions/
|
|
|
|
Returns a list of API-created cart positions.
|
|
|
|
**Example request**:
|
|
|
|
.. sourcecode:: http
|
|
|
|
GET /api/v1/organizers/bigevents/events/sampleconf/cartpositions/ HTTP/1.1
|
|
Host: pretix.eu
|
|
Accept: application/json, text/javascript
|
|
|
|
**Example response**:
|
|
|
|
.. sourcecode:: http
|
|
|
|
HTTP/1.1 200 OK
|
|
Vary: Accept
|
|
Content-Type: application/json
|
|
X-Page-Generated: 2017-12-01T10:00:00Z
|
|
|
|
{
|
|
"count": 1,
|
|
"next": null,
|
|
"previous": null,
|
|
"results": [
|
|
{
|
|
"id": 1,
|
|
"cart_id": "XwokV8FojQviD9jhtDzKvHFdlLRNMhlfo3cNjGbuK6MUTQDT@api",
|
|
"item": 1,
|
|
"variation": null,
|
|
"price": "23.00",
|
|
"attendee_name": null,
|
|
"attendee_name_parts": {},
|
|
"attendee_email": null,
|
|
"voucher": null,
|
|
"addon_to": null,
|
|
"subevent": null,
|
|
"datetime": "2018-06-11T10:00:00Z",
|
|
"expires": "2018-06-11T10:00:00Z",
|
|
"includes_tax": true,
|
|
"answers": []
|
|
}
|
|
]
|
|
}
|
|
|
|
:query integer page: The page number in case of a multi-page result set, default is 1
|
|
:statuscode 200: no error
|
|
:statuscode 401: Authentication failure
|
|
:statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
|
|
|
|
.. http:get:: /api/v1/organizers/(organizer)/events/(event)/cartpositions/(id)/
|
|
|
|
Returns information on one cart position, identified by its internal ID.
|
|
|
|
**Example request**:
|
|
|
|
.. sourcecode:: http
|
|
|
|
GET /api/v1/organizers/bigevents/events/sampleconf/cartpositions/1/ HTTP/1.1
|
|
Host: pretix.eu
|
|
Accept: application/json, text/javascript
|
|
|
|
**Example response**:
|
|
|
|
.. sourcecode:: http
|
|
|
|
HTTP/1.1 200 OK
|
|
Vary: Accept
|
|
Content-Type: application/json
|
|
|
|
{
|
|
"id": 1,
|
|
"cart_id": "XwokV8FojQviD9jhtDzKvHFdlLRNMhlfo3cNjGbuK6MUTQDT@api",
|
|
"item": 1,
|
|
"variation": null,
|
|
"price": "23.00",
|
|
"attendee_name": null,
|
|
"attendee_name_parts": {},
|
|
"attendee_email": null,
|
|
"voucher": null,
|
|
"addon_to": null,
|
|
"subevent": null,
|
|
"datetime": "2018-06-11T10:00:00Z",
|
|
"expires": "2018-06-11T10:00:00Z",
|
|
"includes_tax": true,
|
|
"answers": []
|
|
}
|
|
|
|
:param organizer: The ``slug`` field of the organizer to fetch
|
|
:param event: The ``slug`` field of the event to fetch
|
|
:param id: The ``id`` field of the position to fetch
|
|
:statuscode 200: no error
|
|
:statuscode 401: Authentication failure
|
|
:statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
|
|
:statuscode 404: The requested cart position does not exist.
|
|
|
|
.. http:post:: /api/v1/organizers/(organizer)/events/(event)/cartpositions/
|
|
|
|
Creates a new cart position.
|
|
|
|
.. warning:: This endpoint is considered **experimental**. It might change at any time without prior notice.
|
|
|
|
.. warning::
|
|
|
|
This endpoint is intended for advanced users. It is not designed to be used to build your own shop frontend.
|
|
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 a cart 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 the event's ticket sales are already over or haven't started
|
|
|
|
* does not support add-on products at the moment
|
|
|
|
* does not check or calculate prices but believes any prices you send
|
|
|
|
* does not support the redemption of vouchers
|
|
|
|
* does not prevent you from buying items that can only be bought with a voucher
|
|
|
|
* does not support file upload questions
|
|
|
|
You can supply the following fields of the resource:
|
|
|
|
* ``cart_id`` (optional, needs to end in ``@api``)
|
|
* ``item``
|
|
* ``variation`` (optional)
|
|
* ``price``
|
|
* ``attendee_name`` **or** ``attendee_name_parts`` (optional)
|
|
* ``attendee_email`` (optional)
|
|
* ``subevent`` (optional)
|
|
* ``expires`` (optional)
|
|
* ``includes_tax`` (optional)
|
|
* ``answers``
|
|
|
|
* ``question``
|
|
* ``answer``
|
|
* ``options``
|
|
|
|
**Example request**:
|
|
|
|
.. sourcecode:: http
|
|
|
|
POST /api/v1/organizers/bigevents/events/sampleconf/cartpositions/ HTTP/1.1
|
|
Host: pretix.eu
|
|
Accept: application/json, text/javascript
|
|
Content: application/json
|
|
|
|
{
|
|
"item": 1,
|
|
"variation": null,
|
|
"price": "23.00",
|
|
"attendee_name_parts": {
|
|
"given_name": "Peter",
|
|
"family_name": "Miller"
|
|
},
|
|
"attendee_email": null,
|
|
"answers": [
|
|
{
|
|
"question": 1,
|
|
"answer": "23",
|
|
"options": []
|
|
}
|
|
],
|
|
"subevent": null
|
|
}
|
|
|
|
**Example response**:
|
|
|
|
.. sourcecode:: http
|
|
|
|
HTTP/1.1 201 Created
|
|
Vary: Accept
|
|
Content-Type: application/json
|
|
|
|
(Full cart position resource, see above.)
|
|
|
|
:param organizer: The ``slug`` field of the organizer of the event to create a position for
|
|
:param event: The ``slug`` field of the event to create a position for
|
|
:statuscode 201: no error
|
|
:statuscode 400: The item could not be created due to invalid submitted data or lack of quota.
|
|
:statuscode 401: Authentication failure
|
|
:statuscode 403: The requested organizer/event does not exist **or** you have no permission to create this
|
|
order.
|
|
|
|
.. http:delete:: /api/v1/organizers/(organizer)/events/(event)/cartpositions/(id)/
|
|
|
|
Deletes a cart position, identified by its internal ID.
|
|
|
|
**Example request**:
|
|
|
|
.. sourcecode:: http
|
|
|
|
DELETE /api/v1/organizers/bigevents/events/sampleconf/cartpositions/1/ HTTP/1.1
|
|
Host: pretix.eu
|
|
Accept: application/json, text/javascript
|
|
|
|
**Example response**:
|
|
|
|
.. sourcecode:: http
|
|
|
|
HTTP/1.1 204 No Content
|
|
Vary: Accept
|
|
Content-Type: application/json
|
|
|
|
:param organizer: The ``slug`` field of the organizer to fetch
|
|
:param event: The ``slug`` field of the event to fetch
|
|
:param id: The ``id`` field of the position to delete
|
|
:statuscode 200: no error
|
|
:statuscode 401: Authentication failure
|
|
:statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
|
|
:statuscode 404: The requested cart position does not exist.
|