Get Reservation — NaviPartner | NP Retail API Documentation

Retrieves the current details of an existing reservation using its token. This endpoint allows clients to check the status, contents, and expiration time of a reservation, whether it’s registered or confirmed.

Path parameters

tenantstringRequired

Your Entra Tenant ID. More details.

environmentstringRequired

Your Business Central Environment. More details.

companystringRequired

Your Business Central Company. More details.

tokenstringRequired

A unique token that identifies a ticket reservation

Headers

x-api-versiondateOptional

Used for API versioning. More details.

Response

This endpoint returns an object.

tokenstring

A unique token that identifies a ticket reservation

reservationStatusenum

Allowed values: registeredconfirmedcanceledexpired

The status of the reservation

reservationslist of objects

expiresAtdatetimeOptional

The date and time when the token expires and reservation is no longer valid

1 curl https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%20International%20Ltd./ticket/reservation/ABC123456DEF789GHI

1 { 2 "token": "ABC123456DEF789GHI", 3 "reservationStatus": "registered", 4 "reservations": [ 5 { 6 "itemNumber": "31001", 7 "quantity": 2, 8 "ticket": { 9 "validFrom": "2024-10-15T00:00:00Z", 10 "validUntil": "2024-10-15T23:59:59Z", 11 "unitPrice": 80, 12 "unitPriceInclVat": 100, 13 "currencyCode": "DKK" 14 }, 15 "content": [ 16 { 17 "admissionDetails": { 18 "capacityControl": "sales", 19 "code": "CASTLE", 20 "default": true, 21 "included": "mandatory", 22 "description": { 23 "title": "Castle Museum Entrance", 24 "subtitle": "Adult Castle Ticket", 25 "name": "Explore the Castle", 26 "description": "<b>Access</b> to the castle exhibit", 27 "fullDescription": "<p>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.</p>" 28 }, 29 "scheduleDetails": { 30 "id": 452, 31 "code": "MORNING", 32 "startDate": "2024-10-15", 33 "startTime": "09:00", 34 "endDate": "2024-10-15", 35 "endTime": "12:00", 36 "duration": "3 hours", 37 "description": "Morning schedule", 38 "arrivalFromTime": "08:30", 39 "arrivalUntilTime": "10:00" 40 } 41 } 42 } 43 ] 44 } 45 ], 46 "expiresAt": "2024-10-11T12:13:00Z" 47 }

1	{
2	"token": "ABC123456DEF789GHI",
3	"reservationStatus": "registered",
4	"reservations": [
5	{
6	"itemNumber": "31001",
7	"quantity": 2,
8	"ticket": {
9	"validFrom": "2024-10-15T00:00:00Z",
10	"validUntil": "2024-10-15T23:59:59Z",
11	"unitPrice": 80,
12	"unitPriceInclVat": 100,
13	"currencyCode": "DKK"
14	},
15	"content": [
16	{
17	"admissionDetails": {
18	"capacityControl": "sales",
19	"code": "CASTLE",
20	"default": true,
21	"included": "mandatory",
22	"description": {
23	"title": "Castle Museum Entrance",
24	"subtitle": "Adult Castle Ticket",
25	"name": "Explore the Castle",
26	"description": "<b>Access</b> to the castle exhibit",
27	"fullDescription": "<p>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.</p>"
28	},
29	"scheduleDetails": {
30	"id": 452,
31	"code": "MORNING",
32	"startDate": "2024-10-15",
33	"startTime": "09:00",
34	"endDate": "2024-10-15",
35	"endTime": "12:00",
36	"duration": "3 hours",
37	"description": "Morning schedule",
38	"arrivalFromTime": "08:30",
39	"arrivalUntilTime": "10:00"
40	}
41	}
42	}
43	]
44	}
45	],
46	"expiresAt": "2024-10-11T12:13:00Z"
47	}