Update Reservation

PUT

https://api.npretail.app/:tenant/:environment/:company/ticket/reservation/:token

PUT

/:tenant/:environment/:company/ticket/reservation/:token

curl -X PUT https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%2520International%2520Ltd./ticket/reservation/ABC123456DEF789GHI \
     -H "x-np-api-key: <NaviPartner API Key>" \
     -H "Content-Type: application/json" \
     -d '{
  "reserve": [
    {
      "itemNumber": "31001",
      "quantity": 3,
      "content": [
        {
          "admissionCode": "CASTLE",
          "scheduleNumber": 452
        }
      ]
    }
  ]
}'

200Updated

{
  "token": "ABC123456DEF789GHI",
  "reservationStatus": "registered",
  "expiresAt": "2024-10-11T12:13:00Z",
  "reservations": [
    {
      "itemNumber": "31001",
      "quantity": 3,
      "lineId": "819647d5-9d69-492e-8bb5-87799bfbf179",
      "ticket": {
        "ticketKind": "individualAdmission",
        "validFrom": "2024-10-15T00:00:00Z",
        "validUntil": "2024-10-15T23:59:59Z",
        "issuedAt": "2024-10-15T12:13:00Z",
        "blocked": false,
        "unitPrice": 80,
        "unitPriceInclVat": 100,
        "currencyCode": "DKK"
      },
      "content": [
        {
          "admissionDetails": {
            "capacityControl": "sales",
            "code": "CASTLE",
            "default": true,
            "description": {
              "title": "Castle Museum Entrance",
              "subtitle": "Adult Castle Ticket",
              "name": "Explore the Castle",
              "description": "<b>Access</b> to the castle exhibit",
              "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>"
            },
            "included": "mandatory"
          },
          "scheduleDetails": {
            "code": "MORNING",
            "duration": 10800,
            "endDate": "2024-10-15",
            "endTime": "12:00",
            "externalNumber": 452,
            "startDate": "2024-10-15",
            "startTime": "09:00",
            "arrivalFromTime": "08:30",
            "arrivalUntilTime": "10:00",
            "description": "Morning schedule"
          }
        }
      ]
    }
  ]
}

Modifies an existing reservation identified by a token. This endpoint replaces the current reservation details with new ones provided in the request, such as changing quantities or items. Useful for adjusting reservations before confirmation, ensuring that held tickets are updated and previous allocations are released.

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.

tokenstringRequired

A unique token that identifies a ticket reservation

Query parameters

includeTicketNumbersbooleanOptional

Indicates whether ticket numbers should be included in reservation responses. Tickets are normally included only when the reservation is confirmed. If true, ticket numbers are returned regardless of reservation status. When a reservation is updated, any previously disclosed ticket numbers are removed. This affects ticket numbers only; pinCode and ticketHolder are returned only once the reservation is confirmed.

Request

This endpoint expects an object.

reservelist of objectsRequired

Response

This endpoint returns an object.

tokenstring

A unique token that identifies a ticket reservation

reservationStatusenum

The status of the reservation

expiresAtdatetimeOptional

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

reservationslist of objectsOptional

Authentication

Path parameters

Headers

Query parameters

Request

Response