[UNRELEASED] Beneficiary requirements
In some cases, you will need to enter the details of the ticket beneficiaries to download the tickets in PDF format. You will gather this information when you retrieve the order. More specifically, in the order.items[].tickets[].requiredBeneficiaryFields section, let's take the example below:
{
"@context": "/contexts/BookingOrder",
"@id": "/v1/booking/orders/0197cb40-0a9a-772d-9c06-94f4ebf74643",
"@type": "BookingOrder",
"id": "0197cb40-0a9a-772d-9c06-94f4ebf74643",
"createdAt": "2025-07-02T13:07:41+00:00",
"catalog": "/v1/ticketing/catalogs/0196f2ef-c0de-7456-ac8e-8e2479c54aa5",
"organization": "/v1/organizations/0194d07e-aa39-71a8-9d45-bba145a85838",
"reference": "KTOLKT-84A749",
"externalReference": "TEST",
"connectorReference": "3875",
"totalAmountInclTax": "80.00",
"totalAmountExclTax": "75.83",
"reservation": "/v1/booking/reservations/0197cb3f-f1dd-7246-9660-d1613775333f",
"customer": {
"@type": "OrderCustomer",
"@id": "/.well-known/genid/659ea7d58fe6d29dcf2e",
"firstname": "test",
"lastname": "test",
"email": "[email protected]",
"phone": "0610203040",
"optin": false,
"country": "FR",
"language": "fr",
"title": "mx"
},
"status": "confirmed",
"cancelledAt": null,
"items": [
{
"@type": "OrderItem",
"@id": "/.well-known/genid/132ddf0cb624270e4245",
"unitAmountInclTax": "80.00",
"unitAmountExclTax": "75.83",
"quantity": 1,
"totalAmountInclTax": "80.00",
"totalAmountExclTax": "75.83",
"id": "0197cb40-0a99-7351-8a73-3278b4978671",
"amountInclTax": "80.00",
"amountExclTax": "75.83",
"date": "2026-01-18",
"product": "/v1/ticketing/catalogs/0196f2ef-c0de-7456-ac8e-8e2479c54aa5/products/0197c022-3988-7006-83a2-94a34daeec03",
"tickets": [
{
"@type": "OrderItemTicketResource",
"@id": "/v1/booking/orders/0197cb40-0a9a-772d-9c06-94f4ebf74643/items/0197cb40-0a99-7351-8a73-3278b4978671/tickets/0197cb40-0a99-7351-8a73-3278b40b0cbc",
"id": "0197cb40-0a99-7351-8a73-3278b40b0cbc",
"voucher": "8555400800002783",
"occursAt": "2026-01-18T21:00:00+01:00",
"event": "/v1/ticketing/catalogs/0196f2ef-c0de-7456-ac8e-8e2479c54aa5/events/0197c01f-8978-7ba9-991e-a81443ee9d8c",
"requiredBeneficiaryFields": [
"firstname",
"lastname"
],
"beneficiary": null
}
]
}
],
"documents": [
"/v1/booking/orders/0197cb40-0a9a-772d-9c06-94f4ebf74643/documents/0197cb40-0a9a-772d-9c06-94f4ebf9f433"
]
}here we can see that the ticket /v1/booking/orders/0197cb40-0a9a-772d-9c06-94f4ebf74643/items/0197cb40-0a99-7351-8a73-3278b4978671/tickets/0197cb40-0a99-7351-8a73-3278b40b0cbc requires the first and last name of the beneficiary. It will therefore be necessary to provide us with this information.