Find Ticket | NaviPartner | NP Retail API Documentation

1 curl -G https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%2520International%2520Ltd./ticket \ 2 -H "x-np-api-key: <NaviPartner API Key>" \ 3 --data-urlencode externalNumbers=TICKET123,TICKET124 \ 4 -d withAdmissionContent=true \ 5 -d withAccessHistoryDetails=true \ 6 -d activeOnly=true

1 [ 2 { 3 "ticketId": "12345678-1234-1234-1234-123456789012", 4 "ticketNumber": "TICKET123", 5 "reservationToken": "ABC123456DEF789GHI", 6 "itemNumber": "31001", 7 "validFrom": "2024-10-15T00:00:00Z", 8 "validUntil": "2025-10-14T23:59:59Z", 9 "issuedAt": "2024-10-15T12:13:00Z", 10 "blocked": false, 11 "pinCode": "12-34", 12 "unitPrice": 80, 13 "unitPriceInclVat": 100, 14 "currencyCode": "DKK", 15 "ticketHolder": "John Doe", 16 "ticketHolderLanguage": "ENU", 17 "notificationAddress": "john@acme.com", 18 "printCount": 1, 19 "printedAt": "2024-10-15T12:00:00Z", 20 "content": [ 21 { 22 "admissionDetails": { 23 "capacityControl": "sales", 24 "code": "CASTLE", 25 "default": true, 26 "description": { 27 "title": "Castle Museum Entrance", 28 "subtitle": "Adult Castle Ticket", 29 "name": "Explore the Castle", 30 "description": "Access to the castle exhibit", 31 "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." 32 }, 33 "included": "mandatory" 34 }, 35 "scheduleDetails": { 36 "externalNumber": 452, 37 "code": "MORNING", 38 "startDate": "2024-10-15", 39 "startTime": "09:00", 40 "endDate": "2024-10-15", 41 "endTime": "12:00", 42 "duration": 10800, 43 "description": "Morning schedule", 44 "arrivalFromTime": "08:30", 45 "arrivalUntilTime": "10:00" 46 } 47 } 48 ], 49 "description": { 50 "title": "Castle Museum Entrance", 51 "subtitle": "Adult Castle Ticket", 52 "name": "Explore History", 53 "description": "Access to all castle exhibits", 54 "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." 55 }, 56 "accessHistory": [ 57 { 58 "admissionCode": "CASTLE", 59 "firstAdmissionAt": "2025-01-31T09:12:00Z", 60 "events": [ 61 { 62 "event": "admitted", 63 "eventAt": "2025-01-31T09:12:00Z" 64 }, 65 { 66 "event": "departed", 67 "eventAt": "2025-01-31T12:47:00Z" 68 } 69 ] 70 } 71 ] 72 } 73 ]

Retrieves ticket id and access details about a specific ticket or list of tickets, depending on which query parameter is used. If the value is not found, an empty list is returned. In case when a list of external numbers is provided, all matching tickets are returned, including duplicates. Tickets not found are omitted from the result. Leading and trailing spaces are ignored in the provided ticket numbers.
Exactly one of ticketId, externalNumbers or notificationAddress must be provided.

- Filter using ticketId, externalNumbers or notificationAddress to get a specific ticket or a list of tickets.
- Use externalNumbers to find multiple tickets by their external numbers. (Separate the ticket number with a comma).
- Admission content and item descriptions can be included with withAdmissionContent.
- Access history summary is always included; use withAccessHistoryDetails to also include event-level events.
- activeOnly controls whether blocked/expired tickets are filtered out (defaults to true when omitted).

Retrieves ticket id and access details about a specific ticket or list of tickets, depending on which query parameter is used. If the value is not found, an empty list is returned. In case when a list of external numbers is provided, all matching tickets are returned, including duplicates. Tickets not found are omitted from the result. Leading and trailing spaces are ignored in the provided ticket numbers. Exactly one of `ticketId`, `externalNumbers` or `notificationAddress` must be provided. - Filter using `ticketId`, `externalNumbers` or `notificationAddress` to get a specific ticket or a list of tickets. - Use `externalNumbers` to find multiple tickets by their external numbers. (Separate the ticket number with a comma). - Admission content and item descriptions can be included with `withAdmissionContent`. - Access history summary is always included; use `withAccessHistoryDetails` to also include event-level events. - `activeOnly` controls whether blocked/expired tickets are filtered out (defaults to `true` when omitted).

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.

Query parameters

externalNumbersstringOptional

A list of unique identifiers of tickets, separated by commas

ticketIdUUIDOptional

The unique identifier of a ticket

notificationAddressstringOptional

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

withAdmissionContentbooleanOptional

withAccessHistoryDetailsbooleanOptional

activeOnlybooleanOptional

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.

Response

This endpoint returns a list of objects.

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

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

contentlist of objects or null

descriptionobject or null

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

accessHistorylist of objects or null

Authentication

Path parameters

Headers

Query parameters

Response