Tickets

Tickets are created when creating an order with products.

A valid ticket grants you access to an event.

Retrieve a single ticket

Retrieve the details of a single order using a ticket reference.

Authentication

The retrieval of a ticket can be authenticated in multiple ways.

  • Basic access authorization: The application must have permission to access the order associated with this ticket.

  • Cognito token: The user represented by the token must be the creator of the order associated with this ticket.

Response

Field name

Type

Description

uid

String

A machine readable id for this ticket, used in communication with the API.

code

String

Barcode printed on (e)ticket.

consumer

Ticket consumer

A ticket consumer object, representing the personal ticket information.

seating

Seating

Ticket seating object, representing the information about seat physical location.

subproduct

I18N

Subproduct (entrance) title.

has_valid_subscription

Boolean

True when the ticket requires a subscription to be valid, and a subscription for this ticket is active.

needs_personalization

Boolean

True when the ticket needs to be personalized

personalization_start

Datetime

The date and time that the personalization for this ticket started.

personalization_end

Datetime

The date and time that the personalization for this ticket will end. After this point in time, ticket consumer information can no longer be POSTed via Consumers.

price

Amount

The price of a ticket. For tickets transferred for free, they present the value before transferring.

service_fee_paid

Amount

How much of a service cost the fan paid for this ticket. Null if the ticket’s order is not completed yet.

fulfillment_starts_at

Datetime

In case delayed fulfillment is set for the ticket’s event, this is the date and time of it.

scannable_until

Datetime

The date and time after which the ticket cannot be scanned.

Embedded resources

  • shop:product: the product that was purchased, see Product.

  • shop:secondary_sales: A title and reference for one or more channels this ticket can be offered to. See Transfer Approvals.

Example

[GET] https://shopping-api.paylogic.com/tickets/cba40d60019448278542c9f5ac1bf7ce
{
    "_links": {
        "self": {
            "href": "https://shopping-api.paylogic.com/tickets/90842034646f49c99882eb99a13fa2e9"
        },
        "shop:event": {
            "href": "https://shopping-api.paylogic.com/events/8e3df2124072459994bd9423257cc5ce"
        },
        "shop:parent": {
            "href": "https://shopping-api.paylogic.com/tickets/4676fd8719c8439f88cb1561431aac5f"
        },
        "shop:product": {
            "href": "https://shopping-api.paylogic.com/products/4a8f0a6caa874d80acff3834da9bc124"
        },
        "shop:order": {
            "href": "https://shopping-api.paylogic.com/orders/4f6cc8bea3ac4cfeb6b41a09bfd80c74"
        },
        "profile": {
            "href": "https://shopping-api-docs.paylogic.com/documentation/tickets.html",
            "type": "text/html"
        },
        "shop:eticket": {
            "href": "https://download.paylogic.nl/download/eticket/rbF2L_04EGkeswtfqLWsGnvQR-v1Ppi4tpp-oGVHG3s"
        },
        "shop:provided_subscription": {
            "href": "https://shopping-api.paylogic.com/subscriptions/e75f9114efd841bbaa34c1efc126e575"
        },
        "shop:personalization_request": [],
        "shop:ticket_transfer_approvals": {
            "href": "https://shopping-api.paylogic.com/ticket-transfer-approvals"
        },
        "curies": [
            {
                "href": "https://shopping-api-docs.paylogic.com/documentation/{rel}.html",
                "type": "text/html",
                "name": "shop",
                "templated": true
            }
        ]
    },
    "uid": "90842034646f49c99882eb99a13fa2e9",
    "seating": {
        "seat": "",
        "row": "",
        "section": "",
        "seat_label": {"de": "", "en": "", "es": "", "fr": "", "nl": "", "pt": "", "tr": ""},
        "row_label": {"de": "", "en": "", "es": "", "fr": "", "nl": "", "pt": "", "tr": ""},
        "section_label": {"de": "", "en": "", "es": "", "fr": "", "nl": "", "pt": "", "tr": ""},
        "venue": {"de": "", "en": "", "es": "", "fr": "", "nl": "", "pt": "", "tr": ""}
    },
    "has_valid_subscription": false,
    "is_scanned": false,
    "status": "valid",
    "needs_personalization": false,
    "personalization_start": null,
    "personalization_end": null,
    "personalization_form": {
        "gender": {
            "required": true
        },
        "first_name": {
            "required": true
        },
        "last_name": {
            "required": true
        },
        "date_of_birth": {
            "required": true
        },
        "email": {
            "required": true,
            "unique_per_product": false
        }
    },
    "subproduct": {"de": "", "en": "", "es": "", "fr": "", "nl": "", "pt": "", "tr": ""},
    "consumer": {
        "first_name": "Blaise",
        "last_name": "Test",
        "date_of_birth": "1970-01-01",
        "email": "blaise.kal+bravoure@seetickets.nl",
        "phone_number": "",
        "gender": 1,
        "address": "Sesamstraat 123",
        "postal_code": "1234AA",
        "city": "Amsterdam",
        "country": "NL",
        "state": "",
        "realm": null,
        "language": null
    },
    "service_fee_paid": {
        "currency": "EUR",
        "amount": "0.45"
    },
    "fulfillment_starts_at": "2020-11-03T08:00:00Z",
    "_embedded": {
        "shop:product": {
            "_links": {
                "curies": [
                    {
                        "href": "https://shopping-api-docs.paylogic.com/documentation/{rel}.html",
                        "name": "shop",
                        "templated": true,
                        "type": "text/html"
                    }
                ],
                "profile": {
                    "href": "https://shopping-api-docs.paylogic.com/documentation/product.html",
                    "type": "text/html"
                },
                "self": {
                    "href": "https://shopping-api.paylogic.com/products/4a8f0a6caa874d80acff3834da9bc124"
                },
                "shop:event": {
                    "href": "https://shopping-api.paylogic.com/events/8e3df2124072459994bd9423257cc5ce"
                }
            },
            "additional_information": {"de": "", "en": "", "es": "", "fr": "", "nl": "", "pt": "", "tr": ""},
            "availability": 0,
            "total_availability": 200,
            "combo": null,
            "min_per_order": 1,
            "max_per_order": 20,
            "name": {"de": "", "en": "Product Name", "es": "", "fr": "", "nl": "Productnaam", "pt": "", "tr": ""},
            "subtitle": {"de": "", "en": "", "es": "", "fr": "", "nl": "", "pt": "", "tr": ""},
            "parents": null,
            "price": {
                "amount": "10.00",
                "currency": "EUR"
            },
            "reference": "1669",
            "sale_end": "2021-11-30T20:59:00Z",
            "sale_start": "2011-11-30T22:24:00Z",
            "separately_saleable": true,
            "sold_out_text": {"de": "", "en": "", "es": "", "fr": "", "nl": "", "pt": "", "tr": ""},
            "types": [],
            "uid": "f0d8de67992e49d39bb9d0e818aba1fb",
            "viewing_order": 1,
            "requires_membership": false,
            "provides_membership": true
        },
        "shop:transfer_sale": [
            {
                "_links": {
                    "self": {"href": "https://shopping-api.paylogic.com/sales/19567973c6df449082286821ecc5ab10"}
                },
                "channel": {
                    "title": {"de": "", "en": "Waiting List", "es": "", "fr": "", "nl": "Wachtlijst", "pt": "", "tr": ""}
                }
            }
        ],
    },
}

Retrieve a ticket by barcode

Use Basic access authorization to authenticate this request.

Required parameters

Parameter

Description

code

Barcode of the ticket

event

Event reference

Example

[GET] https://shopping-api.paylogic.com/tickets?code=8663092874786&event=https://shopping-api.paylogic.com/events/5b3e9744999d4d0ca56b4c5ca1f4dc49
{
    "_links": {
        "self": {
            "href": "https://shopping-api.paylogic.com/tickets"
        },
        "search": {
            "href": "https://shopping-api.paylogic.com/{?event,code}",
            "templated": true
        },
        "profile": {
            "href": "https://shopping-api-docs.paylogic.com/documentation/tickets.html",
            "type": "text/html"
        },
        "curies": [
            {
                "href": "https://shopping-api-docs.paylogic.com/documentation/{rel}.html",
                "name": "shop",
                "templated": true,
                "type": "text/html"
            }
        ]
    },
    "_embedded": {
        "shop:ticket": [
            // See "Embedded resources" above.
            // For historic reasons, this is a list containing a single ticket.
        ]
    }
}

Retrieve all tickets for a Cognito user

Retrieve all tickets that are personalized by this Cognito user. Note that this does not include tickets for orders owned by this Cognito user.

Use a Cognito token to authenticate this request.

Embedded resources

All embedded resources in this response contain a subset of the available data per ticket. Retrieve a single ticket to get the complete data.

  • shop:ticket: all tickets this Cognito user personalized. Retrieve the self link to get all data of this ticket. See Ticket.

  • shop:product: products of these tickets. See Product.

  • shop:event: events of these tickets. See Event.

Example

[GET] https://shopping-api.paylogic.com/tickets
{
    "_links": {
        "self": {
            "href": "https://shopping-api.paylogic.com/tickets"
        },
        "profile": {
            "href": "https://shopping-api-docs.paylogic.com/documentation/tickets.html",
            "type": "text/html"
        },
        "curies": [
            {
                "href": "https://shopping-api-docs.paylogic.com/documentation/{rel}.html",
                "type": "text/html",
                "name": "shop",
                "templated": true
            }
        ]
    },
    "_embedded": {
        "shop:ticket": [
            {
                "_links": {
                    "profile": {
                        "href": "https://shopping-api-docs.paylogic.com/documentation/tickets.html",
                        "type": "text/html"
                    },
                    "self": {
                        "href": "https://shopping-api.paylogic.com/tickets/90842034646f49c99882eb99a13fa2e9"
                    },
                    "shop:event": {
                        "href": "https://shopping-api.paylogic.com/events/8e3df2124072459994bd9423257cc5ce"
                    },
                    "shop:product": {
                        "href": "https://shopping-api.paylogic.com/products/4a8f0a6caa874d80acff3834da9bc124"
                    },
                    "shop:order": {
                        "href": "https://shopping-api.paylogic.com/orders/4f6cc8bea3ac4cfeb6b41a09bfd80c74"
                    },
                    "curies": [
                        {
                            "href": "https://shopping-api-docs.paylogic.com/documentation/{rel}.html",
                            "type": "text/html",
                            "name": "shop",
                            "templated": true
                        }
                    ]
                },
                "uid": "90842034646f49c99882eb99a13fa2e9",
                "status": "valid",
                "has_valid_subscription": false
            }
        ],
        "shop:product": [
            {
                "_links": {
                    "self": {
                        "href": "https://shopping-api.paylogic.com/products/4a8f0a6caa874d80acff3834da9bc124"
                    }
                },
                "uid": "4a8f0a6caa874d80acff3834da9bc124",
                "name": {
                    "fr": "Membership",
                    "en": "Membership",
                    "nl": "Lidmaatschap",
                    "pt": "",
                    "de": "Membership",
                    "tr": "",
                    "es": "Membership"
                },
                "subtitle": {
                    "fr": "",
                    "en": "",
                    "nl": "",
                    "pt": "",
                    "de": "",
                    "tr": "",
                    "es": ""
                }
            }
        ],
        "shop:event": [
            {
                "_links": {
                    "self": {
                        "href": "https://shopping-api.paylogic.com/events/8e3df2124072459994bd9423257cc5ce"
                    }
                },
                "uid": "8e3df2124072459994bd9423257cc5ce",
                "title": {
                    "fr": "Seventies LIVE",
                    "en": "Seventies LIVE",
                    "nl": "Seventies LIVE",
                    "pt": "Seventies LIVE",
                    "de": "Seventies LIVE",
                    "tr": "Seventies LIVE",
                    "es": "Seventies LIVE"
                },
                "subtitle": {
                    "fr": "Open 20:00",
                    "en": "Open 20:00",
                    "nl": "Open 20:00",
                    "pt": "Open 20:00",
                    "de": "Open 20:00",
                    "tr": "Open 20:00",
                    "es": "Open 20:00"
                },
                "event_start": "2022-03-01T19:00:00Z",
                "event_end": "2022-03-01T22:59:00Z",
                "location": {
                    "name": "Paradiso - Kleine zaal",
                    "postal_code": "",
                    "country": "NL",
                    "city": "Amsterdam",
                    "latitude": null,
                    "longitude": null
                }
            }
        ]
    }
}

See also

Get all tickets of an order

Retrieve a single order to retrieve all tickets belonging to an order.

Transfer a ticket to someone else

See Transfer Approvals

Personalizing or claiming a ticket

See Personalization