openapi: 3.2.0 info: title: NewSkies-Digital-Api Trip API version: 4.8.6.23 description: Navitaire Digital Api servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground security: - JWT: [] tags: - name: trip paths: /api/nsk/v5/trip: post: tags: - trip summary: Creates a new booking with the provided journeys, contacts, passengers, and SSRs. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: tripCreatev5' operationId: nsk_v5_trip_post parameters: - name: syncPassengerAndTravelDocGender in: query description: "Indicates whether to synchronize the passenger and all its travel\ndocuments' gender. This will update the gender of all the travel documents in the\npassengers[passengerKey].travelDocuments list in the booking model. The value defaults to true if not specified.\n " schema: type: boolean default: true x-position: 2 requestBody: x-name: request description: The booking sell request. content: application/json: schema: $ref: '#/components/schemas/BookingSellRequest' required: true x-position: 1 responses: '201': description: Created. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBooking' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Passenger type not allowed for infant in lap.: description: Example when attempting to add an infant in lap to a passenger type that is not allowed. value: errors: - id: 305fe78c-03e9-4c68-a8f8-5841b5dc6a10 code: nsk:Passenger:PassengerTypeNotAllowedForInfantInLap message: Passenger with type CHD is not allowed to have an infant in lap. type: Validation details: null rawMessage: Passenger with type CHD is not allowed to have an infant in lap. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null No POST request body.: description: Example when making a call without a request body. value: errors: - id: 5560684d-8fa9-47f1-b2f6-ebe6380d5b69 code: nsk:Exceptions:Null message: An unexpected null value of type 'BookingSellRequest'. type: Validation details: null rawMessage: An unexpected null value of type 'BookingSellRequest'. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v4/trip: post: tags: - trip summary: Creates a new booking with the provided journeys, contacts, passengers, and SSRs. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: tripCreatev4' operationId: nsk_v4_trip_post requestBody: x-name: request description: The booking sell request. content: application/json: schema: $ref: '#/components/schemas/BookingSellRequest' required: true x-position: 1 responses: '201': description: Created. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBooking' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true /api/nsk/v1/trip/{legKey}/seats/{unitKey}/properties: get: tags: - trip summary: BETA - Retrieves inventory seat properties for a given flight leg and unit key. description: 'This is a beta endpoint and is not currently a long term supported endpoint. This endpoint may be removed in future updates. Beta endpoints are not available in all labs or for all customers of the API. GraphQL endpoint: inventorySeatProperties' operationId: nsk_v1_trip_legKey_seats_unitKey_properties_get parameters: - name: legKey in: path required: true description: The flight leg to retrieve the properties for. schema: type: string x-position: 1 - name: unitKey in: path required: true description: The unit key to retrieve the properties for. schema: type: string x-position: 2 - name: compartmentDesignator in: query description: The compartment to retrieve the seat properties for. schema: type: - string - 'null' x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIDictionaryOfStringAndListOfInventorySeatPropertyBase' examples: Default: description: '' value: data: tlYhNTY5NSEgITYzODMwMzY4NTAwMDAwMDAwMCFTTEMhREVOITFBIVk-: - code: RECLINER value: 'TRUE' tlYhNTY5NSEgITYzODMwMzY4NTAwMDAwMDAwMCFTTEMhREVOITJBIVk-: - code: AVAILC value: 'TRUE' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Default: description: '' value: errors: - id: null code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: null rawMessage: The identifier 'legKey' with value 'X' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null post: tags: - trip summary: BETA - Creates an inventory seat property for a given flight leg and unit key. description: 'This is a beta endpoint and is not currently a long term supported endpoint. This endpoint may be removed in future updates. Beta endpoints are not available in all labs or for all customers of the API. GraphQL endpoint: inventorySeatPropertiesAdd' operationId: nsk_v1_trip_legKey_seats_unitKey_properties_post parameters: - name: legKey in: path required: true description: The leg key to modify the properties for. schema: type: string x-position: 1 - name: unitKey in: path required: true description: The unit key to modify the properties for. schema: type: string x-position: 2 requestBody: x-name: property description: The property to create. content: application/json: schema: $ref: '#/components/schemas/InventorySeatPropertyBase' examples: Default: description: The code and value on the request are required and are case-insensitive. value: code: WINDOW value: 'TRUE' required: true x-position: 3 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Default: description: '' value: errors: - id: null code: nsk:InventorySeatProperties:InventorySeatPropertyCommitFailed message: nsk:InventorySeatProperties:InventorySeatPropertyCommitFailed type: Error details: null rawMessage: 'Inventory seat properties were not committed due to the following: Check if requested property code ''WINDOW'' and value ''TRUE'' is an active inventory property in setup. No inventory seat property to commit.' exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null put: tags: - trip summary: BETA - Updates an inventory seat property for a given flight leg and unit key. description: 'This is a beta endpoint and is not currently a long term supported endpoint. This endpoint may be removed in future updates. Beta endpoints are not available in all labs or for all customers of the API. GraphQL endpoint: inventorySeatPropertiesSet' operationId: nsk_v1_trip_legKey_seats_unitKey_properties_put parameters: - name: legKey in: path required: true description: The leg key to update the properties for. schema: type: string x-position: 1 - name: unitKey in: path required: true description: The unit key to update the properties for. schema: type: string x-position: 2 requestBody: x-name: property description: The properties to update. content: application/json: schema: $ref: '#/components/schemas/InventorySeatPropertyBase' examples: Default: description: The code and value on the request are required and are case-insensitive. value: code: WINDOW value: 'TRUE' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Default: description: '' value: errors: - id: null code: nsk:InventorySeatProperties:InventorySeatPropertyCommitFailed message: nsk:InventorySeatProperties:InventorySeatPropertyCommitFailed type: Error details: null rawMessage: 'Inventory seat properties were not committed due to the following: Check if requested property code ''WINDOW'' and value ''TRUE'' is an active inventory property in setup. No inventory seat property to commit.' exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null delete: tags: - trip summary: BETA - Deletes an inventory seat property for a given flight leg and unit key. description: 'This is a beta endpoint and is not currently a long term supported endpoint. This endpoint may be removed in future updates. Beta endpoints are not available in all labs or for all customers of the API. GraphQL endpoint: inventorySeatPropertiesDelete' operationId: nsk_v1_trip_legKey_seats_unitKey_properties_delete parameters: - name: legKey in: path required: true description: The leg key to delete the properties for. schema: type: string x-position: 1 - name: unitKey in: path required: true description: The unit key to delete the properties for. schema: type: string x-position: 2 requestBody: x-name: property description: The property to delete. content: application/json: schema: $ref: '#/components/schemas/InventorySeatPropertyBase' examples: Default: description: The code and value on the request are required and are case-insensitive. value: code: WINDOW value: 'TRUE' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Default: description: '' value: errors: - id: null code: nsk:InventorySeatProperties:InventorySeatPropertyCommitFailed message: nsk:InventorySeatProperties:InventorySeatPropertyCommitFailed type: Error details: null rawMessage: 'Inventory seat properties were not committed due to the following: Check if requested property code ''WINDOW'' and value ''TRUE'' is an active inventory property in setup. No inventory seat property to commit.' exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v1/trip/{legKey}/seats/properties: get: tags: - trip summary: BETA - Retrieves inventory seat properties for a given flight leg. description: 'This is a beta endpoint and is not currently a long term supported endpoint. This endpoint may be removed in future updates. Beta endpoints are not available in all labs or for all customers of the API. GraphQL endpoint: inventorySeatPropertiesByLeg' operationId: nsk_v1_trip_legKey_seats_properties_get parameters: - name: legKey in: path required: true description: The flight leg to retrieve the properties for. schema: type: string x-position: 1 - name: compartmentDesignator in: query description: The compartment to retrieve the seat properties for. schema: type: - string - 'null' x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIDictionaryOfStringAndListOfInventorySeatPropertyBase' examples: Default: description: '' value: data: tlYhNTY5NSEgITYzODMwMzY4NTAwMDAwMDAwMCFTTEMhREVOITFBIVk-: - code: RECLINER value: 'TRUE' tlYhNTY5NSEgITYzODMwMzY4NTAwMDAwMDAwMCFTTEMhREVOITJBIVk-: - code: AVAILC value: 'TRUE' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Default: description: '' value: errors: - id: null code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: null rawMessage: The identifier 'legKey' with value 'X' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v1/trip/contacts: post: tags: - trip summary: Creates a new contacts-only booking. description: 'This endpoint is not for updating contacts on an existing booking. For that purpose, use the "booking/contacts/{contactTypeCode}" endpoints for PUT and PATCH. This endpoint is to create a new contacts-only booking. An example use case for a contacts-only booking are agency gift certificates (Agency Contact) where a payment is made with the organization credit and left as a credit on the PNR. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: tripContactsAdd' operationId: nsk_v1_trip_contacts_post requestBody: x-name: tripContactsRequest description: The trip contacts request. content: application/json: schema: $ref: '#/components/schemas/TripContactsRequest' examples: Valid trip contacts request: description: Example request for creating a contacts only booking. value: data: contacts: - contactTypeCode: P phoneNumbers: - type: 1 number: '1234' cultureCode: null address: lineOne: '123' lineTwo: null lineThree: null countryCode: null provinceState: null city: City postalCode: '100' emailAddress: mail@mail.com customerNumber: null sourceOrganization: null distributionOption: null notificationPreference: null companyName: null name: first: John middle: null last: Doe title: null suffix: null required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBooking' examples: Contacts-only booking: description: Example response for successfully creating a contacts-only booking. value: data: selfServiceMoveAvailable: false bookingKey: null recordLocator: null currencyCode: null systemCode: null groupName: null locators: null info: status: 0 paidStatus: 0 priceStatus: 0 profileStatus: 0 bookingType: null channelType: 0 bookedDate: '2026-07-09T05:55:13.5552699+00:00' createdDate: null expirationDate: null modifiedDate: null modifiedAgentId: 0 createdAgentId: 0 owningCarrierCode: null changeAllowed: false createdUserKey: MA-- modifiedUserKey: null sales: null typeOfSale: null hold: null breakdown: null receivedBy: null contacts: p: contactTypeCode: P phoneNumbers: - type: 1 number: '1234' cultureCode: null address: lineOne: '123' lineTwo: null lineThree: null countryCode: null provinceState: null city: City postalCode: '100' emailAddress: mail@mail.com customerNumber: null sourceOrganization: null distributionOption: null notificationPreference: null companyName: null name: first: John middle: null last: Doe title: null suffix: null passengers: null journeys: null comments: null queues: null history: null payments: null addOns: null orders: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With invalid contact type code: description: The contact type code is invalid or not configured in the system. The list of valid contact type codes can be retrieved using the GET api/nsk/v1/resources/ContactTypes endpoint. value: errors: - id: 12bd2c3d-ddd4-5844-3sz5-3cg52c2e13n1 code: nsk:Contact:InvalidContactTypeCode message: The contact type code 'S' is invalid. type: Validation details: contactTypeCode: S rawMessage: The contact type code 'S' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With duplicate contact type code: description: The contact type code already exists in the request. value: errors: - id: 99cd1b2b-ccc3-4733-7fa4-2bf49b1d98c0 code: nsk:Contact:DuplicateTypeCode message: Duplicate contact type 'P' detected. type: Validation details: contactTypeCode: P rawMessage: Duplicate contact type 'P' detected. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With no contact type code: description: The contact type code in the request is not populated. value: errors: - id: 5f490eab-3a4d-a783-14ed-25456aecf82f code: Contact.ContactTypeCode:RequiredAttribute message: The Contact field is required. type: Validation details: null rawMessage: The Contact field is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With incomplete booking contact information: description: The booking contact information provided is incomplete. value: errors: - id: 666e7592-c107-3812-46e6-f7147dd3c5cd code: nsk-server:BookingContactInfoIncomplete message: Missing or invalid GST Registration Number. type: Validation details: null rawMessage: Missing or invalid GST Registration Number. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With booking already in state: description: There is already a booking in state. value: errors: - id: 505b55d3-cac8-93a9-4d25-131256cdd551 code: nsk:Booking:AlreadyExistsInState message: Booking already exists in state. Try again after reseting the state. type: Error details: null rawMessage: Booking already exists in state. Try again after reseting the state. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With null request: description: The trip contact request field is null value: errors: - id: 292fcb67-e1de-eb62-3d1a-123a586b03a9 code: core:Validation:NullRequest message: The request is null or couldn't be converted to the expected data type. type: Error details: null rawMessage: The request is null or couldn't be converted to the expected data type. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v2/trip/info: post: tags: - trip summary: Gets the search results for the trip information, based on the search criteria. description: 'This endpoint will return a maximum of 100 journeys. If more than 100 journeys are needed, the search criteria will need to be modified and additional trip calls will need to be made. GraphQL endpoint: tripInformationv2' operationId: nsk_v2_trip_info_post requestBody: x-name: request description: The trip information request. content: application/json: schema: $ref: '#/components/schemas/TripInformationQuery' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfTripInformationResponsev2' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/trip/info/{legKey}/details: get: tags: - trip summary: Retrieves cabin and various details for the specified leg key. description: 'The additional trip details include the leg cross references, the cabin details (nest counts), and the checkin-lid. GraphQL endpoint: tripInformationDetails' operationId: nsk_v1_trip_info_legKey_details_get parameters: - name: legKey in: path required: true description: The encoded leg key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfTripDetails' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/trip/info/{legKey}/status: patch: tags: - trip summary: Stateless operation for updating the trip information status for a specific flight. description: 'A flight must be within three days of leaving to be able to make flight following information changes. An empty string or whitespaces are allowed input values and are not considered as null inputs. Null values will retain the original value in the trip status while empty strings or whitespaces will clear the value from the trip status. When updating tail numbers, this endpoint will not validate mismatching equipment types. If validation is required for tail numbers, please see `POST /equipment/tailNumber`. GraphQL endpoint: tripInformationStatusModify' operationId: nsk_v1_trip_info_legKey_status_patch parameters: - name: legKey in: path required: true description: The leg key of the flight being updated. schema: type: string x-position: 1 requestBody: x-name: request description: The trip information status request. content: application/json: schema: $ref: '#/components/schemas/TripInformationStatusRequestBase' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Update flight following information successful: description: Example response when flight following information is updated successfully. value: data: null Mismatch tail number equipment type: description: Example response when the tail number is updated even if the equipment type is mismatching. value: messages: - code: nsk:TripStatus:EquipmentTypeMismatch type: Information value: nsk:TripStatus:EquipmentTypeMismatch status: 0 details: flightEquipmentType: '767' tailNumberEquipmentType: '731' data: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Update Flight Following Information Not Allowed: description: Example response when an agent is not allowed to update the flight following information. value: errors: - id: null code: nsk-server:AuthorizationManageFLIFONotAllowed message: nsk-server:AuthorizationManageFLIFONotAllowed type: Validation details: message: Agent does not have the proper clearance to update FLIFO. rawMessage: Agent does not have the proper clearance to update FLIFO. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Leg key is invalid: description: Example response when the leg key is invalid. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'legKey' with value 'NjM4NjY2ODkyMDAwMDAwMTMhICFTTEMhREVOITIzNTk3OTg-' is invalid. type: Validation details: null rawMessage: The identifier 'legKey' with value 'NjM4NjY2ODkyMDAwMDAwMTMhICFTTEMhREVOITIzNTk3OTg-' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Tail number does not exist: description: Example response when the tail number does not exist. See /resources/tailNumbers for the list of all available tail numbers. value: errors: - id: null code: nsk:TripStatus:TailNumberDoesNotExist message: nsk:TripStatus:TailNumberDoesNotExist type: Validation details: tailNumber: abc rawMessage: The tail number does not exist. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Tail number exceeds 10 characters: description: Example response when the tail number exceeds 10 characters. value: errors: - id: null code: TripInformationStatusRequestBase.TailNumber:StringLengthAttribute message: The field TripInformationStatusRequestBase must be a string with a maximum length of 10. type: Validation details: validation: StringLengthAttribute model: TripInformationStatusRequestBase member: TailNumber rawMessage: The field TripInformationStatusRequestBase must be a string with a maximum length of 10. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Request is null: description: Example response when the request is null. value: errors: - id: null code: core:Validation:NullRequest message: The request is null or couldn't be converted to the expected data type. type: Error details: null rawMessage: The request is null or couldn't be converted to the expected data type. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/trip/info/{legKey}/status: get: tags: - trip summary: Retrieves the trip status data for the specified leg key. description: 'GraphQL endpoint: tripInformationStatusv2' operationId: nsk_v2_trip_info_legKey_status_get parameters: - name: legKey in: path required: true description: The encoded leg key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfTripStatusv2' examples: Retrieve Trip Status: description: Successfully retrieving the trip status. value: data: tripStatusKey: MzAxMzx2NxFxNCI0MTAxOCBOVjU2MDggU0xDQk8J operationDetails: tailNumber: null equipmentType: '380' equipmentTypeSuffix: '800' status: 0 identifier: identifier: '5608' carrierCode: NV opSuffix: null tripOperationTimes: null counts: boardingCount: 0 boardingSequence: 0 infantCount: 0 nonRevenueCount: 0 revenueCount: 0 checkInCount: 0 fuelOnboardOut: 0 fuelOnboardIn: 0 upLiftFuel: 0 upLiftWeight: 0 cockpitCrewCount: 0 cabinCrewCount: 0 delays: - delayCode: TEST delayMinutes: 10 tripOperationDelayKey: MzAxMzc1MyExMzU1 note: TEST DELAY EDIT createdDate: '2026-07-09T05:55:14.768511Z' includeMvtMessage: true modifiedDate: '2026-07-12T05:55:14.7685353Z' createdUserKey: MQ-- modifiedUserKey: MQ-- payloads: null crewList: null comments: - text: TEST COMMENT EDIT tripOperationCommentKey: MzAxMzc1MyEzMDU4 type: 0 createdDate: '2026-07-09T05:55:14.7686459Z' modifiedDate: '2026-07-12T05:55:14.7686595Z' createdUserKey: MQ-- modifiedUserKey: MQ-- historyList: - tripOperationHistoryKey: MzAxMzc1MyEyODkxNlsz tripOperationHistoryCode: GP detail: US|iAPI Scheduled Msg ( 0/ 0) createdHistoryDate: '2026-07-09T05:55:14.7687139+00:00' - tripOperationHistoryKey: MzAxMzc1EySlOBk2MsN3 tripOperationHistoryCode: GS detail: US|iAPI Scheduled Msg ( 2/ 1) createdHistoryDate: '2026-07-09T05:55:14.7687146+00:00' originDetails: status: 0 note: null gate: null station: SLC destinationDetails: status: 0 note: null baggageClaim: null gate: null station: BOS modifiedAgentName: ExampleAgent verified: true irop: true modifiedDate: '2026-07-09T05:55:14.7687175Z' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/trip/info/{legKey}/status/comments: post: tags: - trip summary: Stateless operation for creating operation comments in the trip information status for a specific flight. description: 'A flight must be within three days of leaving to be able to make flight following information changes. GraphQL endpoint: tripOperationCommentsAdd' operationId: nsk_v1_trip_info_legKey_status_comments_post parameters: - name: legKey in: path required: true description: The leg key of the flight being updated. schema: type: string x-position: 1 requestBody: x-name: request description: The trip operation comment create request. content: application/json: schema: $ref: '#/components/schemas/TripOperationCommentCreateRequest' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Update Flight Following Information Not Allowed: description: Example response when an agent is not allowed to update the flight following information. value: errors: - id: 7a9504cd-8764-84af-9769-d634a09cd09d code: nsk-server:AuthorizationManageFLIFONotAllowed message: nsk-server:AuthorizationManageFLIFONotAllowed type: Validation details: message: Agent does not have the proper clearance to update FLIFO. rawMessage: Agent does not have the proper clearance to update FLIFO. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v1/trip/info/{legKey}/status/comments/{commentKey}: put: tags: - trip summary: Stateless operation for updating the operation comments in the trip information status for a specific flight. description: 'A flight must be within three days of leaving to be able to make flight following information changes. GraphQL endpoint: tripOperationCommentsSet' operationId: nsk_v1_trip_info_legKey_status_comments_commentKey_put parameters: - name: legKey in: path required: true description: The leg key of the flight being updated. schema: type: string x-position: 1 - name: commentKey in: path required: true description: The key of the comment to be updated. schema: type: string x-position: 2 requestBody: x-name: request description: The trip operation comment request. content: application/json: schema: $ref: '#/components/schemas/TripOperationCommentEditRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Update Flight Following Information Not Allowed: description: Example response when an agent is not allowed to update the flight following information. value: errors: - id: 7a9504cd-8764-84af-9769-d634a09cd09d code: nsk-server:AuthorizationManageFLIFONotAllowed message: nsk-server:AuthorizationManageFLIFONotAllowed type: Validation details: message: Agent does not have the proper clearance to update FLIFO. rawMessage: Agent does not have the proper clearance to update FLIFO. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - trip summary: Stateless operation for deleting the operation comments in the trip information status for a specific flight. description: 'A flight must be within three days of leaving to be able to make flight following information changes. GraphQL endpoint: tripOperationCommentsDelete' operationId: nsk_v1_trip_info_legKey_status_comments_commentKey_delete parameters: - name: legKey in: path required: true description: The leg key of the flight being updated. schema: type: string x-position: 1 - name: commentKey in: path required: true description: The key of the comment to be deleted. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Update Flight Following Information Not Allowed: description: Example response when an agent is not allowed to update the flight following information. value: errors: - id: 7a9504cd-8764-84af-9769-d634a09cd09d code: nsk-server:AuthorizationManageFLIFONotAllowed message: nsk-server:AuthorizationManageFLIFONotAllowed type: Validation details: message: Agent does not have the proper clearance to update FLIFO. rawMessage: Agent does not have the proper clearance to update FLIFO. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/trip/info/{legKey}/status/delays: post: tags: - trip summary: Stateless operation for creating operation delays in the trip information status for a specific flight. description: 'A flight must be within three days of leaving to be able to make flight following information changes. GraphQL endpoint: tripOperationDelaysAdd' operationId: nsk_v1_trip_info_legKey_status_delays_post parameters: - name: legKey in: path required: true description: The leg key of the flight being updated. schema: type: string x-position: 1 requestBody: x-name: request description: The trip operation delay request. content: application/json: schema: $ref: '#/components/schemas/TripOperationDelayCreateRequest' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Update Flight Following Information Not Allowed: description: Example response when an agent is not allowed to update the flight following information. value: errors: - id: 7a9504cd-8764-84af-9769-d634a09cd09d code: nsk-server:AuthorizationManageFLIFONotAllowed message: nsk-server:AuthorizationManageFLIFONotAllowed type: Validation details: message: Agent does not have the proper clearance to update FLIFO. rawMessage: Agent does not have the proper clearance to update FLIFO. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v1/trip/info/{legKey}/status/delays/{delayKey}: patch: tags: - trip summary: Stateless operation for patching the operation delays in the trip information status for a specific flight. description: 'A flight must be within three days of leaving to be able to make flight following information changes. GraphQL endpoint: tripOperationDelaysModify' operationId: nsk_v1_trip_info_legKey_status_delays_delayKey_patch parameters: - name: legKey in: path required: true description: The leg key of the flight being updated. schema: type: string x-position: 1 - name: delayKey in: path required: true description: The key of the delay to be patched. schema: type: string x-position: 2 requestBody: x-name: request description: The trip operation delay request. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfTripOperationDelayEditRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Update Flight Following Information Not Allowed: description: Example response when an agent is not allowed to update the flight following information. value: errors: - id: 7a9504cd-8764-84af-9769-d634a09cd09d code: nsk-server:AuthorizationManageFLIFONotAllowed message: nsk-server:AuthorizationManageFLIFONotAllowed type: Validation details: message: Agent does not have the proper clearance to update FLIFO. rawMessage: Agent does not have the proper clearance to update FLIFO. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - trip summary: Stateless operation for deleting trip operation delays in the trip information status for a specific flight. description: 'A flight must be within three days of leaving to be able to make flight following information changes. GraphQL endpoint: tripOperationDelaysDelete' operationId: nsk_v1_trip_info_legKey_status_delays_delayKey_delete parameters: - name: legKey in: path required: true description: The leg key of the flight being updated. schema: type: string x-position: 1 - name: delayKey in: path required: true description: The key of the delay to be deleted. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Update Flight Following Information Not Allowed: description: Example response when an agent is not allowed to update the flight following information. value: errors: - id: 7a9504cd-8764-84af-9769-d634a09cd09d code: nsk-server:AuthorizationManageFLIFONotAllowed message: nsk-server:AuthorizationManageFLIFONotAllowed type: Validation details: message: Agent does not have the proper clearance to update FLIFO. rawMessage: Agent does not have the proper clearance to update FLIFO. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/trip/info/{legKey}/status/operationDetails/status/cancel: put: tags: - trip summary: Updates the leg status to cancel. description: 'GraphQL endpoint: modifyStatusCancel' operationId: nsk_v1_trip_info_legKey_status_operationDetails_status_cancel_put parameters: - name: legKey in: path required: true description: The leg key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/trip/info/{legKey}/status/operationDetails/status/closeLeg: put: tags: - trip summary: Updates a leg status closed. description: 'A leg status can be set to closed regardless of check-in configuration period of time set in settings. This check-in restriction determines if a flight can be closed before a designated departure time. It is recommended to set a leg status to close using the check-in restrictions. There are a number of factors that can prevent the leg from being closed. These include: A PNRGOV message is required and has not been sent A flight closure or APIS message is required and has not been sent Passengers have a balance due (unless overrideBalanceDueWarning is specified) Passengers have a balance due and not all passengers on the booking have the same lift status. GraphQL endpoint: updateLegStatusClose' operationId: nsk_v1_trip_info_legKey_status_operationDetails_status_closeLeg_put parameters: - name: legKey in: path required: true description: The leg key. schema: type: string x-position: 1 - name: bypassCheckinRestrictions in: query description: "This will allows updates regardless of checkin configuration period of time set in settings.\n " schema: type: boolean x-position: 2 - name: overrideBalanceDueWarning in: query description: "This will allow the flight to be closed regardless of any balance due by any passenger(s) on the leg.\n " schema: type: boolean x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true /api/nsk/v2/trip/info/{legKey}/status/operationDetails/status/closeLeg: put: tags: - trip summary: Updates a leg status closed. description: 'A leg status can be set to closed regardless of check-in configuration period of time set in settings. This check-in restriction determines if a flight can be closed before a designated departure time. It is recommended to set a leg status to closed using the check-in restrictions. There are a number of factors that can prevent the leg from being closed. These include: A PNRGOV message is required and has not been sent A flight closure or APIS message is required and has not been sent Passengers have a balance due (unless overrideBalanceDueWarning is specified) Passengers have a balance due and not all passengers on the booking have the same lift status. Exit Row Requirements are not met (unless OverrideExitRowRequirement is specified) GraphQL endpoint: updateLegStatusClosev2' operationId: nsk_v2_trip_info_legKey_status_operationDetails_status_closeLeg_put parameters: - name: legKey in: path required: true description: The leg key. schema: type: string x-position: 1 requestBody: x-name: request description: "Flight close options.\n " content: application/json: schema: $ref: '#/components/schemas/FlightCloseRequest' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/trip/info/{legKey}/status/operationDetails/status/closePendingLeg: put: tags: - trip summary: Updates a leg status to closed pending. description: 'GraphQL endpoint: updateLegStatusClosePendingv2' operationId: nsk_v1_trip_info_legKey_status_operationDetails_status_closePendingLeg_put parameters: - name: legKey in: path required: true description: The leg key. schema: type: string x-position: 1 - name: overrideExitRowRequirement in: query description: "This will allow the leg to be set to closed pending regardless of any exit row requirements.\n " schema: type: - boolean - 'null' x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/trip/info/{legKey}/status/operationDetails/status/mishap: put: tags: - trip summary: 'Secures all passenger information associated with the flight leg clearing and locking the passenger data. This changes the leg status to Mishap.' description: 'GraphQL endpoint: modifyStatusMishap' operationId: nsk_v1_trip_info_legKey_status_operationDetails_status_mishap_put parameters: - name: legKey in: path required: true description: The leg key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Invalid Flight Key: description: Example of invalid flight key. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'legKey' with value 'aPQxScmtKWMS7YtIi6Pdp9kwUQKLrqc6j9K5f4cM' is invalid. type: Error details: null rawMessage: null exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Update Failed: description: Example of when attempted status change to 'Mishap' failed. value: errors: - id: null code: nsk:Exceptions:UpdateFailed message: Attempted update of object 'legKey' has failed. Please verify this object exists. type: Error details: null rawMessage: null exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '401': description: Authentication is required for this request. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/trip/info/{legKey}/status/operationDetails/status/mishapRestore: put: tags: - trip summary: Restores locked passenger data associated with the flight leg. This restores the leg status to normal. description: 'GraphQL endpoint: modifyStatusMishapRestore' operationId: nsk_v1_trip_info_legKey_status_operationDetails_status_mishapRestore_put parameters: - name: legKey in: path required: true description: The leg key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: Authentication is required for this request. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true /api/nsk/v1/trip/info/{legKey}/status/operationDetails/status/openLeg: put: tags: - trip summary: Updates a leg status to open. description: 'A leg status can be set to open regardless of checkin configuration period of time set in settings. This checkin restriction determines if a flight can be opened after a designated departure time. It is recommended to set a leg status to open using the checkin restrictions. GraphQL endpoint: updateLegStatusOpen' operationId: nsk_v1_trip_info_legKey_status_operationDetails_status_openLeg_put parameters: - name: legKey in: path required: true description: The leg key. schema: type: string x-position: 1 - name: bypassCheckinRestrictions in: query description: "This will allows updates regardless of checkin configuration period of time set in settings.\n " schema: type: boolean x-position: 2 - name: convertNoShowToDefault in: query description: If true, converts no show passengers' liftStatus to default schema: type: boolean x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/trip/info/{legKey}/status/operationDetails/status/restore: put: tags: - trip summary: Updates the leg status to normal. description: 'GraphQL endpoint: modifyStatusRestore' operationId: nsk_v1_trip_info_legKey_status_operationDetails_status_restore_put parameters: - name: legKey in: path required: true description: The leg key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/trip/info/legs: post: tags: - trip summary: Searches for the inventory legs based on the search criteria. description: 'This is functionally a GET but POST is used to reduce URL length overhead. GraphQL endpoint: tripInformationByLegv2' operationId: nsk_v2_trip_info_legs_post requestBody: x-name: request description: The trip information leg query. content: application/json: schema: $ref: '#/components/schemas/TripInformationLegQuery' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfTripInformationLegv2' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/trip/info/legs/simple: get: tags: - trip summary: 'Performs a simplified search for trip information by leg, based upon minimal, required data for the search criteria.' description: 'GraphQL endpoint: tripInformationByLegSimplev2' operationId: nsk_v2_trip_info_legs_simple_get parameters: - name: Origin in: query description: "The departure station.\n " schema: type: - string - 'null' maxLength: 3 minLength: 0 x-position: 1 - name: Destination in: query description: "The arrival station.\n " schema: type: - string - 'null' maxLength: 3 minLength: 0 x-position: 2 - name: BeginDate in: query description: "The starting date of the trip information search.\n " schema: type: - string - 'null' format: date-time x-position: 3 - name: EndDate in: query description: "The end date of the trip information search.\n " schema: type: - string - 'null' format: date-time x-position: 4 - name: StartTimeInterval in: query description: "The starting time of the trip information search.\n " schema: type: - string - 'null' format: duration x-position: 5 - name: EndTimeInterval in: query description: "The end time of the trip information search.\n " schema: type: - string - 'null' format: duration x-position: 6 - name: Identifier in: query description: "The transportation identifier, such as a flight number.\n " schema: type: - string - 'null' maxLength: 4 minLength: 0 x-position: 7 - name: CarrierCode in: query description: "The carrier code.\n " schema: type: - string - 'null' maxLength: 3 minLength: 2 x-position: 8 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfTripInformationLegv2' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/trip/info/simple: get: tags: - trip summary: 'Performs a simplified search for trip information based upon minimal, required data for the search criteria.' description: 'This endpoint will return a maximum of 100 journeys. If more than 100 journeys are needed, the search criteria will need to be modified and additional trip calls will need to be made. GraphQL endpoint: tripInformationSimplev2' operationId: nsk_v2_trip_info_simple_get parameters: - name: NumberOfJourneys in: query description: "When set to null, 100 journeys will be returned.\nThis endpoint will never return more than 100 journeys.\n " schema: type: - integer - 'null' format: int32 x-position: 1 - name: Origin in: query description: "The departure station.\n " schema: type: - string - 'null' maxLength: 3 minLength: 0 x-position: 2 - name: Destination in: query description: "The arrival station.\n " schema: type: - string - 'null' maxLength: 3 minLength: 0 x-position: 3 - name: EndDate in: query description: "The end date of the trip information search.\n " schema: type: - string - 'null' format: date-time x-position: 4 - name: StartTimeInterval in: query description: "The starting time of the trip information search.\n " schema: type: - string - 'null' format: duration x-position: 5 - name: EndTimeInterval in: query description: "The end time of the trip information search.\n " schema: type: - string - 'null' format: duration x-position: 6 - name: CarrierCode in: query description: "The carrier code.\n " schema: type: - string - 'null' maxLength: 3 minLength: 2 x-position: 7 - name: BeginDate in: query description: "The starting date of the trip information search.\n " schema: type: - string - 'null' format: date-time x-position: 8 - name: Identifier in: query description: "The transportation identifier, such as a flight number.\n " schema: type: - string - 'null' maxLength: 4 minLength: 0 x-position: 9 - name: FlightType in: query description: "The flight type.\n \nEnumeration values: 0 = All, 1 = NonStop, 2 = Through, 3 = Direct, 4 = Connect" schema: $ref: '#/components/schemas/OperationsFlightType' x-position: 10 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfTripInformationResponsev2' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/trip/info/status/operationDetails/status/mishapRestore: post: tags: - trip summary: Restores locked passenger data associated the leg information. This restores the leg status to normal. description: 'GraphQL endpoint: modifyStatusRestoreMishap' operationId: nsk_v1_trip_info_status_operationDetails_status_mishapRestore_post requestBody: x-name: request description: The leg key. content: application/json: schema: $ref: '#/components/schemas/MarketInformation' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Unauthorized Agent: description: Example of Agent unauthorized to restore passenger data for restore after mishap. value: errors: - id: null code: nsk:Trip:MishapRestorePassengerDataUnauthorized message: Agent unauthorized to restore passenger data. type: Error details: null rawMessage: null exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid Carrier Code: description: Example of invalid or unknown carrier code. value: errors: - id: null code: nsk:Trip:InvalidCarrierCode message: The carrier code 'x!*' is invalid. type: Error details: null rawMessage: null exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid Origin: description: Example of invalid or unknown departure station. value: errors: - id: null code: nsk:Trip:InvalidOrigin message: The Departure Station 'Gdo' is invalid. type: Error details: null rawMessage: null exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid Destination: description: Example of invalid or unknown arrival station. value: errors: - id: null code: nsk:Trip:InvalidDestination message: The Arrival Station 'hJA' is invalid. type: Error details: null rawMessage: null exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid Flight Number: description: Example of an invalid flight number. value: errors: - id: null code: nsk:Trip:InvalidFlightNumber message: The flight number 'KYB9' is invalid. type: Error details: null rawMessage: null exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Mishap Restore Failed: description: Example of when restoring a flight from mishap failed. value: errors: - id: null code: nsk:Trip:MishapRestoreFailed message: NV1234 was not found or not restored.. type: Error details: null rawMessage: null exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '401': description: Authentication is required for this request. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/trip/move: post: tags: - trip summary: Moves a journey on the booking in state. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: movev2' operationId: nsk_v2_trip_move_post requestBody: x-name: request description: Move request. content: application/json: schema: $ref: '#/components/schemas/MoveRequestv2' examples: Move Request: description: Example request for move journey for a booking in state. value: data: fromJourneyKey: TlZ_NTYxMH4gfn5TTEN_MDMvMTcvMjAyNiAxOTowMH5CT1N_MDMvMTcvMjAyNiAyMzo1OX5_ journeyKey: TlZ_NTYxMH4gfn5TTEN_MDMvMTcvMjAyNiAxOTowMH5CT1N_MDMvMTcvMjAyNiAyMzo1OX5_ fareKey: Mn5Cfn5OVn5CRkFSRX4yOTMzfn4wfjB_flg- moveType: 0 ignoreClosedFlightStatus: true ignoreLiftStatus: 2 boardingSequenceOffset: 0 moveSsrOption: 1 standbyPriorityCode: R inventoryControlType: 0 changeReasonCode: 2 required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid Journey Key: description: The journey key was not found on the booking in state. value: errors: - id: null code: nsk:Journey:InvalidKey message: nsk:Journey:InvalidKey type: Error details: null rawMessage: Journey key tDiBTmOoPK was not found on the booking in state. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Self Service Move Not Allowed: description: Self-service move is not allowed on the booking. value: errors: - id: null code: nsk:Availability:SelfServiceMoveNotAllowed message: nsk:Availability:SelfServiceMoveNotAllowed type: Error details: null rawMessage: A self-service move is not allowed for this booking. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Trip Move Not Allowed: description: Trip move is not allowed on the initial booking. value: errors: - id: null code: nsk:Trip:MoveNotAllowedOnInitialBooking message: nsk:Trip:MoveNotAllowedOnInitialBooking type: Validation details: null rawMessage: A trip move is not allowed for the initial booking based on the current user's permissions. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid Journey For Confirmed Move Type: description: The original journey is on standby status when attempting to move the trip from confirmed status. value: errors: - id: null code: nsk:Trip:InvalidJourneyForConfirmedMove message: nsk:Trip:InvalidJourneyForConfirmedMove type: Validation details: null rawMessage: The original journey to be moved is invalid because it is on standby status. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With No Standby Priority Code: description: The standby priority code is missing when attempting to move the trip to standby status. value: errors: - id: null code: nsk:Trip:StandbyPriorityCodeRequired message: nsk:Trip:StandbyPriorityCodeRequired type: Validation details: null rawMessage: A standby priority code is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid Standby Priority Code: description: The provided standby priority code is invalid or not configured in the system. For the list of valid codes, please use the GET /resources/StandByPriorities endpoint. value: errors: - id: null code: nsk:Trip:InvalidStandbyPriorityCode message: nsk:Trip:InvalidStandbyPriorityCode type: Validation details: null rawMessage: The standby priority code tDiBTmOoPK is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid Change Reason Code: description: The provided change reason code is invalid or not configured in the system. value: errors: - id: null code: nsk:Trip:InvalidChangeReasonCode message: nsk:Trip:InvalidChangeReasonCode type: Validation details: null rawMessage: The change reason code 8 is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. '403': description: Role permissions are not met. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid Split Journey Move: description: The journey does not have at least one boarded and one unboarded segment. value: errors: - id: null code: nsk-server:InvalidSplitJourneyMove message: nsk-server:InvalidSplitJourneyMove type: Error details: null rawMessage: Split Journey requires atleast one boarded and one unboarded segment. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Split Journey Move Not Allowed: description: The user is not allowed to attempt split-journey move. value: errors: - id: null code: nsk-server:InvalidRole message: nsk-server:InvalidRole type: Error details: null rawMessage: Agent is not allowed for SplitJourney. RoleCode = TAW3. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Fly Ahead Move Not Allowed: description: The journey is not enabled for fly-ahead offers. value: errors: - id: null code: nsk-server:InvalidFlyAheadMove message: nsk-server:InvalidFlyAheadMove type: Error details: null rawMessage: 'Fly-ahead move not allowed: Current journey is not enabled for fly-ahead offers' exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With HIDR Disabled: description: The Hybrid Interline Disruption Recovery premium service is disabled. value: errors: - id: null code: nsk-server:NotHIDREligible message: nsk-server:NotHIDREligible type: Error details: null rawMessage: Not eligible for HIDR move. HIDR is disabled. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. /api/nsk/v3/trip/move/availability: post: tags: - trip summary: 'Searches for move availability with the full availability search request. This request will allow for total control over the configuration. If a property is not set, the default settings (AvailabilitySettings) is used in its place.' description: 'Note, this is a post request even though it is only getting information. This is due to the complicated data needed in the post data. Even though service bundle offers is part of the endpoint response, it is expected to be not populated. GraphQL endpoint: moveAvailabilityv3' operationId: nsk_v3_trip_move_availability_post requestBody: x-name: request description: The availability move request. content: application/json: schema: $ref: '#/components/schemas/AvailabilityMoveRequest' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfAvailabilityv2' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '403': description: Role permissions are not met. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v3/trip/move/availability/{journeyKey}: get: tags: - trip summary: 'Searches for availability with the simple move request. The simple search request covers the bare minimum search criteria and lets default settings (AvailabilitySettings) configure the rest.' description: 'Even though service bundle offers is part of the endpoint response, it is expected to be not populated. GraphQL endpoint: moveAvailabilitySimplev3' operationId: nsk_v3_trip_move_availability_journeyKey_get parameters: - name: journeyKey in: path required: true description: The journey key. schema: type: string x-position: 1 - name: BeginDate in: query description: "The departure date.\n " schema: type: - string - 'null' format: date-time x-position: 2 - name: Origin in: query description: "The origin station code.\n " schema: type: - string - 'null' maxLength: 3 minLength: 3 x-position: 3 - name: Destination in: query description: "The destination station code.\n " schema: type: - string - 'null' maxLength: 3 minLength: 3 x-position: 4 - name: PassengerMoveType in: query description: "The passenger move type.\n \nEnumeration values: 0 = None, 1 = Irop, 2 = Diversion, 4 = FlightClose, 5 = FlyAhead, 6 = SplitJourney, 7 = SelfServiceRebooking, 8 = HIDR" schema: $ref: '#/components/schemas/MovePassengerJourneyType' x-position: 5 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfAvailabilityv2' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/trip/move/availability/selfService: get: tags: - trip summary: Self-service search for move availability. description: 'If no BeginDate is provided, it will default to the journey departure date. If no EndDate is provided, it will default to the begin date + 1 day. Even though service bundle offers is part of the endpoint response, it is expected to be not populated. GraphQL endpoint: moveAvailabilitySelfServicev2' operationId: nsk_v2_trip_move_availability_selfService_get parameters: - name: BeginDate in: query description: "The begin date.\n " schema: type: - string - 'null' format: date-time x-position: 1 - name: EndDate in: query description: "The end date.\n " schema: type: - string - 'null' format: date-time x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfAvailabilityv2' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/trip/move/irop: post: tags: - trip summary: 'Performs an IROP move for the booking in state. This endpoint adds additional IROP move functionality for agents. See `/api/nsk/v2/trip/move` for IROP functionality not restricted to agents only.' description: 'GraphQL endpoint: iropMove' operationId: nsk_v1_trip_move_irop_post requestBody: x-name: request description: IROP move request. content: application/json: schema: $ref: '#/components/schemas/IropMoveRequest' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/trip/passengers: post: tags: - trip summary: Creates a new booking with the provided passengers. description: 'This endpoint is not for updating passengers on an existing booking. For that purpose, use the "booking/passengers/{passengerKey}" endpoints for PUT and PATCH. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: tripPassengersAdd' operationId: nsk_v1_trip_passengers_post parameters: - name: syncPassengerAndTravelDocGender in: query description: "Indicates whether to synchronize the passenger and all its travel\ndocuments' gender. This will update the gender of all the travel documents in the\npassengers[passengerKey].travelDocuments list in the booking model. The value defaults to true if not specified.\n " schema: type: boolean default: true x-position: 2 requestBody: x-name: passengerRequests description: The passengers to be added. content: application/json: schema: type: array items: $ref: '#/components/schemas/PassengerRequest' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBooking' examples: Valid declared gender mapped to the same binary gender: description: Example response for successfully creating a passenger with a valid declared gender mapped to the same binary gender (i.e. Male to Undisclosed or Unspecified). value: data: selfServiceMoveAvailable: false bookingKey: null recordLocator: null currencyCode: null systemCode: null groupName: null locators: null info: status: 0 paidStatus: 0 priceStatus: 0 profileStatus: 0 bookingType: null channelType: 0 bookedDate: '2026-07-09T05:55:13.564119+00:00' createdDate: null expirationDate: null modifiedDate: null modifiedAgentId: 0 createdAgentId: 0 owningCarrierCode: null changeAllowed: false createdUserKey: null modifiedUserKey: null sales: null typeOfSale: null hold: null breakdown: null receivedBy: null contacts: null passengers: mcfbrfQ-: passengerKey: MCFBRFQ- passengerAlternateKey: null customerNumber: null fees: null name: first: Justine middle: null last: Doe title: null suffix: null passengerTypeCode: ADT discountCode: null bags: null program: null infant: null info: nationality: null residentCountry: null gender: 1 dateOfBirth: '2006-07-09T00:00:00+00:00' familyNumber: null declaredGender: U travelDocuments: null addresses: null weightCategory: 1 emdCoupons: null journeys: null comments: null queues: null history: null payments: null addOns: null orders: null Valid declared gender mapped to a different binary gender: description: Example response for successfully creating a passenger with a valid declared gender mapped to a different binary gender (i.e. Male, Undisclosed or Unspecified to Female). value: messages: - code: SyncBinaryGenderToDeclaredGender type: SyncBinaryGenderToDeclaredGender value: 'Passenger Justine Doe - Binary Gender Male will be synced with Declared Gender value F. New Binary Gender: Female' status: 1 details: null data: selfServiceMoveAvailable: false bookingKey: null recordLocator: null currencyCode: null systemCode: null groupName: null locators: null info: status: 0 paidStatus: 0 priceStatus: 0 profileStatus: 0 bookingType: null channelType: 0 bookedDate: '2026-07-09T05:55:13.5641201+00:00' createdDate: null expirationDate: null modifiedDate: null modifiedAgentId: 0 createdAgentId: 0 owningCarrierCode: null changeAllowed: false createdUserKey: null modifiedUserKey: null sales: null typeOfSale: null hold: null breakdown: null receivedBy: null contacts: null passengers: mcfbrfQ-: passengerKey: MCFBRFQ- passengerAlternateKey: null customerNumber: null fees: null name: first: Justine middle: null last: Doe title: null suffix: null passengerTypeCode: ADT discountCode: null bags: null program: null infant: null info: nationality: null residentCountry: null gender: 2 dateOfBirth: '2006-07-09T00:00:00+00:00' familyNumber: null declaredGender: F travelDocuments: null addresses: null weightCategory: 2 emdCoupons: null journeys: null comments: null queues: null history: null payments: null addOns: null orders: null Mismatching gender and declared gender: description: Example response for successfully creating a passenger with a mismatching gender (Female) and declared gender (Male). value: messages: - code: SyncBinaryGenderToDeclaredGender type: SyncBinaryGenderToDeclaredGender value: 'Passenger Justine Doe - Binary Gender Female will be synced with Declared Gender value M. New Binary Gender: Male' status: 1 details: null data: selfServiceMoveAvailable: false bookingKey: null recordLocator: null currencyCode: null systemCode: null groupName: null locators: null info: status: 0 paidStatus: 0 priceStatus: 0 profileStatus: 0 bookingType: null channelType: 0 bookedDate: '2026-07-09T05:55:13.5641213+00:00' createdDate: null expirationDate: null modifiedDate: null modifiedAgentId: 0 createdAgentId: 0 owningCarrierCode: null changeAllowed: false createdUserKey: null modifiedUserKey: null sales: null typeOfSale: null hold: null breakdown: null receivedBy: null contacts: null passengers: mcfbrfQ-: passengerKey: MCFBRFQ- passengerAlternateKey: null customerNumber: null fees: null name: first: Justine middle: null last: Doe title: null suffix: null passengerTypeCode: ADT discountCode: null bags: null program: null infant: null info: nationality: null residentCountry: null gender: 1 dateOfBirth: '2006-07-09T00:00:00+00:00' familyNumber: null declaredGender: M travelDocuments: null addresses: null weightCategory: 1 emdCoupons: null journeys: null comments: null queues: null history: null payments: null addOns: null orders: null '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Missing passenger information: description: Example error for missing passenger information. value: errors: - id: null code: nsk-server:PassengerInfoIncomplete message: PassengerInfo is required. type: Error details: null rawMessage: null exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid declared gender length: description: Example response when the declared gender in the request is more than 2 characters. value: errors: - id: null code: PassengerInfo.DeclaredGender:LengthStringAttribute message: The value of PassengerInfo.DeclaredGender:LengthStringAttribute is 'ABC' but must be no more than 2 characters in length. type: Validation details: null rawMessage: The value of PassengerInfo.DeclaredGender:LengthStringAttribute is 'ABC' but must be no more than 2 characters in length. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Inactive or non-existent declared gender: description: Example response when the declared gender in the request is inactive or non-existent. value: errors: - id: null code: nsk-server:InvalidDeclaredGender message: Passenger John Doe has an invalid Declared Gender K. type: Validation details: message: Passenger John Doe has an invalid Declared Gender K. rawMessage: Passenger John Doe has an invalid Declared Gender K. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v1/trip/passiveSegments: post: tags: - trip summary: Creates a passive segment and creates a booking if it doesn't already exist. description: 'This endpoint creates a new journey with the passive segment on it. A passive segment cannot be updated, however get and delete work like all other journeys. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: tripPassiveSegmentAdd' operationId: nsk_v1_trip_passiveSegments_post requestBody: x-name: request description: The passive segment request. content: application/json: schema: $ref: '#/components/schemas/PassiveSegmentRequest' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBooking' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v5/trip/rebook/availability: post: tags: - trip summary: Rebook search with the current booking defaults. description: 'Requires a booking in state. Although this endpoint behaves like a GET, POST is used to reduce the limitations resulting from URL length issues. GraphQL endpoint: rebookAvailabilityv5' operationId: nsk_v5_trip_rebook_availability_post requestBody: x-name: request description: The rebook request. content: application/json: schema: $ref: '#/components/schemas/AvailabilityRebookRequestv3' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfAvailabilityv2' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v4/trip/rebook/availability/simple: get: tags: - trip summary: Simple rebook search with the current booking defaults. description: 'Requires a booking in state. The AvailabilityCriteriaFilter.FareInclusionType.NoPricing enumeration value, if set, will result in an availability response that does not include fares. The primary use case for this is in Move flows, but is being maintained on the main availability and rebook availability flows in case there are other use cases as well. Even though service bundle offers is part of the endpoint response, it is expected to be not populated. GraphQL endpoint: rebookAvailabilitySimplev4' operationId: nsk_v4_trip_rebook_availability_simple_get parameters: - name: Origin in: query description: "The origin station code.\n " schema: type: - string - 'null' maxLength: 3 minLength: 3 x-position: 1 - name: Destination in: query description: "The destination station code.\n " schema: type: - string - 'null' maxLength: 3 minLength: 3 x-position: 2 - name: BeginDate in: query description: "The departure date.\n " schema: type: string format: date-time x-position: 3 - name: EndDate in: query description: "The return date if this is a round trip request.\n " schema: type: - string - 'null' format: date-time x-position: 4 - name: LoyaltyFilter in: query description: "The loyalty fare filter.\n \nEnumeration values: 0 = MonetaryOnly, 1 = PointsOnly, 2 = PointsAndMonetary, 3 = PreserveCurrent" schema: $ref: '#/components/schemas/LoyaltyFilter' x-position: 5 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfAvailabilityv2' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/trip/schedule: get: tags: - trip summary: Retrieves the schedule of flights for a market. description: 'GraphQL endpoint: tripScheduleSimple' operationId: nsk_v1_trip_schedule_get parameters: - name: Origin in: query description: "The origin station code.\n " schema: type: - string - 'null' maxLength: 3 minLength: 3 x-position: 1 - name: Destination in: query description: "The destination station code.\n " schema: type: - string - 'null' maxLength: 3 minLength: 3 x-position: 2 - name: BeginDate in: query description: "The begin date to search for.\n " schema: type: string format: date-time x-position: 3 - name: EndDate in: query description: "The end date to search for.\n " schema: type: string format: date-time x-position: 4 - name: Type in: query description: "The flight type filter.\n \nEnumeration values: 0 = None, 1 = NonStop, 2 = Through, 3 = Direct, 4 = Connect, 5 = All" schema: $ref: '#/components/schemas/FlightType' x-position: 5 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfScheduleDetail' /api/nsk/v1/trip/schedule/adHoc: post: tags: - trip summary: Creates an ad hoc flight. description: 'GraphQL endpoint: tripScheduleAdHocAdd' operationId: nsk_v1_trip_schedule_adHoc_post requestBody: x-name: request description: The commit itinerary variation request. content: application/json: schema: $ref: '#/components/schemas/CommitItineraryVariationRequest' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfItineraryVariation' /api/nsk/v4/trip/sell: post: tags: - trip summary: Sells the list of journeys and creates a booking if it doesn't already exist. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` This endpoint will ignore the contents of ''TripSellRequestv2.Passengers.Types.Details'' if there are already passengers in the booking in state and use the existing passengers instead. GraphQL endpoint: tripAddv5' operationId: nsk_v4_trip_sell_post requestBody: x-name: request description: The trip sell request. content: application/json: schema: $ref: '#/components/schemas/TripSellRequestv2' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBooking' examples: Trip sold successfully.: description: Example response when the trip is sold successfully. value: data: selfServiceMoveAvailable: false bookingKey: MyE2dWp4ZSFmYWxzZQ-- recordLocator: null currencyCode: null systemCode: null groupName: null locators: null info: null sales: null typeOfSale: null hold: null breakdown: null receivedBy: null contacts: null passengers: mcfbrfQ-: passengerKey: MCFBRFQ- passengerAlternateKey: null customerNumber: null fees: null name: null passengerTypeCode: ADT discountCode: null bags: null program: null infant: null info: null travelDocuments: null addresses: - status: 0 companyName: null lineOne: 123 First Street passengerAddressKey: null phone: 555-555-1234 lineTwo: null stationCode: SLC lineThree: null emailAddress: null countryCode: US cultureCode: null provinceState: UT refusedContact: null city: SLC postalCode: '84108' weightCategory: null emdCoupons: null journeys: - flightType: 1 stops: 0 designator: destination: DEN origin: SLC arrival: '2026-07-10T00:00:00+00:00' departure: '2026-07-09T00:00:00+00:00' move: null segments: - isStandby: false isConfirming: false isConfirmingExternal: false isBlocked: false isHosted: true isChangeOfGauge: false designator: destination: DEN origin: SLC arrival: '2026-07-10T00:00:00+00:00' departure: '2026-07-09T00:00:00+00:00' isSeatmapViewable: true fares: - isGoverning: true carrierCode: null fareKey: MH5Cfn5OVn5CRU1EfkVTQ1J_fjB_MH5_WA-- classOfService: null classType: null fareApplicationType: 0 fareClassOfService: null fareBasisCode: null fareSequence: 0 inboundOutBound: 0 fareStatus: 0 isAllotmentMarketFare: false originalClassOfService: null ruleNumber: null productClass: null ruleTariff: null travelClassCode: null pricingDate: '0001-01-01T00:00:00' crossReferenceClassOfService: null fareDesignator: null passengerFares: null fareLink: 0 segmentKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ identifier: identifier: '1234' carrierCode: NV opSuffix: null passengerSegment: mcfbrfQ-: seats: null passengerKey: null activityDate: null boardingSequence: null createdDate: null liftStatus: 2 modifiedDate: null overBookIndicator: 0 priorityDate: null timeChanged: false verifiedTravelDocs: null sourcePointOfSale: null pointOfSale: null ssrs: - isConfirmed: false isConfirmingUnheld: false note: null ssrDuration: 0 ssrKey: null count: 0 ssrCode: WCHR feeCode: null inBundle: false passengerKey: null ssrDetail: null ssrNumber: null market: null tickets: null bags: null scores: null boardingPassDetail: null hasInfant: false seatPreferences: null bundleCode: null verifiedTravelDocuments: null referenceNumber: 0 baggageGroupNumber: null baggageAllowanceUsed: false baggageAllowanceWeight: 0 baggageAllowanceWeightType: 0 stayType: 0 infantStayType: 0 channelType: 0 cabinOfService: null externalIdentifier: null priorityCode: null changeReasonCode: 0 segmentType: 0 salesDate: null international: false flightReference: null legs: - legKey: null operationsInfo: null designator: destination: DEN origin: SLC arrival: '2026-07-10T00:00:00+00:00' departure: '2026-07-09T00:00:00+00:00' legInfo: null nests: null ssrs: null seatmapReference: null flightReference: null status: 0 journeyKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ notForGeneralUser: false comments: null queues: null history: null payments: null addOns: null orders: null PaxPriceDetails are ignored.: description: Example message when there are already existing booking passengers and the Passengers.Types. The trip is sold successfully and the details in the request are ignored. value: messages: - code: nsk:Trip:PaxPriceDetailsRequestIgnored type: Warning value: The contents of 'TripSellRequestv2.Passengers.Types.Details' are ignored because the booking in state already contains passengers. status: 0 details: null data: selfServiceMoveAvailable: false bookingKey: MyE2dWp4ZSFmYWxzZQ-- recordLocator: null currencyCode: null systemCode: null groupName: null locators: null info: null sales: null typeOfSale: null hold: null breakdown: null receivedBy: null contacts: null passengers: mcfbrfQ-: passengerKey: MCFBRFQ- passengerAlternateKey: null customerNumber: null fees: null name: null passengerTypeCode: ADT discountCode: null bags: null program: null infant: null info: null travelDocuments: null addresses: - status: 0 companyName: null lineOne: 123 First Street passengerAddressKey: null phone: 555-555-1234 lineTwo: null stationCode: SLC lineThree: null emailAddress: null countryCode: US cultureCode: null provinceState: UT refusedContact: null city: SLC postalCode: '84108' weightCategory: null emdCoupons: null journeys: - flightType: 1 stops: 0 designator: destination: DEN origin: SLC arrival: '2026-07-10T00:00:00+00:00' departure: '2026-07-09T00:00:00+00:00' move: null segments: - isStandby: false isConfirming: false isConfirmingExternal: false isBlocked: false isHosted: true isChangeOfGauge: false designator: destination: DEN origin: SLC arrival: '2026-07-10T00:00:00+00:00' departure: '2026-07-09T00:00:00+00:00' isSeatmapViewable: true fares: - isGoverning: true carrierCode: null fareKey: MH5Cfn5OVn5CRU1EfkVTQ1J_fjB_MH5_WA-- classOfService: null classType: null fareApplicationType: 0 fareClassOfService: null fareBasisCode: null fareSequence: 0 inboundOutBound: 0 fareStatus: 0 isAllotmentMarketFare: false originalClassOfService: null ruleNumber: null productClass: null ruleTariff: null travelClassCode: null pricingDate: '0001-01-01T00:00:00' crossReferenceClassOfService: null fareDesignator: null passengerFares: null fareLink: 0 segmentKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ identifier: identifier: '1234' carrierCode: NV opSuffix: null passengerSegment: mcfbrfQ-: seats: null passengerKey: null activityDate: null boardingSequence: null createdDate: null liftStatus: 2 modifiedDate: null overBookIndicator: 0 priorityDate: null timeChanged: false verifiedTravelDocs: null sourcePointOfSale: null pointOfSale: null ssrs: - isConfirmed: false isConfirmingUnheld: false note: null ssrDuration: 0 ssrKey: null count: 0 ssrCode: WCHR feeCode: null inBundle: false passengerKey: null ssrDetail: null ssrNumber: null market: null tickets: null bags: null scores: null boardingPassDetail: null hasInfant: false seatPreferences: null bundleCode: null verifiedTravelDocuments: null referenceNumber: 0 baggageGroupNumber: null baggageAllowanceUsed: false baggageAllowanceWeight: 0 baggageAllowanceWeightType: 0 stayType: 0 infantStayType: 0 channelType: 0 cabinOfService: null externalIdentifier: null priorityCode: null changeReasonCode: 0 segmentType: 0 salesDate: null international: false flightReference: null legs: - legKey: null operationsInfo: null designator: destination: DEN origin: SLC arrival: '2026-07-10T00:00:00+00:00' departure: '2026-07-09T00:00:00+00:00' legInfo: null nests: null ssrs: null seatmapReference: null flightReference: null status: 0 journeyKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ notForGeneralUser: false comments: null queues: null history: null payments: null addOns: null orders: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/trip/standby/availability: post: tags: - trip summary: Retrieves same-day standby availability relevant to the current state booking. description: 'This endpoint only provisions same-day standby availability. The existing, standard flight availability endpoints should still be used for other standby availability search scenarios. Although this endpoint behaves like a GET, POST reduces the limitations resulting from URL length issues. Even though service bundle offers is part of the endpoint response, it is expected to be not populated. GraphQL endpoint: tripStandbyAvailability' operationId: nsk_v1_trip_standby_availability_post requestBody: x-name: request description: The standby availability request to use in the search. content: application/json: schema: $ref: '#/components/schemas/AvailabilityStandbyRequest' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfAvailabilityv2' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' components: schemas: EmdTypeCode: type: integer description: "Represents the EMD type code options.\n \n\n0 = None\n1 = Associated\n2 = StandAlone" x-enumNames: - None - Associated - StandAlone enum: - 0 - 1 - 2 QueueMode: type: integer description: "Determines where a queue request is coming from.\n \n\n0 = EnQueued\n1 = DeQueued" x-enumNames: - EnQueued - DeQueued enum: - 0 - 1 MovePassengerJourneyType: type: integer description: "The type of move to perform for the passengers on the journey.\n \n\n0 = None\n1 = Irop\n2 = Diversion\n4 = FlightClose\n5 = FlyAhead\n6 = SplitJourney\n7 = SelfServiceRebooking\n8 = HIDR" x-enumNames: - None - Irop - Diversion - FlightClose - FlyAhead - SplitJourney - SelfServiceRebooking - HIDR enum: - 0 - 1 - 2 - 4 - 5 - 6 - 7 - 8 PaymentAttachment: type: object description: "Defines a payment attachment.\n " additionalProperties: false properties: id: type: integer description: "The attachment ID.\n " format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 paymentId: type: integer description: "The payment ID attached to.\n " format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 attachment: type: - string - 'null' description: "The attachment data.\n " format: byte TripOperationPayload: type: object description: "Represents the payload data for the trip operation.\n " additionalProperties: false properties: payloadType: type: - string - 'null' description: "The type of payload this model represents, expressed as a single\ncharacter.\nPlease note that this should be a char and not a string.\n " maxLength: 1 compartment: type: - string - 'null' description: "The compartment for the payload this model represents, expressed\nas a single character.\nPlease note that this should be a char and not a string.\n " maxLength: 1 payloadCount: type: integer description: "The payload count.\n " format: int32 maximum: 2147483647.0 minimum: 1.0 weight: type: integer description: "The total payload weight.\n " format: int32 maximum: 2147483647.0 minimum: 1.0 AvailabilitySsrCollectionsMode: type: integer description: "SSR collection mode determines whethere SSR availability should be checked and returned on availability.\n \n\n0 = None\n1 = Leg" x-enumNames: - None - Leg enum: - 0 - 1 PassengerProgram: type: object description: "Model representing a passenger program.\n " additionalProperties: false properties: code: type: - string - 'null' description: "The program code.\n " maxLength: 3 minLength: 0 pattern: ^[^|]*$ levelCode: type: - string - 'null' description: "The program level code.\n " maxLength: 3 minLength: 0 pattern: ^[^|]*$ number: type: - string - 'null' description: "The program number.\n " maxLength: 32 minLength: 0 BookingPassengerRequest: type: object description: "Defines the the passenger and associated ssr request.\n " additionalProperties: false required: - passenger properties: passenger: description: "The passenger information.\n " $ref: '#/components/schemas/PassengerRequest' discountCode: type: - string - 'null' description: "The passenger discount code.\n " maxLength: 4 minLength: 0 ssrs: type: - array - 'null' description: "The ssrs to initially add.\n " items: $ref: '#/components/schemas/JourneySsrRequest' AuthenticationStatus: type: integer description: "Defines the different possible payment authentication statuses for 3DS.\n \n\n0 = Unknown\n1 = AuthenticationSuccessful\n2 = AuthenticationFailed\n3 = AuthenticationCouldNotBePerformed\n4 = AuthenticationAttemptProcessing\n5 = AuthenticationRejected" x-enumNames: - Unknown - AuthenticationSuccessful - AuthenticationFailed - AuthenticationCouldNotBePerformed - AuthenticationAttemptProcessing - AuthenticationRejected enum: - 0 - 1 - 2 - 3 - 4 - 5 Passenger: type: object description: "Model information representing a passenger on a journey.\n " additionalProperties: false required: - passengerTypeCode properties: customerNumber: type: - string - 'null' description: "The passenger customer number.\n " maxLength: 20 minLength: 0 name: description: "The passenger's name.\n " $ref: '#/components/schemas/Name' discountCode: type: - string - 'null' description: "The discount code associated with the passenger type.\n " maxLength: 8 minLength: 0 program: description: "The passenger programs.\n " $ref: '#/components/schemas/PassengerProgram' info: description: "Additional passenger information.\n " $ref: '#/components/schemas/PassengerInformation' passengerKey: type: - string - 'null' description: "The unique passenger identifier key.\n " passengerAlternateKey: type: - string - 'null' description: "The passenger alternate key is used to identify a passenger post commit of the booking.\n " fees: type: - array - 'null' description: "Fees.\n " items: $ref: '#/components/schemas/PassengerFee' passengerTypeCode: type: string description: "The passenger type code.\n " minLength: 1 bags: type: - array - 'null' description: "Passenger bags.\n " items: $ref: '#/components/schemas/PassengerBag' infant: description: "The optional infant associated with this passenger.\n " $ref: '#/components/schemas/PassengerInfant' travelDocuments: type: - array - 'null' description: "The collection of passenger travel Documents.\n " items: $ref: '#/components/schemas/PassengerTravelDocument' addresses: type: - array - 'null' description: "The collection of passenger addresses.\n " items: $ref: '#/components/schemas/PassengerAddress' weightCategory: description: "The weight category assigned to this passenger.\n " $ref: '#/components/schemas/WeightCategory' emdCoupons: type: - array - 'null' description: "The passenger EMD coupons.\n " items: $ref: '#/components/schemas/PassengerEmdCoupon' IJsonResponseOfAvailabilityv2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/Availabilityv2' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' OperationCounts: type: object description: "Represents the operation counts model.\n " additionalProperties: false properties: boardingCount: type: integer description: "Represents the number of passengers that have boarded the trip equipment.\n " maximum: 32767.0 minimum: 0.0 boardingSequence: type: integer description: "Represents the boarding sequence number. Starts at 1 for each leg.\n " maximum: 32767.0 minimum: 0.0 infantCount: type: integer description: "Represents the number of infants not occupying a seat.\n " maximum: 32767.0 minimum: 0.0 nonRevenueCount: type: integer description: "Represents the number of non-revenue passengers.\n " maximum: 32767.0 minimum: 0.0 revenueCount: type: integer description: "Represents the number of revenue passengers.\n " maximum: 32767.0 minimum: 0.0 checkInCount: type: integer description: "Represents the number of passengers that have checked-in.\n " maximum: 32767.0 minimum: 0.0 fuelOnboardOut: type: integer description: "Represents the amount of fuel onboard the aircraft/equipment upon departure.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 fuelOnboardIn: type: integer description: "Represents the amount of fuel onboard the aircraft/equipment upon arrival.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 upLiftFuel: type: integer description: "Represents the amount of fuel uplifted to the aircraft/equipment.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 upLiftWeight: type: integer description: "Represents the uplift weight.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 cockpitCrewCount: type: integer description: "Represents the number of crew in the cockpit.\n " maximum: 32767.0 minimum: 0.0 cabinCrewCount: type: integer description: "Represents the number of crew in the cabin.\n " maximum: 32767.0 minimum: 0.0 AvailabilityMoveFilterCriteria: type: object description: "Filter criteria filters the move availability responses results.\n " additionalProperties: false properties: filter: description: "Filters the type of journeys to return.\n " $ref: '#/components/schemas/AvailabilityFilter' sortKeys: type: - array - 'null' description: "The list of inventory journey sort keys. Used for filtering journeys on the response.\n " items: $ref: '#/components/schemas/JourneySortKey' MoveSsrOption: type: integer description: "How to handle SSRs on move.\n \n\n0 = OverbookSsr\n1 = MoveAvailableSsr\n2 = MoveNone" x-enumNames: - OverbookSsr - MoveAvailableSsr - MoveNone enum: - 0 - 1 - 2 BookingOrder: type: object description: "Represents a booking order.\n " additionalProperties: false properties: bookingOrderKey: type: - string - 'null' description: "The unique identifier.\n " orderId: type: string description: "The unique identifier related to a travel commerce order.\nFor use with TC API.\n " format: guid collect: type: number description: "Total amount of the order that is to be collected directly by NewSkies.\n " format: decimal thirdPartyCharge: type: number description: "Total amount of the order that will be charged immediately by a third party.\nFor example, the amount that is charged when an add-on is booked.\n " format: decimal thirdPartyHold: type: number description: "Total amount of the order that will be charged at the time of the service by a third party.\nFor example, the amount that is charged when a car is picked up.\n " format: decimal total: type: number description: "Total face value of the order, including non-chargeable amounts.\n " format: decimal status: description: "The overall status of the order from a NewSkies perspective, indicating\ninformation such as if the order has been finalized in Travel Commerce.\n " $ref: '#/components/schemas/BookingOrderStatus' TripContactsRequest: type: object description: "Trip contacts request represents the data needed to sell a contacts-only booking.\n " additionalProperties: false required: - contacts properties: contacts: type: array description: "The contacts for the new booking.\n " items: $ref: '#/components/schemas/Contact' Availabilityv2: type: object description: "Availabilityv2 represents the availability response based on the search criteria.\n " additionalProperties: false properties: results: type: - array - 'null' description: "The collection of trip results based on date and markets.\n " items: $ref: '#/components/schemas/TripResult' faresAvailable: type: - object - 'null' description: "The aggregate collection of fares available for all the provided journeys.\n " additionalProperties: $ref: '#/components/schemas/FareReference' currencyCode: type: - string - 'null' description: "The currency code for all displayed fares.\n " maxLength: 17 minLength: 0 includeTaxesAndFees: type: boolean description: "Flag indicating if the trip includes taxes and fees.\n " bundleOffers: type: - object - 'null' description: "The collection of service bundle offers available for all the provided journeys, if requested.\n " additionalProperties: $ref: '#/components/schemas/BundleOffer' OrderFeeType: type: integer description: "Defines the travel commerce fee types.\n \n\n0 = Default\n1 = Tax\n2 = Markup\n3 = Discount" x-enumNames: - Default - Tax - Markup - Discount enum: - 0 - 1 - 2 - 3 DeltaMapperOfTripOperationDelayEditRequest: type: object description: "Map delta changes of a specific type T to another object.\n " additionalProperties: false properties: delayMinutes: type: integer description: "The number of minutes for this delay.\n " note: type: string description: "The note for this delay, containing extra information about the delay\n(if any).\n " maxLength: 128 minLength: 1 includeMvtMessage: type: boolean description: "The flag to include the MVT message.\n " BundleControlFilter: type: integer description: "Filter used to segregate the bundle information to return on flight availability.\n \n\n0 = Disabled\n1 = ReturnBundleSets\n2 = ReturnBundleOffers" x-enumNames: - Disabled - ReturnBundleSets - ReturnBundleOffers enum: - 0 - 1 - 2 GssStayType: type: integer description: "The type of stay type.\n \n\n0 = None\n1 = Vacation\n2 = Business\n3 = Duty" x-enumNames: - None - Vacation - Business - Duty enum: - 0 - 1 - 2 - 3 IJsonResponseOfIListOfTripInformationResponsev2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: $ref: '#/components/schemas/TripInformationResponsev2' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' AmountDue: type: object description: "Defines the amounts due for an order.\n " additionalProperties: false properties: preTax: type: - number - 'null' description: "The pre tax total.\n " format: decimal tax: type: - number - 'null' description: "The tax total.\n " format: decimal total: type: - number - 'null' description: "The total.\n " format: decimal AddOnOrderSummary: type: object description: "Defines the details about an order if the order is not available.\n " additionalProperties: false properties: total: type: number description: "The total price of the order.\n " format: decimal held: type: number description: "The total held amount of the order.\n " format: decimal charged: type: number description: "The total charged amount of the order.\n " format: decimal supplierCode: type: - string - 'null' description: "The order's supplier code.\n " beginDate: type: string description: "The order's begin date.\n " format: date-time beginLocation: type: - string - 'null' description: "The order's begin location code.\n " endDate: type: string description: "The order's end date.\n " format: date-time endLocation: type: - string - 'null' description: "The order's end location code.\n " externalReference: type: - string - 'null' description: "The order's supplier external reference (record locator).\n " description: type: - string - 'null' description: "The order's description.\n " externalConfirmationNumber: type: - string - 'null' description: "The order's supplier external confirmation number.\n " FareClassControl: type: integer description: "Fare class control enumeration for controlling the number and type of fares applied to the search response.\n \n\n0 = LowestFareClass\n1 = CompressByProductClass\n2 = Default" x-enumNames: - LowestFareClass - CompressByProductClass - Default enum: - 0 - 1 - 2 PassengerPriceBreakdown: type: object description: "Defines the individual passenger-level pricing breakdown.\n " additionalProperties: false properties: services: description: "The charge breakdown of the service fees.\n " $ref: '#/components/schemas/ChargeBreakdown' specialServices: description: "The charge breakdown of the special service requests.\n " $ref: '#/components/schemas/ChargeBreakdown' seats: description: "The charge breakdown of seat fees.\n " $ref: '#/components/schemas/ChargeBreakdown' upgrades: description: "The charge breakdown of upgrade fees.\n " $ref: '#/components/schemas/ChargeBreakdown' spoilage: description: "The charge breakdown of spoilage fees.\n " $ref: '#/components/schemas/ChargeBreakdown' nameChanges: description: "The charge breakdown of name change fees.\n " $ref: '#/components/schemas/ChargeBreakdown' convenience: description: "The charge breakdown of convenience fees.\n " $ref: '#/components/schemas/ChargeBreakdown' infant: description: "The charge breakdown of infant fees.\n " $ref: '#/components/schemas/ChargeBreakdown' totalCost: type: - number - 'null' description: "The total cost for the passenger.\nThese values are only populated by NewSkies after a booking commit\n " format: decimal passengerKey: type: - string - 'null' description: "The unique passenger number.\n " InputedParameter: type: object description: "Defines a parameter with data input.\n " additionalProperties: false properties: code: type: - string - 'null' description: "The unique code for a supplier parameter.\n " description: type: - string - 'null' description: "The description.\n " value: type: - string - 'null' description: "The parameters value.\n " SeatPreference: type: object description: "Represents a single seat preference.\n " additionalProperties: false required: - seatMapCode - value properties: seatMapCode: type: string description: "The seat map code (ex. 'SMOKING').\n " maxLength: 8 minLength: 0 value: type: string description: "The seat map value (ex. 'TRUE').\n " maxLength: 8 minLength: 0 status: description: "Defines if the seat preference is met, not met or unknown.\n " $ref: '#/components/schemas/SeatPreferenceStatus' Fare: type: object description: "Model describing a fare.\n " additionalProperties: false properties: carrierCode: type: - string - 'null' description: "The fares carrier code.\n " maxLength: 3 minLength: 2 classOfService: type: - string - 'null' description: "The class of service.\n " maxLength: 8 minLength: 0 fareApplicationType: description: "The type of the fare application.\n " $ref: '#/components/schemas/FareApplicationType' fareBasisCode: type: - string - 'null' description: "The fare basis code.\n " maxLength: 8 minLength: 0 inboundOutBound: description: "The inbound and outbound.\n " $ref: '#/components/schemas/InboundOutbound' isAllotmentMarketFare: type: boolean description: "Gets or sets a value indicating whether this fare is an allotment marker.\n " ruleNumber: type: - string - 'null' description: "The rule number.\n " maxLength: 4 minLength: 0 ruleTariff: type: - string - 'null' description: "The rule tariff.\n " maxLength: 4 minLength: 0 pricingDate: type: string description: "The pricing date.\n " format: date-time fareDesignator: description: "The fare designator.\n " $ref: '#/components/schemas/FareDesignator' isGoverning: type: boolean description: "Flag that indicates if the fare is the governing fare.\n " fareKey: type: - string - 'null' description: "Unique key for this type of fare.\n " classType: type: - string - 'null' description: "The fares type of the class.\n " fareClassOfService: type: - string - 'null' description: "The fare class of service.\n " maxLength: 8 minLength: 0 fareSequence: type: integer description: "The fare sequence.\n " maximum: 32767.0 minimum: 0.0 fareStatus: description: "The fare status.\n " $ref: '#/components/schemas/FareStatus' originalClassOfService: type: - string - 'null' description: "The original class of service.\n " maxLength: 8 minLength: 0 productClass: type: - string - 'null' description: "The product class.\n " maxLength: 2 minLength: 0 travelClassCode: type: - string - 'null' description: "The travel class code.\nPlease note that this should be a char and not a string.\n " maxLength: 1 crossReferenceClassOfService: type: - string - 'null' description: "The cross reference class of service.\n " maxLength: 8 minLength: 0 passengerFares: type: - array - 'null' description: "The collection of passenger fares.\n " items: $ref: '#/components/schemas/PassengerFare' fareLink: type: integer description: "The fare link.\n " maximum: 32767.0 minimum: 0.0 HistoryCategory: type: integer description: "Represents the various history report types.\n \n\n0 = Unknown\n1 = Baggage\n2 = BagTagPrint\n3 = BoardingPassPrint\n4 = CheckIn\n5 = ClassOfServiceChange\n6 = Comment\n7 = ConfirmedSegment\n8 = ContactChange\n9 = Converted\n10 = CouponOverride\n11 = DividePnr\n12 = FareOverride\n13 = Fee\n14 = FlightMove\n15 = GroupNameChange\n16 = Hold\n17 = ItinerarySent\n18 = ManualPayment\n19 = MoveBackPnr\n20 = NameChange\n21 = NameRemove\n22 = Payment\n23 = Pds\n24 = Promotion\n25 = QueuePlaceRemove\n26 = RecordLocator\n27 = ScheduleCancelllation\n28 = ScheduleCodeShareChange\n29 = ScheduleFlightDesignatorChange\n30 = ScheduleTimeChange\n31 = SeatAssignment\n32 = SegmentChange\n33 = Reprice\n34 = SsrChange\n35 = StandByChange\n36 = TicketNumber\n37 = VerifiedTravelDocument\n38 = Apps\n39 = InhibitedOverride\n40 = CustomIdChange\n41 = HoldDateChange\n42 = AddedTravelDocument\n43 = ChangedTravelDocument\n44 = ChangedPayment" x-enumNames: - Unknown - Baggage - BagTagPrint - BoardingPassPrint - CheckIn - ClassOfServiceChange - Comment - ConfirmedSegment - ContactChange - Converted - CouponOverride - DividePnr - FareOverride - Fee - FlightMove - GroupNameChange - Hold - ItinerarySent - ManualPayment - MoveBackPnr - NameChange - NameRemove - Payment - Pds - Promotion - QueuePlaceRemove - RecordLocator - ScheduleCancelllation - ScheduleCodeShareChange - ScheduleFlightDesignatorChange - ScheduleTimeChange - SeatAssignment - SegmentChange - Reprice - SsrChange - StandByChange - TicketNumber - VerifiedTravelDocument - Apps - InhibitedOverride - CustomIdChange - HoldDateChange - AddedTravelDocument - ChangedTravelDocument - ChangedPayment enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 - 32 - 33 - 34 - 35 - 36 - 37 - 38 - 39 - 40 - 41 - 42 - 43 - 44 IJsonResponseOfTripStatusv2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/TripStatusv2' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' PassengerFareAvailability: type: object description: "Model describing common fare availability information for an entire availability request.\n " additionalProperties: false required: - passengerType properties: fareDiscountCode: type: - string - 'null' description: "The fare discount code.\n " maxLength: 8 minLength: 0 passengerDiscountCode: type: - string - 'null' description: "The passenger discount code.\n " maxLength: 4 minLength: 0 passengerType: type: string description: "The type of the passenger.\n " maxLength: 4 minLength: 0 fareAmount: type: number description: "The passenger fare total fare amount.\n " format: decimal revenueFare: type: number description: "The passenger fare revenue fare amount.\n " format: decimal publishedFare: type: number description: "The passenger fare published fare amount.\n " format: decimal loyaltyPoints: type: number description: "The passenger fare loyalty points.\n " format: decimal discountedFare: type: number description: "The discounted fare amount.\n " format: decimal serviceCharges: type: - array - 'null' description: "The service charges.\n " items: $ref: '#/components/schemas/ServiceCharge' multiplier: type: integer description: "The number of passengers with the same fare information represented by passenger type and discount code pair.\n " maximum: 32767.0 minimum: 1.0 deprecated: true x-deprecatedMessage: 4.4.5 - This property has been obsoleted and will be removed in a future version, as the multiplier could yield inaccurate numbers. Please use actual fare availability data to derive the correct multiplier. ticketFareBasis: type: - string - 'null' description: "A fare basis alias which is a more descriptive and custom value than the fare basis itself.\nThis value is created in FareManager Plus based on specific fare rule categories and ATPCO documentation.\n " SoldAsConnectionType: type: integer description: "Enum to define if a connection is sold as domestic or international.\n \n\n0 = None\n1 = Domestic\n2 = International\n3 = Both" x-enumNames: - None - Domestic - International - Both enum: - 0 - 1 - 2 - 3 PassengerVoucherCustomerProgram: type: object description: "Defines the passenger voucher customer program.\n " additionalProperties: false properties: programCode: type: - string - 'null' description: "The program code.\n " programNumber: type: - string - 'null' description: "The program number.\n " NestType: type: integer description: "Nest type enumeration.\n \n\n0 = Default\n1 = Net\n2 = Serial\n3 = OneBooking" x-enumNames: - Default - Net - Serial - OneBooking enum: - 0 - 1 - 2 - 3 FareReferenceTotals: type: object description: "The fare reference totals represents the sum of all the fares for a specific available journey fare. If individual\npassenger fare breakdown in needed that will need to be calculated using the master fare collection.\n " deprecated: true x-deprecatedMessage: 4.4.5 - This model has been obsoleted and will be removed in a future version, as the totals could yield inaccurate numbers. Please use actual fare availability data to derive the correct total amounts. additionalProperties: false properties: fareTotal: type: - number - 'null' description: "The fares total.\n " format: decimal deprecated: true x-deprecatedMessage: 4.4.5 - This property has been obsoleted and will be removed in a future version, as the totals could yield inaccurate numbers. Please use actual fare availability data to derive the correct total amounts. revenueTotal: type: - number - 'null' description: "The fares revenue total.\n " format: decimal deprecated: true x-deprecatedMessage: 4.4.5 - This property has been obsoleted and will be removed in a future version, as the totals could yield inaccurate numbers. Please use actual fare availability data to derive the correct total amounts. publishedTotal: type: - number - 'null' description: "The fares published total.\n " format: decimal deprecated: true x-deprecatedMessage: 4.4.5 - This property has been obsoleted and will be removed in a future version, as the totals could yield inaccurate numbers. Please use actual fare availability data to derive the correct total amounts. loyaltyTotal: type: - number - 'null' description: "The fares loyalty total.\n " format: decimal deprecated: true x-deprecatedMessage: 4.4.5 - This property has been obsoleted and will be removed in a future version, as the totals could yield inaccurate numbers. Please use actual fare availability data to derive the correct total amounts. discountedTotal: type: - number - 'null' description: "The fares discounted total.\n " format: decimal deprecated: true x-deprecatedMessage: 4.4.5 - This property has been obsoleted and will be removed in a future version, as the totals could yield inaccurate numbers. Please use actual fare availability data to derive the correct total amounts. AvailableJourneyFareDetail: type: object description: "The available journey fare details represents a journeys fare availability.\n " additionalProperties: false properties: availableCount: type: - integer - 'null' description: "The availability left.\n " status: description: "The classes status.\n " $ref: '#/components/schemas/ClassStatus' reference: type: - string - 'null' description: "The reference to the fare in the master fare collection.\n " serviceBundleSetCode: type: - string - 'null' description: "Service bundle set code.\n " bundleReferences: type: - array - 'null' description: "The references to the service bundle offers in the master bundle offer collection.\n " items: type: string ssrReferences: type: - array - 'null' description: "The SSR references that correspond to the applicable SSR prices in AvailabilityWithSSRResponse's IncludedSsrs.\n " items: type: string TripOperationDelayCreateRequest: type: object description: "Represents a delay for a trip operation.\n " additionalProperties: false required: - note - delayCode properties: delayMinutes: type: integer description: "The number of minutes for this delay.\n " note: type: string description: "The note for this delay, containing extra information about the delay\n(if any).\n " maxLength: 128 minLength: 1 includeMvtMessage: type: boolean description: "The flag to include the MVT message.\n " delayCode: type: string description: "The delay code.\n " maxLength: 4 minLength: 1 PassengerEmdCoupon: type: object description: "Model information for the passenger EMD coupon.\n " additionalProperties: false properties: status: description: "The EMD coupon status.\n " $ref: '#/components/schemas/EmdCouponStatus' emdTypeCode: description: "The EMD type code.\n " $ref: '#/components/schemas/EmdTypeCode' passengerEmdCouponKey: type: - string - 'null' description: "The unique identifier for a passenger EMD coupon.\n " emdNumber: type: - string - 'null' description: "The 13 digit passenger EMD number, assigned after the EMD has been issued.\n " maxLength: 13 minLength: 0 couponNumber: type: integer description: "The EMD coupon number, assigned after the EMD has been issued.\nTODO: In SkySpeed this is 0-4 only\n " maximum: 32767.0 minimum: 0.0 optionalServiceInformation: description: "The optional service information.\n " $ref: '#/components/schemas/OptionalServiceInformation' salesDate: type: - string - 'null' description: "The sale date.\n " format: date-time flightReference: type: - string - 'null' description: "The EMD flight reference.\n " maxLength: 22 minLength: 0 receivedFromSystemCode: type: - string - 'null' description: "The received from system code.\n " maxLength: 3 minLength: 0 numberOfServices: type: integer description: "The number of services.\n " maximum: 32767.0 minimum: 1.0 feeType: description: "The EMD related fee type.\n " $ref: '#/components/schemas/FeeType' feeKey: type: - string - 'null' description: "The EMD related fee key.\n " ssrCode: type: - string - 'null' description: "The EMD related SSR code.\n " maxLength: 4 minLength: 0 ssrNumber: type: - integer - 'null' description: "The EMD related SSR code.\n " ReceivedByInfo: type: object description: "Defines the received by information.\n " additionalProperties: false properties: receivedBy: type: - string - 'null' description: "The received by name.\n " maxLength: 64 minLength: 0 latestReceivedBy: type: - string - 'null' description: "The latest received by name.\n " maxLength: 64 minLength: 0 receivedReference: type: - string - 'null' description: "The received by reference.\n " maxLength: 20 minLength: 0 latestReceivedReference: type: - string - 'null' description: "The latest received by reference.\n " maxLength: 20 minLength: 0 referralCode: type: - string - 'null' description: "The referral code.\n " maxLength: 12 minLength: 0 CollectType: type: integer description: "Used to identify the collect type of a service charge.\n \n\n0 = SellerChargeable\n1 = ExternalChargeable\n2 = SellerNonChargeable\n3 = ExternalNonChargeable\n4 = ExternalChargeableImmediate" x-enumNames: - SellerChargeable - ExternalChargeable - SellerNonChargeable - ExternalNonChargeable - ExternalChargeableImmediate enum: - 0 - 1 - 2 - 3 - 4 PassengerFare: type: object description: "Model that represents the passenger fare details.\n " additionalProperties: false required: - passengerType properties: fareDiscountCode: type: - string - 'null' description: "The fare discount code.\n " maxLength: 8 minLength: 0 passengerType: type: string description: "The type of the passenger.\n " maxLength: 4 minLength: 0 serviceCharges: type: - array - 'null' description: "The service charges.\n " items: $ref: '#/components/schemas/ServiceCharge' discountCode: type: - string - 'null' description: "The passenger discount code.\n " maxLength: 4 minLength: 0 ticketFareBasis: type: - string - 'null' description: "A fare basis alias which is a more descriptive and custom value than the fare basis itself. \nThis value is created in FareManager Plus based on specific fare rule categories and ATPCO documentation.\n " OrderFee: type: object description: "Defines a order fee.\n " additionalProperties: false properties: code: type: - string - 'null' description: "The fee code.\n " feeCategoryCode: type: - string - 'null' description: "The charge type code.\n " description: type: - string - 'null' description: "The fee description.\n " amount: description: "The fees amounts.\n " $ref: '#/components/schemas/Amount' foreignAmount: description: "The fees foreign amounts.\n " $ref: '#/components/schemas/Amount' type: description: "The type of fee applied.\n " $ref: '#/components/schemas/OrderFeeType' isWaiveable: type: boolean description: "Flag indicating if they specific fee is waiveable.\n " foreignCurrencyCode: type: - string - 'null' description: "The foreign currency code.\n " currencyCode: type: - string - 'null' description: "The currency code.\n " isChargeable: type: boolean description: "The currency code.\n " OperationsInformation: type: object description: "Model describing the operations information.\n " additionalProperties: false properties: arrivalGate: description: "The arrival gate information.\n " $ref: '#/components/schemas/GateInformation' departureGate: description: "The departure gate information.\n " $ref: '#/components/schemas/GateInformation' actualOffBlockTime: type: - string - 'null' description: "The actual off block time.\n " format: date-time actualOnBlockTime: type: - string - 'null' description: "The actual on block time.\n " format: date-time actualTouchDownTime: type: - string - 'null' description: "The actual touch down time.\n " format: date-time airborneTime: type: - string - 'null' description: "The airborne time.\n " format: date-time arrivalNote: type: - string - 'null' description: "The arrival note.\n " maxLength: 128 minLength: 0 arrivalStatus: description: "The arrival status.\n " $ref: '#/components/schemas/ArrivalStatus' baggageClaim: type: - string - 'null' description: "The baggage claim.\n " maxLength: 10 minLength: 0 departureNote: type: - string - 'null' description: "The departure note.\n " maxLength: 128 minLength: 0 departureStatus: description: "The departure status.\n " $ref: '#/components/schemas/DepartureStatus' departureTimes: description: "The departure time information.\n " $ref: '#/components/schemas/DepartureEvent' standardArrivalTime: type: - string - 'null' description: "The standard time of arrival (STA).\n " format: date-time tailNumber: type: - string - 'null' description: "The tail number.\n " maxLength: 10 minLength: 0 estimatedArrivalTime: type: - string - 'null' description: "The estimated time of arrival (ETA).\n " format: date-time PaymentAmounts: type: object description: "Defines the different applied payment amounts for a single payment.\n " additionalProperties: false properties: amount: type: number description: "The amount in the booking currency (based off the origin).\n " format: decimal currencyCode: type: - string - 'null' description: "The payment amount currency code.\n " maxLength: 3 minLength: 0 collected: type: number description: "The collected amount post DCC or MCC.\n " format: decimal collectedCurrencyCode: type: - string - 'null' description: "The collected amounts currency code.\n " maxLength: 3 minLength: 0 quoted: type: number description: "The pre DCC or MCC amount (maybe different than the booking).\n " format: decimal quotedCurrencyCode: type: - string - 'null' description: "The quoted currency code.\n " maxLength: 3 minLength: 0 BookingProfileStatus: type: integer description: "Defines the profiling status of the booking.\n \n\n0 = Default\n1 = KnownIndividual\n2 = ResolutionGroup\n3 = SelecteeGroup\n4 = NotUsed\n5 = FailureGroup\n6 = RandomSelectee\n7 = Exempt" x-enumNames: - Default - KnownIndividual - ResolutionGroup - SelecteeGroup - NotUsed - FailureGroup - RandomSelectee - Exempt enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 QueueAction: type: integer description: "Specifies the basics by which a queue filter was created.\n \n\n0 = Default\n1 = Warning\n2 = Lock\n3 = DefaultAndNotify\n4 = WarningAndNotify\n5 = LockAndNotify" x-enumNames: - Default - Warning - Lock - DefaultAndNotify - WarningAndNotify - LockAndNotify enum: - 0 - 1 - 2 - 3 - 4 - 5 TripOperationCommentEditRequest: type: object description: "Represents a comment for a trip operation.\n " additionalProperties: false required: - text properties: text: type: string description: "The note for this delay, containing extra information about the delay\n(if any).\n " maxLength: 800 minLength: 1 TripInformationQuery: type: object description: "The trip information query model contains data to perform a\ntrip information search.\n " additionalProperties: false required: - beginDate properties: endDate: type: - string - 'null' description: "The end date of the trip information search.\n " format: date-time startTimeInterval: type: - string - 'null' description: "The starting time of the trip information search.\n " format: duration endTimeInterval: type: - string - 'null' description: "The end time of the trip information search.\n " format: duration carrierCode: type: - string - 'null' description: "The carrier code.\n " maxLength: 3 minLength: 2 beginDate: type: string description: "The starting date of the trip information search.\n " format: date-time minLength: 1 identifier: type: - string - 'null' description: "The transportation identifier, such as a flight number.\n " maxLength: 4 minLength: 0 flightType: description: "The flight type.\n " $ref: '#/components/schemas/OperationsFlightType' daysOfWeek: type: - array - 'null' description: "The days of the week to include in the provided date range.\n " items: $ref: '#/components/schemas/DayOfWeek' equipmentFilter: description: "The optional equipment filter for the search.\n " $ref: '#/components/schemas/EquipmentFilter' originStations: type: - array - 'null' description: "The list of departure stations.\n " items: type: string destinationStations: type: - array - 'null' description: "The list of arrival stations.\n " items: type: string opSuffix: type: - string - 'null' description: "The operational suffix.\nPlease note that this should be a char and not a string.\n " maxLength: 1 searchXRef: type: boolean description: "Indicates whether to include marketing code share segments.\nSetting this flag to true will request all marketing code share segments\nin addition to the operational ones.\n " excludeMarketedFlights: type: boolean description: "When set to true, all flights with a non-blank operating carrier are filtered out of the result.\nThe DB calls the parameter noOperatingCarrier.\n " numberOfJourneys: type: - integer - 'null' description: "When set to null, 100 journeys will be returned.\nThis endpoint will never return more than 100 journeys.\n " format: int32 Order: type: object description: "Defines a order.\n " additionalProperties: false properties: orderKey: type: - string - 'null' description: "The unique order key.\n " active: type: boolean description: "Flag indicating if the order is active.\n " criteria: description: "The specific order criteria.\n " $ref: '#/components/schemas/OrderCriteria' thumbnailFileName: type: - string - 'null' description: "The thumbnail file name.\n " quantity: type: integer description: "The quantity.\n " format: int32 usageDate: type: string description: "The usage date for this order.\n " format: date-time externalLocator: type: - string - 'null' description: "The third party external locator.\n " description: type: - string - 'null' description: "The orders description.\n " descriptionFormatType: type: - string - 'null' description: "The order descriptions format type.\n " productDescription: type: - string - 'null' description: "The products description.\n " productVariationDescription: type: - string - 'null' description: "The products variations description.\n " paymentAction: description: "The payment action.\n " $ref: '#/components/schemas/PaymentAction' amounts: description: "The pricing breakdown.\n " $ref: '#/components/schemas/OrderPriceBreakdown' terms: type: - array - 'null' description: "The collection of terms and conditions.\n " items: $ref: '#/components/schemas/Term' cancellationTerms: type: - array - 'null' description: "The collection of cancellation terms and conditions.\n " items: $ref: '#/components/schemas/Term' details: type: - array - 'null' description: "The collection of product variation details.\n " items: $ref: '#/components/schemas/ProductVariationDetail' fees: type: - array - 'null' description: "The collection of applied fees.\n " items: $ref: '#/components/schemas/OrderFee' notes: type: - array - 'null' description: "The collection of notes about the order.\n " items: $ref: '#/components/schemas/OrderNote' productVariationKey: type: - string - 'null' description: "The unique product variation key.\n " productOrderKey: type: - string - 'null' description: "The unique product order key.\n " address: description: "The orders address.\n " $ref: '#/components/schemas/OrderAddress' phoneNumbers: type: - array - 'null' description: "The collection of available phone numbers.\n " items: $ref: '#/components/schemas/PhoneNumber' locations: type: - array - 'null' description: "The collection of order locations.\n " items: $ref: '#/components/schemas/OrderLocation' customer: description: "The oder customer.\n " $ref: '#/components/schemas/OrderCustomer' participants: type: - object - 'null' description: "The collection of order participants.\n " additionalProperties: $ref: '#/components/schemas/OrderParticipant' history: type: - array - 'null' description: "The collection of order history entry history.\n " items: $ref: '#/components/schemas/OrderHistory' payment: description: "The applied payment.\n " $ref: '#/components/schemas/OrderPayment' parameters: type: - array - 'null' description: "The collection of dynamic order input parameters.\n " items: $ref: '#/components/schemas/InputedParameter' PassengerSegment: type: object description: "Model data for the passenger on the booking for the specific segment.\n " additionalProperties: false properties: seats: type: - array - 'null' description: "The seat details.\n " items: $ref: '#/components/schemas/PassengerSeat' passengerKey: type: - string - 'null' description: "The unique key of the passenger on the segment\n " activityDate: type: - string - 'null' description: "The activity date.\n " format: date-time boardingSequence: type: - string - 'null' description: "The passenger segment boarding sequence.\n " createdDate: type: - string - 'null' description: "The created date.\n " format: date-time liftStatus: description: "The lift status.\n " $ref: '#/components/schemas/LiftStatus' modifiedDate: type: - string - 'null' description: "The modified date.\n " format: date-time overBookIndicator: description: "The over book indicator.\n " $ref: '#/components/schemas/OverbookIndicatorTypes' priorityDate: type: - string - 'null' description: "The priority date.\n " format: date-time timeChanged: type: boolean description: "Gets or sets a value indicating whether the passenger segment time has changed.\n " verifiedTravelDocs: type: - string - 'null' description: "The verified travel docs. Please use VerifiedTravelDocuments instead.\n " maxLength: 44 minLength: 0 sourcePointOfSale: description: "The source point of sale.\n " $ref: '#/components/schemas/PointOfSale' pointOfSale: description: "The point of sale.\n " $ref: '#/components/schemas/PointOfSale' ssrs: type: - array - 'null' description: "The Ssr information for both the leg and segment.\n " items: $ref: '#/components/schemas/PassengerSsr' tickets: type: - array - 'null' description: "The ticket information.\n " items: $ref: '#/components/schemas/Ticket' bags: type: - array - 'null' description: "The baggage information.\n " items: $ref: '#/components/schemas/PassengerSegmentBag' scores: type: - array - 'null' description: "The collection of passenger scores.\n " items: $ref: '#/components/schemas/PassengerScore' boardingPassDetail: description: "The passengers boarding pass details.\n " $ref: '#/components/schemas/PassengerBoardingPassDetail' hasInfant: type: boolean description: "Flag indicating if the passenger has an infant for the specific segment.\n " seatPreferences: description: "The passenger seat preferences.\n " $ref: '#/components/schemas/SeatPreferences' bundleCode: type: - string - 'null' description: "The bundle code associated with the passenger segment.\n " verifiedTravelDocuments: type: - array - 'null' description: "The travel document keys that have been verified at checkin.\n " items: type: string referenceNumber: type: integer description: "The reference number, used as an identifier by New Skies Rail customers for purposes\nof ticketing and check in.\n " format: int64 baggageGroupNumber: type: - integer - 'null' description: "The passenger's baggage group number.\n " baggageAllowanceUsed: type: boolean description: "Indicates whether the passenger segment baggage allowance is used.\n " baggageAllowanceWeight: type: integer description: "The passenger segment baggage allowance weight.\n " maximum: 32767.0 minimum: 0.0 baggageAllowanceWeightType: description: "The type of passenger segment baggage allowance weight.\n " $ref: '#/components/schemas/WeightType' stayType: description: "The stay type.\n " $ref: '#/components/schemas/GssStayType' infantStayType: description: "The stay type for an infant.\n " $ref: '#/components/schemas/GssStayType' ItinerarySegment: type: object description: "Represents the operation between board station and any subsequent off station\nwithin the same flight.\n " additionalProperties: false properties: isSeatmapViewable: type: boolean description: "Indicates if the seatmaps associated with the segment are retrievable.\nSets to `false` for passive segments, and `true` for non-passive segments.\n " identifier: description: "The transportation identifier.\n " $ref: '#/components/schemas/TransportationIdentifier' externalIdentifier: description: "The external transportation identifier.\n " $ref: '#/components/schemas/TransportationIdentifier' segmentType: description: "The type of the segment.\n " $ref: '#/components/schemas/SegmentTypes' designator: description: "This is a summary of all the legs on the segment. It will contain the details\nof the transportation from the first and last leg.\n " $ref: '#/components/schemas/TransportationDesignator' segmentKey: type: - string - 'null' description: "The unique identifier for the segment.\n " legs: type: - array - 'null' description: "The legs.\n " items: $ref: '#/components/schemas/ItineraryLeg' IJsonResponseOfTripDetails: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/TripDetails' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' PaymentMethodType: type: integer description: "Defines the payment method types.\n \n\n0 = ExternalAccount\n1 = PrePaid\n2 = AgencyAccount\n3 = CustomerAccount\n4 = Voucher\n5 = Loyalty" x-enumNames: - ExternalAccount - PrePaid - AgencyAccount - CustomerAccount - Voucher - Loyalty enum: - 0 - 1 - 2 - 3 - 4 - 5 TripResult: type: object description: "The trip results represents a wrapper class for the potential collection of multiple selected dates (flex days or\nrange) selected on the availability request.\n " additionalProperties: false properties: trips: type: - array - 'null' description: "The collection of available trip by date that contain a collection of markets.\n " items: $ref: '#/components/schemas/TripDateMarket' BookingHold: type: object description: "Defines the booking hold expiration.\n " additionalProperties: false properties: expiration: type: - string - 'null' description: "Defines the hold date and time expiration.\n " format: date-time OperationsFlightType: type: integer description: "Flight types enumeration for operations and schedules.\n \n\n0 = All\n1 = NonStop\n2 = Through\n3 = Direct\n4 = Connect" x-enumNames: - All - NonStop - Through - Direct - Connect enum: - 0 - 1 - 2 - 3 - 4 ProductTypeCode: type: integer description: "Defines the different travel commerce types.\n \n\n0 = Default\n1 = Insurance\n2 = Activity\n3 = Hotel\n4 = Car" x-enumNames: - Default - Insurance - Activity - Hotel - Car enum: - 0 - 1 - 2 - 3 - 4 CreatedAddOnDetails: type: object description: "Defines a component details.\n " additionalProperties: false properties: agentCode: type: - string - 'null' description: "The created agent code.\n " organizationCode: type: - string - 'null' description: "The created organization code.\n " domainCode: type: - string - 'null' description: "The created domain code.\n " locationCode: type: - string - 'null' description: "The created location code.\n " agentReference: type: - string - 'null' description: "The agent key.\n " date: type: string description: "The date created.\n " format: date-time PassengerPriceBreakdownBase: type: object description: "Defines the combined booking passengers pricing breakdown.\n " additionalProperties: false properties: services: description: "The charge breakdown of the service fees.\n " $ref: '#/components/schemas/ChargeBreakdown' specialServices: description: "The charge breakdown of the special service requests.\n " $ref: '#/components/schemas/ChargeBreakdown' seats: description: "The charge breakdown of seat fees.\n " $ref: '#/components/schemas/ChargeBreakdown' upgrades: description: "The charge breakdown of upgrade fees.\n " $ref: '#/components/schemas/ChargeBreakdown' spoilage: description: "The charge breakdown of spoilage fees.\n " $ref: '#/components/schemas/ChargeBreakdown' nameChanges: description: "The charge breakdown of name change fees.\n " $ref: '#/components/schemas/ChargeBreakdown' convenience: description: "The charge breakdown of convenience fees.\n " $ref: '#/components/schemas/ChargeBreakdown' infant: description: "The charge breakdown of infant fees.\n " $ref: '#/components/schemas/ChargeBreakdown' totalCost: type: - number - 'null' description: "The total cost for the passenger.\nThese values are only populated by NewSkies after a booking commit\n " format: decimal TripDateMarket: type: object description: "The trip date market represents a specific dates collection of markets.\n " additionalProperties: false properties: multipleOriginStations: type: boolean description: "Flag indicating if multiple origin stations exist in the journeys available by market dictionary.\n " multipleDestinationStations: type: boolean description: "Flag indicating if multiple destination stations exist in the journeys available by market dictionary.\n " date: type: string description: "The date all the different markets are for.\n " format: date-time journeysAvailableByMarket: type: - object - 'null' description: "The dictionary of available journeys for the date per market.\n " additionalProperties: type: array items: $ref: '#/components/schemas/AvailableJourney' ChargeType: type: integer description: "The type of a service charge.\n \n\n0 = FarePrice\n1 = Discount\n2 = IncludedTravelFee\n3 = IncludedTax\n4 = TravelFee\n5 = Tax\n6 = ServiceCharge\n7 = PromotionDiscount\n8 = ConnectionAdjustmentAmount\n9 = AddOnsPrice\n10 = FarePoints\n11 = DiscountPoints\n16 = IncludedAddOnsFee\n17 = AddOnsFee\n18 = AddOnsMarkup\n19 = FareSurcharge\n21 = AddOnsCancelFee\n22 = Calculated\n23 = Note\n24 = Points\n25 = DynamicFareAdjustment" x-enumNames: - FarePrice - Discount - IncludedTravelFee - IncludedTax - TravelFee - Tax - ServiceCharge - PromotionDiscount - ConnectionAdjustmentAmount - AddOnsPrice - FarePoints - DiscountPoints - IncludedAddOnsFee - AddOnsFee - AddOnsMarkup - FareSurcharge - AddOnsCancelFee - Calculated - Note - Points - DynamicFareAdjustment enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 16 - 17 - 18 - 19 - 21 - 22 - 23 - 24 - 25 AvailabilityCodeCriteriav2: type: object description: "Describes the different code criteria that can be set that can influence availability response.\n " additionalProperties: false properties: currencyCode: type: - string - 'null' description: "The currency code for fare pricing.\n " maxLength: 3 minLength: 0 promotionCode: type: - string - 'null' description: "The promotion code to be applied.\n " maxLength: 8 minLength: 0 sourceOrganization: type: - string - 'null' description: "The organization to use when evaluating availability of private fares. If specified, this organization code will\nalso be used for evaluation of any organization rules on sales taxes and travel fees (if included in the response).\nIf blank or not specified, the logged-in user's organization will be used.\n " maxLength: 10 minLength: 0 currentSourceOrganization: type: - string - 'null' description: "The current source point of sale organization on the PNR. May be blank or unspecified if the source point of sale\norganization has not yet been set on the PNR. If blank or unspecified, the logged-in user's organization will be\nused.\n " maxLength: 10 minLength: 0 TripSellRequestv2: type: object description: "Defines the data needed to sell journeys to a booking.\n " additionalProperties: false required: - passengers - currencyCode properties: keys: type: - array - 'null' description: "The collection of selected sell keys to be added to the booking.\n " items: $ref: '#/components/schemas/SellKey' passengers: description: "The collection of passengers.\n " $ref: '#/components/schemas/PassengerTypeCriteriav2' currencyCode: type: string description: "The desired currency code.\n " maxLength: 3 minLength: 1 infantCount: type: - integer - 'null' description: "The number of infants to be added.\n " format: int32 promotionCode: type: - string - 'null' description: "The promo code to apply.\n " maxLength: 8 minLength: 0 sourceOrganization: type: - string - 'null' description: "The acting source organization code.\n " maxLength: 10 minLength: 0 preventOverlap: type: - boolean - 'null' description: "Used to explicitly control support for flight overlaps. It works together with the ‘Allow Sell of Flight Overlap’\nrole setting. Overlaps will be allowed only when PreventOverlaps is FALSE and the user has permissions to sell\noverlaps.\n " suppressPassengerAgeValidation: type: - boolean - 'null' description: "Indicates if passenger and infant age validation will be skipped.\n " loyalty: description: "Controls whether to use monetary fares, points-based fares, or both.\nDefaults to monetary only.\n " $ref: '#/components/schemas/TripLoyaltyFilter' serviceBundleCodes: type: - array - 'null' description: "Optional list of bundle codes from a specific fare of a flight to be added to the booking if `ApplyServiceBundle`\nis set to `Yes` or `Copy`.\n " items: type: string applyServiceBundle: description: "Determines whether to sell bundles in the booking. Can also be used for cancel or rebook situations.\n " $ref: '#/components/schemas/ApplyServiceBundle' BookingHistory: type: object description: "Defines a booking history log entry.\n " additionalProperties: false properties: pointOfSale: description: "The point of sale.\n " $ref: '#/components/schemas/PointOfSale' sourcePointOfSale: description: "The source point of sale.\n " $ref: '#/components/schemas/PointOfSale' receivedBy: type: - string - 'null' description: "The received by name.\n " maxLength: 64 minLength: 0 receivedByReference: type: - string - 'null' description: "The received by reference number.\n " maxLength: 20 minLength: 0 createdDate: type: - string - 'null' description: "The the history entry was created.\n " format: date-time historyCategory: description: "The booking history report category.\n " $ref: '#/components/schemas/HistoryCategory' details: type: - string - 'null' description: "The the history report data.\n " event: description: "The specific history code.\n " $ref: '#/components/schemas/BookingHistoryEvent' ServiceBundleType: type: integer description: "Defines the types for bundles.\n \n\n0 = Included\n1 = AddOn" x-enumNames: - Included - AddOn enum: - 0 - 1 AvailableJourney: type: object description: "The available journey represents a specific date, market journey that can be sold.\n " additionalProperties: false properties: flightType: description: "The flight type of the journey.\n " $ref: '#/components/schemas/FlightType' stops: type: integer description: "The number of stops the journey will make.\n " format: int32 designator: description: "The journeys transportation designator.\n " $ref: '#/components/schemas/TransportationDesignator' journeyKey: type: - string - 'null' description: "The unique journey key.\n " segments: type: - array - 'null' description: "The collection of segments on the journey.\n " items: $ref: '#/components/schemas/AvailableSegment' fares: type: - array - 'null' description: "The collection of available fares to be sold for this journey.\n " items: $ref: '#/components/schemas/AvailableJourneyFare' notForGeneralUser: type: boolean description: "A value indicating whether the journey is for a general user.\n " ContactRequest: type: object description: "Defines a contact create request.\n " additionalProperties: false properties: cultureCode: type: - string - 'null' description: "The culture code.\n " maxLength: 17 minLength: 0 address: description: "The contact address.\n " $ref: '#/components/schemas/Address' emailAddress: type: - string - 'null' description: "The email address of the contact.\n " customerNumber: type: - string - 'null' description: "The customer number.\n " maxLength: 20 minLength: 0 sourceOrganization: type: - string - 'null' description: "Source organization.\n " maxLength: 10 minLength: 0 distributionOption: description: "The contact distribution option.\n " $ref: '#/components/schemas/DistributionOption' notificationPreference: description: "The notification preference of the contact.\n " $ref: '#/components/schemas/NotificationPreference' companyName: type: - string - 'null' description: "The company name.\n " maxLength: 64 minLength: 0 name: description: "The contact's name.\n " $ref: '#/components/schemas/Name' phoneNumbers: type: - array - 'null' description: "The collection of phone numbers.\nSupported types: Home, Work, Fax, Other.\nThis collections can only contain one number for each supported type.\n " items: $ref: '#/components/schemas/PhoneNumber' BundleOffer: type: object description: "The bundle offer model.\n " additionalProperties: false properties: bundleCode: type: - string - 'null' description: "The bundle code.\n " maxLength: 4 minLength: 0 serviceBundleType: description: "The type of the bundle\n " $ref: '#/components/schemas/ServiceBundleType' bundlePrices: type: - array - 'null' description: "A list of possible price variants of the service\nbundle and SSRs per journey in the availability.\n " items: $ref: '#/components/schemas/BundlePrice' Booking: type: object description: "Represents a full booking object.\n " additionalProperties: false properties: selfServiceMoveAvailable: type: boolean description: "The flag indicating whether self-service move is allowed.\n " bookingKey: type: - string - 'null' description: "The unique identifier.\n " recordLocator: type: - string - 'null' description: "The alphanumeric identifier assigned to a reservation when the record is created (created means when the booking\nwas submitted to the database).\n " maxLength: 12 minLength: 0 currencyCode: type: - string - 'null' description: "The currency in which the booking is created and priced.\n " maxLength: 3 minLength: 0 systemCode: type: - string - 'null' description: "The GDS/CRS code that requested the booking.\n " maxLength: 3 minLength: 0 groupName: type: - string - 'null' description: "The group name of the booking.\n " locators: description: "Booking locators used to define a booking.\n " $ref: '#/components/schemas/BookingRecordLocators' info: description: "Informational about the booking.\n " $ref: '#/components/schemas/BookingInfo' sales: description: "Details about the point of sale.\n " $ref: '#/components/schemas/BookingSales' typeOfSale: description: "Information about the type of sale the booking was.\n " $ref: '#/components/schemas/TypeOfSale' hold: description: "Defines the hold expiration.\n " $ref: '#/components/schemas/BookingHold' breakdown: description: "The booking pricing breakdown.\n " $ref: '#/components/schemas/BookingPriceBreakdown' receivedBy: description: "Details about what received the booking commit.\n " $ref: '#/components/schemas/ReceivedByInfo' contacts: type: - object - 'null' description: "The contacts on the booking by unique the contact type code.\nPlease note that this should be a dictionary of char keys and not a dictionary of string keys.\n " additionalProperties: $ref: '#/components/schemas/Contact' passengers: type: - object - 'null' description: "The list of passengers and information.\n " additionalProperties: $ref: '#/components/schemas/Passenger' journeys: type: - array - 'null' description: "The list of journeys and information.\n " items: $ref: '#/components/schemas/Journey' comments: type: - array - 'null' description: "The list of associated comments.\n " items: $ref: '#/components/schemas/BookingComment' queues: type: - array - 'null' description: "The list of information indicating which queue the booking is present in.\n " items: $ref: '#/components/schemas/BookingQueueInfo' history: type: - array - 'null' description: "The history of the booking since it was loaded into state.\n " items: $ref: '#/components/schemas/BookingHistory' payments: type: - array - 'null' description: "The list of applied payments.\n " items: $ref: '#/components/schemas/Payment' addOns: type: - object - 'null' description: "The list of components.\n " additionalProperties: $ref: '#/components/schemas/AddOn' orders: type: - array - 'null' description: "The list of booking orders.\n " items: $ref: '#/components/schemas/BookingOrder' QueueEventType: type: integer description: "Describes the different queue event types.\n \n\n0 = Default\n1 = BookingBalanceDue\n2 = BookingNegativeBalance\n3 = BookingCustomerComment\n4 = DeclinedPaymentInitial\n5 = DeclinedPaymentChange\n6 = FareOverride\n7 = ScheduleTimeChange\n8 = ScheduleTimeChangeMisconnect\n9 = ScheduleCancellation\n10 = FlightDesignatorChange\n11 = ReaccommodationMove\n12 = GdsCancelWithPendingPayment\n13 = InvalidPriceStatusOverride\n14 = FareRestrictionOverride\n15 = HeldBookings\n16 = InvalidPriceStatus\n17 = Watchlist\n18 = NonFlightServiceFee\n19 = NotAllTicketNumbersReceived\n20 = BookingSegmentOversold\n21 = ReaccommodationCancel\n22 = ExternalSsrAutoConfirmed\n23 = OpCarrierSegUpdate\n24 = OpCarrierSsrUpdate\n25 = OpCarrierOtherUpdate\n26 = NameChangeNotAllowed\n27 = InboundAscNotProcessed\n28 = OpCarrierInformationChange\n29 = BookingComponentUpdate\n30 = GroupBookings\n31 = BankDirectPnrOutOfBalance\n32 = NoSeatAssigned\n33 = SeatNumberChange\n34 = SsrNotSupportedOnNewSeat\n35 = FewerSeatPreferencesMetOnNewSeat\n36 = AosUnableToConfirmCancel\n37 = ETicketIssue\n38 = ETicketFollowup\n39 = InvoluntaryFlyAhead\n40 = ManualClearanceOnOutage\n41 = UnbalancedPoints\n42 = OpCarrierTimeChange\n43 = OaCarrierTimeChange\n44 = VoluntaryFlightChange\n45 = InvoluntaryFlightChange\n46 = HoldCancellationFailed\n47 = ScheduleTimeChangeWithDynamicQueueCode\n48 = ReaccommodationMoveWithDynamicQueueCode\n49 = ItineraryIntegrity\n50 = ReducePartyNotProcessed\n51 = CheckedPassengerUpdate\n52 = MustBeSeatGroupViolation\n57 = NameChangeWithinRule\n58 = IncompletePassengerEMDCoupon\n59 = ASVCUpdateFailed\n60 = FailedFareClassRealignment\n61 = ScheduleTimeChangeMisconnectBelowMinimum\n62 = ScheduleTimeChangeMisconnectAboveMaximum\n63 = OpCarrierMisconnect\n64 = InventoryQueuing\n65 = SelfServiceAsm\n66 = SelfServiceDelay\n67 = SelfServiceFlightCancellation\n68 = SelfServiceIrop\n69 = SelfServiceScheduleChange\n70 = SelfServiceTimeChange\n71 = AosAddOrCancelNotSuccessful\n72 = MissingGdsFareFamily\n73 = ChangeCabinQueue\n74 = PendingPaymentQueue\n75 = TicketDisplayToDetermineIncludedServiceBundleFailed\n76 = DuplicateTicketsInBooking\n77 = TicketCouponUpdateQueue\n78 = ETicketRefund\n79 = ExternalEticketVoidCheck\n80 = ExternalEticketVoidCheckFollowUp\n81 = NoAssignedSeatOnNewFlightFromEquipmentChange" x-enumNames: - Default - BookingBalanceDue - BookingNegativeBalance - BookingCustomerComment - DeclinedPaymentInitial - DeclinedPaymentChange - FareOverride - ScheduleTimeChange - ScheduleTimeChangeMisconnect - ScheduleCancellation - FlightDesignatorChange - ReaccommodationMove - GdsCancelWithPendingPayment - InvalidPriceStatusOverride - FareRestrictionOverride - HeldBookings - InvalidPriceStatus - Watchlist - NonFlightServiceFee - NotAllTicketNumbersReceived - BookingSegmentOversold - ReaccommodationCancel - ExternalSsrAutoConfirmed - OpCarrierSegUpdate - OpCarrierSsrUpdate - OpCarrierOtherUpdate - NameChangeNotAllowed - InboundAscNotProcessed - OpCarrierInformationChange - BookingComponentUpdate - GroupBookings - BankDirectPnrOutOfBalance - NoSeatAssigned - SeatNumberChange - SsrNotSupportedOnNewSeat - FewerSeatPreferencesMetOnNewSeat - AosUnableToConfirmCancel - ETicketIssue - ETicketFollowup - InvoluntaryFlyAhead - ManualClearanceOnOutage - UnbalancedPoints - OpCarrierTimeChange - OaCarrierTimeChange - VoluntaryFlightChange - InvoluntaryFlightChange - HoldCancellationFailed - ScheduleTimeChangeWithDynamicQueueCode - ReaccommodationMoveWithDynamicQueueCode - ItineraryIntegrity - ReducePartyNotProcessed - CheckedPassengerUpdate - MustBeSeatGroupViolation - NameChangeWithinRule - IncompletePassengerEMDCoupon - ASVCUpdateFailed - FailedFareClassRealignment - ScheduleTimeChangeMisconnectBelowMinimum - ScheduleTimeChangeMisconnectAboveMaximum - OpCarrierMisconnect - InventoryQueuing - SelfServiceAsm - SelfServiceDelay - SelfServiceFlightCancellation - SelfServiceIrop - SelfServiceScheduleChange - SelfServiceTimeChange - AosAddOrCancelNotSuccessful - MissingGdsFareFamily - ChangeCabinQueue - PendingPaymentQueue - TicketDisplayToDetermineIncludedServiceBundleFailed - DuplicateTicketsInBooking - TicketCouponUpdateQueue - ETicketRefund - ExternalEticketVoidCheck - ExternalEticketVoidCheckFollowUp - NoAssignedSeatOnNewFlightFromEquipmentChange enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 - 32 - 33 - 34 - 35 - 36 - 37 - 38 - 39 - 40 - 41 - 42 - 43 - 44 - 45 - 46 - 47 - 48 - 49 - 50 - 51 - 52 - 57 - 58 - 59 - 60 - 61 - 62 - 63 - 64 - 65 - 66 - 67 - 68 - 69 - 70 - 71 - 72 - 73 - 74 - 75 - 76 - 77 - 78 - 79 - 80 - 81 DayOfWeek: type: integer description: "Defines the day of the week with none as an option.\n \n\n0 = None\n1 = Monday\n2 = Tuesday\n3 = Wednesday\n4 = Thursday\n5 = Friday\n6 = Saturday\n7 = Sunday" x-enumNames: - None - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 ChangeReasonCodes: type: integer description: "Specifies the reason code on why the change on the journey or segment is performed.\n \n\n0 = NoChange\n1 = Irop\n2 = ScheduleChange\n3 = Move\n4 = VoluntaryFlyAhead\n5 = InvoluntaryFlyAhead\n6 = SelfServiceRebooking" x-enumNames: - NoChange - Irop - ScheduleChange - Move - VoluntaryFlyAhead - InvoluntaryFlyAhead - SelfServiceRebooking enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 TripInformationJourneyv2: type: object description: "Represents the trip information journey.\n " additionalProperties: false properties: designator: description: "This is a summary of all the segments on the journey. It will contain the details\nof the transportation from the first and last segment.\n " $ref: '#/components/schemas/TransportationDesignator' tripKey: type: - string - 'null' description: "Represents the trip key.\n " segments: type: - array - 'null' description: "Represents the collection of itinerary segments for this journey.\n " items: $ref: '#/components/schemas/ItinerarySegment' AuthorizationStatus: type: integer description: "Defines the different possible payment authorization states.\n \n\n0 = Unknown\n1 = Acknowledged\n2 = Pending\n3 = InProcess\n4 = Approved\n5 = Declined\n6 = Referral\n7 = PickUpCard\n8 = HotCard\n9 = Voided\n10 = Retrieval\n11 = ChargedBack\n12 = Error\n13 = ValidationFailed\n14 = Address\n15 = VerificationCode\n16 = FraudPrevention\n17 = ForcedApproval\n18 = ForcedDecline\n19 = NoResponse\n20 = BadResponse" x-enumNames: - Unknown - Acknowledged - Pending - InProcess - Approved - Declined - Referral - PickUpCard - HotCard - Voided - Retrieval - ChargedBack - Error - ValidationFailed - Address - VerificationCode - FraudPrevention - ForcedApproval - ForcedDecline - NoResponse - BadResponse enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 AvailableSegment: type: object description: "Available segment represents an available segment on a available journey.\n " additionalProperties: false properties: isSeatmapViewable: type: boolean description: "Indicates if the seatmaps associated with the segment are retrievable.\nSets to `false` for passive segments, and `true` for non-passive segments.\n " identifier: description: "The transportation identifier.\n " $ref: '#/components/schemas/TransportationIdentifier' externalIdentifier: description: "The external transportation identifier.\n " $ref: '#/components/schemas/TransportationIdentifier' segmentType: description: "The type of the segment.\n " $ref: '#/components/schemas/SegmentTypes' isChangeOfGauge: type: boolean description: "Flag indicating if the segment is a change of gauge.\n " isBlocked: type: boolean description: "Flag indicating if the segment is blocked.\n " isHosted: type: boolean description: "Flag indicating if the segment is hosted.\n " designator: description: "The segments transportation designator.\n " $ref: '#/components/schemas/TransportationDesignator' segmentKey: type: - string - 'null' description: "The unique segment key.\n " cabinOfService: type: - string - 'null' description: "The segments cabin of service.\nPlease note that this should be a char and not a string.\n " maxLength: 1 international: type: boolean description: "Flag indicating if the segment is international.\n " legs: type: - array - 'null' description: "The collection of legs on the segment.\n " items: $ref: '#/components/schemas/Leg' PaidStatus: type: integer description: "Paid status enumeration.\n \n\n0 = UnderPaid\n1 = PaidInFull\n2 = OverPaid" x-enumNames: - UnderPaid - PaidInFull - OverPaid enum: - 0 - 1 - 2 TripInformationResponsev2: type: object description: "A collection of journeys for a given departure date and market.\n " additionalProperties: false properties: date: type: - string - 'null' description: "Represents the date for the journey response.\n " format: date-time journeys: type: - array - 'null' description: "Represents the collection of journeys.\n " items: $ref: '#/components/schemas/TripInformationJourneyv2' TripInformationLegv2: type: object description: "Represents the trip information leg model.\n " additionalProperties: false properties: legKey: type: - string - 'null' description: "The unique identifier for the leg.\n " legDetails: description: "The additional details for the leg.\n " $ref: '#/components/schemas/LegDetailsv2' seatsSold: description: "Information relating to the number of seats sold for the leg.\n " $ref: '#/components/schemas/LegSeatsSold' designator: description: "The transportation designator.\n " $ref: '#/components/schemas/TransportationDesignator' identifier: description: "The transportation identifier.\n " $ref: '#/components/schemas/TransportationIdentifier' operatingInformation: description: "The leg's \"operated by\" information.\n " $ref: '#/components/schemas/OperatingInformation' PassengerSearchCriteriaDetail: type: object description: "Represents the passenger details for flight availability search.\n " additionalProperties: false properties: dateOfBirth: type: - string - 'null' description: "The passenger's date of birth.\n " format: date-time nationality: type: - string - 'null' description: "The passenger's nationality.\n " residentCountry: type: - string - 'null' description: "The passenger's resident country.\n " programCode: type: - string - 'null' description: "The customer program of the passenger.\n " programLevel: type: - string - 'null' description: "The customer program level of the passenger.\n " TransportationIdentifier: type: object description: "Represents the transportation identifier model data.\n " additionalProperties: false required: - identifier - carrierCode properties: identifier: type: string description: "The unique transportation identifier.\n " maxLength: 4 minLength: 0 carrierCode: type: string description: "The carrier code.\n " maxLength: 3 minLength: 2 opSuffix: type: - string - 'null' description: "The op suffix.\nPlease note that this should be a char and not a string.\n " maxLength: 1 IJsonResponseOfIListOfTripInformationLegv2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: $ref: '#/components/schemas/TripInformationLegv2' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' TripInformationStatusRequestBase: type: object description: "Represents the base trip information status request model.\n " additionalProperties: false properties: departureStatus: description: "The departure status.\n " $ref: '#/components/schemas/DepartureStatus' departureGate: type: - string - 'null' description: "The estimated departure gate.\n " actualDepartureGate: type: - string - 'null' description: "Represents the actual departure gate of the trip.\n " maxLength: 4 minLength: 0 arrivalStatus: description: "The arrival status.\n " $ref: '#/components/schemas/ArrivalStatus' arrivalGate: type: - string - 'null' description: "The estimated arrival gate.\n " actualArrivalGate: type: - string - 'null' description: "Represents the actual arrival gate of the trip.\n " maxLength: 4 minLength: 0 baggageClaim: type: - string - 'null' description: "The baggage claim.\n " tripOperationTimes: description: "The request to update the trip operation times.\n " $ref: '#/components/schemas/TripOperationTimesEditRequest' tripFuelDetails: description: "The trip fuel details.\n " $ref: '#/components/schemas/TripFuelDetails' irop: type: - boolean - 'null' description: "Indicates if the leg is designated as IROP.\n " tailNumber: type: - string - 'null' description: "The tail number of the aircraft. See /resources/tailNumbers for the list of all available tail numbers.\n " maxLength: 10 minLength: 0 passengerCounts: description: "The number of passengers and crew on board.\n " $ref: '#/components/schemas/TripPassengerCountsEditRequest' JourneySortKey: type: integer description: "Defines the sorting keys for the journeys on availability.\n \n\n0 = ServiceType\n1 = ShortestTravelTime\n2 = LowestFare\n3 = HighestFare\n4 = EarliestDeparture\n5 = LatestDeparture\n6 = EarliestArrival\n7 = LatestArrival\n8 = NoSort\n9 = BiasOnlineCommercialDuplicates\n10 = JourneyNumber" x-enumNames: - ServiceType - ShortestTravelTime - LowestFare - HighestFare - EarliestDeparture - LatestDeparture - EarliestArrival - LatestArrival - NoSort - BiasOnlineCommercialDuplicates - JourneyNumber enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 InventoryControlType: type: integer description: "Defines the different ways inventory is held at the time of sell.\n \n\n0 = HoldSpace\n1 = SoftHoldSpace\n2 = ClaimSpace\n3 = OversellSpace\n4 = StandBy" x-enumNames: - HoldSpace - SoftHoldSpace - ClaimSpace - OversellSpace - StandBy enum: - 0 - 1 - 2 - 3 - 4 ParticipantDocument: type: object description: "Defines a consumer document.\n " additionalProperties: false properties: number: type: - string - 'null' description: "The documents number.\n " issuedByCode: type: - string - 'null' description: "The documents issued by code.\n " documentTypeCode: type: - string - 'null' description: "The documents type code.\n " ItineraryVariation: type: object description: "Defines the schedule itinerary variation.\n " additionalProperties: false required: - flightIdentifier - itineraryLegs properties: flightIdentifier: description: "The identifier of the flight to be added.\n " $ref: '#/components/schemas/TransportationIdentifier' itineraryLegs: type: array description: "The legs of the flight to be added.\n " items: $ref: '#/components/schemas/ScheduleItineraryLeg' TicketStatusCode: type: integer description: "This enumeration defines the ticket availability status.\n \n\n0 = Unknown\n1 = TicketAvailableForUse\n2 = TicketUnavailableForUse\n3 = TicketReissueRequiredForPassenger\n4 = TicketReissueRequiredForInfant\n5 = TicketReissueRequiredForBoth\n6 = TicketReValidationRequired" x-enumNames: - Unknown - TicketAvailableForUse - TicketUnavailableForUse - TicketReissueRequiredForPassenger - TicketReissueRequiredForInfant - TicketReissueRequiredForBoth - TicketReValidationRequired enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 BookingPaymentStatus: type: integer description: "Determines if the booking has been paid for or not.\n \n\n0 = New\n1 = Received\n2 = Pending\n3 = Approved\n4 = Declined\n5 = Unknown\n6 = PendingCustomerAction" x-enumNames: - New - Received - Pending - Approved - Declined - Unknown - PendingCustomerAction enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 PassengerSeat: type: object description: "Model for a passenger seat for a segment.\n " additionalProperties: false properties: compartmentDesignator: type: - string - 'null' description: "The passenger seat compartment designator.\n " maxLength: 2 minLength: 0 penalty: type: integer description: "The passenger seat penalty.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 unitDesignator: type: - string - 'null' description: "The passenger seat unit designator.\n " seatInformation: description: "The passenger seat seat information.\n " $ref: '#/components/schemas/SeatInfo' arrivalStation: type: - string - 'null' description: "The leg arrival station.\n " maxLength: 3 minLength: 3 departureStation: type: - string - 'null' description: "The leg departure station.\n " maxLength: 3 minLength: 3 passengerKey: type: - string - 'null' description: "The passenger key associated with the seat.\n " unitKey: type: - string - 'null' description: "The seat's unique unit key.\n " crossReferenceSeatingPreference: type: - string - 'null' description: "The seating preference for non-hosted flight seating assignments.\nCould be either one of the following values:\nnull = seating preference is not applicable (usual value for hosted flights)\nN = no requested seating preference\nA = aisle\nW = window\nF = front seating location\nR = rear seating location\nAF = front seating location, on aisle\nAR = rear seating location, on aisle\nWF = front seating location, on window\nWR = rear seating location, on window\n " isPending: type: boolean description: "Determines whether or not the seat is pending request.\n " seatmapReference: type: - string - 'null' description: "The reference identifying what seat map the passenger seat is associated to.\n " TravelClassSeatPreference: type: integer description: "Represents a travel class seating preference.\n \n\n0 = None\n1 = Business\n2 = Economy\n3 = FirstClass" x-enumNames: - None - Business - Economy - FirstClass enum: - 0 - 1 - 2 - 3 AddOn: type: object description: "Defines a booking add on service details.\n " additionalProperties: false properties: paymentRequired: type: boolean description: "Returns true if the component requires a separate\npayment from the rest of the booking.\n " status: description: "The status of the add on.\n " $ref: '#/components/schemas/AddOnStatus' addOnKey: type: - string - 'null' description: "The unique add on key.\n " type: description: "The type of add on.\n " $ref: '#/components/schemas/ProductTypeCode' summary: description: "The components order summary when the order is not available.\n " $ref: '#/components/schemas/AddOnOrderSummary' reference: type: - string - 'null' description: "The component reference.\n " created: description: "The created by details.\n " $ref: '#/components/schemas/CreatedAddOnDetails' source: description: "The responsible source details.\n " $ref: '#/components/schemas/AddOnDetails' declinedText: type: - string - 'null' description: "The declined component text.\n " cultureCode: type: - string - 'null' description: "The culture code.\n " modifiedDate: type: string description: "The date the component was last modified.\n " format: date-time modifiedAgentReference: type: - string - 'null' description: "The agent reference that modified the component.\n " order: description: "The component order details.\n " $ref: '#/components/schemas/Order' isHistorical: type: boolean description: "Flag indicating if the component is historical.\n " charges: type: - array - 'null' description: "The collection of booking component charges.\n " items: $ref: '#/components/schemas/AddOnCharge' SegmentStatus: type: integer description: "The segment status.\n \n\n0 = UnknownStatus\n1 = UnableToConfirmSegment\n2 = UnableToSellSegment\n3 = HeldPending\n4 = WaitListConfirmed\n5 = HeldUnconfirmed\n6 = HeldConfirmed\n7 = HeldCancelled\n8 = Confirming\n9 = ConfirmingWaitList\n10 = ConfirmedTimeChange" x-enumNames: - UnknownStatus - UnableToConfirmSegment - UnableToSellSegment - HeldPending - WaitListConfirmed - HeldUnconfirmed - HeldConfirmed - HeldCancelled - Confirming - ConfirmingWaitList - ConfirmedTimeChange enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 JourneyPriceBreakdownBase: type: object description: "Defines the journey price breakdown base.\n " additionalProperties: false properties: totalAmount: type: number description: "The journey price total.\n " format: decimal totalPoints: type: number description: "The journey points total.\n " format: decimal totalTax: type: number description: "The journey taxes total.\n " format: decimal totalDiscount: type: number description: "The journey discount total.\n " format: decimal TypeOfSale: type: object description: "Defines the type of sale values.\n " additionalProperties: false properties: residentCountry: type: - string - 'null' description: "The resident country.\n " maxLength: 2 minLength: 0 promotionCode: type: - string - 'null' description: "The promo code that was applied.\n " maxLength: 8 minLength: 0 fareTypes: type: - array - 'null' description: "The collection of fare types applied.\n " items: type: string PassengerSsr: type: object description: "The model for a passengers Ssr details.\n " additionalProperties: false properties: note: type: - string - 'null' description: "The passenger SSR note.\n " maxLength: 128 minLength: 0 count: type: integer description: "The passenger SSR unit value.\n " maximum: 32767.0 minimum: 1.0 inBundle: type: boolean description: "Indicates if the SSR is part of a bundle.\n " ssrDuration: description: "The length of the Ssr duration.\n " $ref: '#/components/schemas/SsrDurationType' ssrCode: type: - string - 'null' description: "The passenger SSR code.\n " maxLength: 4 minLength: 0 passengerKey: type: - string - 'null' description: "The unique passenger key.\n " ssrNumber: type: - integer - 'null' description: "The passenger SSR number.\n " maximum: 32767.0 minimum: 0.0 market: description: "The market for either the leg or segment depending on the Ssr type.\n " $ref: '#/components/schemas/MarketInformation' isConfirmed: type: boolean description: "A status flag to indicate if the ssr has been confirmed or not.\n " isConfirmingUnheld: type: boolean description: "A status flag to indicate if the ssr is in a confirming unheld state.\n " ssrKey: type: - string - 'null' description: "The key that uniquely identifies the Ssr, passenger, and leg or segment.\n " feeCode: type: - string - 'null' description: "The SSR fee code.\n " maxLength: 6 minLength: 0 ssrDetail: type: - string - 'null' description: "The passenger SSR detail.\n " maxLength: 20 minLength: 0 TripLoyaltyFilter: type: integer description: "Trip loyalty filter enumeration for selling journeys on a booking.\n \n\n0 = MonetaryOnly\n1 = PointsOnly\n2 = PointsAndMonetary" x-enumNames: - MonetaryOnly - PointsOnly - PointsAndMonetary enum: - 0 - 1 - 2 ChargeBreakdown: type: object description: "Defines a charge breakdown.\n " additionalProperties: false properties: total: type: - number - 'null' description: "The total amount.\n " format: decimal taxes: type: - number - 'null' description: "The total fee taxes amount.\n " format: decimal adjustments: type: - number - 'null' description: "The total adjusted amount.\n " format: decimal charges: type: - array - 'null' description: "The collection of charges within the calculation.\n " items: $ref: '#/components/schemas/ServiceCharge' OrderLocation: type: object description: "Defines a location.\n " additionalProperties: false required: - code - usageDate properties: code: type: string description: "The unique location code.\n " minLength: 1 usageDate: type: string description: "The usage date at this location.\n " format: date-time minLength: 1 description: type: - string - 'null' description: "The location description.\n " utcOffset: type: number description: "The UTC offset.\n " format: float AvailabilityDateCriteria: type: object description: "Defines the availability criteria dates.\n " additionalProperties: false required: - beginDate properties: beginDate: type: string description: "The beginning date to include flights for.\n " format: date-time minLength: 1 startTimeInterval: type: - string - 'null' description: "The beginning time interval to include flights from regardless of the days.\n " format: duration endDate: type: - string - 'null' description: "The ending date to include flights for.\n " format: date-time endTimeInterval: type: - string - 'null' description: "The ending time interval to include flights from regardless of the days.\n " format: duration daysOfWeek: type: - array - 'null' description: "The days of the week to include in the provided date range.\n " items: $ref: '#/components/schemas/DayOfWeek' Gender: type: integer description: "Defines the different binary gender types.\n \n\n0 = XX\n1 = Male\n2 = Female" x-enumNames: - XX - Male - Female enum: - 0 - 1 - 2 TaxesAndFeesRollupMode: type: integer description: "Indicates how \"all-up\" service charges will be rolled-up in the availability response.\n \n\n0 = None\n1 = Taxes\n2 = TaxesAndFees" x-enumNames: - None - Taxes - TaxesAndFees enum: - 0 - 1 - 2 BundleProgramDetails: type: object description: "Represents the bundle program details model.\n " additionalProperties: false properties: code: type: - string - 'null' description: "The program code.\n " maxLength: 3 minLength: 0 level: type: - string - 'null' description: "The program level.\n " maxLength: 3 minLength: 0 AvailabilityCriteria: type: object description: "Defines a single direction search criteria far an availability call.\n " additionalProperties: false required: - stations - dates properties: stations: description: "The station criteria.\n " $ref: '#/components/schemas/AvailabilityStationCriteria' dates: description: "The date criteria.\n " $ref: '#/components/schemas/AvailabilityDateCriteria' filters: description: "Filters applied to the response for a single direction.\n " $ref: '#/components/schemas/AvailabilityCriteriaFilter' ssrCollectionsMode: description: "Determines if SSR nest information will be returned on the legs for each available journey segments.\n " $ref: '#/components/schemas/AvailabilitySsrCollectionsMode' FareStatus: type: integer description: "This enumeration defines the fare status of a passenger fare.\n \n\n0 = Default\n1 = SameDayStandBy\n2 = FareOverrideConfirming\n3 = FareOverrideConfirmed\n4 = PublishedFareOverrideConfirming\n5 = PublishedFareOverrideConfirmed" x-enumNames: - Default - SameDayStandBy - FareOverrideConfirming - FareOverrideConfirmed - PublishedFareOverrideConfirming - PublishedFareOverrideConfirmed enum: - 0 - 1 - 2 - 3 - 4 - 5 IJsonResponseOfBooking: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/Booking' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' FeeType: type: integer description: "Enumeration representing all the different fee types.\n \n\n0 = All\n1 = Tax\n2 = TravelFee\n3 = ServiceFee\n4 = PaymentFee\n5 = PenaltyFee\n6 = SsrFee\n7 = NonFlightServiceFee\n8 = UpgradeFee\n9 = SeatFee\n10 = BaseFare\n11 = SpoilageFee\n12 = NameChangeFee\n13 = ConvenienceFee\n14 = BaggageFee\n15 = FareSurcharge\n16 = PromotionDiscount\n17 = ServiceBundle\n18 = ExtraBagFee\n19 = ATPCOBagFee" x-enumNames: - All - Tax - TravelFee - ServiceFee - PaymentFee - PenaltyFee - SsrFee - NonFlightServiceFee - UpgradeFee - SeatFee - BaseFare - SpoilageFee - NameChangeFee - ConvenienceFee - BaggageFee - FareSurcharge - PromotionDiscount - ServiceBundle - ExtraBagFee - ATPCOBagFee enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 TripFuelDetails: type: object description: "Represents the fuel information for a trip.\n " additionalProperties: false properties: fuelOnboardOut: type: - integer - 'null' description: "Represents the amount of fuel onboard the aircraft/equipment upon departure.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 fuelOnboardIn: type: - integer - 'null' description: "Represents the amount of fuel onboard the aircraft/equipment upon arrival.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 upLiftFuel: type: - integer - 'null' description: "Represents the amount of fuel uplifted to the aircraft/equipment.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 AvailabilityFlightCriteria: type: object description: "The specific flight criteria for the availability criteria.\n " additionalProperties: false properties: carrierCode: type: - string - 'null' description: "The desired carrier code.\n " maxLength: 3 minLength: 2 flightNumber: type: - string - 'null' description: "The desired flight number.\n " maxLength: 4 minLength: 0 type: description: "The flight type filtering based on connections.\n " $ref: '#/components/schemas/FlightType' maxConnectingFlights: type: - integer - 'null' description: "The number of max connecting flights.\n " PaymentVoucherDetails: type: object description: "Payment voucher details. This describes a voucher applied to a payment.\n " additionalProperties: false properties: id: type: integer description: "The voucher ID.\n " format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 transactionId: type: integer description: "The vouchers transactions ID.\n " format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 overrideRestrictions: type: boolean description: "Flag indicating if the voucher restrictions were overridden.\n " overrideAmount: type: boolean description: "The amount applied of the voucher.\n " recordLocator: type: - string - 'null' description: "The record locator attached to the voucher.\n " maxLength: 12 minLength: 0 LegNest: type: object description: "A model representing a leg nest.\n " additionalProperties: false properties: adjustedCapacity: type: integer description: "Gets or sets the adjusted capacity of the nest.\n " classNest: type: integer description: "Gets or sets the nest class nest.\n " lid: type: integer description: "Gets or sets the nest lid.\n " travelClassCode: type: - string - 'null' description: "Gets or sets the nest travel class code.\nPlease note that this should be a char and not a string.\n " maxLength: 1 nestType: description: "Gets or sets the type of the nest.\n " $ref: '#/components/schemas/NestType' legClasses: type: - array - 'null' description: "Gets or sets the nest leg classes.\n " items: $ref: '#/components/schemas/LegClass' ItineraryLeg: type: object description: "Defines a single instance of non-stop travel between two stations.\n " additionalProperties: false properties: legKey: type: - string - 'null' description: "The unique identifier for this leg sell information.\n " designator: description: "Transportation information.\n " $ref: '#/components/schemas/TransportationDesignator' IJsonResponseOfIListOfScheduleDetail: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: $ref: '#/components/schemas/ScheduleDetail' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' FareReference: type: object description: "The fare reference represents a master reference of the full fare details.\n " additionalProperties: false properties: totals: description: "The summed up totals for the collection of fares.\n " deprecated: true x-deprecatedMessage: 4.4.5 - This property has been obsoleted and will be removed in a future version, as the totals could yield inaccurate numbers. Please use actual fare availability data to derive the correct total amounts. $ref: '#/components/schemas/FareReferenceTotals' isSumOfSector: type: boolean description: "Flag indicating if the fare reference is a sum of sector.\n " fareAvailabilityKey: type: - string - 'null' description: "The unique fare availability key.\n " fares: type: - array - 'null' description: "The collection of fares for this reference.\n " items: $ref: '#/components/schemas/FareAvailabilityv2' LegClass: type: object description: "The leg class model information.\n " additionalProperties: false required: - classOfService properties: classAllotted: type: integer description: "The leg class allotted.\n " classAuthorizedUnits: type: integer description: "The leg class Authorized Units (AUs).\n " classOfService: type: string description: "The leg class, class of service.\n " maxLength: 8 minLength: 0 classRank: type: integer description: "The leg class rank.\n " classSold: type: integer description: "The class sold.\n " cnxSold: type: integer description: "The CNX sold.\n " latestAdvancedReservation: type: integer description: "The latest advanced reservation.\n " status: description: "The status.\n " $ref: '#/components/schemas/ClassStatus' thruSold: type: integer description: "The thru sold.\n " classNest: type: integer description: "The leg class nest.\n " classType: type: - string - 'null' description: "The type of class.\n " DirectCurrencyConversion: type: object description: "Defines a direct currency conversion.\n " additionalProperties: false properties: rateId: type: string description: "The rate ID.\n " format: guid currencyCode: type: - string - 'null' description: "The currency code converted to.\n " maxLength: 3 minLength: 0 rateValue: type: number description: "The conversion rate value.\n " format: decimal amount: type: number description: "The conversion rate amount.\n " format: decimal putInState: type: - string - 'null' description: "The put in state value.\n " status: description: "The conversion status.\n " $ref: '#/components/schemas/DirectCurrencyConversionStatus' applicable: type: boolean description: "Flag indicating if DCC is applicable.\n " FareDesignator: type: object description: "Model describing the fare designator information.\n " additionalProperties: false properties: fareTypeCodes: type: - array - 'null' description: "The fares carrier code.\n " items: type: string LegStatus: type: integer description: "Leg status enumeration.\n \n\n0 = Normal\n1 = Closed\n2 = Canceled\n3 = Suspended\n5 = ClosedPending\n6 = BlockAllActivities\n7 = Mishap" x-enumNames: - Normal - Closed - Canceled - Suspended - ClosedPending - BlockAllActivities - Mishap enum: - 0 - 1 - 2 - 3 - 5 - 6 - 7 DestinationDetails: type: object description: "Represents the destination details model.\n " additionalProperties: false properties: note: type: - string - 'null' description: "Represents additional information about the\ntrip operation station.\n " maxLength: 128 minLength: 0 gate: description: "Represents the gate details.\n " $ref: '#/components/schemas/GateInformation' station: type: - string - 'null' description: "The station code.\n " maxLength: 3 minLength: 0 status: description: "Represents the arrival status.\n " $ref: '#/components/schemas/ArrivalStatus' baggageClaim: type: - string - 'null' description: "Represents the airline defined location where the trip's\nluggage is to be retrieved.\n " maxLength: 10 minLength: 0 TripOperationEvents: type: object description: "Represents the flight operation time events for an estimated,\nactual, and forced time event.\n " additionalProperties: false properties: forced: type: - string - 'null' description: "Represents the forced time for this event type.\n " format: date-time actual: type: - string - 'null' description: "Represents the actual time for this event type.\n " format: date-time estimated: type: - string - 'null' description: "Represents the estimated time for this event type.\n " format: date-time IropMoveRequest: type: object description: "Defines the irop move request for a booking.\n " additionalProperties: false required: - fromJourneyKey - journeyKey - fareKey properties: fromJourneyKey: type: string description: "The journey key to move from.\n " minLength: 1 journeyKey: type: string description: "The journey key to move to.\n " minLength: 1 fareKey: type: string description: "The fare key to move to.\n " minLength: 1 moveAsDiversion: type: boolean description: "Whether to perform the move as a diversion or not. Defaults to false.\n " overSell: type: boolean description: "If true then the move will be allowed even if the legs of FromJourney have been\nmarked as Closed.\nIf false, the move will be disallowed if any one of the legs\nof FromJourney has been marked as Closed.\n " changeStatus: type: boolean description: "If ChangeStatus is true, the status of the new segments will be set to\nthe opposite of the status of the original (moving from) segment. If the\noriginal segments were waitlisted, then new segments will not be. If the\noriginal segments were not waitlisted, the new segments will be waitlisted.\nThis does not need to be set to true if moving to a standby journey that is\nalready part of the booking.\n " boardingSequenceOffset: type: integer description: "If set to zero and MoveAsDiversion is false, the boarding sequence\nof the original segments will be copied to the new (moved to) segments.\nIf set to a value other than zero and MoveAsDiversion is false,\nthe boarding sequence of the original segments will be copied to the new (moved to)\nsegments and then incremented by the specified BoardingSequenceOffset.\nBoarding sequence is not preserved for Diversion moves.\n " standbyPriorityCode: type: - string - 'null' description: "Standby priority code.\n " inventoryControlType: description: "The IROP inventory control type.\n " $ref: '#/components/schemas/IropInventoryControlType' AvailabilityStationCriteria: type: object description: "Defines the availability criteria stations.\n " additionalProperties: false required: - destinationStationCodes - originStationCodes properties: destinationStationCodes: type: array description: "The Arrival Station Codes.\n " items: type: string originStationCodes: type: array description: "The Departure Station Codes.\n " items: type: string searchDestinationMacs: type: - boolean - 'null' description: "Flag indicating to search by the corresponding MAC associated with station codes provided.\n " searchOriginMacs: type: - boolean - 'null' description: "Flag indicating to search by the corresponding MAC associated with station codes provided.\n " Infant: type: object description: "Model representing an infant.\n " additionalProperties: false properties: dateOfBirth: type: - string - 'null' description: "The date of birth of the infant.\n " format: date-time gender: description: "The gender of the passenger.\n " $ref: '#/components/schemas/Gender' name: description: "The name of the passenger.\n " $ref: '#/components/schemas/Name' declaredGender: type: - string - 'null' description: "The infant's declared gender. A value of \"F\" is mapped to a female binary gender. All other values will be\nmapped to a male binary gender.\n " maxLength: 2 minLength: 0 nationality: type: - string - 'null' description: "The nationality of the passenger.\n " maxLength: 2 minLength: 0 residentCountry: type: - string - 'null' description: "The residentCountry of the passenger.\n " maxLength: 2 minLength: 0 PhoneNumberType: type: integer description: "Defines the types of phone numbers. Note: New Skies does not support Mobile for booking contacts.\n \n\n0 = Other\n1 = Home\n2 = Work\n3 = Mobile\n4 = Fax" x-enumNames: - Other - Home - Work - Mobile - Fax enum: - 0 - 1 - 2 - 3 - 4 SeatPreferences: type: object description: "Represents the seating preferences base model.\n " additionalProperties: false properties: seat: description: "The simple seating preference.\n " $ref: '#/components/schemas/SimpleSeatPreference' travelClass: description: "The preferred travel class of service.\n " $ref: '#/components/schemas/TravelClassSeatPreference' advancedPreferences: type: - array - 'null' description: "The advanced seating preferences.\n " items: $ref: '#/components/schemas/SeatPreference' AddOnPriceBreakdown: type: object description: "Defines the addOn price breakdown.\n " additionalProperties: false properties: car: type: - number - 'null' description: "The car price total.\n " format: decimal hotel: type: - number - 'null' description: "The hotel price total.\n " format: decimal activities: type: - number - 'null' description: "The activities price total.\n " format: decimal PassengerRequest: type: object description: "Defines the passenger request details.\n " additionalProperties: false required: - passengerTypeCode properties: customerNumber: type: - string - 'null' description: "The passenger customer number.\n " maxLength: 20 minLength: 0 name: description: "The passenger's name.\n " $ref: '#/components/schemas/Name' discountCode: type: - string - 'null' description: "The discount code associated with the passenger type.\n " maxLength: 8 minLength: 0 program: description: "The passenger programs.\n " $ref: '#/components/schemas/PassengerProgram' info: description: "Additional passenger information.\n " $ref: '#/components/schemas/PassengerInformation' travelDocuments: type: - array - 'null' description: "Travel Documents.\n " items: $ref: '#/components/schemas/TravelDocumentCreateRequest' addresses: type: - array - 'null' description: "The passengers addresses.\n " items: $ref: '#/components/schemas/PassengerAddress' infant: description: "The optional infant associated with this passenger.\n " $ref: '#/components/schemas/Infant' passengerTypeCode: type: string description: "The passenger type code.\n " minLength: 1 Contact: type: object description: "Contact model describing a person contact information.\n " additionalProperties: false required: - contactTypeCode properties: phoneNumbers: type: - array - 'null' description: "The collection of phone numbers.\nSupported types: Home, Work, Fax, Other.\nThis collections can only contain one number for each supported type.\n " items: $ref: '#/components/schemas/PhoneNumber' cultureCode: type: - string - 'null' description: "The culture code.\n " maxLength: 17 minLength: 0 address: description: "The contact address.\n " $ref: '#/components/schemas/Address' emailAddress: type: - string - 'null' description: "The email address of the contact.\n " customerNumber: type: - string - 'null' description: "The customer number.\n " maxLength: 20 minLength: 0 sourceOrganization: type: - string - 'null' description: "Source organization.\n " maxLength: 10 minLength: 0 distributionOption: description: "The contact distribution option.\n " $ref: '#/components/schemas/DistributionOption' notificationPreference: description: "The notification preference of the contact.\n " $ref: '#/components/schemas/NotificationPreference' companyName: type: - string - 'null' description: "The company name.\n " maxLength: 64 minLength: 0 name: description: "The contact's name.\n " $ref: '#/components/schemas/Name' contactTypeCode: type: string description: "The contact type code. There can only be one contact of a specific type on the booking.\nTypically only one contact is used. Null values will be replaced by the primary contact type code.\nPlease note that this should be a char and not a string.\n " maxLength: 1 minLength: 1 PriceStatus: type: integer description: "Describes the fare pricing status\n \n\n0 = Invalid\n1 = Override\n2 = Valid" x-enumNames: - Invalid - Override - Valid enum: - 0 - 1 - 2 TripDetails: type: object description: "Represents the trip status details version two model.\n " additionalProperties: false properties: legCrossReferences: type: - array - 'null' description: "Represents the leg cross references.\n " items: $ref: '#/components/schemas/LegCrossReference' cabinDetails: type: - array - 'null' description: "Represents the list of cabin details.\n " items: $ref: '#/components/schemas/CabinDetails' checkinLid: type: integer description: "Represents the total number of passengers allowed to checkin.\n " BookingPointOfSale: type: object description: "Model related to the point of sale.\n " additionalProperties: false properties: agentCode: type: - string - 'null' description: "The point of sale agent code.\n " domainCode: type: - string - 'null' description: "The point of sale domain code.\n " locationCode: type: - string - 'null' description: "The point of sale location code.\n " organizationCode: type: - string - 'null' description: "The point of sale organization code.\n " isoCountryCode: type: - string - 'null' description: "Two character country code, optionally supplied in GDS message\n " sourceSystemCode: type: - string - 'null' description: "Two character system code, optionally supplied in GDS message\n " LegCrossReference: type: object description: "Represents the inventory leg cross reference data.\n " additionalProperties: false properties: legKey: type: - string - 'null' description: "The key for the manifest leg.\n " number: type: integer description: "The inventory leg cross reference number.\n " maximum: 32767.0 minimum: 0.0 marketInformation: description: "Information about the market arrival and destination details.\n " $ref: '#/components/schemas/MarketInformation' Message: type: object description: "Defines a unique informational message.\n " additionalProperties: false properties: code: type: - string - 'null' description: "The unique message code.\n " type: type: - string - 'null' description: "The message type.\n " value: type: - string - 'null' description: "The message's value.\n " status: description: "The message's status.\n " $ref: '#/components/schemas/MessageStatus' details: type: - object - 'null' description: "Dynamic detailed information about the message.\n " additionalProperties: type: string AvailabilityRebookRequestv3: type: object description: "Model representing an availability rebook search.\n " additionalProperties: false required: - criteria properties: criteria: type: array description: "The list of availability search criteria.\n " items: $ref: '#/components/schemas/AvailabilityCriteria' taxesAndFees: description: "The taxes and fees rollup mode which affects the pricing information.\n " $ref: '#/components/schemas/TaxesAndFeesRollupMode' codes: description: "The different code criteria that can be set that can influence availability response.\n " $ref: '#/components/schemas/AvailabilityCodeCriteriav2' returnEmptyResults: type: - boolean - 'null' description: "Whether to include empty results in the returned object.\n " numberOfFaresPerJourney: type: - integer - 'null' description: "The number of fares desired per journey.\n " format: int32 Payment: type: object description: "Defines an applied payment on the booking.\n " additionalProperties: false properties: paymentKey: type: - string - 'null' description: "The payment key that uniquely identifies the payment.\n " code: type: - string - 'null' description: "The payment method code.\n " maxLength: 2 minLength: 0 approvalDate: type: - string - 'null' description: "Date when the card/payment is approved in the database.\n " format: date-time details: description: "The payment detail information.\n " $ref: '#/components/schemas/PaymentDetails' amounts: description: "The payment amounts and currency codes.\n " $ref: '#/components/schemas/PaymentAmounts' authorizationCode: type: - string - 'null' description: "The banks auth code when funds are released.\n " maxLength: 10 minLength: 0 authorizationStatus: description: "The real payment status that should never be exposed to the end user unless a agent.\n " $ref: '#/components/schemas/AuthorizationStatus' fundedDate: type: - string - 'null' description: "The date restriction for a payment (when funds will be there).\n " format: date-time transactionCode: type: - string - 'null' description: "Used for credit shell payments and how to compute the expiration of the credit.\n " dcc: description: "DCC payment details.\n " $ref: '#/components/schemas/DirectCurrencyConversion' threeDSecure: description: "3DS payment details.\n " $ref: '#/components/schemas/ThreeDSecure' attachments: type: - array - 'null' description: "The list of payment attachments.\n " items: $ref: '#/components/schemas/PaymentAttachment' createdDate: type: - string - 'null' description: "The date the payment was created on.\n " format: date-time modifiedDate: type: - string - 'null' description: "The date the payment was modified.\n " format: date-time type: description: "The payment method type.\n " $ref: '#/components/schemas/PaymentMethodType' status: description: "The status of the booking (this is the safe status).\n " $ref: '#/components/schemas/BookingPaymentStatus' transferred: type: boolean description: "Flag that indicates if the payment is a result of a divide.\n " channelType: description: "The channel type that the payment was made through.\n " $ref: '#/components/schemas/ChannelType' pointOfSale: description: "The payments point of sale information.\n " $ref: '#/components/schemas/PointOfSale' sourcePointOfSale: description: "The payments source point of sale information.\n " $ref: '#/components/schemas/PointOfSale' deposit: type: boolean description: "Flag indicating if the payment is a deposit.\n " accountId: type: integer description: "Used to identify a credit shell, credit file and agency payments.\n " format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 voucher: description: "The applied voucher details.\n " $ref: '#/components/schemas/PaymentVoucherDetails' addedToState: type: boolean description: "Flag indicating if the payment has been added to state or not.\n " createdAgentId: type: integer description: "The created agents ID.\n " format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 modifiedAgentId: type: integer description: "The modified agents ID.\n " format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 reference: type: integer description: "The reference to the payment.\n " format: int64 passengerVoucher: description: "The passenger voucher.\n " $ref: '#/components/schemas/PassengerVoucher' SegmentTypes: type: integer description: "Indicates the type of a segment.\n \n\n0 = Normal\n1 = CodeShareOperating\n2 = CodeShareMarketing\n3 = InterlineOutbound\n4 = InterlineInbound\n5 = Passive" x-enumNames: - Normal - CodeShareOperating - CodeShareMarketing - InterlineOutbound - InterlineInbound - Passive enum: - 0 - 1 - 2 - 3 - 4 - 5 AddOnDetails: type: object description: "Defines a booking add on base details.\n " additionalProperties: false properties: agentCode: type: - string - 'null' description: "The created agent code.\n " organizationCode: type: - string - 'null' description: "The created organization code.\n " domainCode: type: - string - 'null' description: "The created domain code.\n " locationCode: type: - string - 'null' description: "The created location code.\n " MarketInformation: type: object description: "Model information about the market arrival and destination details.\n " additionalProperties: false required: - destination - origin - departureDate - identifier properties: destination: type: string description: "Gets or sets the leg arrival station.\n " maxLength: 3 minLength: 0 origin: type: string description: "Gets or sets the leg departure station.\n " maxLength: 3 minLength: 0 departureDate: type: string description: "The departure date.\n " format: date-time minLength: 1 identifier: description: "Gets or sets the leg arrival station.\n " $ref: '#/components/schemas/TransportationIdentifier' OrderParticipant: type: object description: "Defines a orders participant.\n " additionalProperties: false properties: description: type: - string - 'null' description: "The participant description.\n " participantTypeCode: type: - string - 'null' description: "The participant type code.\n " isPrimary: type: boolean description: "Flag indicating if the participant is the primary.\n " document: description: "The participant document.\n " $ref: '#/components/schemas/ParticipantDocument' name: description: "The name of the consumer.\n " $ref: '#/components/schemas/Name' address: description: "The address of the consumer.\n " $ref: '#/components/schemas/ConsumerAddress' dateOfBirth: type: - string - 'null' description: "The date of birth of the consumer.\n " format: date-time emailAddress: type: - string - 'null' description: "The email address of the consumer.\n " companyName: type: - string - 'null' description: "The company name of the consumer.\n " type: type: - string - 'null' description: "The type of consumer (business or residential).\n " homePhone: type: - string - 'null' description: "The home phone number.\n " maxLength: 20 minLength: 0 workPhone: type: - string - 'null' description: "The work phone number.\n " maxLength: 20 minLength: 0 fax: type: - string - 'null' description: "The fax phone number.\n " maxLength: 20 minLength: 0 participantKey: type: - string - 'null' description: "The unique participant key.\n " ArrivalStatus: type: integer description: "Arrival status.\n \n\n0 = Default\n1 = Cancelled\n2 = Arrived\n3 = SeeAgent\n4 = Delayed" x-enumNames: - Default - Cancelled - Arrived - SeeAgent - Delayed enum: - 0 - 1 - 2 - 3 - 4 InventorySeatPropertyBase: type: object description: "Represents the base inventory seat property to be committed.\n " additionalProperties: false required: - code - value properties: code: type: string description: "The type code for the inventory seat property.\n " minLength: 1 value: type: string description: "The value code for the inventory seat property.\n " minLength: 1 ChannelType: type: integer description: "Defines the available channel types doing invoking the communication with the server.\n \n\n0 = Default\n1 = Direct\n2 = Web\n3 = Gds\n4 = Api\n5 = DigitalApi\n6 = DigitalWeb\n7 = Ndc" x-enumNames: - Default - Direct - Web - Gds - Api - DigitalApi - DigitalWeb - Ndc enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 OrderCriteria: type: object description: "Defines a products order criteria.\n " additionalProperties: false properties: countryCode: type: - string - 'null' description: "The country code (source or market of the customer).\n " departmentCode: type: - string - 'null' description: "The department code.\n " companyCode: type: - string - 'null' description: "The company code.\n " ratingCode: type: - string - 'null' description: "The rating code.\n " discountCode: type: - string - 'null' description: "The discount code.\n " promotionCode: type: - string - 'null' description: "The promotion code.\n " currencyCode: type: - string - 'null' description: "The currency code.\n " categoryCode: type: - string - 'null' description: "The category code to search with.\n " catalogCode: type: - string - 'null' description: "The catalog code.\n " supplierCode: type: - string - 'null' description: "The suppliers code.\n " vendorCode: type: - string - 'null' description: "The orders vendor.\n " BookingHistoryEvent: type: integer description: "Represents the different events that trigger an\nentry into the schedule history.\n \n\n0 = Unknown\n1 = ConvertedHistory\n2 = FlightTimeChange\n3 = FlightDesignatorChange\n4 = AssignedSeat\n5 = RemoveSeat\n6 = AddedFlight\n7 = DeletedFlight\n8 = DeletedPassenger\n9 = NameChange\n10 = GroupNameChange\n11 = CancelledTicketing\n12 = ScheduleChange\n13 = AddedPayment\n14 = ServiceFee\n15 = QueuedPnr\n16 = UnqueuedPnr\n17 = DeletedComment\n18 = Divided\n19 = CheckedIn\n20 = CheckedOut\n21 = FareOverride\n22 = AddedBaggage\n23 = ChangedBaggageWeight\n24 = CheckedBaggage\n25 = RemovedBaggage\n26 = BoardedPassenger\n27 = UnboardedPassenger\n28 = ManualAuthorization\n29 = ManualDecline\n30 = UndoCancel\n31 = ItinerarySent\n32 = ContactChange\n33 = SsrAdded\n34 = FlightMoved\n35 = VerifiedDocument\n36 = RemovedVerifiedDocument\n37 = Promotion\n38 = BookingComment\n39 = CancelledSchedule\n40 = CancelServiceFee\n41 = OverrideServiceFee\n42 = AddedRecordLocator\n43 = DeletedRecordLocator\n44 = UpgradeClassOfService\n45 = DowngradeClassOfService\n46 = StandbyPriorityChange\n47 = AssignedTicketNumber\n48 = DeletedTicketNumber\n49 = ConfirmSegmentStatusCodeChange\n50 = CodeshareFlightChanged\n51 = PdsCancel\n52 = PdsPending\n53 = PdsConfirm\n54 = PdsFinalized\n55 = PdsDeclined\n56 = PdsException\n57 = PdsCancelRefused\n58 = PdsCancelUnsuccessful\n59 = Apps\n60 = InhibitedOverride\n61 = PrintedBagTag\n62 = SelfPrintedBagTag\n63 = PrintedBoardingPass\n64 = AddCustomerId\n65 = DeleteCustomerId\n66 = HoldCreated\n67 = HoldRemoved\n68 = HoldChanged\n69 = OverrideCoupon\n70 = PdsSynchronized\n71 = PdsItemremoved\n72 = Reprice\n73 = ChannelOverride\n74 = EmdCreated\n75 = EmdRemoved\n76 = EmdChanged\n77 = ServiceBundle\n78 = PublishedFareOverride\n79 = FareClassRealignment\n80 = AddedDocument\n81 = ChangedDocument\n82 = DeletedPaymentProperties" x-enumNames: - Unknown - ConvertedHistory - FlightTimeChange - FlightDesignatorChange - AssignedSeat - RemoveSeat - AddedFlight - DeletedFlight - DeletedPassenger - NameChange - GroupNameChange - CancelledTicketing - ScheduleChange - AddedPayment - ServiceFee - QueuedPnr - UnqueuedPnr - DeletedComment - Divided - CheckedIn - CheckedOut - FareOverride - AddedBaggage - ChangedBaggageWeight - CheckedBaggage - RemovedBaggage - BoardedPassenger - UnboardedPassenger - ManualAuthorization - ManualDecline - UndoCancel - ItinerarySent - ContactChange - SsrAdded - FlightMoved - VerifiedDocument - RemovedVerifiedDocument - Promotion - BookingComment - CancelledSchedule - CancelServiceFee - OverrideServiceFee - AddedRecordLocator - DeletedRecordLocator - UpgradeClassOfService - DowngradeClassOfService - StandbyPriorityChange - AssignedTicketNumber - DeletedTicketNumber - ConfirmSegmentStatusCodeChange - CodeshareFlightChanged - PdsCancel - PdsPending - PdsConfirm - PdsFinalized - PdsDeclined - PdsException - PdsCancelRefused - PdsCancelUnsuccessful - Apps - InhibitedOverride - PrintedBagTag - SelfPrintedBagTag - PrintedBoardingPass - AddCustomerId - DeleteCustomerId - HoldCreated - HoldRemoved - HoldChanged - OverrideCoupon - PdsSynchronized - PdsItemremoved - Reprice - ChannelOverride - EmdCreated - EmdRemoved - EmdChanged - ServiceBundle - PublishedFareOverride - FareClassRealignment - AddedDocument - ChangedDocument - DeletedPaymentProperties enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 - 32 - 33 - 34 - 35 - 36 - 37 - 38 - 39 - 40 - 41 - 42 - 43 - 44 - 45 - 46 - 47 - 48 - 49 - 50 - 51 - 52 - 53 - 54 - 55 - 56 - 57 - 58 - 59 - 60 - 61 - 62 - 63 - 64 - 65 - 66 - 67 - 68 - 69 - 70 - 71 - 72 - 73 - 74 - 75 - 76 - 77 - 78 - 79 - 80 - 81 - 82 PassengerVoucherUsageType: type: integer description: "Passenger voucher usage type specifies what parts of a booking this voucher can pay for.\n \n\n0 = None\n1 = Fares\n2 = Taxes\n3 = TravelFees\n4 = ServiceFees\n5 = PenaltyFees\n6 = SsrFees\n7 = NonFlightServiceFees\n8 = UpgradeFees\n9 = SeatFees\n10 = SpoilageFees\n11 = NameChangeFees\n12 = ConvenienceFees\n13 = Car\n14 = Hotel\n15 = Insurance\n16 = Activities\n17 = BaseFeeOnly" x-enumNames: - None - Fares - Taxes - TravelFees - ServiceFees - PenaltyFees - SsrFees - NonFlightServiceFees - UpgradeFees - SeatFees - SpoilageFees - NameChangeFees - ConvenienceFees - Car - Hotel - Insurance - Activities - BaseFeeOnly enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 AddOnCharge: type: object description: "Defines a booking add ons charge.\n " additionalProperties: false properties: type: description: "The charge type.\n " $ref: '#/components/schemas/ChargeType' code: type: - string - 'null' description: "The charge code.\n " ticketCode: type: - string - 'null' description: "The charge ticket code.\n " collection: description: "The charge collection type.\n " $ref: '#/components/schemas/CollectType' currencyCode: type: - string - 'null' description: "The currency code.\n " amount: type: number description: "The charged amount.\n " format: decimal details: type: - string - 'null' description: "The charge details.\n " DistributionOption: type: integer description: "This enumeration specifies the distribution methods for sending notifications.\n \n\n0 = None\n1 = Mail\n2 = Email\n3 = Fax\n4 = MailFax\n5 = Airport\n6 = Hold\n7 = Print" x-enumNames: - None - Mail - Email - Fax - MailFax - Airport - Hold - Print enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 TripOperationTimes: type: object description: "Represents the flight operation time events. Null property values indicate\nthat there is no recorded time event for the given property name.\n " additionalProperties: false properties: touchDownTimes: description: "Represents the touch down times for this flight operation.\n " $ref: '#/components/schemas/TripOperationEvents' onBlockTimes: description: "Represents the on-block times for this flight operation.\n " $ref: '#/components/schemas/TripOperationEvents' departureTimes: description: "Represents the departure times for this flight operation.\n " $ref: '#/components/schemas/DepartureEvent' offBlockTime: type: - string - 'null' description: "Represents the off-block time for this flight operation.\n " format: date-time airborneTime: type: - string - 'null' description: "Represents the airborne time for this flight operation.\n " format: date-time crewReportTime: type: - string - 'null' description: "Represents the crew report time for this flight operation.\n " format: date-time takeOffTime: type: - string - 'null' description: "Represents the take-off time for this flight operation.\n " format: date-time movementAfterPushBackTime: type: - string - 'null' description: "Represents the movement after push-back time (taxi) for this flight operation.\n " format: date-time nextInformationTime: type: - string - 'null' description: "Represents the next information time for this flight operation.\n " format: date-time reclearanceTime: type: - string - 'null' description: "Represents the re-clearance time for this flight operation.\n " format: date-time returnToRampTime: type: - string - 'null' description: "Represents the return to ramp time for this flight operation.\n " format: date-time scheduledArrivalTime: type: - string - 'null' description: "Represents the scheduled arrival time for this flight operation.\n " format: date-time lastModifiedDate: type: - string - 'null' description: "Represents the date the object was last modified.\n " format: date-time IJsonResponse: type: object description: "Defines the JSON response contract for a not content type response.\n " additionalProperties: false properties: data: description: "The payload data, this will always be null for errors responses and no content responses.\n " errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' OrderHistory: type: object description: "Defines a order history transaction.\n " additionalProperties: false properties: code: type: - string - 'null' description: "The status code.\n " previousCode: type: - string - 'null' description: "The previous status code.\n " note: type: - string - 'null' description: "The history note.\n " created: type: string description: "The history entry created date.\n " format: date-time hasError: type: boolean description: "Flag indicating if has an error.\n " PassengerFee: type: object description: "Model representing passenger fee information.\n " additionalProperties: false required: - code properties: isConfirmed: type: boolean description: "A status flag to indicate if the fee has been confirmed or not.\n " isConfirming: type: boolean description: "A status flag to indicate if the fee is confirming or not.\n " isConfirmingExternal: type: boolean description: "A status flag to indicate if the fee is confirming external or not.\n " code: type: string description: "The fee code.\n " maxLength: 6 minLength: 0 detail: type: - string - 'null' description: "The fee detail.\n " maxLength: 32 minLength: 0 passengerFeeKey: type: - string - 'null' description: "The passenger fee key.\n " override: type: boolean description: "The fee override.\n " flightReference: type: - string - 'null' description: "The flight reference which signifies a link to a segment and or leg.\n " maxLength: 22 minLength: 0 note: type: - string - 'null' description: "The fee notes.\n " maxLength: 128 minLength: 0 createdDate: type: - string - 'null' description: "The created date for the fee.\n " format: date-time isProtected: type: boolean description: "Indicates if the fee is protected.\n " serviceCharges: type: - array - 'null' description: "The list of service charges for the fee.\n " items: $ref: '#/components/schemas/ServiceCharge' type: description: "The fee type.\n " $ref: '#/components/schemas/FeeType' ssrCode: type: - string - 'null' description: "The SSR code.\n " ssrNumber: type: integer description: "The fee SSR number.\n " paymentNumber: type: integer description: "The fee payment number.\n " OverbookIndicatorTypes: type: integer description: "Specifies the type of code share agreement.\n \n\n0 = NormalSell\n1 = Oversold\n2 = ClassOrCabinOversold" x-enumNames: - NormalSell - Oversold - ClassOrCabinOversold enum: - 0 - 1 - 2 IgnoreLiftStatus: type: integer description: "Defines the lift status ignore level for Journey Move/Cancel.\n \n\n0 = IgnoreNotAllowed\n1 = IgnoreCheckin\n2 = IgnoreBoarded" x-enumNames: - IgnoreNotAllowed - IgnoreCheckin - IgnoreBoarded enum: - 0 - 1 - 2 ThreeDSecure: type: object description: "Defines three D secure.\n " additionalProperties: false properties: browserUserAgent: type: - string - 'null' description: "The browser agent being used.\n " browserAccept: type: - string - 'null' description: "The browser agent accept.\n " remoteIpAddress: type: - string - 'null' description: "The remote IP address.\n " termUrl: type: - string - 'null' description: "The return URL from the bank.\n " paReq: type: - string - 'null' description: "The payload that will be sent to the bank site.\n " acsUrl: type: - string - 'null' description: "The URL to redirect to for TDS (aka the bank).\n " paRes: type: - string - 'null' description: "The response that comes back from the bank.\n " authResult: type: - string - 'null' description: "The result of 3DS.\n " cavv: type: - string - 'null' description: "The encrypted string of prof that 3DS was processed.\n " cavvAlgorithm: type: - string - 'null' description: "The algorithm that created the Cavv.\n " eci: type: - string - 'null' description: "The electronic commerce indicator (the level of 3DS).\n " xid: type: - string - 'null' description: "The transaction ID specific to the 3DS 3rd party processing.\n " applicable: type: boolean description: "Flag that indicates if more validation is needed.\n " successful: type: boolean description: "Flag indicating if 3DS was successful.\n " threeDSecureSessionId: type: - string - 'null' description: "The three d secure session id. This is returned by device data collection.\nThis ties the device data collection to the 3DSecure Lookup.\n " challengePreference: description: "The requested challenge preference.\nIndicates whether the merchant would like to force the issuer to present a 3DSecure challenge.\n " $ref: '#/components/schemas/ChallengePreference' challengeWindowSize: description: "The requested challenge window size.\nIndicates the preferred size of the 3DSecure challenge window.\n " $ref: '#/components/schemas/ChallengePreferenceWindowSize' transactionIdThreeDSecure: type: - string - 'null' description: "The transaction id three d secure. Used after completing 3DS Native challenge.\nThis is the equivalent of the 3DSecure Redirect PaRes value. For 3DSecure Native authentications,\nthe transaction ID should be populated in lieu of the PaRes.\n " threeDSecureVersion: type: - string - 'null' description: "The three d secure version. Indicates the version of 3DS that was applied during the authentication.\n " merchantData: type: - string - 'null' description: "Merchant data.\n " redirectJwt: type: - string - 'null' description: "The Jwt object created by SkyPay to use when redirecting a customer.\n " redirectJwtUrl: type: - string - 'null' description: "Secondary url that may be included in lieu or in addition to the Redirect Url.\n " dsTransactionId: type: - string - 'null' description: "The D S transaction id.\n " authenticationStatus: description: "The authentication status.\n " $ref: '#/components/schemas/AuthenticationStatus' BundlePrice: type: object description: "The bundle price model.\n " additionalProperties: false properties: totalPrice: type: number description: "The total price for the service bundle, minus taxes.\nIncludes any fees associated with the bundle.\n " format: decimal taxTotal: type: number description: "The total sales taxes that are applicable to the\nservice bundle.\n " format: decimal feePrice: type: number description: "The fee price associated with the bundle if there is any.\n " format: decimal passengerType: type: - string - 'null' description: "The passenger type that is applicable to the service\nbundle.\n " maxLength: 4 minLength: 0 program: description: "The program details that are applicable to the service\nbundle.\n " $ref: '#/components/schemas/BundleProgramDetails' inclusiveTaxTotal: type: number description: "The total sales inclusive taxes that are applicable to the service bundle.\n " format: decimal bundleSsrPrices: type: - array - 'null' description: "The list of bundle SSR prices.\n " items: $ref: '#/components/schemas/BundleSsrPrice' JourneySellRequest: type: object description: "Journey request represents the trip sell request but with only information needed for a booking sell.\n " additionalProperties: false required: - keys properties: keys: type: array description: "The list of selected sell keys to be added to the booking.\n " items: $ref: '#/components/schemas/SellKey' preventOverlap: type: - boolean - 'null' description: "Used to explicitly control support for flight overlaps. It works together with the ‘Allow Sell of Flight Overlap’\nrole setting. Overlaps will be allowed only when PreventOverlaps is FALSE and the user has permissions to sell\noverlaps.\n " suppressPassengerAgeValidation: type: - boolean - 'null' description: "Flag indicating if passenger and infant age validation will be skipped.\n " PassiveSegmentRequest: type: object description: "Passive segment request represents the data that will be added as a passive segment on a booking.\n " additionalProperties: false required: - carrierCode - flightNumber - classOfService - arrivalTime - departureTime - origin - destination properties: carrierCode: type: string description: "The carrier code.\n " maxLength: 3 minLength: 2 flightNumber: type: string description: "The flight number.\n " maxLength: 4 minLength: 1 opSuffix: type: string description: "The op suffix.\nPlease note that this should be a char and not a string.\n " maxLength: 1 totalPassengers: type: - integer - 'null' description: "The total number of passengers.\n " classOfService: type: string description: "The class of service.\n " maxLength: 8 minLength: 0 arrivalTime: type: string description: "The arrival date.\n " format: date-time minLength: 1 departureTime: type: string description: "The departure date.\n " format: date-time minLength: 1 origin: type: string description: "The origin station.\n " maxLength: 3 minLength: 0 destination: type: string description: "The destination station.\n " maxLength: 3 minLength: 0 OperationDetails: type: object description: "Represents the operation details model.\n " additionalProperties: false properties: tailNumber: type: - string - 'null' description: "Represents the tail number for the aircraft.\n " maxLength: 10 minLength: 0 equipmentType: type: - string - 'null' description: "Represents the equipment type for the leg.\n " maxLength: 3 minLength: 1 equipmentTypeSuffix: type: - string - 'null' description: "Represents the equipment type suffix for the leg.\n " maxLength: 3 minLength: 0 status: description: "Represents the trip status.\n " $ref: '#/components/schemas/LegStatus' identifier: description: "Represents the transportation identifier.\n " $ref: '#/components/schemas/TransportationIdentifier' tripOperationTimes: description: "Represents the trip operation time events.\n " $ref: '#/components/schemas/TripOperationTimes' counts: description: "Represents the various counts related to the operation.\n " $ref: '#/components/schemas/OperationCounts' delays: type: - array - 'null' description: "A list of trip operation delays.\n " items: $ref: '#/components/schemas/TripOperationDelay' payloads: type: - array - 'null' description: "Represents the list of trip operation payloads.\n " items: $ref: '#/components/schemas/TripOperationPayload' crewList: type: - array - 'null' description: "Represents the list of crew members.\n " items: $ref: '#/components/schemas/TripOperationCrew' comments: type: - array - 'null' description: "Represents the comments related to this trip operation.\n " items: $ref: '#/components/schemas/TripOperationComment' historyList: type: - array - 'null' description: "Represents the history of this trip operation.\n " items: $ref: '#/components/schemas/TripOperationHistory' Coordinate: type: object description: "The defined coordinates of a location.\n " additionalProperties: false properties: latitude: type: - string - 'null' description: "The locations latitude.\n " longitude: type: - string - 'null' description: "The locations longitude.\n " LiftStatus: type: integer description: "Lift status enumeration.\n \n\n0 = Default\n1 = CheckedIn\n2 = Boarded\n3 = NoShow" x-enumNames: - Default - CheckedIn - Boarded - NoShow enum: - 0 - 1 - 2 - 3 BaggageStatus: type: integer description: "Baggage Status enumeration.\n \n\n0 = Default\n1 = Checked\n2 = Removed\n3 = Added\n4 = AddedPrinted" x-enumNames: - Default - Checked - Removed - Added - AddedPrinted enum: - 0 - 1 - 2 - 3 - 4 OrderCustomer: type: object description: "Defines an order customer contact details.\n " additionalProperties: false properties: name: description: "The name of the consumer.\n " $ref: '#/components/schemas/Name' address: description: "The address of the consumer.\n " $ref: '#/components/schemas/ConsumerAddress' dateOfBirth: type: - string - 'null' description: "The date of birth of the consumer.\n " format: date-time emailAddress: type: - string - 'null' description: "The email address of the consumer.\n " companyName: type: - string - 'null' description: "The company name of the consumer.\n " type: type: - string - 'null' description: "The type of consumer (business or residential).\n " homePhone: type: - string - 'null' description: "The home phone number.\n " maxLength: 20 minLength: 0 workPhone: type: - string - 'null' description: "The work phone number.\n " maxLength: 20 minLength: 0 fax: type: - string - 'null' description: "The fax phone number.\n " maxLength: 20 minLength: 0 customerKey: type: - string - 'null' description: "The unique customer key.\n " customerNumber: type: - string - 'null' description: "The customer number.\n " TransportationDesignator: type: object description: "Model information about the traveling arrival and destination details.\n " additionalProperties: false properties: destination: type: - string - 'null' description: "Gets or sets the leg arrival station.\n " maxLength: 3 minLength: 0 origin: type: - string - 'null' description: "Gets or sets the leg departure station.\n " maxLength: 3 minLength: 0 arrival: type: string description: "The arrival date and time local to the arrival station.\n " format: date-time departure: type: string description: "The departure date and time local to the departure station.\n " format: date-time AvailabilityCriteriaFilter: type: object description: "Defines all the different ways the availability response can be filtered.\n " additionalProperties: false properties: fareInclusionType: description: "Defines the type of fares to be included in the response.\n " $ref: '#/components/schemas/AvailabilityType' compressionType: description: "The class compression type.\n " $ref: '#/components/schemas/FareClassControl' maxPrice: type: - number - 'null' description: "The max fare price.\n " format: decimal minPrice: type: - number - 'null' description: "The min fare price.\n " format: decimal loyalty: description: "Filters fares based on loyalty.\n " $ref: '#/components/schemas/LoyaltyFilter' includeAllotments: type: - boolean - 'null' description: "Flag indicating to include allotted fare classes of service.\n " exclusionType: description: "Filters the type of journeys to return.\n " $ref: '#/components/schemas/AvailabilityFilter' sortOptions: type: - array - 'null' description: "The list of inventory journey sort options, used for filtering journeys on the response.\n " items: $ref: '#/components/schemas/JourneySortKey' productClasses: type: - array - 'null' description: "The list of product class codes to filter with.\n " items: type: string travelClasses: type: - array - 'null' description: "The list of travel class codes to filter with.\nPlease note that this should be an array of chars and not an array of string.\n " items: type: string maxLength: 1 fareTypes: type: - array - 'null' description: "The list of fare types.\n " items: type: string classesOfService: type: - array - 'null' description: "The list of classes of service.\n " items: type: string carrierCode: type: - string - 'null' description: "The desired carrier code.\n " maxLength: 3 minLength: 2 identifier: type: - string - 'null' description: "The desired identifier number.\n " maxLength: 4 minLength: 0 type: description: "The type filtering based on connections.\n " $ref: '#/components/schemas/FlightType' connectionType: description: "Specifies the type of sold as connection when segment connects with passive segment.\n " $ref: '#/components/schemas/SoldAsConnectionType' maxConnections: type: - integer - 'null' description: "The number of max connections.\n " bundleControlFilter: description: "Determines what level of service bundle information should be returned with flight availability.\n " $ref: '#/components/schemas/BundleControlFilter' TripOperationCommentCreateRequest: type: object description: "Represents the create request for a comment for a trip operation.\n " additionalProperties: false required: - text properties: text: type: string description: "The note for this delay, containing extra information about the delay\n(if any).\n " maxLength: 800 minLength: 1 type: description: "Represents the comment type.\n " $ref: '#/components/schemas/OperationCommentType' DepartureStatus: type: integer description: "Departure status.\n \n\n0 = Default\n1 = Cancelled\n2 = Boarding\n3 = SeeAgent\n4 = Delayed\n5 = Departed" x-enumNames: - Default - Cancelled - Boarding - SeeAgent - Delayed - Departed enum: - 0 - 1 - 2 - 3 - 4 - 5 EquipmentFilter: type: object description: "Represents a filter for equipment type.\n " additionalProperties: false required: - equipmentType properties: equipmentType: type: string description: "The type of equipment for the journey.\n " maxLength: 3 minLength: 0 equipmentTypeSuffix: type: - string - 'null' description: "The suffix associated with the equipment type.\n " maxLength: 3 minLength: 0 Exception: type: object additionalProperties: false properties: Message: type: string InnerException: $ref: '#/components/schemas/Exception' Source: type: - string - 'null' StackTrace: type: - string - 'null' BookingStatus: type: integer description: "Booking Status Enumeration\n \n\n0 = Default\n1 = Hold\n2 = Confirmed\n3 = Closed\n4 = HoldCanceled\n5 = PendingArchive\n6 = Archived\n7 = ArchivedPrivate\n777 = ProcessedForArchive" x-enumNames: - Default - Hold - Confirmed - Closed - HoldCanceled - PendingArchive - Archived - ArchivedPrivate - ProcessedForArchive enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 777 PassengerInformation: type: object description: "Represents additional passenger information.\n " additionalProperties: false properties: nationality: type: - string - 'null' description: "The passenger's nationality.\n " maxLength: 2 minLength: 0 residentCountry: type: - string - 'null' description: "The resident country.\n " maxLength: 2 minLength: 2 gender: description: "The passenger's binary gender.\n " $ref: '#/components/schemas/Gender' dateOfBirth: type: - string - 'null' description: "The passenger's date of birth.\n " format: date-time familyNumber: type: - integer - 'null' description: "The unique identifier of a family registered in the system.\n " declaredGender: type: - string - 'null' description: "The passenger's declared gender. A value of \"F\" is mapped to a female binary gender. All other values will be\nmapped to a male binary gender.\n " maxLength: 2 minLength: 0 JourneyPriceBreakdown: type: object description: "Defines a specifics journey pricing breakdown.\n " additionalProperties: false properties: totalAmount: type: number description: "The journey price total.\n " format: decimal totalPoints: type: number description: "The journey points total.\n " format: decimal totalTax: type: number description: "The journey taxes total.\n " format: decimal totalDiscount: type: number description: "The journey discount total.\n " format: decimal journeyKey: type: - string - 'null' description: "The unique journey key.\n " CommitItineraryVariationRequest: type: object description: "Defines the commit itinerary variation request.\n " additionalProperties: false properties: forGeneralUse: type: boolean description: "Indicates if the flight will be available for general use.\n " itineraryVariation: description: "The itinerary variation.\n " $ref: '#/components/schemas/ItineraryVariation' LegSsr: type: object description: "A model representing a leg ssr summary.\n " additionalProperties: false properties: available: type: integer description: "The number of Ssrs available.\n " ssrNestCode: type: - string - 'null' description: "The SSR nest code.\n " maxLength: 4 minLength: 0 lid: type: integer description: "The maximum number of SSRs authorized to be sold on a nest.\n " sold: type: integer description: "The number of SSRs sold in the SSR nest.\n " unitSold: type: integer description: "The units of space sold for the SSR.\n " ProductVariationDetail: type: object description: "Defines a products variation detail.\n " additionalProperties: false properties: code: type: - string - 'null' description: "The product variation detail code.\n " styleCode: type: - string - 'null' description: "The style code.\n " description: type: - string - 'null' description: "The product variation detail description.\n " PassengerVoucher: type: object description: "Defines a passenger voucher.\n " additionalProperties: false properties: passengerVoucherKey: type: - string - 'null' description: "The passenger voucher key.\n " passengerKey: type: - string - 'null' description: "The passenger key.\nWill be null if the voucher does not apply to a specific passenger.\n " voucherConfigurationCode: type: - string - 'null' description: "The voucher configuration code.\n " voucherUses: type: - array - 'null' description: "The list of voucher uses.\n " items: $ref: '#/components/schemas/PassengerVoucherUsageType' customerPrograms: type: - array - 'null' description: "The list of customer programs.\n " items: $ref: '#/components/schemas/PassengerVoucherCustomerProgram' customerNumber: type: - string - 'null' description: "The customer number of the customer record to which the voucher has been issued.\n " OnTime: type: integer description: "Represents the likelihood of a leg being on time.\n \n\n0 = Above0Percent\n1 = Above10Percent\n2 = Above20Percent\n3 = Above30Percent\n4 = Above40Percent\n5 = Above50Percent\n6 = Above60Percent\n7 = Above70Percent\n8 = Above80Percent\n9 = Above90Percent\n10 = NotApplicable\n11 = Unknown" x-enumNames: - Above0Percent - Above10Percent - Above20Percent - Above30Percent - Above40Percent - Above50Percent - Above60Percent - Above70Percent - Above80Percent - Above90Percent - NotApplicable - Unknown enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 PhoneNumber: type: object description: "Defines a common phone number.\n " additionalProperties: false required: - number - type properties: number: type: string description: "The phone number without any formatting characters.\n " maxLength: 20 minLength: 0 type: description: "The phone number type.\n " $ref: '#/components/schemas/PhoneNumberType' Leg: type: object description: "Model data describing the leg which is a single travel leg from point a to b.\n " additionalProperties: false properties: legKey: type: - string - 'null' description: "The unique identifier for this leg sell information.\n " designator: description: "Transportation information.\n " $ref: '#/components/schemas/TransportationDesignator' operationsInfo: description: "The operations information.\n " $ref: '#/components/schemas/OperationsInformation' legInfo: description: "The leg information.\n " $ref: '#/components/schemas/LegInformation' nests: type: - array - 'null' description: "The collection of leg nests.\n " items: $ref: '#/components/schemas/LegNest' ssrs: type: - array - 'null' description: "The Ssrs summary information.\n " items: $ref: '#/components/schemas/LegSsr' seatmapReference: type: - string - 'null' description: "The reference identifying what seatmap the leg is in associated to.\n " flightReference: type: - string - 'null' description: "The flight reference which signifies a link to a segment and or leg.\n " maxLength: 22 minLength: 0 PassengerTravelDocument: type: object description: "Model representing a passenger travel document.\n " additionalProperties: false required: - documentTypeCode properties: documentTypeCode: type: string description: "The unique travel document type code.\n " maxLength: 4 minLength: 0 issuedByCode: type: - string - 'null' description: "The issuer code for the travel document (country code).\n " maxLength: 3 minLength: 0 birthCountry: type: - string - 'null' description: "The BirthCountry property.\n " name: description: "The Name property.\n " $ref: '#/components/schemas/Name' nationality: type: - string - 'null' description: "The Nationality property.\n " maxLength: 2 minLength: 0 expirationDate: type: - string - 'null' description: "The date when this travel document expires.\n " format: date-time number: type: - string - 'null' description: "The travel document number.\n " maxLength: 35 minLength: 0 issuedDate: type: - string - 'null' description: "The date this travel document was issued.\n " format: date-time gender: description: "The travel document holder's gender.\n " $ref: '#/components/schemas/Gender' dateOfBirth: type: - string - 'null' description: "The person's date of birth.\n " format: date-time declaredGender: type: - string - 'null' description: "The travel document holder's declared gender.\nThis will override the gender field on passenger or person POST, PUT, and PATCH requests.\nNote: Any value other than \"F\" will cause gender to be updated to Male by default to support compatibility with\nother systems.\nAdditionally you cannot change the declared gender and gender fields at the same time as declared gender\nwill override any gender field value regardless of the value passed in.\n " maxLength: 2 minLength: 0 placeOfBirth: type: - string - 'null' description: "Represents the place of birth. Only used on the following document type groups: TravelVisa (9), RedressNumber (20),\nand KnownTravelerId (21).\nOnly allows alpha characters, please do not use spaces, numbers, or special characters.\nNote: If unsure which travel document types fall into these groups please use `/api/nsk/v1/resources/DocumentTypes`\nor `/api/nsk/v1/resources/DocumentTypes/{documentTypeCode}`\n " maxLength: 35 minLength: 0 pattern: ^[A-Za-z\s]*$ placeOfIssue: type: - string - 'null' description: "Represents the place of issue. Only used on the following document type groups: TravelVisa (9), RedressNumber (20),\nand KnownTravelerId (21).\nOnly allows alpha characters, please do not use spaces, hyphens, or special characters.\nNote: If unsure which travel document types fall into these groups please use `/api/nsk/v1/resources/DocumentTypes`\nor `/api/nsk/v1/resources/DocumentTypes/{documentTypeCode}`\n " maxLength: 35 minLength: 0 pattern: ^[A-Za-z\s]*$ passengerTravelDocumentKey: type: - string - 'null' description: "A key that uniquely identifies a travel document in the context of a specific passenger.\n " SeatInfo: type: object description: "The model for the seat information such as deck, seat properties, etc.\n " additionalProperties: false properties: deck: type: integer description: "Gets or sets the deck.\n " seatSet: type: integer description: "Gets or sets the seat set.\n " propertyList: type: - object - 'null' description: "The property list by type code and value.\n " additionalProperties: type: string WeightCategory: type: integer description: "Defines the categories of adults by gender or specifies the passenger as a child. This is used for balance\ndeterminations.\n \n\n0 = Undefined\n1 = Male\n2 = Female\n3 = Child" x-enumNames: - Undefined - Male - Female - Child enum: - 0 - 1 - 2 - 3 LegSeatsSold: type: object description: "Represents the leg seats sold model.\n " additionalProperties: false properties: total: type: integer description: "The number of seats sold.\n " throughTotal: type: integer description: "The number of seats sold as part of a through flight.\n " nonStopTotal: type: integer description: "The number of seats sold as part of a non-stop flight.\n " connectTotal: type: integer description: "The number of seats sold as part of a connecting flight.\n " confirmed: type: integer description: "The number of confirmed seats sold in this leg.\n " Segment: type: object description: "Segment model for an already booked flight.\n " additionalProperties: false properties: isStandby: type: boolean description: "Represents the stand by status of the segment.\n " isConfirming: type: boolean description: "Represents the confirming status of the segment.\n " isConfirmingExternal: type: boolean description: "Represents the pending external confirming status of the segment.\n " channelType: description: "The type of the channel from the user that added the segment.\n " $ref: '#/components/schemas/ChannelType' priorityCode: type: - string - 'null' description: "The priority code.\n " maxLength: 2 minLength: 0 salesDate: type: - string - 'null' description: "The segment sales date.\n " format: date-time flightReference: type: - string - 'null' description: "The flight reference which signifies a link to a segment and or leg.\n " maxLength: 22 minLength: 0 status: description: "Represents the segment status.\n " $ref: '#/components/schemas/SegmentStatus' isBlocked: type: boolean description: "Represents the blocked status of the segment.\n " isHosted: type: boolean description: "Represents the hosted status of the segment.\n " isChangeOfGauge: type: boolean description: "Represents the change of gauge status of the segment.\n " designator: description: "This is a summary of all the legs on the segment. It will contain the details\nof the transportation from the first and last leg.\n " $ref: '#/components/schemas/TransportationDesignator' segmentKey: type: - string - 'null' description: "The unique identifier for this segment sell information.\n " cabinOfService: type: - string - 'null' description: "The cabin of service.\nPlease note that this should be a char and not a string.\n " maxLength: 1 changeReasonCode: description: "The change reason code.\n " $ref: '#/components/schemas/ChangeReasonCodes' international: type: boolean description: "The value indicating if this segment is international.\n " legs: type: - array - 'null' description: "The legs.\n " items: $ref: '#/components/schemas/Leg' isSeatmapViewable: type: boolean description: "Indicates if the seatmaps associated with the segment are retrievable.\nSets to `false` for passive segments, and `true` for non-passive segments.\n " identifier: description: "The transportation identifier.\n " $ref: '#/components/schemas/TransportationIdentifier' externalIdentifier: description: "The external transportation identifier.\n " $ref: '#/components/schemas/TransportationIdentifier' segmentType: description: "The type of the segment.\n " $ref: '#/components/schemas/SegmentTypes' fares: type: - array - 'null' description: "The fares.\n " items: $ref: '#/components/schemas/Fare' passengerSegment: type: - object - 'null' description: "Passengers on this segment by passenger key.\n " additionalProperties: $ref: '#/components/schemas/PassengerSegment' DirectCurrencyConversionStatus: type: integer description: "Enumeration that determines the status of a DCC authorization.\n \n\n0 = DccNotOffered\n1 = DccOfferRejected\n2 = DccOfferAccepted\n3 = DccInitialValue\n4 = MccInUse" x-enumNames: - DccNotOffered - DccOfferRejected - DccOfferAccepted - DccInitialValue - MccInUse enum: - 0 - 1 - 2 - 3 - 4 OrderPayment: type: object description: "Defines a payment on an order.\n " additionalProperties: false required: - type properties: type: type: string description: "The payment type.\n " minLength: 1 name: description: "The name on the payment.\n " $ref: '#/components/schemas/Name' number: type: - string - 'null' description: "The number on the payment.\n " expiration: type: - string - 'null' description: "The expiration date.\n " format: date-time cvv: type: - string - 'null' description: "The CVV on the payment.\n " amount: type: number description: "The applied payment amount.\n " format: decimal description: type: - string - 'null' description: "The payment description.\n " issueNumber: type: - string - 'null' description: "The payment issue number.\n " address: description: "The payments address.\n " $ref: '#/components/schemas/Address' emailAddress: type: - string - 'null' description: "The provided email address.\n " format: email phoneNumbers: type: - array - 'null' description: "The collection of phone numbers.\n " items: $ref: '#/components/schemas/PhoneNumber' paymentKey: type: - string - 'null' description: "The unique order payment key.\n " currencyCode: type: - string - 'null' description: "The currency code the payment is in (will always be set to the bookings currency code).\n " TripOperationComment: type: object description: "Represents a comment for a trip operation.\n " additionalProperties: false properties: text: type: - string - 'null' description: "Represents the comment text.\n " maxLength: 800 minLength: 1 type: description: "Represents the comment type.\n " $ref: '#/components/schemas/OperationCommentType' tripOperationCommentKey: type: - string - 'null' description: "The unique identification number for the comment.\n " createdDate: type: - string - 'null' description: "The date the comment was created in UTC.\n " format: date-time modifiedDate: type: - string - 'null' description: "The date the comment was modified in UTC.\n " format: date-time createdUserKey: type: - string - 'null' description: "The unique identifier of the user who created the comment.\n " modifiedUserKey: type: - string - 'null' description: "The unique identifier of the user who modified the comment.\n " Name: type: object description: "Defines a common name.\n " additionalProperties: false properties: first: type: - string - 'null' description: "The given first name.\n " maxLength: 32 minLength: 0 middle: type: - string - 'null' description: "The given middle name.\n " maxLength: 32 minLength: 0 last: type: - string - 'null' description: "The given last name.\n " maxLength: 32 minLength: 0 title: type: - string - 'null' description: "The title.\n " maxLength: 6 minLength: 0 suffix: type: - string - 'null' description: "The suffix.\n " maxLength: 6 minLength: 0 ApisAddressStatus: type: integer description: "Defines what type of APIS requirement is the address.\n \n\n0 = Residence\n1 = InCountry\n2 = Emergency\n3 = Contact" x-enumNames: - Residence - InCountry - Emergency - Contact enum: - 0 - 1 - 2 - 3 OrderAddress: type: object description: "Defines an address with GPS coordinates.\n " additionalProperties: false properties: lineOne: type: - string - 'null' description: "The address line one.\n " lineTwo: type: - string - 'null' description: "The address line two.\n " lineThree: type: - string - 'null' description: "The address line 3.\n " countryCode: type: - string - 'null' description: "The country code.\n " provinceState: type: - string - 'null' description: "The province state.\n " city: type: - string - 'null' description: "The city.\n " postalCode: type: - string - 'null' description: "The postal code.\n " coordinates: description: "The GPS coordinates associated with this item address.\n " $ref: '#/components/schemas/Coordinate' PassengerBag: type: object description: "Model information about the passenger's baggage.\n " additionalProperties: false properties: identifier: type: - string - 'null' description: "The unique transportation identifier.\n " maxLength: 4 minLength: 1 nonStandard: type: boolean description: "Flag for marking a bag as a non-standard piece of luggage.\n " osTag: type: - string - 'null' description: "The OSTag in Bag object.\n " maxLength: 32 minLength: 0 taggedToStation: type: - string - 'null' description: "The tagged to station in the bag object. This is the last station where\nthe bag is going to. For example, on a trip from SLC to JFK, JFK would\nbe the tagged to station value.\n " maxLength: 3 minLength: 3 weight: type: integer description: "The Weight in Bag object.\n " maximum: 32767.0 minimum: 0.0 weightType: description: "The WeightType in Bag object.\n " $ref: '#/components/schemas/WeightType' baggageKey: type: - string - 'null' description: "Unique key for the baggage.\n " type: type: - string - 'null' description: "The type of baggage.\n " maxLength: 6 minLength: 0 osTagDate: type: - string - 'null' description: "The bag OS tag date.\n " format: date-time stationCode: type: - string - 'null' description: "The bag station code.\n " maxLength: 3 minLength: 3 taggedToCarrierCode: type: - string - 'null' description: "The bag tagged to carrier code.\n " maxLength: 3 minLength: 2 AvailabilityType: type: integer description: "Availability type defines the type of fares to be returned.\n \n\n0 = Default\n1 = Standby\n2 = Overbook\n3 = NoPricing" x-enumNames: - Default - Standby - Overbook - NoPricing enum: - 0 - 1 - 2 - 3 PassengerScore: type: object description: "Defines a passenger score.\n " additionalProperties: false required: - guestValueCode properties: guestValueCode: type: string description: "The guest value code.\n " maxLength: 8 minLength: 1 score: type: integer description: "The score.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 passengerKey: type: - string - 'null' description: "The passenger key associated with the score.\n " PointOfSale: type: object description: "Model related to the point of sale. This is for read-only operations.\n " additionalProperties: false properties: agentCode: type: - string - 'null' description: "The point of sale agent code.\n " domainCode: type: - string - 'null' description: "The point of sale domain code.\n " locationCode: type: - string - 'null' description: "The point of sale location code.\n " organizationCode: type: - string - 'null' description: "The point of sale organization code.\n " TripInformationLegQuery: type: object description: "The trip information leg query model contains data to perform a\ntrip information search.\n " additionalProperties: false required: - beginDate properties: beginDate: type: string description: "The starting date of the trip information search.\n " format: date-time minLength: 1 endDate: type: - string - 'null' description: "The end date of the trip information search.\n " format: date-time startTimeInterval: type: - string - 'null' description: "The starting time of the trip information search.\n " format: duration endTimeInterval: type: - string - 'null' description: "The end time of the trip information search.\n " format: duration identifier: type: - string - 'null' description: "The transportation identifier, such as a flight number.\n " maxLength: 4 minLength: 0 carrierCode: type: - string - 'null' description: "The carrier code.\n " maxLength: 3 minLength: 2 daysOfWeek: type: - array - 'null' description: "The days of the week to include in the provided date range.\n " items: $ref: '#/components/schemas/DayOfWeek' equipmentFilter: description: "The optional equipment filter for the search.\n " $ref: '#/components/schemas/EquipmentFilter' originStations: type: - array - 'null' description: "The list of departure stations.\n " items: type: string destinationStations: type: - array - 'null' description: "The list of arrival stations.\n " items: type: string opSuffix: type: - string - 'null' description: "The operational suffix.\nPlease note that this should be a char and not a string.\n " maxLength: 1 excludeMarketedFlights: type: boolean description: "When set to true, all flights with a non-blank operating carrier are filtered out of the result.\nThe DB calls the parameter noOperatingCarrier.\n " BookingComment: type: object description: "Defines a booking comment.\n " additionalProperties: false properties: type: description: "Indicates where the comment will be seen.\n " $ref: '#/components/schemas/CommentType' text: type: - string - 'null' description: "The text of the comment.\n " createdDate: type: - string - 'null' description: "The created date of the comment.\n " format: date-time pointOfSale: description: "The point of sale for the comment.\n " $ref: '#/components/schemas/PointOfSale' commentKey: type: - string - 'null' description: "The comment key.\n " Address: type: object description: "Defines a common address.\n " additionalProperties: false properties: lineOne: type: - string - 'null' description: "The address line one.\n " maxLength: 128 minLength: 0 lineTwo: type: - string - 'null' description: "The address line two.\n " maxLength: 128 minLength: 0 lineThree: type: - string - 'null' description: "The address line 3.\n " maxLength: 128 minLength: 0 countryCode: type: - string - 'null' description: "The country code.\n " maxLength: 2 minLength: 0 provinceState: type: - string - 'null' description: "The province state.\n " maxLength: 3 minLength: 0 city: type: - string - 'null' description: "The city.\n " maxLength: 32 minLength: 0 postalCode: type: - string - 'null' description: "The postal code.\n " maxLength: 10 minLength: 0 LegDetailsv2: type: object description: "Represents the leg details model.\n " additionalProperties: false properties: departureTimeUtc: type: - string - 'null' description: "The departure time using the time variant in universal time.\n " format: date-time arrivalTimeUtc: type: - string - 'null' description: "The arrival time using the time variant in universal time.\n " format: date-time adjustedCapacity: type: integer description: "The leg adjusted capacity.\n " arrivalTerminal: type: - string - 'null' description: "The leg arrival terminal.\n " maxLength: 2 minLength: 0 arrivalTimeVariant: type: integer description: "The leg arrival Local Time Variant (LTV).\n " capacity: type: - integer - 'null' description: "The leg capacity.\n " changeOfDirection: type: boolean description: "A value indicating whether the leg has a change of direction.\n " codeShareIndicator: description: "The leg code share indicator.\n " $ref: '#/components/schemas/CodeShareIndicator' departureTerminal: type: - string - 'null' description: "The leg departure terminal.\n " maxLength: 2 minLength: 0 departureTimeVariant: type: integer description: "The leg departure Local Time Variant (LTV).\n " equipmentType: type: - string - 'null' description: "The leg type of the equipment.\n " maxLength: 3 minLength: 0 equipmentTypeSuffix: type: - string - 'null' description: "The leg equipment type suffix.\n " maxLength: 3 minLength: 0 eTicket: type: boolean description: "A value indicating whether this leg is an e-ticketed leg.\n " irop: type: boolean description: "Gets or sets a value indicating whether this leg is an IROP.\n " lid: type: integer description: "The leg's lid.\n " marketingCode: type: - string - 'null' description: "The leg marketing code.\n " marketingOverride: type: boolean description: "A value indicating whether the leg has a marketing override.\n " onTime: description: "The indicator for on-time perfomance of the leg.\n " $ref: '#/components/schemas/OnTime' arrivalTime: type: - string - 'null' description: "The leg passenger standard time of arrival (STA).\n " format: date-time departureTime: type: - string - 'null' description: "The leg passenger standard time of departure (STD).\n " format: date-time prbcCode: type: - string - 'null' description: "The leg PRBC code.\n " maxLength: 8 minLength: 0 status: description: "The legs status.\n " $ref: '#/components/schemas/LegStatus' subjectToGovernmentApproval: type: boolean description: "A value indicating whether the leg is subject to government approval.\n " jointOpInfo: type: - string - 'null' description: "The identifier if legs are jointly operated by two or more carriers.\n " maxLength: 20 minLength: 0 transitLayover: type: integer description: "The waiting period in number of days between flights.\n " transitDays: type: integer description: "The number of transit days for the leg.\n " TicketIndicatorCode: type: integer description: "This enumeration defines the ticket requirements\n \n\n0 = Unknown\n1 = TicketRequired\n2 = AutomatedTicketLiftRequired\n3 = ManualTicketLiftRequired\n4 = AutomatedTicketNoLiftRequired\n5 = ManualTicketNoLiftRequired\n6 = HostETicketNoLiftRequired\n7 = ElectronicTicketNoLiftRequired" x-enumNames: - Unknown - TicketRequired - AutomatedTicketLiftRequired - ManualTicketLiftRequired - AutomatedTicketNoLiftRequired - ManualTicketNoLiftRequired - HostETicketNoLiftRequired - ElectronicTicketNoLiftRequired enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 PaymentAction: type: integer description: "Defines payment action that should be taken by selling system for this service.\n \n\n1 = SellingSystemCollects\n2 = PassThroughHold\n3 = NoPaymentRequired\n4 = ReferToSupplierMessage\n5 = PassThroughCharge" x-enumNames: - SellingSystemCollects - PassThroughHold - NoPaymentRequired - ReferToSupplierMessage - PassThroughCharge enum: - 1 - 2 - 3 - 4 - 5 BookingPriceBreakdown: type: object description: "Defines the booking top level pricing breakdown.\n " additionalProperties: false properties: balanceDue: type: number description: "The booking balance due.\n " format: decimal pointsBalanceDue: type: number description: "The booking points balance due.\n " format: decimal authorizedBalanceDue: type: number description: "The bookings authorized balance due.\n " format: decimal totalAmount: type: number description: "The booking total amount.\n " format: decimal totalPoints: type: number description: "The booking total points.\n " format: decimal totalToCollect: type: number description: "The booking total to collect.\n " format: decimal totalPointsToCollect: type: number description: "The booking total points to collect.\n " format: decimal totalCharged: type: number description: "The total amount charged.\n " format: decimal passengerTotals: description: "The calculated price breakdown for all passengers.\n " $ref: '#/components/schemas/PassengerPriceBreakdownBase' passengers: type: - object - 'null' description: "The individual collection of passenger price breakdowns.\n " additionalProperties: $ref: '#/components/schemas/PassengerPriceBreakdown' journeyTotals: description: "The calculated price breakdown for all journeys.\n " $ref: '#/components/schemas/JourneyPriceBreakdownBase' journeys: type: - object - 'null' description: "The individual collection of journey price breakdown.\n " additionalProperties: $ref: '#/components/schemas/JourneyPriceBreakdown' addOnTotals: description: "The total amounts charged for each type of AddOn.\n " $ref: '#/components/schemas/AddOnPriceBreakdown' TripOperationCrew: type: object description: "Represents the crew of an trip operation.\n " additionalProperties: false properties: tripOperationCrewKey: type: - string - 'null' description: "The unique identifier for the trip crew operation.\n " crewType: description: "The crew personnel type.\n " $ref: '#/components/schemas/CrewType' FareAvailabilityv2: type: object description: "The fare availability represents a master fare reference with all the fare details.\n " additionalProperties: false properties: isGoverning: type: boolean description: "Flag indicating of the fare is the governing fare.\n " fareBasisCode: type: - string - 'null' description: "The fare basis code.\n " classOfService: type: - string - 'null' description: "The class of service.\n " classType: type: - string - 'null' description: "The fare class type.\n " fareApplicationType: description: "The fare application type.\n " $ref: '#/components/schemas/FareApplicationType' fareStatus: description: "The fare status.\n " $ref: '#/components/schemas/FareStatus' productClass: type: - string - 'null' description: "The fare product class.\n " ruleNumber: type: - string - 'null' description: "The fare rule number.\n " ruleTariff: type: - string - 'null' description: "The fare rule tariff.\n " passengerFares: type: - array - 'null' description: "The fare collection of passenger price breakdown.\n " items: $ref: '#/components/schemas/PassengerFareAvailability' travelClassCode: type: - string - 'null' description: "The travel class code.\nPlease note that this should be a char and not a string.\n " maxLength: 1 isAllotmentMarketFare: type: boolean description: "Gets or sets a value indicating whether this fare is an allotment market fare.\n " reference: type: - string - 'null' description: "The reference to the fare from the journey fare available.\n " CommentType: type: integer description: "Comment Types Enumerations\n \n\n0 = Default\n1 = Itinerary\n2 = Manifest\n3 = Alert\n4 = Archive\n5 = Voucher" x-enumNames: - Default - Itinerary - Manifest - Alert - Archive - Voucher enum: - 0 - 1 - 2 - 3 - 4 - 5 Term: type: object description: "Defines the terms and conditions of an order.\n " additionalProperties: false properties: code: type: - string - 'null' description: "The terms and conditions code.\n " description: type: - string - 'null' description: "The description.\n " terms: type: - string - 'null' description: "The terms.\n " NotificationPreference: type: integer description: "Describes types of notifications the user would prefer.\n \n\n0 = None\n1 = Promotional" x-enumNames: - None - Promotional enum: - 0 - 1 GateInformation: type: object description: "Represents the gate information for the trip status model. Consists\nof actual gate information and estimated/scheduled gate information.\n " additionalProperties: false properties: estimatedGate: type: - string - 'null' description: "Represents the estimated or scheduled gate of the trip mode.\n " maxLength: 4 minLength: 0 actualGate: type: - string - 'null' description: "Represents the actual gate of the trip mode.\n " maxLength: 4 minLength: 0 BundleSsrPrice: type: object description: "The bundle SSR price model.\n " additionalProperties: false properties: bundleSsrPrice: type: number description: "The total price of the applied fee.\n " format: decimal taxTotal: type: number description: "The applied sales tax.\n " format: decimal inclusiveTaxTotal: type: number description: "The total sales inclusive taxes that are applicable to the service bundle ssr.\n " format: decimal ssrCode: type: - string - 'null' description: "The SSR code.\n " maxLength: 4 minLength: 0 PassengerAddress: type: object description: "Passenger address information. This contains more data then the base address class.\n " additionalProperties: false properties: status: description: "The addresses APIS status.\n " $ref: '#/components/schemas/ApisAddressStatus' companyName: type: - string - 'null' description: "Company name associated with this address.\n " maxLength: 64 minLength: 0 phone: type: - string - 'null' description: "Phone number associated with this address.\n " maxLength: 20 minLength: 0 stationCode: type: - string - 'null' description: "Station code associated with this address.\n " maxLength: 3 minLength: 3 emailAddress: type: - string - 'null' description: "The email address associated with the address.\n " cultureCode: type: - string - 'null' description: "The culture code for the passenger address.\n " maxLength: 17 minLength: 0 refusedContact: type: - boolean - 'null' description: "Indicates if the passenger refused to enter a contact.\n " lineOne: type: - string - 'null' description: "The address line one.\n " maxLength: 128 minLength: 0 lineTwo: type: - string - 'null' description: "The address line two.\n " maxLength: 128 minLength: 0 lineThree: type: - string - 'null' description: "The address line 3.\n " maxLength: 128 minLength: 0 countryCode: type: - string - 'null' description: "The country code.\n " maxLength: 2 minLength: 0 provinceState: type: - string - 'null' description: "The province state.\n " maxLength: 3 minLength: 0 city: type: - string - 'null' description: "The city.\n " maxLength: 32 minLength: 0 postalCode: type: - string - 'null' description: "The postal code.\n " maxLength: 10 minLength: 0 passengerAddressKey: type: - string - 'null' description: "The unique address identifier.\n " InboundOutbound: type: integer description: "This enumeration specifies direction of flight application.\n \n\n0 = None\n1 = Inbound\n2 = Outbound\n3 = Both\n4 = RoundFrom\n5 = RoundTo" x-enumNames: - None - Inbound - Outbound - Both - RoundFrom - RoundTo enum: - 0 - 1 - 2 - 3 - 4 - 5 BookingSales: type: object description: "Defines the different point of sale information.\n " additionalProperties: false properties: created: description: "Contains the details about the agent and organization information that created this booking.\n " $ref: '#/components/schemas/PointOfSale' source: description: "Contains the details about the agent and organization information that referred the created booking.\n " $ref: '#/components/schemas/BookingPointOfSale' modified: description: "Contains the details about the agent and organization information that made the last set of changes.\n " $ref: '#/components/schemas/PointOfSale' BookingInfo: type: object description: "Describes general booking details.\n " additionalProperties: false properties: status: description: "The status of the entire booking.\n " $ref: '#/components/schemas/BookingStatus' paidStatus: description: "The status of the applied payments.\n " $ref: '#/components/schemas/PaidStatus' priceStatus: description: "The pricing status of the booking.\n " $ref: '#/components/schemas/PriceStatus' profileStatus: description: "The booking profiling status.\n " $ref: '#/components/schemas/BookingProfileStatus' bookingType: type: - string - 'null' description: "Identifies the type (Default, GDS, CodeShare, ect) of the booking set during the commit process.\n " channelType: description: "The channel that is responsible for created the booking.\n " $ref: '#/components/schemas/ChannelType' bookedDate: type: - string - 'null' description: "The UTC date and time the booking was originally created.\n " format: date-time createdDate: type: - string - 'null' description: "The UTC date and time of when the booking was created.\n " format: date-time expirationDate: type: - string - 'null' description: "The UTC date and time indicating when the booking will not be returned when retrieved by a GDS/GRS.\n " format: date-time modifiedDate: type: - string - 'null' description: "The UTC date and time when the booking was last updated on the server.\n " format: date-time modifiedAgentId: type: integer description: "The last agent ID who modified the booking.\n " format: int64 createdAgentId: type: integer description: "The agent ID that created the booking.\n " format: int64 owningCarrierCode: type: - string - 'null' description: "Identifies which carrier is financially responsible for the booking and payment.\n " maxLength: 3 minLength: 2 changeAllowed: type: boolean description: "The flag indicating whether the booking can be changed.\n " createdUserKey: type: - string - 'null' description: "The user key of the agent ID who created the booking, which can be used anywhere the userKey is accepted.\n " modifiedUserKey: type: - string - 'null' description: "The modified user key of the agent ID who modified the booking last, which can be used anywhere the userKey is\naccepted.\n " AvailabilityMoveRequest: type: object description: "Defines the availability move request.\n " additionalProperties: false required: - journeyKey - stations - dates properties: filters: description: "The filtering criteria.\n " $ref: '#/components/schemas/AvailabilityMoveFilterCriteria' journeyKey: type: string description: "The journey sell key to move.\n " minLength: 1 stations: description: "The station criteria.\n " $ref: '#/components/schemas/AvailabilityStationCriteria' dates: description: "The date criteria.\n " $ref: '#/components/schemas/AvailabilityDateCriteria' flightFilters: description: "The flight search criteria.\n " $ref: '#/components/schemas/AvailabilityFlightCriteria' type: description: "Defines the type of fares to be returned.\n " $ref: '#/components/schemas/AvailabilityType' passengerMoveType: description: "The passenger move type.\n " $ref: '#/components/schemas/MovePassengerJourneyType' AddOnStatus: type: integer description: "An enumeration to indicate the add on's current status.\n \n\n0 = Unknown\n1 = Active\n2 = Pending\n3 = Confirming\n4 = CancelPending\n5 = Cancelled" x-enumNames: - Unknown - Active - Pending - Confirming - CancelPending - Cancelled enum: - 0 - 1 - 2 - 3 - 4 - 5 InfantFee: type: object description: "Defines the infant fee information.\n " additionalProperties: false required: - code properties: isConfirmed: type: boolean description: "A status flag to indicate if the fee has been confirmed or not.\n " isConfirming: type: boolean description: "A status flag to indicate if the fee is confirming or not.\n " isConfirmingExternal: type: boolean description: "A status flag to indicate if the fee is confirming external or not.\n " code: type: string description: "The fee code.\n " maxLength: 6 minLength: 0 detail: type: - string - 'null' description: "The fee detail.\n " maxLength: 32 minLength: 0 passengerFeeKey: type: - string - 'null' description: "The passenger fee key.\n " override: type: boolean description: "The fee override.\n " flightReference: type: - string - 'null' description: "The flight reference which signifies a link to a segment and or leg.\n " maxLength: 22 minLength: 0 note: type: - string - 'null' description: "The fee notes.\n " maxLength: 128 minLength: 0 createdDate: type: - string - 'null' description: "The created date for the fee.\n " format: date-time isProtected: type: boolean description: "Indicates if the fee is protected.\n " serviceCharges: type: - array - 'null' description: "The list of service charges for the fee.\n " items: $ref: '#/components/schemas/ServiceCharge' OriginDetails: type: object description: "Represents the origin details model.\n " additionalProperties: false properties: note: type: - string - 'null' description: "Represents additional information about the\ntrip operation station.\n " maxLength: 128 minLength: 0 gate: description: "Represents the gate details.\n " $ref: '#/components/schemas/GateInformation' station: type: - string - 'null' description: "The station code.\n " maxLength: 3 minLength: 0 status: description: "Represents the departure status.\n " $ref: '#/components/schemas/DepartureStatus' LoyaltyFilter: type: integer description: "Availability loyalty filter enumeration for filtering the returning fares on availability.\n \n\n0 = MonetaryOnly\n1 = PointsOnly\n2 = PointsAndMonetary\n3 = PreserveCurrent" x-enumNames: - MonetaryOnly - PointsOnly - PointsAndMonetary - PreserveCurrent enum: - 0 - 1 - 2 - 3 ChallengePreference: type: integer description: "Defines the challenge preference.\n \n\n0 = NoPreference\n1 = NoChallengeRequested\n2 = ChallengeRequested\n3 = ChallengeMandated" x-enumNames: - NoPreference - NoChallengeRequested - ChallengeRequested - ChallengeMandated enum: - 0 - 1 - 2 - 3 WeightType: type: integer description: "Weight Type enumeration.\n \n\n0 = Default\n1 = Pounds\n2 = Kilograms" x-enumNames: - Default - Pounds - Kilograms enum: - 0 - 1 - 2 FlightCloseRequest: type: object description: "Options for flight close\n " additionalProperties: false properties: bypassCheckinRestrictions: type: boolean description: "This will allows updates regardless of checkin configuration period of time set in settings.\n " overrideBalanceDueWarning: type: boolean description: "This will allow the flight to be closed regardless of any balance due by any passenger(s) on the leg.\n " overrideExitRowRequirement: type: boolean description: "This will allow the flight to be closed regardless of exit row requirements.\n " autoBoardAllCheckedInPassengers: type: boolean description: "Board all checked-in passengers automatically. With this Autoboard feature enabled,\nagents can close a flight before boarding passengers.\n " convertHoldToConfirmed: type: boolean description: "On Flight Close convert hold to confirmed (HL to HK), Otherwise set to N.\n " deleteStandByPassengers: type: boolean description: "Also delete standby passengers when converting hold to confirmed.\n " validateOverWingExitRows: type: boolean description: "Determines whether we will validate the overwing exit row requirements at flight close.\n " processStandbyPayments: type: boolean description: "Process standby passenger form of payment on flight close.\n " SsrDurationType: type: integer description: "Ssr duration type.\n \n\n0 = Segment\n1 = Journey\n2 = Leg" x-enumNames: - Segment - Journey - Leg enum: - 0 - 1 - 2 BookingSellRequest: type: object description: "Trip sell request represents the data needed to sell journeys to a booking.\n " additionalProperties: false required: - passengers - currencyCode properties: journeys: description: "The journey information.\n " $ref: '#/components/schemas/JourneySellRequest' contact: description: "The primary contact.\n " $ref: '#/components/schemas/ContactRequest' passengers: type: array description: "The list of passengers.\n " items: $ref: '#/components/schemas/BookingPassengerRequest' residentCountry: type: - string - 'null' description: "The acting resident country.\n " maxLength: 2 minLength: 0 currencyCode: type: string description: "The desired currency code.\n " maxLength: 3 minLength: 1 promotionCode: type: - string - 'null' description: "The promo code to apply.\n " maxLength: 8 minLength: 0 sourceOrganization: type: - string - 'null' description: "The acting source organization code.\n " maxLength: 10 minLength: 0 loyalty: description: "Controls whether to use monetary fares, points-based fares, or both.\nDefaults to monetary only.\n " $ref: '#/components/schemas/TripLoyaltyFilter' serviceBundleCodes: type: - array - 'null' description: "Optional list of bundle codes from a specific fare of a flight to be added to the booking if `ApplyServiceBundle`\nis set to `Yes` or `Copy`.\n " items: type: string applyServiceBundle: description: "Determines whether to sell bundles in the booking. Can also be used for cancel or rebook situations.\n " $ref: '#/components/schemas/ApplyServiceBundle' BookingQueueInfo: type: object description: "Describes the booking queue info.\n " additionalProperties: false properties: code: type: - string - 'null' description: "The identifier for the queue where the booking is placed.\n " maxLength: 6 minLength: 0 subCode: type: - string - 'null' description: "The identifier for the sub queue where the booking is placed.\n " maxLength: 6 minLength: 0 name: type: - string - 'null' description: "The name for the queue where the booking is placed.\n " maxLength: 64 minLength: 0 queueId: type: integer description: "The unique ID of the booking queue entry.\n " format: int64 passengerId: type: integer description: "The unique identifier of a passenger on the booking.\n " format: int64 watchListId: type: integer description: "Unique identifier of the watchlist where a match was found for the booking or passenger.\n " format: int64 note: type: - string - 'null' description: "A summary on why the booking was placed in the queue.\n " maxLength: 128 minLength: 0 type: description: "The type of event that triggered placement of the booking in the queue.\n " $ref: '#/components/schemas/QueueEventType' action: description: "The action that will be taken as a result of the placement in the queue.\n " $ref: '#/components/schemas/QueueAction' mode: description: "The indicator if this entry was added or removed from the queue.\n " $ref: '#/components/schemas/QueueMode' flightReference: type: - string - 'null' description: "The flight reference.\n " bookingQueueKey: type: - string - 'null' description: "The key of the booking queue entry.\n " passengerAlternateKey: type: - string - 'null' description: "The unique identifier of a passenger on the booking.\n " watchListKey: type: - string - 'null' description: "Unique identifier of the watchlist where a match was found for the booking or passenger.\n " PaymentDetails: type: object description: "Defines the payment details.\n " additionalProperties: false properties: accountNumberId: type: integer description: "The reference of an encrypted account number.\n " format: int64 parentPaymentId: type: - integer - 'null' description: "ID of the parent of refunds or divide. Null if none exists.\n " format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 accountName: type: - string - 'null' description: "The account holder name.\n " maxLength: 64 minLength: 0 accountNumber: type: - string - 'null' description: "The account number.\n " maxLength: 34 minLength: 0 expirationDate: type: - string - 'null' description: "The expiration date.\n " format: date-time text: type: - string - 'null' description: "The payment added text.\n " maxLength: 64 minLength: 0 installments: type: integer description: "The number of installments to be applied.\n " maximum: 999.0 minimum: 0.0 binRange: type: integer description: "The first 6 digits of the credit card number.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 fields: type: - object - 'null' description: "The collection of payment fields.\n " additionalProperties: type: string RecordLocator: type: object description: "Defines a unique locator for reference.\n " additionalProperties: false properties: systemDomainCode: type: - string - 'null' description: "The system domain code.\n " maxLength: 3 minLength: 0 bookingSystemCode: type: - string - 'null' description: "The system code of where the booking was created.\n " maxLength: 3 minLength: 0 hostedCarrierCode: type: - string - 'null' description: "The hosted carrier's code.\n " maxLength: 3 minLength: 0 recordLocatorKey: type: - string - 'null' description: "The unique record locator key.\n " recordCode: type: - string - 'null' description: "The record code.\n " maxLength: 12 minLength: 0 owningSystemCode: type: - string - 'null' description: "The owning system code for the booking.\n " maxLength: 3 minLength: 0 interactionPurpose: type: - string - 'null' description: "The interaction purpose.\n " maxLength: 2 minLength: 0 OperationCommentType: type: integer description: "The operation comment type enumeration.\n \n\n0 = Default\n1 = Reservation\n2 = Operation\n3 = PitLoad\n4 = Irop\n5 = AppsOverride\n6 = ManualAppsOverride" x-enumNames: - Default - Reservation - Operation - PitLoad - Irop - AppsOverride - ManualAppsOverride enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 SellKey: type: object description: "Sell key represents the journey and the fare sell keys to combine to what journey and fare will be sold.\n " additionalProperties: false required: - journeyKey - fareAvailabilityKey properties: journeyKey: type: string description: "The journey sell key.\n " minLength: 1 fareAvailabilityKey: type: string description: "The fare sell key.\n " minLength: 1 standbyPriorityCode: type: - string - 'null' description: "The stand by priority code.\n " inventoryControl: description: "The reserving inventory action of the journey once sold by the system.\n " $ref: '#/components/schemas/InventoryControlType' DepartureEvent: type: object description: "Represents the flight operation times for the departure event, which\nincludes an estimated and scheduled time event.\n " additionalProperties: false properties: scheduled: type: - string - 'null' description: "Represents the scheduled departure time.\n " format: date-time estimated: type: - string - 'null' description: "Represents the estimated departure time.\n " format: date-time AvailabilityFilter: type: integer description: "Filter used to filter the types of journeys to return on availability.\n \n\n0 = Default\n1 = ExcludeDeparted\n2 = ExcludeImminent\n3 = ExcludeUnavailable" x-enumNames: - Default - ExcludeDeparted - ExcludeImminent - ExcludeUnavailable enum: - 0 - 1 - 2 - 3 FlightType: type: integer description: "Flight types enumeration.\n \n\n0 = None\n1 = NonStop\n2 = Through\n3 = Direct\n4 = Connect\n5 = All" x-enumNames: - None - NonStop - Through - Direct - Connect - All enum: - 0 - 1 - 2 - 3 - 4 - 5 PassengerTypeCriteriav2: type: object description: "Defines the passenger type criteria for availability search.\n " additionalProperties: false required: - types properties: types: type: array description: "The collection of passenger types and counts.\n " items: $ref: '#/components/schemas/PassengerSearchCriteriav2' residentCountry: type: - string - 'null' description: "The passenger's resident country.\n " maxLength: 2 minLength: 0 Ticket: type: object description: "Model for a ticket applied to a passenger.\n " additionalProperties: false properties: ticketNumber: type: - string - 'null' description: "The ticket number.\n " maxLength: 14 minLength: 0 infantTicketNumber: type: - string - 'null' description: "The infant ticket number.\n " maxLength: 14 minLength: 0 ticketIndicator: description: "The ticket indicator.\n " $ref: '#/components/schemas/TicketIndicatorCode' ticketStatus: description: "The ticket status.\n " $ref: '#/components/schemas/TicketStatusCode' passengerKey: type: - string - 'null' description: "The passenger key the ticket is associated with.\n " ConsumerAddress: type: object description: "Defines a consumer address.\n " additionalProperties: false properties: lineOne: type: - string - 'null' description: "The address line one.\n " maxLength: 128 minLength: 0 lineTwo: type: - string - 'null' description: "The address line two.\n " maxLength: 128 minLength: 0 lineThree: type: - string - 'null' description: "The address line 3.\n " maxLength: 128 minLength: 0 countryCode: type: - string - 'null' description: "The country code.\n " maxLength: 2 minLength: 0 provinceState: type: - string - 'null' description: "The province state.\n " maxLength: 3 minLength: 0 city: type: - string - 'null' description: "The city.\n " maxLength: 32 minLength: 0 postalCode: type: - string - 'null' description: "The postal code.\n " maxLength: 10 minLength: 0 county: type: - string - 'null' description: "The address country.\n " IJsonResponseOfIListOfItineraryVariation: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: $ref: '#/components/schemas/ItineraryVariation' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' ScheduleDetail: type: object description: "Market detail contains the abstracted market data describing the earliest and\nlatest STD.\n " additionalProperties: false properties: departureDate: type: string description: "Date this market detail corresponds to.\n " format: date-time earliest: type: string description: "Earliest std on this departure date.\n " format: date-time latest: type: string description: "Latest std on this deparure date.\n " format: date-time flights: type: integer description: "Number of flights on the given departure date.\n " format: int64 OrderPriceBreakdown: type: object description: "Defines all the different order price breakdown.\n " additionalProperties: false properties: display: description: "The display prices.\n " $ref: '#/components/schemas/Amount' initial: description: "The initial base prices.\n " $ref: '#/components/schemas/Amount' markup: description: "The markup prices.\n " $ref: '#/components/schemas/Amount' listed: description: "The list prices.\n " $ref: '#/components/schemas/Amount' listedDiscount: description: "The list discount prices.\n " $ref: '#/components/schemas/Amount' discount: description: "The discount prices.\n " $ref: '#/components/schemas/Amount' handling: description: "The handling charge prices.\n " $ref: '#/components/schemas/Amount' handlingDiscount: description: "The handling charge discount prices.\n " $ref: '#/components/schemas/Amount' dueNow: description: "The amounts due now at payment.\n " $ref: '#/components/schemas/AmountDue' dueLater: description: "The amounts due later at pickup.\n " $ref: '#/components/schemas/AmountDue' personalizations: type: - number - 'null' description: "The personalized total.\n " format: decimal taxable: type: - number - 'null' description: "The taxable total.\n " format: decimal services: type: - number - 'null' description: "The services total.\n " format: decimal fees: type: - number - 'null' description: "The fees total.\n " format: decimal total: type: - number - 'null' description: "The overall cost.\n " format: decimal taxRate: type: integer description: "The applied tax rate.\n " format: int32 taxExempt: type: boolean description: "Flag indicating if taxes are exempt.\n " taxAtUnitPrice: type: boolean description: "Flag indicating if taxed at the unit price.\n " ClassStatus: type: integer description: "Indicates whether a leg class may be used or not.\n \n\n1 = Active\n2 = InActive\n3 = AvsOpen\n4 = AvsOnRequest\n5 = AvsClosed" x-enumNames: - Active - InActive - AvsOpen - AvsOnRequest - AvsClosed enum: - 1 - 2 - 3 - 4 - 5 TravelDocumentCreateRequest: type: object description: "Defines a create travel documents request.\n " additionalProperties: false required: - documentTypeCode properties: birthCountry: type: - string - 'null' description: "The BirthCountry property.\n " name: description: "The Name property.\n " $ref: '#/components/schemas/Name' nationality: type: - string - 'null' description: "The Nationality property.\n " maxLength: 2 minLength: 0 expirationDate: type: - string - 'null' description: "The date when this travel document expires.\n " format: date-time number: type: - string - 'null' description: "The travel document number.\n " maxLength: 35 minLength: 0 issuedDate: type: - string - 'null' description: "The date this travel document was issued.\n " format: date-time gender: description: "The travel document holder's gender.\n " $ref: '#/components/schemas/Gender' dateOfBirth: type: - string - 'null' description: "The person's date of birth.\n " format: date-time declaredGender: type: - string - 'null' description: "The travel document holder's declared gender.\nThis will override the gender field on passenger or person POST, PUT, and PATCH requests.\nNote: Any value other than \"F\" will cause gender to be updated to Male by default to support compatibility with\nother systems.\nAdditionally you cannot change the declared gender and gender fields at the same time as declared gender\nwill override any gender field value regardless of the value passed in.\n " maxLength: 2 minLength: 0 placeOfBirth: type: - string - 'null' description: "Represents the place of birth. Only used on the following document type groups: TravelVisa (9), RedressNumber (20),\nand KnownTravelerId (21).\nOnly allows alpha characters, please do not use spaces, numbers, or special characters.\nNote: If unsure which travel document types fall into these groups please use `/api/nsk/v1/resources/DocumentTypes`\nor `/api/nsk/v1/resources/DocumentTypes/{documentTypeCode}`\n " maxLength: 35 minLength: 0 pattern: ^[A-Za-z\s]*$ placeOfIssue: type: - string - 'null' description: "Represents the place of issue. Only used on the following document type groups: TravelVisa (9), RedressNumber (20),\nand KnownTravelerId (21).\nOnly allows alpha characters, please do not use spaces, hyphens, or special characters.\nNote: If unsure which travel document types fall into these groups please use `/api/nsk/v1/resources/DocumentTypes`\nor `/api/nsk/v1/resources/DocumentTypes/{documentTypeCode}`\n " maxLength: 35 minLength: 0 pattern: ^[A-Za-z\s]*$ documentTypeCode: type: string description: "The unique travel document type code.\n " maxLength: 4 minLength: 0 issuedByCode: type: - string - 'null' description: "The issuer code for the travel document (country code).\n " maxLength: 3 minLength: 0 PassengerSegmentBag: type: object description: "Model information about the baggage a passenger has on a segment.\n " additionalProperties: false required: - passengerKey - arrivalStation - departureStation properties: baggageKey: type: - string - 'null' description: "Unique key for the baggage.\n " passengerKey: type: string description: "The passenger key associated to this bag.\n " minLength: 1 arrivalStation: type: string description: "The bag segment arrival station.\n " maxLength: 3 minLength: 3 status: description: "The bag status.\n " $ref: '#/components/schemas/BaggageStatus' departureStation: type: string description: "The bag segment departure station.\n " maxLength: 3 minLength: 3 osTag: type: - string - 'null' description: "The bag OS tag.\n " maxLength: 32 minLength: 0 PassengerInfant: type: object description: "Model representing an infant with a passenger.\n " additionalProperties: false properties: nationality: type: - string - 'null' description: "The nationality of the passenger.\n " maxLength: 2 minLength: 0 residentCountry: type: - string - 'null' description: "The residentCountry of the passenger.\n " maxLength: 2 minLength: 0 dateOfBirth: type: - string - 'null' description: "The date of birth of the infant.\n " format: date-time gender: description: "The gender of the passenger.\n " $ref: '#/components/schemas/Gender' name: description: "The name of the passenger.\n " $ref: '#/components/schemas/Name' declaredGender: type: - string - 'null' description: "The infant's declared gender. A value of \"F\" is mapped to a female binary gender. All other values will be\nmapped to a male binary gender.\n " maxLength: 2 minLength: 0 fees: type: - array - 'null' description: "The collection of infant fees.\n " items: $ref: '#/components/schemas/InfantFee' travelDocuments: type: - array - 'null' description: "Travel Documents.\n " items: $ref: '#/components/schemas/PassengerTravelDocument' type: type: - string - 'null' description: "The infant passenger type.\n " SimpleSeatPreference: type: integer description: "Represents a simple seating preference.\n \n\n0 = None\n1 = Window\n2 = Aisle\n3 = Other" x-enumNames: - None - Window - Aisle - Other enum: - 0 - 1 - 2 - 3 CrewType: type: integer description: "Defines the different types of crew members.\n \n\n0 = Default\n1 = Pilot\n2 = CoPilot\n3 = CockpitJumpseat\n4 = CabinJumpseat\n5 = CabinCrew" x-enumNames: - Default - Pilot - CoPilot - CockpitJumpseat - CabinJumpseat - CabinCrew enum: - 0 - 1 - 2 - 3 - 4 - 5 BookingRecordLocators: type: object description: "Defines the booking's unique identifiers.\n " additionalProperties: false properties: numericRecordLocator: type: - string - 'null' description: "The alphanumeric identifier generated when the booking is retrieved from the alphanumeric record locator value that\nwas assigned.\n " maxLength: 12 minLength: 0 parentRecordLocator: type: - string - 'null' description: "The record locator of the booking where the current booking resulted from.\n " maxLength: 12 minLength: 0 parentId: type: integer description: "The unique identifier of the booking where the current booking resulted from.\n " format: int64 recordLocators: type: - array - 'null' description: "The list of other reservations that can be used as cross reference for the booking.\n " items: $ref: '#/components/schemas/RecordLocator' OptionalServiceInformation: type: object description: "Represents the optional service information model.\n " additionalProperties: false properties: carrierCode: type: - string - 'null' description: "The optional service carrier code.\n " maxLength: 3 minLength: 0 reasonForIssuanceSubCode: type: - string - 'null' description: "The optional service reason for issuance sub-code (RFISC).\n " maxLength: 3 minLength: 0 MessageStatus: type: integer description: "Defines the message status.\n \n\n0 = General\n1 = Warning\n2 = Critical" x-enumNames: - General - Warning - Critical enum: - 0 - 1 - 2 TripOperationHistory: type: object description: "Represents the history of an trip operation.\n " additionalProperties: false properties: tripOperationHistoryKey: type: - string - 'null' description: "The unique identification for the trip operation history.\n " tripOperationHistoryCode: type: - string - 'null' description: "Represents the code for the event that triggered an entry into history.\n " maxLength: 2 minLength: 1 detail: type: - string - 'null' description: "Represents the history details.\n " maxLength: 6000 minLength: 1 createdHistoryDate: type: - string - 'null' description: "The date when this history item was created.\n " format: date-time EmdCouponStatus: type: integer description: "Represents the EMD coupon status options.\n \n\n0 = Unknown\n1 = HeldConfirmed\n2 = HoldingNeed\n3 = HoldingConfirmedEmdRequired\n4 = HoldingConfirmedEmdIssued" x-enumNames: - Unknown - HeldConfirmed - HoldingNeed - HoldingConfirmedEmdRequired - HoldingConfirmedEmdIssued enum: - 0 - 1 - 2 - 3 - 4 PassengerBoardingPassDetail: type: object description: "Defines information used to populate the printed boarding pass and 2D bar codes.\n " additionalProperties: false properties: gateInformation: type: - string - 'null' description: "The gate information from the boarding pass.\n " priorityInformation: type: - string - 'null' description: "The priority information from the boarding pass.\n " cabinClass: type: - string - 'null' description: "The cabin class as seen from the boarding pass.\n " compartmentLevel: type: - string - 'null' description: "The compartment level as seen from the boarding pass.\n " boardingZone: type: - string - 'null' description: "The assigned boarding zone from the boarding pass.\n " seatAssignment: type: - string - 'null' description: "The seat assignment as seen from the boarding pass.\n " sequenceNumber: type: - string - 'null' description: "The boarding sequence number as seen from the boarding pass.\n " Amount: type: object description: "Defines an amount base price and total price.\n " additionalProperties: false properties: value: type: - number - 'null' description: "The base amount value.\n " format: decimal total: type: - number - 'null' description: "The total amount.\n " format: decimal IropInventoryControlType: type: integer description: "Defines the different ways inventory is held at the time of sell for an irop move.\n \n\n0 = ClaimSpace\n1 = OversellSpace\n2 = StandBy" x-enumNames: - ClaimSpace - OversellSpace - StandBy enum: - 0 - 1 - 2 OrderNote: type: object description: "Defines a order note.\n " additionalProperties: false properties: text: type: - string - 'null' description: "The notes text.\n " description: type: - string - 'null' description: "The notes description (used to identity the note).\n " created: type: string description: "The created date.\n " format: date-time modified: type: string description: "The modified date.\n " format: date-time CodeShareIndicator: type: integer description: "Specifies the type of code share agreement.\n \n\n0 = NonCodeShare\n1 = CodeShareCommercialDuplicate\n2 = SharedDesignatorOrWetLease\n3 = CodeShareHostOperatingCarrier\n4 = CodeShareCommercialDuplicateWithOverrideText\n5 = SharedDesignatorOrWetLeaseWithOverrideText" x-enumNames: - NonCodeShare - CodeShareCommercialDuplicate - SharedDesignatorOrWetLease - CodeShareHostOperatingCarrier - CodeShareCommercialDuplicateWithOverrideText - SharedDesignatorOrWetLeaseWithOverrideText enum: - 0 - 1 - 2 - 3 - 4 - 5 TripOperationDelay: type: object description: "Represents the trip operation delay data.\n " additionalProperties: false required: - delayCode - note properties: delayCode: type: string description: "The delay code.\n " maxLength: 4 minLength: 1 delayMinutes: type: integer description: "The number of minutes for this delay.\n " note: type: string description: "The note for this delay, containing extra information about the delay\n(if any).\n " maxLength: 128 minLength: 1 includeMvtMessage: type: boolean description: "The flag to include the MVT message.\n " tripOperationDelayKey: type: - string - 'null' description: "The unique identification for the trip operation delay.\n " createdDate: type: - string - 'null' description: "The date the delay was created in UTC.\n " format: date-time modifiedDate: type: - string - 'null' description: "The date the delay was modified in UTC.\n " format: date-time createdUserKey: type: - string - 'null' description: "The unique identifier of the user who created the delay.\n " modifiedUserKey: type: - string - 'null' description: "The unique identifier of the user who modified the delay.\n " IJsonResponseOfIDictionaryOfStringAndListOfInventorySeatPropertyBase: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - object - 'null' description: "The payload data.\n " additionalProperties: type: array items: $ref: '#/components/schemas/InventorySeatPropertyBase' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' LegInformation: type: object description: "Model describing the detailed leg information.\n " additionalProperties: false properties: departureTimeUtc: type: - string - 'null' description: "The departure time using the time variant in universal time.\n " format: date-time arrivalTimeUtc: type: - string - 'null' description: "The arrival time using the time variant in universal time.\n " format: date-time adjustedCapacity: type: integer description: "The leg adjusted capacity.\n " arrivalTerminal: type: - string - 'null' description: "The leg arrival terminal.\n " maxLength: 2 minLength: 0 arrivalTimeVariant: type: integer description: "The leg arrival Local Time Variant (LTV).\n " backMoveDays: type: integer description: "The legs back move days.\n " capacity: type: integer description: "The leg capacity.\n " changeOfDirection: type: boolean description: "A value indicating whether the leg has a change of direction.\n " codeShareIndicator: description: "The leg code share indicator.\n " $ref: '#/components/schemas/CodeShareIndicator' departureTerminal: type: - string - 'null' description: "The leg departure terminal.\n " maxLength: 2 minLength: 0 departureTimeVariant: type: integer description: "The leg departure Local Time Variant (LTV).\n " equipmentType: type: - string - 'null' description: "The leg type of the equipment.\n " maxLength: 3 minLength: 0 equipmentTypeSuffix: type: - string - 'null' description: "The leg equipment type suffix.\n " maxLength: 3 minLength: 0 eTicket: type: boolean description: "A value indicating whether this leg is an e-ticketed leg.\n " irop: type: boolean description: "Gets or sets a value indicating whether this leg is an IROP.\n " lid: type: integer description: "The legs lid.\n " marketingCode: type: - string - 'null' description: "The leg marketing code.\n " marketingOverride: type: boolean description: "A value indicating whether the leg has a marketing override.\n " operatedByText: type: - string - 'null' description: "The leg \"operated by\" text.\n " operatingCarrier: type: - string - 'null' description: "The leg operating carrier.\n " operatingFlightNumber: type: - string - 'null' description: "The leg operating flight number.\n " operatingOpSuffix: type: - string - 'null' description: "The leg operating operating suffix.\nPlease note that this should be a char and not a string.\n " maxLength: 1 outMoveDays: type: integer description: "The leg move out days.\n " arrivalTime: type: - string - 'null' description: "The leg passenger standard time of arrival (STA).\n " format: date-time departureTime: type: - string - 'null' description: "The leg passenger standard time of departure (STD).\n " format: date-time prbcCode: type: - string - 'null' description: "The leg PRBC code.\n " maxLength: 8 minLength: 0 scheduleServiceType: type: - string - 'null' description: "The type of the schedule service.\nPlease note that this should be a char and not a string.\n " maxLength: 1 sold: type: integer description: "The sold.\n " status: description: "The legs status.\n " $ref: '#/components/schemas/LegStatus' subjectToGovtApproval: type: boolean description: "A value indicating whether the leg is subject to government approval.\n " ScheduleItineraryLeg: type: object description: "Defines the itinerary leg for creating flights.\n " additionalProperties: false required: - beginDate - origin - destination - equipmentType - salesConfigurationCode properties: beginDate: type: string description: "The start date of the flight operation.\n " format: date-time minLength: 1 origin: type: string description: "The departure station code.\n " maxLength: 3 minLength: 3 destination: type: string description: "The arrival station code.\n " maxLength: 3 minLength: 3 scheduledDepartureTime: type: integer description: "The leg departure time in minutes.\n " maximum: 1440.0 minimum: 0.0 departureTimeVariant: type: integer description: "The leg departure local time variant (LTV).\n " maximum: 1440.0 minimum: -1440.0 scheduledArrivalTime: type: integer description: "The leg arrival time in minutes.\n " maximum: 1440.0 minimum: 0.0 arrivalTimeVariant: type: integer description: "The leg arrival local time variant (LTV).\n " maximum: 1440.0 minimum: -1440.0 equipmentType: type: string description: "The type of equipment for the leg.\n " maxLength: 3 minLength: 0 equipmentTypeSuffix: type: - string - 'null' description: "The suffix associated with the equipment type.\n " maxLength: 3 minLength: 0 salesConfigurationCode: type: string description: "The sales configuration code for the leg, also known as PRBC (Passenger Reservation Booking Configuration) code.\n " maxLength: 8 minLength: 0 eTicket: type: boolean description: "Indicates if the e-ticket is enabled for the leg.\n " OperatingInformation: type: object description: "Represents the operating information model.\n " additionalProperties: false properties: comment: type: - string - 'null' description: "The operated by comment field.\n " identifier: type: - string - 'null' description: "The unique transportation identifier.\n " maxLength: 4 minLength: 0 carrierCode: type: - string - 'null' description: "The carrier code.\n " maxLength: 3 minLength: 2 opSuffix: type: - string - 'null' description: "The op suffix.\nPlease note that this should be a char and not a string.\n " maxLength: 1 TripPassengerCountsEditRequest: type: object description: "The number of passengers and crew in the flight.\n " additionalProperties: false properties: infantCount: type: integer description: "The number of infants not occupying a seat.\n " maximum: 32767.0 minimum: 0.0 nonRevenueCount: type: integer description: "The number of non-revenue passengers.\n " maximum: 32767.0 minimum: 0.0 revenueCount: type: integer description: "The number of revenue passengers.\n " maximum: 32767.0 minimum: 0.0 cockpitCrewCount: type: integer description: "The number of crew in the cockpit.\n " maximum: 32767.0 minimum: 0.0 cabinCrewCount: type: integer description: "The number of crew in the cabin.\n " maximum: 32767.0 minimum: 0.0 ServiceCharge: type: object description: "Model that represents the fare service charge information.\n " additionalProperties: false properties: amount: type: number description: "The service charge amount.\n " format: decimal code: type: - string - 'null' description: "The service charge code.\n " detail: type: - string - 'null' description: "The service charge detail.\n " maxLength: 10 minLength: 0 type: description: "The service charge type.\n " $ref: '#/components/schemas/ChargeType' collectType: description: "The service charge collect type.\n " $ref: '#/components/schemas/CollectType' currencyCode: type: - string - 'null' description: "The service charge currency code.\n " maxLength: 3 minLength: 0 foreignCurrencyCode: type: - string - 'null' description: "The service charge foreign currency code.\n " maxLength: 3 minLength: 0 foreignAmount: type: number description: "The service charge foreign amount.\n " format: decimal ticketCode: type: - string - 'null' description: "The service charge ticket code.\n " maxLength: 3 minLength: 0 AvailabilityStandbyRequest: type: object description: "Standby availability request.\n " additionalProperties: false required: - journeyKey properties: journeyKey: type: string description: "The journey key to reference in the standby availability request.\n " minLength: 1 classControl: description: "The fare class control.\n " $ref: '#/components/schemas/FareClassControl' numberOfFaresPerJourney: type: - integer - 'null' description: "The number of fares per journey to be returned. If not set, it will use the default optimized values.\n " format: int32 returnEmptyResults: type: - boolean - 'null' description: "Indicates if empty results could be returned as a response.\n " ErrorResponse: type: object description: "Defines a unique error response.\n " additionalProperties: false properties: exception: description: "The original exception that was thrown and all the exception details.\n " $ref: '#/components/schemas/Exception' rawMessage: type: - string - 'null' description: "The original raw message set (non-localized).\n " code: type: - string - 'null' description: "The unique error code. The primary value used to match against a unique message localized for the end user in the\nchosen language.\n " message: type: - string - 'null' description: "The error message. Deprecated: Please use the Code instead.\n " type: type: - string - 'null' description: "The error type showing severity. Values: Critical, Error, Validation, Information.\n " number: type: - integer - 'null' description: "A unique identifier in numeric form. This is required for Splunk logging. If none is provided a number will be\ngenerated based on code and type.\n " format: int32 maximum: 99999.0 minimum: 0.0 details: type: - object - 'null' description: "Dynamic detailed information about the error.\n " additionalProperties: type: string ActivityId: type: - string - 'null' description: "The activity ID unique to the request. Useful for debugging purposes to uniquely look up what happened for this\nspecific request.\n " Journey: type: object description: "Data about the journey which represents the collection of segments and their legs on the journey.\n " additionalProperties: false properties: journeyKey: type: - string - 'null' description: "The unique identifier for this journey sell information.\n " notForGeneralUser: type: boolean description: "A value indicating whether the journey is for a general user.\n " flightType: description: "Returns a flight type enumeration. (NonStop, Thru, etc.)\n " $ref: '#/components/schemas/FlightType' stops: type: integer description: "The total number of stops this flight takes.\n " format: int32 designator: description: "This is a summary of all the segments. It will contain the details\nof the transportation from the first and last segment.\n " $ref: '#/components/schemas/TransportationDesignator' move: description: "The information regarding the journey move restrictions.\n " $ref: '#/components/schemas/JourneyMove' segments: type: - array - 'null' description: "The collection of segments.\n " items: $ref: '#/components/schemas/Segment' FareApplicationType: type: integer description: "This enumeration defines the fare application type of a fare.\n \n\n0 = Route\n1 = Sector\n2 = Governing" x-enumNames: - Route - Sector - Governing enum: - 0 - 1 - 2 JourneyMove: type: object description: "Summarized move data at the journey level.\n " additionalProperties: false properties: maxMoveBackDays: type: integer description: "The maximum number of days this flight can be moved backwards.\n " format: int32 maxMoveOutDays: type: integer description: "The maximum number of days this flight can be moved forward.\n " format: int32 MoveRequestv2: type: object description: "Defines the move journey request for a booking in state.\n " additionalProperties: false required: - fromJourneyKey - journeyKey - fareKey properties: fromJourneyKey: type: string description: "The journey key to move from.\n " minLength: 1 journeyKey: type: string description: "The journey key to move to.\n " minLength: 1 fareKey: type: string description: "The fare key to move to.\n " minLength: 1 moveType: description: "The type of move that is requested.\n " $ref: '#/components/schemas/MovePassengerJourneyType' ignoreClosedFlightStatus: type: boolean description: "If true then the move will be allowed even if the legs of FromJourney have been\nmarked as Closed.\nIf false, the move will be disallowed if any one of the legs\nof FromJourney has been marked as Closed.\n " ignoreLiftStatus: description: "Controls whether the Move is allowed to ignore boarded and/or\nchecked-in statuses.\n " $ref: '#/components/schemas/IgnoreLiftStatus' boardingSequenceOffset: type: integer description: "If set to zero and MovePassengerJourneyType is not Diversion, the boarding sequence\nof the original segments will be copied to the new (moved to) segments.\nIf set to a value other than zero and MovePassengerJourneyType is not Diversion,\nthe boarding sequence of the original segments will be copied to the new (moved to)\nsegments and then incremented by the specified BoardingSequenceOffset.\nBoarding sequence is not preserved for Diversion moves.\n " moveSsrOption: description: "Controls whether to move SSRs from FromJourney to ToJourney.\n " $ref: '#/components/schemas/MoveSsrOption' standbyPriorityCode: type: - string - 'null' description: "Standby priority code.\n " inventoryControlType: description: "Inventory control.\n " $ref: '#/components/schemas/InventoryControlType' changeReasonCode: description: "Change reason code.\n " $ref: '#/components/schemas/ChangeReasonCodes' JourneySsrRequest: type: object description: "SSR request for a single journey Ssr.\n " additionalProperties: false required: - ssrCode - journeyKey properties: ssrCode: type: string description: "The Ssr code.\n " minLength: 1 count: type: - integer - 'null' description: "The number of items to include. Defaults to 1.\n " maximum: 32767.0 minimum: 1.0 note: type: - string - 'null' description: "Notes associated with this Ssr.\n " journeyKey: type: string description: "The journey key.\n " minLength: 1 PassengerSearchCriteriav2: type: object description: "Represents the passenger group type for availability search.\n " additionalProperties: false required: - type - count properties: type: type: string description: "The passenger type code.\n " maxLength: 4 minLength: 0 discountCode: type: - string - 'null' description: "The discount code to be applied.\n " maxLength: 4 minLength: 0 count: type: integer description: "The number of passenger for the type.\n " format: int32 maximum: 2147483647.0 minimum: 1.0 details: type: - array - 'null' description: "The additional search criteria per passenger. The number of details in the list must match the count.\n " items: $ref: '#/components/schemas/PassengerSearchCriteriaDetail' SeatPreferenceStatus: type: integer description: "Defines the seat preference status.\n \n\n0 = Unknown\n1 = Met\n2 = NotMet" x-enumNames: - Unknown - Met - NotMet enum: - 0 - 1 - 2 TripOperationTimesEditRequest: type: object description: "Represents the edit request for flight operation time events.\n " additionalProperties: false properties: touchDownTimes: description: "Represents the touch down times for this flight operation.\n " $ref: '#/components/schemas/TripOperationEvents' onBlockTimes: description: "Represents the on-block times for this flight operation.\n " $ref: '#/components/schemas/TripOperationEvents' departureTimes: description: "Represents the departure times for this flight operation.\n " $ref: '#/components/schemas/DepartureEvent' offBlockTime: type: - string - 'null' description: "Represents the off-block time for this flight operation.\n " format: date-time airborneTime: type: - string - 'null' description: "Represents the airborne time for this flight operation.\n " format: date-time crewReportTime: type: - string - 'null' description: "Represents the crew report time for this flight operation.\n " format: date-time takeOffTime: type: - string - 'null' description: "Represents the take-off time for this flight operation.\n " format: date-time movementAfterPushBackTime: type: - string - 'null' description: "Represents the movement after push-back time (taxi) for this flight operation.\n " format: date-time nextInformationTime: type: - string - 'null' description: "Represents the next information time for this flight operation.\n " format: date-time reclearanceTime: type: - string - 'null' description: "Represents the re-clearance time for this flight operation.\n " format: date-time returnToRampTime: type: - string - 'null' description: "Represents the return to ramp time for this flight operation.\n " format: date-time scheduledArrivalTime: type: - string - 'null' description: "Represents the scheduled arrival time for this flight operation.\n " format: date-time AvailableJourneyFare: type: object description: "The available journey fare represents a journeys fare offering. If the journey is multi segment multiple fare\ndetails will be present so each fare can be shown its unique details.\n " additionalProperties: false properties: fareAvailabilityKey: type: - string - 'null' description: "The unique fare availability key.\n " details: type: - array - 'null' description: "The collection of fare details for a specific fare.\n " items: $ref: '#/components/schemas/AvailableJourneyFareDetail' isSumOfSector: type: boolean description: "Flag indicating if the journey fare is sum of sector.\n " ApplyServiceBundle: type: integer description: "The apply service bundle enumeration.\n \n\n0 = Yes\n1 = No\n2 = Copy" x-enumNames: - true - false - Copy enum: - 0 - 1 - 2 ChallengePreferenceWindowSize: type: integer description: "Defines the challenge preference window size.\n \n\n0 = SizeFullPage\n1 = Size250X400\n2 = Size390X400\n3 = Size500X600\n4 = Size600X400" x-enumNames: - SizeFullPage - Size250X400 - Size390X400 - Size500X600 - Size600X400 enum: - 0 - 1 - 2 - 3 - 4 CabinDetails: type: object description: "Represents the cabin details model.\n " additionalProperties: false properties: cabinOfService: type: - string - 'null' description: "Represents the code for the cabin of service.\nPlease note that this should be a char and not a string.\n " maxLength: 1 adjustedSeatCount: type: integer description: "Represents the adjusted seat count of the leg for the cabin.\n " format: int32 maximumSeatCount: type: integer description: "Represents the maximum number of seats authorized to be sold on a flight.\n " format: int32 seatsSold: type: integer description: "Represents the number of seats that have been sold.\n " format: int32 TripStatusv2: type: object description: "Represents the trip status version two model.\n " additionalProperties: false properties: tripStatusKey: type: - string - 'null' description: "Represents the trip status key.\n " operationDetails: description: "Represents the operation details.\n " $ref: '#/components/schemas/OperationDetails' originDetails: description: "Represents details related to the trip origin location.\n " $ref: '#/components/schemas/OriginDetails' destinationDetails: description: "Represents details related to the trip destination location.\n " $ref: '#/components/schemas/DestinationDetails' modifiedAgentName: type: - string - 'null' description: "The name of the agent that last modified this data.\n " maxLength: 64 minLength: 0 verified: type: boolean description: "Represents the verified bit.\n " irop: type: boolean description: "Represents the IROP flag.\n " modifiedDate: type: - string - 'null' description: "The date and time (in UTC) that the trip status was modified.\n " format: date-time BookingOrderStatus: type: integer description: "Booking Order Status Enumeration\n \n\n0 = None\n1 = FinalizedProcess" x-enumNames: - None - FinalizedProcess enum: - 0 - 1 securitySchemes: JWT: type: http description: Paste your JWT token from the token endpoint. scheme: bearer bearerFormat: jwt x-generator: NSwag v14.6.3.0 (NJsonSchema v11.5.2.0 (Newtonsoft.Json v13.0.0.0))