Skip to main content

Update Endorsement

Update endorsement information for booking. This endpoint allows updating endorsement details specifically for VN system bookings.


Endpoint

  • URL: /api/v1/flight/updateendorsement
  • Method: POST
  • Auth Required: Yes (Bearer Token/X-API-KEY)
  • Content-Type: application/json

Authentication

This endpoint requires a valid JWT Bearer token in the Authorization header:

Authorization: Bearer <access_token>

Obtain tokens via /api/v1/sign-in (POST) with your credentials.


Request Structure

FieldTypeRequiredDescription
systemstringNoBooking system code (e.g., VN, VJ, 1A)
bookingCodestringNoBooking code (PNR)
endorsementstringNoEndorsement content to update
endorsementsarrayNoList of endorsements to update (see EndorsementInfo)

EndorsementInfo Object

FieldTypeRequiredDescription
indexstringNoSegment order to update (from booking face FE PAX line)
endorsementstringNoEndorsement value to update

Example Request:

{
"system": "VN",
"bookingCode": "ABC123",
"endorsement": "NON-REFUNDABLE/NON-ENDORSABLE"
}

Request Constraints & Business Rules

  • This endpoint is only applicable for VN system bookings.
  • The booking must exist and be in a valid state for endorsement updates.
  • Endorsement content must follow airline-specific formatting requirements.
  • Only certain booking statuses allow endorsement modifications.
  • Endorsement updates are logged for audit and compliance purposes.
  • Some endorsement types may have restrictions based on fare rules.

Response Structure

FieldTypeNullableDescription
systemstringYesSystem name (e.g., VN, VJ, 1A)
statusbooleanNotrue if successful, false if failed
errorobjectYesError details (if any)
descriptionstringYesError description (if any)
trackingIdstringYesTracking ID for request logs
trackingTimestringYesTime for request tracking (ISO 8601 format)

Error Object

FieldTypeNullableDescription
idintegerNoError code ID
messagestringYesError message

Example Response:

{
"system": "VN",
"status": true,
"error": null,
"description": null,
"trackingId": "abc-123",
"trackingTime": "2024-06-01T12:00:00Z"
}

Error Codes

See Error Codes for details on possible error responses.


Security & Validation

  • All input is validated for type and required fields.
  • Only authenticated users can access this endpoint.
  • Booking codes are verified against existing bookings.
  • Endorsement content is validated for proper format and compliance.
  • All endorsement updates are logged and traceable.
  • Access control ensures only authorized users can modify endorsements.

Validation Questions

  • What are the standard endorsement formats accepted by VN system?
  • Are there restrictions on endorsement updates based on booking status?
  • How are endorsement changes reflected in issued tickets?
  • Can endorsements be removed or only updated?

For integration support, see Contact Support.