Get Ticket | NaviPartner | NP Retail API Documentation

1 curl -G https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%2520International%2520Ltd./ticket/12345678-1234-1234-1234-123456789012 \ 2 -H "x-np-api-key: <NaviPartner API Key>" \ 3 -d storeCode=EN \ 4 -d withAccessHistory=true \ 5 -d withAccessHistoryDetails=true

1 { 2 "ticketId": "12345678-1234-1234-1234-123456789012", 3 "ticketNumber": "TICKET123", 4 "reservationToken": "ABC123456DEF789GHI", 5 "itemNumber": "31001", 6 "validFrom": "2024-10-15T00:00:00Z", 7 "validUntil": "2025-10-14T23:59:59Z", 8 "issuedAt": "2024-10-15T12:13:00Z", 9 "blocked": false, 10 "content": [ 11 { 12 "admissionDetails": { 13 "capacityControl": "sales", 14 "code": "CASTLE", 15 "default": true, 16 "description": { 17 "title": "Castle Museum Entrance", 18 "subtitle": "Adult Castle Ticket", 19 "name": "Explore the Castle", 20 "description": "Access to the castle exhibit", 21 "fullDescription": "Experience the grandeur of the castle's architecture and marvel at its intricate details. Walk through beautifully decorated rooms and admire the stunning artwork and furniture on display." 22 }, 23 "included": "mandatory" 24 }, 25 "scheduleDetails": { 26 "externalNumber": 452, 27 "code": "MORNING", 28 "startDate": "2024-10-15", 29 "startTime": "09:00", 30 "endDate": "2024-10-15", 31 "endTime": "12:00", 32 "duration": 10800, 33 "description": "Morning schedule", 34 "arrivalFromTime": "08:30", 35 "arrivalUntilTime": "10:00" 36 } 37 } 38 ], 39 "description": { 40 "title": "Castle Museum Entrance", 41 "subtitle": "Adult Castle Ticket", 42 "name": "Explore History", 43 "description": "Access to all castle exhibits", 44 "fullDescription": "Step back in time and immerse yourself in the rich history of our castle museum. Discover fascinating artifacts, explore grand halls, and learn about the lives of the people who once lived within these walls. Experience the grandeur of the castle's architecture and marvel at its intricate details. Walk through beautifully decorated rooms and admire the stunning artwork and furniture on display. Join a guided tour to gain deeper insights into the castle's history and hear captivating stories about its past. Learn about the battles fought, the royal inhabitants, and the secrets that lie hidden within these ancient walls." 45 }, 46 "pinCode": "12-34", 47 "unitPrice": 80, 48 "unitPriceInclVat": 100, 49 "currencyCode": "DKK", 50 "ticketHolder": "John Doe", 51 "ticketHolderLanguage": "ENU", 52 "notificationAddress": "john@acme.com", 53 "printCount": 1, 54 "printedAt": "2024-10-15T12:00:00Z", 55 "accessHistory": [ 56 { 57 "admissionCode": "CASTLE", 58 "firstAdmissionAt": "2025-01-31T09:12:00Z", 59 "events": [ 60 { 61 "event": "admitted", 62 "eventAt": "2025-01-31T09:12:00Z" 63 }, 64 { 65 "event": "departed", 66 "eventAt": "2025-01-31T12:47:00Z" 67 } 68 ] 69 } 70 ] 71 }

Retrieves detailed information about a specific ticket using its unique ticketId. Admission content and descriptions are always included. Use withAccessHistory to include summarized access history and withAccessHistoryDetails to additionally include event-level access history.

Authentication

x-np-api-keystring

API Key authentication via header

Path parameters

tenantstringRequired

Your Entra Tenant ID. More details.

environmentstringRequired

Your Business Central Environment. More details.

companystringRequired

Your Business Central Company. More details.

ticketIdUUIDRequired

The unique identifier of a ticket

Query parameters

storeCodestringOptional

A unique identifier for a store - a logical grouping defining a subset of ticket items. This is used to filter the list of ticket items returned by the API. When left empty, the API will use the default store code.

withAccessHistorybooleanOptional

withAccessHistoryDetailsbooleanOptional

Response

This endpoint returns an object.

ticketIdUUID

The unique identifier of a ticket

ticketNumberstring

The unique identifier of a ticket

reservationTokenstring

A unique token that identifies a ticket reservation

itemNumberstring

An item or product number defined in the ticketing system

validFromdatetime

validUntildatetime

issuedAtdatetime

The date and time when the ticket was issued

blockedboolean

contentlist of objects

descriptionobject

Descriptive information about a ticket item. The source of these fields are configurable.

pinCodestring or null

A pin code for the ticket, used for validation when rescheduling or revoking a confirmed ticket

unitPricedouble or null

unitPriceInclVatdouble or null

currencyCodestring or null

ticketHolderstring or null

The name of the person holding the ticket(s)

ticketHolderLanguagestring or null

The language code the ticket holder wants to receive notifications in.

notificationAddressstring or null

The email address or mobile phone number to send tickets and notifications to

printCountinteger or null

printedAtdatetime or null

accessHistorylist of objects or null

Authentication

Path parameters

Headers

Query parameters

Response