***** Event ***** An event contains all data of the event. An event will only be available if it is currently enabled for sale by the merchant. Accepted methods ================ * **GET**: Retrieve the details of a single event. Accepted query parameters ========================= None. Data ==== ========================= ============================================ ============================================================ Field name Type Description ========================= ============================================ ============================================================ uid String A machine readable id for this event, used in communication with the API. reference String A human readable id for this event, used in communication with consumers. merchant_name String Name of the merchant title :doc:`/objects/i18n` Title of the event. subtitle :doc:`/objects/i18n` Subtitle of the event. sale_start Datetime The date and time that the sale for this event has started. sale_end Datetime The date and time that the sale for this event will end. After this point in time tickets can no longer be bought for this event. event_start Datetime The start date and time of the event. event_end Datetime The end date and time of the event. personalization_start Datetime The date and time that the personalization for this event started. personalization_end Datetime The date and time that the personalization for this event will end. After this point in time, ticket consumer information can no longer be POSTed via :doc:`consumers`. fulfillment_starts_at Datetime The date and time when the fulfillment for this event starts. In case delayed fulfillment is not set up, this is null. location :doc:`/objects/location` A location object, describing where the event will take place. facilities :doc:`/objects/facilities` A facilities object, describing all facilities present at the event. description :doc:`/objects/i18n` A description of the event, as entered by the merchant. long_description :doc:`/objects/i18n` A longer description of the event, as entered by the merchant. image URL The absolute URL of an image for this event. artists :doc:`/objects/i18n` A list of artists that will perform at this event. sold_out_text :doc:`/objects/i18n` A text with more information, which can be shown when the event is sold out. min_quantity_per_order Integer The minimum amount of products that have to be in a single order for the purchase to be valid. max_quantity_per_order Integer The maximum number of products that can be bought in a single order for this event. opt_in :doc:`/objects/opt_in` Opt-in configuration for this event. uses_discounts Boolean Whether this event uses discounts. tracking_tags List of :doc:`/objects/tracking_tag_item` A list of tracking tag items. ========================= ============================================ ============================================================ Link relations ============== * :doc:`events`: The list of events for a merchant that this event is part of. * :doc:`products`: Products available for this event. * :doc:`tickets`: Find a ticket for this event with the specified barcode. * :doc:`ticketshop`: Paylogic’s ticketshop for this event. Embedded resources ================== * :doc:`Product (list) `: Products available for this event, embedded here for ease of use. Example representation ====================== .. code-block:: bash [GET] https://shopping-api.paylogic.com/events/0c2019503cd666fb35c5a3dbd7bafe86 .. code-block:: javascript { "_links": { "self": { "href": "https://shopping-api.paylogic.com/events/0c2019503cd666fb35c5a3dbd7bafe86" }, "curies": [{ "name": "shop", "href": "https://shopping-api-docs.paylogic.com/documentation/{rel}.html", "templated": true, "type": "text/html" }], "profile": { "href": "https://shopping-api-docs.paylogic.com/documentation/event.html", "type": "text/html" }, "shop:event": { "href": "https://shopping-api.paylogic.com/events" }, "shop:product": { "href": "https://shopping-api.paylogic.com/products?event=https://shopping-api.paylogic.com/events/0c2019503cd666fb35c5a3dbd7bafe86" }, "shop:ticketshop": { "href": "https://frontoffice.paylogic.nl/?event_id=36890&point_of_sale_id=13996", "type": "text/html" } "shop:tickets": { "href": "https://shopping-api.paylogic.com/tickets?event=https://shopping-api.paylogic.com/events/0c2019503cd666fb35c5a3dbd7bafe86&code={barcode}" "templated": true, }, }, "uid": "0c2019503cd666fb35c5a3dbd7bafe86", "reference": "321749", "merchant_name": {"en": "Ms. Christiana Lesch events", "nl": "", "de": "", "fr": "", "es": "", "pt": "", "tr": "", "ru": ""}, "title": {"en": "Paylogic in Concert 2014", "nl": "Paylogic in concert 2014", "de": "", "fr": "", "es": "", "pt": "", "tr": "", "ru": ""}, "subtitle": {"en": "Live from Groningen", "nl": "Live uit Groningen", "de": "", "fr": "", "es": "", "pt": "", "tr": "", "ru": ""}, "sale_start": "2014-01-28T20:27:16Z", "sale_end": "2014-06-09T17:27:16Z", "event_start": "2014-06-10T20:27:16Z", "event_end": "2014-06-11T05:27:16Z", "personalization_start": "2014-01-28T20:27:16Z", "personalization_end": "2014-06-09T17:27:16Z", "location": { "name": {"en": "Vera", "nl": "", "de": "", "fr": "", "es": "", "pt": "", "tr": "", "ru": ""}, "postal_code": "9711 NV", "country": "NL", "city": {"en": "Groningen", "nl": "", "de": "", "fr": "", "es": "", "pt": "", "tr": "", "ru": ""} }, "facilities": { "is_indoor": false, "is_outdoor": false, "number_of_visitors": 7600, "event_homepage": "http://www.nu.nl", "door_policy_and_dresscode": {"en": "Ut maiores labore quia ut.", "nl": "", "de": "", "fr": "", "es": "", "pt": "", "tr": "", "ru": ""}, "additional_information": {"en": "Officia voluptas quia.", "nl": "", "de": "", "fr": "", "es": "", "pt": "", "tr": "", "ru": ""}, "wardrobe_and_lockers_description": {"en": "Officia voluptas quia.", "nl": "", "de": "", "fr": "", "es": "", "pt": "", "tr": "", "ru": ""}, "has_wardrobe": false, "has_lockers": true, "accessibility": {"en": "Nemo dolores ad", "nl": "", "de": "", "fr": "", "es": "", "pt": "", "tr": "", "ru": ""}, "accessible": false, "requires_id": false, "minimum_age": 23 }, "description": {"en": "Nemo dolores ad", "nl": "", "de": "", "fr": "", "es": "", "pt": "", "tr": "", "ru": ""}, "long_description": {"en": "Nemo dolores ad", "nl": "", "de": "", "fr": "", "es": "", "pt": "", "tr": "", "ru": ""}, "max_quantity_per_order": 10, "min_quantity_per_order": 1, "image": "http://example.com/img.jpg", "artists": ["Van Dik Hout", "Nena", "Bon Jovi"], "sold_out": false, "sold_out_text": {"en": "Paylogic in Concert 2014 sold out! Join us in next year’s edition!", "nl": "", "de": "", "fr": "", "es": "", "pt": "", "tr": "", "ru": ""}, "opt_in": { "default": false, "text": {"en": "I would like to receive the newsletter", "nl": "", "de": "", "fr": "", "es": "", "pt": "", "tr": "", "ru": ""} }, "opt_in_2": { "default": false, "text": {"en": "I would like to receive marketing from selected partners", "nl": "", "de": "", "fr": "", "es": "", "pt": "", "tr": "", "ru": ""} }, "uses_discounts": false, "tracking_tags": [ { "name": "_mid", "is_eu_cookie_law": false, "value": "2" }, { "name": "setoptin", "is_eu_cookie_law": true, "value": "1" } ], "_embedded": { "shop:product": [ // ... ] } }