{ "opencollection": "1.0.0", "info": { "name": "NewSkies-Digital-Api", "version": "4.8.6.23" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "account", "type": "folder" }, "items": [ { "info": { "name": "Sends a challenge code for agents' reset password flow.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/account/password/challenge", "body": { "type": "json", "data": "{}" } }, "docs": "This is the first step in the reset password flow to generate a challenge code. The challenge\ncode is sent to the user's email and/or phone number based on the domain configuration.\nTo configure this flow, see the Reset Password tab in the `Edit Domain` window in `Management Console`.\n\nRelated Endpoints:\n- POST /api/nsk/v1/account/password/challenge/verify: The optional step to verify the challenge code.\n- PUT /api/nsk/v1/account/password/challenge/reset: The second step to verify the challenge " }, { "info": { "name": "Resets the password for agents using challenge code authentication.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/account/password/challenge/reset", "body": { "type": "json", "data": "{}" } }, "docs": "This is the second step in the reset password flow. To configure this flow, see the Reset Password tab in\nthe `Edit Domain` window in `Management Console`.\n\nRelated Endpoints:\n- POST /api/nsk/v1/account/password/challenge: The first step to generate the challenge code.\n- POST /api/nsk/v1/account/password/challenge/verify: The optional step to verify the challenge code.\n\nUnrelated Endpoints:\n- POST /api/auth/v1/token/multifactor: MFA relies on separate configuration and is for login flows vs rese" }, { "info": { "name": "Verifies the challenge code for agents' reset password flow.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/account/password/challenge/verify", "body": { "type": "json", "data": "{}" } }, "docs": "This is an optional step between creating a challenge code and resetting the password. To configure this flow,\nsee the Reset Password tab in the `Edit Domain` window in `Management Console`.\n\nRelated Endpoints:\n- POST /api/nsk/v1/account/password/challenge: The first step to generate the challenge code.\n- PUT /api/nsk/v1/account/password/challenge/reset: The second step to verify the challenge code and reset the\npassword.\n\nUnrelated Endpoints:\n- POST /api/auth/v1/token/multifactor: MFA relies on" }, { "info": { "name": "Changes the accounts password.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v3/account/password/change", "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint is recommended for a user who has an expired password.\nThis endpoint is restricted to the anonymous user only\nand remains as the anonymous user even if the change password operation completed.\nFor changing the password of a logged-in user, please use /api/nsk/v3/user/password/change.\nThis follows domain level restrictions and could result in a failed change if there is a minimum time\nrequirement between password changes, invalid password length, or invalid character.\n\nGraphQL endpo" }, { "info": { "name": "Invokes the forgot password reset for a specific account.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/account/password/reset", "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: accountPasswordForgot" } ] }, { "info": { "name": "apisMessage", "type": "folder" }, "items": [ { "info": { "name": "Takes the ApisMessage Request and sends it to core to queue a new message.\nReturns 201 in the response if message successfully queued and a message with Verified and Infant Counts,\nand 400 if errors occur (And failure text (if any) will be returned).", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/apisMessage", "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: apisMessageQueue" } ] }, { "info": { "name": "apo", "type": "folder" }, "items": [ { "info": { "name": "Gets the current saved ancillary pricing options data.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/apo" }, "docs": "GraphQL endpoint: apo" }, { "info": { "name": "Adds new entries to the saved ancillary pricing options data.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/apo", "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: apoAddv2" }, { "info": { "name": "Adds new or updates existing ancillary pricing options data.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/apo", "body": { "type": "json", "data": "{}" } }, "docs": "Adds new or updates existing ancillary pricing options data." }, { "info": { "name": "Deletes all of the saved ancillary pricing options data.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/apo" }, "docs": "GraphQL endpoint: apoDeleteAll" }, { "info": { "name": "Updates an individual saved ancillary pricing option's data.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/apo/:inputParameterKey", "params": [ { "name": "inputParameterKey", "value": "", "type": "path", "description": "The input parameter key to update." }, { "name": "inputParameterValue", "value": "", "type": "query", "description": "The input parameter value to update." } ] }, "docs": "This will replace the current saved ancillary pricing option's value with the\ngiven input parameter value, based on the input parameter key.\n\nGraphQL endpoint: apoSet" }, { "info": { "name": "Deletes a single saved ancillary pricing option's data.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/apo/:inputParameterKey", "params": [ { "name": "inputParameterKey", "value": "", "type": "path", "description": "The input parameter key to delete." } ] }, "docs": "GraphQL endpoint: apoDelete" } ] }, { "info": { "name": "availability", "type": "folder" }, "items": [ { "info": { "name": "Searches for low fare availability with the full low fare search request. This request allows for total control\nover the configuration. If a property is not set, the default settings (LowFareAvailabilitySettings) are used in\nits place. Note low fare will not always match availability requests for certain configurations including sorting\nby taxes and fees.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v3/availability/lowfare", "body": { "type": "json", "data": "{}" } }, "docs": "Although this endpoint behaves like a GET, POST reduces the limitations resulting from URL length issues.\nWhen LowFareAvailabilityRequest.GetAllDetails is set to true, New Skies sets the passenger count in the request\nto zero. This means that passenger count restrictions on a fare are not considered and that any available fare\nis returned.\n\nGraphQL endpoint: availabilityLowFarev3" }, { "info": { "name": "Retrieves the low fare availability estimate using a range of dates.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/availability/lowfare/estimate", "params": [ { "name": "StartDate", "value": "", "type": "query", "description": "The start date to retrieve from the low fare cache.\n " }, { "name": "EndDate", "value": "", "type": "query", "description": "The end date for the low fare cache request.\n " }, { "name": "Origin", "value": "", "type": "query", "description": "The origin station code.\n " }, { "name": "Destination", "value": "", "type": "query", "description": "The destination station code.\n " }, { "name": "CurrencyCode", "value": "", "type": "query", "description": "The currency code.\n " }, { "name": "IncludeTaxesAndFees", "value": "", "type": "query", "description": "A flag to indicate if taxes and fees should be included.\n " }, { "name": "NumberOfPassengers", "value": "", "type": "query", "description": "The number of passengers\n " } ] }, "docs": "This endpoint, unless otherwise specified, will request the pricing and availability for a single adult passenger.\nHowever, the number of passengers can be set on the\nrequest. It is important to note that the pricing on this endpoint is estimated. It will not match availability\ndue to round trip vs one way discounts, taxes and fees\nvariations, multi passenger discounts, recently sold out fares, etc. It's intended to be an estimate only. Due to\nthese restrictions this endpoint is extremely\npe" }, { "info": { "name": "Searches for low fare availability with the simple search request. The simple search request covers the common\nsearch\ncriteria and lets default settings (LowFareAvailabilitySettings) configure the rest. Note low fare will not always\nmatch availability requests for certain configurations included sorting by taxes and fees.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v3/availability/lowfare/simple", "body": { "type": "json", "data": "{}" } }, "docs": "Although this endpoint behaves like a GET, POST reduces the limitations resulting from URL length issues.\n\nGraphQL endpoint: availabilityLowFareSimplev3" }, { "info": { "name": "Searches for availability with the full availability search request. This request allows for total control over\nthe configuration. If a property is not set, default values will be set instead. These defaults are what we\nconsider a general optimized request. If these optimizations are not preferred the requester will need to\nopted out the filters on the availability request.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v4/availability/search", "body": { "type": "json", "data": "{}" } }, "docs": "Note: It is advised to optimize the availability request with passing in at least one or more (ProductClass,\nTravelClass, FareTypes or ClassesOfService) so the response can be optimized as possible. This is even more\nrecommended for mobile applications due to the nature of limited network capabilities.\nThe default values that will be set unless specified:\n- TaxesAndFees = TaxesAndFeesRollupMode.None\n- Criteria.SsrCollectionsMode = AvailabilitySsrCollectionsMode.None\n- Criteria.Filters.FareInclus" }, { "info": { "name": "Searches for availability with the simple availability search request. This request allows for easy setup for one\nway and round trip searches. If a property is not set, default values will be set instead just like they would in\nthe full availability request. These defaults are what we consider a general optimized request. If these\noptimizations are not preferred the requester will need to opted out the filters on the availability simple\nrequest.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v4/availability/search/simple", "body": { "type": "json", "data": "{}" } }, "docs": "Note: It is advised to optimize the availability request with passing in at least one or more (ProductClass,\nTravelClass, FareTypes or ClassesOfService) so the response can be optimized as possible. This is even more\nrecommended for mobile applications due to the nature of limited network capabilities.\nThe default values that will be set unless specified:\n- TaxesAndFees = TaxesAndFeesRollupMode.None\n- SsrCollectionsMode = AvailabilitySsrCollectionsMode.None\n- Filters.FareInclusionType = Availabi" }, { "info": { "name": "Searches for availability with SSR prices with the full availability search request. This request allows for total\ncontrol over the configuration. If a property is not set, default values will be set instead. These defaults are\nwhat we consider a general optimized request. If these optimizations are not preferred the requester will need to\nopt out of the filters on the availability request.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/availability/search/ssr", "body": { "type": "json", "data": "{}" } }, "docs": "Note: This is an expensive call and should be used with appropriate cautions.\nIt is advised to optimize the availability request with passing in at least one or more (ProductClass,\nTravelClass, FareTypes or ClassesOfService) so the response can be optimized as possible. This is even more\nrecommended for mobile applications due to the nature of limited network capabilities.\nThe default values that will be set unless specified:\n- AvailabilityWithSsrRequest.TaxesAndFees = TaxesAndFeesRollupMode.Non" } ] }, { "info": { "name": "baggage", "type": "folder" }, "items": [ { "info": { "name": "Adds baggage to a booking stateless.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/dcs/v1/baggage", "body": { "type": "json", "data": "{}" } }, "docs": "Agent only. Requires the booking to be committed.\nIf you have the booking in state you will need to re-retrieve it to see the added baggage.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: baggageAdd" }, { "info": { "name": "Sets the 'Removed' status for a bag for a booking stateless.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/dcs/v1/baggage", "body": { "type": "json", "data": "{}" } }, "docs": "Agent only. Requires the booking to be committed.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: baggageRemove" }, { "info": { "name": "Adds baggage to a booking stateless.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/dcs/v2/baggage", "body": { "type": "json", "data": "{}" } }, "docs": "Agent only. Requires the booking to be committed.\nIf you have the booking in state you will need to re-retrieve it to see the added baggage.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: baggageAddv2" }, { "info": { "name": "Sets the 'Removed' status for a bag for a booking stateless, by leg key.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/dcs/v1/baggage/byLegKey", "body": { "type": "json", "data": "{}" } }, "docs": "Agent only. Requires the booking to be committed.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\nAll downline legs and segments will have the bag status marked as `Removed` as well.\nIf you want to remove the bag for a whole journey, just pass in the first leg key.\n\nGraphQL endpoint: baggageRemoveByLegKey" }, { "info": { "name": "Performs an update and checks-in an individual baggage item for a specific passenger.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/dcs/v1/baggage/checkIn", "body": { "type": "json", "data": "{}" } }, "docs": "If the journey key is set on the request, the request will process all segments associated with the journey,\nand will ignore the segment key value.\nThe baggage type code can only be updated if the baggage weight is changed as well, and if the baggage type code is\na valid, active baggage type in the current environment.\nPlease note, this call does NOT sync with the booking baggage allowances and usages.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avo" }, { "info": { "name": "Performs an update and checks-in an individual baggage item for a specific passenger.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/dcs/v2/baggage/checkIn", "body": { "type": "json", "data": "{}" } }, "docs": "If the journey key is set on the request, the request will process all segments associated with the journey,\nand will ignore the segment key value.\nThe baggage type code can only be updated if the baggage weight is changed as well, and if the baggage type code is\na valid, active baggage type in the current environment.\nPlease note, this call does NOT sync with the booking baggage allowances and usages.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avo" } ] }, { "info": { "name": "bagTag", "type": "folder" }, "items": [ { "info": { "name": "Gets the bag tag printers.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/dcs/v1/bagTag/printers" }, "docs": "This information is retrieved based on the logged in user's location. If a location is not set up,\nthe returned information will be the default printers configured in printers.xml from UTL\\Resource Management.\n\nGraphQL endpoint: bagTagPrinters" } ] }, { "info": { "name": "boarding", "type": "folder" }, "items": [ { "info": { "name": "Boards a passenger on a specific leg. If the leg is NOT a part of a change of gauge flight, it is\nrecommended to board by segment instead.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/dcs/v2/boarding/:recordLocator/legs/:legKey/passengers/:passengerKey", "params": [ { "name": "recordLocator", "value": "", "type": "path", "description": "The record locator for the booking." }, { "name": "legKey", "value": "", "type": "path", "description": "The leg key to board." }, { "name": "passengerKey", "value": "", "type": "path", "description": "The passenger key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "If there are downstream legs that are not boarded on the segment and the flight\nis not a change of gauge, the rest of the legs will be boarded as well. For example,\nif you have a three leg segment and you board the middle leg, the last leg will also\nbe boarded and the first leg will not be boarded.\nThis endpoint will return information like a GET because there may be necessary\nsecurity information on the response.\nTo check the lift status of the boarded leg, please use\n/api/nsk/manifest/{legKey}" }, { "info": { "name": "Unboards a passenger on a specific leg.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/dcs/v1/boarding/:recordLocator/legs/:legKey/passengers/:passengerKey", "params": [ { "name": "recordLocator", "value": "", "type": "path", "description": "The record locator for the booking." }, { "name": "legKey", "value": "", "type": "path", "description": "The leg key to board." }, { "name": "passengerKey", "value": "", "type": "path", "description": "The passenger key." } ] }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: unboardByLeg" }, { "info": { "name": "Boards a passenger on a specific segment. A segment should not be boarded if it is a change of\ngauge flight.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/dcs/v2/boarding/:recordLocator/segments/:segmentKey/passengers/:passengerKey", "params": [ { "name": "recordLocator", "value": "", "type": "path", "description": "The record locator for the booking." }, { "name": "segmentKey", "value": "", "type": "path", "description": "The segment key to board." }, { "name": "passengerKey", "value": "", "type": "path", "description": "The passenger key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "If an attempt at boarding a segment is made with a change of gauge flight, only the first leg of\nthat segment will be boarded. The endpoint will return that the process was successful,\nbut the full segment with legs was not boarded. This can be checked using the endpoint listed below.\nThis endpoint will return information like a GET because there may be necessary\nsecurity information on the response.\nTo check the lift status of the boarded segment please use\n/api/nsk/v1/bookings/checkin/{recordL" }, { "info": { "name": "Unboards all passengers on a leg.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/dcs/v1/boarding/legs/:legKey/passengers", "params": [ { "name": "legKey", "value": "", "type": "path", "description": "The leg key." } ] }, "docs": "If a warning message is present, check the lift status of the passengers. A passenger will come back as not\nbeing unboarded if they are not checked in and boarded.\n\nGraphQL endpoint: unboardAllPassengers" }, { "info": { "name": "Boards all passengers on a specific leg.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/dcs/v2/boarding/legs/:legKey/passengers", "params": [ { "name": "legKey", "value": "", "type": "path", "description": "The leg key to board." } ] }, "docs": "If there are downstream legs that are not boarded on the segment and the flight\nis not a change of gauge, the rest of the legs will be boarded as well. For example,\nif you have a three leg segment and you board the middle leg, the last leg will also\nbe boarded and the first leg will not be boarded. If the flight is a change of gauge,\nthen only the leg requested will be boarded.\nTo check the lift status of the boarded leg, please use\n/api/nsk/manifest/bookings/{recordLocator}/legs/{legKey}.\n\nGrap" } ] }, { "info": { "name": "booking", "type": "folder" }, "items": [ { "info": { "name": "Get the current booking in state.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking" }, "docs": "Note: To add a booking comment please use\napi/nsk/v3/booking.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: booking" }, { "info": { "name": "Commits stateful changes made and processes the booking.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v3/booking", "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\nThis endpoint can be configured to allow for the newly created record locator to be returned in the response.\nThis is\nan API value that needs to be set in configuration, NskSystemOptions.ReturnPnrOnv3BookingPost = true.\nDefault behavior is to not return the new record locator. This will require a SNOW ticket to change.\n\nGraphQL endpoint: bookingCommitv3" }, { "info": { "name": "Commits stateful changes made and processes the booking.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v3/booking", "params": [ { "name": "allowConcurrentChanges", "value": "", "type": "query", "description": "Flag to allow concurrent booking changes between multiple sessions." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Only archived bookings can use the `Archive` comment type. If the booking in state is archived, only\nthe comments will be acknowledged by New Skies. All other filled in fields in the request will be ignored.\nIf AllowConcurrentChanges is set to true, a merge between concurrent changes between multiple sessions will be\nperformed before committing the booking. New Skies refers to this as MergeAndCommit2. We recommend only\nsetting this flag to true for cases where concurrent booking changes are high" }, { "info": { "name": "Gets the baggage allowances for the current booking in state.\nBaggage usage details will only be returned if includeUsageDetails\nis flagged true AND the allowance behavior is NOT Default.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/baggageAllowances", "params": [ { "name": "includeUsageDetails", "value": "", "type": "query", "description": "If true, the baggage allowance usage details will be populated in the response.\nIncluding these details adds processing overhead, so set this only when absolutely necessary.\nDefaults to `false`, not include usage details.\n " } ] }, "docs": "GraphQL endpoint: baggageAllowances" }, { "info": { "name": "Gets the third-party baggage allowance calculations for the current booking in state.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/baggageAllowances/external", "body": { "type": "json", "data": "{}" } }, "docs": "Although this endpoint behaves like a GET, POST reduces the limitations resulting from URL length issues.\n\nGraphQL endpoint: baggageAllowancesExternal" }, { "info": { "name": "Retrieves the bundle and ssr availability for the booking in-state.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/bundle/availability", "body": { "type": "json", "data": "{}" } }, "docs": "Although this endpoint behaves like a GET, POST reduces the limitations resulting from URL length issues.\n\nGraphQL endpoint: bookingBundleAvailability" }, { "info": { "name": "Gets the list of comments on the in-state booking.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/comments" }, "docs": "Gets the list of comments on the in-state booking." }, { "info": { "name": "Deletes a comment from the booking.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/comments/:commentKey", "params": [ { "name": "commentKey", "value": "", "type": "path", "description": "The booking comment key." } ] }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: bookingCommentsDeletev2" }, { "info": { "name": "Divides the current booking.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/divide", "body": { "type": "json", "data": "{}" } }, "docs": "A valid user must be logged in to divide a booking.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: bookingDividev2" }, { "info": { "name": "Retrieves equipment information for a specified leg.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/equipment/legs/:legKey", "params": [ { "name": "legKey", "value": "", "type": "path", "description": "The leg key." } ] }, "docs": "GraphQL endpoint: legEquipmentv2" }, { "info": { "name": "Retrieves equipment, supported seat property and seat-dependent SSR information for a specified leg.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/equipment/legs/:legKey/properties", "params": [ { "name": "legKey", "value": "", "type": "path", "description": "The leg key." } ] }, "docs": "GraphQL endpoint: legEquipmentPropertiesv2" }, { "info": { "name": "Retrieves equipment information for all legs on a specified segment.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/equipment/segments/:segmentKey", "params": [ { "name": "segmentKey", "value": "", "type": "path", "description": "The segment key." } ] }, "docs": "GraphQL endpoint: segmentEquipmentv2" }, { "info": { "name": "Retrieves equipment, supported seat property and seat-dependent SSR information for all legs on a specified\nsegment.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/equipment/segments/:segmentKey/properties", "params": [ { "name": "segmentKey", "value": "", "type": "path", "description": "The segment key." } ] }, "docs": "GraphQL endpoint: segmentEquipmentPropertiesv2" }, { "info": { "name": "BETA - Issues new e-tickets and re-issues existing e-tickets for segments with voluntary changes.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/eTickets" }, "docs": "The endpoint performs validation and determines internally if the booking is for issuance of new e-tickets or\nre-issuance of existing e-tickets.\nFor some cases that the re-issuance is not allowed by the ticketing service, a `502 BadGateway` will be returned\nand new e-tickets can be issued using the POST `api/nsk/v1/booking/eTickets/forceIssue` endpoint.\n\nGraphQL endpoint: eTicketAddv2" }, { "info": { "name": "BETA - Re-issues existing e-tickets for segments with involuntary changes such as schedule change and IROP.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/eTickets" }, "docs": "For some cases that the re-issuance is not allowed by the ticketing service, a `502 BadGateway` will be returned\nand new e-tickets can be issued using the POST `api/nsk/v1/booking/eTickets/forceIssue` endpoint.\n\nGraphQL endpoint: eTicketSetv2" }, { "info": { "name": "Issues new e-tickets and re-issues existing e-tickets for segments with voluntary changes.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/eTickets" }, "docs": "The endpoint performs validation and determines internally if the booking is for issuance of new e-tickets or\nre-issuance of existing e-tickets.\nFor some cases that the re-issuance is not allowed by the ticketing service, new e-tickets are issued instead.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: eTicketAdd" }, { "info": { "name": "Re-issues existing e-tickets for segments with involuntary changes such as schedule change and IROP.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/eTickets" }, "docs": "For some cases that the re-issuance is not allowed by the ticketing service, new e-tickets are issued instead.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: eTicketSet" }, { "info": { "name": "BETA - Forces issuance of new e-tickets when re-issuance is not allowed by the ticketing service.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/eTickets/forceIssue" }, "docs": "This is a beta endpoint and is not currently a long term supported endpoint. This endpoint may be removed in\nfuture updates. Beta endpoints are not available in all labs or for all customers of the API.\nThis endpoint is intended to be used only if the POST or PUT e-tickets endpoints return an error with code\n`nsk:ETickets:IssuanceOfNewETicketsRequired`. Tickets are accountable documents and need to be available for\ncheck-in, refund or exchange. Using this endpoint other than the said use case wo" }, { "info": { "name": "Checks if the booking in state is valid for e-ticketing operations.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/eTickets/validation" }, "docs": "GraphQL endpoint: eTicketBookingValidation" }, { "info": { "name": "Replaces an existing fare price with an amount specified.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/fareOverride/journey/:journeyKey", "params": [ { "name": "journeyKey", "value": "", "type": "path", "description": "The journey key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: fareOverrideAdd" }, { "info": { "name": "Retrieves the collection of all fare rules from the current booking in state.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/fareRules", "params": [ { "name": "convertToHtml", "value": "", "type": "query", "description": "Whether to convert to html. Defaults to true." } ] }, "docs": "Note that this defaults to returning the fare rules in html format. The html format may not be entirely culture\nsensitive, so setting the convertToHtml flag to false will allow users some flexibility when converting the\ncontent and the fare rules will be returned as an rtf string.\n\nGraphQL endpoint: fareRulesv3" }, { "info": { "name": "Get the category 50 fare rule information for a specific segment on a booking.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/fareRules/category50/journeys/:journeyKey/segments/:segmentKey", "params": [ { "name": "journeyKey", "value": "", "type": "path", "description": "The journey key." }, { "name": "segmentKey", "value": "", "type": "path", "description": "The segment key." }, { "name": "cultureCode", "value": "", "type": "query", "description": "the culture code." }, { "name": "convertToHtml", "value": "", "type": "query", "description": "If true, converts the response's Text value from RTF to HTML. Defaults to true." } ] }, "docs": "This is functionally a GET but POST is used to reduce URL length overhead.\n\nGraphQL endpoint: bookingCategory50FareRuleInfov3" }, { "info": { "name": "Retrieves a fare rule from the current booking in state based on\nthe specific fare key.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/fareRules/fare/:fareKey", "params": [ { "name": "fareKey", "value": "", "type": "path", "description": "The unique fare key." }, { "name": "convertToHtml", "value": "", "type": "query", "description": "Whether to convert to html. Defaults to true." } ] }, "docs": "Note that this defaults to returning the fare rules in html format. The html format may not be entirely culture\nsensitive, so setting the convertToHtml flag to false will allow users some flexibility when converting the\ncontent and the fare rules will be returned as an rtf string.\n\nGraphQL endpoint: fareRulesByKeyv2" }, { "info": { "name": "Retrieves the collection of all fare rules from the current booking in state\nfor the specific journey key.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/fareRules/journey/:journeyKey", "params": [ { "name": "journeyKey", "value": "", "type": "path", "description": "The unique journey key." }, { "name": "convertToHtml", "value": "", "type": "query", "description": "Whether to convert to html. Defaults to true." } ] }, "docs": "Note that this defaults to returning the fare rules in html format. The html format may not be entirely culture\nsensitive, so setting the convertToHtml flag to false will allow users some flexibility when converting the\ncontent and the fare rules will be returned as an rtf string.\n\nGraphQL endpoint: fareRulesByJourneyv3" }, { "info": { "name": "Retrieves the collection of all fare rules from the current booking in state for the specific segment key.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/fareRules/segment/:segmentKey", "params": [ { "name": "segmentKey", "value": "", "type": "path", "description": "The unique segment key." }, { "name": "convertToHtml", "value": "", "type": "query", "description": "Whether to convert to html. Defaults to true." } ] }, "docs": "Note that this defaults to returning the fare rules in html format. The html format may not be entirely culture\nsensitive, so setting the convertToHtml flag to false will allow users some flexibility when converting the\ncontent and the fare rules will be returned as an rtf string.\n\nGraphQL endpoint: fareRulesBySegmentv3" }, { "info": { "name": "Gets the fee price.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/fee", "params": [ { "name": "PassengerKey", "value": "", "type": "query", "description": "The passenger key.\n " }, { "name": "Origin", "value": "", "type": "query", "description": "The origin station code.\n " }, { "name": "CollectedCurrencyCode", "value": "", "type": "query", "description": "The collected currency code.\n " }, { "name": "FeeCode", "value": "", "type": "query", "description": "The fee code.\n " }, { "name": "FeePricingMode", "value": "", "type": "query", "description": "Determines if fees are to be paid in points or with currency.\n \nEnumeration values: 0 = MonetaryOnly, 1 = PointsOnly" } ] }, "docs": "Only service and penalty fee types support a price that is configured by the booking in state.\nDepending on the configuration, the passenger key will be needed.\nFor other fee types the price amount is manually provided.\n\nGraphQL endpoint: fee" }, { "info": { "name": "Manually adds a new fee.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/fee", "body": { "type": "json", "data": "{}" } }, "docs": "Penalty fees, spoilage fees, and service fees can be created manually. Other types are automatically created by\nthe system.\nDepending on the configuration, the passenger key will be needed.\nIf a passenger key was added to the request, the API will attempt to provide a location header url to point to the\nnewly created fee using the passenger key and the passenger fee key from the new fee. However, depending on the\nfee type, this url may not always be valid. Spoilage fees for example are applied" }, { "info": { "name": "Overrides a fee amount.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/fee/:feeKey", "params": [ { "name": "feeKey", "value": "", "type": "path", "description": "The fee key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "When the fee override amount is zero, New Skies keeps or removes passenger fees with respect to the Store\nConfirming Waived Fees system setting.\nThis endpoint returns a HTTP 200 on either case. Please retrieve the state booking afterwards to verify the absence\nor presence of the overridden fee.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: feeSet" }, { "info": { "name": "Deletes a fee.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/fee/:feeKey", "params": [ { "name": "feeKey", "value": "", "type": "path", "description": "The fee key request." } ] }, "docs": "If a fee is deleted during the same commit in which it was added, then the fee will not be present on the booking\n-- It is truly deleted\nIf a fee is waived after it has been committed to a booking, then the fee will still be present, along with a \"FEE\nOR\" fee indicating the override is 0.\nThis behavior can be changed by checking the \"Store Confirming Waived Fees\" box in the Booking Settings dialog in\nutilities (SYS Users Only). If this box\nis checked, then all fees will behave in the second man" }, { "info": { "name": "Overrides multiple fee amounts.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/fees", "body": { "type": "json", "data": "{}" } }, "docs": "When the fee override amount is zero, New Skies keeps or removes passenger fees with respect to the Store\nConfirming Waived Fees system setting.\nThis endpoint returns a HTTP 200 on either case. Please retrieve the state booking afterwards to verify the absence\nor presence of the overridden fees.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: feeSetMultiple" }, { "info": { "name": "Gets the override fee quote of an existing fee.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/fees/:feeKey/quote", "params": [ { "name": "feeKey", "value": "", "type": "path", "description": "The fee key of an existing fee." }, { "name": "Amount", "value": "", "type": "query", "description": "The override amount.\n " }, { "name": "CollectedCurrencyCode", "value": "", "type": "query", "description": "The collected currency code.\n " } ] }, "docs": "GraphQL endpoint: overrideExistingFeeQuote" }, { "info": { "name": "Waives the penalty fee of all journeys in the booking.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/fees/penalty" }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: bookingPenaltyFeeDelete" }, { "info": { "name": "Waives the spoilage fee of all journeys in the booking.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/fees/spoilage" }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: bookingSpoilageFeeDelete" }, { "info": { "name": "Changes the group name of the booking in state.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/groupName", "params": [ { "name": "groupName", "value": "", "type": "query", "description": "The booking group name." } ] }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: groupNameSet" }, { "info": { "name": "Deletes the group name of the booking in state.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/groupName" }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: groupNameDelete" }, { "info": { "name": "Changes the group name of the booking in state.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/groupName", "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: groupNameSetv2" }, { "info": { "name": "Retrieves the recommended hold date if hold is available.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/hold/available" }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: bookingHoldv2" }, { "info": { "name": "Returns true if it is expected to prompt the user for India GST registration details.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/indiaGstRegistrationRequirement" }, "docs": "GraphQL endpoint: indiaGstRegistrationRequirement" }, { "info": { "name": "Gets the details of the current booking in state.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/info" }, "docs": "This endpoint returns the same booking information in the GET /api/nsk/v1/booking endpoint,\nbut with the addition of the eligibility of the booking for external baggage display.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: bookingInfo" }, { "info": { "name": "Sends the booking itinerary notification to the specified printer.\nAutomatically commits uncommitted changes to the state booking before queuing the booking to a print notification\nqueue.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/itinerary/print", "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: bookingItineraryPrint" }, { "info": { "name": "Gets the booking penalty from the booking in state.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/penalties" }, "docs": "GraphQL endpoint: bookingPenalties" }, { "info": { "name": "Waives the penalty fees of the specified cancelled journey.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/penalties/:cancelledJourneyKey", "params": [ { "name": "cancelledJourneyKey", "value": "", "type": "path", "description": "The journey key of the cancelled journey." } ] }, "docs": "If the journey key specified is for a non-cancelled journey, i.e. the journey exists in the booking in state,\nan exception will be thrown.\nTo waive the penalty fee of a journey in the booking in state, please use\n/api/nsk/v1/booking/journeys/{journeyKey}/fees/penalty instead.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: bookingPenaltiesDeleteByKey" }, { "info": { "name": "Updates the booking point of sale.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/pointOfSale", "body": { "type": "json", "data": "{}" } }, "docs": "The ISO country code cannot be updated for a committed booking. This value can only be\nupdated on an uncommitted booking.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: bookingPointOfSaleSet" }, { "info": { "name": "Updates the booking point of sale.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/pointOfSale", "body": { "type": "json", "data": "{}" } }, "docs": "The ISO country code cannot be updated for a committed booking. This value can only be\nupdated on an uncommitted booking.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: bookingPointOfSaleModify" }, { "info": { "name": "Creates a new prepaid external payment on the booking in state.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/prepaidExternal", "params": [ { "name": "prepaidApprovalCode", "value": "", "type": "query", "description": "The prepaid approval code. This maps to a payment field with PrepaidApprovalCode as the system field type\n(configured in Utilities - Payment Types).\n " } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint requires agent permissions.\nThe payment fields are dynamic to the criteria of your payment provider. Here is an example request for a\ncredit card payment that does not require address, zip, etc.\n{ \"amount\": 10, \"currencyCode\": \"USD\", \"paymentFields\": {\"ACCTNO\":\"411111111111\", \"EXPDATE\":\"10/8/2017\",\n\"CC::AccountHolderName\":\"Bob Smith\", \"CC::VerificationCode\":\"111\"}}\n`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems" }, { "info": { "name": "Applies fares, discounts and taxes to the booking in state.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/price", "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: priceSet" }, { "info": { "name": "Validates the fare prices on the booking in state.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/price/validation" }, "docs": "This endpoint is only recommended to be used with Fare Manager Plus and CAT1 validation is not fully supported in this endpoint outside of 4.5.2.\n\nGraphQL endpoint: priceValidate" }, { "info": { "name": "Sets a promotion code to a booking in state.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/promotion", "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: bookingPromotionCodeSet" }, { "info": { "name": "Updates a promotion code to a booking in state.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/promotion", "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: bookingPromotionCodeSet" }, { "info": { "name": "Deletes the promotion code on the booking in state.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/promotion" }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: bookingPromotionCodeDelete" }, { "info": { "name": "Adds the booking from state to a booking queue.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v3/booking/queue", "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: bookingEnqueuev3" }, { "info": { "name": "Adds the booking from state to a booking queue.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/queue", "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: bookingEnqueuev2" }, { "info": { "name": "Removes the booking in state from a booking queue.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/queue", "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: bookingDequeuev2" }, { "info": { "name": "Removes the booking in state from the specified booking queue item.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/queues/:bookingQueueKey", "params": [ { "name": "bookingQueueKey", "value": "", "type": "path", "description": "The unique key of the booking queue to dequeue from." } ], "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: bookingDequeueByKey" }, { "info": { "name": "Gets all of the record locators on the in-state booking.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/recordLocators" }, "docs": "GraphQL endpoint: recordLocators" }, { "info": { "name": "Adds a third party record locator to the booking.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/recordLocators", "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: recordLocatorsAdd" }, { "info": { "name": "Deletes all record locators from the booking.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/recordLocators" }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: recordLocatorsDelete" }, { "info": { "name": "Gets the record locator associated with the record locator key for\nthe in-state booking.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/recordLocators/:recordLocatorKey", "params": [ { "name": "recordLocatorKey", "value": "", "type": "path", "description": "The record locator key to retrieve." } ] }, "docs": "GraphQL endpoint: recordLocator" }, { "info": { "name": "Replaces the data of a third party record locator on the booking.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/recordLocators/:recordLocatorKey", "params": [ { "name": "recordLocatorKey", "value": "", "type": "path", "description": "The record locator key to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: recordLocatorsSet" }, { "info": { "name": "Patches the data of a third party record locator on the booking.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/recordLocators/:recordLocatorKey", "params": [ { "name": "recordLocatorKey", "value": "", "type": "path", "description": "The record locator key to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: recordLocatorsModify" }, { "info": { "name": "Deletes a record locator from the booking.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/recordLocators/:recordLocatorKey", "params": [ { "name": "recordLocatorKey", "value": "", "type": "path", "description": "The record locator key." } ] }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: recordLocatorDelete" }, { "info": { "name": "Reinstates a booking with a status of hold canceled.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/reinstate" }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: bookingReinstate" }, { "info": { "name": "Clears the current booking state.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/reset" }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: bookingReset" }, { "info": { "name": "Overrides the effective sales channel for the booking in state.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/salesChannel", "params": [ { "name": "channelType", "value": "", "type": "query", "description": "The sales channel type to override to. \nEnumeration values: 0 = Direct, 1 = Web, 2 = Api, 3 = DigitalApi, 4 = DigitalWeb, 5 = Ndc" } ] }, "docs": "For the overriden channel to be implemented, the booking in state must be committed after calling this endpoint.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: salesChannelSet" }, { "info": { "name": "Gets the status of the booking commit and returns the booking.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/status" }, "docs": "There are certain booking data that are not saved to state, such as payment\nattachments. This endpoint will return the booking data so that non persisted\ninformation is returned when and only when the status code is 200. This is the\nonly time the data will be available.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: bookingCommitStatusv2" }, { "info": { "name": "Updates the system code of the state booking.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/systemCode", "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: bookingSystemCodeSet" }, { "info": { "name": "Removes the system code of the state booking.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/systemCode" }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: bookingSystemCodeDelete" }, { "info": { "name": "Evaluates the booking in state prior to commit or payment processing.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/validation" }, "docs": "The response indicates the forecasted status that will be applied to the booking during commit and if a held\nseat warning should be issued.\n\nGraphQL endpoint: bookingValidation" }, { "info": { "name": "Adds a new verified travel document to a passenger or the associated infant.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/verifiedTravelDocuments/segments/:segmentKey/passengers/:passengerKey", "params": [ { "name": "segmentKey", "value": "", "type": "path", "description": "The target segment key." }, { "name": "passengerKey", "value": "", "type": "path", "description": "The target passenger key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\nThe following items are required to use this endpoint.\nAgent permissions.\nGovernment Security Drivers need to be enabled under government security configurations.\nGovernment Security Drivers need to be configured to approve the given document type.\nThe given document must be a document type approved by customs.\nThe target passenger must be either CheckedIn or Boarded on the ta" } ] }, { "info": { "name": "booking/addons", "type": "folder" }, "items": [ { "info": { "name": "Gets a specific add-on's allowed payment methods.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/addons/:addOnKey/payments", "params": [ { "name": "addOnKey", "value": "", "type": "path", "description": "The unique add on key." } ] }, "docs": "If the add on's payment required flag is set to true, this endpoint\nwill return the allowed payment options for the add on. If set to\nfalse, null will be returned.\n\nGraphQL endpoint: addOnPaymentAllowed" }, { "info": { "name": "Adds a payment to a specific add-on on the booking.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/addons/:addOnKey/payments", "params": [ { "name": "addOnKey", "value": "", "type": "path", "description": "The unique add on key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: addOnPaymentAdd" }, { "info": { "name": "Gets all the available add-ons allowed payment methods for all the add-ons on the booking in state.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/addons/payments" }, "docs": "GraphQL endpoint: addOnPayment" }, { "info": { "name": "Syncs the prices of the Travel Commerce addons.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/addons/sync" }, "docs": "This endpoint should be called prior to displaying the total booking cost and collecting\npayment for Travel Commerce items. It will trigger New Skies to query Travel Commerce for\nthe items in the cart.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: addOnSyncPriceSet" } ] }, { "info": { "name": "booking/boardingpasses", "type": "folder" }, "items": [ { "info": { "name": "Retrieves the version of the boarding passes based on a specific journey.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v3/booking/boardingpasses/journey/:journeyKey", "params": [ { "name": "journeyKey", "value": "", "type": "path", "description": "The journey to retrieve boarding passes for." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: boardingPassByJourneyv3" }, { "info": { "name": "Retrieves the specific journeys boarding passes using the M2D barcode type. This endpoint will only give a single\nbarcode back even if the journey contains multiple segments. Note that if the journey has only one segment the M2D\nbarcode will look just like the S2D barcode.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/boardingpasses/m2d/journey/:journeyKey", "params": [ { "name": "journeyKey", "value": "", "type": "path", "description": "The specific journey to get boarding passes for." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: boardingPassByJourneyForPassengerM2D" }, { "info": { "name": "Retrieves the specific journeys boarding passes for each segment using the S2D barcode type. This endpoint will\nprovide a single barcode for each segment.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/boardingpasses/s2d/journey/:journeyKey", "params": [ { "name": "journeyKey", "value": "", "type": "path", "description": "The specific journey to get boarding passes for." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: boardingPassByJourneyForPassengerS2D" }, { "info": { "name": "Retrieves the version of the boarding passes based on a specific segment.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v3/booking/boardingpasses/segment/:segmentKey", "params": [ { "name": "segmentKey", "value": "", "type": "path", "description": "The segment to retrieve boarding passes for." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: boardingPassBySegmentv3" } ] }, { "info": { "name": "booking/checkin", "type": "folder" }, "items": [ { "info": { "name": "Removes the checkin status of passengers for a specific journey in state.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/checkin/journey/:journeyKey", "params": [ { "name": "journeyKey", "value": "", "type": "path", "description": "The journey key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: checkinByJourneyDelete" }, { "info": { "name": "Checks in a collection of passengers to a specific journey in state.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v3/booking/checkin/journey/:journeyKey", "params": [ { "name": "journeyKey", "value": "", "type": "path", "description": "The journey key of the segments to checkin." } ], "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n- When debug mode is disabled, warning and error messages will be masked if the `SystemOptions.HideErrorMessages`\nis set to true.\n- When debug mode is disabled, warning and error messages will be returned to agents only if the\n`SystemOptions.HideErrorMessages` is set to false.\n\nGraphQL endpoint: checkinByJourneyAddv3" }, { "info": { "name": "Gets the checkin pre-validation requirements for a specific journey.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/checkin/journey/:journeyKey/requirements", "params": [ { "name": "journeyKey", "value": "", "type": "path", "description": "The journey key to be pre validate checkin with." } ] }, "docs": "GraphQL endpoint: checkinByJourneyRequirementsv2" }, { "info": { "name": "Gets the checkin pre-validation requirements for a specific journey.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/checkin/journey/:journeyKey/requirements", "params": [ { "name": "journeyKey", "value": "", "type": "path", "description": "The journey key to be pre validate checkin with." } ] }, "docs": "GraphQL endpoint: checkinByJourneyRequirements" }, { "info": { "name": "Gets the passengers lift status for a specific journey based on the booking in state.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/checkin/journey/:journeyKey/status", "params": [ { "name": "journeyKey", "value": "", "type": "path", "description": "The journey to check lift statuses." } ] }, "docs": "GraphQL endpoint: checkinByJourneyStatus" }, { "info": { "name": "Removes the checkin status of passengers for a specific journey's segment in state.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/checkin/segment/:segmentKey", "params": [ { "name": "segmentKey", "value": "", "type": "path", "description": "The segment key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: checkinBySegmentDelete" }, { "info": { "name": "Checks in a collection of passengers to a specific journey's segment in state.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v3/booking/checkin/segment/:segmentKey", "params": [ { "name": "segmentKey", "value": "", "type": "path", "description": "The segment key of the segment to checkin." } ], "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n- When debug mode is disabled, warning and error messages will be masked if the `SystemOptions.HideErrorMessages`\nis set to true.\n- When debug mode is disabled, warning and error messages will be returned to agents only if the\n`SystemOptions.HideErrorMessages` is set to false.\n\nGraphQL endpoint: checkinBySegmentAddv3" }, { "info": { "name": "Gets the checkin pre-validation requirements for a specific journey's segment.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/checkin/segment/:segmentKey/requirements", "params": [ { "name": "segmentKey", "value": "", "type": "path", "description": "The segment key to pre validate checkin with." } ] }, "docs": "GraphQL endpoint: checkinBySegmentRequirementsv2" }, { "info": { "name": "Gets the checkin pre-validation requirements for a specific journey's segment.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/checkin/segment/:segmentKey/requirements", "params": [ { "name": "segmentKey", "value": "", "type": "path", "description": "The segment key to pre validate checkin with." } ] }, "docs": "GraphQL endpoint: checkinBySegmentRequirements" }, { "info": { "name": "Gets the passenger lift status for a specific segment based on the booking in state.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/checkin/segment/:segmentKey/status", "params": [ { "name": "segmentKey", "value": "", "type": "path", "description": "The segment key in reference." } ] }, "docs": "GraphQL endpoint: checkinBySegmentStatus" } ] }, { "info": { "name": "booking/contacts", "type": "folder" }, "items": [ { "info": { "name": "Gets all the contacts on the booking.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/contacts" }, "docs": "Gets all the contacts on the booking." }, { "info": { "name": "Creates a new contact on the booking.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/contacts", "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\nNote: New Skies does not support the Mobile phone number type for booking contacts.\n\nGraphQL endpoint: contactsAdd" }, { "info": { "name": "Gets a specific contact on the booking.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/contacts/:contactTypeCode", "params": [ { "name": "contactTypeCode", "value": "", "type": "path", "description": "The unique contact type code. Please note that this should be a char and not a string." } ] }, "docs": "GraphQL endpoint: contacts" }, { "info": { "name": "Updates a specific contact on the booking based on type code.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/contacts/:contactTypeCode", "params": [ { "name": "contactTypeCode", "value": "", "type": "path", "description": "The unique type code. Please note that this should be a char and not a string." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: contactsSet" }, { "info": { "name": "Patches a specific contact on the booking based on type code.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/contacts/:contactTypeCode", "params": [ { "name": "contactTypeCode", "value": "", "type": "path", "description": "The unique type code. Please note that this should be a char and not a string." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: contactsModify" }, { "info": { "name": "Deletes a specific contact on the booking based on type code.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/contacts/:contactTypeCode", "params": [ { "name": "contactTypeCode", "value": "", "type": "path", "description": "The unique type code. Please note that this should be a char and not a string." } ] }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: contactsDelete" }, { "info": { "name": "Gets the collection of phone number for a specific contact on the booking.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/contacts/:contactTypeCode/phoneNumbers", "params": [ { "name": "contactTypeCode", "value": "", "type": "path", "description": "The unique contact type code. Please note that this should be a char and not a string." } ] }, "docs": "Gets the collection of phone number for a specific contact on the booking." }, { "info": { "name": "Creates a new phone number on a specific contact on the booking.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/contacts/:contactTypeCode/phoneNumbers", "params": [ { "name": "contactTypeCode", "value": "", "type": "path", "description": "The unique contact type code. Please note that this should be a char and not a string." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: contactsPhoneAdd" }, { "info": { "name": "Gets the specific phone number from a specific contact on the booking.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/contacts/:contactTypeCode/phoneNumbers/:phoneNumberType", "params": [ { "name": "contactTypeCode", "value": "", "type": "path", "description": "The unique contact type code. Please note that this should be a char and not a string." }, { "name": "phoneNumberType", "value": "", "type": "path", "description": "The phone number type. \nEnumeration values: 0 = Other, 1 = Home, 2 = Work, 3 = Mobile, 4 = Fax" } ] }, "docs": "GraphQL endpoint: contactsPhone" }, { "info": { "name": "Updates a specific phone number on a specific contact on the booking.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/contacts/:contactTypeCode/phoneNumbers/:phoneNumberType", "params": [ { "name": "contactTypeCode", "value": "", "type": "path", "description": "The unique contact type code. Please note that this should be a char and not a string." }, { "name": "phoneNumberType", "value": "", "type": "path", "description": "The phone number type. \nEnumeration values: 0 = Other, 1 = Home, 2 = Work, 3 = Mobile, 4 = Fax" } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: contactsPhoneSet" }, { "info": { "name": "Deletes a specific phone number on a specific contact on the booking.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/contacts/:contactTypeCode/phoneNumbers/:phoneNumberType", "params": [ { "name": "contactTypeCode", "value": "", "type": "path", "description": "The unique contact type code. Please note that this should be a char and not a string." }, { "name": "phoneNumberType", "value": "", "type": "path", "description": "The phone number type. \nEnumeration values: 0 = Other, 1 = Home, 2 = Work, 3 = Mobile, 4 = Fax" } ] }, "docs": "GraphQL endpoint: contactsPhoneDelete" }, { "info": { "name": "Gets the primary contact based on configuration.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/contacts/primary" }, "docs": "GraphQL endpoint: primaryContact" }, { "info": { "name": "Creates a new primary contact based on configuration.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/contacts/primary", "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: primaryContactAdd" }, { "info": { "name": "Updates the primary contact.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/contacts/primary", "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: primaryContactSet" }, { "info": { "name": "Patches the primary contact.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/contacts/primary", "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: primaryContactModify" }, { "info": { "name": "Delete the primary contact.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/contacts/primary" }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: primaryContactDelete" } ] }, { "info": { "name": "booking/history", "type": "folder" }, "items": [ { "info": { "name": "Gets the current booking history in state.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/history", "params": [ { "name": "Event", "value": "", "type": "query", "description": "The event that triggered the history entry.\n \nEnumeration values: 0 = Unknown, 1 = ConvertedHistory, 2 = FlightTimeChange, 3 = FlightDesignatorChange, 4 = AssignedSeat, 5 = RemoveSeat, 6 = AddedFlight, 7 = DeletedFlight, 8 = DeletedPassenger, 9 = NameChange, 10 = GroupNameChange, 11 = CancelledTicketing, 12 = ScheduleChange, 13 = AddedPayment, 14 = ServiceFee, 15 = QueuedPnr, 16 = UnqueuedPnr, 17 = DeletedComment, 18 = Divided, 19 = CheckedIn, 20 = CheckedOut, 21 = FareOverride, 22 = AddedBaggage, 23 = ChangedBaggageWeight, 24 = CheckedBaggage, 25 = RemovedBaggage, 26 = BoardedPassenger, 27 = UnboardedPassenger, 28 = ManualAuthorization, 29 = ManualDecline, 30 = UndoCancel, 31 = ItinerarySent, 32 = ContactChange, 33 = SsrAdded, 34 = FlightMoved, 35 = VerifiedDocument, 36 = RemovedVerifiedDocument, 37 = Promotion, 38 = BookingComment, 39 = CancelledSchedule, 40 = CancelServiceFee, 41 = OverrideServiceFee, 42 = AddedRecordLocator, 43 = DeletedRecordLocator, 44 = UpgradeClassOfService, 45 = DowngradeClassOfService, 46 = StandbyPriorityChange, 47 = AssignedTicketNumber, 48 = DeletedTicketNumber, 49 = ConfirmSegmentStatusCodeChange, 50 = CodeshareFlightChanged, 51 = PdsCancel, 52 = PdsPending, 53 = PdsConfirm, 54 = PdsFinalized, 55 = PdsDeclined, 56 = PdsException, 57 = PdsCancelRefused, 58 = PdsCancelUnsuccessful, 59 = Apps, 60 = InhibitedOverride, 61 = PrintedBagTag, 62 = SelfPrintedBagTag, 63 = PrintedBoardingPass, 64 = AddCustomerId, 65 = DeleteCustomerId, 66 = HoldCreated, 67 = HoldRemoved, 68 = HoldChanged, 69 = OverrideCoupon, 70 = PdsSynchronized, 71 = PdsItemremoved, 72 = Reprice, 73 = ChannelOverride, 74 = EmdCreated, 75 = EmdRemoved, 76 = EmdChanged, 77 = ServiceBundle, 78 = PublishedFareOverride, 79 = FareClassRealignment, 80 = AddedDocument, 81 = ChangedDocument, 82 = DeletedPaymentProperties" }, { "name": "LastPageKey", "value": "", "type": "query", "description": "The key of the last booking history item returned.\n " }, { "name": "PageSize", "value": "", "type": "query", "description": "The page size for the response.\n " } ] }, "docs": "GraphQL endpoint: bookingHistory" }, { "info": { "name": "Gets the current bag tag print history for the booking in state.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/history/bagTagPrint", "params": [ { "name": "isBagTagSelfPrinted", "value": "", "type": "query", "description": "Whether the bag tag is self printed." } ] }, "docs": "GraphQL endpoint: bookingBagTagPrintHistoryv2" }, { "info": { "name": "Creates a bag tag print history for the booking in state.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/history/bagTagPrint", "body": { "type": "json", "data": "{}" } }, "docs": "Also updates bag's status from Added to AddedPrinted if Self-Tagging Baggage is enabled.\nIn order to see the status of a bag, check bags on a passenger segment.\n\nGraphQL endpoints: bookingBagTagPrintHistoryAdd, bookingBagTagPrintHistoryAddBatch" }, { "info": { "name": "Gets the current flight move history in state.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/history/flightMove", "params": [ { "name": "LastPageKey", "value": "", "type": "query", "description": "The key of the last booking history item returned.\n " }, { "name": "PageSize", "value": "", "type": "query", "description": "The page size for the response.\n " } ] }, "docs": "GraphQL endpoint: bookingFlightMoveHistory" }, { "info": { "name": "Gets the current hold date change history for the booking in state.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/history/holdDateChange", "params": [ { "name": "Event", "value": "", "type": "query", "description": "The event that triggered the hold date change history entry.\n \nEnumeration values: 66 = Created, 67 = Removed, 68 = Changed" }, { "name": "LastPageKey", "value": "", "type": "query", "description": "The key of the last booking history item returned.\n " }, { "name": "PageSize", "value": "", "type": "query", "description": "The page size for the response.\n " } ] }, "docs": "GraphQL endpoint: bookingHoldDateChangeHistory" }, { "info": { "name": "Gets the current itinerary sent history for the booking in state.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/history/itinerarySent", "params": [ { "name": "LastPageKey", "value": "", "type": "query", "description": "The key of the last booking history item returned.\n " }, { "name": "PageSize", "value": "", "type": "query", "description": "The page size for the response.\n " } ] }, "docs": "GraphQL endpoint: bookingItinerarySentHistory" }, { "info": { "name": "Gets the current message history in state.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/history/message" }, "docs": "GraphQL endpoint: bookingMessageHistory" }, { "info": { "name": "Gets the current notification history in state.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/history/notification" }, "docs": "GraphQL endpoint: bookingNotificationHistory" }, { "info": { "name": "Gets the current seat assignment history in state.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/history/seatAssignment", "params": [ { "name": "Event", "value": "", "type": "query", "description": "The event that triggered the seat assignment history entry.\n \nEnumeration values: 4 = AssignedSeat, 5 = RemoveSeat" }, { "name": "LastPageKey", "value": "", "type": "query", "description": "The key of the last booking history item returned.\n " }, { "name": "PageSize", "value": "", "type": "query", "description": "The page size for the response.\n " } ] }, "docs": "GraphQL endpoint: bookingSeatAssignmentHistory" }, { "info": { "name": "Gets the current segment change history in state.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/history/segmentChange", "params": [ { "name": "Event", "value": "", "type": "query", "description": "The event that triggered the seat assignment history entry.\n \nEnumeration values: 6 = AddedFlight, 7 = DeletedFlight" }, { "name": "LastPageKey", "value": "", "type": "query", "description": "The key of the last booking history item returned.\n " }, { "name": "PageSize", "value": "", "type": "query", "description": "The page size for the response.\n " } ] }, "docs": "GraphQL endpoint: bookingSegmentChangeHistory" } ] }, { "info": { "name": "booking/journeys", "type": "folder" }, "items": [ { "info": { "name": "Gets the collection of journeys on the booking in state.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/journeys" }, "docs": "GraphQL endpoint: journeys" }, { "info": { "name": "Cancels all the journeys on the current booking in state.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/journeys" }, "docs": "This endpoint also cancels all booking components/add-ons.\nTo only cancel journeys, use DELETE /api/nsk/v1/booking/journeys/{journeyKey}.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: journeyDeleteAll" }, { "info": { "name": "Gets a single journey by the key.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/journeys/:journeyKey", "params": [ { "name": "journeyKey", "value": "", "type": "path", "description": "The journey key to be retrieved." } ] }, "docs": "GraphQL endpoint: journey" }, { "info": { "name": "Cancels the specific journey from the booking in state.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/journeys/:journeyKey", "params": [ { "name": "journeyKey", "value": "", "type": "path", "description": "The journey key to be canceled." } ], "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: journeyDelete" }, { "info": { "name": "Removes the add-on service bundles of the requested passengers in the given journey.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/journeys/:journeyKey/bundles", "params": [ { "name": "journeyKey", "value": "", "type": "path", "description": "The journey key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint does not support removal of included bundles.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: bundleDelete" }, { "info": { "name": "Sells a service bundle for one or more passengers on a journey.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/journeys/:journeyKey/bundles", "params": [ { "name": "journeyKey", "value": "", "type": "path", "description": "The journey key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: bundleSellv2" }, { "info": { "name": "Waives the penalty fee of the specified journey.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/journeys/:journeyKey/fees/penalty", "params": [ { "name": "journeyKey", "value": "", "type": "path", "description": "The journey key." } ] }, "docs": "Waiving the penalty fee is configurable. See the \"Fee and Tax Settings\", \"Single Penalty Fee\" option. If this is\nchecked and configured this endpoint will waive the penalty fees from all journeys in the booking in state.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: journeyPenaltyFeeDelete" }, { "info": { "name": "Gets the passenger or associated infant's destination address requirements for a specific journey for the booking\nin-state.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/journeys/:journeyKey/passengers/:passengerKey/address/requirements", "params": [ { "name": "journeyKey", "value": "", "type": "path", "description": "The journey key to check requirements for." }, { "name": "passengerKey", "value": "", "type": "path", "description": "The passenger key to check requirements for." } ] }, "docs": "This endpoint will determine if the passenger or the associated infant requires a destination address for the\ngiven journey.\nThis does not determine if the passenger already has a qualifying address, only if the destination address\nis required.\n\nGraphQL endpoint: destinationAddressRequirementsByKey" }, { "info": { "name": "Gets all baggage for a passenger on a specific journey.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/journeys/:journeyKey/passengers/:passengerKey/baggage", "params": [ { "name": "journeyKey", "value": "", "type": "path", "description": "The journey key for the journey to retrieve from." }, { "name": "passengerKey", "value": "", "type": "path", "description": "The passenger key for the passenger to retrieve from." } ] }, "docs": "GraphQL endpoint: passengerBagJourneys" }, { "info": { "name": "Adds baggage to the booking.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/journeys/:journeyKey/passengers/:passengerKey/baggage", "params": [ { "name": "journeyKey", "value": "", "type": "path", "description": "The unique identifier for the journey to add to." }, { "name": "passengerKey", "value": "", "type": "path", "description": "The specific passenger key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This call must be followed by a commit to see the bags added in state.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: passengerBagAdd" }, { "info": { "name": "Gets a single bag from a passenger on a journey.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/journeys/:journeyKey/passengers/:passengerKey/baggage/:baggageKey", "params": [ { "name": "journeyKey", "value": "", "type": "path", "description": "The journey key for the journey to retrieve from." }, { "name": "passengerKey", "value": "", "type": "path", "description": "The passenger key for the passenger to retrieve from." }, { "name": "baggageKey", "value": "", "type": "path", "description": "The bag key for the bag to retrieve." } ] }, "docs": "GraphQL endpoint: passengerBagJourney" }, { "info": { "name": "Checks-in the baggage for a passenger on the booking in state.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/journeys/:journeyKey/passengers/:passengerKey/baggage/:baggageKey", "params": [ { "name": "journeyKey", "value": "", "type": "path", "description": "The journey key." }, { "name": "passengerKey", "value": "", "type": "path", "description": "The passenger key." }, { "name": "baggageKey", "value": "", "type": "path", "description": "The baggage key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This is to be called after a stateful adding of baggage to a booking and a commit must follow\nthe completion of this in order to see the bag checked in.\nAlso, this call properly syncs with baggage allowances and usages once completed.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: passengerBagCheckIn" }, { "info": { "name": "Removes baggage from the booking.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/journeys/:journeyKey/passengers/:passengerKey/baggage/:baggageKey", "params": [ { "name": "journeyKey", "value": "", "type": "path", "description": "The unique identifier for the journey to remove from." }, { "name": "passengerKey", "value": "", "type": "path", "description": "The specific passenger key." }, { "name": "baggageKey", "value": "", "type": "path", "description": "Unique identifier for the bag to remove." } ] }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: passengerBagDelete" }, { "info": { "name": "Updates the baggage for a passenger on the booking in state.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/journeys/:journeyKey/passengers/:passengerKey/baggage/:baggageKey", "params": [ { "name": "journeyKey", "value": "", "type": "path", "description": "The journey key." }, { "name": "passengerKey", "value": "", "type": "path", "description": "The passenger key." }, { "name": "baggageKey", "value": "", "type": "path", "description": "The baggage key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This is to be called after a stateful adding of baggage to a booking and a commit must follow\nthe completion of this in order to see the bag checked in.\nThis call does NOT sync with baggage allowances and usages.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: passengerBagSet" }, { "info": { "name": "Checks in the baggage for a passenger on the booking in state.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/journeys/:journeyKey/passengers/:passengerKey/baggage/:baggageKey/checkin", "params": [ { "name": "journeyKey", "value": "", "type": "path", "description": "The journey key." }, { "name": "passengerKey", "value": "", "type": "path", "description": "The passenger key." }, { "name": "baggageKey", "value": "", "type": "path", "description": "The baggage key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This is to be called after a stateful adding of baggage to a booking and a commit must follow\nthe completion of this in order to see the bag checked in.\nAlso, this call properly syncs with baggage allowances and usages once completed.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: passengerBagCheckIn" }, { "info": { "name": "Moves passenger to a different baggage group.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/journeys/:journeyKey/passengers/:passengerKey/baggage/group", "params": [ { "name": "journeyKey", "value": "", "type": "path", "description": "The journey key." }, { "name": "passengerKey", "value": "", "type": "path", "description": "The passenger key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Passengers in the same baggage group may share baggage allowances,\nenabling baggage allowance pooling.\n`PassengerBagGroupRequest.BaggageGroupNumber` only accepts bag group numbers\nfrom existing passenger bag group numbers. Passenger bag group number is\nexposed under passenger segment. If set to null, the passenger will be moved\nto a new bag group.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoints: passengerBa" }, { "info": { "name": "Adds manually tagged baggage to the booking.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/journeys/:journeyKey/passengers/:passengerKey/baggage/manual", "params": [ { "name": "journeyKey", "value": "", "type": "path", "description": "The unique identifier for the journey to add to." }, { "name": "passengerKey", "value": "", "type": "path", "description": "The specific passenger key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This call must be followed by a commit to see the bags added in state.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: passengerManualBagAdd" }, { "info": { "name": "Waives fees for a specific journey and passenger, based upon the given fee type.\nThis is an agent-only endpoint.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/journeys/:journeyKey/passengers/:passengerKey/fees/amount", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "The passenger key." }, { "name": "journeyKey", "value": "", "type": "path", "description": "The journey key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "NOTE: This endpoint takes a singular property for the request body and as such the request will need to be\nformatted differently than what it typically looks like. For more information, please see\nhttps://navitaire-developer-digital-api.azurewebsites.net/articles/Miscellaneous/UniqueInputSingleRequestBodiesREST.\nand the Swagger request examples.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: passengerFeesA" }, { "info": { "name": "Creates an infant on a passenger in the specified journey.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/journeys/:journeyKey/passengers/:passengerKey/infant", "params": [ { "name": "journeyKey", "value": "", "type": "path", "description": "The unique journey key." }, { "name": "passengerKey", "value": "", "type": "path", "description": "The unique passenger key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "If the booking in state contains a passive segment, an infant will not be\ncreated on the passive segment for the passenger.\nIf one of the segments in the journey already has an infant, the infant details from\nthe request will be ignored and the infant details from the existing infant will be retained.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: passengerInfantJourneyAdd" }, { "info": { "name": "Deletes an infant from a passenger in the specified journey.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/journeys/:journeyKey/passengers/:passengerKey/infant", "params": [ { "name": "journeyKey", "value": "", "type": "path", "description": "The unique identifier of the journey to remove infants from." }, { "name": "passengerKey", "value": "", "type": "path", "description": "The unique passenger key." } ] }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: passengerInfantJourneyDelete" }, { "info": { "name": "Modifies the status of the specified segment in the journey.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/journeys/:journeyKey/segments/:segmentKey/status", "params": [ { "name": "journeyKey", "value": "", "type": "path", "description": "The journey that contains the specified segment." }, { "name": "segmentKey", "value": "", "type": "path", "description": "The segment to be modified." }, { "name": "newStatus", "value": "", "type": "query", "description": "The new segment status to be set. \nEnumeration values: 0 = UnknownStatus, 1 = NoActionTaken, 2 = UnableToConfirmSegment, 3 = HeldConfirmed, 4 = HeldCancelled, 5 = ConfirmedTimeChange" } ] }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: segmentStatusModify" }, { "info": { "name": "Gets the travel document requirements for a specific journey for the booking in-state.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/journeys/:journeyKey/travelDocument/requirements", "params": [ { "name": "journeyKey", "value": "", "type": "path", "description": "The journey key to get required travel documents for." } ] }, "docs": "This endpoint will return a response containing a collection of travel document type codes that could fulfill\na travel document requirement. If the \"AtLeastOneDocumentRequired\" value is true, then one or more documents\nin the list are required. However, it does not mean that every document in the list is required. If\n\"AtLeastOneDocumentRequired\" is false, then the list of document type codes represents a list of acceptable\ntravel documents, but nothing is required.\nThis endpoint does not dete" }, { "info": { "name": "Gets the passenger or associated infant's destination address requirements for all journeys for the booking\nin-state.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/journeys/passengers/:passengerKey/address/requirements", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "The passenger key to check requirements for." } ] }, "docs": "This endpoint will determine if the passenger or the associated infant requires a destination address. If a\ndestination address is required for the passenger or associated infant for any journey, then this will return\ntrue.\nThis does not determine if the passenger already has a qualifying address, only if the destination address\nis required.\n\nGraphQL endpoint: destinationAddressRequirements" }, { "info": { "name": "Gets the travel document requirements for all journeys for the booking in-state.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/journeys/travelDocument/requirements" }, "docs": "This endpoint will return a response containing a collection of travel document type codes that could fulfill\na travel document requirement. If the \"AtLeastOneDocumentRequired\" value is true, then one or more documents\nin the list are required. However, it does not mean that every document in the list is required. If\n\"AtLeastOneDocumentRequired\" is false, then the list of document type codes represents a list of acceptable\ntravel documents, but nothing is required.\nThis endpoint does not dete" } ] }, { "info": { "name": "booking/passengers", "type": "folder" }, "items": [ { "info": { "name": "Gets the collection of passengers on the booking.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers" }, "docs": "GraphQL endpoint: passengers" }, { "info": { "name": "Gets passenger travel notifications for a specific passenger on the booking in state.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/:passengerAlternateKey/travelNotifications", "params": [ { "name": "passengerAlternateKey", "value": "", "type": "path", "description": "The passenger alternate key. This key will be null until the booking is committed." } ] }, "docs": "GraphQL endpoint: passengerTravelNotifications" }, { "info": { "name": "Creates a passenger travel notification for a specific passenger on the booking in state.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/:passengerAlternateKey/travelNotifications", "params": [ { "name": "passengerAlternateKey", "value": "", "type": "path", "description": "The passenger alternate key. This key will be null until the booking is committed." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: passengerTravelNotificationsAdd" }, { "info": { "name": "Gets a passenger travel notification for a specific passenger on the booking in state.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/:passengerAlternateKey/travelNotifications/:travelNotificationKey", "params": [ { "name": "passengerAlternateKey", "value": "", "type": "path", "description": "The passenger alternate key. This key will be null until the booking is committed." }, { "name": "travelNotificationKey", "value": "", "type": "path", "description": "The travel notification key." } ] }, "docs": "GraphQL endpoint: passengerTravelNotification" }, { "info": { "name": "Updates a passenger travel notification for a specific passenger on the booking in state.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/:passengerAlternateKey/travelNotifications/:travelNotificationKey", "params": [ { "name": "passengerAlternateKey", "value": "", "type": "path", "description": "The passenger alternate key. This key will be null until the booking is committed." }, { "name": "travelNotificationKey", "value": "", "type": "path", "description": "The travel notification key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: passengerTravelNotificationsSet" }, { "info": { "name": "Patches a passenger travel notification for a specific passenger on the booking in state.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/:passengerAlternateKey/travelNotifications/:travelNotificationKey", "params": [ { "name": "passengerAlternateKey", "value": "", "type": "path", "description": "The passenger alternate key. This key will be null until the booking is committed." }, { "name": "travelNotificationKey", "value": "", "type": "path", "description": "The travel notification key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: passengerTravelNotificationsModify" }, { "info": { "name": "Deletes a passenger travel notification for a specific passenger on the booking in state.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/:passengerAlternateKey/travelNotifications/:travelNotificationKey", "params": [ { "name": "passengerAlternateKey", "value": "", "type": "path", "description": "The passenger alternate key. This key will be null until the booking is committed." }, { "name": "travelNotificationKey", "value": "", "type": "path", "description": "The travel notification key." } ] }, "docs": "GraphQL endpoint: passengerTravelNotificationsDelete" }, { "info": { "name": "Gets notification events for a specific passenger travel notification on the booking in state.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/:passengerAlternateKey/travelNotifications/:travelNotificationKey/events", "params": [ { "name": "passengerAlternateKey", "value": "", "type": "path", "description": "The passenger alternate key. This key will be null until the booking is committed." }, { "name": "travelNotificationKey", "value": "", "type": "path", "description": "The travel notification key." } ] }, "docs": "GraphQL endpoint: passengerNotificationEvents" }, { "info": { "name": "Adds a notification event to a specific passenger travel notification on the booking in state.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/:passengerAlternateKey/travelNotifications/:travelNotificationKey/events", "params": [ { "name": "passengerAlternateKey", "value": "", "type": "path", "description": "The passenger alternate key. This key will be null until the booking is committed." }, { "name": "travelNotificationKey", "value": "", "type": "path", "description": "The travel notification key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: passengerNotificationEventsAdd" }, { "info": { "name": "Get a notification event for a specific passenger travel notification on the booking in state.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/:passengerAlternateKey/travelNotifications/:travelNotificationKey/events/:eventType", "params": [ { "name": "passengerAlternateKey", "value": "", "type": "path", "description": "The passenger alternate key. This key will be null until the booking is committed." }, { "name": "travelNotificationKey", "value": "", "type": "path", "description": "The travel notification key." }, { "name": "eventType", "value": "", "type": "path", "description": "The event type. \nEnumeration values: 0 = DepartureDelay, 1 = ArrivalDelay, 2 = ScheduleChange, 3 = CheckIn, 4 = GateInformation" } ] }, "docs": "GraphQL endpoint: passengerNotificationEvent" }, { "info": { "name": "Deletes a notification event from a specific passenger travel notification on the booking in state.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/:passengerAlternateKey/travelNotifications/:travelNotificationKey/events/:eventType", "params": [ { "name": "passengerAlternateKey", "value": "", "type": "path", "description": "The passenger alternate key. This key will be null until the booking is committed." }, { "name": "travelNotificationKey", "value": "", "type": "path", "description": "The travel notification key." }, { "name": "eventType", "value": "", "type": "path", "description": "The notification event type. \nEnumeration values: 0 = DepartureDelay, 1 = ArrivalDelay, 2 = ScheduleChange, 3 = CheckIn, 4 = GateInformation" } ] }, "docs": "GraphQL endpoint: passengerNotificationEventsDelete" }, { "info": { "name": "Gets notification timed events for a specific passenger travel notification on the booking in state.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/:passengerAlternateKey/travelNotifications/:travelNotificationKey/timedEvents", "params": [ { "name": "passengerAlternateKey", "value": "", "type": "path", "description": "The passenger alternate key. This key will be null until the booking is committed." }, { "name": "travelNotificationKey", "value": "", "type": "path", "description": "The travel notification key." } ] }, "docs": "GraphQL endpoint: passengerNotificationTimedEvents" }, { "info": { "name": "Adds a notification timed event to a specific passenger travel notification on the booking in state.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/:passengerAlternateKey/travelNotifications/:travelNotificationKey/timedEvents", "params": [ { "name": "passengerAlternateKey", "value": "", "type": "path", "description": "The passenger alternate key. This key will be null until the booking is committed." }, { "name": "travelNotificationKey", "value": "", "type": "path", "description": "The travel notification key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: passengerNotificationTimedEventsAdd" }, { "info": { "name": "Get a notification timed event for a specific passenger travel notification on the booking in state.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/:passengerAlternateKey/travelNotifications/:travelNotificationKey/timedEvents/:timedEventType", "params": [ { "name": "passengerAlternateKey", "value": "", "type": "path", "description": "The passenger alternate key. This key will be null until the booking is committed." }, { "name": "travelNotificationKey", "value": "", "type": "path", "description": "The travel notification key." }, { "name": "timedEventType", "value": "", "type": "path", "description": "The timed event type. \nEnumeration values: 0 = Departure, 1 = Arrival" } ] }, "docs": "GraphQL endpoint: passengerNotificationTimedEvent" }, { "info": { "name": "Updates a notification timed event for a specific passenger travel notification on the booking in state.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/:passengerAlternateKey/travelNotifications/:travelNotificationKey/timedEvents/:timedEventType", "params": [ { "name": "passengerAlternateKey", "value": "", "type": "path", "description": "The passenger alternate key. This key will be null until the booking is committed." }, { "name": "travelNotificationKey", "value": "", "type": "path", "description": "The travel notification key." }, { "name": "timedEventType", "value": "", "type": "path", "description": "The notification timed event type. \nEnumeration values: 0 = Departure, 1 = Arrival" } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: passengerNotificationTimedEventsSet" }, { "info": { "name": "Deletes a notification timed event from a specific passenger travel notification on the booking in state.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/:passengerAlternateKey/travelNotifications/:travelNotificationKey/timedEvents/:timedEventType", "params": [ { "name": "passengerAlternateKey", "value": "", "type": "path", "description": "The passenger alternate key. This key will be null until the booking is committed." }, { "name": "travelNotificationKey", "value": "", "type": "path", "description": "The travel notification key." }, { "name": "timedEventType", "value": "", "type": "path", "description": "The notification timed event type. \nEnumeration values: 0 = Departure, 1 = Arrival" } ] }, "docs": "GraphQL endpoint: passengerNotificationTimedEventsDelete" }, { "info": { "name": "Gets a specific passenger on the booking.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/:passengerKey", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "The unique passenger key." } ] }, "docs": "GraphQL endpoint: passenger" }, { "info": { "name": "Updates a specific passenger on the booking.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v3/booking/passengers/:passengerKey", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "The unique passenger key." }, { "name": "waiveNameChangeFees", "value": "", "type": "query", "description": "Waive the name change fees." }, { "name": "syncPassengerAndTravelDocGender", "value": "", "type": "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 " } ], "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoints: passengerSetv4, passengersSetBatchv2" }, { "info": { "name": "Patches a specific passenger on the booking.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v3/booking/passengers/:passengerKey", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "The unique passenger key." }, { "name": "waiveNameChangeFees", "value": "", "type": "query", "description": "Waive the name change fee. If unprovided, defaults to the configuration value." }, { "name": "syncPassengerAndTravelDocGender", "value": "", "type": "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 " } ], "body": { "type": "json", "data": "{}" } }, "docs": "Please note, the API will perform validation for the same properties that are on both the PATCH request and the\nexisting passenger.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoints: passengerModifyv4, passengersModifyBatchv2" }, { "info": { "name": "Gets the collection of addresses from a specific passenger.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/:passengerKey/addresses", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "The unique passenger key." } ] }, "docs": "Gets the collection of addresses from a specific passenger." }, { "info": { "name": "Creates a new address for a specific passenger.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/passengers/:passengerKey/addresses", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "The unique passenger key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: passengerAddressAddv2" }, { "info": { "name": "Gets a specific address from a specific passenger.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/:passengerKey/addresses/:addressKey", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "The unique passenger key." }, { "name": "addressKey", "value": "", "type": "path", "description": "The unique address key." } ] }, "docs": "GraphQL endpoint: passengerAddress" }, { "info": { "name": "Updates a specific address on a specific passenger.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v3/booking/passengers/:passengerKey/addresses/:addressKey", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "The unique passenger key." }, { "name": "addressKey", "value": "", "type": "path", "description": "The unique address key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: passengerAddressSetv3" }, { "info": { "name": "Patches a specific address on a specific passenger.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v3/booking/passengers/:passengerKey/addresses/:addressKey", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "The unique passenger key." }, { "name": "addressKey", "value": "", "type": "path", "description": "The unique address key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: passengerAddressModifyv3" }, { "info": { "name": "Deletes a specific address on a specific passenger.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/passengers/:passengerKey/addresses/:addressKey", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "The unique passenger key." }, { "name": "addressKey", "value": "", "type": "path", "description": "The unique address key." } ] }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: passengerAddressDeletev2" }, { "info": { "name": "Gets all the baggage for a specified passenger.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/:passengerKey/baggage", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "The unique identifier for the passenger to get baggage for." } ] }, "docs": "Gets all the baggage for a specified passenger." }, { "info": { "name": "Retrieve a single bag from a specific passenger.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/:passengerKey/baggage/:baggageKey", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "The passenger key for the passenger to retrieve from." }, { "name": "baggageKey", "value": "", "type": "path", "description": "The bag key for the bag to retrieve." } ] }, "docs": "GraphQL endpoint: passengerBag" }, { "info": { "name": "Retrieves events for a specific passenger baggage.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/:passengerKey/baggage/:baggageKey/events", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "Passenger key." }, { "name": "baggageKey", "value": "", "type": "path", "description": "Baggage key." }, { "name": "StartDate", "value": "", "type": "query", "description": "Start date. If no start date is provided, the start date defaults to the current UTC-based date.\n " }, { "name": "EndDate", "value": "", "type": "query", "description": "End date. If no end date is provided, the end date defaults to the current UTC-based date.\n " } ] }, "docs": "GraphQL endpoint: passengerBagEvents" }, { "info": { "name": "Creates event information for a specific passenger baggage. A successful call immediately creates the event\nand does not require the booking to be committed.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/:passengerKey/baggage/:baggageKey/events", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "Passenger key." }, { "name": "baggageKey", "value": "", "type": "path", "description": "Baggage key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: passengerBagEventAdd" }, { "info": { "name": "Retrieves information for a specific passenger baggage event.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/:passengerKey/baggage/:baggageKey/events/:baggageEventKey", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "Passenger key." }, { "name": "baggageKey", "value": "", "type": "path", "description": "Baggage key." }, { "name": "baggageEventKey", "value": "", "type": "path", "description": "Baggage event key." }, { "name": "StartDate", "value": "", "type": "query", "description": "Start date. If no start date is provided, the start date defaults to the current UTC-based date.\n " }, { "name": "EndDate", "value": "", "type": "query", "description": "End date. If no end date is provided, the end date defaults to the current UTC-based date.\n " } ] }, "docs": "GraphQL endpoint: passengerBagEvent" }, { "info": { "name": "Gets a specific passenger price breakdown by passenger key.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/:passengerKey/breakdown", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "The specific passenger key." } ] }, "docs": "GraphQL endpoint: passengerBreakdown" }, { "info": { "name": "Gets a specific passenger's collection of travel documents.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/:passengerKey/documents", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "The unique passenger key." } ] }, "docs": "Gets a specific passenger's collection of travel documents." }, { "info": { "name": "Create a new travel document for a specific passenger.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/passengers/:passengerKey/documents", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "The unique passenger key." }, { "name": "syncPassengerAndTravelDocGender", "value": "", "type": "query", "description": "Indicates whether to synchronize the passenger and all its travel\ndocuments' gender. This will update the gender in the passengers[passengerKey] as well as the gender of the other\ntravel documents in the passengers[passengerKey].travelDocuments list in the booking model. The value defaults to\ntrue if not specified.\n " } ], "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: passengerTravelDocumentsAddv2" }, { "info": { "name": "Gets a specific passenger's specific travel document.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/:passengerKey/documents/:travelDocumentKey", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "The unique passenger key." }, { "name": "travelDocumentKey", "value": "", "type": "path", "description": "The unique travel document key." } ] }, "docs": "GraphQL endpoint: passengerTravelDocuments" }, { "info": { "name": "Updates a specific passenger's travel document.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/passengers/:passengerKey/documents/:travelDocumentKey", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "The unique passenger key." }, { "name": "travelDocumentKey", "value": "", "type": "path", "description": "The unique travel document key." }, { "name": "syncPassengerAndTravelDocGender", "value": "", "type": "query", "description": "Indicates whether to synchronize the passenger and all its travel\ndocuments' gender. This will update the gender in the passengers[passengerKey] as well as the gender of the other\ntravel documents in the passengers[passengerKey].travelDocuments list in the booking model. The value defaults to\ntrue if not specified.\n " } ], "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: passengerTravelDocumentsSetv2" }, { "info": { "name": "Patches a specific passenger's travel document.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/passengers/:passengerKey/documents/:travelDocumentKey", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "The unique passenger key." }, { "name": "travelDocumentKey", "value": "", "type": "path", "description": "The unique travel document key." }, { "name": "syncPassengerAndTravelDocGender", "value": "", "type": "query", "description": "Indicates whether to synchronize the passenger and all its travel\ndocuments' gender. This will update the gender in the passengers[passengerKey] as well as the gender of the other\ntravel documents in the passengers[passengerKey].travelDocuments list in the booking model. The value defaults to\ntrue if not specified.\n " } ], "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: passengerTravelDocumentsModifyv2" }, { "info": { "name": "Deletes a specific passenger's specific travel document.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/passengers/:passengerKey/documents/:travelDocumentKey", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "The unique passenger key." }, { "name": "travelDocumentKey", "value": "", "type": "path", "description": "The unique travel document key." } ] }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: passengerTravelDocumentsDeletev2" }, { "info": { "name": "Gets the document check status for a specific passenger if there are any.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/:passengerKey/documents/check", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "The key of the passenger to perform the document check on." } ] }, "docs": "Requires a committed booking in state. Requires document check to be enabled in government security configuration.\n\nPerforms document check and returns the results as documentCheckStatus.\nMore detailed information is intentionally not provided for security reasons.\nThe designers of the client application will need to determine what to do with the different responses,\nin most cases the passenger will need to be assisted by an airport agent.\nFor more specific requirements check the following endpo" }, { "info": { "name": "Gets the collection of passenger EMD coupons for a specific passenger.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/:passengerKey/emdCoupons", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "The unique passenger key." } ] }, "docs": "GraphQL endpoint: passengerEmdCoupons" }, { "info": { "name": "Gets a specific passenger EMD coupon for a specific passenger.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/:passengerKey/emdCoupons/:passengerEmdCouponKey", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "The unique passenger key." }, { "name": "passengerEmdCouponKey", "value": "", "type": "path", "description": "The unique passenger EMD coupon key." } ] }, "docs": "GraphQL endpoint: passengerEmdCoupon" }, { "info": { "name": "Gets all fees for a specific passenger, based upon the given passenger key.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/:passengerKey/fees", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "The passenger key." } ] }, "docs": "GraphQL endpoint: passengerFees" }, { "info": { "name": "Gets a specific fee for a specific passenger, based upon the given keys.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/:passengerKey/fees/:passengerFeeKey", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "The passenger key." }, { "name": "passengerFeeKey", "value": "", "type": "path", "description": "The passenger fee key." } ] }, "docs": "GraphQL endpoint: passengerFee" }, { "info": { "name": "Waives the name change fee of the specified passenger.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/:passengerKey/fees/nameChange", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "The passenger key." } ] }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: passengerNameChangeFeeDelete" }, { "info": { "name": "Gets the override fee quote of a new fee.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/:passengerKey/fees/quote", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "The passenger key." }, { "name": "FeeCode", "value": "", "type": "query", "description": "The fee code used to identify the fee being overridden.\n \nCurrently, only manually-added fees are supported for quoting new fee overrides.\nThese fee types are:\n- Service Fee\n- Non-Flight Service Fee\n- Penalty Fee\n- Spoilage Fee\n " }, { "name": "PricingMode", "value": "", "type": "query", "description": "Indicates if fees are to be paid in points or with currency\n \nEnumeration values: 0 = MonetaryOnly, 1 = PointsOnly" }, { "name": "OriginStation", "value": "", "type": "query", "description": "Originating station code of the booking where the fee will be applied.\n " }, { "name": "Amount", "value": "", "type": "query", "description": "The override amount.\n " }, { "name": "CollectedCurrencyCode", "value": "", "type": "query", "description": "The collected currency code.\n " } ] }, "docs": "GraphQL endpoint: overrideNewFeeQuote" }, { "info": { "name": "Gets a specific passenger's infant.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/:passengerKey/infant", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "The unique passenger key." } ] }, "docs": "GraphQL endpoint: passengerInfant" }, { "info": { "name": "Creates an infant on a specific passenger.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v3/booking/passengers/:passengerKey/infant", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "The unique identifier of the passenger to which the infant will be added." } ], "body": { "type": "json", "data": "{}" } }, "docs": "If the booking in state contains a passive segment, an infant will not be\ncreated on the passive segment for the passenger.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: passengerInfantAddv3" }, { "info": { "name": "Updates an infant on a specific passenger.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v3/booking/passengers/:passengerKey/infant", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "The unique identifier of the passenger associated with the infant." }, { "name": "syncInfantAndTravelDocGender", "value": "", "type": "query", "description": "Indicates whether to synchronize the infant and all its travel documents' gender. This will update the gender of\nall the travel documents in the passengers[passengerKey].infant.travelDocuments list in the booking model. The\nvalue defaults to true if not specified.\n " } ], "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: passengerInfantSetv3" }, { "info": { "name": "Patches an infant on a specific passenger.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/passengers/:passengerKey/infant", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "The unique identifier of the passenger associated with the infant." }, { "name": "syncInfantAndTravelDocGender", "value": "", "type": "query", "description": "Indicates whether to synchronize the infant and all its travel documents' gender. This will update the gender of\nall the travel documents in the passengers[passengerKey].infant.travelDocuments list in the booking model. The\nvalue defaults to true if not specified.\n " } ], "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: passengerInfantModifyv2" }, { "info": { "name": "Deletes an infant from a specific passenger.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/passengers/:passengerKey/infant", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "The unique passenger key." } ] }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: passengerInfantDeletev2" }, { "info": { "name": "Gets a specific passenger infant's collection of travel documents.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/:passengerKey/infant/documents", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "The unique passenger key." } ] }, "docs": "Gets a specific passenger infant's collection of travel documents." }, { "info": { "name": "Create a new travel document for a specific passenger infant.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/passengers/:passengerKey/infant/documents", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "The unique passenger key." }, { "name": "syncInfantAndTravelDocGender", "value": "", "type": "query", "description": "Indicates whether to synchronize the infant and all its travel documents' gender. This will update the gender in\nthe passengers[passengerKey].infant as well as the gender of the other travel documents in the\npassengers[passengerKey].infant.travelDocuments list in the booking model. The value defaults to true if not\nspecified.\n " } ], "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: passengerInfantTravelDocumentsAddv2" }, { "info": { "name": "Gets a specific passenger infant's specific travel document.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/:passengerKey/infant/documents/:travelDocumentKey", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "The unique passenger key." }, { "name": "travelDocumentKey", "value": "", "type": "path", "description": "The unique travel document key." } ] }, "docs": "GraphQL endpoint: passengerInfantTravelDocuments" }, { "info": { "name": "Updates a specific passenger infant travel document.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/passengers/:passengerKey/infant/documents/:travelDocumentKey", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "The unique passenger key." }, { "name": "travelDocumentKey", "value": "", "type": "path", "description": "The unique travel document key." }, { "name": "syncInfantAndTravelDocGender", "value": "", "type": "query", "description": "Indicates whether to synchronize the infant and all its travel documents' gender. This will update the gender in\nthe passengers[passengerKey].infant as well as the gender of the other travel documents in the\npassengers[passengerKey].infant.travelDocuments list in the booking model. The value defaults to true if not\nspecified.\n " } ], "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: passengerInfantTravelDocumentsSetv2" }, { "info": { "name": "Patches a specific passenger infant travel document.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/passengers/:passengerKey/infant/documents/:travelDocumentKey", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "The unique passenger key." }, { "name": "travelDocumentKey", "value": "", "type": "path", "description": "The unique travel document key." }, { "name": "syncInfantAndTravelDocGender", "value": "", "type": "query", "description": "Indicates whether to synchronize the infant and all its travel documents' gender. This will update the gender in\nthe passengers[passengerKey].infant as well as the gender of the other travel documents in the\npassengers[passengerKey].infant.travelDocuments list in the booking model. The value defaults to true if not\nspecified.\n " } ], "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: passengerInfantTravelDocumentsModifyv2" }, { "info": { "name": "Deletes a specific passenger infant specific travel document.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/passengers/:passengerKey/infant/documents/:travelDocumentKey", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "The unique passenger key." }, { "name": "travelDocumentKey", "value": "", "type": "path", "description": "The unique travel document key." } ] }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: passengerInfantTravelDocumentsDeletev2" }, { "info": { "name": "Gets the document check status for a specific passenger's infant if there are any.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/:passengerKey/infant/documents/check", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "The key of the passenger to perform the infant document check on." } ] }, "docs": "Requires a committed booking in state. Requires document check to be enabled in government security configuration.\n\nPerforms document check and returns the results as documentCheckStatus.\nMore detailed information is intentionally not provided for security reasons.\nThe designers of the client application will need to determine what to do with the different responses,\nin most cases the passenger will need to be assisted by an airport agent.\nFor more specific requirements check the following endpo" }, { "info": { "name": "Patches a specific passenger to the given passenger type.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/:passengerKey/passengerTypeCode", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "The unique passenger key." }, { "name": "syncPassengerAndTravelDocGender", "value": "", "type": "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 " } ], "body": { "type": "json", "data": "{}" } }, "docs": "NOTE: The date of birth doesn't need to be updated if the passenger's current date of birth still falls within the\nnew passenger type's age restriction.\nThis could also cause a repricing on the booking.\nIn addition, changing the passenger type will change the passenger key as well.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: passengerTypeCodeModify" }, { "info": { "name": "Gets all seats associated with a passenger.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/passengers/:passengerKey/seats", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "Passengers to get seats for." } ] }, "docs": "GraphQL endpoint: seatPassengerv2" }, { "info": { "name": "Deletes a seat assignment from a specific passenger on the booking in state.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/:passengerKey/seats/:unitKey", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "The key for the passenger whose seat assignment is to be deleted." }, { "name": "unitKey", "value": "", "type": "path", "description": "The unique unit key." }, { "name": "WaiveFee", "value": "", "type": "query", "description": "The flag indicating to waive the seat fees if permissions permit.\n " }, { "name": "IgnoreSeatSsrs", "value": "", "type": "query", "description": "Flag indicating whether to ignore seat SSR's.\n " } ] }, "docs": "GraphQL endpoint: seatDelete" }, { "info": { "name": "Gets passenger seat by key.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/passengers/:passengerKey/seats/:unitKey", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "Unique passenger key." }, { "name": "unitKey", "value": "", "type": "path", "description": "Unique unit key." } ] }, "docs": "GraphQL endpoint: seatv2" }, { "info": { "name": "Adds a seat assignment to a specific passenger on the booking in state.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/passengers/:passengerKey/seats/:unitKey", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "The passenger key." }, { "name": "unitKey", "value": "", "type": "path", "description": "The unit key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint actively checks whether the passenger has a seat. If the passenger does\nhave a seat, it will delete the current seat the passenger occupies and add the requested\none. This may result in slightly slower response times.\n\nGraphQL endpoint: seatAddv2" }, { "info": { "name": "Retrieves a seat fee quote for a specific passenger.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/:passengerKey/seats/:unitKey/quote", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "The passenger key." }, { "name": "unitKey", "value": "", "type": "path", "description": "The unit key." }, { "name": "InventoryControlType", "value": "", "type": "query", "description": "The type of hold placed on seats.\n \nEnumeration values: 0 = Session, 1 = None" }, { "name": "IgnoreSeatSSRs", "value": "", "type": "query", "description": "Determines whether or not SSRs associated with the seat will be ignored when determining\nunit availability.\n " }, { "name": "SeatAssignmentMode", "value": "", "type": "query", "description": "The seat assignment mode can affect available units in seat maps and whether or not\nseat fees are charged based on channel type, role settings, customer programs\nand/or class of service.\n \nEnumeration values: 0 = AutoDetermine, 1 = PreSeatAssignment, 2 = WebCheckIn" }, { "name": "MonetaryOnly", "value": "", "type": "query", "description": "Indicates whether the fee to be priced is to be priced in money or points.\n " }, { "name": "CollectedCurrencyCode", "value": "", "type": "query", "description": "Optional currency code. If different than the booking currency code,\nfees in that currency will be returned if the conversion exists in the system.\n " } ] }, "docs": "GraphQL endpoint: seatFeeQuote" }, { "info": { "name": "Retrieves a seat fee quote for a specific passenger.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/:passengerKey/seats/:unitKey/quote", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "The passenger key." }, { "name": "unitKey", "value": "", "type": "path", "description": "The unit key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Although this endpoint behaves like a GET, POST reduces the limitations resulting from URL length issues.\n\nGraphQL endpoint: passengerSeatFeeQuote" }, { "info": { "name": "Gets an SSR price quote on the booking in state.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/:passengerKey/ssrs/:ssrCode/price", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "The passenger key." }, { "name": "ssrCode", "value": "", "type": "path", "description": "The ssr code." }, { "name": "collectedCurrencyCode", "value": "", "type": "query", "description": "The collected currency code." } ] }, "docs": "Requires a booking in state.\n\nGraphQL endpoint: passengerSsrPriceQuotes" }, { "info": { "name": "Gets multiple SSR price quotes for the booking in state.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/:passengerKey/ssrs/priceDetails", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "The passenger key. These can be found on the /booking GET endpoint response." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Requires a booking in state.\nDue to the complexity of the request parameters, we use POST to allow for the request body to be used,\neven though this is actually a GET operation.\nThis endpoint is related to the booking/ssrs/availability POST endpoint. This is a deep call to get the\nprice details for specific SSR's for a specific passenger, while the availability endpoint is a shallow\ncall to get the available SSR's and their associated prices.\nSubmitting a request with SSR codes not found in the" }, { "info": { "name": "Gets information regarding a specific voucher code and passenger.\nReturns what a voucher can pay for a given passenger.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/:passengerKey/voucher", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "The passenger key." }, { "name": "ReferenceCode", "value": "", "type": "query", "description": "The voucher reference code.\n " }, { "name": "OverrideRestrictions", "value": "", "type": "query", "description": "Override restrictions. Defaults to false.\n " } ] }, "docs": "GraphQL endpoint: voucherByPassenger" }, { "info": { "name": "Gets baggage group membership for all passengers on booking in state, or predicts group membership if no current groups exist", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/baggage/group" }, "docs": "Call this before adding a bag to see what baggage group an added bag will be added to.\nRespects newskies configuration of baggage groups.\nRelated endpoints:\n- PUT api/nsk/v1/booking/journeys/{journeyKey}/passengers/{passengerKey}/baggage/group\n- GET /api/nsk/v1/booking/baggageAllowances - baggage allowances can have weight sharing by group behavior\n\nGraphQL endpoint: passengersBagGroups" }, { "info": { "name": "Gets baggage group membership for selected passengers, or predicts group membership if no current groups exist.\nStructured as a POST but behaves as a GET.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/baggage/group", "body": { "type": "json", "data": "{}" } }, "docs": "Call this before adding a bag to see what baggage group an added bag will be added to.\nRespects newskies configuration of baggage groups.\nRelated endpoints:\n- PUT api/nsk/v1/booking/journeys/{journeyKey}/passengers/{passengerKey}/baggage/group\n- GET /api/nsk/v1/booking/baggageAllowances - baggage allowances can have weight sharing by group behavior\n\nGraphQL endpoint: passengersBagGroupsList" }, { "info": { "name": "Gets all the passenger price breakdowns.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/breakdown" }, "docs": "Gets all the passenger price breakdowns." }, { "info": { "name": "Gets all the passenger price breakdown by passenger type.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/breakdown/byType" }, "docs": "Gets all the passenger price breakdown by passenger type." }, { "info": { "name": "Updates the collection of un-named or TBA passengers on the booking.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/passengers/groupBooking" }, "docs": "When Enforce Standard Group Booking setting is true, group name is required and\nun-named or TBA passengers will be setup with\nFirst Name: TBA, Middle Name: Sequential Numeric, Last Name = Group Name.\nWhen the setting is false, group name is not required and\npassengers will be setup with\nFirst Name: Sequential Alphabetic, Last Name: TBA\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: passengersGroupBookingSe" } ] }, { "info": { "name": "booking/payments", "type": "folder" }, "items": [ { "info": { "name": "Retrieves the booking payments on the booking in state.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/payments" }, "docs": "Requires a booking in state." }, { "info": { "name": "Creates a new external payment or prepaid payment on the booking in state.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v5/booking/payments", "params": [ { "name": "termUrl", "value": "", "type": "query", "description": "The term URL." } ], "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\nThe payment fields are dynamic to the criteria of your payment provider. Here is an example request for a\ncredit card payment that does not require address, zip, etc.\n{ \"amount\": 10, \"currencyCode\": \"USD\", \"paymentFields\": {\"ACCTNO\":\"411111111111\", \"EXPDATE\":\"10/8/2017\",\n\"CC::AccountHolderName\":\"Bob Smith\", \"CC::VerificationCode\":\"111\"}}\nA 202 (HTTP status code) response retur" }, { "info": { "name": "Gets a specific payment.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/payments/:paymentKey", "params": [ { "name": "paymentKey", "value": "", "type": "path", "description": "Payment key." } ] }, "docs": "GraphQL endpoint: payments" }, { "info": { "name": "Deletes the payment.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/payments/:paymentKey", "params": [ { "name": "paymentKey", "value": "", "type": "path", "description": "Payment key." } ] }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: paymentDelete" }, { "info": { "name": "Manually authorize a committed payment.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/payments/:paymentKey/authorize", "params": [ { "name": "paymentKey", "value": "", "type": "path", "description": "The payment key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "NOTE: This endpoint takes a singular property for the request body and as such the request will need to be\nformatted differently than what it typically looks like. For more information, please see\nhttps://navitaire-developer-digital-api.azurewebsites.net/articles/Miscellaneous/UniqueInputSingleRequestBodiesREST\nand the Swagger request examples.\nThis endpoint is to be used with caution and is only permissible to use under certain circumstances.\nIMPORTANT: This endpoint should NOT be called concur" }, { "info": { "name": "Manually decline a committed payment.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/payments/:paymentKey/decline", "params": [ { "name": "paymentKey", "value": "", "type": "path", "description": "The payment key." } ] }, "docs": "This endpoint is to be used with caution and is only permissible to use under certain circumstances.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: paymentDeclinev3" }, { "info": { "name": "Gets the available direct currency codes offer.\nThis is for making an inline DCC payment.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/payments/:paymentMethod/dcc", "params": [ { "name": "paymentMethod", "value": "", "type": "path", "description": "The payment method code." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint behaves like a GET but is masked as a POST.\nIf a DCC offer is accepted the payment transaction will need to be completed before getting another\nDCC offer. For example, a user cannot get a DCC offer for a VISA, get a DCC offer for a MasterCard and then accept\nthe VISA DCC offer and pay with the VISA. The only way to complete this would be to get a DCC offer on one card,\naccept, and then pay and then get the DCC offer for another card, accept, and pay.\nRegardless of whether the offer" }, { "info": { "name": "Gets the payment allocations for the booking in state.\nPayment allocations are a collection of the payments assigned to each passenger\non the booking.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/payments/allocations" }, "docs": "GraphQL endpoint: paymentAllocations" }, { "info": { "name": "Retrieves the booking payment methods available for the booking in state.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/payments/available", "params": [ { "name": "currencyCode", "value": "", "type": "query", "description": "The optional currency code. Defaults to the logged in users currency code." } ] }, "docs": "Requires a booking in state.\n\nGraphQL endpoint: paymentsAvailablev2" }, { "info": { "name": "Adds the booking payment to the blacklist.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/payments/blacklist", "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: paymentsBlacklistAdd" }, { "info": { "name": "Retrieves the specified blacklisted payment.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/payments/blacklist/:paymentKey", "params": [ { "name": "paymentKey", "value": "", "type": "path", "description": "The unique identifier of the blacklisted payment to retrieve." } ] }, "docs": "GraphQL endpoint: paymentsBlacklistGet" }, { "info": { "name": "Modifies the specified blacklisted payment.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/payments/blacklist/:paymentKey", "params": [ { "name": "paymentKey", "value": "", "type": "path", "description": "The unique identifier of the blacklisted payment to modify." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: paymentsBlacklistModify" }, { "info": { "name": "Removes the specified payment from the blacklist.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/payments/blacklist/:paymentKey", "params": [ { "name": "paymentKey", "value": "", "type": "path", "description": "The unique identifier of the payment to be removed from the blacklist. " } ] }, "docs": "GraphQL endpoint: paymentsBlacklistDelete" }, { "info": { "name": "Retrieves the specified blacklisted payment.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/payments/blacklist/:paymentKey", "params": [ { "name": "paymentKey", "value": "", "type": "path", "description": "The unique identifier of the blacklisted payment to retrieve." } ] }, "docs": "GraphQL endpoint: paymentsBlacklistGetv2" }, { "info": { "name": "Gets credit available from a past booking.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/payments/bookingCredit", "params": [ { "name": "CurrencyCode", "value": "", "type": "query", "description": "The currency code of the account.\n " }, { "name": "RecordLocator", "value": "", "type": "query", "description": "Record locator being requested.\n " }, { "name": "EmailAddress", "value": "", "type": "query", "description": "The email address of a contact.\n " }, { "name": "Origin", "value": "", "type": "query", "description": "The origin station code.\n " }, { "name": "FirstName", "value": "", "type": "query", "description": "The first name of a passenger or contact.\n " }, { "name": "LastName", "value": "", "type": "query", "description": "The last name of a passenger or contact.\n " }, { "name": "CustomerNumber", "value": "", "type": "query", "description": "One of the passengers customer numbers applied.\n " }, { "name": "DepartureDate", "value": "", "type": "query", "description": "The first journeys departure date.\n " } ] }, "docs": "See booking retrieve. This method uses the same validation rules.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: paymentBookingCreditsv3" }, { "info": { "name": "Applies credit from a past booking.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v3/booking/payments/bookingCredit", "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: paymentBookingCreditsAddv4" }, { "info": { "name": "Applies credit by reference number and type.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v3/booking/payments/credit", "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint is for agents and can apply credit for any user or type.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: paymentCreditsAddv3" }, { "info": { "name": "Gets credit available by reference number and type.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/payments/credit", "params": [ { "name": "ReferenceNumber", "value": "", "type": "query", "description": "The account reference. This will be the record locator, customer account number, or organization code depending on\nthe type.\n " }, { "name": "CurrencyCode", "value": "", "type": "query", "description": "The currency code of the account.\n " }, { "name": "Type", "value": "", "type": "query", "description": "Defines the type of credit being applied.\n \nEnumeration values: 0 = Customer, 1 = Booking, 2 = Organization" } ] }, "docs": "This endpoint is for agents and can get credit available for any user or type.\n\nGraphQL endpoint: paymentCreditsv2" }, { "info": { "name": "Applies credit from the logged in customer to the booking in state.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v3/booking/payments/customerCredit", "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: paymentCustomerCreditsAddv3" }, { "info": { "name": "Gets credit available for the logged in user on the booking in state.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/payments/customerCredit", "params": [ { "name": "CurrencyCode", "value": "", "type": "query", "description": "The currency code of the account.\n " } ] }, "docs": "Depending on configuration, credit may be validated by the contacts and passengers on the booking.\n\nGraphQL endpoint: paymentCustomerCreditsv2" }, { "info": { "name": "Creates a new external payment with direct currency conversion.\nThis endpoint is used for inline DCC payments only.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v6/booking/payments/dcc/:dccKey", "params": [ { "name": "dccKey", "value": "", "type": "path", "description": "The DCC key." }, { "name": "termUrl", "value": "", "type": "query", "description": "The term url." } ], "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\nIf a DCC offer is accepted the payment transaction will need to be completed before getting another\nDCC offer. For example, a user cannot get a DCC offer for a VISA, get a DCC offer for a MasterCard and then accept\nthe VISA DCC offer and pay with the VISA. The only way to complete this would be to get a DCC offer on one card,\naccept, and then pay and then get the DCC offer for" }, { "info": { "name": "Adds a dcc payment to the booking in state.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/payments/dcc/:dccPaymentTransactionKey", "params": [ { "name": "dccPaymentTransactionKey", "value": "", "type": "path", "description": "The dcc payment transaction key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\nNOTE: This endpoint takes a singular property for the request body and as such the request will need to be\nformatted differently than what it typically looks like. For more information, please see\nhttps://navitaire-developer-digital-api.azurewebsites.net/articles/Miscellaneous/UniqueInputSingleRequestBodiesREST\nand the Swagger request examples.\nIf the system using this endpoin" }, { "info": { "name": "Retrieves the payment fee for the fee code by providing the account number and payment method code for a manual\nform of payment.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/payments/fees/:feeCode", "params": [ { "name": "feeCode", "value": "", "type": "path", "description": "The feeCode." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint behaves like a GET endpoint but is masked as POST.\n\nGraphQL endpoint: paymentFeeManual" }, { "info": { "name": "Retrieves the payment fee for the fee code by providing the stored payment key for a stored payment.\nThe stored payment key will be able to provide to retrieve the account number, payment method code and account\nnumber id.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/payments/fees/:feeCode/storedPayment/:storedPaymentKey", "params": [ { "name": "feeCode", "value": "", "type": "path", "description": "The fee code." }, { "name": "storedPaymentKey", "value": "", "type": "path", "description": "The stored payment key of the agent holding the session." }, { "name": "Amount", "value": "", "type": "query", "description": "The amount being payed.\n " }, { "name": "CurrencyCode", "value": "", "type": "query", "description": "The currency code. This will default to the bookings currency code.\n " }, { "name": "CollectedCurrencyCode", "value": "", "type": "query", "description": "The optional collected currency code. This will be needed for MCC requests.\n " } ] }, "docs": "GraphQL endpoint: paymentFeeStored" }, { "info": { "name": "Cancels an in-process payment, if one exists, from the session state.\nThis can be used when in the middle of a 3DS, MCC, or DCC payment to remove the payment.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/payments/inProcess" }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: inProcessPaymentDelete" }, { "info": { "name": "Gets the available multi-currency codes available.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v3/booking/payments/mcc" }, "docs": "This is affected by the booking currency code.\n\nGraphQL endpoint: paymentMccAvailabilityv3" }, { "info": { "name": "Creates a new MCC payment.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v6/booking/payments/mcc/:currencyCode", "params": [ { "name": "currencyCode", "value": "", "type": "path", "description": "The collected currency code." }, { "name": "termUrl", "value": "", "type": "query", "description": "The term URL." } ], "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\nThis is affected by the booking currency code.\nThe MCC payment cannot have the same currency code in the URL and body.\nIn a normal MCC rate scenario, the rate ID and exchange rate payment fields are auto-populated and should not be\npassed in manually.\nIf you would like to make a ThreeDSecure payment, you will need to provide a valid term url.\nYou will also need to have these h" }, { "info": { "name": "Creates a new MCC payment from a stored payment.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v6/booking/payments/mcc/:currencyCode/storedPayment/:storedPaymentKey", "params": [ { "name": "currencyCode", "value": "", "type": "path", "description": "The collected currency code." }, { "name": "storedPaymentKey", "value": "", "type": "path", "description": "Stored payment key." }, { "name": "termUrl", "value": "", "type": "query", "description": "The term URL." } ], "body": { "type": "json", "data": "{}" } }, "docs": "IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\nThis is affected by the booking currency code.\nThe MCC payment cannot have the same currency code in the URL and body.\nIn a normal MCC rate scenario, the rate ID and exchange rate payment fields are auto-populated and should not be\npassed in manually.\nIf you would like to make a ThreeDSecure payment, you will need to provide a valid term url.\nYou will also need to have these hea" }, { "info": { "name": "Applies credit to the logged-in or specified user's organization.\nNOTE: It is not recommended to use a custom agency credit payment as it will not have the\nsame behavior nor be validated like the pre-configured `AG` credit payment.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v3/booking/payments/organizationCredit", "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: paymentOrganizationCreditsAddv3" }, { "info": { "name": "Gets credit available for the logged in users organization.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/payments/organizationCredit", "params": [ { "name": "CurrencyCode", "value": "", "type": "query", "description": "The currency code of the account.\n " } ] }, "docs": "Depending on configuration, credit may be validated by the contacts and passengers on the booking.\n\nGraphQL endpoint: paymentOrganizationCreditsv2" }, { "info": { "name": "Retrieves the booking payment methods available for a refund on the booking in state.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/payments/refunds" }, "docs": "Requires a booking in state.\n\nGraphQL endpoint: paymentRefundsAvailability" }, { "info": { "name": "Creates a refund for the booking in state. No longer handles Credit Shell or `CS` refunds.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v5/booking/payments/refunds", "body": { "type": "json", "data": "{}" } }, "docs": "Requires a booking in state.\nNOTE: CS, credit shell refunds are no longer accepted through this endpoint. It is now recommended to use\nPOST `api/nsk/v1/booking/payments/refunds/creditShell` endpoint for any credit shell refund.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: paymentRefundsAddv5" }, { "info": { "name": "Creates a refund for the booking in state.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v4/booking/payments/refunds", "body": { "type": "json", "data": "{}" } }, "docs": "Requires a booking in state. Credit shell payment types will default to a customer credit if logged in. If not\nlogged in a booking credit will be applied.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: paymentRefundsAddv4" }, { "info": { "name": "Creates a credit shell refund for the booking in state.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/payments/refunds/creditShell", "body": { "type": "json", "data": "{}" } }, "docs": "Requires a booking in state.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: paymentRefundsCreditShell" }, { "info": { "name": "Creates a customer credit for a specified customer.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v3/booking/payments/refunds/customerCredit", "params": [ { "name": "skipBalanceValidation", "value": "", "type": "query", "description": "Indicates whether the validation of the booking balance should be skipped." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Requires a booking in state and an agent token. Agents should use /refunds endpoint for booking credits.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: paymentRefundsCustomerCreditv4" }, { "info": { "name": "Creates an organization account refund for a payment from\nthe booking in state.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v3/booking/payments/refunds/organizationCredit", "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: organizations2PaymentRefundAddv3" }, { "info": { "name": "Creates an organization account refund for a payment from\nthe booking in state.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/payments/refunds/organizationCredit", "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: organizations2PaymentRefundAddv2" }, { "info": { "name": "Reverses a payment for the booking in state.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/payments/reversals", "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\nThis endpoint works similarly with the refund endpoint (POST api/nsk/v4/booking/payments/refunds),\nbut agent-only permissions are needed and does not require a zero or negative booking balance for processing.\nRequires a booking in state. Credit shell payment types will default to a customer credit if logged in. If not\nlogged in a booking credit will be applied.\n\nGraphQL endpoi" }, { "info": { "name": "Reverses a payment for the booking in state.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/payments/reversals", "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\nThis endpoint works similarly with the refund endpoint (POST api/nsk/v4/booking/payments/refunds),\nbut agent-only permissions are needed and does not require a zero or negative booking balance for processing.\nRequires a booking in state.\nNOTE: CS, credit shell refunds are no longer accepted through this endpoint. It is now recommended to use\nPOST `api/nsk/v1/booking/payments/r" }, { "info": { "name": "Creates a payment using the stored payment information for the booking in state.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v7/booking/payments/storedPayment/:storedPaymentKey", "params": [ { "name": "storedPaymentKey", "value": "", "type": "path", "description": "Stored payment key." }, { "name": "termUrl", "value": "", "type": "query", "description": "The term url." } ], "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\nAccount Number and Expiration Date are stored.\nWith stored payments, payment fields may still be required to complete the transaction.\nFor example, a credit card that requires address information, this information is not stored with the stored\npayment.\nA 202 (HTTP status code) response returns alternate data signifying that either Three D Secure was enabled for\nthis payment an" }, { "info": { "name": "Creates a new ThreeDSecure external payment or prepaid payment on the booking in state.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v6/booking/payments/threeDSecure", "params": [ { "name": "termUrl", "value": "", "type": "query", "description": "The term URL." } ], "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\nA call to payments post should be made first and processed to verify a 3DS payment is required.\nIf you would like to make a ThreeDSecure payment, you will need to provide a valid term url.\nYou will also need to have these headers populated:\nUser Agent (USER-AGENT)\nAccept (ACCEPT)\n\nGraphQL endpoint: paymentThreeDSecureAddv6" }, { "info": { "name": "Creates a new ThreeDSecure external payment or prepaid payment on the booking in state.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v7/booking/payments/threeDSecure", "params": [ { "name": "termUrl", "value": "", "type": "query", "description": "The term URL." } ], "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\nA call to payments post should be made first and processed to verify a 3DS payment is required.\nIf you would like to make a ThreeDSecure payment, you will need to provide a valid term url.\nYou will also need to have these headers populated:\nUser Agent (USER-AGENT)\nAccept (ACCEPT)\n\nGraphQL endpoint: paymentThreeDSecureAddv6" }, { "info": { "name": "Creates a new ThreeDSecure Redirect external payment or prepaid payment on the booking in state.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/payments/threeDSecureRedirect", "params": [ { "name": "termUrl", "value": "", "type": "query", "description": "The term URL." } ], "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\nA call to payments post should be made first and processed to verify a 3DS payment is required.\nIf you would like to make a ThreeDSecure Redirect payment, you will need to provide a valid term url.\nYou will also need to have these headers populated:\nUser Agent (USER-AGENT)\nAccept (ACCEPT)\n\nGraphQL endpoint: paymentThreeDSecureRedirectAdd" }, { "info": { "name": "Creates a new voucher payment on the booking in state.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v4/booking/payments/voucher", "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: paymentVouchersAddv4" }, { "info": { "name": "Gets information regarding a specific voucher code and validates whether the referenced voucher\nexists as a voucher payment in the booking in state.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v3/booking/payments/voucher", "params": [ { "name": "ReferenceCode", "value": "", "type": "query", "description": "The voucher reference code.\n " }, { "name": "OverrideRestrictions", "value": "", "type": "query", "description": "Override restrictions. Defaults to false.\n " } ] }, "docs": "GraphQL endpoint: paymentVouchersv3" }, { "info": { "name": "Reverses a voucher payment on the booking in state. This refunds the claimed amount on the voucher.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/payments/voucher/:voucherPaymentReference", "params": [ { "name": "voucherPaymentReference", "value": "", "type": "path", "description": "Voucher payment reference." } ] }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: paymentVoucherDeletev2" }, { "info": { "name": "Creates a new voucher payment for a specified passenger.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/payments/voucher/passenger/:passengerKey", "params": [ { "name": "passengerKey", "value": "", "type": "path", "description": "Passenger key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "For a passenger-select voucher to be shared across passengers, please use the standard voucher payment endpoint.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: paymentPassengerVouchersAdd" }, { "info": { "name": "Reassess the voucher payments on the current booking in state.\nThis will reverse non-adjustable voucher payments to balance the voucher when the booking is overpaid.\nThe use of the voucher is not considered in the reassessment of a non-adjustable voucher payment.\nMulti-use without adjustment vouchers will be prioritized over single-use without adjustment vouchers.\nVouchers with a longer expiration date will also be prioritized. The voucher type will be honored first and then\nthe expiration date.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/payments/voucher/reassess" }, "docs": "IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: paymentVouchersReassess" } ] }, { "info": { "name": "booking/retrieve", "type": "folder" }, "items": [ { "info": { "name": "Retrieves the booking from the New Skies server based on the retrieve booking request parameters and any configured\nbooking retrieve strategies. If the booking exists and the search criteria is allowed by one of the configured\nbooking retrieve strategies, the booking will be loaded into the web session and returned.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/retrieve", "params": [ { "name": "RecordLocator", "value": "", "type": "query", "description": "Record locator being requested.\n " }, { "name": "EmailAddress", "value": "", "type": "query", "description": "The email address of a contact.\n " }, { "name": "Origin", "value": "", "type": "query", "description": "The origin station code.\n " }, { "name": "FirstName", "value": "", "type": "query", "description": "The first name of a passenger or contact.\n " }, { "name": "LastName", "value": "", "type": "query", "description": "The last name of a passenger or contact.\n " }, { "name": "CustomerNumber", "value": "", "type": "query", "description": "One of the passengers customer numbers applied.\n " }, { "name": "DepartureDate", "value": "", "type": "query", "description": "The first journeys departure date.\n " } ] }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\nThis endpoint will perform validation using a pre-configured booking retrieve strategy. Custom strategies can\nbe configured in Utilities, and are configurable based on application name.\nTo set up a custom strategy, go to Utilities -> Resource Management. From the \"Resource Management\" screen, go\nto Root -> Web -> dotREZ folder. Right-click on the dotREZ folder and select \"A" }, { "info": { "name": "Gets a specific booking by key and stores it in state.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/retrieve/:bookingKey", "params": [ { "name": "bookingKey", "value": "", "type": "path", "description": "The booking key." } ] }, "docs": "This endpoint requires a session token and is agent-only.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: bookingRetrieveByKey" }, { "info": { "name": "Gets a specific booking by ID and stores it in state.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/retrieve/byBookingId/:bookingId", "params": [ { "name": "bookingId", "value": "", "type": "path", "description": "The booking ID." } ] }, "docs": "This endpoint requires a session token and is agent-only. Archived bookings cannot be retrieved with this endpoint.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: bookingRetrieveByBookingId" }, { "info": { "name": "Gets a specific booking by record locator and stores it in state.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/retrieve/byRecordLocator/:recordLocator", "params": [ { "name": "recordLocator", "value": "", "type": "path", "description": "The booking record locator." } ] }, "docs": "This endpoint requires a session token and is agent-only.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: bookingRetrieveByRecordLocator" }, { "info": { "name": "Gets a specific booking by third-party record locator and stores it in state.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/retrieve/byThirdPartyRecordLocator", "params": [ { "name": "SystemCode", "value": "", "type": "query", "description": "System Code being requested.\n " }, { "name": "ThirdPartyRecordLocator", "value": "", "type": "query", "description": "The Third Party Record Locator of the booking being requested.\n " } ] }, "docs": "This endpoint requires a session token and is agent-only.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: bookingRetrieveByThirdPartyRecordLocator" } ] }, { "info": { "name": "booking/seatmaps", "type": "folder" }, "items": [ { "info": { "name": "Gets the list of seat maps for all the journeys for the booking in state.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v3/booking/seatmaps", "params": [ { "name": "FeePricingMode", "value": "", "type": "query", "description": "Fee pricing mode.\n \nEnumeration values: 0 = MonetaryOnly, 1 = PointsOnly" }, { "name": "CollectedCurrencyCode", "value": "", "type": "query", "description": "The collected currency code.\n " }, { "name": "IncludePropertyLookup", "value": "", "type": "query", "description": "Flag indicating to include seat property lookup on the response.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code.\n " } ] }, "docs": "GraphQL endpoint: seatMapsv3" }, { "info": { "name": "Gets the list of seat maps for an entire journey.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v4/booking/seatmaps/journey/:journeyKey", "params": [ { "name": "journeyKey", "value": "", "type": "path", "description": "The unique journey key." }, { "name": "FeePricingMode", "value": "", "type": "query", "description": "Fee pricing mode.\n \nEnumeration values: 0 = MonetaryOnly, 1 = PointsOnly" }, { "name": "CollectedCurrencyCode", "value": "", "type": "query", "description": "The collected currency code.\n " }, { "name": "IncludePropertyLookup", "value": "", "type": "query", "description": "Flag indicating to include seat property lookup on the response.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code.\n " } ] }, "docs": "GraphQL endpoint: seatMapsByJourneyKeyv3" }, { "info": { "name": "Gets the list of seat maps for a specific journey's segment.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v3/booking/seatmaps/segment/:segmentKey", "params": [ { "name": "segmentKey", "value": "", "type": "path", "description": "The segment key." }, { "name": "FeePricingMode", "value": "", "type": "query", "description": "Fee pricing mode.\n \nEnumeration values: 0 = MonetaryOnly, 1 = PointsOnly" }, { "name": "CollectedCurrencyCode", "value": "", "type": "query", "description": "The collected currency code.\n " }, { "name": "IncludePropertyLookup", "value": "", "type": "query", "description": "Flag indicating to include seat property lookup on the response.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code.\n " } ] }, "docs": "GraphQL endpoint: seatMapsBySegmentKeyv3" } ] }, { "info": { "name": "booking/seats", "type": "folder" }, "items": [ { "info": { "name": "Auto assigns seats to all selected passengers that do not have them for every journey on the booking.\nIf seatedNearPrimary is empty, all passengers in the state booking will be requested for seat assignments.\nOtherwise, passengers with a passenger key specified in seatedNearPrimary will be requested instead.\nAn invalid primary passenger key or invalid passenger keys are not accepted and will return a Bad Request Error.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/seats/auto", "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: autoAssignSeats" }, { "info": { "name": "Auto assigns seats to all selected passengers that do not have them for every journey on the booking.\nIf seatedNearPrimary is empty, all passengers in the state booking will be requested for seat assignments.\nOtherwise, passengers with a passenger key specified in seatedNearPrimary will be requested instead.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/seats/auto/:primaryPassengerKey", "params": [ { "name": "primaryPassengerKey", "value": "", "type": "path", "description": "The key for the primary passenger." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: seatAutoAssign" }, { "info": { "name": "Auto assigns seats to all passengers that do not have them for a specific journey.\nIf seatedNearPrimary is empty, all passengers in the state booking will be requested for seat assignments.\nOtherwise, passengers with a passenger key specified in seatedNearPrimary will be requested instead.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/seats/auto/:primaryPassengerKey/journey/:journeyKey", "params": [ { "name": "primaryPassengerKey", "value": "", "type": "path", "description": "The key for the primary passenger." }, { "name": "journeyKey", "value": "", "type": "path", "description": "The specific journey key to auto assign." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: seatAutoAssignJourney" }, { "info": { "name": "Retrieves the seat fee information of the auto-assigned seats of a passenger on a given journey.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/seats/auto/:primaryPassengerKey/journey/:journeyKey/quote", "params": [ { "name": "journeyKey", "value": "", "type": "path", "description": "The key of the journey for the auto-assigned seat where the seat fee information will be\nbased.\n " }, { "name": "primaryPassengerKey", "value": "", "type": "path", "description": "The key of the primary passenger being seated." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Although this endpoint behaves like a GET, POST reduces the limitations resulting from URL length issues.\n\nGraphQL endpoint: passengerSeatFeeQuoteJourney" }, { "info": { "name": "Auto assigns seats to all passengers that do not have them for a specific journey's segment.\nIf seatedNearPrimary is empty, all passengers in the state booking will be requested for seat assignments.\nOtherwise, passengers with a passenger key specified in seatedNearPrimary will be requested instead.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/seats/auto/:primaryPassengerKey/segment/:segmentKey", "params": [ { "name": "primaryPassengerKey", "value": "", "type": "path", "description": "The key for the primary passenger." }, { "name": "segmentKey", "value": "", "type": "path", "description": "The specific segment key to auto assign." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: seatAutoAssignSegment" }, { "info": { "name": "Retrieves the seat fee information of the auto-assigned seats of a passenger on a given segment.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/seats/auto/:primaryPassengerKey/segment/:segmentKey/quote", "params": [ { "name": "segmentKey", "value": "", "type": "path", "description": "The key of the segment for the auto-assigned seat where the seat fee information will be\nbased.\n " }, { "name": "primaryPassengerKey", "value": "", "type": "path", "description": "The key of the primary passenger being seated." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Although this endpoint behaves like a GET, POST reduces the limitations resulting from URL length issues.\n\nGraphQL endpoint: passengerSeatFeeQuoteSegment" }, { "info": { "name": "Auto assigns seats to all passengers that do not have them for a specific journey.\nIf seatedNearPrimary is empty, all passengers in the state booking will be requested for seat assignments.\nOtherwise, passengers with a passenger key specified in seatedNearPrimary will be requested instead.\nAn invalid primary passenger key or invalid passenger keys are not accepted and will return a Bad Request Error.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/seats/auto/journey/:journeyKey", "params": [ { "name": "journeyKey", "value": "", "type": "path", "description": "The specific journey key to auto assign." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: autoAssignSeatsJourney" }, { "info": { "name": "Auto assigns seats to all passengers that do not have them for a specific journey's segment.\nIf seatedNearPrimary is empty, all passengers in the state booking will be requested for seat assignments.\nOtherwise, passengers with a passenger key specified in seatedNearPrimary will be requested instead.\nAn invalid primary passenger key or invalid passenger keys are not accepted and will return a Bad Request Error.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/seats/auto/segment/:segmentKey", "params": [ { "name": "segmentKey", "value": "", "type": "path", "description": "The specific segment key to auto assign." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: autoAssignSeatsSegment" } ] }, { "info": { "name": "booking/segments", "type": "folder" }, "items": [ { "info": { "name": "Cancels the specific segment from the booking in state.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/segments/:segmentKey", "params": [ { "name": "segmentKey", "value": "", "type": "path", "description": "The key of the specific segment to be canceled." } ] }, "docs": "Calling this method will alter the existing journeyKey. If you are cancelling the only segment in a journey,\nthis method will behave the same as calling DELETE on /api/nsk/v1/booking/journeys/{journeyKey}.\nIf there are segments remaining after the delete, the Location response header will be set with\nthe location of the modified journey with its new key.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: segme" }, { "info": { "name": "Restores a segment to the class of service prior to an upgrade or downgrade.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/segments/:segmentKey/classOfService", "params": [ { "name": "segmentKey", "value": "", "type": "path", "description": "The segment key." }, { "name": "overSell", "value": "", "type": "query", "description": "Indicates the intent to restore the class of service even if there are no available AUs." } ] }, "docs": "This does not truly delete the old class of service. Instead, it restores the original class of service before\nan upgrade or downgrade occurred.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: classOfServiceResetv2" }, { "info": { "name": "Gets a specific passenger segment from the booking in state.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/segments/:segmentKey/passengers/:passengerKey", "params": [ { "name": "segmentKey", "value": "", "type": "path", "description": "The segment key." }, { "name": "passengerKey", "value": "", "type": "path", "description": "The passenger key." } ] }, "docs": "GraphQL endpoint: passengerSegment" }, { "info": { "name": "Creates an infant on a passenger in the specified segment.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/segments/:segmentKey/passengers/:passengerKey/infant", "params": [ { "name": "segmentKey", "value": "", "type": "path", "description": "The unique segment key." }, { "name": "passengerKey", "value": "", "type": "path", "description": "The unique passenger key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "If the booking in state contains a passive segment, an infant will not be\ncreated on the passive segment for the passenger.\nIf the passenger on the specified segment already has an infant, an exception\nwill be thrown.\nIf any other segment in the booking already has an infant, the infant details from\nthe request will be ignored and the infant details from the existing infant will\nbe retained.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performa" }, { "info": { "name": "Deletes an infant from a passenger in the specified segment.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/segments/:segmentKey/passengers/:passengerKey/infant", "params": [ { "name": "segmentKey", "value": "", "type": "path", "description": "The unique identifier of the segment to remove infants from." }, { "name": "passengerKey", "value": "", "type": "path", "description": "The unique passenger key." } ] }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: passengerInfantSegmentDelete" }, { "info": { "name": "Creates a ticket on a passenger segment on the booking in state.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/segments/:segmentKey/passengers/:passengerKey/tickets", "params": [ { "name": "segmentKey", "value": "", "type": "path", "description": "The segment key." }, { "name": "passengerKey", "value": "", "type": "path", "description": "The passenger key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: ticketAdd" }, { "info": { "name": "Updates a ticket on a passenger segment on the booking in state.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/segments/:segmentKey/passengers/:passengerKey/tickets", "params": [ { "name": "segmentKey", "value": "", "type": "path", "description": "The segment key." }, { "name": "passengerKey", "value": "", "type": "path", "description": "The passenger key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "If you attempt to update the passenger number and set the ticket indicator code to 'X' (TicketRequired)\nyou will encounter an error. If you need to update both please do so separately.\nThis endpoint cannot be used to remove a ticket number,\nbut can be used to update to a different ticket number.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: ticketSet" }, { "info": { "name": "Modifies the class of service for the current booking in state to effect a segment upgrade or downgrade.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/segments/classOfService/:classModifyKey", "params": [ { "name": "classModifyKey", "value": "", "type": "path", "description": "The class modify key from class of service availability." } ], "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: classOfServiceModify" }, { "info": { "name": "Gets class of service availability for the booking in state.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/segments/classOfService/availability", "params": [ { "name": "isUpgrade", "value": "", "type": "query", "description": "Indicates an upgrade class of service request.\nWhen set to false, indicates a downgrade class of service request.\n " }, { "name": "collectedCurrencyCode", "value": "", "type": "query", "description": "Collected currency code." }, { "name": "feePricingMode", "value": "", "type": "query", "description": "Fee pricing mode. \nEnumeration values: 0 = MonetaryOnly, 1 = PointsOnly" }, { "name": "includeUnavailable", "value": "", "type": "query", "description": "Indicates that classes of service with no availability should be returned." } ] }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: classOfServiceAvailabilityv2" } ] }, { "info": { "name": "booking/ssrs", "type": "folder" }, "items": [ { "info": { "name": "Retrieves the current SSRs added to the booking in state.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/ssrs" }, "docs": "Requires a booking in state.\n\nGraphQL endpoint: ssrs" }, { "info": { "name": "Adds SSRs to the booking in state.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v3/booking/ssrs", "body": { "type": "json", "data": "{}" } }, "docs": "Adding an SSR by journey automatically adds the SSR to every segment.\nRequires a booking in state.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: ssrsAddv3" }, { "info": { "name": "Retrieves the current SSR by key.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/ssrs/:ssrKey", "params": [ { "name": "ssrKey", "value": "", "type": "path", "description": "Unique Ssr passenger identifier." } ] }, "docs": "Requires a booking in state.\n\nGraphQL endpoint: ssr" }, { "info": { "name": "Modifies the SSR note.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/ssrs/:ssrKey", "params": [ { "name": "ssrKey", "value": "", "type": "path", "description": "Unique Ssr key identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "NOTE: This endpoint takes a singular property for the request body and as such the request will need to be\nformatted differently than what it typically looks like. For more information, please see\nhttps://navitaire-developer-digital-api.azurewebsites.net/articles/Miscellaneous/UniqueInputSingleRequestBodiesREST\nand the Swagger request examples.\nRequires a booking in state.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGrap" }, { "info": { "name": "Deletes the SSR associated with the specified passenger SSR key.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/ssrs/:ssrKey", "params": [ { "name": "ssrKey", "value": "", "type": "path", "description": "The passenger SSR key." } ] }, "docs": "Requires a booking in state. The passenger SSR key can be found in the `PassengerSegment.Ssrs` object in the\nbooking.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: ssrsDelete" }, { "info": { "name": "Add an SSR to the booking in state.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v3/booking/ssrs/:ssrKey", "params": [ { "name": "ssrKey", "value": "", "type": "path", "description": "The SSR key to add." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adding an SSR by journey automatically adds the SSR to every segment.\nRequires a booking in state.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: ssrAddv3" }, { "info": { "name": "Deletes the SSR associated with the specified passenger SSR key.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/ssrs/:ssrKey", "params": [ { "name": "ssrKey", "value": "", "type": "path", "description": "The passenger SSR key." } ] }, "docs": "Requires a booking in state. The passenger SSR key can be found in the `PassengerSegment.Ssrs` object in the\nbooking.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: ssrsDeletev2" }, { "info": { "name": "Gets the available SSRs that can be added to a booking.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v3/booking/ssrs/availability", "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint requires a booking in state. By default, all SSR availability for the booking is returned.\nFor details about a specific SSR, the `GET booking/passengers/{passengerKey}/ssrs/{ssrCode}/price` endpoint can\nbe used.\nDuplicate values for trips and/or passenger keys in the request are ignored i.e. only unique values are\nprocessed.\n\nInfant SSR availability for the configured infant SSR (the infant SSR code recognized by the Digital API on\ninfant-specific endpoints) is included. To determi" }, { "info": { "name": "Get the ssr's available to add to the booking in state.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/ssrs/availability", "body": { "type": "json", "data": "{}" } }, "docs": "- Requires a booking in state.\n- By default, all ssr availability for the booking is returned.\n- For details about a specific ssr you can use the\n`/booking/passengers/{passengerKey}/ssrs/{ssrCode}/price` endpoint.\n- Infant SSR availability for the configured infant SSR is not included by default.\n- If the configured infant SSR availability needs to be displayed, the `passengerOptions.showInfantSsrAvailability`\nflag in the API's configuration should be set to true.\n- Note that the SSR key for the" }, { "info": { "name": "Resells any cancelled SSR bundle to the provided journey on the booking.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/ssrs/bundles/resell", "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: resellSsrBundles" }, { "info": { "name": "Deletes the SSR that matches the request criteria.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/ssrs/manual", "body": { "type": "json", "data": "{}" } }, "docs": "Requires a booking in state.\nThis is an alternate way of deleting an SSR. It is still recommended to delete an SSR by the passenger key (see\nDELETE /booking/ssrs/{ssrKey}). This method is useful if the application is not querying availability and not using\ndynamic SSR information.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: ssrsDeleteManual" }, { "info": { "name": "Adds SSRs to the booking in state.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/ssrs/manual", "body": { "type": "json", "data": "{}" } }, "docs": "Adding an SSR by journey automatically adds the SSR to every segment.\nRequires a booking in state.\nThis is an alternate way of creating an SSR. Creating by ID is recommended (see /api/booking/ssrs).\nThis method is useful if the UI is not querying availability and not using dynamic SSR information.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: ssrsAddManualv2" }, { "info": { "name": "Resells any cancelled SSRs to the provided journey on the booking.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/booking/ssrs/resell", "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: resellSsrs" }, { "info": { "name": "Resells any cancelled SSRs to the provided journey on the booking.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/booking/ssrs/resell", "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\nRelated Endpoints:\n- `GET /api/nsk/v1/booking/journeys`: Gets the collection of journeys on the booking in state.\n- `GET /api/nsk/v1/booking/ssrs`: Retrieves the current SSRs added to the booking in state.\n- `GET /api/nsk/v1/settings/general/codes`: Determines which roles are allowed to waive fees.\n\nGraphQL endpoint: resellSsrsv2" } ] }, { "info": { "name": "bookings", "type": "folder" }, "items": [ { "info": { "name": "Retrieves the booking from the New Skies server based on the retrieve booking request parameters and any configured\nbooking retrieve strategies. If the booking exists and the search criteria is allowed by one of the configured\nbooking retrieve strategies, the booking will be returned, but not loaded into the web session.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/bookings", "params": [ { "name": "RecordLocator", "value": "", "type": "query", "description": "Record locator being requested.\n " }, { "name": "EmailAddress", "value": "", "type": "query", "description": "The email address of a contact.\n " }, { "name": "Origin", "value": "", "type": "query", "description": "The origin station code.\n " }, { "name": "FirstName", "value": "", "type": "query", "description": "The first name of a passenger or contact.\n " }, { "name": "LastName", "value": "", "type": "query", "description": "The last name of a passenger or contact.\n " }, { "name": "CustomerNumber", "value": "", "type": "query", "description": "One of the passengers customer numbers applied.\n " }, { "name": "DepartureDate", "value": "", "type": "query", "description": "The first journeys departure date.\n " } ] }, "docs": "This endpoint will perform validation using a pre-configured booking retrieve strategy. Custom strategies can\nbe configured in Utilities, and are configurable based on application name.\nTo set up a custom strategy, go to Utilities -> Resource Management. From the \"Resource Management\" screen, go\nto Root -> Web -> dotREZ folder. Right-click on the dotREZ folder and select \"Add Content\". On the \"Add Resource\"\nscreen, set the \"Content Name\" to \"BookingStrategyManagementConfig\". Choose \"XML\" as" }, { "info": { "name": "Gets an itinerary history stateless.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/bookings/:bookingKey/history", "params": [ { "name": "bookingKey", "value": "", "type": "path", "description": "The booking key." }, { "name": "Event", "value": "", "type": "query", "description": "The event that triggered the history entry.\n \nEnumeration values: 0 = Unknown, 1 = ConvertedHistory, 2 = FlightTimeChange, 3 = FlightDesignatorChange, 4 = AssignedSeat, 5 = RemoveSeat, 6 = AddedFlight, 7 = DeletedFlight, 8 = DeletedPassenger, 9 = NameChange, 10 = GroupNameChange, 11 = CancelledTicketing, 12 = ScheduleChange, 13 = AddedPayment, 14 = ServiceFee, 15 = QueuedPnr, 16 = UnqueuedPnr, 17 = DeletedComment, 18 = Divided, 19 = CheckedIn, 20 = CheckedOut, 21 = FareOverride, 22 = AddedBaggage, 23 = ChangedBaggageWeight, 24 = CheckedBaggage, 25 = RemovedBaggage, 26 = BoardedPassenger, 27 = UnboardedPassenger, 28 = ManualAuthorization, 29 = ManualDecline, 30 = UndoCancel, 31 = ItinerarySent, 32 = ContactChange, 33 = SsrAdded, 34 = FlightMoved, 35 = VerifiedDocument, 36 = RemovedVerifiedDocument, 37 = Promotion, 38 = BookingComment, 39 = CancelledSchedule, 40 = CancelServiceFee, 41 = OverrideServiceFee, 42 = AddedRecordLocator, 43 = DeletedRecordLocator, 44 = UpgradeClassOfService, 45 = DowngradeClassOfService, 46 = StandbyPriorityChange, 47 = AssignedTicketNumber, 48 = DeletedTicketNumber, 49 = ConfirmSegmentStatusCodeChange, 50 = CodeshareFlightChanged, 51 = PdsCancel, 52 = PdsPending, 53 = PdsConfirm, 54 = PdsFinalized, 55 = PdsDeclined, 56 = PdsException, 57 = PdsCancelRefused, 58 = PdsCancelUnsuccessful, 59 = Apps, 60 = InhibitedOverride, 61 = PrintedBagTag, 62 = SelfPrintedBagTag, 63 = PrintedBoardingPass, 64 = AddCustomerId, 65 = DeleteCustomerId, 66 = HoldCreated, 67 = HoldRemoved, 68 = HoldChanged, 69 = OverrideCoupon, 70 = PdsSynchronized, 71 = PdsItemremoved, 72 = Reprice, 73 = ChannelOverride, 74 = EmdCreated, 75 = EmdRemoved, 76 = EmdChanged, 77 = ServiceBundle, 78 = PublishedFareOverride, 79 = FareClassRealignment, 80 = AddedDocument, 81 = ChangedDocument, 82 = DeletedPaymentProperties" }, { "name": "LastPageKey", "value": "", "type": "query", "description": "The key of the last booking history item returned.\n " }, { "name": "PageSize", "value": "", "type": "query", "description": "The page size for the response.\n " } ] }, "docs": "GraphQL endpoint: bookingsHistory" }, { "info": { "name": "Gets the current bag tag print history for a booking, stateless.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/bookings/:bookingKey/history/bagTagPrint", "params": [ { "name": "bookingKey", "value": "", "type": "path", "description": "The booking key." }, { "name": "isBagTagSelfPrinted", "value": "", "type": "query", "description": "Whether the bag tag is self printed." } ] }, "docs": "GraphQL endpoint: bookingsBagTagPrintv2" }, { "info": { "name": "Creates a bag tag print history for a booking, stateless.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/bookings/:bookingKey/history/bagTagPrint", "params": [ { "name": "bookingKey", "value": "", "type": "path", "description": "The booking key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Also updates bag's status from Added to AddedPrinted if Self-Tagging Baggage is enabled.\nIn order to see the status of a bag, check bags on a passenger segment.\nThe `Enable Baggage Self-Tagging` in Premium Services and `Write to booking history for bag tag printing` in\nDeparture Control Settings must be enabled in Management Console for self bag-tag printing.\n\nGraphQL endpoints: bookingsBagTagPrintHistoryAdd, bookingsBagTagPrintHistoryAddBatch" }, { "info": { "name": "Gets a flight move history stateless.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/bookings/:bookingKey/history/flightMove", "params": [ { "name": "bookingKey", "value": "", "type": "path", "description": "The booking key." }, { "name": "LastPageKey", "value": "", "type": "query", "description": "The key of the last booking history item returned.\n " }, { "name": "PageSize", "value": "", "type": "query", "description": "The page size for the response.\n " } ] }, "docs": "GraphQL endpoint: bookingsFlightMoveHistory" }, { "info": { "name": "Gets the hold date change history records for a booking.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/bookings/:bookingKey/history/holdDateChange", "params": [ { "name": "bookingKey", "value": "", "type": "path", "description": "The booking key." }, { "name": "Event", "value": "", "type": "query", "description": "The event that triggered the hold date change history entry.\n \nEnumeration values: 66 = Created, 67 = Removed, 68 = Changed" }, { "name": "LastPageKey", "value": "", "type": "query", "description": "The key of the last booking history item returned.\n " }, { "name": "PageSize", "value": "", "type": "query", "description": "The page size for the response.\n " } ] }, "docs": "GraphQL endpoint: bookingsHoldDateChangeHistory" }, { "info": { "name": "Gets the itinerary sent history records for a booking.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/bookings/:bookingKey/history/itinerarySent", "params": [ { "name": "bookingKey", "value": "", "type": "path", "description": "The booking key." }, { "name": "LastPageKey", "value": "", "type": "query", "description": "The key of the last booking history item returned.\n " }, { "name": "PageSize", "value": "", "type": "query", "description": "The page size for the response.\n " } ] }, "docs": "GraphQL endpoint: bookingsItinerarySentHistory" }, { "info": { "name": "Gets a booking's message history, stateless.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/bookings/:bookingKey/history/message", "params": [ { "name": "bookingKey", "value": "", "type": "path", "description": "The booking key." } ] }, "docs": "GraphQL endpoint: bookingsMessageHistory" }, { "info": { "name": "Gets the booking notification history, stateless.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/bookings/:bookingKey/history/notification", "params": [ { "name": "bookingKey", "value": "", "type": "path", "description": "The booking key." } ] }, "docs": "GraphQL endpoint: bookingsNotificationHistory" }, { "info": { "name": "Gets a seat assignment history stateless.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/bookings/:bookingKey/history/seatAssignment", "params": [ { "name": "bookingKey", "value": "", "type": "path", "description": "The booking key." }, { "name": "Event", "value": "", "type": "query", "description": "The event that triggered the seat assignment history entry.\n \nEnumeration values: 4 = AssignedSeat, 5 = RemoveSeat" }, { "name": "LastPageKey", "value": "", "type": "query", "description": "The key of the last booking history item returned.\n " }, { "name": "PageSize", "value": "", "type": "query", "description": "The page size for the response.\n " } ] }, "docs": "GraphQL endpoint: bookingsSeatAssignmentHistory" }, { "info": { "name": "Gets a segment change history stateless.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/bookings/:bookingKey/history/segmentChange", "params": [ { "name": "bookingKey", "value": "", "type": "path", "description": "The booking key." }, { "name": "Event", "value": "", "type": "query", "description": "The event that triggered the seat assignment history entry.\n \nEnumeration values: 6 = AddedFlight, 7 = DeletedFlight" }, { "name": "LastPageKey", "value": "", "type": "query", "description": "The key of the last booking history item returned.\n " }, { "name": "PageSize", "value": "", "type": "query", "description": "The page size for the response.\n " } ] }, "docs": "GraphQL endpoint: bookingsSegmentChangeHistory" }, { "info": { "name": "Adds a booking to a booking queue.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v3/bookings/:bookingKey/queue", "params": [ { "name": "bookingKey", "value": "", "type": "path", "description": "The booking key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: bookingsEnqueuev3" }, { "info": { "name": "Adds a booking to a booking queue.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/bookings/:bookingKey/queue", "params": [ { "name": "bookingKey", "value": "", "type": "path", "description": "The booking key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: bookingsEnqueuev2" }, { "info": { "name": "Removes a booking from a booking queue.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/bookings/:bookingKey/queue", "params": [ { "name": "bookingKey", "value": "", "type": "path", "description": "The booking key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: bookingsDequeuev2" }, { "info": { "name": "Gets the booking queue history for a specific booking.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/bookings/:bookingKey/queue/history", "params": [ { "name": "bookingKey", "value": "", "type": "path", "description": "The booking key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: bookingQueueHistory" }, { "info": { "name": "Retrieves a booking itinerary stateless.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/bookings/:recordLocator", "params": [ { "name": "recordLocator", "value": "", "type": "path", "description": "The record locator." } ] }, "docs": "This endpoint requires a session token and is agent-only.\nThis is a stateless booking endpoint and `LegInfo` is not returned. This is intentional as New Skies does not\nquery schedule data for this call. If this data is needed, please use the stateful booking retrieval endpoint/graph\nroute to get this information.\nYou can also use GET `/api/nsk/v2/trip/info/legs/simple` to get this information.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid perfor" }, { "info": { "name": "Retrieves the booking account and collections based on the record locator.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/bookings/:recordLocator/account", "params": [ { "name": "recordLocator", "value": "", "type": "path", "description": "The record locator." } ] }, "docs": "This endpoint allows agents to see all of the different payment account transactions for the booking.\nSee related endpoint for non agents: /booking/payments/bookingCredit\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: bookingsAccount" }, { "info": { "name": "Creates the booking account based on the record locator and\ndata in the request.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/bookings/:recordLocator/account", "params": [ { "name": "recordLocator", "value": "", "type": "path", "description": "The record locator." } ], "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: bookingsAccountAdd" }, { "info": { "name": "Creates a booking account collection and transaction based on the record\nlocator and data in the request.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/bookings/:recordLocator/account/collection", "params": [ { "name": "recordLocator", "value": "", "type": "path", "description": "The record locator." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint will create a new account collection and a transaction if no collection exists or\nno matching collection is found. An account collection is unique based on the transaction code\nand the expiration date. If a matching collection is found, a transaction for that collection\nis generated and the account collection will be updated.\nSee /api/nsk/v1/resources/accountTransactionCodes for a list of available account transaction codes.\nIMPORTANT: This endpoint should NOT be called concurren" }, { "info": { "name": "Retrieves the booking account collection transactions based on the record\nlocator, the account collection key, and the request data.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/bookings/:recordLocator/account/collection/:accountCollectionKey/transactions", "params": [ { "name": "recordLocator", "value": "", "type": "path", "description": "The record locator." }, { "name": "accountCollectionKey", "value": "", "type": "path", "description": "The account collection key." }, { "name": "StartTime", "value": "", "type": "query", "description": "The starting date and time of the date range to search in.\n " }, { "name": "EndTime", "value": "", "type": "query", "description": "The end date and time of the date range to search in.\n " }, { "name": "SortByNewest", "value": "", "type": "query", "description": "Optional filter to sort results by newest.\n " }, { "name": "PageSize", "value": "", "type": "query", "description": "Used to specify the number of records to return.\n " }, { "name": "PageIndex", "value": "", "type": "query", "description": "Represents the index of the requested paged item.\n " } ] }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: bookingsAccountTransactions" }, { "info": { "name": "Creates a booking account collection transaction based on the record locator,\nthe account collection key, and data in the request.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/bookings/:recordLocator/account/collection/:accountCollectionKey/transactions", "params": [ { "name": "recordLocator", "value": "", "type": "path", "description": "The record locator." }, { "name": "accountCollectionKey", "value": "", "type": "path", "description": "The account collection key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint will add a transaction to an existing account collection.\nIf there are no account collections, or the account collection key does\nnot match an existing collection, the request will fail.\nTo add a new credit, see /api/nsk/v1/bookings/{recordLocator}/account/collection.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: bookingsAccountTransactionsAdd" }, { "info": { "name": "Retrieves the booking account collection transactions based on the record locator, the account collection key, and the request data.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/bookings/:recordLocator/account/collection/:accountCollectionKey/transactions", "params": [ { "name": "recordLocator", "value": "", "type": "path", "description": "The record locator." }, { "name": "accountCollectionKey", "value": "", "type": "path", "description": "The account collection key." }, { "name": "StartDate", "value": "", "type": "query", "description": "The starting date and time of the date range to search in.\n " }, { "name": "EndDate", "value": "", "type": "query", "description": "The end date and time of the date range to search in.\n " }, { "name": "SortByNewest", "value": "", "type": "query", "description": "Optional filter to sort results by newest.\n " }, { "name": "PageSize", "value": "", "type": "query", "description": "Used to specify the number of records to return.\n " }, { "name": "LastPageKey", "value": "", "type": "query", "description": "The last page key where to start paged query.\n " } ] }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.`\n\nGraphQL endpoint: bookingsAccountTransactionsv2" }, { "info": { "name": "Updates the booking account status.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/bookings/:recordLocator/account/status", "params": [ { "name": "recordLocator", "value": "", "type": "path", "description": "The record locator." }, { "name": "status", "value": "", "type": "query", "description": "The allowed account status. \nEnumeration values: 0 = Open, 1 = Closed, 2 = AgencyInactive, 3 = Unknown" } ] }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: bookingsAccountStatusSet" }, { "info": { "name": "Retrieves all of the transactions for all of the collections for the booking.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/bookings/:recordLocator/account/transactions", "params": [ { "name": "recordLocator", "value": "", "type": "path", "description": "The record locator." }, { "name": "StartTime", "value": "", "type": "query", "description": "The starting date and time of the date range to search in.\n " }, { "name": "EndTime", "value": "", "type": "query", "description": "The end date and time of the date range to search in.\n " }, { "name": "SortByNewest", "value": "", "type": "query", "description": "Optional filter to sort results by newest.\n " }, { "name": "PageSize", "value": "", "type": "query", "description": "Used to specify the number of records to return.\n " }, { "name": "PageIndex", "value": "", "type": "query", "description": "Represents the index of the requested paged item.\n " } ] }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: bookingsAccountAllTransactions" }, { "info": { "name": "Retrieves all of the transactions for the booking.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/bookings/:recordLocator/account/transactions", "params": [ { "name": "recordLocator", "value": "", "type": "path", "description": "The record locator." }, { "name": "StartDate", "value": "", "type": "query", "description": "The starting date and time of the date range to search in.\n " }, { "name": "EndDate", "value": "", "type": "query", "description": "The end date and time of the date range to search in.\n " }, { "name": "SortByNewest", "value": "", "type": "query", "description": "Optional filter to sort results by newest.\n " }, { "name": "PageSize", "value": "", "type": "query", "description": "Used to specify the number of records to return.\n " }, { "name": "LastPageKey", "value": "", "type": "query", "description": "The last page key where to start paged query.\n " } ] }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.`\n\nGraphQL endpoint: bookingsAccountAllTransactionsv2" }, { "info": { "name": "Gets children record locators of a booking not in state.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/bookings/:recordLocator/children", "params": [ { "name": "recordLocator", "value": "", "type": "path", "description": "The record locator to find children bookings for." } ] }, "docs": "A booking gets children bookings as a result of a booking divide operation.\nThis endpoint returns a list of children booking record locators.\n\nGraphQL endpoint: childrenRecordLocators" }, { "info": { "name": "Adds a comment to a booking not in state.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v3/bookings/:recordLocator/comments", "params": [ { "name": "recordLocator", "value": "", "type": "path", "description": "The record locator." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Requires agent permissions.\nNote: To add comments and log added comments to GDS history please use POST or PUT /api/nsk/v3/booking and set\nSendToBookingSource to true\nGDS comments cannot be logged statelessly.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: bookingsCommentsAddv3" }, { "info": { "name": "Sends itinerary notification via email.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/bookings/:recordLocator/email", "params": [ { "name": "recordLocator", "value": "", "type": "path", "description": "The record locator." } ] }, "docs": "This method will always send itinerary notifications via email,\nregardless of the chosen distributionOption on the contact.\n\nGraphQL endpoint: bookingsAddEmailNotification" }, { "info": { "name": "Replaces an existing fare price with an amount specified.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/bookings/:recordLocator/fareOverride/journey/:journeyKey", "params": [ { "name": "recordLocator", "value": "", "type": "path", "description": "The booking key." }, { "name": "journeyKey", "value": "", "type": "path", "description": "The journeyKey." } ], "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: bookingsFareOverrideAdd" }, { "info": { "name": "Confirms the passenger fee for a given booking.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/bookings/:recordLocator/fees/:passengerFeeKey/confirm", "params": [ { "name": "recordLocator", "value": "", "type": "path", "description": "The record locator." }, { "name": "passengerFeeKey", "value": "", "type": "path", "description": "The passenger fee key." } ] }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: confirmPassengerFee" }, { "info": { "name": "Moves a journey on a stateless booking to a different journey.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/bookings/:recordLocator/journey", "params": [ { "name": "recordLocator", "value": "", "type": "path", "description": "The record locator." } ], "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: bookingsMoveJourney" }, { "info": { "name": "Moves a journey on a stateless booking to a different journey.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/bookings/:recordLocator/journey", "params": [ { "name": "recordLocator", "value": "", "type": "path", "description": "The record locator." } ], "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: bookingsMoveJourneyv2" }, { "info": { "name": "Combines a collection of journeys represented by the \"ToJourneyKeys\" into one journey and attempts to create an ad\nhoc connection between the journeys, and then move to the new journey.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/bookings/:recordLocator/journey/adHocMove", "params": [ { "name": "recordLocator", "value": "", "type": "path", "description": "The record locator." } ], "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\nThis endpoint does not validate that the submitted journeys are valid for ad hoc connections. It is the\nresponsibility of the end user to ensure that the ad hoc connection is valid.\nSubmit the journey keys in order in the \"ToJourneyKeys\" list, with the origin journey appearing first, and\nthe final destination journey appearing last in the list. The segments from each valid j" }, { "info": { "name": "Sends itinerary notification.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/bookings/:recordLocator/notification", "params": [ { "name": "recordLocator", "value": "", "type": "path", "description": "The record locator of the booking." } ] }, "docs": "Itinerary will be sent using the method set on the contact's distributionOption field.\n\nGraphQL endpoint: bookingsAddNotificationv2" }, { "info": { "name": "Gets the document check status for a specific passenger if there are any on a specific booking.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/dcs/v1/bookings/:recordLocator/passengers/:passengerKey/documents/check", "params": [ { "name": "recordLocator", "value": "", "type": "path", "description": "The record locator of the associated booking." }, { "name": "passengerKey", "value": "", "type": "path", "description": "The passenger key." } ] }, "docs": "Requires a committed booking in state. Requires document check to be enabled in government security configuration.\n\nPerforms document check and returns the results as documentCheckStatus.\nMore detailed information is intentionally not provided for security reasons.\nThe designers of the client application will need to determine what to do with the different responses,\nin most cases the passenger will need to be assisted by an airport agent.\nFor more specific requirements check the following endpo" }, { "info": { "name": "Gets the document check status for a specific passenger's infant if there are any on a specific booking.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/dcs/v1/bookings/:recordLocator/passengers/:passengerKey/infant/documents/check", "params": [ { "name": "recordLocator", "value": "", "type": "path", "description": "The record locator of the associated booking." }, { "name": "passengerKey", "value": "", "type": "path", "description": "The passenger key." } ] }, "docs": "Requires a committed booking in state. Requires document check to be enabled in government security configuration.\n\nPerforms document check and returns the results as documentCheckStatus.\nMore detailed information is intentionally not provided for security reasons.\nThe designers of the client application will need to determine what to do with the different responses,\nin most cases the passenger will need to be assisted by an airport agent.\nFor more specific requirements check the following endpo" }, { "info": { "name": "Agent only.\nAdds a seat assignment to a specific passenger on a booking.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/bookings/:recordLocator/passengers/:passengerKey/seats/:unitKey", "params": [ { "name": "recordLocator", "value": "", "type": "path", "description": "The record locator." }, { "name": "passengerKey", "value": "", "type": "path", "description": "The passenger key." }, { "name": "unitKey", "value": "", "type": "path", "description": "The unit key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Agent only.\nThis endpoint actively checks whether the passenger has a seat. If the passenger does\nhave a seat, it will delete the current seat the passenger occupies and add the requested\none. This may result in slightly slower response times.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoints: bookingsSeatAdd, bookingsSeatsAdd" }, { "info": { "name": "Agent only.\nDeletes a seat assignment from a specific passenger on a booking.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/bookings/:recordLocator/passengers/:passengerKey/seats/:unitKey", "params": [ { "name": "recordLocator", "value": "", "type": "path", "description": "The record locator." }, { "name": "passengerKey", "value": "", "type": "path", "description": "The passenger key." }, { "name": "unitKey", "value": "", "type": "path", "description": "The unique unit key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Agent only.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoints: bookingsSeatDelete, bookingsSeatsDelete" }, { "info": { "name": "Retrieves the details for the booking queues of a specific booking.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/bookings/:recordLocator/queues/:queueCode", "params": [ { "name": "recordLocator", "value": "", "type": "path", "description": "The record locator." }, { "name": "queueCode", "value": "", "type": "path", "description": "The queue code." } ], "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: bookingsQueues" }, { "info": { "name": "Retrieves a booking itinerary stateless.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/bookings/byBookingId/:bookingId", "params": [ { "name": "bookingId", "value": "", "type": "path", "description": "The New Skies Booking ID." } ] }, "docs": "This endpoint requires a session token and is agent-only.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\nIf no booking associated with the record locator is found, an HTTP 404 `NotFound` will be returned.\n\nGraphQL endpoint: bookingsByBookingId" }, { "info": { "name": "Removes the checkin status of passengers for a specific journey stateless.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/bookings/checkin/:recordLocator/journey/:journeyKey", "params": [ { "name": "recordLocator", "value": "", "type": "path", "description": "The booking record locator to look up the journey." }, { "name": "journeyKey", "value": "", "type": "path", "description": "The journey key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: checkInByJourneyDelete" }, { "info": { "name": "Checks in a collection of passengers to a specific journey stateless.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v3/bookings/checkin/:recordLocator/journey/:journeyKey", "params": [ { "name": "recordLocator", "value": "", "type": "path", "description": "The booking record locator to look up the journey." }, { "name": "journeyKey", "value": "", "type": "path", "description": "The journey key of the journey to check into." } ], "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n- When debug mode is disabled, warning and error messages will be masked if the `SystemOptions.HideErrorMessages`\nis set to true.\n- When debug mode is disabled, warning and error messages will be returned to agents only if the\n`SystemOptions.HideErrorMessages` is set to false.\n\nGraphQL endpoint: checkInByJourneyv3" }, { "info": { "name": "Gets the checkin pre-validation requirements for a specific journey.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/bookings/checkin/:recordLocator/journey/:journeyKey/requirements", "params": [ { "name": "recordLocator", "value": "", "type": "path", "description": "The record locator of the booking." }, { "name": "journeyKey", "value": "", "type": "path", "description": "The journey key to be pre validate checkin with." } ] }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: checkInRequirementsByJourney" }, { "info": { "name": "Gets the checkin pre-validation requirements for a specific journey version 2.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/bookings/checkin/:recordLocator/journey/:journeyKey/requirements", "params": [ { "name": "recordLocator", "value": "", "type": "path", "description": "The record locator of the booking." }, { "name": "journeyKey", "value": "", "type": "path", "description": "The journey key to be pre validate checkin with." } ] }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: checkInRequirementsByJourneyv2" }, { "info": { "name": "Gets the passengers lift status stateless for a specific journey based on the record locator.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/bookings/checkin/:recordLocator/journey/:journeyKey/status", "params": [ { "name": "recordLocator", "value": "", "type": "path", "description": "The record locator in reference to the journey." }, { "name": "journeyKey", "value": "", "type": "path", "description": "The journey key in reference." } ] }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: checkInStatusByJourney" }, { "info": { "name": "Removes the checkin status of passengers for a specific journey's segment stateless.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/bookings/checkin/:recordLocator/segment/:segmentKey", "params": [ { "name": "recordLocator", "value": "", "type": "path", "description": "The booking record locator to look up the journeys segment." }, { "name": "segmentKey", "value": "", "type": "path", "description": "The segment key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: checkInBySegmentDelete" }, { "info": { "name": "Checks in a collection of passengers to a specific journeys segment stateless.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v3/bookings/checkin/:recordLocator/segment/:segmentKey", "params": [ { "name": "recordLocator", "value": "", "type": "path", "description": "The booking record locator to look up the journeys segment." }, { "name": "segmentKey", "value": "", "type": "path", "description": "The segment key of the segment to check into." } ], "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n- When debug mode is disabled, warning and error messages will be masked if the `SystemOptions.HideErrorMessages`\nis set to true.\n- When debug mode is disabled, warning and error messages will be returned to agents only if the\n`SystemOptions.HideErrorMessages` is set to false.\n\nGraphQL endpoint: checkInBySegmentv3" }, { "info": { "name": "Gets the checkin pre-validation requirements for a specific bookings journeys segment.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/bookings/checkin/:recordLocator/segment/:segmentKey/requirements", "params": [ { "name": "recordLocator", "value": "", "type": "path", "description": "The record locator of the booking." }, { "name": "segmentKey", "value": "", "type": "path", "description": "The segment key to pre validate checkin with." } ] }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: checkInRequirementsBySegment" }, { "info": { "name": "Gets the checkin pre-validation requirements for a specific bookings journeys segment version 2.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/bookings/checkin/:recordLocator/segment/:segmentKey/requirements", "params": [ { "name": "recordLocator", "value": "", "type": "path", "description": "The record locator of the booking." }, { "name": "segmentKey", "value": "", "type": "path", "description": "The segment key to pre validate checkin with." } ] }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: checkInRequirementsBySegmentv2" }, { "info": { "name": "Gets the passengers lift status stateless for a specific segment based on the record locator.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/bookings/checkin/:recordLocator/segment/:segmentKey/status", "params": [ { "name": "recordLocator", "value": "", "type": "path", "description": "The record locator in reference to the journey." }, { "name": "segmentKey", "value": "", "type": "path", "description": "The segment key in reference." } ] }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: checkInStatusBySegment" }, { "info": { "name": "Queues the bookings by inventory leg.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/bookings/queues", "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: bookingQueuesByInventoryLeg" }, { "info": { "name": "Removes a booking from the specified booking queue item.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/bookings/queues/:bookingQueueKey", "params": [ { "name": "bookingQueueKey", "value": "", "type": "path", "description": "The unique key of the booking queue to dequeue from." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: bookingsDequeueByKey" }, { "info": { "name": "Retrieves the booking queue items associated with the queue code.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/bookings/queues/:queueCode/items", "params": [ { "name": "queueCode", "value": "", "type": "path", "description": "The queue code." }, { "name": "SubQueueCode", "value": "", "type": "query", "description": "The sub queue code.\n " }, { "name": "StartDate", "value": "", "type": "query", "description": "The start date.\n " }, { "name": "EndDate", "value": "", "type": "query", "description": "The end date.\n " }, { "name": "QueueEventType", "value": "", "type": "query", "description": "The queue event type.\n \nEnumeration values: 0 = Default, 1 = BookingBalanceDue, 2 = BookingNegativeBalance, 3 = BookingCustomerComment, 4 = DeclinedPaymentInitial, 5 = DeclinedPaymentChange, 6 = FareOverride, 7 = ScheduleTimeChange, 8 = ScheduleTimeChangeMisconnect, 9 = ScheduleCancellation, 10 = FlightDesignatorChange, 11 = ReaccommodationMove, 12 = GdsCancelWithPendingPayment, 13 = InvalidPriceStatusOverride, 14 = FareRestrictionOverride, 15 = HeldBookings, 16 = InvalidPriceStatus, 17 = Watchlist, 18 = NonFlightServiceFee, 19 = NotAllTicketNumbersReceived, 20 = BookingSegmentOversold, 21 = ReaccommodationCancel, 22 = ExternalSsrAutoConfirmed, 23 = OpCarrierSegUpdate, 24 = OpCarrierSsrUpdate, 25 = OpCarrierOtherUpdate, 26 = NameChangeNotAllowed, 27 = InboundAscNotProcessed, 28 = OpCarrierInformationChange, 29 = BookingComponentUpdate, 30 = GroupBookings, 31 = BankDirectPnrOutOfBalance, 32 = NoSeatAssigned, 33 = SeatNumberChange, 34 = SsrNotSupportedOnNewSeat, 35 = FewerSeatPreferencesMetOnNewSeat, 36 = AosUnableToConfirmCancel, 37 = ETicketIssue, 38 = ETicketFollowup, 39 = InvoluntaryFlyAhead, 40 = ManualClearanceOnOutage, 41 = UnbalancedPoints, 42 = OpCarrierTimeChange, 43 = OaCarrierTimeChange, 44 = VoluntaryFlightChange, 45 = InvoluntaryFlightChange, 46 = HoldCancellationFailed, 47 = ScheduleTimeChangeWithDynamicQueueCode, 48 = ReaccommodationMoveWithDynamicQueueCode, 49 = ItineraryIntegrity, 50 = ReducePartyNotProcessed, 51 = CheckedPassengerUpdate, 52 = MustBeSeatGroupViolation, 57 = NameChangeWithinRule, 58 = IncompletePassengerEMDCoupon, 59 = ASVCUpdateFailed, 60 = FailedFareClassRealignment, 61 = ScheduleTimeChangeMisconnectBelowMinimum, 62 = ScheduleTimeChangeMisconnectAboveMaximum, 63 = OpCarrierMisconnect, 64 = InventoryQueuing, 65 = SelfServiceAsm, 66 = SelfServiceDelay, 67 = SelfServiceFlightCancellation, 68 = SelfServiceIrop, 69 = SelfServiceScheduleChange, 70 = SelfServiceTimeChange, 71 = AosAddOrCancelNotSuccessful, 72 = MissingGdsFareFamily, 73 = ChangeCabinQueue, 74 = PendingPaymentQueue, 75 = TicketDisplayToDetermineIncludedServiceBundleFailed, 76 = DuplicateTicketsInBooking, 77 = TicketCouponUpdateQueue, 78 = ETicketRefund, 79 = ExternalEticketVoidCheck, 80 = ExternalEticketVoidCheckFollowUp, 81 = NoAssignedSeatOnNewFlightFromEquipmentChange" }, { "name": "PageSize", "value": "", "type": "query", "description": "The number of records to be retrieved per page.\nTo retrieve the next set of records, use the endpoint again with the lastIndex set.\n " }, { "name": "LastIndex", "value": "", "type": "query", "description": "The last row retrieved. This is used for paging.\n " } ] }, "docs": "GraphQL endpoint: bookingQueueItemsv2" }, { "info": { "name": "Retrieves an itinerary quote based on the request.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/bookings/quote", "body": { "type": "json", "data": "{}" } }, "docs": "Although this endpoint behaves like a GET, POST is used to reduce the limitations resulting from URL length issues.\nItinerary is a stateless booking and not tied to the logged-in user.\n\nThe `IncludeServiceBundle` parameter defaults to `false` if not supplied.\n\nGraphQL endpoint: bookingsQuotev2" }, { "info": { "name": "Find booking by agency.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/bookings/searchByAgency", "params": [ { "name": "OrganizationCode", "value": "", "type": "query", "description": "OrganizationCode represents the organization associated with the agent who created\nthe booking.\n " }, { "name": "FirstName", "value": "", "type": "query", "description": "The first name of a passenger.\n " }, { "name": "LastName", "value": "", "type": "query", "description": "The last name of a passenger.\n " }, { "name": "PhoneticSearch", "value": "", "type": "query", "description": "Whether or not to do a phonetic search of the last name.\n " }, { "name": "Filters.PageSize", "value": "", "type": "query", "description": "The number of items to return for the request.\n " }, { "name": "Filters.LastIndex", "value": "", "type": "query", "description": "The last booking index (used for paging).\n " }, { "name": "Filters.FlightNumber", "value": "", "type": "query", "description": "Filter by the flight number.\n " }, { "name": "Filters.DepartureDate", "value": "", "type": "query", "description": "The first journeys departure date.\n " }, { "name": "Filters.Destination", "value": "", "type": "query", "description": "Filter by the destination code.\n " }, { "name": "Filters.Origin", "value": "", "type": "query", "description": "Filter by the departure code.\n " }, { "name": "Filters.SourceOrganization", "value": "", "type": "query", "description": "Filter by the organization associated with the booking. For example the\ntravel agency associated with this booking.\n " }, { "name": "Filters.OrganizationGroupCode", "value": "", "type": "query", "description": "Filter by the organization group code to find.\n " }, { "name": "Filters.SearchArchive", "value": "", "type": "query", "description": "Whether or not to search the booking archive.\n " } ] }, "docs": "GraphQL endpoint: searchByAgencyv2" }, { "info": { "name": "Find booking by agent.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/bookings/searchByAgent", "params": [ { "name": "AgentId", "value": "", "type": "query", "description": "The agent identifier.\n " }, { "name": "FirstName", "value": "", "type": "query", "description": "The first name of a passenger.\n " }, { "name": "LastName", "value": "", "type": "query", "description": "The last name of a passenger.\n " }, { "name": "PhoneticSearch", "value": "", "type": "query", "description": "Whether or not to do a phonetic search.\n " }, { "name": "Filters.PageSize", "value": "", "type": "query", "description": "The number of items to return for the request.\n " }, { "name": "Filters.LastIndex", "value": "", "type": "query", "description": "The last booking index (used for paging).\n " }, { "name": "Filters.FlightNumber", "value": "", "type": "query", "description": "Filter by the flight number.\n " }, { "name": "Filters.DepartureDate", "value": "", "type": "query", "description": "The first journeys departure date.\n " }, { "name": "Filters.Destination", "value": "", "type": "query", "description": "Filter by the destination code.\n " }, { "name": "Filters.Origin", "value": "", "type": "query", "description": "Filter by the departure code.\n " }, { "name": "Filters.SourceOrganization", "value": "", "type": "query", "description": "Filter by the organization associated with the booking. For example the\ntravel agency associated with this booking.\n " }, { "name": "Filters.OrganizationGroupCode", "value": "", "type": "query", "description": "Filter by the organization group code to find.\n " }, { "name": "Filters.SearchArchive", "value": "", "type": "query", "description": "Whether or not to search the booking archive.\n " } ] }, "docs": "GraphQL endpoint: searchByAgentv2" }, { "info": { "name": "Find booking by the agent code.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/bookings/searchByAgentCode", "params": [ { "name": "AgentCode", "value": "", "type": "query", "description": "The agent code (name) that created the booking.\n " }, { "name": "DomainCode", "value": "", "type": "query", "description": "The domain code to find.\n " }, { "name": "FirstName", "value": "", "type": "query", "description": "The first name of a passenger.\n " }, { "name": "LastName", "value": "", "type": "query", "description": "The last name of a passenger.\n " }, { "name": "PhoneticSearch", "value": "", "type": "query", "description": "Whether or not to do a phonetic search.\n " }, { "name": "Filters.PageSize", "value": "", "type": "query", "description": "The number of items to return for the request.\n " }, { "name": "Filters.LastIndex", "value": "", "type": "query", "description": "The last booking index (used for paging).\n " }, { "name": "Filters.FlightNumber", "value": "", "type": "query", "description": "Filter by the flight number.\n " }, { "name": "Filters.DepartureDate", "value": "", "type": "query", "description": "The first journeys departure date.\n " }, { "name": "Filters.Destination", "value": "", "type": "query", "description": "Filter by the destination code.\n " }, { "name": "Filters.Origin", "value": "", "type": "query", "description": "Filter by the departure code.\n " }, { "name": "Filters.SourceOrganization", "value": "", "type": "query", "description": "Filter by the organization associated with the booking. For example the\ntravel agency associated with this booking.\n " }, { "name": "Filters.OrganizationGroupCode", "value": "", "type": "query", "description": "Filter by the organization group code to find.\n " }, { "name": "Filters.SearchArchive", "value": "", "type": "query", "description": "Whether or not to search the booking archive.\n " } ] }, "docs": "GraphQL endpoint: searchByAgentCodev2" }, { "info": { "name": "Find booking by a bag tag.\nThe StartUtc needs to be within 7 days before the created date of the booking.\nIf the StartUtc is set to DateTime.MinValue (1/1/0001) or not set at all, the value will be set to the current\ndate, UTC.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v3/bookings/searchByBagTag", "params": [ { "name": "BagTag", "value": "", "type": "query", "description": "One of the OS tag number.\n " }, { "name": "StartUtc", "value": "", "type": "query", "description": "The OS tag start date. If not set or set to DateTime.MinValue (1/1/0001), will default to current date, UTC.\nThis date needs to be within 7 days before the created date of the booking.\n " }, { "name": "PageSize", "value": "", "type": "query", "description": "The number of items to return for the request.\n " }, { "name": "LastIndex", "value": "", "type": "query", "description": "The last booking index (used for paging).\n " }, { "name": "SearchArchive", "value": "", "type": "query", "description": "Whether or not to search the booking archive.\n " } ] }, "docs": "GraphQL endpoint: searchByBagTagv3" }, { "info": { "name": "Find booking by contact.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/bookings/searchByContact", "params": [ { "name": "FirstName", "value": "", "type": "query", "description": "The first name of a passenger or contact.\n " }, { "name": "LastName", "value": "", "type": "query", "description": "The last name of a passenger or contact.\n " }, { "name": "RecordLocator", "value": "", "type": "query", "description": "Record locator being requested.\n " }, { "name": "PhoneNumber", "value": "", "type": "query", "description": "One of the applied phone numbers to a passenger or contact.\n " }, { "name": "EmailAddress", "value": "", "type": "query", "description": "The email address of a contact.\n " }, { "name": "SourceOrganization", "value": "", "type": "query", "description": "Filter by the organization associated with the booking. For example the\ntravel agency associated with this booking.\n " }, { "name": "OrganizationCode", "value": "", "type": "query", "description": "OrganizationCode represents the organization associated with the agent who created\nthe booking.\n " }, { "name": "OrganizationGroupCode", "value": "", "type": "query", "description": "Filter by the organization group code to find.\n " }, { "name": "SearchArchive", "value": "", "type": "query", "description": "Whether or not to search the booking archive.\n " }, { "name": "PageSize", "value": "", "type": "query", "description": "The number of items to return for the request.\n " }, { "name": "LastIndex", "value": "", "type": "query", "description": "The last booking index (used for paging).\n " } ] }, "docs": "GraphQL endpoint: searchByContactv2" }, { "info": { "name": "Find booking by contact customer number.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/bookings/searchByContactCustomerNumber", "params": [ { "name": "ContactCustomerNumber", "value": "", "type": "query", "description": "One of the contacts customer number applied.\n " }, { "name": "AgentId", "value": "", "type": "query", "description": "The agent identifier.\n " }, { "name": "OrganizationCode", "value": "", "type": "query", "description": "OrganizationCode represents the organization associated with the agent who created\nthe booking.\n " }, { "name": "Filters.PageSize", "value": "", "type": "query", "description": "The number of items to return for the request.\n " }, { "name": "Filters.LastIndex", "value": "", "type": "query", "description": "The last booking index (used for paging).\n " }, { "name": "Filters.FlightNumber", "value": "", "type": "query", "description": "Filter by the flight number.\n " }, { "name": "Filters.DepartureDate", "value": "", "type": "query", "description": "The first journeys departure date.\n " }, { "name": "Filters.Destination", "value": "", "type": "query", "description": "Filter by the destination code.\n " }, { "name": "Filters.Origin", "value": "", "type": "query", "description": "Filter by the departure code.\n " }, { "name": "Filters.SourceOrganization", "value": "", "type": "query", "description": "Filter by the organization associated with the booking. For example the\ntravel agency associated with this booking.\n " }, { "name": "Filters.OrganizationGroupCode", "value": "", "type": "query", "description": "Filter by the organization group code to find.\n " }, { "name": "Filters.SearchArchive", "value": "", "type": "query", "description": "Whether or not to search the booking archive.\n " } ] }, "docs": "GraphQL endpoint: searchByContactCustomerNumberv2" }, { "info": { "name": "Find booking by credit card number.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/bookings/searchByCreditCard", "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint behaves like a GET but is masked as a POST.\n\nGraphQL endpoint: searchByCreditCardv2" }, { "info": { "name": "Find booking by customer number.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/bookings/searchByCustomerNumber", "params": [ { "name": "CustomerNumber", "value": "", "type": "query", "description": "One of the contacts customer number applied.\n " }, { "name": "AgentId", "value": "", "type": "query", "description": "The agent identifier.\n " }, { "name": "OrganizationCode", "value": "", "type": "query", "description": "OrganizationCode represents the organization associated with the agent who created\nthe booking.\n " }, { "name": "Filters.PageSize", "value": "", "type": "query", "description": "The number of items to return for the request.\n " }, { "name": "Filters.LastIndex", "value": "", "type": "query", "description": "The last booking index (used for paging).\n " }, { "name": "Filters.FlightNumber", "value": "", "type": "query", "description": "Filter by the flight number.\n " }, { "name": "Filters.DepartureDate", "value": "", "type": "query", "description": "The first journeys departure date.\n " }, { "name": "Filters.Destination", "value": "", "type": "query", "description": "Filter by the destination code.\n " }, { "name": "Filters.Origin", "value": "", "type": "query", "description": "Filter by the departure code.\n " }, { "name": "Filters.SourceOrganization", "value": "", "type": "query", "description": "Filter by the organization associated with the booking. For example the\ntravel agency associated with this booking.\n " }, { "name": "Filters.OrganizationGroupCode", "value": "", "type": "query", "description": "Filter by the organization group code to find.\n " }, { "name": "Filters.SearchArchive", "value": "", "type": "query", "description": "Whether or not to search the booking archive.\n " } ] }, "docs": "GraphQL endpoint: searchByCustomerNumberv2" }, { "info": { "name": "Find booking by date.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/bookings/searchByDate", "params": [ { "name": "StartDateUtc", "value": "", "type": "query", "description": "The booking date start search.\n " }, { "name": "EndDateUtc", "value": "", "type": "query", "description": "The booking date end search.\n " }, { "name": "Filters.PageSize", "value": "", "type": "query", "description": "The number of items to return for the request.\n " }, { "name": "Filters.LastIndex", "value": "", "type": "query", "description": "The last booking index (used for paging).\n " }, { "name": "Filters.FlightNumber", "value": "", "type": "query", "description": "Filter by the flight number.\n " }, { "name": "Filters.DepartureDate", "value": "", "type": "query", "description": "The first journeys departure date.\n " }, { "name": "Filters.Destination", "value": "", "type": "query", "description": "Filter by the destination code.\n " }, { "name": "Filters.Origin", "value": "", "type": "query", "description": "Filter by the departure code.\n " }, { "name": "Filters.SourceOrganization", "value": "", "type": "query", "description": "Filter by the organization associated with the booking. For example the\ntravel agency associated with this booking.\n " }, { "name": "Filters.OrganizationGroupCode", "value": "", "type": "query", "description": "Filter by the organization group code to find.\n " }, { "name": "Filters.SearchArchive", "value": "", "type": "query", "description": "Whether or not to search the booking archive.\n " } ] }, "docs": "GraphQL endpoint: searchByDatev2" }, { "info": { "name": "Find booking by document.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/bookings/searchByDocument", "params": [ { "name": "Document.DocumentNumber", "value": "", "type": "query", "description": "One of the passengers applied travel document number.\n " }, { "name": "Document.DocumentTypeCode", "value": "", "type": "query", "description": "One of the passengers applied travel document type code.\n " }, { "name": "Filters.PageSize", "value": "", "type": "query", "description": "The number of items to return for the request.\n " }, { "name": "Filters.LastIndex", "value": "", "type": "query", "description": "The last booking index (used for paging).\n " }, { "name": "Filters.FlightNumber", "value": "", "type": "query", "description": "Filter by the flight number.\n " }, { "name": "Filters.DepartureDate", "value": "", "type": "query", "description": "The first journeys departure date.\n " }, { "name": "Filters.Destination", "value": "", "type": "query", "description": "Filter by the destination code.\n " }, { "name": "Filters.Origin", "value": "", "type": "query", "description": "Filter by the departure code.\n " }, { "name": "Filters.SourceOrganization", "value": "", "type": "query", "description": "Filter by the organization associated with the booking. For example the\ntravel agency associated with this booking.\n " }, { "name": "Filters.OrganizationGroupCode", "value": "", "type": "query", "description": "Filter by the organization group code to find.\n " }, { "name": "Filters.SearchArchive", "value": "", "type": "query", "description": "Whether or not to search the booking archive.\n " } ] }, "docs": "GraphQL endpoint: searchByDocumentv2" }, { "info": { "name": "Find booking by email.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/bookings/searchByEmail", "params": [ { "name": "EmailAddress", "value": "", "type": "query", "description": "The email address of a contact.\n " }, { "name": "AgentId", "value": "", "type": "query", "description": "The agent identifier.\n " }, { "name": "PhoneticSearch", "value": "", "type": "query", "description": "Whether or not to do a phonetic search.\n " }, { "name": "Filters.PageSize", "value": "", "type": "query", "description": "The number of items to return for the request.\n " }, { "name": "Filters.LastIndex", "value": "", "type": "query", "description": "The last booking index (used for paging).\n " }, { "name": "Filters.FlightNumber", "value": "", "type": "query", "description": "Filter by the flight number.\n " }, { "name": "Filters.DepartureDate", "value": "", "type": "query", "description": "The first journeys departure date.\n " }, { "name": "Filters.Destination", "value": "", "type": "query", "description": "Filter by the destination code.\n " }, { "name": "Filters.Origin", "value": "", "type": "query", "description": "Filter by the departure code.\n " }, { "name": "Filters.SourceOrganization", "value": "", "type": "query", "description": "Filter by the organization associated with the booking. For example the\ntravel agency associated with this booking.\n " }, { "name": "Filters.OrganizationGroupCode", "value": "", "type": "query", "description": "Filter by the organization group code to find.\n " }, { "name": "Filters.SearchArchive", "value": "", "type": "query", "description": "Whether or not to search the booking archive.\n " } ] }, "docs": "GraphQL endpoint: searchByEmailv2" }, { "info": { "name": "Used to search the list of bookings that have used the account from the payment. Only External Payments\nshould be used for searching.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/bookings/searchByExternalPayment", "params": [ { "name": "RecordLocator", "value": "", "type": "query", "description": "The record locator of a booking.\n " }, { "name": "PaymentKey", "value": "", "type": "query", "description": "The payment key of a specific payment under a booking.\n " }, { "name": "PageSize", "value": "", "type": "query", "description": "The number of items to return for the request.\n " }, { "name": "LastIndex", "value": "", "type": "query", "description": "The last booking index (used for paging).\n " }, { "name": "FlightNumber", "value": "", "type": "query", "description": "Filter by the flight number.\n " }, { "name": "DepartureDate", "value": "", "type": "query", "description": "The first journeys departure date.\n " }, { "name": "Destination", "value": "", "type": "query", "description": "Filter by the destination code.\n " }, { "name": "Origin", "value": "", "type": "query", "description": "Filter by the departure code.\n " }, { "name": "SourceOrganization", "value": "", "type": "query", "description": "Filter by the organization associated with the booking. For example the\ntravel agency associated with this booking.\n " }, { "name": "OrganizationGroupCode", "value": "", "type": "query", "description": "Filter by the organization group code to find.\n " } ] }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: searchByExternalPayment" }, { "info": { "name": "Find booking by last name.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/bookings/searchByLastName", "params": [ { "name": "LastName", "value": "", "type": "query", "description": "The last name of a passenger or contact.\n " }, { "name": "FirstName", "value": "", "type": "query", "description": "The first name of a passenger or contact.\n " }, { "name": "PhoneticSearch", "value": "", "type": "query", "description": "Whether or not to do a phonetic search.\n " }, { "name": "Filters.PageSize", "value": "", "type": "query", "description": "The number of items to return for the request.\n " }, { "name": "Filters.LastIndex", "value": "", "type": "query", "description": "The last booking index (used for paging).\n " }, { "name": "Filters.FlightNumber", "value": "", "type": "query", "description": "Filter by the flight number.\n " }, { "name": "Filters.DepartureDate", "value": "", "type": "query", "description": "The first journeys departure date.\n " }, { "name": "Filters.Destination", "value": "", "type": "query", "description": "Filter by the destination code.\n " }, { "name": "Filters.Origin", "value": "", "type": "query", "description": "Filter by the departure code.\n " }, { "name": "Filters.SourceOrganization", "value": "", "type": "query", "description": "Filter by the organization associated with the booking. For example the\ntravel agency associated with this booking.\n " }, { "name": "Filters.OrganizationGroupCode", "value": "", "type": "query", "description": "Filter by the organization group code to find.\n " }, { "name": "Filters.SearchArchive", "value": "", "type": "query", "description": "Whether or not to search the booking archive.\n " } ] }, "docs": "GraphQL endpoint: searchByLastNamev2" }, { "info": { "name": "Retrieves the bookings of the specified person based on the date range.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/bookings/searchByPerson", "params": [ { "name": "PersonKey", "value": "", "type": "query", "description": "The unique person key. This can be found by using GET /api/nsk/v2/persons endpoint.\n " }, { "name": "StartDate", "value": "", "type": "query", "description": "The booking date start search. If not set manually the start date will be set to the current day.\n " }, { "name": "EndDate", "value": "", "type": "query", "description": "The booking date end search. If not set manually the end date will be 24 hours after the start date.\n " }, { "name": "PageSize", "value": "", "type": "query", "description": "Used to specify the maximum results to return.\nDefaults to 1000 if not specified. Minimum is 10 and maximum is 5000.\n " }, { "name": "LastPageKey", "value": "", "type": "query", "description": "The last page key of the last paged item. This can be found on the\nresponse from the previous set of paged results.\n " } ] }, "docs": "Adds the ability to search by a date range. To get more information about each booking, a subsequent call to GET /api/nsk/v1/bookings/{recordLocator} can be used. Please use this call and not any stateful calls for performance reasons.\n\nGraphQL endpoint: searchByPerson" }, { "info": { "name": "Find booking by phone.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/bookings/searchByPhone", "params": [ { "name": "PhoneNumber", "value": "", "type": "query", "description": "One of the applied phone numbers to a passenger or contact.\n " }, { "name": "AgentId", "value": "", "type": "query", "description": "The agent identifier.\n " }, { "name": "OrganizationCode", "value": "", "type": "query", "description": "OrganizationCode represents the organization associated with the agent who created\nthe booking.\n " }, { "name": "Filters.PageSize", "value": "", "type": "query", "description": "The number of items to return for the request.\n " }, { "name": "Filters.LastIndex", "value": "", "type": "query", "description": "The last booking index (used for paging).\n " }, { "name": "Filters.FlightNumber", "value": "", "type": "query", "description": "Filter by the flight number.\n " }, { "name": "Filters.DepartureDate", "value": "", "type": "query", "description": "The first journeys departure date.\n " }, { "name": "Filters.Destination", "value": "", "type": "query", "description": "Filter by the destination code.\n " }, { "name": "Filters.Origin", "value": "", "type": "query", "description": "Filter by the departure code.\n " }, { "name": "Filters.SourceOrganization", "value": "", "type": "query", "description": "Filter by the organization associated with the booking. For example the\ntravel agency associated with this booking.\n " }, { "name": "Filters.OrganizationGroupCode", "value": "", "type": "query", "description": "Filter by the organization group code to find.\n " }, { "name": "Filters.SearchArchive", "value": "", "type": "query", "description": "Whether or not to search the booking archive.\n " } ] }, "docs": "GraphQL endpoint: searchByPhonev2" }, { "info": { "name": "Find booking by record locator.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/bookings/searchByRecordLocator", "params": [ { "name": "RecordLocator", "value": "", "type": "query", "description": "Record locator being requested.\n " }, { "name": "PageSize", "value": "", "type": "query", "description": "The number of items to return for the request.\n " }, { "name": "LastIndex", "value": "", "type": "query", "description": "The last booking index (used for paging).\n " }, { "name": "SourceOrganization", "value": "", "type": "query", "description": "Filter by the organization associated with the booking. For example the\ntravel agency associated with this booking.\n " }, { "name": "OrganizationGroupCode", "value": "", "type": "query", "description": "Filter by the organization group code to find.\n " }, { "name": "SearchArchive", "value": "", "type": "query", "description": "Whether or not to search the booking archive.\n " } ] }, "docs": "GraphQL endpoint: searchByRecordLocatorv2" }, { "info": { "name": "Find booking by reference number. The reference number is used as identifier by\nNew Skies Rail customers for purposes of ticketing and check in.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/bookings/searchByReferenceNumber", "params": [ { "name": "ReferenceNumber", "value": "", "type": "query", "description": "The reference number, used as an identifier by New Skies Rail customers for purposes\nof ticketing and check in.\n " }, { "name": "AgentId", "value": "", "type": "query", "description": "The agent identifier.\n " }, { "name": "OrganizationCode", "value": "", "type": "query", "description": "The organization code associated with the agent who created the booking.\n " }, { "name": "PageSize", "value": "", "type": "query", "description": "The number of items to return for the request.\n " }, { "name": "LastIndex", "value": "", "type": "query", "description": "The last booking index (used for paging).\n " }, { "name": "SourceOrganization", "value": "", "type": "query", "description": "Filter by the organization associated with the booking. For example the\ntravel agency associated with this booking.\n " }, { "name": "OrganizationGroupCode", "value": "", "type": "query", "description": "Filter by the organization group code to find.\n " }, { "name": "SearchArchive", "value": "", "type": "query", "description": "Whether or not to search the booking archive.\n " } ] }, "docs": "GraphQL endpoint: searchByReferenceNumberv2" }, { "info": { "name": "Find booking by a third party record locator.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v3/bookings/searchByThirdPartyRecordLocator", "params": [ { "name": "SystemCode", "value": "", "type": "query", "description": "The system code to find.\n " }, { "name": "AgentId", "value": "", "type": "query", "description": "The agent identifier.\n " }, { "name": "OrganizationCode", "value": "", "type": "query", "description": "OrganizationCode represents the organization associated with the agent who created\nthe booking.\n " }, { "name": "RecordLocator", "value": "", "type": "query", "description": "Record locator being requested.\n " }, { "name": "PageSize", "value": "", "type": "query", "description": "The number of items to return for the request.\n " }, { "name": "LastIndex", "value": "", "type": "query", "description": "The last booking index (used for paging).\n " }, { "name": "SourceOrganization", "value": "", "type": "query", "description": "Filter by the organization associated with the booking. For example the\ntravel agency associated with this booking.\n " }, { "name": "OrganizationGroupCode", "value": "", "type": "query", "description": "Filter by the organization group code to find.\n " } ] }, "docs": "GraphQL endpoint: searchByThirdPartyRecordLocatorv3" }, { "info": { "name": "Retrieves the watch list for a specific booking.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/bookings/watchList/:bookingKey", "params": [ { "name": "bookingKey", "value": "", "type": "path", "description": "The booking key." } ] }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: bookingsWatchList" } ] }, { "info": { "name": "bundles", "type": "folder" }, "items": [ { "info": { "name": "Retrieves a specific bundle application's details.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/bundles/applications/:bundleApplicationKey/details", "params": [ { "name": "bundleApplicationKey", "value": "", "type": "path", "description": "The bundle application key." } ] }, "docs": "See api/nsk/v1/resources/bundles/applications to retrieve the collection of\nbundle application resources.\n\nGraphQL endpoint: bundleApplicationDetails" }, { "info": { "name": "Retrieves the list of bundle applications associated with\nthe bundle rule.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/bundles/rules/:bundleRuleCode/details", "params": [ { "name": "bundleRuleCode", "value": "", "type": "path", "description": "The bundle rule code." } ] }, "docs": "See api/nsk/v1/resources/bundles/rules to retrieve the collection of\nbundle rule resources.\n\nGraphQL endpoint: bundleRuleDetails" }, { "info": { "name": "Retrieves the list of bundle codes associated with the bundle set.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/bundles/sets/:bundleSetCode/details", "params": [ { "name": "bundleSetCode", "value": "", "type": "path", "description": "The bundle set code." } ] }, "docs": "See api/nsk/v1/resources/bundles/sets to retrieve the collection of\nbundle set resources.\n\nGraphQL endpoint: bundleSetDetails" } ] }, { "info": { "name": "collection", "type": "folder" }, "items": [ { "info": { "name": "Updates the expiration of the account collection based on the\naccount collection key and data in the request.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/collection/:accountCollectionKey/expirationDate", "params": [ { "name": "accountCollectionKey", "value": "", "type": "path", "description": "The account collection key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: accountCollectionExpirationDateSet" }, { "info": { "name": "Retrieves the credit transactions based on the account collection key and\nthe request data.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/collection/:accountCollectionKey/transactions", "params": [ { "name": "accountCollectionKey", "value": "", "type": "path", "description": "The account collection key." }, { "name": "StartTime", "value": "", "type": "query", "description": "The starting date and time of the date range to search in.\n " }, { "name": "EndTime", "value": "", "type": "query", "description": "The end date and time of the date range to search in.\n " }, { "name": "SortByNewest", "value": "", "type": "query", "description": "Optional filter to sort results by newest.\n " }, { "name": "PageSize", "value": "", "type": "query", "description": "Used to specify the number of records to return.\n " }, { "name": "PageIndex", "value": "", "type": "query", "description": "Represents the index of the requested paged item.\n " } ] }, "docs": "GraphQL endpoint: accountCollectionTransactions" }, { "info": { "name": "Retrieves the credit transactions based on the account collection key and\nthe request data.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/collection/:accountCollectionKey/transactions", "params": [ { "name": "accountCollectionKey", "value": "", "type": "path", "description": "The account collection key." }, { "name": "StartDate", "value": "", "type": "query", "description": "The starting date and time of the date range to search in.\n " }, { "name": "EndDate", "value": "", "type": "query", "description": "The end date and time of the date range to search in.\n " }, { "name": "SortByNewest", "value": "", "type": "query", "description": "Optional filter to sort results by newest.\n " }, { "name": "PageSize", "value": "", "type": "query", "description": "Used to specify the number of records to return.\n " }, { "name": "LastPageKey", "value": "", "type": "query", "description": "The last page key where to start paged query.\n " } ] }, "docs": "GraphQL endpoint: accountCollectionTransactionsv2" } ] }, { "info": { "name": "configuration", "type": "folder" }, "items": [ { "info": { "name": "Retrieves the Digital API configuration.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/v1/configuration" }, "docs": "This is a server-based configuration of the Digital API. For requests to change the configuration, please log a\nsupport ticket." } ] }, { "info": { "name": "contacts", "type": "folder" }, "items": [ { "info": { "name": "Gets the latest contact in a booking with a specific phone number.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/contacts/searchByPhoneNumber", "params": [ { "name": "PhoneNumber", "value": "", "type": "query", "description": "The phone number.\n " } ] }, "docs": "GraphQL endpoint: contactsByPhoneNumber" } ] }, { "info": { "name": "contents", "type": "folder" }, "items": [ { "info": { "name": "Retrieves the available news metadata.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/contents/news", "params": [ { "name": "PageSize", "value": "", "type": "query", "description": "The number of items to return for this request. Defaults to the minimum value of 10. The max value is 20.\n " }, { "name": "LastPageKey", "value": "", "type": "query", "description": "The LastPageKey, where to start paged query.\n " }, { "name": "StartDate", "value": "", "type": "query", "description": "The start effective date. This will default to today if not provided.\n " }, { "name": "EndDate", "value": "", "type": "query", "description": "The end effective date. This will default to today if not provided.\n " }, { "name": "Type", "value": "", "type": "query", "description": "The news type to search.\n \nEnumeration values: 0 = All, 1 = Alert, 2 = OneTimeRead, 3 = Daily, 4 = NoAlert" }, { "name": "RequestType", "value": "", "type": "query", "description": "The news request type.\n \nEnumeration values: 0 = Default, 1 = Unread, 2 = UnreadAlert, 3 = UnreadDailyAndOneTimeRead" }, { "name": "DomainCode", "value": "", "type": "query", "description": "The domain code. See /resources/Domains for the valid codes.\n " }, { "name": "DepartmentCode", "value": "", "type": "query", "description": "The department code. See /resources/Departments for the valid codes.\n " }, { "name": "RoleCode", "value": "", "type": "query", "description": "The role code. See /resources/Roles for the valid codes.\n " } ] }, "docs": "News or sometimes referred to as FYI Content notes are created by management about your carrier operations. They can be viewed by reservation agents and station agents.\n\nNews notes are a quick way for airlines to distribute important information to reservation and check-in agents.\n\nIf your carrier has a new fare rule, you can use FYI Content to enter this information and set the FYI type to specify how and when this information is displayed.You can also determine who reads this information by as" }, { "info": { "name": "Add a new news content item.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/contents/news", "body": { "type": "json", "data": "{}" } }, "docs": "Add news or sometimes referred to as FYI Content notes.\n\nRelated endpoints:\n- `GET /resources/contents/{contentID}/data`: Allows you to view the data for a specific content item including news content.\n- `GET /contents/news`: Allows you to search for news content items.\n\nThe `OrganizationCode` is automatically set to the `OrganizationCode` of the logged in \nagent if the `DomainCode`, `DepartmentCode`, and `RoleCode` are all set in the request.\n\nOnly text based content data types are allowed. Oth" } ] }, { "info": { "name": "currency", "type": "folder" }, "items": [ { "info": { "name": "Calculates currency conversions.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/currency/converter", "params": [ { "name": "FromCurrencyCode", "value": "", "type": "query", "description": "The currency code that the amount is currently in.\n " }, { "name": "ToCurrencyCode", "value": "", "type": "query", "description": "The currency code we want the amount converted to.\n " }, { "name": "Amount", "value": "", "type": "query", "description": "The amount to be converted. This will be in the FromCurrencyCode currency.\n " }, { "name": "Inverted", "value": "", "type": "query", "description": "If set to true, the endpoint will use 1/(exchange rate of the reverse) during the conversion. Defaults to false if no value is set.\n " } ] }, "docs": "If the currency conversion is inverted, the exchange rate returned is of the reversed to and \nfrom currency code and the rate used in the calculation is 1/(exchange rate of the reverse).\n\nGraphQL endpoint: currencyCalculation" } ] }, { "info": { "name": "equipment", "type": "folder" }, "items": [ { "info": { "name": "Exchanges one equipment for another on an existing flight.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/dcs/v1/equipment/swap", "body": { "type": "json", "data": "{}" } }, "docs": "Specifically, the leg is updated with a new transport code and equipment information.\nAll seat assignments on the affected flight legs are examined. Any assignments for seats which do not exist\nin the new equipment are released. Those passengers will no longer have seat assignments on the affected legs\nAs a result of the equipment swap, passengers may end up with a different cabin or class of service than they\nhad on the prior equipment. This method is only concerned with making sure that the se" }, { "info": { "name": "Assigns a tail number to a specific leg.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/dcs/v1/equipment/tailNumber", "body": { "type": "json", "data": "{}" } }, "docs": "To confirm the assignment of the tail number, please use /api/nsk/v2/trip/info/{legKey}/status.\nIf the aircraft code of the leg is different from the aircraft code of the tail number, an equipment swap will be\nrequired to assign the tail number\nand the tail number will not be changed until that swap.\nThis equipment swap requirement can be overriden using `IgnoreEquipmentDifference` on the request, however this\nshould be used with caution.\n\nGraphQL endpoints: tailNumber, tailNumberBatch" } ] }, { "info": { "name": "eTickets", "type": "folder" }, "items": [ { "info": { "name": "Retrieves the passenger's e-ticket and its details by providing the ticket number,\nhosted carrier code and the alternate carrier code from the e-ticket database\nif the ticket is OA validated (issued by the other airline not by the hosted carrier).", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/eTickets/:eTicketNumber", "params": [ { "name": "eTicketNumber", "value": "", "type": "path", "description": "The e-ticket number." }, { "name": "HostedCarrierCode", "value": "", "type": "query", "description": "The hosted carrier code. If not provided, the hosted carrier code will be retrieved internally.\n " }, { "name": "AlternateCarrierCode", "value": "", "type": "query", "description": "The alternate carrier code. This is required if the ticket is issued by another airline.\n " } ] }, "docs": "GraphQL endpoint: eTicketv3" }, { "info": { "name": "Retrieves all coupons associated with the e-ticket.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/eTickets/:eTicketNumber/coupons", "params": [ { "name": "eTicketNumber", "value": "", "type": "path", "description": "The e-ticket number." }, { "name": "HostedCarrierCode", "value": "", "type": "query", "description": "The hosted carrier code. If not provided, the hosted carrier code will be retrieved internally.\n " }, { "name": "AlternateCarrierCode", "value": "", "type": "query", "description": "The alternate carrier code. This is required if the ticket is issued by another airline.\n " } ] }, "docs": "GraphQL endpoint: eTicketCouponsv2" }, { "info": { "name": "Retrieves a single coupon associated with the e-ticket.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/eTickets/:eTicketNumber/coupons/:couponNumber", "params": [ { "name": "eTicketNumber", "value": "", "type": "path", "description": "The e-ticket number." }, { "name": "couponNumber", "value": "", "type": "path", "description": "The e-ticket coupon number." }, { "name": "HostedCarrierCode", "value": "", "type": "query", "description": "The hosted carrier code. If not provided, the hosted carrier code will be retrieved internally.\n " }, { "name": "AlternateCarrierCode", "value": "", "type": "query", "description": "The alternate carrier code. This is required if the ticket is issued by another airline.\n " } ] }, "docs": "GraphQL endpoint: eTicketCouponv2" }, { "info": { "name": "Updates a coupon contained in an e-ticket.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/eTickets/:eTicketNumber/coupons/:couponNumber", "params": [ { "name": "eTicketNumber", "value": "", "type": "path", "description": "The e-ticket number to update." }, { "name": "couponNumber", "value": "", "type": "path", "description": "The coupon number to update" } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: eTicketCouponSetv3" } ] }, { "info": { "name": "fareRules", "type": "folder" }, "items": [ { "info": { "name": "Gets the fare rules from the server based on a fare availability key.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/fareRules/:fareAvailabilityKey", "params": [ { "name": "fareAvailabilityKey", "value": "", "type": "path", "description": "The unique fare availability key to get rules for." }, { "name": "convertToHtml", "value": "", "type": "query", "description": "Whether to convert to HTML. Defaults to true." } ] }, "docs": "Note that this defaults to returning the fare rules in HTML format.\nThe HTML format may not be entirely culture sensitive, so setting the convertToHtml flag to false\nwill allow users some flexibility when converting the content and the fare rules will be returned as an RTF string.\n\nGraphQL endpoint: fareRulesByAvailabilityKeyv2" }, { "info": { "name": "Get the category 50 fare rule information after an availability call.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/fareRules/category50/journeys/:journeyKey/segments/:segmentKey", "params": [ { "name": "journeyKey", "value": "", "type": "path", "description": "The journey key." }, { "name": "segmentKey", "value": "", "type": "path", "description": "The segment key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This is functionally a GET but POST is used to reduce URL length overhead.\n\nGraphQL endpoint: category50FareRuleInfov2" } ] }, { "info": { "name": "graph", "type": "folder" }, "items": [ { "info": { "name": "Invokes a graph query and returns the response.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/v1/graph", "body": { "type": "json", "data": "{}" } }, "docs": "Invokes a graph query and returns the response." }, { "info": { "name": "Invokes a graph query and returns the response.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/v2/graph/:queryName", "params": [ { "name": "queryName", "value": "", "type": "path", "description": "The unique name used for reporting." }, { "name": "cachedResults", "value": "", "type": "query", "description": "Cached results query string parameter. This is the same as the post variable but enables\nvarious tools to set the same value.\n " } ], "body": { "type": "json", "data": "{}" } }, "docs": "Invokes a graph query and returns the response." }, { "info": { "name": "Invokes a graph query configured in utilities.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/graph/:queryName", "params": [ { "name": "queryName", "value": "", "type": "path", "description": "The query name matching your resource management configuration." }, { "name": "cachedResults", "value": "", "type": "query", "description": "True to return cached results." } ], "body": { "type": "json", "data": "{}" } }, "docs": "When a graph query is configured on the server under Resource Management it allows your payload sizes to be even\nsmaller." } ] }, { "info": { "name": "health", "type": "folder" }, "items": [ { "info": { "name": "Gets the current environment's health status.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/v1/health" }, "docs": "Gets the current environment's health status." }, { "info": { "name": "Returns a simple health check that will return a 200 if the server is responding.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/v2/health" }, "docs": "This health check will not ensure that the required underlying services are working. For a more detailed health\ncheck that will validate configuration and third party services please use a different health endpoint." }, { "info": { "name": "Performs the health check.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/v3/health" }, "docs": "This endpoint does not require a token.\nIf the health check returns an overall status of \"Ok\", the expected HTTP status code response would be a\n\"200 - Ok\".\nIf the health check returns an overall status of \"Warning\", the expected HTTP status code response would be\na \"299\". This is a custom code not typically mapped as per industry\nstandards, and was done intentionally to indicate a warning response from the health endpoint.\nIf the health check returns an overall status of \"Error\", the expected " } ] }, { "info": { "name": "inventory", "type": "folder" }, "items": [ { "info": { "name": "Gets the stateless inventory leg.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/dcs/v2/inventory/legs/:legKey", "params": [ { "name": "legKey", "value": "", "type": "path", "description": "The leg key." } ] }, "docs": "GraphQL endpoint: inventoryLegv2" }, { "info": { "name": "Patches an inventory leg's data, its nests' data, and its classes' data based on information in the request.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/dcs/v2/inventory/legs/:legKey", "params": [ { "name": "legKey", "value": "", "type": "path", "description": "The leg key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: inventoryLegModifyv2" }, { "info": { "name": "Gets an inventory leg nest by key.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/dcs/v1/inventory/legs/:legKey/nests/:legNestKey", "params": [ { "name": "legKey", "value": "", "type": "path", "description": "The leg key." }, { "name": "legNestKey", "value": "", "type": "path", "description": "The leg nest key." } ] }, "docs": "GraphQL endpoint: inventoryNest" }, { "info": { "name": "Patches an inventory leg nest's data based on information in the request.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/dcs/v1/inventory/legs/:legKey/nests/:legNestKey", "params": [ { "name": "legKey", "value": "", "type": "path", "description": "The leg key." }, { "name": "legNestKey", "value": "", "type": "path", "description": "The leg nest key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: inventoryNestModify" }, { "info": { "name": "Gets an inventory leg nest class by key.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/dcs/v1/inventory/legs/:legKey/nests/:legNestKey/classes/:legClassKey", "params": [ { "name": "legKey", "value": "", "type": "path", "description": "The leg key." }, { "name": "legNestKey", "value": "", "type": "path", "description": "The leg nest key." }, { "name": "legClassKey", "value": "", "type": "path", "description": "The leg class key." } ] }, "docs": "GraphQL endpoint: inventoryClass" }, { "info": { "name": "Patches an inventory leg nest class's data based on information in the request.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/dcs/v1/inventory/legs/:legKey/nests/:legNestKey/classes/:legClassKey", "params": [ { "name": "legKey", "value": "", "type": "path", "description": "The leg key." }, { "name": "legNestKey", "value": "", "type": "path", "description": "The leg nest key." }, { "name": "legClassKey", "value": "", "type": "path", "description": "The leg class key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: inventoryClassModify" }, { "info": { "name": "Returns a list of leg keys and their ssr nest codes and lids.\nStructured as a POST but behaves as a GET.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/dcs/v1/inventory/legs/ssrs/lids", "body": { "type": "json", "data": "{}" } }, "docs": "This is a batch endpoint. To get ssr lid information for a single leg, please use GET\n`api/dcs/v2/inventory/legs/{legKey}`." }, { "info": { "name": "Patches the ssr lids for multiple specified legs.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/dcs/v1/inventory/legs/ssrs/lids", "body": { "type": "json", "data": "{}" } }, "docs": "This is a batch endpoint. It accepts a list of leg keys in the body along with their SSR nest codes and requested\nlids. If a leg has an SSR that is not specified in the parameter list, that SSR will not be updated.\nRelated Endpoints:\nGET `api/dcs/v2/inventory/legs/{legKey}`: Retrieves the current configuration for a leg and retrieve the SSR nest\ncodes used for this endpoint.\nGET `api/nsk/v1/bookings/{recordLocator}`: Retrieves the current configuration related to a booking.Requires a\nlogin with " }, { "info": { "name": "Gets the classes for a route, stateless.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/dcs/v1/inventory/routes/:tripKey/classes", "params": [ { "name": "tripKey", "value": "", "type": "path", "description": "The trip key from a manifest or flight info." } ] }, "docs": "GraphQL endpoint: inventoryRouteClasses" }, { "info": { "name": "Patches an inventory route class's data based on information in the request.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/dcs/v1/inventory/routes/:tripKey/classes/:classOfService", "params": [ { "name": "tripKey", "value": "", "type": "path", "description": "The trip key." }, { "name": "classOfService", "value": "", "type": "path", "description": "The class of service." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: inventoryRouteClassModify" }, { "info": { "name": "Deletes an inventory route class's authorized unit.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/dcs/v1/inventory/routes/:tripKey/classes/:classOfService/authorizedUnit", "params": [ { "name": "tripKey", "value": "", "type": "path", "description": "The trip key." }, { "name": "classOfService", "value": "", "type": "path", "description": "The class of service." } ] }, "docs": "GraphQL endpoint: inventoryRouteClassAuthorizedUnitDelete" } ] }, { "info": { "name": "manifest", "type": "folder" }, "items": [ { "info": { "name": "Gets the manifest trip information response list for the specified\nmanifest trip information search request.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/manifest", "params": [ { "name": "Origin", "value": "", "type": "query", "description": "The departure station.\n " }, { "name": "Destination", "value": "", "type": "query", "description": "The arrival station.\n " }, { "name": "CarrierCode", "value": "", "type": "query", "description": "The carrier code.\n " }, { "name": "BeginDate", "value": "", "type": "query", "description": "The starting date of the trip information search.\n " }, { "name": "Identifier", "value": "", "type": "query", "description": "The transportation identifier, such as a flight number.\n " }, { "name": "FlightType", "value": "", "type": "query", "description": "The flight type.\n \nEnumeration values: 0 = All, 1 = NonStop, 2 = Through, 3 = Direct, 4 = Connect" } ] }, "docs": "GraphQL endpoint: manifestSearchv2" }, { "info": { "name": "Gets the manifest for the specified leg.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/manifest/:legKey", "params": [ { "name": "legKey", "value": "", "type": "path", "description": "The manifest leg key." } ] }, "docs": "GraphQL endpoint: manifestv3" }, { "info": { "name": "Gets the manifest Passenger Bags for the specified leg. Sorted by recordLocator and then by Passenger.\nweightType 0 = Default, 1 = Pounds, 2 = Kilograms, (2 is current default for backwards compatibility)", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/manifest/:legKey/bags", "params": [ { "name": "legKey", "value": "", "type": "path", "description": "The manifest leg key." }, { "name": "weightType", "value": "", "type": "query", "description": "Weight type. 0 = Default, 1 = Pounds, 2 = Kilograms. \nEnumeration values: 0 = Default, 1 = Pounds, 2 = Kilograms" } ] }, "docs": "GraphQL endpoint: manifestBags" }, { "info": { "name": "Gets the manifest bookings data for the specified leg.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/manifest/:legKey/bookings", "params": [ { "name": "legKey", "value": "", "type": "path", "description": "The manifest leg key." } ] }, "docs": "GraphQL endpoint: manifestBookings" }, { "info": { "name": "Gets the manifest Passenger Government Security Information for the specified leg.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/manifest/:legKey/governmentSecurityInfo", "params": [ { "name": "legKey", "value": "", "type": "path", "description": "The manifest leg key." } ] }, "docs": "GraphQL endpoint: manifestGovernmentSecurityInformation" }, { "info": { "name": "Retrieves the government security requirements for all passengers on the specified leg by calling the New Skies\nGovernment Security Service (GSS).", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/manifest/:legKey/governmentSecurityInfo", "params": [ { "name": "legKey", "value": "", "type": "path", "description": "The leg key." } ] }, "docs": "This endpoint is slower than other manifest endpoints because it requires synchronous communication with backend\nsystems such as the Government Security Service (GSS) and the underlying New Skies remoting layer that brokers\nGSS calls.\n\nThe `data.internationalFlight` property is only populated if there are passengers on the flight.\n\nThe following response properties are only populated if the flight is international and already has passengers:\n- `data.arrivalCountry`\n- `data.departureCountry`\n\nThi" }, { "info": { "name": "Gets the passenger details for the specified leg.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/manifest/:legKey/passengerDetails", "params": [ { "name": "legKey", "value": "", "type": "path", "description": "The leg key." } ] }, "docs": "GraphQL endpoint: manifestPassengerDetailsv2" }, { "info": { "name": "Gets the weight balance passenger details for the specified leg.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/dcs/v1/manifest/:legKey/passengerDetails/weightBalance", "params": [ { "name": "legKey", "value": "", "type": "path", "description": "The leg key." } ] }, "docs": "GraphQL endpoint: passengerWeightBalance" }, { "info": { "name": "Gets a list of seat assignment reports for the specified leg.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/manifest/:legKey/passengerSeatAssignments", "params": [ { "name": "legKey", "value": "", "type": "path", "description": "The leg key." } ] }, "docs": "GraphQL endpoint: manifestSeatAssignments" }, { "info": { "name": "Gets the manifest segment data for the specified leg.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/manifest/:legKey/segments", "params": [ { "name": "legKey", "value": "", "type": "path", "description": "The manifest leg key." }, { "name": "includeNonOriginData", "value": "", "type": "query", "description": "Include segments associated outside the requested leg." }, { "name": "includeIATCILookAhead", "value": "", "type": "query", "description": "Include IATCI look ahead data. Default is false." } ] }, "docs": "This structure of manifest data most closely resembles the original v2 manifest structure without the duplicate\ndata and performance issues.\n\nGraphQL endpoint: manifestSegments" }, { "info": { "name": "Gets the manifest SSRs for the specified leg.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/manifest/:legKey/ssrs", "params": [ { "name": "legKey", "value": "", "type": "path", "description": "The manifest leg key." }, { "name": "includeNonOriginSsrs", "value": "", "type": "query", "description": "Include SSRs associated to other legs or segments from the requested leg." } ] }, "docs": "GraphQL endpoint: manifestSsrs" } ] }, { "info": { "name": "messages", "type": "folder" }, "items": [ { "info": { "name": "Adds a new message item.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/messages", "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: messageAddv2" }, { "info": { "name": "Deletes a collection of message items.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/messages", "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint does not perform additional verification that the messages were deleted.\nAs long as there are no errors or exceptions, the delete operation is considered successful.\nA separate call to the GET `/api/nsk/v1/messages` endpoint can be made to verify that all the\nspecified messages do not exist anymore.\n\nGraphQL endpoint: messagesDelete" }, { "info": { "name": "Retrieves a collection of teletype messages based on search criteria.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/messages", "params": [ { "name": "LastPageKey", "value": "", "type": "query", "description": "The key of the last item returned from paging.\n " }, { "name": "MessageQueueFilter", "value": "", "type": "query", "description": "The filter that specifies which records to retrieve.\n \nEnumeration values: 0 = NonHiddenRecords, 1 = HiddenRecords, 2 = All" }, { "name": "MessageTypeCode", "value": "", "type": "query", "description": "The message type code to search for.\n " }, { "name": "SearchStartDate", "value": "", "type": "query", "description": "The start of created date range to search for.\n " }, { "name": "SearchEndDate", "value": "", "type": "query", "description": "The end of created date range to search for.\n " }, { "name": "PageSize", "value": "", "type": "query", "description": "The number of records to return when paging.\n " }, { "name": "SearchValue", "value": "", "type": "query", "description": "The search query.\n " }, { "name": "SearchType", "value": "", "type": "query", "description": "The type of search to be performed.\n \nEnumeration values: 0 = StartsWith, 1 = EndsWith, 2 = Contains, 3 = ExactMatch" } ] }, "docs": "GraphQL endpoint: messagesSearchv2" }, { "info": { "name": "Retrieves a specific message item.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/messages/:messageKey", "params": [ { "name": "messageKey", "value": "", "type": "path", "description": "The key of the message to be retrieved." } ] }, "docs": "GraphQL endpoint: messages" }, { "info": { "name": "Deletes a message item.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/messages/:messageKey", "params": [ { "name": "messageKey", "value": "", "type": "path", "description": "The key of the message to delete." } ] }, "docs": "GraphQL endpoint: messageDeletev2" }, { "info": { "name": "Sends a new generic teletype message to the specified address in the request.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/messages/teletype", "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: teletypeMessageAdd" }, { "info": { "name": "Sends a well-formed TCP formatted teletype message to the appropriate booking segments.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/messages/teletype/tcp/:recordLocator", "params": [ { "name": "recordLocator", "value": "", "type": "path", "description": "The record locator, which uniquely identifies a booking. Common referred to as PNR." } ] }, "docs": "For carriers that are Amadeus Reservation Gateway (ARG) participants, this agent-only endpoint provides the option\nto push a PNR to Amadeus on a PNR-by-PNR basis using the TCP push functionality.\nWhen a booking containing a TCP-qualifying segment is retrieved (marketing codeshare and normal unflown segments),\nand the TCP Push functionality is used, the system then sends an \"Unsolicited Transfer PNR\" (TCP) message to the\nconfigured external system.\nTCP messages can be configured using the Managem" } ] }, { "info": { "name": "oneTimeTravelNotifications", "type": "folder" }, "items": [ { "info": { "name": "Creates a one time travel notification.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/oneTimeTravelNotifications", "body": { "type": "json", "data": "{}" } }, "docs": "To get or delete a one time notification, you will need to store the key that is on the location header.\n\nGraphQL endpoint: oneTimeTravelNotificationAdd" }, { "info": { "name": "Creates a one time travel notification.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/oneTimeTravelNotifications", "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: oneTimeTravelNotificationAddv2" }, { "info": { "name": "Gets a one time travel notification.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/oneTimeTravelNotifications/:oneTimeTravelNotificationKey", "params": [ { "name": "oneTimeTravelNotificationKey", "value": "", "type": "path", "description": "The one time travel notification key." } ] }, "docs": "GraphQL endpoint: oneTimeTravelNotification" }, { "info": { "name": "Deletes a one time travel notification.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/oneTimeTravelNotifications/:oneTimeTravelNotificationKey", "params": [ { "name": "oneTimeTravelNotificationKey", "value": "", "type": "path", "description": "The one time travel notification key." } ] }, "docs": "GraphQL endpoint: oneTimeTravelNotificationDelete" }, { "info": { "name": "Gets a one time travel notification through a subscription number.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/oneTimeTravelNotifications/:subscriptionNumber", "params": [ { "name": "subscriptionNumber", "value": "", "type": "path", "description": "The subscription number." }, { "name": "destination", "value": "", "type": "query", "description": "The notification destination." } ] }, "docs": "GraphQL endpoint: oneTimeTravelNotificationv2" }, { "info": { "name": "Deletes a one time travel notification through a subscription number.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/oneTimeTravelNotifications/:subscriptionNumber", "params": [ { "name": "subscriptionNumber", "value": "", "type": "path", "description": "The subscription number." }, { "name": "destination", "value": "", "type": "query", "description": "The notification destination." } ] }, "docs": "GraphQL endpoint: oneTimeTravelNotificationDeletev2" } ] }, { "info": { "name": "organizationGroup", "type": "folder" }, "items": [ { "info": { "name": "Creates a new organization group and adds an organization to it.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/organizationGroup", "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: organizationGroupAddv2" } ] }, { "info": { "name": "organizationGroups", "type": "folder" }, "items": [ { "info": { "name": "Creates a new organization group.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizationGroups/:organizationGroupCode", "params": [ { "name": "organizationGroupCode", "value": "", "type": "path", "description": "The ID of the organization group to create." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: organizationGroupAdd" }, { "info": { "name": "Modifies an organization group by updating the group name or adding an organization to the organization group.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizationGroups/:organizationGroupCode", "params": [ { "name": "organizationGroupCode", "value": "", "type": "path", "description": "The organization group code to modify." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: organizationGroupSet" }, { "info": { "name": "Deletes an organization group.\nThis should not be used if the organization group needs to exist.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizationGroups/:organizationGroupCode", "params": [ { "name": "organizationGroupCode", "value": "", "type": "path", "description": "The organization group code to delete." } ] }, "docs": "GraphQL endpoint: organizationGroupDelete" }, { "info": { "name": "Updates an organization group by removing all organizations", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizationGroups/:organizationGroupCode/organizations", "params": [ { "name": "organizationGroupCode", "value": "", "type": "path", "description": "The organization group code to remove all organizations from." } ] }, "docs": "GraphQL endpoint: organizationGroupOrganizationRemoveAll" }, { "info": { "name": "Updates an organization group by removing an organization", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizationGroups/:organizationGroupCode/organizations/:organizationCode", "params": [ { "name": "organizationGroupCode", "value": "", "type": "path", "description": "The organization group code to modify." }, { "name": "organizationCode", "value": "", "type": "path", "description": "The organization code to remove from the group." } ] }, "docs": "GraphQL endpoint: organizationGroupOrganizationRemove" } ] }, { "info": { "name": "organizations", "type": "folder" }, "items": [ { "info": { "name": "Retrieves the organization groups.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations/groups" }, "docs": "GraphQL endpoint: organizationGroups" }, { "info": { "name": "Retrieves the details of an organization group.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations/groups/:organizationGroupCode", "params": [ { "name": "organizationGroupCode", "value": "", "type": "path", "description": "The organization group code to retrieve." } ] }, "docs": "GraphQL endpoint: organizationGroup" } ] }, { "info": { "name": "organizations2", "type": "folder" }, "items": [ { "info": { "name": "Create a new organization.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations2", "body": { "type": "json", "data": "{}" } }, "docs": "Requires agent permissions.\nThe organization code is a generic code for all of the organization types. Each individual type has its own code\nand validation.\nIf the organization status is not pending the organization code should follow these validation rules based on type:\nThird Party: 3 to 10 characters in length with alphanumeric values.\nTravel Agency: 7 to 10 characters in length with numeric values.\nCarrier: 2 to 3 characters in length with alphanumeric values.\nIf no organization code is prov" }, { "info": { "name": "Searches for organizations.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/organizations2", "params": [ { "name": "OrganizationCode", "value": "", "type": "query", "description": "The organization code.\n " }, { "name": "Type", "value": "", "type": "query", "description": "Organization type.\n \nEnumeration values: 0 = Default, 1 = Master, 2 = Carrier, 3 = TravelAgency, 4 = ThirdParty" }, { "name": "Status", "value": "", "type": "query", "description": "The organization status.\n \nEnumeration values: 0 = Default, 1 = Active, 2 = Cancelled, 3 = Pending" }, { "name": "ParentOrganizationCode", "value": "", "type": "query", "description": "The parent organization code.\n " }, { "name": "CompanyName", "value": "", "type": "query", "description": "The organization company name.\n " }, { "name": "City", "value": "", "type": "query", "description": "The organization company city.\n " }, { "name": "PostalCode", "value": "", "type": "query", "description": "The organization company postal code.\n " }, { "name": "PagedItemIndex", "value": "", "type": "query", "description": "Used to specify the index for skipping values when paging.\n " }, { "name": "PageSize", "value": "", "type": "query", "description": "Used to specify the maximum results to return.\n " }, { "name": "MatchCriteria.OrganizationCode", "value": "", "type": "query", "description": "The type of string search for organization code.\n \nEnumeration values: 0 = StartsWith, 1 = EndsWith, 2 = Contains, 3 = ExactMatch" }, { "name": "MatchCriteria.ParentOrganizationCode", "value": "", "type": "query", "description": "The type of string search for parent organization code.\n \nEnumeration values: 0 = StartsWith, 1 = EndsWith, 2 = Contains, 3 = ExactMatch" }, { "name": "MatchCriteria.CompanyName", "value": "", "type": "query", "description": "The type of string search for organization company name.\n \nEnumeration values: 0 = StartsWith, 1 = EndsWith, 2 = Contains, 3 = ExactMatch" }, { "name": "MatchCriteria.City", "value": "", "type": "query", "description": "The type of string search for organization company city.\n \nEnumeration values: 0 = StartsWith, 1 = EndsWith, 2 = Contains, 3 = ExactMatch" }, { "name": "MatchCriteria.PostalCode", "value": "", "type": "query", "description": "The type of string search for organization company postal code.\n \nEnumeration values: 0 = StartsWith, 1 = EndsWith, 2 = Contains, 3 = ExactMatch" } ] }, "docs": "GraphQL endpoint: organizations2v2" }, { "info": { "name": "Retrieves the organization.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations2/:organizationCode", "params": [ { "name": "organizationCode", "value": "", "type": "path", "description": "The identifier of the organization to update." } ] }, "docs": "GraphQL endpoint: organization2" }, { "info": { "name": "Updates an organization.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations2/:organizationCode", "params": [ { "name": "organizationCode", "value": "", "type": "path", "description": "The identifier for the organization to be updated." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Requires agent permissions.\nThe organization code is a generic code for all of the organization types. Each individual type has its own code\nand validation.\nIf the organization status is not pending the organization code should follow these validation rules based on type:\nThird Party: 3 to 10 characters in length with alphanumeric values.\nTravel Agency: 7 to 10 characters in length with numeric values.\nCarrier: 2 to 3 characters in length with alphanumeric values.\n\nGraphQL endpoint: organization" }, { "info": { "name": "Updates an organization.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations2/:organizationCode", "params": [ { "name": "organizationCode", "value": "", "type": "path", "description": "The identifier of the organization to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Requires agent permissions.\nThe organization code is a generic code for all of the organization types. Each individual type has its own code\nand validation.\nIf the organization status is not pending the organization code should follow these validation rules based on type:\nThird Party: 3 to 10 characters in length with alphanumeric values.\nTravel Agency: 7 to 10 characters in length with numeric values.\nCarrier: 2 to 3 characters in length with alphanumeric values.\n\nGraphQL endpoint: organization" }, { "info": { "name": "Retrieves the organization account and collections based on the organization code.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations2/:organizationCode/account", "params": [ { "name": "organizationCode", "value": "", "type": "path", "description": "The organization code." } ] }, "docs": "GraphQL endpoint: organizations2Account" }, { "info": { "name": "Creates an organization account based on the organization code.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations2/:organizationCode/account", "params": [ { "name": "organizationCode", "value": "", "type": "path", "description": "The organization code." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: organizations2AccountAdd" }, { "info": { "name": "Adjust the available amount of a child account.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations2/:organizationCode/account/childAccountTransactions", "params": [ { "name": "organizationCode", "value": "", "type": "path", "description": "The account reference number for the child organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "The known list of parent-child relations are as follows:\n- Dependent accounts are not supported.\n- A parent's account of type credit may have children of type supplemental or credit.\n- A parent's account of type prepaid may have children of type prepaid.\n- No other combination of parent-child relations are supported.\n\nGraphQL endpoint: childAccountTransactionsAdd" }, { "info": { "name": "Adjust the credit limit of a child account.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations2/:organizationCode/account/childAccountTransactions", "params": [ { "name": "organizationCode", "value": "", "type": "path", "description": "The account reference number for the child organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "The known list of parent-child relations are as follows:\n- Dependent accounts are not supported.\n- A parent's account of type credit may have children of type supplemental or credit.\n- A parent's account of type prepaid may have children of type prepaid.\n- No other combination of parent-child relations are supported.\n\nGraphQL endpoint: childAccountTransactionsSet" }, { "info": { "name": "Updates the organization account status.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations2/:organizationCode/account/status", "params": [ { "name": "organizationCode", "value": "", "type": "path", "description": "The organization code." }, { "name": "status", "value": "", "type": "query", "description": "The allowed account status. \nEnumeration values: 0 = Open, 1 = Closed, 2 = AgencyInactive, 3 = Unknown" } ] }, "docs": "GraphQL endpoint: organizations2AccountStatusSet" }, { "info": { "name": "Retrieves the organization account transactions based on the organization code\nand data in the request.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations2/:organizationCode/account/transactions", "params": [ { "name": "organizationCode", "value": "", "type": "path", "description": "The organization code." }, { "name": "StartTime", "value": "", "type": "query", "description": "The starting date and time of the date range to search in.\n " }, { "name": "EndTime", "value": "", "type": "query", "description": "The end date and time of the date range to search in.\n " }, { "name": "SortByNewest", "value": "", "type": "query", "description": "Optional filter to sort results by newest.\n " }, { "name": "PageSize", "value": "", "type": "query", "description": "Used to specify the number of records to return.\n " }, { "name": "PageIndex", "value": "", "type": "query", "description": "Represents the index of the requested paged item.\n " } ] }, "docs": "GraphQL endpoint: organizations2Transactions" }, { "info": { "name": "Creates account transactions based on data in the request and the\norganization code.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations2/:organizationCode/account/transactions", "params": [ { "name": "organizationCode", "value": "", "type": "path", "description": "The organization code." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: organizations2TransactionsAdd" }, { "info": { "name": "Retrieves the organization account transactions based on the organization code and data in the request.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/organizations2/:organizationCode/account/transactions", "params": [ { "name": "organizationCode", "value": "", "type": "path", "description": "The organization code." }, { "name": "StartDate", "value": "", "type": "query", "description": "The starting date and time of the date range to search in.\n " }, { "name": "EndDate", "value": "", "type": "query", "description": "The end date and time of the date range to search in.\n " }, { "name": "SortByNewest", "value": "", "type": "query", "description": "Optional filter to sort results by newest.\n " }, { "name": "PageSize", "value": "", "type": "query", "description": "Used to specify the number of records to return.\n " }, { "name": "LastPageKey", "value": "", "type": "query", "description": "The last page key where to start paged query.\n " } ] }, "docs": "GraphQL endpoint: organizations2Transactionsv2" }, { "info": { "name": "Retrieves all allotment contracts for the specified organization.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations2/:organizationCode/allotments/contracts", "params": [ { "name": "organizationCode", "value": "", "type": "path", "description": "The organization code." } ] }, "docs": "GraphQL endpoint: allotmentContracts" }, { "info": { "name": "Creates the specified allotment contract.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations2/:organizationCode/allotments/contracts", "params": [ { "name": "organizationCode", "value": "", "type": "path", "description": "The organization code." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: allotmentContractAdd" }, { "info": { "name": "Updates the specified allotment contract.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations2/:organizationCode/allotments/contracts/:contractCode", "params": [ { "name": "organizationCode", "value": "", "type": "path", "description": "The organization code." }, { "name": "contractCode", "value": "", "type": "path", "description": "The contract code." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: allotmentContractSet" }, { "info": { "name": "Create a commission rate.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations2/:organizationCode/commissionRates", "params": [ { "name": "organizationCode", "value": "", "type": "path", "description": "The organization group code to create a commission rate for." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: organizationCommissionRateAdd" }, { "info": { "name": "Get a commission rate.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations2/:organizationCode/commissionRates/:commissionRateCode", "params": [ { "name": "organizationCode", "value": "", "type": "path", "description": "The organization group code to retrieve commission rates for." }, { "name": "commissionRateCode", "value": "", "type": "path", "description": "The commission rate code to retrieve." } ] }, "docs": "Get a commission rate." }, { "info": { "name": "Delete a commission rate.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations2/:organizationCode/commissionRates/:commissionRateCode", "params": [ { "name": "organizationCode", "value": "", "type": "path", "description": "The organization group code to delete commission rates for." }, { "name": "commissionRateCode", "value": "", "type": "path", "description": "The commission rate code to delete." } ] }, "docs": "GraphQL endpoint: organizationCommissionRateDelete" }, { "info": { "name": "Create a company phone number.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations2/:organizationCode/company/phoneNumbers", "params": [ { "name": "organizationCode", "value": "", "type": "path", "description": "The organization code for the organization that owns the phone number." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: organizationCompanyPhoneAdd" }, { "info": { "name": "Updates a company phone number.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations2/:organizationCode/company/phoneNumbers/:phoneNumberType", "params": [ { "name": "organizationCode", "value": "", "type": "path", "description": "The organization code for the organization that owns the phone number." }, { "name": "phoneNumberType", "value": "", "type": "path", "description": "The phone number type of the phone number to update. \nEnumeration values: 0 = Other, 1 = Home, 2 = Work, 3 = Mobile, 4 = Fax" } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: organizationCompanyPhoneSet" }, { "info": { "name": "Deletes a company phone number.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations2/:organizationCode/company/phoneNumbers/:phoneNumberType", "params": [ { "name": "organizationCode", "value": "", "type": "path", "description": "The organization code for the organization that owns the phone number." }, { "name": "phoneNumberType", "value": "", "type": "path", "description": "The phone number type of the phone number to delete. \nEnumeration values: 0 = Other, 1 = Home, 2 = Work, 3 = Mobile, 4 = Fax" } ] }, "docs": "GraphQL endpoint: organizationCompanyPhoneDelete" }, { "info": { "name": "Create a contact phone number.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations2/:organizationCode/contact/phoneNumbers", "params": [ { "name": "organizationCode", "value": "", "type": "path", "description": "The organization code for the organization that owns the contact." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: organizationContactPhoneAdd" }, { "info": { "name": "Updates a contact phone number.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations2/:organizationCode/contact/phoneNumbers/:phoneNumberType", "params": [ { "name": "organizationCode", "value": "", "type": "path", "description": "The organization code for the organization that owns the contact." }, { "name": "phoneNumberType", "value": "", "type": "path", "description": "The type of the phone number being updated. \nEnumeration values: 0 = Other, 1 = Home, 2 = Work, 3 = Mobile, 4 = Fax" } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: organizationContactPhoneSet" }, { "info": { "name": "Deletes a contact phone number.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations2/:organizationCode/contact/phoneNumbers/:phoneNumberType", "params": [ { "name": "organizationCode", "value": "", "type": "path", "description": "The organization code for the organization that owns the contact." }, { "name": "phoneNumberType", "value": "", "type": "path", "description": "The type of the phone number being deleted. \nEnumeration values: 0 = Other, 1 = Home, 2 = Work, 3 = Mobile, 4 = Fax" } ] }, "docs": "GraphQL endpoint: organizationContactPhoneDelete" }, { "info": { "name": "Create an external account.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations2/:organizationCode/externalAccounts", "params": [ { "name": "organizationCode", "value": "", "type": "path", "description": "The organization code for the organization that owns the account." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: organizationExternalAccountAdd" }, { "info": { "name": "Get an external account.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations2/:organizationCode/externalAccounts/:externalAccountKey", "params": [ { "name": "organizationCode", "value": "", "type": "path", "description": "The organization code for the organization that owns the account." }, { "name": "externalAccountKey", "value": "", "type": "path", "description": "The particular external account desired." } ] }, "docs": "Get an external account." }, { "info": { "name": "Delete an external account.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations2/:organizationCode/externalAccounts/:externalAccountKey", "params": [ { "name": "organizationCode", "value": "", "type": "path", "description": "The organization that owns the account to delete." }, { "name": "externalAccountKey", "value": "", "type": "path", "description": "The particular account to delete." } ] }, "docs": "GraphQL endpoint: organizationExternalAccountDelete" }, { "info": { "name": "Returns a list of Process Schedules for the organization.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations2/:organizationCode/processSchedules", "params": [ { "name": "organizationCode", "value": "", "type": "path", "description": "The organization code." } ] }, "docs": "GraphQL endpoint: organizationProcessScheduleGetAll" }, { "info": { "name": "Adds a process schedule to the organization.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations2/:organizationCode/processSchedules/:processScheduleId", "params": [ { "name": "organizationCode", "value": "", "type": "path", "description": "The organization code." }, { "name": "processScheduleId", "value": "", "type": "path", "description": "The ID of the process schedule." } ] }, "docs": "GraphQL endpoint: organizationProcessScheduleAdd" }, { "info": { "name": "Deletes a process schedule from the organization.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations2/:organizationCode/processSchedules/:processScheduleId", "params": [ { "name": "organizationCode", "value": "", "type": "path", "description": "The organization code." }, { "name": "processScheduleId", "value": "", "type": "path", "description": "The ID of the process schedule." } ] }, "docs": "GraphQL endpoint: organizationProcessScheduleDelete" }, { "info": { "name": "Retrieves all allotments for the specified leg.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations2/allotments", "params": [ { "name": "legKey", "value": "", "type": "query", "description": "The leg key." } ] }, "docs": "GraphQL endpoint: allotments" }, { "info": { "name": "Retrieves a single allotment for the specified leg using the given allotment basis code.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations2/allotments/:allotmentBasisCode", "params": [ { "name": "legKey", "value": "", "type": "query", "description": "The leg key." }, { "name": "allotmentBasisCode", "value": "", "type": "path", "description": "The allotment basis code." } ] }, "docs": "The allotment basis code should be substituted with allotment class code in Fare Manager Plus environments.\n\nGraphQL endpoint: allotment" }, { "info": { "name": "Retrieves all allotment bases for the specified contract.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations2/allotments/:contractCode/bases", "params": [ { "name": "contractCode", "value": "", "type": "path", "description": "The contract code." }, { "name": "PageSize", "value": "", "type": "query", "description": "The Page Size, Default 1000\n " }, { "name": "LastPageKey", "value": "", "type": "query", "description": "The LastPageKey, where to start paged query.\n " } ] }, "docs": "GraphQL endpoint: allotmentBases" }, { "info": { "name": "Creates the specified allotment basis.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations2/allotments/:contractCode/bases", "params": [ { "name": "contractCode", "value": "", "type": "path", "description": "The contract code." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: allotmentBasisAdd" }, { "info": { "name": "Updates the specified allotment basis.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations2/allotments/:contractCode/bases/:allotmentBasisCode", "params": [ { "name": "contractCode", "value": "", "type": "path", "description": "The contract code." }, { "name": "allotmentBasisCode", "value": "", "type": "path", "description": "The allotment basis code." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: allotmentBasisSet" }, { "info": { "name": "Retrieves the specified allotment basis.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations2/allotments/bases/:allotmentBasisCode", "params": [ { "name": "allotmentBasisCode", "value": "", "type": "path", "description": "The allotment basis code to search for." } ] }, "docs": "GraphQL endpoint: allotmentBasis" }, { "info": { "name": "Gets all market fares for the given allotment basis.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations2/allotments/bases/:allotmentBasisCode/marketFares", "params": [ { "name": "allotmentBasisCode", "value": "", "type": "path", "description": "The allotment basis code." } ] }, "docs": "GraphQL endpoint: allotmentBasisMarketFares" }, { "info": { "name": "Creates the specified allotment basis market fare.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations2/allotments/bases/:allotmentBasisCode/marketFares", "params": [ { "name": "allotmentBasisCode", "value": "", "type": "path", "description": "The allotment basis code." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: allotmentBasisMarketFareAdd" }, { "info": { "name": "Gets the specified market fare for the given allotment basis.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations2/allotments/bases/:allotmentBasisCode/marketFares/:allotmentMarketFareKey", "params": [ { "name": "allotmentBasisCode", "value": "", "type": "path", "description": "The allotment basis code." }, { "name": "allotmentMarketFareKey", "value": "", "type": "path", "description": "The allotment market fare key." } ] }, "docs": "GraphQL endpoint: allotmentBasisMarketFare" }, { "info": { "name": "Updates the specified allotment basis market fare.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations2/allotments/bases/:allotmentBasisCode/marketFares/:allotmentMarketFareKey", "params": [ { "name": "allotmentBasisCode", "value": "", "type": "path", "description": "The allotment basis code." }, { "name": "allotmentMarketFareKey", "value": "", "type": "path", "description": "The target allotment market fare key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: allotmentBasisMarketFareSet" }, { "info": { "name": "Deletes the specified allotment basis market fare.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations2/allotments/bases/:allotmentBasisCode/marketFares/:allotmentMarketFareKey", "params": [ { "name": "allotmentBasisCode", "value": "", "type": "path", "description": "The allotment basis code." }, { "name": "allotmentMarketFareKey", "value": "", "type": "path", "description": "The target allotment market fare key." } ] }, "docs": "GraphQL endpoint: allotmentBasisMarketFareDelete" }, { "info": { "name": "Retrieves all allotments for the specified allotment basis code.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations2/allotments/byAllotmentBasisCode/:allotmentBasisCode", "params": [ { "name": "allotmentBasisCode", "value": "", "type": "path", "description": "The allotment basis code." } ] }, "docs": "GraphQL endpoint: allotmentsByBasisCode" }, { "info": { "name": "Retrieves the specified allotment contract.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations2/allotments/contracts/:contractCode", "params": [ { "name": "contractCode", "value": "", "type": "path", "description": "The contract code to search for." } ] }, "docs": "GraphQL endpoint: allotmentContract" }, { "info": { "name": "Creates an allotment for the specified leg.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations2/contracts/basis/:allotmentBasisCode/allotments/legs/:legKey", "params": [ { "name": "allotmentBasisCode", "value": "", "type": "path", "description": "The allotment basis code" }, { "name": "legKey", "value": "", "type": "path", "description": "The leg key" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Due to system limitations, if this endpoint is used the inventory cache will need to be refreshed\nNegoAlloment and ProrataAllotment are the only allotment class types available.\nThese values align with the ClassType enum.\nThe allotment basis code should be substituted with allotment class code in Fare Manager Plus\nenvironments.\n\nGraphQL endpoint: allotmentAdd" }, { "info": { "name": "Updates an allotment for the specified leg.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations2/contracts/basis/:allotmentBasisCode/allotments/legs/:legKey", "params": [ { "name": "allotmentBasisCode", "value": "", "type": "path", "description": "The allotment basis code" }, { "name": "legKey", "value": "", "type": "path", "description": "The leg key" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Due to system limitations, if this endpoint is used the inventory cache will need to be refreshed.\nNegoAllotment and ProrataAllotment are the only allotment class types available.\nThese values align with the ClassType enum.\nThe allotment basis code should be substituted with allotment class code in Fare Manager Plus environments.\n\nGraphQL endpoint: allotmentSet" }, { "info": { "name": "Returns a single Process Schedule object.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations2/processSchedule/:processScheduleId", "params": [ { "name": "processScheduleId", "value": "", "type": "path", "description": "The ID of the process schedule to retrieve." } ] }, "docs": "GraphQL endpoint: processScheduleGet" }, { "info": { "name": "Returns a single Process Schedule object.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/organizations2/processSchedule/:processScheduleId", "params": [ { "name": "processScheduleId", "value": "", "type": "path", "description": "The ID of the process schedule to retrieve." } ] }, "docs": "GraphQL endpoint: processScheduleGetv2" }, { "info": { "name": "Returns a list of active process schedules.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations2/processSchedules" }, "docs": "GraphQL endpoint: processScheduleGetAll" }, { "info": { "name": "Returns a list of active process schedules.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/organizations2/processSchedules" }, "docs": "GraphQL endpoint: processScheduleGetAllv2" }, { "info": { "name": "Requests to register a new organization.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/organizations2/register", "body": { "type": "json", "data": "{}" } }, "docs": "Note: This is only a request. An agent will need to approve the action.\n\nGraphQL endpoint: organization2RegisterAdd" } ] }, { "info": { "name": "payments", "type": "folder" }, "items": [ { "info": { "name": "Gets the payment data based on the specified bank identification number and date range.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/payments", "params": [ { "name": "BankIdentificationNumber", "value": "", "type": "query", "description": "The bank identification number to search for. This is the first 6 digits of the card number.\n " }, { "name": "StartDate", "value": "", "type": "query", "description": "The start date to search for. This refers to the date the payment was made.\n " }, { "name": "EndDate", "value": "", "type": "query", "description": "The end date.\n " }, { "name": "PageSize", "value": "", "type": "query", "description": "The number of payment records per request.\n " }, { "name": "LastPageKey", "value": "", "type": "query", "description": "The key for the last payment record returned from paged response.\n " } ] }, "docs": "GraphQL endpoint: paymentsSearchByBin" } ] }, { "info": { "name": "persons", "type": "folder" }, "items": [ { "info": { "name": "Creates a new person record (used by agents).", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons", "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint requires agent permissions.\n\nGraphQL endpoint: personAdd" }, { "info": { "name": "Search person records.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/persons", "params": [ { "name": "LastIndex", "value": "", "type": "query", "description": "The index of the last paged item. This can be found on the\nresponse from the previous set of paged results.\n " }, { "name": "Username", "value": "", "type": "query", "description": "The person user name to search by.\n " }, { "name": "FirstName", "value": "", "type": "query", "description": "The person's first name to search by.\n " }, { "name": "LastName", "value": "", "type": "query", "description": "The person's last name to search by.\n " }, { "name": "FirstNameMatching", "value": "", "type": "query", "description": "The matching criteria for the person's first name.\n \nEnumeration values: 0 = StartsWith, 1 = EndsWith, 2 = Contains, 3 = ExactMatch" }, { "name": "CustomerNumber", "value": "", "type": "query", "description": "The person's customer number.\n " }, { "name": "PhoneNumber", "value": "", "type": "query", "description": "The phone number to search by.\n " }, { "name": "EmailAddress", "value": "", "type": "query", "description": "The email address to search by.\n " }, { "name": "ProgramNumber", "value": "", "type": "query", "description": "The program number to search by.\n " }, { "name": "ProgramCode", "value": "", "type": "query", "description": "The program code to search by.\n " }, { "name": "Type", "value": "", "type": "query", "description": "The person type to search by.\n \nEnumeration values: 0 = None, 1 = Customer, 2 = Agent" }, { "name": "NationalIdNumber", "value": "", "type": "query", "description": "The national ID number to search by.\n " }, { "name": "NationalIdNumberMatching", "value": "", "type": "query", "description": "The matching criteria for the national ID number.\n \nEnumeration values: 0 = StartsWith, 1 = EndsWith, 2 = Contains, 3 = ExactMatch" }, { "name": "ReturnCount", "value": "", "type": "query", "description": "The number of results to return.\n " }, { "name": "ActiveOnly", "value": "", "type": "query", "description": "Include active person records only.\n " } ] }, "docs": "GraphQL endpoint: personSearchv2" }, { "info": { "name": "Retrieves a specific person by key.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." } ] }, "docs": "GraphQL endpoint: person" }, { "info": { "name": "Updates the person record basic information.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: personSet" }, { "info": { "name": "Patches the person record basic information.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Only need to send in the data that is being requested to be updated.\n\nGraphQL endpoint: personModify" }, { "info": { "name": "Deletes a person by setting the record to terminated.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." } ] }, "docs": "This endpoint requires agent permissions.\n\nGraphQL endpoint: personDelete" }, { "info": { "name": "Retrieves the person account and credits based on the person key.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/account", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The person key." }, { "name": "currencyCode", "value": "", "type": "query", "description": "The currency code. This is optional." } ] }, "docs": "If the currency code is not provided it will default to the currency code associated to the account.\n\nGraphQL endpoint: personsAccount" }, { "info": { "name": "Creates the person account based on the person key and\ndata in the request.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/account", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The person key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: personsAccountAdd" }, { "info": { "name": "Creates an account collection based on the person key and data in the request.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/account/collection", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The person key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint will create a new account collection and a transaction if no account\ntransaction exists or no matching collection is found. An account collection is unique\nbased on the transaction code and the expiration date. If a matching account collection\nis found, a transaction for that collection is generated and the account collection will\nbe updated.\nSee /api/nsk/v1/resources/accountTransactionCodes for a list of available account transaction\ncodes.\n\nGraphQL endpoint: personsAccountColle" }, { "info": { "name": "Retrieves the person account collection transactions based on the person key,\nthe account collection key, and data in the request.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/account/collection/:accountCollectionKey/transactions", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The person key." }, { "name": "accountCollectionKey", "value": "", "type": "path", "description": "The account collection key." }, { "name": "StartTime", "value": "", "type": "query", "description": "The starting date and time of the date range to search in.\n " }, { "name": "EndTime", "value": "", "type": "query", "description": "The end date and time of the date range to search in.\n " }, { "name": "SortByNewest", "value": "", "type": "query", "description": "Optional filter to sort results by newest.\n " }, { "name": "PageSize", "value": "", "type": "query", "description": "Used to specify the number of records to return.\n " }, { "name": "PageIndex", "value": "", "type": "query", "description": "Represents the index of the requested paged item.\n " } ] }, "docs": "GraphQL endpoint: personsAccountTransactions" }, { "info": { "name": "Creates an account collection transaction based on the person key, the\naccount collection key, and data in the request.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/account/collection/:accountCollectionKey/transactions", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The person key." }, { "name": "accountCollectionKey", "value": "", "type": "path", "description": "The account collection key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint will add a transaction to an existing account collection.\nIf there are no account collections, or the account collection key does\nnot match an existing collection, the request will fail.\nTo add a new account collection, see /api/nsk/v1/persons/{personKey}/account/collection.\n\nGraphQL endpoint: personsAccountTransactionsAdd" }, { "info": { "name": "Retrieves the person account collection transactions based on the person key, the account collection key, and data in the request.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/persons/:personKey/account/collection/:accountCollectionKey/transactions", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The person key." }, { "name": "accountCollectionKey", "value": "", "type": "path", "description": "The account collection key." }, { "name": "StartDate", "value": "", "type": "query", "description": "The starting date and time of the date range to search in.\n " }, { "name": "EndDate", "value": "", "type": "query", "description": "The end date and time of the date range to search in.\n " }, { "name": "SortByNewest", "value": "", "type": "query", "description": "Optional filter to sort results by newest.\n " }, { "name": "PageSize", "value": "", "type": "query", "description": "Used to specify the number of records to return.\n " }, { "name": "LastPageKey", "value": "", "type": "query", "description": "The last page key where to start paged query.\n " } ] }, "docs": "GraphQL endpoint: personsAccountTransactionsv2" }, { "info": { "name": "Updates the person account status.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/account/status", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The person key." }, { "name": "status", "value": "", "type": "query", "description": "The new account status. \nEnumeration values: 0 = Open, 1 = Closed, 2 = AgencyInactive, 3 = Unknown" } ] }, "docs": "GraphQL endpoint: personsAccountStatusSet" }, { "info": { "name": "Retrieves all transactions for every collection.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/account/transactions", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The person key." }, { "name": "StartTime", "value": "", "type": "query", "description": "The starting date and time of the date range to search in.\n " }, { "name": "EndTime", "value": "", "type": "query", "description": "The end date and time of the date range to search in.\n " }, { "name": "SortByNewest", "value": "", "type": "query", "description": "Optional filter to sort results by newest.\n " }, { "name": "PageSize", "value": "", "type": "query", "description": "Used to specify the number of records to return.\n " }, { "name": "PageIndex", "value": "", "type": "query", "description": "Represents the index of the requested paged item.\n " } ] }, "docs": "GraphQL endpoint: personsAccountAllTransactions" }, { "info": { "name": "Retrieves all persons account transactions.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/persons/:personKey/account/transactions", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The person key." }, { "name": "StartDate", "value": "", "type": "query", "description": "The starting date and time of the date range to search in.\n " }, { "name": "EndDate", "value": "", "type": "query", "description": "The end date and time of the date range to search in.\n " }, { "name": "SortByNewest", "value": "", "type": "query", "description": "Optional filter to sort results by newest.\n " }, { "name": "PageSize", "value": "", "type": "query", "description": "Used to specify the number of records to return.\n " }, { "name": "LastPageKey", "value": "", "type": "query", "description": "The last page key where to start paged query.\n " } ] }, "docs": "GraphQL endpoint: personsAccountAllTransactionsv2" }, { "info": { "name": "Gets the collection of addresses for a specific person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/addresses", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." } ] }, "docs": "Gets the collection of addresses for a specific person." }, { "info": { "name": "Creates a new address for a specific person.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/addresses", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: personAddressAdd" }, { "info": { "name": "Gets a specific address for a specific person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/addresses/:personAddressKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." }, { "name": "personAddressKey", "value": "", "type": "path", "description": "The unique address key." } ] }, "docs": "GraphQL endpoint: personAddress" }, { "info": { "name": "Updates a specific address for a specific person.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/addresses/:personAddressKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." }, { "name": "personAddressKey", "value": "", "type": "path", "description": "The unique person address key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: personAddressSet" }, { "info": { "name": "Patches a specific address for a specific person.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/addresses/:personAddressKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." }, { "name": "personAddressKey", "value": "", "type": "path", "description": "The unique person address key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: personAddressModify" }, { "info": { "name": "Deletes a specific address for a specific person.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/addresses/:personAddressKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." }, { "name": "personAddressKey", "value": "", "type": "path", "description": "The unique person address key." } ] }, "docs": "GraphQL endpoint: personAddressDelete" }, { "info": { "name": "Gets all affiliations for a specific person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/affiliations", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." } ] }, "docs": "GraphQL endpoint: personAffiliations" }, { "info": { "name": "Creates a new affiliation for a specific person.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/affiliations", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: personAffiliationAdd" }, { "info": { "name": "Gets a specific affiliation for a specific person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/affiliations/:personAffiliationKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." }, { "name": "personAffiliationKey", "value": "", "type": "path", "description": "The unique person affiliation key." } ] }, "docs": "GraphQL endpoint: personAffiliation" }, { "info": { "name": "Updates a specific affiliation for a specific person.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/affiliations/:personAffiliationKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." }, { "name": "personAffiliationKey", "value": "", "type": "path", "description": "The unique person affiliation key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: personAffiliationSet" }, { "info": { "name": "Deletes a specific affiliation for a specific person.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/affiliations/:personAffiliationKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." }, { "name": "personAffiliationKey", "value": "", "type": "path", "description": "The unique person affiliation key." } ] }, "docs": "GraphQL endpoint: personAffiliationDelete" }, { "info": { "name": "Gets the collection of aliases for a specific person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/aliases", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." } ] }, "docs": "Gets the collection of aliases for a specific person." }, { "info": { "name": "Creates a new alias for a specific person.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/aliases", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: personAliasAdd" }, { "info": { "name": "Gets a specific alias for a specific person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/aliases/:personAliasKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." }, { "name": "personAliasKey", "value": "", "type": "path", "description": "The unique person alias key." } ] }, "docs": "GraphQL endpoint: personAlias" }, { "info": { "name": "Updates a specific alias for a specific person.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/aliases/:personAliasKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." }, { "name": "personAliasKey", "value": "", "type": "path", "description": "The unique person alias key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: personAliasSet" }, { "info": { "name": "Patches a specific alias for a specific person.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/aliases/:personAliasKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." }, { "name": "personAliasKey", "value": "", "type": "path", "description": "The unique person alias key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: personAliasModify" }, { "info": { "name": "Deletes a specific alias for a specific person.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/aliases/:personAliasKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." }, { "name": "personAliasKey", "value": "", "type": "path", "description": "The unique person alias key." } ] }, "docs": "GraphQL endpoint: personAliasDelete" }, { "info": { "name": "Gets the collection of comments for a specific person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/comments", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." } ] }, "docs": "GraphQL endpoint: personComments" }, { "info": { "name": "Creates a new comment for a specific person.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/comments", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: personCommentAdd" }, { "info": { "name": "Gets a specific comment for a specific person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/comments/:personCommentKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." }, { "name": "personCommentKey", "value": "", "type": "path", "description": "The unique comment key." } ] }, "docs": "GraphQL endpoint: personComment" }, { "info": { "name": "Updates a specific comment for a specific person.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/comments/:personCommentKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." }, { "name": "personCommentKey", "value": "", "type": "path", "description": "The unique person comment key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: personCommentSet" }, { "info": { "name": "Patches a specific comment for a specific person.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/comments/:personCommentKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." }, { "name": "personCommentKey", "value": "", "type": "path", "description": "The unique person comment key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: personCommentModify" }, { "info": { "name": "Deletes a specific comment for a specific person.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/comments/:personCommentKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." }, { "name": "personCommentKey", "value": "", "type": "path", "description": "The unique person comment key." } ] }, "docs": "GraphQL endpoint: personCommentDelete" }, { "info": { "name": "Gets the collection of email addresses for a specific person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/emails", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." } ] }, "docs": "Gets the collection of email addresses for a specific person." }, { "info": { "name": "Creates a new email address for a specific person.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/emails", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "The \"type\" property for the request is a single character. See the \"/resources/EmailTypes\"\nendpoint for valid email type codes.\n\nGraphQL endpoint: personEmailAdd" }, { "info": { "name": "Gets a specific email address for a specific person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/emails/:personEmailAddressKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." }, { "name": "personEmailAddressKey", "value": "", "type": "path", "description": "The unique email address key." } ] }, "docs": "GraphQL endpoint: personEmail" }, { "info": { "name": "Updates a specific email address for a specific person.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/emails/:personEmailAddressKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." }, { "name": "personEmailAddressKey", "value": "", "type": "path", "description": "The unique person email address key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: personEmailSet" }, { "info": { "name": "Patches a specific email address for a specific person.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/emails/:personEmailAddressKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." }, { "name": "personEmailAddressKey", "value": "", "type": "path", "description": "The unique person email address key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: personEmailModify" }, { "info": { "name": "Deletes a specific email address for a specific person.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/emails/:personEmailAddressKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." }, { "name": "personEmailAddressKey", "value": "", "type": "path", "description": "The unique person email address key." } ] }, "docs": "GraphQL endpoint: personEmailDelete" }, { "info": { "name": "Gets all information for a specific person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/information", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." } ] }, "docs": "GraphQL endpoint: personInformations" }, { "info": { "name": "Creates new information for a specific person.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/information", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: personInformationAdd" }, { "info": { "name": "Gets specific information for a specific person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/information/:personInformationKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." }, { "name": "personInformationKey", "value": "", "type": "path", "description": "The unique person information key." } ] }, "docs": "GraphQL endpoint: personInformation" }, { "info": { "name": "Updates specific information for a specific person.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/information/:personInformationKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." }, { "name": "personInformationKey", "value": "", "type": "path", "description": "The unique person information key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: personInformationSet" }, { "info": { "name": "Patches specific information for a specific person.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/information/:personInformationKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." }, { "name": "personInformationKey", "value": "", "type": "path", "description": "The unique person information key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: personInformationModify" }, { "info": { "name": "Deletes specific information for a specific person.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/information/:personInformationKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." }, { "name": "personInformationKey", "value": "", "type": "path", "description": "The unique person information key." } ] }, "docs": "GraphQL endpoint: personInformationDelete" }, { "info": { "name": "Updates a person by merging the PNRs associated, account information and optionally the customer programs.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/merge", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The person to be updated and merged on to." } ], "body": { "type": "json", "data": "{}" } }, "docs": "- If new name is not given the name of the person to be updated will be retained.\n- This endpoint requires agent permissions.\n\nGraphQL endpoint: personMerge" }, { "info": { "name": "Gets the collection of phone numbers for a specific person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/phoneNumbers", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." } ] }, "docs": "Gets the collection of phone numbers for a specific person." }, { "info": { "name": "Creates a new phone number for a specific person.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/phoneNumbers", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: personPhoneNumberAdd" }, { "info": { "name": "Gets a specific phone number for a specific person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/phoneNumbers/:personPhoneNumberKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." }, { "name": "personPhoneNumberKey", "value": "", "type": "path", "description": "The unique phone number key." } ] }, "docs": "GraphQL endpoint: personPhoneNumber" }, { "info": { "name": "Updates a specific phone number for a specific person.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/phoneNumbers/:personPhoneNumberKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." }, { "name": "personPhoneNumberKey", "value": "", "type": "path", "description": "The unique person phone number key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: personPhoneNumberSet" }, { "info": { "name": "Patches a specific phone number for a specific person.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/phoneNumbers/:personPhoneNumberKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." }, { "name": "personPhoneNumberKey", "value": "", "type": "path", "description": "The unique person phone number key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: personPhoneNumberModify" }, { "info": { "name": "Deletes a specific phone number for a specific person.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/phoneNumbers/:personPhoneNumberKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." }, { "name": "personPhoneNumberKey", "value": "", "type": "path", "description": "The unique person phone number key." } ] }, "docs": "GraphQL endpoint: personPhoneNumberDelete" }, { "info": { "name": "Gets all preferences for a specific person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/preferences", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." } ] }, "docs": "Gets all preferences for a specific person." }, { "info": { "name": "Creates a new preference for a specific person.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/preferences", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: personPreferenceAdd" }, { "info": { "name": "Gets a specific preference for a specific person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/preferences/:personPreferenceKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." }, { "name": "personPreferenceKey", "value": "", "type": "path", "description": "The unique person preference key." } ] }, "docs": "GraphQL endpoint: personPreference" }, { "info": { "name": "Updates a specific preference for a specific person.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/preferences/:personPreferenceKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." }, { "name": "personPreferenceKey", "value": "", "type": "path", "description": "The unique person preference key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: personPreferenceSet" }, { "info": { "name": "Patches a specific preference for a specific person.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/preferences/:personPreferenceKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." }, { "name": "personPreferenceKey", "value": "", "type": "path", "description": "The unique person preference key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: personPreferenceModify" }, { "info": { "name": "Deletes a specific preference for a specific person.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/preferences/:personPreferenceKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." }, { "name": "personPreferenceKey", "value": "", "type": "path", "description": "The unique person preference key." } ] }, "docs": "GraphQL endpoint: personPreferenceDelete" }, { "info": { "name": "Gets the collection of programs for a specific person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/programs", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." } ] }, "docs": "GraphQL endpoint: personPrograms" }, { "info": { "name": "Creates a new program for a specific person.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/programs", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: personProgramAdd" }, { "info": { "name": "Gets a specific program for a specific person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/programs/:personProgramKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." }, { "name": "personProgramKey", "value": "", "type": "path", "description": "The unique program key." } ] }, "docs": "GraphQL endpoint: personProgram" }, { "info": { "name": "Updates a specific program for a specific person.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/programs/:personProgramKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." }, { "name": "personProgramKey", "value": "", "type": "path", "description": "The unique person program key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: personProgramSet" }, { "info": { "name": "Patches a specific program for a specific person.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/programs/:personProgramKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." }, { "name": "personProgramKey", "value": "", "type": "path", "description": "The unique person program key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: personProgramModify" }, { "info": { "name": "Deletes a specific program for a specific person.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/programs/:personProgramKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." }, { "name": "personProgramKey", "value": "", "type": "path", "description": "The unique person program key." } ] }, "docs": "GraphQL endpoint: personProgramDelete" }, { "info": { "name": "Gets the collection of stored payments for a specific person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/storedPayments", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." } ] }, "docs": "Gets the collection of stored payments for a specific person." }, { "info": { "name": "Creates a new stored payment for a specific person.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/storedPayments", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: personStoredPaymentAdd" }, { "info": { "name": "Gets a specific stored payment for a specific person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/storedPayments/:personStoredPaymentKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." }, { "name": "personStoredPaymentKey", "value": "", "type": "path", "description": "The unique stored payment key." } ] }, "docs": "GraphQL endpoint: personStoredPayment" }, { "info": { "name": "Patches a specific stored payment for a specific person.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/storedPayments/:personStoredPaymentKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." }, { "name": "personStoredPaymentKey", "value": "", "type": "path", "description": "The unique person stored payment key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "To update the account number please DELETE and POST a new stored payment.\n\nGraphQL endpoint: personStoredPaymentModify" }, { "info": { "name": "Deletes a specific stored payment for a specific person.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/storedPayments/:personStoredPaymentKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." }, { "name": "personStoredPaymentKey", "value": "", "type": "path", "description": "The unique person stored payment key." } ] }, "docs": "GraphQL endpoint: personStoredPaymentDelete" }, { "info": { "name": "Updates a specific stored payment for a specific person.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/persons/:personKey/storedPayments/:personStoredPaymentKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." }, { "name": "personStoredPaymentKey", "value": "", "type": "path", "description": "The unique person stored payment key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "To update the account number please DELETE and POST a new stored payment.\n\nGraphQL endpoint: personStoredPaymentSetv2" }, { "info": { "name": "Gets the collection of travel documents for a specific person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/travelDocuments", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." } ] }, "docs": "Gets the collection of travel documents for a specific person." }, { "info": { "name": "Creates a new travel document for a specific person.\nNote: Gender and Date of Birth on the Travel Document will overwrite the values on the related person object.\nThis is by design due to New Skies validation on the Gender property, and on the Travel Document\nDate of Birth being trusted over the person record Date of Birth.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/travelDocuments", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: personTravelDocumentAddv2" }, { "info": { "name": "Gets a specific travel document for a specific person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/travelDocuments/:personTravelDocumentKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." }, { "name": "personTravelDocumentKey", "value": "", "type": "path", "description": "The unique travel document key." } ] }, "docs": "GraphQL endpoint: personTravelDocumentv2" }, { "info": { "name": "Deletes a specific travel document for a specific person.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/travelDocuments/:personTravelDocumentKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." }, { "name": "personTravelDocumentKey", "value": "", "type": "path", "description": "The unique person travel document key." } ] }, "docs": "GraphQL endpoint: personTravelDocumentDeletev2" }, { "info": { "name": "Updates a specific travel document for a specific person.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/persons/:personKey/travelDocuments/:personTravelDocumentKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." }, { "name": "personTravelDocumentKey", "value": "", "type": "path", "description": "The unique person travel document key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Note: Gender and Date of Birth on the Travel Document will overwrite the values on the related person object.\nThis is by design due to New Skies validation on the Gender property, and on the Travel Document\nDate of Birth being trusted over the person record Date of Birth.\nOnce the declared gender is set in the travel document, it can only be set to other values. Setting the declared\ngender in the request to blank or null will not cause an error in the endpoint, but the existing value will be\nret" }, { "info": { "name": "Patches a specific travel document for a specific person.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/persons/:personKey/travelDocuments/:personTravelDocumentKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The unique person key." }, { "name": "personTravelDocumentKey", "value": "", "type": "path", "description": "The unique person travel document key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Note: Gender and Date of Birth on the Travel Document will overwrite the values on the related person object.\nThis is by design due to New Skies validation on the Gender property, and on the Travel Document\nDate of Birth being trusted over the person record Date of Birth.\nOnce the declared gender is set in the travel document, it can only be set to other values. Setting the declared\ngender in the request to blank or null will not cause an error in the endpoint, but the existing value will be\nret" }, { "info": { "name": "Gets person travel notifications for a person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/travelNotifications", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The person key." } ] }, "docs": "GraphQL endpoint: personsTravelNotifications" }, { "info": { "name": "Creates a person travel notification for a person.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/travelNotifications", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The person key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: personsTravelNotificationAdd" }, { "info": { "name": "Gets a person travel notification for a person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/travelNotifications/:travelNotificationKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The person key." }, { "name": "travelNotificationKey", "value": "", "type": "path", "description": "The travel notification key." } ] }, "docs": "GraphQL endpoint: personsTravelNotification" }, { "info": { "name": "Updates a person travel notification for a person.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/travelNotifications/:travelNotificationKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The person key." }, { "name": "travelNotificationKey", "value": "", "type": "path", "description": "The travel notification key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: personsTravelNotificationSet" }, { "info": { "name": "Patches a person travel notification for a person.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/travelNotifications/:travelNotificationKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The person key." }, { "name": "travelNotificationKey", "value": "", "type": "path", "description": "The travel notification key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: personsTravelNotificationModify" }, { "info": { "name": "Deletes a person travel notification for a person.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/travelNotifications/:travelNotificationKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The person key." }, { "name": "travelNotificationKey", "value": "", "type": "path", "description": "The travel notification key." } ] }, "docs": "GraphQL endpoint: personsTravelNotificationDelete" }, { "info": { "name": "Gets notification events for a person travel notification for a person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/travelNotifications/:travelNotificationKey/events", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The person key." }, { "name": "travelNotificationKey", "value": "", "type": "path", "description": "The travel notification key." } ] }, "docs": "GraphQL endpoint: personsNotificationEvents" }, { "info": { "name": "Creates a notification event for a person travel notification for a person.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/travelNotifications/:travelNotificationKey/events", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The person key." }, { "name": "travelNotificationKey", "value": "", "type": "path", "description": "The travel notification key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: personsNotificationEventAdd" }, { "info": { "name": "Gets a notification event for a person travel notification for a person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/travelNotifications/:travelNotificationKey/events/:eventType", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The person key." }, { "name": "travelNotificationKey", "value": "", "type": "path", "description": "The travel notification key." }, { "name": "eventType", "value": "", "type": "path", "description": "The event type. \nEnumeration values: 0 = DepartureDelay, 1 = ArrivalDelay, 2 = ScheduleChange, 3 = CheckIn, 4 = GateInformation" } ] }, "docs": "GraphQL endpoint: personsNotificationEvent" }, { "info": { "name": "Deletes a notification event from a person travel notification for a person.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/travelNotifications/:travelNotificationKey/events/:eventType", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The person key." }, { "name": "travelNotificationKey", "value": "", "type": "path", "description": "The travel notification key." }, { "name": "eventType", "value": "", "type": "path", "description": "The notification event type. \nEnumeration values: 0 = DepartureDelay, 1 = ArrivalDelay, 2 = ScheduleChange, 3 = CheckIn, 4 = GateInformation" } ] }, "docs": "GraphQL endpoint: personsNotificationEventDelete" }, { "info": { "name": "Gets notification timed events for a person travel notification for a person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/travelNotifications/:travelNotificationKey/timedEvents", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The person key." }, { "name": "travelNotificationKey", "value": "", "type": "path", "description": "The travel notification key." } ] }, "docs": "GraphQL endpoint: personsNotificationTimedEvents" }, { "info": { "name": "Creates a notification timed event for a person travel notification for a person.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/travelNotifications/:travelNotificationKey/timedEvents", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The person key." }, { "name": "travelNotificationKey", "value": "", "type": "path", "description": "The travel notification key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: personsNotificationTimedEventAdd" }, { "info": { "name": "Gets a notification timed event for a person travel notification for a person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/travelNotifications/:travelNotificationKey/timedEvents/:timedEventType", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The person key." }, { "name": "travelNotificationKey", "value": "", "type": "path", "description": "The travel notification key." }, { "name": "timedEventType", "value": "", "type": "path", "description": "The timed event type. \nEnumeration values: 0 = Departure, 1 = Arrival" } ] }, "docs": "GraphQL endpoint: personsNotificationTimedEvent" }, { "info": { "name": "Updates a notification timed event for a person travel notification for a person.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/travelNotifications/:travelNotificationKey/timedEvents/:timedEventType", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The person key." }, { "name": "travelNotificationKey", "value": "", "type": "path", "description": "The travel notification key." }, { "name": "timedEventType", "value": "", "type": "path", "description": "The notification timed event type. \nEnumeration values: 0 = Departure, 1 = Arrival" } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: personsNotificationTimedEventSet" }, { "info": { "name": "Deletes a notification timed event from a person travel notification for a person.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/persons/:personKey/travelNotifications/:travelNotificationKey/timedEvents/:timedEventType", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The person key." }, { "name": "travelNotificationKey", "value": "", "type": "path", "description": "The travel notification key." }, { "name": "timedEventType", "value": "", "type": "path", "description": "The notification timed event type. \nEnumeration values: 0 = Departure, 1 = Arrival" } ] }, "docs": "GraphQL endpoint: personsNotificationTimedEventDelete" } ] }, { "info": { "name": "pricing", "type": "folder" }, "items": [ { "info": { "name": "Creates a pricing offer in the ancillary pricing options service.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/apo/v1/pricing", "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: apoPricingAdd" }, { "info": { "name": "Gets the pricing configuration data from the ancillary pricing options service.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/apo/v1/pricing/configuration", "params": [ { "name": "source", "value": "", "type": "query", "description": "The pricing configuration source." } ] }, "docs": "GraphQL endpoint: apoPricingConfiguration" } ] }, { "info": { "name": "promotions", "type": "folder" }, "items": [ { "info": { "name": "Gets promotions based on data in the request.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/promotions", "params": [ { "name": "PromotionCode", "value": "", "type": "query", "description": "The promotion code.\n " }, { "name": "OrganizationCode", "value": "", "type": "query", "description": "The organization code.\n " }, { "name": "EffectiveDate", "value": "", "type": "query", "description": "The effective date of the promotion.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The requested culture code.\n " }, { "name": "PromotionCodeMatching", "value": "", "type": "query", "description": "The matching criteria for the promotion code, by default if not set the criteria will be an exact match.\n \nEnumeration values: 0 = StartsWith, 1 = EndsWith, 2 = Contains, 3 = ExactMatch" }, { "name": "OrganizationCodeMatching", "value": "", "type": "query", "description": "The matching criteria for the organization code, by default if not set the criteria will be an exact match.\n \nEnumeration values: 0 = StartsWith, 1 = EndsWith, 2 = Contains, 3 = ExactMatch" } ] }, "docs": "GraphQL endpoint: promotions" }, { "info": { "name": "Gets a promotion based on the promotion code.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/promotions/:promotionCode", "params": [ { "name": "promotionCode", "value": "", "type": "path", "description": "The promotion code." } ] }, "docs": "GraphQL endpoint: promotion" }, { "info": { "name": "Evaluates a promotion code and optional organization code to determine if\nthe associated promotion is valid or not.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/promotions/:promotionCode/validate", "params": [ { "name": "promotionCode", "value": "", "type": "path", "description": "The promotion code." }, { "name": "organizationCode", "value": "", "type": "query", "description": "The optional organization code." } ] }, "docs": "This validates the promotion code based on the logged-in user if the\norganization code is not provided.\n\nGraphQL endpoint: promotionValidate" } ] }, { "info": { "name": "queues", "type": "folder" }, "items": [ { "info": { "name": "Gets the list of queues available.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/queues/bookings", "params": [ { "name": "QueueName", "value": "", "type": "query", "description": "Queue name.\n " }, { "name": "QueueCode", "value": "", "type": "query", "description": "Queue code.\n " }, { "name": "QueueCategoryCode", "value": "", "type": "query", "description": "Queue category code.\nPlease note that this should be a char and not a string.\n " }, { "name": "PageSize", "value": "", "type": "query", "description": "The default page size.\n " }, { "name": "LastPageIndex", "value": "", "type": "query", "description": "Used to specify the index of the last set of records retrieved\nwhen paging is performed. This is optional.\n " } ] }, "docs": "This action requires a session token.\nThis endpoint has known issues where the total count returned is incorrect\nand on the first initial request, the count of the items returned is one less\nthan the requested page size. This is an issue with the underlying NewSkies\nremoting call and a bug has been logged to fix these issues.\n\nGraphQL endpoint: bookingQueuesv2" }, { "info": { "name": "Empties the booking queue.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/queues/bookings/:bookingQueueCode/items", "params": [ { "name": "bookingQueueCode", "value": "", "type": "path", "description": "The booking queue code." }, { "name": "subQueueCode", "value": "", "type": "query", "description": "The sub-queue code." } ] }, "docs": "GraphQL endpoint: bookingQueueEmpty" }, { "info": { "name": "Moves to a different queue.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/queues/bookings/:bookingQueueCode/items/:bookingQueueItemKey", "params": [ { "name": "bookingQueueCode", "value": "", "type": "path", "description": "The identifier for the particular booking queue" }, { "name": "bookingQueueItemKey", "value": "", "type": "path", "description": "The identifier for the booking queue item." } ], "body": { "type": "json", "data": "{}" } }, "docs": "The booking queue proxy and service model do not currently support getting the queue code\nthe item was moved to. Therefore, it is not possible at this time to provide a link to\naccess the item on a different queue or a configurable response containing the queue object.\nAdditionally, the proxy and service model do not allow for getting a particular item within a\nqueue.\n\nGraphQL endpoint: bookingQueueMoveItem" }, { "info": { "name": "Removes booking queue items from the specified queue.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/queues/bookings/:bookingQueueCode/items/:bookingQueueItemKey", "params": [ { "name": "bookingQueueCode", "value": "", "type": "path", "description": "The identifier of the booking queue containing the item to delete." }, { "name": "bookingQueueItemKey", "value": "", "type": "path", "description": "The identifier of the booking queue item to delete." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: bookingQueueDeleteItem" }, { "info": { "name": "Gets the next item in the booking queue.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/queues/bookings/:bookingQueueCode/next", "params": [ { "name": "bookingQueueCode", "value": "", "type": "path", "description": "booking queue code to get next item from." }, { "name": "SubQueueCode", "value": "", "type": "query", "description": "The optional sub queue code.\n " }, { "name": "StartDate", "value": "", "type": "query", "description": "Begin priority date.\n " }, { "name": "EndDate", "value": "", "type": "query", "description": "End priority date.\n " }, { "name": "Password", "value": "", "type": "query", "description": "The Password needed to access the queue. Required if queue\nis set to password-protected in Sky Manager.\n " } ] }, "docs": "This will not delete the item from the queue.\nThis action requires a session token.\n\nGraphQL endpoint: bookingQueueNextItemv2" }, { "info": { "name": "Places the booking queue item back on the queue.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/queues/bookings/items/:bookingQueueItemKey", "params": [ { "name": "bookingQueueItemKey", "value": "", "type": "path", "description": "The booking queue item key." }, { "name": "password", "value": "", "type": "query", "description": "The password needed to access the queue." } ] }, "docs": "This is solely to return existing booking queue items that have been dequeued (not deleted)\nvia GET `/api/nsk/v2/queues/bookings/{bookingQueueCode}/next`.\n\nGraphQL endpoint: bookingQueueReleaseItem" }, { "info": { "name": "Places the booking queue item back on the queue.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/queues/bookings/items/:bookingQueueItemKey", "params": [ { "name": "bookingQueueItemKey", "value": "", "type": "path", "description": "The booking queue item key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This is solely to return existing booking queue items that have been dequeued (not deleted)\nvia GET `/api/nsk/v2/queues/bookings/{bookingQueueCode}/next`." }, { "info": { "name": "Gets the list of booking queues that match the specified event type.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/queues/bookings/queueEvents/:queueEventType", "params": [ { "name": "queueEventType", "value": "", "type": "path", "description": "The queue event type. \nEnumeration values: 0 = Default, 1 = BookingBalanceDue, 2 = BookingNegativeBalance, 3 = BookingCustomerComment, 4 = DeclinedPaymentInitial, 5 = DeclinedPaymentChange, 6 = FareOverride, 7 = ScheduleTimeChange, 8 = ScheduleTimeChangeMisconnect, 9 = ScheduleCancellation, 10 = FlightDesignatorChange, 11 = ReaccommodationMove, 12 = GdsCancelWithPendingPayment, 13 = InvalidPriceStatusOverride, 14 = FareRestrictionOverride, 15 = HeldBookings, 16 = InvalidPriceStatus, 17 = Watchlist, 18 = NonFlightServiceFee, 19 = NotAllTicketNumbersReceived, 20 = BookingSegmentOversold, 21 = ReaccommodationCancel, 22 = ExternalSsrAutoConfirmed, 23 = OpCarrierSegUpdate, 24 = OpCarrierSsrUpdate, 25 = OpCarrierOtherUpdate, 26 = NameChangeNotAllowed, 27 = InboundAscNotProcessed, 28 = OpCarrierInformationChange, 29 = BookingComponentUpdate, 30 = GroupBookings, 31 = BankDirectPnrOutOfBalance, 32 = NoSeatAssigned, 33 = SeatNumberChange, 34 = SsrNotSupportedOnNewSeat, 35 = FewerSeatPreferencesMetOnNewSeat, 36 = AosUnableToConfirmCancel, 37 = ETicketIssue, 38 = ETicketFollowup, 39 = InvoluntaryFlyAhead, 40 = ManualClearanceOnOutage, 41 = UnbalancedPoints, 42 = OpCarrierTimeChange, 43 = OaCarrierTimeChange, 44 = VoluntaryFlightChange, 45 = InvoluntaryFlightChange, 46 = HoldCancellationFailed, 47 = ScheduleTimeChangeWithDynamicQueueCode, 48 = ReaccommodationMoveWithDynamicQueueCode, 49 = ItineraryIntegrity, 50 = ReducePartyNotProcessed, 51 = CheckedPassengerUpdate, 52 = MustBeSeatGroupViolation, 57 = NameChangeWithinRule, 58 = IncompletePassengerEMDCoupon, 59 = ASVCUpdateFailed, 60 = FailedFareClassRealignment, 61 = ScheduleTimeChangeMisconnectBelowMinimum, 62 = ScheduleTimeChangeMisconnectAboveMaximum, 63 = OpCarrierMisconnect, 64 = InventoryQueuing, 65 = SelfServiceAsm, 66 = SelfServiceDelay, 67 = SelfServiceFlightCancellation, 68 = SelfServiceIrop, 69 = SelfServiceScheduleChange, 70 = SelfServiceTimeChange, 71 = AosAddOrCancelNotSuccessful, 72 = MissingGdsFareFamily, 73 = ChangeCabinQueue, 74 = PendingPaymentQueue, 75 = TicketDisplayToDetermineIncludedServiceBundleFailed, 76 = DuplicateTicketsInBooking, 77 = TicketCouponUpdateQueue, 78 = ETicketRefund, 79 = ExternalEticketVoidCheck, 80 = ExternalEticketVoidCheckFollowUp, 81 = NoAssignedSeatOnNewFlightFromEquipmentChange" } ] }, "docs": "This action requires a session token.\n\"Default\" or \"0\" is not a valid queue event type and would return a 400 Bad Request.\n\nGraphQL endpoint: bookingQueuesByEventType" }, { "info": { "name": "Creates a new travel queue entry.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/queues/travel", "body": { "type": "json", "data": "{}" } }, "docs": "This action requires a session token.\n\nGraphQL endpoint: travelQueueEnqueueItem" }, { "info": { "name": "Pops the next item in the travel queue.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/queues/travel/:travelQueueCode/next", "params": [ { "name": "travelQueueCode", "value": "", "type": "path", "description": "Travel queue code to get next item from." }, { "name": "subQueueCode", "value": "", "type": "query", "description": "Sub queue code." } ] }, "docs": "This will delete the item from the queue.\nThis action requires a session token.\n\nGraphQL endpoint: travelQueueNextItem" } ] }, { "info": { "name": "redis", "type": "folder" }, "items": [ { "info": { "name": "Gets all the cache items that exist in redis.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/v1/redis" }, "docs": "Gets all the cache items that exist in redis." }, { "info": { "name": "Deletes all cache items.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/v1/redis" }, "docs": "This will ignore all session values. If an in memory cache is configured via \"cacheOptions.serverCache\" (default is\n5 minutes) other API instances may still have locally stale cached data\nfor the configured time." }, { "info": { "name": "Deletes a specific cache item from redis based on the cache item name.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/v1/redis/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "The name of the cache item." } ] }, "docs": "If an in memory cache is configured via \"cacheOptions.serverCache\" (default is 5 minutes) other API instances may\nstill have locally stale cached data\nfor the configured time." } ] }, { "info": { "name": "resources", "type": "folder" }, "items": [ { "info": { "name": "Retrieves the collection of account transaction code resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/AccountTransactionCodes", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceAccountTransactionCodes" }, { "info": { "name": "Retrieves the specific account transaction code resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/AccountTransactionCodes/:transactionCode", "params": [ { "name": "transactionCode", "value": "", "type": "path", "description": "The desired transaction code to retrieve." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The desired culture code for the resource." } ] }, "docs": "GraphQL endpoint: resourceAccountTransactionCode" }, { "info": { "name": "Retrieves the collection of address type resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/AddressTypes", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceAddressTypes" }, { "info": { "name": "Retrieves the specific address type resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/AddressTypes/:addressTypeCode", "params": [ { "name": "addressTypeCode", "value": "", "type": "path", "description": "The unique type code. Please note that this should be a char and not a string." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture code." } ] }, "docs": "GraphQL endpoint: resourceAddressType" }, { "info": { "name": "Retrieves the collection of area resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/Areas", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceAreas" }, { "info": { "name": "Retrieves the specific area resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/Areas/:areaCode", "params": [ { "name": "areaCode", "value": "", "type": "path", "description": "The unique area code." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The unique culture code." } ] }, "docs": "See `/api/nsk/v1/resources/areas/{areaCode}/zones` to retrieve the list of geographical zones associated with a\nspecific area.\n\nGraphQL endpoint: resourceArea" }, { "info": { "name": "Retrieves the collection of zones resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/Areas/:areaCode/zones", "params": [ { "name": "areaCode", "value": "", "type": "path", "description": "The unique code of the area to which the zones belong." }, { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceZonesv2" }, { "info": { "name": "Retrieves the specific zone resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/Areas/:areaCode/zones/:zoneCode", "params": [ { "name": "areaCode", "value": "", "type": "path", "description": "The unique code of the area to which the zone belongs." }, { "name": "zoneCode", "value": "", "type": "path", "description": "The unique zone code." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture code." } ] }, "docs": "GraphQL endpoint: resourceZonev2" }, { "info": { "name": "Retrieves the collection of baggage type resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/BaggageTypes", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceBaggageTypes" }, { "info": { "name": "Retrieves the specific baggage type resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/BaggageTypes/:baggageTypeCode", "params": [ { "name": "baggageTypeCode", "value": "", "type": "path", "description": "The unique baggage type code." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture code." } ] }, "docs": "GraphQL endpoint: resourceBaggageType" }, { "info": { "name": "Retrieves the collection of bundle configuration resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/bundles", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: bundles" }, { "info": { "name": "Retrieves a specific bundle configuration based on the bundle code.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/bundles/:bundleCode", "params": [ { "name": "bundleCode", "value": "", "type": "path", "description": "The bundle code." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The culture code." } ] }, "docs": "GraphQL endpoint: bundle" }, { "info": { "name": "Retrieves the collection of bundle application resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/bundles/applications", "params": [ { "name": "BundleRuleCode", "value": "", "type": "query", "description": "The bundle rule code.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The specific culture code.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache eTag for this request.\n " } ] }, "docs": "See api/nsk/v1/bundles/application/{bundleApplicationKey}/details to retrieve additional\nbundle application details. The application details consist of three lists: carrier codes,\nproduct classes, and classes of service.\n\nGraphQL endpoint: bundleApplications" }, { "info": { "name": "Retrieves the collection of bundle rule resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/bundles/rules", "params": [ { "name": "eTag", "value": "", "type": "query", "description": "The unique etag ID." } ] }, "docs": "See api/nsk/v1/bundles/rule/{bundleRuleCode}/details to retrieve a list of bundle\napplications associated with a specific bundle rule.\nBundle rules are used to control where and how bundle applications are used.\n\nGraphQL endpoint: bundleRules" }, { "info": { "name": "Retrieves the collection of bundle set resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/bundles/sets", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "See api/nsk/v1/bundles/set/{bundleSetCode}/details to retrieve a list of bundle\ncodes associated with a specific bundle set.\n\nGraphQL endpoint: bundleSets" }, { "info": { "name": "Retrieves the collection of bundle ssr configurations associated with\nthe bundle code.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/bundles/ssrs", "params": [ { "name": "BundleCode", "value": "", "type": "query", "description": "The bundle code.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The specific culture code.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache eTag for this request.\n " } ] }, "docs": "GraphQL endpoint: bundleSsrs" }, { "info": { "name": "Retrieves the collection of carrier resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/carriers", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceCarriers" }, { "info": { "name": "Retrieves a single carrier.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/carriers/:carrierCode", "params": [ { "name": "carrierCode", "value": "", "type": "path", "description": "The unique carrier code." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture code." }, { "name": "eTag", "value": "", "type": "query", "description": "The eTag." } ] }, "docs": "GraphQL endpoint: resourceCarrierv2" }, { "info": { "name": "Retrieves the collection of city resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/Cities", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceCities" }, { "info": { "name": "Retrieves the specific city resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/Cities/:cityCode", "params": [ { "name": "cityCode", "value": "", "type": "path", "description": "The unique city code." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture code." } ] }, "docs": "GraphQL endpoint: resourceCity" }, { "info": { "name": "Retrieves the collection of class of service resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/ClassOfServices", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceClassOfServices" }, { "info": { "name": "Retrieves the resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/ClassOfServices/:classOfServiceCode", "params": [ { "name": "classOfServiceCode", "value": "", "type": "path", "description": "The unique class of service code." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture code." } ] }, "docs": "GraphQL endpoint: resourceClassOfService" }, { "info": { "name": "Retrieves the collection of commission rate resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/CommissionRates", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceCommissionRates" }, { "info": { "name": "Retrieves the specific commission rate resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/CommissionRates/:commissionRateCode", "params": [ { "name": "commissionRateCode", "value": "", "type": "path", "description": "The unique commission rate code." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture code." } ] }, "docs": "GraphQL endpoint: resourceCommissionRate" }, { "info": { "name": "Retrieves the collection of contact type resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/ContactTypes", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceContactTypes" }, { "info": { "name": "Retrieves the specific contact type resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/ContactTypes/:contactTypeCode", "params": [ { "name": "contactTypeCode", "value": "", "type": "path", "description": "The unique contact type code. Please note that this should be a char and not a string." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture code." } ] }, "docs": "GraphQL endpoint: resourceContactType" }, { "info": { "name": "Searches the contents based on the search criteria provided.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/contents", "params": [ { "name": "Name", "value": "", "type": "query", "description": "Name of the content.\n " }, { "name": "Type", "value": "", "type": "query", "description": "Specific content type.\n \nEnumeration values: 0 = GeneralReference, 1 = News, 2 = ConsoleHelp, 3 = FareRuleReference, 4 = ReviewWithCustomer, 8 = Image, 9 = PromotionReference, 10 = SubscriptionReference" }, { "name": "ContainerId", "value": "", "type": "query", "description": "Unique id of the container.\n " }, { "name": "PageSize", "value": "", "type": "query", "description": "The default page size.\n " }, { "name": "LastContentId", "value": "", "type": "query", "description": "Used to specify the last item of the page of the last set of records retrieved\nwhen paging was performed. This is optional.\n " } ] }, "docs": "Searches the contents based on the search criteria provided." }, { "info": { "name": "Retrieves a resource setting and its related information.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/contents/:contentId", "params": [ { "name": "contentId", "value": "", "type": "path", "description": "The content id." }, { "name": "convertRtfToHtml", "value": "", "type": "query", "description": "The bool to determine whether or not to convert RTF to HTML data." }, { "name": "eTag", "value": "", "type": "query", "description": "ETag for caching." } ] }, "docs": "This is a post to easily allow special path characters.\nSee /resources/settings/data to avoid manually parsing the data." }, { "info": { "name": "Deletes a content item.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/contents/:contentId", "params": [ { "name": "contentId", "value": "", "type": "path", "description": "The content identifier." } ] }, "docs": "This endpoint currently only supports deleting news content items.\nDeletion of other content types will be supported in the future.\n\nGraphQL endpoint: resourceContentDeletev2" }, { "info": { "name": "Retrieves resource setting data based on the accept content type.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/contents/:contentId/data", "params": [ { "name": "contentId", "value": "", "type": "path", "description": "The content id." }, { "name": "convertRtfToHtml", "value": "", "type": "query", "description": "The bool to determine whether or not to convert RTF to HTML data." }, { "name": "eTag", "value": "", "type": "query", "description": "ETag for caching." } ] }, "docs": "This is a post to easily allow special path characters.\nIf the data returned is not in HTML format and convertRtfToHtml is set to true,\nthe content requested was of an incompatible data type." }, { "info": { "name": "Retrieves the collection of country resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/resources/countries", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceCountriesv2" }, { "info": { "name": "Retrieves a specific country resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/resources/countries/:countryCode", "params": [ { "name": "countryCode", "value": "", "type": "path", "description": "The unique country code." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture code." } ] }, "docs": "GraphQL endpoint: resourceCountryv2" }, { "info": { "name": "Retrieves the resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/cultures", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceCultures" }, { "info": { "name": "Retrieves the resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/cultures/:cultureCode", "params": [ { "name": "cultureCode", "value": "", "type": "path", "description": "The unique culture code." }, { "name": "forCultureCode", "value": "", "type": "query", "description": "The for culture." } ] }, "docs": "GraphQL endpoint: resourceCulture" }, { "info": { "name": "Retrieves the collection of currency resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/resources/currencies", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceCurrenciesv2" }, { "info": { "name": "Retrieves the specific currency resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/resources/currencies/:currencyCode", "params": [ { "name": "currencyCode", "value": "", "type": "path", "description": "The unique currency code." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture code." } ] }, "docs": "GraphQL endpoint: resourceCurrencyv2" }, { "info": { "name": "Retrieves the collection of customer program resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/resources/customerPrograms", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceCustomerProgramsv2" }, { "info": { "name": "Retrieves the collection of customer program resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/CustomerPrograms", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceCustomerPrograms" }, { "info": { "name": "Retrieves the specific customer program resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/resources/customerPrograms/:programCode", "params": [ { "name": "programCode", "value": "", "type": "path", "description": "The unique program code." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture code." } ] }, "docs": "GraphQL endpoint: resourceCustomerProgramv2" }, { "info": { "name": "Retrieves the specific customer program resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/CustomerPrograms/:programCode", "params": [ { "name": "programCode", "value": "", "type": "path", "description": "The unique program code." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture code." } ] }, "docs": "GraphQL endpoint: resourceCustomerProgram" }, { "info": { "name": "Retrieves the specific program level.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/CustomerPrograms/:programCode/levels/:programLevelCode", "params": [ { "name": "programCode", "value": "", "type": "path", "description": "The unique program code." }, { "name": "programLevelCode", "value": "", "type": "path", "description": "The unique program level code." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The culture code." } ] }, "docs": "Retrieves the specific program level." }, { "info": { "name": "Retrieves the collection of delay resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/Delays", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceDelays" }, { "info": { "name": "Retrieves the specific delay resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/Delays/:delayCode", "params": [ { "name": "delayCode", "value": "", "type": "path", "description": "The unique delay code." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture code." } ] }, "docs": "GraphQL endpoint: resourceDelay" }, { "info": { "name": "Retrieves the collection of department resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/Departments", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceDepartments" }, { "info": { "name": "Retrieves the specific department resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/Departments/:departmentCode", "params": [ { "name": "departmentCode", "value": "", "type": "path", "description": "The unique department code." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture code." } ] }, "docs": "GraphQL endpoint: resourceDepartment" }, { "info": { "name": "Retrieves the localizations.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/distributionOptions", "params": [ { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: localizationDistributionOptions" }, { "info": { "name": "Retrieves the collection of document type resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/DocumentTypes", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceDocumentTypes" }, { "info": { "name": "Retrieves the specific document type resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/DocumentTypes/:documentTypeCode", "params": [ { "name": "documentTypeCode", "value": "", "type": "path", "description": "The unique document type code." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture code." } ] }, "docs": "GraphQL endpoint: resourceDocumentType" }, { "info": { "name": "Retrieves the collection of domain resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/Domains", "params": [ { "name": "eTag", "value": "", "type": "query", "description": "The unique etag ID." } ] }, "docs": "GraphQL endpoint: resourceDomains" }, { "info": { "name": "Retrieves the specific domain resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/Domains/:domainCode", "params": [ { "name": "domainCode", "value": "", "type": "path", "description": "The unique domain code." } ] }, "docs": "GraphQL endpoint: resourceDomain" }, { "info": { "name": "Retrieves the collection of email type resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/EmailTypes", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceEmailTypes" }, { "info": { "name": "Retrieves the specific email type resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/EmailTypes/:emailTypeCode", "params": [ { "name": "emailTypeCode", "value": "", "type": "path", "description": "The unique email type code. Please note that this should be a char and not a string." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture code." } ] }, "docs": "GraphQL endpoint: resourceEmailType" }, { "info": { "name": "Retrieves the collection of external rate resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/ExternalRates", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "The external rates cache expiration is configurable as a number of minutes past the hour to expire. This\nshould allow for better alignment with third party external rates providers' recommendations, which typically\nstate that external rates cache items should expire 5-7 minutes past the hour. This can be configured in\nthe NskSystemOptions.ExternalRatesExpiration. If no value is set, the API will default to five minutes\npast the hour.\nIf the value \"Enable External Currency Conversion\" is disab" }, { "info": { "name": "Retrieves the specific external rate resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/ExternalRates/:rateId", "params": [ { "name": "rateId", "value": "", "type": "path", "description": "The unique rate ID." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture code." } ] }, "docs": "The external rates cache expiration is configurable as a number of minutes past the hour to expire. This\nshould allow for better alignment with third party external rates providers' recommendations, which typically\nstate that external rates cache items should expire 5-7 minutes past the hour. This can be configured in\nthe NskSystemOptions.ExternalRatesExpiration. If no value is set, the API will default to five minutes\npast the hour.\nIf the value \"Enable External Currency Conversion\" is disab" }, { "info": { "name": "Retrieves the collection of external system resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/ExternalSystems", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceExternalSystems" }, { "info": { "name": "Retrieves a single external system resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/resources/externalSystems/:systemCode", "params": [ { "name": "systemCode", "value": "", "type": "path", "description": "The unique external system code." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture code." } ] }, "docs": "GraphQL endpoint: resourceExternalSystemv2" }, { "info": { "name": "Retrieves the list of fare basis codes.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/fareBasisCodes", "params": [ { "name": "eTag", "value": "", "type": "query", "description": "The unique etag ID." } ] }, "docs": "GraphQL endpoint: resourceFareBasisCodes" }, { "info": { "name": "Retrieves a collection of fare discount resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/fareDiscounts", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceFareDiscounts" }, { "info": { "name": "Retrieves a specific fare discount resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/fareDiscounts/:fareDiscountCode", "params": [ { "name": "fareDiscountCode", "value": "", "type": "path", "description": "The unique fare discount code." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture code." } ] }, "docs": "GraphQL endpoint: resourceFareDiscount" }, { "info": { "name": "Retrieves a collection of fare surcharge resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/fareSurcharges", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceFareSurcharges" }, { "info": { "name": "Retrieves a specific fare surcharge resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/fareSurcharges/:fareSurchargeCode", "params": [ { "name": "fareSurchargeCode", "value": "", "type": "path", "description": "The unique fare surcharge code." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture code." } ] }, "docs": "GraphQL endpoint: resourceFareSurcharge" }, { "info": { "name": "Retrieves the collection of fare type resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/FareTypes", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceFareTypes" }, { "info": { "name": "Retrieves the specific fare type resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/FareTypes/:fareTypeCode", "params": [ { "name": "fareTypeCode", "value": "", "type": "path", "description": "The unique fare type code." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture code." } ] }, "docs": "GraphQL endpoint: resourceFareType" }, { "info": { "name": "Retrieves the collection of fee resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/Fees", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceFees" }, { "info": { "name": "Retrieves the specific fee resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/Fees/:feeCode", "params": [ { "name": "feeCode", "value": "", "type": "path", "description": "The unique fee code." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture code." } ] }, "docs": "GraphQL endpoint: resourceFee" }, { "info": { "name": "Gets the fee options.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/fees/:feeCode/details", "params": [ { "name": "feeCode", "value": "", "type": "path", "description": "The unique fee code." } ] }, "docs": "Note, this endpoint is not cached like other resource endpoints.\nThe NSK enumeration \"TSI.GroundTimeBeforeDepartureFromConnectionWithin\" is synonymous with\n\"TravelSegmentIndicator.DepartureWithinStopoverTime\".\nThe NSK enumeration \"TSI.GroundTimeBeforeDepartureFromConnectionExceeds\" is synonymous with\n\"TravelSegmentIndicator.DepartureExceedsStopoverTime\".\n\nGraphQL endpoint: feeDetails" }, { "info": { "name": "Retrieves the localizations.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/genders", "params": [ { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: localizationGender" }, { "info": { "name": "Retrieves the collection of hot card reason resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/HotCardReasons", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceHotCardReasons" }, { "info": { "name": "Retrieves the specific hot card reason resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/HotCardReasons/:hotCardReasonCode", "params": [ { "name": "hotCardReasonCode", "value": "", "type": "path", "description": "The unique hot card reason." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture code." } ] }, "docs": "GraphQL endpoint: resourceHotCardReason" }, { "info": { "name": "Retrieves the collection of issuance reason resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/IssuanceReasons", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceIssuanceReasons" }, { "info": { "name": "Retrieves the specific issuance reason resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/IssuanceReasons/:issuanceReasonCode", "params": [ { "name": "issuanceReasonCode", "value": "", "type": "path", "description": "The unique issuance reason code." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture code." } ] }, "docs": "GraphQL endpoint: resourceIssuanceReason" }, { "info": { "name": "Retrieves the collection of location resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/Locations", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceLocations" }, { "info": { "name": "Retrieves the specific location resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/Locations/:locationCode", "params": [ { "name": "locationCode", "value": "", "type": "path", "description": "The code for the desired location resource." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The desired culture code for the resource." } ] }, "docs": "GraphQL endpoint: resourceLocation" }, { "info": { "name": "Retrieves the collection of mac resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/resources/macs", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceMacsv2" }, { "info": { "name": "Retrieves the specific mac resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/Macs/:macCode", "params": [ { "name": "macCode", "value": "", "type": "path", "description": "The unique mac code." } ] }, "docs": "GraphQL endpoint: resourceMac" }, { "info": { "name": "Retrieves the collection of market route resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/marketRoutes", "params": [ { "name": "DepartureStation", "value": "", "type": "query", "description": "Gets or sets the departure station for this request.\n " }, { "name": "ArrivalStation", "value": "", "type": "query", "description": "Gets or sets the arrival station for this request.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache eTag for this request.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceMarketRoutes" }, { "info": { "name": "Retrieves the collection of market resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/resources/markets", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceMarketsv2" }, { "info": { "name": "Retrieves a specific market resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/resources/markets/:locationCode", "params": [ { "name": "locationCode", "value": "", "type": "path", "description": "The unique location code." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture code." } ] }, "docs": "GraphQL endpoint: resourceMarketByLocationv2" }, { "info": { "name": "Retrieves the resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/resources/markets/:locationCode/:travelLocationCode", "params": [ { "name": "locationCode", "value": "", "type": "path", "description": "The code for the desired location resource." }, { "name": "travelLocationCode", "value": "", "type": "path", "description": "The code for the desired travel location resource." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The desired culture code for the resource." } ] }, "docs": "GraphQL endpoint: resourceMarketv2" }, { "info": { "name": "Retrieves the collection of message type resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/MessageTypes", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceMessageTypes" }, { "info": { "name": "Retrieves the specific message type resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/MessageTypes/:messageTypeCode", "params": [ { "name": "messageTypeCode", "value": "", "type": "path", "description": "The unique message type code." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture code." } ] }, "docs": "GraphQL endpoint: resourceMessageType" }, { "info": { "name": "Retrieves the collection of non-binary genders configured in the system.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/nonBinaryGenders", "params": [ { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture code." }, { "name": "eTag", "value": "", "type": "query", "description": "The eTag." } ] }, "docs": "If the `Enable Gender Neutral` settings is unchecked, only the `M (Male)` and `F (Female)` are considered as valid\nnon-binary genders for passengers.\n\nGraphQL endpoint: resourceNonBinaryGenders" }, { "info": { "name": "Retrieves the specified non-binary gender.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/nonBinaryGenders/:code", "params": [ { "name": "code", "value": "", "type": "path", "description": "The unique non-binary gender code." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture code." }, { "name": "eTag", "value": "", "type": "query", "description": "The eTag." } ] }, "docs": "GraphQL endpoint: resourceNonBinaryGender" }, { "info": { "name": "Retrieves the localizations.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/organizationStatuses", "params": [ { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: localizationOrganizationStatus" }, { "info": { "name": "Retrieves the collection of passenger discount resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/PassengerDiscounts", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourcePassengerDiscounts" }, { "info": { "name": "Retrieves the specific passenger discount resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/PassengerDiscounts/:passengerDiscountCode", "params": [ { "name": "passengerDiscountCode", "value": "", "type": "path", "description": "The unique passenger discount code." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture code." } ] }, "docs": "GraphQL endpoint: resourcePassengerDiscount" }, { "info": { "name": "Retrieves the collection of role-based passenger type resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/PassengerTypes", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourcePassengerTypes" }, { "info": { "name": "Retrieves the specific role-based passenger type resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/PassengerTypes/:passengerTypeCode", "params": [ { "name": "passengerTypeCode", "value": "", "type": "path", "description": "The unique passenger type code." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture code." } ] }, "docs": "GraphQL endpoint: resourcePassengerType" }, { "info": { "name": "Retrieves the collection of payment method resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/PaymentMethods", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " }, { "name": "currencyCode", "value": "", "type": "query", "description": "The currency code." } ] }, "docs": "GraphQL endpoint: resourcePaymentMethods" }, { "info": { "name": "Retrieves the specific payment method resources that match the payment method code. If the payment method\ntype is set, returns a list with a single payment method that matches both the payment method code and the\npayment method type.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/resources/paymentMethods/:paymentMethodCode", "params": [ { "name": "paymentMethodCode", "value": "", "type": "path", "description": "The unique payment method code." }, { "name": "PaymentMethodType", "value": "", "type": "query", "description": "The payment method type.\n \nEnumeration values: 0 = ExternalAccount, 1 = PrePaid, 2 = AgencyAccount, 3 = CustomerAccount, 4 = Voucher, 5 = Loyalty" }, { "name": "CurrencyCode", "value": "", "type": "query", "description": "The payment method code.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The payment method code.\n " } ] }, "docs": "A payment method is considered unique based on the payment method code and the payment method type.\n\nGraphQL endpoint: resourcePaymentMethodv2" }, { "info": { "name": "Retrieves the specific payment method resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/PaymentMethods/:paymentMethodCode", "params": [ { "name": "paymentMethodCode", "value": "", "type": "path", "description": "The unique payment method code." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture code." }, { "name": "currencyCode", "value": "", "type": "query", "description": "The specific currency code." } ] }, "docs": "GraphQL endpoint: resourcePaymentMethod" }, { "info": { "name": "Retrieves the collection of person information type resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/PersonInformationTypes", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourcePersonInfoTypes" }, { "info": { "name": "Retrieves the specific person information type resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/PersonInformationTypes/:personInformationTypeCode", "params": [ { "name": "personInformationTypeCode", "value": "", "type": "path", "description": "The unique person information type code. Please note that this should be a char\nand not a string.\n " }, { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture code." } ] }, "docs": "GraphQL endpoint: resourcePersonInfoType" }, { "info": { "name": "Retrieves the collection of phone number type resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/PhoneTypes", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourcePhoneTypes" }, { "info": { "name": "Retrieves the specific phone number type resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/PhoneTypes/:phoneTypeCode", "params": [ { "name": "phoneTypeCode", "value": "", "type": "path", "description": "The unique phone type. Please note that this should be a char and not a string." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture code." } ] }, "docs": "GraphQL endpoint: resourcePhoneType" }, { "info": { "name": "Retrieves the collection of postal codes resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/postalCodes", "params": [ { "name": "CountryCode", "value": "", "type": "query", "description": "The country code.\n " }, { "name": "ProvinceStateCode", "value": "", "type": "query", "description": "The province state code.\n " }, { "name": "City", "value": "", "type": "query", "description": "The city.\n " }, { "name": "PageSize", "value": "", "type": "query", "description": "The default page size.\n " }, { "name": "LastPageKey", "value": "", "type": "query", "description": "Used to specify the last item of the page of the last set of records retrieved\nwhen paging was performed. This is optional.\n " }, { "name": "PostalCode", "value": "", "type": "query", "description": "The postal code.\n " } ] }, "docs": "GraphQL endpoint: resourcePostalCodes" }, { "info": { "name": "Retrieves the postal code resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/postalCodes/:postalCode", "params": [ { "name": "postalCode", "value": "", "type": "path", "description": "The unique postal code." } ] }, "docs": "GraphQL endpoint: resourcePostalCode" }, { "info": { "name": "Retrieves a collection of printer resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/printers", "params": [ { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourcePrinters" }, { "info": { "name": "Retrieves a specific printer resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/printers/:printerCode", "params": [ { "name": "printerCode", "value": "", "type": "path", "description": "The unique printer code." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture code." } ] }, "docs": "GraphQL endpoint: resourcePrinter" }, { "info": { "name": "Retrieves the collection of product class resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/ProductClasses", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceProductClasses" }, { "info": { "name": "Retrieves the specific product class resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/ProductClasses/:productClassCode", "params": [ { "name": "productClassCode", "value": "", "type": "path", "description": "The code identifying the specific product class to retrieve." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The desired culture code for the resource." } ] }, "docs": "GraphQL endpoint: resourceProductClass" }, { "info": { "name": "Retrieves the collection of promotion setting type resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/PromotionSettingTypes", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourcePromotionSettingTypes" }, { "info": { "name": "Retrieves the specific promotion setting type resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/PromotionSettingTypes/:promotionSettingsTypeCode", "params": [ { "name": "promotionSettingsTypeCode", "value": "", "type": "path", "description": "The code identifying the promotion settings type resource to retrieve" }, { "name": "cultureCode", "value": "", "type": "query", "description": "The desired culture code for the resource." } ] }, "docs": "GraphQL endpoint: resourcePromotionSettingType" }, { "info": { "name": "Retrieves the collection of province state resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/ProvinceStates", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceProvinceStates" }, { "info": { "name": "Retrieves the specific province state resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/ProvinceStates/:provinceStateCode", "params": [ { "name": "provinceStateCode", "value": "", "type": "path", "description": "The unique province state code." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture code." } ] }, "docs": "GraphQL endpoint: resourceProvinceState" }, { "info": { "name": "Gets a response with a list of QueueCategories that match the given parameters.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/queue/categories", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: queueCategoryResource" }, { "info": { "name": "Gets a response with a single QueueCategory that match the given parameters.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/queue/categories/:queueCategoryCode", "params": [ { "name": "queueCategoryCode", "value": "", "type": "path", "description": "Queue Category Code being requested. Please note that this should be a char and not a\nstring.\n " }, { "name": "cultureCode", "value": "", "type": "query", "description": "[Optional] The culture code for the resources." } ] }, "docs": "GraphQL endpoint: queueCategoryResourceById" }, { "info": { "name": "Retrieves the collection of reminder time resource that contains valid times for all passenger travel notification\ntimed events.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/reminderTimes", "params": [ { "name": "eTag", "value": "", "type": "query", "description": "The unique etag ID." } ] }, "docs": "GraphQL endpoint: resourceReminderTimes" }, { "info": { "name": "Retrieves a specific reminder time resource that contains valid times for a passenger travel notification timed\nevent.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/reminderTimes/:timedEventType", "params": [ { "name": "timedEventType", "value": "", "type": "path", "description": "The timed event type. \nEnumeration values: 0 = Departure, 1 = Arrival" } ] }, "docs": "GraphQL endpoint: resourceReminderTime" }, { "info": { "name": "BETA - Creates a new role.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/roles", "body": { "type": "json", "data": "{}" } }, "docs": "This is a beta endpoint and is not currently a long term supported endpoint. This endpoint may\nbe removed in future updates. Beta endpoints are not available in all labs or for all customers of the API.\nThis endpoint is part of the Allow Edit on Settings And Resources feature that is currently in progress.\n\nGraphQL endpoint: resourceRoleAdd" }, { "info": { "name": "Retrieves the role resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/resources/roles", "params": [ { "name": "eTag", "value": "", "type": "query", "description": "The unique etag ID." } ] }, "docs": "GraphQL endpoint: resourceRolesv2" }, { "info": { "name": "BETA - Delete a role.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/roles/:roleCode", "params": [ { "name": "roleCode", "value": "", "type": "path", "description": "The role code." } ] }, "docs": "This is a beta endpoint and is not currently a long term supported endpoint. This endpoint may\nbe removed in future updates. Beta endpoints are not available in all labs or for all customers of the API.\nThis endpoint is part of the Allow Edit on Settings And Resources feature that is currently in progress.\n\nGraphQL endpoint: resourceRoleDelete" }, { "info": { "name": "Retrieves a single role resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/resources/roles/:roleCode", "params": [ { "name": "roleCode", "value": "", "type": "path", "description": "The unique role code." } ] }, "docs": "GraphQL endpoint: resourceRolev2" }, { "info": { "name": "Retrieves the resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/roles/:roleCode/settings", "params": [ { "name": "roleCode", "value": "", "type": "path", "description": "The unique role code." } ] }, "docs": "GraphQL endpoint: resourceRoleSettings" }, { "info": { "name": "Retrieves the collection of role setting resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/RoleSettingTypes", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceRoleSettingTypes" }, { "info": { "name": "Retrieves the specific role setting resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/RoleSettingTypes/:roleSettingTypeCode", "params": [ { "name": "roleSettingTypeCode", "value": "", "type": "path", "description": "The unique role setting type code." } ] }, "docs": "GraphQL endpoint: resourceRoleSettingType" }, { "info": { "name": "Retrieves the localizations.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/searchTypes", "params": [ { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: localizationSearchType" }, { "info": { "name": "Retrieves a list of seat property types.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/resources/seatPropertyTypes", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceSeatPropertyTypes" }, { "info": { "name": "Retrieves a single seat property type resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/resources/seatPropertyTypes/:seatPropertyTypeCode", "params": [ { "name": "seatPropertyTypeCode", "value": "", "type": "path", "description": "The unique seat property type code." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture code." } ] }, "docs": "GraphQL endpoint: resourceSeatPropertyTypev2" }, { "info": { "name": "Retrieves a resource setting and its related information.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/settings", "params": [ { "name": "eTag", "value": "", "type": "query", "description": "ETag for caching." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This is a post to easily allow special path characters.\nSee /resources/settings/data to avoid manually parsing the data.\n\nGraphQL endpoint: resourceSettingCategory" }, { "info": { "name": "Retrieves resource setting data based on the accept content type.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/settings/data", "params": [ { "name": "eTag", "value": "", "type": "query", "description": "ETag for caching." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This is a post to easily allow special path characters.\n\nGraphQL endpoint: resourceSettingCategoryJson" }, { "info": { "name": "Retrieves the collection of shopping attribute group resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/ShoppingAttributeGroups", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceShoppingAttributeGroups" }, { "info": { "name": "Retrieves the specific shopping attribute group resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/ShoppingAttributeGroups/:shoppingAttributeGroupCode", "params": [ { "name": "shoppingAttributeGroupCode", "value": "", "type": "path", "description": "The unique shopping attribute group code." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture code." } ] }, "docs": "GraphQL endpoint: resourceShoppingAttributeGroup" }, { "info": { "name": "Retrieves the collection of shopping attribute resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/ShoppingAttributes", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceShoppingAttributes" }, { "info": { "name": "Retrieves the specific shopping attribute resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/ShoppingAttributes/:shoppingAttributeCode", "params": [ { "name": "shoppingAttributeCode", "value": "", "type": "path", "description": "The unique shopping attribute code." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture code." } ] }, "docs": "GraphQL endpoint: resourceShoppingAttribute" }, { "info": { "name": "Retrieves a list of available single sign on providers.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/singleSignOnProvider", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: singleSignOnProviders" }, { "info": { "name": "Retrieves a specific single sign on provider.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/singleSignOnProvider/:providerName", "params": [ { "name": "providerName", "value": "", "type": "path", "description": "The single sign on provider name." } ] }, "docs": "GraphQL endpoint: singleSignOnProviderByName" }, { "info": { "name": "Retrieves the collection of ssr group resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/SsrGroups", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceSsrGroups" }, { "info": { "name": "Retrieves the specific ssr group resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/SsrGroups/:ssrGroupCode", "params": [ { "name": "ssrGroupCode", "value": "", "type": "path", "description": "The SSR Group Code wanted." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture code." } ] }, "docs": "GraphQL endpoint: resourceSsrGroup" }, { "info": { "name": "Retrieves the collection of ssr nest resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/SsrNests", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceSsrNests" }, { "info": { "name": "Retrieves the specific ssr nest resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/SsrNests/:ssrNestCode", "params": [ { "name": "ssrNestCode", "value": "", "type": "path", "description": "The unique ssr nest code." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture code." } ] }, "docs": "GraphQL endpoint: resourceSsrNest" }, { "info": { "name": "Retrieves the collection of ssr restriction result resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/SsrRestrictionResults", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceSsrRestrictionResults" }, { "info": { "name": "Retrieves the specific ssr restriction result. resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/SsrRestrictionResults/:ssrRestrictionResultCode", "params": [ { "name": "ssrRestrictionResultCode", "value": "", "type": "path", "description": "The unique ssr restriction result code." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The unique culture code." } ] }, "docs": "GraphQL endpoint: resourceSsrRestrictionResult" }, { "info": { "name": "Retrieves the collection of ssr resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/Ssrs", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceSsrs" }, { "info": { "name": "Retrieves the specific ssr resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/Ssrs/:ssrCode", "params": [ { "name": "ssrCode", "value": "", "type": "path", "description": "The unique ssr code." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture code." } ] }, "docs": "GraphQL endpoint: resourceSsr" }, { "info": { "name": "Retrieves the collection of standby priority resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/StandByPriorities", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceStandByPriorities" }, { "info": { "name": "Retrieves the specific standby priority resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/StandByPriorities/:standByPriorityCode", "params": [ { "name": "standByPriorityCode", "value": "", "type": "path", "description": "The unique standby priority code." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture code." } ] }, "docs": "GraphQL endpoint: resourceStandByPriority" }, { "info": { "name": "Retrieves the collection of station category resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/StationCategories", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceStationCategories" }, { "info": { "name": "Retrieves the specific station category resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/StationCategories/:stationCategoryCode", "params": [ { "name": "stationCategoryCode", "value": "", "type": "path", "description": "The unique station category code. Please note that this should be a char and not a\nstring.\n " }, { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture code." } ] }, "docs": "GraphQL endpoint: resourceStationCategory" }, { "info": { "name": "BETA - Creates a new station.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/beta/resources/stations", "body": { "type": "json", "data": "{}" } }, "docs": "This is a beta endpoint and is not currently a long term supported endpoint. This endpoint may\nbe removed in future updates. Beta endpoints are not available in all labs or for all customers of the API.\nThis endpoint is part of the Allow Edit on Settings And Resources feature that is currently in progress.\nThis endpoint is also currently having some performance issues, expect delays when a request is submitted.\nThe performance issues will be resolved prior to taking this endpoint out of beta.\n\nG" }, { "info": { "name": "Retrieves the collection of station resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/Stations", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceStations" }, { "info": { "name": "BETA - Updates a station.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/beta/resources/stations/:stationCode", "params": [ { "name": "stationCode", "value": "", "type": "path", "description": "The unique identifier of a station." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This is a beta endpoint and is not currently a long term supported endpoint. This endpoint may\nbe removed in future updates. Beta endpoints are not available in all labs or for all customers of the API.\nThis endpoint is part of the Allow Edit on Settings And Resources feature that is currently in progress.\nThis endpoint is also currently having some performance issues, expect delays when a request is submitted.\nThe performance issues will be resolved prior to taking this endpoint out of beta.\n\nG" }, { "info": { "name": "BETA - Modifies a station.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/beta/resources/stations/:stationCode", "params": [ { "name": "stationCode", "value": "", "type": "path", "description": "The unique identifier of a station." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This is a beta endpoint and is not currently a long term supported endpoint. This endpoint may\nbe removed in future updates. Beta endpoints are not available in all labs or for all customers of the API.\nThis endpoint is part of the Allow Edit on Settings And Resources feature that is currently in progress.\nThis endpoint is also currently having some performance issues, expect delays when a request is submitted.\nThe performance issues will be resolved prior to taking this endpoint out of beta.\n\nG" }, { "info": { "name": "Retrieves the specific station resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/Stations/:stationCode", "params": [ { "name": "stationCode", "value": "", "type": "path", "description": "The unique station code." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture code." }, { "name": "eTag", "value": "", "type": "query", "description": "The eTag." } ] }, "docs": "GraphQL endpoint: resourceStationv2" }, { "info": { "name": "Get the station details.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/stations/:stationCode/details", "params": [ { "name": "stationCode", "value": "", "type": "path", "description": "The station code." } ] }, "docs": "Note this endpoint is not cached like other resource endpoints.\n\nGraphQL endpoint: resourceStationDetails" }, { "info": { "name": "Gets a response with stations filtered by category.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/stations/category/:stationCategoryCode", "params": [ { "name": "stationCategoryCode", "value": "", "type": "path", "description": "The unique station category code. Please note that this should be a char and not a\nstring.\n " }, { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "This endpoint is resource intensive until cached.\n\nGraphQL endpoint: resourceStationsByCategory" }, { "info": { "name": "Retrieves the collection of suffix resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/Suffixes", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceSuffixes" }, { "info": { "name": "Retrieves the specific suffix resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/Suffixes/:suffixCode", "params": [ { "name": "suffixCode", "value": "", "type": "path", "description": "The unique suffix code." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture for the suffix." } ] }, "docs": "GraphQL endpoint: resourceSuffix" }, { "info": { "name": "Retrieves the tail number inventory.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/dcs/v1/resources/tailNumbers", "params": [ { "name": "eTag", "value": "", "type": "query", "description": "The resource eTag." } ] }, "docs": "GraphQL endpoint: dcsResourceTailNumberInventory" }, { "info": { "name": "Retrieves the collection of time zone resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/TimeZones", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceTimeZones" }, { "info": { "name": "Retrieves the specific time zone resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/TimeZones/:timeZoneCode", "params": [ { "name": "timeZoneCode", "value": "", "type": "path", "description": "The unique time zone code." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture code." }, { "name": "eTag", "value": "", "type": "query", "description": "The eTag." } ] }, "docs": "GraphQL endpoint: resourceTimeZonev2" }, { "info": { "name": "Retrieves the collection of title resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/Titles", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceTitles" }, { "info": { "name": "Retrieves the specific title resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/Titles/:titleKey", "params": [ { "name": "titleKey", "value": "", "type": "path", "description": "The unique title key." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture for the title." } ] }, "docs": "GraphQL endpoint: resourceTitle" }, { "info": { "name": "Retrieves the collection of travel class resources.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/TravelClasses", "params": [ { "name": "ActiveOnly", "value": "", "type": "query", "description": "Flag indicating to return just active only or all.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code to be returned.\n " }, { "name": "ETag", "value": "", "type": "query", "description": "The cache token for this request. Data will not be returned if etag still matches.\n " }, { "name": "StartIndex", "value": "", "type": "query", "description": "The start index value for this request.\n " }, { "name": "ItemCount", "value": "", "type": "query", "description": "The item count value for this request.\n " } ] }, "docs": "GraphQL endpoint: resourceTravelClasses" }, { "info": { "name": "Retrieves the specific travel class resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/TravelClasses/:travelClassCode", "params": [ { "name": "travelClassCode", "value": "", "type": "path", "description": "The unique travel class code." }, { "name": "cultureCode", "value": "", "type": "query", "description": "The specific culture code." } ] }, "docs": "GraphQL endpoint: resourceTravelClass" }, { "info": { "name": "Retrieves a collection of traveler notification resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/travelerNotifications", "params": [ { "name": "eTag", "value": "", "type": "query", "description": "The unique etag ID." } ] }, "docs": "GraphQL endpoint: resourceTravelerNotifications" }, { "info": { "name": "Retrieves the specified traveler notification resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/travelerNotifications/:notificationTypeCode", "params": [ { "name": "notificationTypeCode", "value": "", "type": "path", "description": "Traveler notification type." } ] }, "docs": "GraphQL endpoint: resourceTravelerNotification" }, { "info": { "name": "Retrieves the traveler notification delivery methods filtered by program code and level.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/travelerNotifications/deliveryMethods", "params": [ { "name": "programCode", "value": "", "type": "query", "description": "The customer's default loyalty program code." }, { "name": "programLevel", "value": "", "type": "query", "description": "The customer's program level of their default loyalty program." } ] }, "docs": "This endpoint will return the allowed traveler notification delivery methods based on the program code and level.\nAny delivery methods that have a required program and level where the passed in values do not meet that level or\nabove will be removed.\nIf the customer is not enrolled in the default loyalty program, leave the program code and level null and the\ndelivery methods will be filtered appropriately.\n\nGraphQL endpoint: resourceTravelerNotificationDeliveryMethods" }, { "info": { "name": "Retrieves the notification delivery method settings resource.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/travelerNotifications/deliveryMethodSettings", "params": [ { "name": "eTag", "value": "", "type": "query", "description": "The unique etag ID." } ] }, "docs": "Contains information about the SMS, PUSH, and EMAIL notification delivery methods and their maximum number of\nallowed notifications.\n\nGraphQL endpoint: resourceNotificationDeliveryMethodSettings" }, { "info": { "name": "Retrieves the collection of subzones.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/zones/:zoneCode/subZones", "params": [ { "name": "zoneCode", "value": "", "type": "path", "description": "The unique code of the zone to which the subzones belong." } ] }, "docs": "This endpoint does not cache the resulting subzone resources.\n\nGraphQL endpoint: resourceSubZonesv2" }, { "info": { "name": "Retrieves the specific subzone.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/resources/zones/:zoneCode/subZones/:subZoneCode", "params": [ { "name": "zoneCode", "value": "", "type": "path", "description": "The unique code of the zone to which the subzones belong." }, { "name": "subZoneCode", "value": "", "type": "path", "description": "The unique subzone code." } ] }, "docs": "This endpoint does not retrieve the subzone resource from the cache.\n\nGraphQL endpoint: resourceSubZonev2" } ] }, { "info": { "name": "seatmaps", "type": "folder" }, "items": [ { "info": { "name": "Gets the list of seat maps for a specified journey.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v4/seatmaps/:journeyKey", "params": [ { "name": "journeyKey", "value": "", "type": "path", "description": "The Journey Key." }, { "name": "IncludePropertyLookup", "value": "", "type": "query", "description": "Flag indicating to include seat property lookup on the response.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code.\n " } ] }, "docs": "GraphQL endpoint: seatMapv4" }, { "info": { "name": "Gets the seat maps for a specified leg.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/seatmaps/:legKey", "params": [ { "name": "legKey", "value": "", "type": "path", "description": "The leg Key." }, { "name": "IncludePropertyLookup", "value": "", "type": "query", "description": "Flag indicating to include seat property lookup on the response.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The desired culture code.\n " } ] }, "docs": "GraphQL endpoint: seatMapByLegKey" } ] }, { "info": { "name": "seats", "type": "folder" }, "items": [ { "info": { "name": "Blocks seats on a specific piece of equipment.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/dcs/v2/seats/block", "body": { "type": "json", "data": "{}" } }, "docs": "A blocked seat cannot be associated with/assigned to a passenger.\nThe change can be verified on a unit's availability on a seat map.\n\nGraphQL endpoint: seatsBlockv2" }, { "info": { "name": "Blocks seats on a specific piece of equipment.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/dcs/v1/seats/block", "body": { "type": "json", "data": "{}" } }, "docs": "A blocked seat cannot be associated with/assigned to a passenger.\nThe change can be verified on a unit's availability on a seat map.\n\nGraphQL endpoint: seatsBlock" }, { "info": { "name": "Unblocks seats on a specific piece of equipment.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/dcs/v1/seats/unblock", "body": { "type": "json", "data": "{}" } }, "docs": "The change can be verified on a unit's availability on a seat map.\n\nGraphQL endpoint: seatsUnblock" } ] }, { "info": { "name": "settings", "type": "folder" }, "items": [ { "info": { "name": "Get the general settings.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/settings/booking", "params": [ { "name": "ETag", "value": "", "type": "query", "description": "The cache eTag for this request.\n " }, { "name": "RoleCode", "value": "", "type": "query", "description": "Gets or sets the role code for this request.\n " } ] }, "docs": "GraphQL endpoint: settingsBookingGeneral" }, { "info": { "name": "Get the checkin settings.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/settings/booking/checkin", "params": [ { "name": "ETag", "value": "", "type": "query", "description": "The cache eTag for this request.\n " }, { "name": "RoleCode", "value": "", "type": "query", "description": "Gets or sets the role code for this request.\n " } ] }, "docs": "GraphQL endpoint: settingsBookingCheckIn" }, { "info": { "name": "Get the contact settings.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/settings/booking/contact", "params": [ { "name": "ETag", "value": "", "type": "query", "description": "The cache eTag for this request.\n " }, { "name": "RoleCode", "value": "", "type": "query", "description": "Gets or sets the role code for this request.\n " } ] }, "docs": "GraphQL endpoint: settingsBookingContactv2" }, { "info": { "name": "Gets the role-based customer account settings.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/settings/booking/customerAccount", "params": [ { "name": "ETag", "value": "", "type": "query", "description": "The cache eTag for this request.\n " }, { "name": "RoleCode", "value": "", "type": "query", "description": "Gets or sets the role code for this request.\n " } ] }, "docs": "GraphQL endpoint: settingsBookingCustomerAccountv2" }, { "info": { "name": "Get the fee settings.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/settings/booking/fee", "params": [ { "name": "ETag", "value": "", "type": "query", "description": "The cache eTag for this request.\n " }, { "name": "RoleCode", "value": "", "type": "query", "description": "Gets or sets the role code for this request.\n " } ] }, "docs": "GraphQL endpoint: settingsBookingFee" }, { "info": { "name": "Get the flight search settings.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/settings/booking/flightSearch", "params": [ { "name": "ETag", "value": "", "type": "query", "description": "The cache eTag for this request.\n " }, { "name": "RoleCode", "value": "", "type": "query", "description": "Gets or sets the role code for this request.\n " } ] }, "docs": "GraphQL endpoint: settingsBookingFlightSearch" }, { "info": { "name": "Create the flight search settings.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/settings/booking/flightSearch", "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: settingsBookingFlightSearchAdd" }, { "info": { "name": "Edit the role based flight search settings.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/settings/booking/flightSearch", "params": [ { "name": "RoleCode", "value": "", "type": "query", "description": "Gets or sets the role code for this request.\n " } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: settingsBookingFlightSearchSet" }, { "info": { "name": "Patches the role based flight search settings.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/settings/booking/flightSearch", "params": [ { "name": "RoleCode", "value": "", "type": "query", "description": "Gets or sets the role code for this request.\n " } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: settingsBookingFlightSearchModify" }, { "info": { "name": "Gets the non-role based general booking settings.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/settings/booking/general", "params": [ { "name": "eTag", "value": "", "type": "query", "description": "The eTag." } ] }, "docs": "GraphQL endpoint: generalBookingSettings" }, { "info": { "name": "Get the passenger settings.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/settings/booking/passenger", "params": [ { "name": "ETag", "value": "", "type": "query", "description": "The cache eTag for this request.\n " }, { "name": "RoleCode", "value": "", "type": "query", "description": "Gets or sets the role code for this request.\n " } ] }, "docs": "GraphQL endpoint: settingsBookingPassenger" }, { "info": { "name": "Create the passenger info settings.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/settings/booking/passenger", "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: settingsBookingPassengerAdd" }, { "info": { "name": "Edit the role based passenger info settings.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/settings/booking/passenger", "params": [ { "name": "RoleCode", "value": "", "type": "query", "description": "Gets or sets the role code for this request.\n " } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: settingsBookingPassengerSet" }, { "info": { "name": "Patches the role based passenger info settings.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/settings/booking/passenger", "params": [ { "name": "RoleCode", "value": "", "type": "query", "description": "Gets or sets the role code for this request.\n " } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: settingsBookingPassengerModify" }, { "info": { "name": "Get the role based booking payment settings.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/settings/booking/payment", "params": [ { "name": "ETag", "value": "", "type": "query", "description": "The cache eTag for this request.\n " }, { "name": "RoleCode", "value": "", "type": "query", "description": "Gets or sets the role code for this request.\n " } ] }, "docs": "GraphQL endpoint: settingsBookingPaymentv2" }, { "info": { "name": "BETA - Create the booking payment settings based on the parent role code.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/settings/booking/payment", "params": [ { "name": "RoleCode", "value": "", "type": "query", "description": "Gets or sets the role code for this request.\n " } ] }, "docs": "This is a beta endpoint and is not currently a long term supported endpoint. This endpoint may\nbe removed in future updates. Beta endpoints are not available in all labs or for all customers of the API.\nThis endpoint is part of the Allow Edit on Settings And Resources feature that is currently in progress.\nSee /api/nsk/v1/resources/roles/{roleCode}/settings to verify if settings have been configured for this role.\nEven without unique settings being configured for a role the GET call will always " }, { "info": { "name": "BETA - Edit the role based booking payment settings.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/settings/booking/payment", "params": [ { "name": "RoleCode", "value": "", "type": "query", "description": "Gets or sets the role code for this request.\n " } ], "body": { "type": "json", "data": "{}" } }, "docs": "This is a beta endpoint and is not currently a long term supported endpoint. This endpoint may\nbe removed in future updates. Beta endpoints are not available in all labs or for all customers of the API.\nThis endpoint is part of the Allow Edit on Settings And Resources feature that is currently in progress.\n\nGraphQL endpoint: settingsBookingPaymentSet" }, { "info": { "name": "BETA - Partially edit the role based booking payment settings.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/settings/booking/payment", "params": [ { "name": "RoleCode", "value": "", "type": "query", "description": "Gets or sets the role code for this request.\n " } ], "body": { "type": "json", "data": "{}" } }, "docs": "This is a beta endpoint and is not currently a long term supported endpoint. This endpoint may\nbe removed in future updates. Beta endpoints are not available in all labs or for all customers of the API.\nThis endpoint is part of the Allow Edit on Settings And Resources feature that is currently in progress.\n\nGraphQL endpoint: settingsBookingPaymentModify" }, { "info": { "name": "Gets the role-based booking payment codes settings.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/settings/booking/paymentCodes", "params": [ { "name": "ETag", "value": "", "type": "query", "description": "The cache eTag for this request.\n " }, { "name": "RoleCode", "value": "", "type": "query", "description": "Gets or sets the role code for this request.\n " } ] }, "docs": "GraphQL endpoint: settingsBookingPaymentCodes" }, { "info": { "name": "Get the reserve flight settings.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/settings/booking/reserveFlights", "params": [ { "name": "ETag", "value": "", "type": "query", "description": "The cache eTag for this request.\n " }, { "name": "RoleCode", "value": "", "type": "query", "description": "Gets or sets the role code for this request.\n " } ] }, "docs": "GraphQL endpoint: settingsReserveFlights" }, { "info": { "name": "Gets customer program settings.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/settings/customerPrograms", "params": [ { "name": "eTag", "value": "", "type": "query", "description": "The eTag." } ] }, "docs": "GraphQL endpoint: settingsCustomerProgram" }, { "info": { "name": "Gets the non-role based e-ticket configuration.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/settings/eTickets", "params": [ { "name": "eTag", "value": "", "type": "query", "description": "The eTag." } ] }, "docs": "GraphQL endpoint: settingsETickets" }, { "info": { "name": "Gets the external message control settings.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/settings/externalMessageControls", "params": [ { "name": "eTag", "value": "", "type": "query", "description": "The eTag." } ] }, "docs": "GraphQL endpoint: settingsExternalMessageControls" }, { "info": { "name": "Retrieves the logon settings.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/settings/general/applicationLogon", "params": [ { "name": "ETag", "value": "", "type": "query", "description": "The cache eTag for this request.\n " }, { "name": "RoleCode", "value": "", "type": "query", "description": "Gets or sets the role code for this request.\n " } ] }, "docs": "GraphQL endpoint: settingsApplicationLogon" }, { "info": { "name": "Retrieves the codes settings.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/settings/general/codes", "params": [ { "name": "ETag", "value": "", "type": "query", "description": "The cache eTag for this request.\n " }, { "name": "RoleCode", "value": "", "type": "query", "description": "Gets or sets the role code for this request.\n " } ] }, "docs": "GraphQL endpoint: settingsCodes" }, { "info": { "name": "Retrieves the operations settings.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/settings/general/operations", "params": [ { "name": "ETag", "value": "", "type": "query", "description": "The cache eTag for this request.\n " }, { "name": "RoleCode", "value": "", "type": "query", "description": "Gets or sets the role code for this request.\n " } ] }, "docs": "GraphQL endpoint: operationsSettings" }, { "info": { "name": "Gets the organization settings.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/settings/general/organization", "params": [ { "name": "eTag", "value": "", "type": "query", "description": "The eTag." } ] }, "docs": "GraphQL endpoint: settingsOrganization" }, { "info": { "name": "Retrieves the session settings.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/settings/general/session", "params": [ { "name": "ETag", "value": "", "type": "query", "description": "The cache eTag for this request.\n " }, { "name": "RoleCode", "value": "", "type": "query", "description": "Gets or sets the role code for this request.\n " } ] }, "docs": "GraphQL endpoint: settingsSession" }, { "info": { "name": "Gets the itinerary settings.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/settings/itinerary", "params": [ { "name": "eTag", "value": "", "type": "query", "description": "The eTag." } ] }, "docs": "GraphQL endpoint: itinerarySettings" }, { "info": { "name": "Gets the non-role based loyalty settings.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/settings/loyalty", "params": [ { "name": "eTag", "value": "", "type": "query", "description": "The eTag." } ] }, "docs": "GraphQL endpoint: settingsLoyalty" }, { "info": { "name": "Gets the general New Skies notification settings.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/settings/notifications/general", "params": [ { "name": "eTag", "value": "", "type": "query", "description": "The eTag." } ] }, "docs": "GraphQL endpoint: settingsGeneralNotifications" }, { "info": { "name": "Get the non role based payment settings.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/settings/payment", "params": [ { "name": "eTag", "value": "", "type": "query", "description": "The eTag." } ] }, "docs": "GraphQL endpoint: settingsPayment" }, { "info": { "name": "Gets the non-role based phone number validation settings.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/settings/phoneNumberValidation", "params": [ { "name": "eTag", "value": "", "type": "query", "description": "The eTag." } ] }, "docs": "GraphQL endpoint: settingsPhoneNumberValidation" }, { "info": { "name": "Retrieves the premium services settings.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/settings/premiumServices", "params": [ { "name": "eTag", "value": "", "type": "query", "description": "The unique etag ID." } ] }, "docs": "GraphQL endpoint: settingsPremiumServicesv2" }, { "info": { "name": "BETA - Edit the premium service settings.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/settings/premiumServices", "body": { "type": "json", "data": "{}" } }, "docs": "This is a beta endpoint and is not currently a long term supported endpoint. This endpoint may\nbe removed in future updates. Beta endpoints are not available in all labs or for all customers of the API.\nThis endpoint is part of the Allow Edit on Settings And Resources feature that is currently in progress.\nThis functionality is restricted to System Master users only." }, { "info": { "name": "Gets the service bundles settings.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/settings/serviceBundles", "params": [ { "name": "ETag", "value": "", "type": "query", "description": "The cache eTag for this request.\n " }, { "name": "RoleCode", "value": "", "type": "query", "description": "Gets or sets the role code for this request.\n " } ] }, "docs": "GraphQL endpoint: settingsServiceBundles" }, { "info": { "name": "Retrieves the role-based and non-role based SkySpeed settings.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/settings/skySpeed", "params": [ { "name": "ETag", "value": "", "type": "query", "description": "The cache eTag for this request.\n " }, { "name": "RoleCode", "value": "", "type": "query", "description": "Gets or sets the role code for this request.\n " } ] }, "docs": "GraphQL endpoint: settingsSkySpeedv2" }, { "info": { "name": "Gets the role-based general system settings.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/settings/system/general", "params": [ { "name": "ETag", "value": "", "type": "query", "description": "The cache eTag for this request.\n " }, { "name": "RoleCode", "value": "", "type": "query", "description": "Gets or sets the role code for this request.\n " } ] }, "docs": "GraphQL endpoint: settingsGeneralSystem" }, { "info": { "name": "Retrieves the session system configuration finance setting.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/settings/systemConfiguration/finance", "params": [ { "name": "ETag", "value": "", "type": "query", "description": "The cache eTag for this request.\n " }, { "name": "RoleCode", "value": "", "type": "query", "description": "Gets or sets the role code for this request.\n " } ] }, "docs": "GraphQL endpoint: systemConfigurationFinance" }, { "info": { "name": "Gets the traveler notification settings.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/settings/travelerNotification", "params": [ { "name": "eTag", "value": "", "type": "query", "description": "The eTag." } ] }, "docs": "GraphQL endpoint: settingsTravelerNotification" }, { "info": { "name": "Retrieves the agency creation settings.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/settings/user/agencyCreation", "params": [ { "name": "eTag", "value": "", "type": "query", "description": "The unique etag ID." } ] }, "docs": "GraphQL endpoint: settingsAgencyCreation" }, { "info": { "name": "Retrieves the customer creation settings.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/settings/user/customerCreation", "params": [ { "name": "eTag", "value": "", "type": "query", "description": "The unique etag ID." } ] }, "docs": "GraphQL endpoint: settingsCustomerCreation" } ] }, { "info": { "name": "token", "type": "folder" }, "items": [ { "info": { "name": "Creates the general access token that will grant access to the API.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/v1/token", "body": { "type": "json", "data": "{}" } }, "docs": "Creates the general access token that will grant access to the API." }, { "info": { "name": "Keeps the active token alive.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/v1/token" }, "docs": "GraphQL endpoint: tokenKeepAlive" }, { "info": { "name": "Abandons the active token.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/v1/token" }, "docs": "GraphQL endpoint: tokenDelete" }, { "info": { "name": "Get the information about the short-lived JWT.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/auth/v1/token" }, "docs": "With custom application names (system type in NewSkies), because of the nature of the underlying system type, the\n`NskServer.SystemName` will always show as `UserDefined`. To see the custom name, see the\n`ServerContext.ApplicationName`.\n\nGraphQL endpoint: jwtToken" }, { "info": { "name": "Updates the short-lived JWT.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/auth/v1/token", "body": { "type": "json", "data": "{}" } }, "docs": "Updates the short-lived JWT." }, { "info": { "name": "Get the information about the current token.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/token" }, "docs": "- With custom application names (system type in NewSkies), because of the nature of the underlying system type, the\n`NskServer.SystemName` will always show as `UserDefined`. To see the custom name, see the\n`ServerContext.ApplicationName`.\n- The values `IsVirtual` and `HasBookingInState` no longer apply if the NSK JWT token is being used.\n\nGraphQL endpoint: token" }, { "info": { "name": "Abandons the active token.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/token" }, "docs": "Abandons the active token." }, { "info": { "name": "Creates the general access token that will grant access to the API.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/token", "body": { "type": "json", "data": "{}" } }, "docs": "Security Note:\nThis endpoint has the ability to log in as any role assigned to a user\nor that is allowed through impersonation settings. A user may still log\ninto a role that is not assigned to them if the impersonation settings\nallow it." }, { "info": { "name": "Given a non-null request, upgrades the current session's logged in user.\nOtherwise, keeps the active token alive.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/token", "body": { "type": "json", "data": "{}" } }, "docs": "Security Note:\nThis endpoint has the ability to log in as any role assigned to a user\nor that is allowed through impersonation settings. A user may still log\ninto a role that is not assigned to them if the impersonation settings\nallow it.\n\nGraphQL endpoint: tokenUpgradev2" }, { "info": { "name": "Create a short-lived anonymous JWT.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/auth/v1/token/anonymous", "body": { "type": "json", "data": "{}" } }, "docs": "Tokens have a set\nexpiration time. Client applications should call the put endpoint to get a new token before this\nexpiration time." }, { "info": { "name": "Sets the culture code for the lifetime of the token.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/token/culture", "params": [ { "name": "defaultCultureCode", "value": "", "type": "query", "description": "The culture code to use as the default for the life of this token." } ] }, "docs": "Note there is middleware that looks for \"Culture\" on every request in the headers or query string parameters.\nThese can be used if you want to set the culture for a single request only.\n\nGraphQL endpoint: tokenCultureSet" }, { "info": { "name": "Register multi-factor authentication options.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/auth/v1/token/multifactor", "body": { "type": "json", "data": "{}" } }, "docs": "Allows first time users to select their multifactor authentication method and will send a challenge code to that\nmethod." }, { "info": { "name": "Updates the short-lived JWT with new role permissions.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/auth/v1/token/role", "body": { "type": "json", "data": "{}" } }, "docs": "Updates the short-lived JWT with new role permissions." }, { "info": { "name": "Transfers the server context from NewSkies and returns a new token.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/token/serverTransfer", "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint returns a new token. The new token must be applied in the\nauthorization header to access the transferred server context.\n\nGraphQL endpoint: serverTransferAdd" }, { "info": { "name": "Creates the general access token that will grant access to the API.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/token/singleSignOn", "body": { "type": "json", "data": "{}" } }, "docs": "In order to use single sign on, a single sign on token must first be\nassociated with a user. Refer to the \"user/singleSignOnToken\" endpoints.\n\nGraphQL endpoint: singleSignOn" }, { "info": { "name": "Given a non-null request, upgrades the current session's logged-in user.\nOtherwise, keeps the active token alive.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/token/singleSignOn", "body": { "type": "json", "data": "{}" } }, "docs": "In order to use single sign on, a single sign on token must first be\nassociated with a user. Refer to the \"user/singleSignOnToken\" endpoints.\n\nGraphQL endpoint: singleSignOnUpgrade" }, { "info": { "name": "Creates a short-lived JWT specific to a user.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/auth/v1/token/user", "body": { "type": "json", "data": "{}" } }, "docs": "Tokens have a set\nexpiration time. Client applications should call the put endpoint to get a new token before this\nexpiration time." }, { "info": { "name": "Updates an anonymous short-lived JWT to login as a user.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/auth/v1/token/user", "body": { "type": "json", "data": "{}" } }, "docs": "Updates an anonymous short-lived JWT to login as a user." }, { "info": { "name": "Creates a new user, links it with a provider, then logs in as the new user.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/token/user/person/singleSignOn", "body": { "type": "json", "data": "{}" } }, "docs": "Warning:\nThis endpoint currently only works with Facebook.\nIf this endpoint fails it could be because an SSO token is already\nlinked to a user or the SSO token is invalid.\n\nGraphQL endpoint: singleSignOnUserAdd" } ] }, { "info": { "name": "trip", "type": "folder" }, "items": [ { "info": { "name": "Creates a new booking with the provided journeys, contacts, passengers, and SSRs.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v5/trip", "params": [ { "name": "syncPassengerAndTravelDocGender", "value": "", "type": "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 " } ], "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: tripCreatev5" }, { "info": { "name": "Creates a new booking with the provided journeys, contacts, passengers, and SSRs.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v4/trip", "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: tripCreatev4" }, { "info": { "name": "BETA - Retrieves inventory seat properties for a given flight leg and unit key.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/trip/:legKey/seats/:unitKey/properties", "params": [ { "name": "legKey", "value": "", "type": "path", "description": "The flight leg to retrieve the properties for." }, { "name": "unitKey", "value": "", "type": "path", "description": "The unit key to retrieve the properties for." }, { "name": "compartmentDesignator", "value": "", "type": "query", "description": "The compartment to retrieve the seat properties for." } ] }, "docs": "This is a beta endpoint and is not currently a long term supported endpoint. This endpoint may be removed in future updates.\nBeta endpoints are not available in all labs or for all customers of the API.\n\nGraphQL endpoint: inventorySeatProperties" }, { "info": { "name": "BETA - Creates an inventory seat property for a given flight leg and unit key.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/trip/:legKey/seats/:unitKey/properties", "params": [ { "name": "legKey", "value": "", "type": "path", "description": "The leg key to modify the properties for." }, { "name": "unitKey", "value": "", "type": "path", "description": "The unit key to modify the properties for." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This is a beta endpoint and is not currently a long term supported endpoint. This endpoint may be removed in future updates.\nBeta endpoints are not available in all labs or for all customers of the API.\n\nGraphQL endpoint: inventorySeatPropertiesAdd" }, { "info": { "name": "BETA - Updates an inventory seat property for a given flight leg and unit key.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/trip/:legKey/seats/:unitKey/properties", "params": [ { "name": "legKey", "value": "", "type": "path", "description": "The leg key to update the properties for." }, { "name": "unitKey", "value": "", "type": "path", "description": "The unit key to update the properties for." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This is a beta endpoint and is not currently a long term supported endpoint. This endpoint may be removed in future updates.\nBeta endpoints are not available in all labs or for all customers of the API.\n\nGraphQL endpoint: inventorySeatPropertiesSet" }, { "info": { "name": "BETA - Deletes an inventory seat property for a given flight leg and unit key.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/trip/:legKey/seats/:unitKey/properties", "params": [ { "name": "legKey", "value": "", "type": "path", "description": "The leg key to delete the properties for." }, { "name": "unitKey", "value": "", "type": "path", "description": "The unit key to delete the properties for." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This is a beta endpoint and is not currently a long term supported endpoint. This endpoint may be removed in future updates.\nBeta endpoints are not available in all labs or for all customers of the API.\n\nGraphQL endpoint: inventorySeatPropertiesDelete" }, { "info": { "name": "BETA - Retrieves inventory seat properties for a given flight leg.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/trip/:legKey/seats/properties", "params": [ { "name": "legKey", "value": "", "type": "path", "description": "The flight leg to retrieve the properties for." }, { "name": "compartmentDesignator", "value": "", "type": "query", "description": "The compartment to retrieve the seat properties for." } ] }, "docs": "This is a beta endpoint and is not currently a long term supported endpoint. This endpoint may be removed in future updates.\nBeta endpoints are not available in all labs or for all customers of the API.\n\nGraphQL endpoint: inventorySeatPropertiesByLeg" }, { "info": { "name": "Creates a new contacts-only booking.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/trip/contacts", "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint is not for updating contacts on an existing booking.\nFor that purpose, use the \"booking/contacts/{contactTypeCode}\" endpoints for PUT and PATCH.\nThis endpoint is to create a new contacts-only booking.\nAn example use case for a contacts-only booking are agency gift certificates (Agency Contact)\nwhere a payment is made with the organization credit and left as a credit on the PNR.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performa" }, { "info": { "name": "Gets the search results for the trip information, based on the search criteria.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/trip/info", "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint will return a maximum of 100 journeys. If more than 100 journeys are needed, the search criteria\nwill need to be modified and additional trip calls will need to be made.\n\nGraphQL endpoint: tripInformationv2" }, { "info": { "name": "Retrieves cabin and various details for the specified leg key.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/trip/info/:legKey/details", "params": [ { "name": "legKey", "value": "", "type": "path", "description": "The encoded leg key." } ] }, "docs": "The additional trip details include the leg cross references,\nthe cabin details (nest counts), and the checkin-lid.\n\nGraphQL endpoint: tripInformationDetails" }, { "info": { "name": "Stateless operation for updating the trip information status for a specific flight.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/trip/info/:legKey/status", "params": [ { "name": "legKey", "value": "", "type": "path", "description": "The leg key of the flight being updated." } ], "body": { "type": "json", "data": "{}" } }, "docs": "A flight must be within three days of leaving to be able to make flight\nfollowing information changes.\nAn empty string or whitespaces are allowed input values and are not considered as null\ninputs. Null values will retain the original value in the trip status while empty strings\nor whitespaces will clear the value from the trip status.\nWhen updating tail numbers, this endpoint will not validate mismatching equipment types.\nIf validation is required for tail numbers, please see `POST /equipment/t" }, { "info": { "name": "Retrieves the trip status data for the specified leg key.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/trip/info/:legKey/status", "params": [ { "name": "legKey", "value": "", "type": "path", "description": "The encoded leg key." } ] }, "docs": "GraphQL endpoint: tripInformationStatusv2" }, { "info": { "name": "Stateless operation for creating operation comments in the trip information status for a specific flight.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/trip/info/:legKey/status/comments", "params": [ { "name": "legKey", "value": "", "type": "path", "description": "The leg key of the flight being updated." } ], "body": { "type": "json", "data": "{}" } }, "docs": "A flight must be within three days of leaving to be able to make flight\nfollowing information changes.\n\nGraphQL endpoint: tripOperationCommentsAdd" }, { "info": { "name": "Stateless operation for updating the operation comments in the trip information status for a specific flight.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/trip/info/:legKey/status/comments/:commentKey", "params": [ { "name": "legKey", "value": "", "type": "path", "description": "The leg key of the flight being updated." }, { "name": "commentKey", "value": "", "type": "path", "description": "The key of the comment to be updated." } ], "body": { "type": "json", "data": "{}" } }, "docs": "A flight must be within three days of leaving to be able to make flight\nfollowing information changes.\n\nGraphQL endpoint: tripOperationCommentsSet" }, { "info": { "name": "Stateless operation for deleting the operation comments in the trip information status for a specific flight.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/trip/info/:legKey/status/comments/:commentKey", "params": [ { "name": "legKey", "value": "", "type": "path", "description": "The leg key of the flight being updated." }, { "name": "commentKey", "value": "", "type": "path", "description": "The key of the comment to be deleted." } ] }, "docs": "A flight must be within three days of leaving to be able to make flight\nfollowing information changes.\n\nGraphQL endpoint: tripOperationCommentsDelete" }, { "info": { "name": "Stateless operation for creating operation delays in the trip information status for a specific flight.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/trip/info/:legKey/status/delays", "params": [ { "name": "legKey", "value": "", "type": "path", "description": "The leg key of the flight being updated." } ], "body": { "type": "json", "data": "{}" } }, "docs": "A flight must be within three days of leaving to be able to make flight\nfollowing information changes.\n\nGraphQL endpoint: tripOperationDelaysAdd" }, { "info": { "name": "Stateless operation for patching the operation delays in the trip information status for a specific flight.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/trip/info/:legKey/status/delays/:delayKey", "params": [ { "name": "legKey", "value": "", "type": "path", "description": "The leg key of the flight being updated." }, { "name": "delayKey", "value": "", "type": "path", "description": "The key of the delay to be patched." } ], "body": { "type": "json", "data": "{}" } }, "docs": "A flight must be within three days of leaving to be able to make flight\nfollowing information changes.\n\nGraphQL endpoint: tripOperationDelaysModify" }, { "info": { "name": "Stateless operation for deleting trip operation delays in the trip information status for a specific flight.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/trip/info/:legKey/status/delays/:delayKey", "params": [ { "name": "legKey", "value": "", "type": "path", "description": "The leg key of the flight being updated." }, { "name": "delayKey", "value": "", "type": "path", "description": "The key of the delay to be deleted." } ] }, "docs": "A flight must be within three days of leaving to be able to make flight\nfollowing information changes.\n\nGraphQL endpoint: tripOperationDelaysDelete" }, { "info": { "name": "Updates the leg status to cancel.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/trip/info/:legKey/status/operationDetails/status/cancel", "params": [ { "name": "legKey", "value": "", "type": "path", "description": "The leg key." } ] }, "docs": "GraphQL endpoint: modifyStatusCancel" }, { "info": { "name": "Updates a leg status closed.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/trip/info/:legKey/status/operationDetails/status/closeLeg", "params": [ { "name": "legKey", "value": "", "type": "path", "description": "The leg key." }, { "name": "bypassCheckinRestrictions", "value": "", "type": "query", "description": "This will allows updates regardless of checkin configuration period of time set in settings.\n " }, { "name": "overrideBalanceDueWarning", "value": "", "type": "query", "description": "This will allow the flight to be closed regardless of any balance due by any passenger(s) on the leg.\n " } ] }, "docs": "A leg status can be set to closed regardless of check-in configuration period of time set in settings.\nThis check-in restriction determines if a flight can be closed before a designated departure time.\nIt is recommended to set a leg status to close using the check-in restrictions.\nThere are a number of factors that can prevent the leg from being closed.\nThese include:\nA PNRGOV message is required and has not been sent\nA flight closure or APIS message is required and has not been sent\nPassengers " }, { "info": { "name": "Updates a leg status closed.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/trip/info/:legKey/status/operationDetails/status/closeLeg", "params": [ { "name": "legKey", "value": "", "type": "path", "description": "The leg key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "A leg status can be set to closed regardless of check-in configuration period of time set in settings.\nThis check-in restriction determines if a flight can be closed before a designated departure time.\nIt is recommended to set a leg status to closed using the check-in restrictions.\nThere are a number of factors that can prevent the leg from being closed.\nThese include:\nA PNRGOV message is required and has not been sent\nA flight closure or APIS message is required and has not been sent\nPassengers" }, { "info": { "name": "Updates a leg status to closed pending.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/trip/info/:legKey/status/operationDetails/status/closePendingLeg", "params": [ { "name": "legKey", "value": "", "type": "path", "description": "The leg key." }, { "name": "overrideExitRowRequirement", "value": "", "type": "query", "description": "This will allow the leg to be set to closed pending regardless of any exit row requirements.\n " } ] }, "docs": "GraphQL endpoint: updateLegStatusClosePendingv2" }, { "info": { "name": "Secures all passenger information associated with the flight leg clearing and locking the\npassenger data. This changes the leg status to Mishap.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/trip/info/:legKey/status/operationDetails/status/mishap", "params": [ { "name": "legKey", "value": "", "type": "path", "description": "The leg key." } ] }, "docs": "GraphQL endpoint: modifyStatusMishap" }, { "info": { "name": "Restores locked passenger data associated with the flight leg. This restores the leg status to normal.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/trip/info/:legKey/status/operationDetails/status/mishapRestore", "params": [ { "name": "legKey", "value": "", "type": "path", "description": "The leg key." } ] }, "docs": "GraphQL endpoint: modifyStatusMishapRestore" }, { "info": { "name": "Updates a leg status to open.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/trip/info/:legKey/status/operationDetails/status/openLeg", "params": [ { "name": "legKey", "value": "", "type": "path", "description": "The leg key." }, { "name": "bypassCheckinRestrictions", "value": "", "type": "query", "description": "This will allows updates regardless of checkin configuration period of time set in settings.\n " }, { "name": "convertNoShowToDefault", "value": "", "type": "query", "description": "If true, converts no show passengers' liftStatus to default" } ] }, "docs": "A leg status can be set to open regardless of checkin configuration period of time set in settings.\nThis checkin restriction determines if a flight can be opened after a designated departure time.\nIt is recommended to set a leg status to open using the checkin restrictions.\n\nGraphQL endpoint: updateLegStatusOpen" }, { "info": { "name": "Updates the leg status to normal.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/trip/info/:legKey/status/operationDetails/status/restore", "params": [ { "name": "legKey", "value": "", "type": "path", "description": "The leg key." } ] }, "docs": "GraphQL endpoint: modifyStatusRestore" }, { "info": { "name": "Searches for the inventory legs based on the search criteria.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/trip/info/legs", "body": { "type": "json", "data": "{}" } }, "docs": "This is functionally a GET but POST is used to reduce URL length overhead.\n\nGraphQL endpoint: tripInformationByLegv2" }, { "info": { "name": "Performs a simplified search for trip information by leg, based upon minimal,\nrequired data for the search criteria.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/trip/info/legs/simple", "params": [ { "name": "Origin", "value": "", "type": "query", "description": "The departure station.\n " }, { "name": "Destination", "value": "", "type": "query", "description": "The arrival station.\n " }, { "name": "BeginDate", "value": "", "type": "query", "description": "The starting date of the trip information search.\n " }, { "name": "EndDate", "value": "", "type": "query", "description": "The end date of the trip information search.\n " }, { "name": "StartTimeInterval", "value": "", "type": "query", "description": "The starting time of the trip information search.\n " }, { "name": "EndTimeInterval", "value": "", "type": "query", "description": "The end time of the trip information search.\n " }, { "name": "Identifier", "value": "", "type": "query", "description": "The transportation identifier, such as a flight number.\n " }, { "name": "CarrierCode", "value": "", "type": "query", "description": "The carrier code.\n " } ] }, "docs": "GraphQL endpoint: tripInformationByLegSimplev2" }, { "info": { "name": "Performs a simplified search for trip information based upon minimal, required data for\nthe search criteria.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/trip/info/simple", "params": [ { "name": "NumberOfJourneys", "value": "", "type": "query", "description": "When set to null, 100 journeys will be returned.\nThis endpoint will never return more than 100 journeys.\n " }, { "name": "Origin", "value": "", "type": "query", "description": "The departure station.\n " }, { "name": "Destination", "value": "", "type": "query", "description": "The arrival station.\n " }, { "name": "EndDate", "value": "", "type": "query", "description": "The end date of the trip information search.\n " }, { "name": "StartTimeInterval", "value": "", "type": "query", "description": "The starting time of the trip information search.\n " }, { "name": "EndTimeInterval", "value": "", "type": "query", "description": "The end time of the trip information search.\n " }, { "name": "CarrierCode", "value": "", "type": "query", "description": "The carrier code.\n " }, { "name": "BeginDate", "value": "", "type": "query", "description": "The starting date of the trip information search.\n " }, { "name": "Identifier", "value": "", "type": "query", "description": "The transportation identifier, such as a flight number.\n " }, { "name": "FlightType", "value": "", "type": "query", "description": "The flight type.\n \nEnumeration values: 0 = All, 1 = NonStop, 2 = Through, 3 = Direct, 4 = Connect" } ] }, "docs": "This endpoint will return a maximum of 100 journeys. If more than 100 journeys are needed, the search criteria\nwill need to be modified and additional trip calls will need to be made.\n\nGraphQL endpoint: tripInformationSimplev2" }, { "info": { "name": "Restores locked passenger data associated the leg information. This restores the leg status to normal.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/trip/info/status/operationDetails/status/mishapRestore", "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: modifyStatusRestoreMishap" }, { "info": { "name": "Moves a journey on the booking in state.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/trip/move", "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\n\nGraphQL endpoint: movev2" }, { "info": { "name": "Searches for move availability with the full availability search request. This request will allow for total control\nover\nthe configuration. If a property is not set, the default settings (AvailabilitySettings) is used in its place.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v3/trip/move/availability", "body": { "type": "json", "data": "{}" } }, "docs": "Note, this is a post request even though it is only getting information. This is due to the complicated data needed\nin the post data.\nEven though service bundle offers is part of the endpoint response, it is expected to be not populated.\n\nGraphQL endpoint: moveAvailabilityv3" }, { "info": { "name": "Searches for availability with the simple move request. The simple search request covers the bare minimum search\ncriteria and lets default settings (AvailabilitySettings) configure the rest.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v3/trip/move/availability/:journeyKey", "params": [ { "name": "journeyKey", "value": "", "type": "path", "description": "The journey key." }, { "name": "BeginDate", "value": "", "type": "query", "description": "The departure date.\n " }, { "name": "Origin", "value": "", "type": "query", "description": "The origin station code.\n " }, { "name": "Destination", "value": "", "type": "query", "description": "The destination station code.\n " }, { "name": "PassengerMoveType", "value": "", "type": "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" } ] }, "docs": "Even though service bundle offers is part of the endpoint response, it is expected to be not populated.\n\nGraphQL endpoint: moveAvailabilitySimplev3" }, { "info": { "name": "Self-service search for move availability.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/trip/move/availability/selfService", "params": [ { "name": "BeginDate", "value": "", "type": "query", "description": "The begin date.\n " }, { "name": "EndDate", "value": "", "type": "query", "description": "The end date.\n " } ] }, "docs": "If no BeginDate is provided, it will default to the journey\ndeparture date.\nIf no EndDate is provided, it will default to the begin date + 1\nday.\nEven though service bundle offers is part of the endpoint response, it is expected to be not populated.\n\nGraphQL endpoint: moveAvailabilitySelfServicev2" }, { "info": { "name": "Performs an IROP move for the booking in state.\nThis endpoint adds additional IROP move functionality for agents. See `/api/nsk/v2/trip/move` for\nIROP functionality not restricted to agents only.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/trip/move/irop", "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: iropMove" }, { "info": { "name": "Creates a new booking with the provided passengers.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/trip/passengers", "params": [ { "name": "syncPassengerAndTravelDocGender", "value": "", "type": "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 " } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint is not for updating passengers on an existing booking.\nFor that purpose, use the \"booking/passengers/{passengerKey}\" endpoints for PUT and PATCH.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: tripPassengersAdd" }, { "info": { "name": "Creates a passive segment and creates a booking if it doesn't already exist.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/trip/passiveSegments", "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint creates a new journey with the passive segment on it. A passive segment cannot\nbe updated, however get and delete work like all other journeys.\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: tripPassiveSegmentAdd" }, { "info": { "name": "Rebook search with the current booking defaults.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v5/trip/rebook/availability", "body": { "type": "json", "data": "{}" } }, "docs": "Requires a booking in state.\nAlthough this endpoint behaves like a GET, POST is used to reduce the limitations resulting from URL length issues.\n\nGraphQL endpoint: rebookAvailabilityv5" }, { "info": { "name": "Simple rebook search with the current booking defaults.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v4/trip/rebook/availability/simple", "params": [ { "name": "Origin", "value": "", "type": "query", "description": "The origin station code.\n " }, { "name": "Destination", "value": "", "type": "query", "description": "The destination station code.\n " }, { "name": "BeginDate", "value": "", "type": "query", "description": "The departure date.\n " }, { "name": "EndDate", "value": "", "type": "query", "description": "The return date if this is a round trip request.\n " }, { "name": "LoyaltyFilter", "value": "", "type": "query", "description": "The loyalty fare filter.\n \nEnumeration values: 0 = MonetaryOnly, 1 = PointsOnly, 2 = PointsAndMonetary, 3 = PreserveCurrent" } ] }, "docs": "Requires a booking in state.\nThe AvailabilityCriteriaFilter.FareInclusionType.NoPricing enumeration value, if set, will result in an\navailability response that does not include fares. The primary use case for this is in Move flows, but is being\nmaintained on the main availability and rebook availability flows in case there are other use cases as well.\nEven though service bundle offers is part of the endpoint response, it is expected to be not populated.\n\nGraphQL endpoint: rebookAvailabilitySimp" }, { "info": { "name": "Retrieves the schedule of flights for a market.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/trip/schedule", "params": [ { "name": "Origin", "value": "", "type": "query", "description": "The origin station code.\n " }, { "name": "Destination", "value": "", "type": "query", "description": "The destination station code.\n " }, { "name": "BeginDate", "value": "", "type": "query", "description": "The begin date to search for.\n " }, { "name": "EndDate", "value": "", "type": "query", "description": "The end date to search for.\n " }, { "name": "Type", "value": "", "type": "query", "description": "The flight type filter.\n \nEnumeration values: 0 = None, 1 = NonStop, 2 = Through, 3 = Direct, 4 = Connect, 5 = All" } ] }, "docs": "GraphQL endpoint: tripScheduleSimple" }, { "info": { "name": "Creates an ad hoc flight.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/trip/schedule/adHoc", "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: tripScheduleAdHocAdd" }, { "info": { "name": "Sells the list of journeys and creates a booking if it doesn't already exist.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v4/trip/sell", "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\nThis endpoint will ignore the contents of 'TripSellRequestv2.Passengers.Types.Details' if there are already\npassengers in the booking in state and use the existing passengers instead.\n\nGraphQL endpoint: tripAddv5" }, { "info": { "name": "Retrieves same-day standby availability relevant to the current state booking.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/trip/standby/availability", "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint only provisions same-day standby availability. The existing, standard flight availability\nendpoints should still be used for other standby availability search scenarios.\nAlthough this endpoint behaves like a GET, POST reduces the limitations resulting from URL length issues.\nEven though service bundle offers is part of the endpoint response, it is expected to be not populated.\n\nGraphQL endpoint: tripStandbyAvailability" } ] }, { "info": { "name": "user", "type": "folder" }, "items": [ { "info": { "name": "Retrieves the current logged in user.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/user" }, "docs": "GraphQL endpoint: user" }, { "info": { "name": "Creates a user and person (used by anonymous to create non agent logins).", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/user", "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint will create a user based off the system configured customer creation parameters. The associated\nperson has to be of type customer or an exception will be thrown. To change these default settings please configure\nutilities.\n\nGraphQL endpoint: userAdd" }, { "info": { "name": "Updates the current logged in user.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/user", "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: userSet" }, { "info": { "name": "Patches the current logged in user.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/user", "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: userModifyv2" }, { "info": { "name": "Searches the logged in user booking upcoming and past bookings.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/user/bookings", "params": [ { "name": "AssociatedFirstName", "value": "", "type": "query", "description": "An associated passenger/contact first name.\n " }, { "name": "AssociatedLastName", "value": "", "type": "query", "description": "An associated passenger/contact last name.\n " }, { "name": "PhoneticSearch", "value": "", "type": "query", "description": "Flag indicating to search using the phonetic option.\n " }, { "name": "TripIdentifier", "value": "", "type": "query", "description": "Filter by trip identifier.\n " }, { "name": "Origin", "value": "", "type": "query", "description": "Filter by origin station code.\n " }, { "name": "Destination", "value": "", "type": "query", "description": "Filter by destination station code.\n " }, { "name": "SearchArchive", "value": "", "type": "query", "description": "Flag indicating to search archived bookings.\n " }, { "name": "TripDate", "value": "", "type": "query", "description": "Filter by trip date.\n " }, { "name": "StartDate", "value": "", "type": "query", "description": "Filter by starting search date.\n " }, { "name": "EndDate", "value": "", "type": "query", "description": "Filter by ending search date.\n " }, { "name": "SearchByCustomerNumber", "value": "", "type": "query", "description": "Flag indicating to search by the users customer number instead of user identifier.\n " }, { "name": "ReturnCount", "value": "", "type": "query", "description": "The number of results to be returned.\n " }, { "name": "LastBookingKey", "value": "", "type": "query", "description": "The last booking key.\n " }, { "name": "StartingIndex", "value": "", "type": "query", "description": "The starting index of the next set of bookings (used for paging).\n " } ] }, "docs": "GraphQL endpoint: userBookings" }, { "info": { "name": "Searches for any bookings that have the current user as a contact via their customer number.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/user/bookingsByContactCustomerNumber", "params": [ { "name": "PageSize", "value": "", "type": "query", "description": "The number of items to return for the request.\n " }, { "name": "LastIndex", "value": "", "type": "query", "description": "The last booking index (used for paging).\n " }, { "name": "FlightNumber", "value": "", "type": "query", "description": "Filter by the flight number.\n " }, { "name": "DepartureDate", "value": "", "type": "query", "description": "The first journeys departure date.\n " }, { "name": "Destination", "value": "", "type": "query", "description": "Filter by the destination code.\n " }, { "name": "Origin", "value": "", "type": "query", "description": "Filter by the departure code.\n " }, { "name": "SourceOrganization", "value": "", "type": "query", "description": "Filter by the organization associated with the booking. For example the\ntravel agency associated with this booking.\n " }, { "name": "OrganizationGroupCode", "value": "", "type": "query", "description": "Filter by the organization group code to find.\n " }, { "name": "SearchArchive", "value": "", "type": "query", "description": "Whether or not to search the booking archive.\n " } ] }, "docs": "GraphQL endpoint: userBookingsByContactCustomerNumber" }, { "info": { "name": "Searches the logged in user booking upcoming and past bookings.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/user/bookingsByPassenger", "params": [ { "name": "StartDate", "value": "", "type": "query", "description": "Booking start search date.\n " }, { "name": "EndDate", "value": "", "type": "query", "description": "Booking end search date.\n " } ] }, "docs": "This is similar to the user booking endpoint but returns more focused trip information.\nThis endpoint will only return data where a booking's passenger customer number matches the current logged in user.\nBookings made by the user where the passenger customer number is not assigned are ignored.\nThe BeginDate will default to today, and the EndDate defaults to one month from today unless a value is provided.\n\nGraphQL endpoint: userBookingsByPassenger" }, { "info": { "name": "Gets the logged in users current session roles state.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/user/impersonate" }, "docs": "GraphQL endpoint: impersonate" }, { "info": { "name": "Impersonates a new role for the logged in user.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/user/impersonate", "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: impersonateSet" }, { "info": { "name": "Resets the logged in users role.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/user/impersonate" }, "docs": "GraphQL endpoint: impersonateDelete" }, { "info": { "name": "Changes the logged in user's password.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v3/user/password/change", "body": { "type": "json", "data": "{}" } }, "docs": "Validates that the current password is correct before proceeding.\nThis follows domain level restrictions and could result in a failed change if there is a minimum time\nrequirement between password changes, invalid password length, or invalid character.\n\nGraphQL endpoint: userChangePasswordv3" }, { "info": { "name": "Retrieves the default SkySpeed settings user preferences of the currently logged in user.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/user/preferences/skySpeedSettings" }, "docs": "GraphQL endpoint: userPreferencesSkySpeedSettings" }, { "info": { "name": "Updates the default SkySpeed settings user preferences of the currently logged in user.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/user/preferences/skySpeedSettings", "body": { "type": "json", "data": "{}" } }, "docs": "If the SkySpeed settings of the current user is disabled and an update is made,\nthe settings will automatically be enabled and updated.\n\nIf given, each string property is validated if it exists and is active.\n\nThe collection currency setting can only be CollectionCurrencySetting.None if the collection currency code is\nnull or empty.\n\nA bad request will be returned if the collection currency code and collection currency setting are:\n- Collection Currency Code is not null or empty and the Collecti" }, { "info": { "name": "Gets all roles from the logged in user.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/user/roles" }, "docs": "Gets all roles from the logged in user." }, { "info": { "name": "Creates a new role on the logged in user.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/user/roles", "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: userRoleAdd" }, { "info": { "name": "Gets a specific role from the logged in user.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/user/roles/:userRoleKey", "params": [ { "name": "userRoleKey", "value": "", "type": "path", "description": "The unique user role key" } ] }, "docs": "GraphQL endpoint: userRole" }, { "info": { "name": "Updates a specific role on the logged in user.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/user/roles/:userRoleKey", "params": [ { "name": "userRoleKey", "value": "", "type": "path", "description": "The unique user role key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: userRoleSet" }, { "info": { "name": "Patches a specific role on the logged in user.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/user/roles/:userRoleKey", "params": [ { "name": "userRoleKey", "value": "", "type": "path", "description": "The unique user role key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: userRoleModify" }, { "info": { "name": "Deletes a specific role on the logged in user.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/user/roles/:userRoleKey", "params": [ { "name": "userRoleKey", "value": "", "type": "path", "description": "The unique user role key." } ] }, "docs": "GraphQL endpoint: userRoleDelete" }, { "info": { "name": "Gets all of the single sign on tokens associated with a specific user.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/user/singleSignOnToken" }, "docs": "GraphQL endpoint: singleSignOnTokens" }, { "info": { "name": "Gets a single sign on token associated with a specific user.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/user/singleSignOnToken/:providerKey", "params": [ { "name": "providerKey", "value": "", "type": "path", "description": "The single sign on provider key." } ] }, "docs": "GraphQL endpoint: singleSignOnToken" }, { "info": { "name": "Links the requested token with the logged-in user.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/user/singleSignOnToken/:providerKey", "params": [ { "name": "providerKey", "value": "", "type": "path", "description": "The single sign on provider key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: singleSignOnTokenAdd" }, { "info": { "name": "Updates an existing token associated with the logged-in user.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/user/singleSignOnToken/:providerKey", "params": [ { "name": "providerKey", "value": "", "type": "path", "description": "The single sign on provider key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: singleSignOnTokenSet" }, { "info": { "name": "Patches an existing token associated with the logged-in user.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/user/singleSignOnToken/:providerKey", "params": [ { "name": "providerKey", "value": "", "type": "path", "description": "The single sign on provider key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: singleSignOnTokenModify" }, { "info": { "name": "Deletes a token associated with the single sign on provider from the logged-in user.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/user/singleSignOnToken/:providerKey", "params": [ { "name": "providerKey", "value": "", "type": "path", "description": "The single sign on provider key." } ] }, "docs": "GraphQL endpoint: singleSignOnTokenDelete" } ] }, { "info": { "name": "users", "type": "folder" }, "items": [ { "info": { "name": "Creates a new user and person (used by agents to create other users).", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users", "body": { "type": "json", "data": "{}" } }, "docs": "This method is used by agents to create other users (either agents or customers).\nUse this method when you want to create both a user and a person at the same time.\n\nGraphQL endpoint: usersAdd" }, { "info": { "name": "Search user records.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/users", "params": [ { "name": "OrganizationCode", "value": "", "type": "query", "description": "The organization code to search by.\n " }, { "name": "LocationGroupCode", "value": "", "type": "query", "description": "The location group code to search by.\n " }, { "name": "DomainCode", "value": "", "type": "query", "description": "The domain code to search in.\n " }, { "name": "Username", "value": "", "type": "query", "description": "The unique username to search by.\n " }, { "name": "UsernameMatching", "value": "", "type": "query", "description": "The matching criteria for the username.\n \nEnumeration values: 0 = StartsWith, 1 = EndsWith, 2 = Contains, 3 = ExactMatch" }, { "name": "FirstName", "value": "", "type": "query", "description": "The agent's first name to search by.\n " }, { "name": "FirstNameMatching", "value": "", "type": "query", "description": "The matching criteria for the agent's first name.\n \nEnumeration values: 0 = StartsWith, 1 = EndsWith, 2 = Contains, 3 = ExactMatch" }, { "name": "LastName", "value": "", "type": "query", "description": "The agent's last name to search by.\n " }, { "name": "RoleCode", "value": "", "type": "query", "description": "The role code to search with.\n " }, { "name": "Status", "value": "", "type": "query", "description": "The agent status to search by.\n \nEnumeration values: 0 = Default, 1 = Active, 2 = Pending, 3 = Suspended, 4 = Terminated" }, { "name": "ReturnCount", "value": "", "type": "query", "description": "The number of results to return.\n " }, { "name": "LastIndex", "value": "", "type": "query", "description": "The last user index (used for paging).\n " } ] }, "docs": "GraphQL endpoint: usersv2" }, { "info": { "name": "Creates a new user for a person (used by agents to create other users).", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/users", "body": { "type": "json", "data": "{}" } }, "docs": "This method is used by agents to create other users (either agents or customers) and connect them with an existing\nperson.\nUse this method when a person already exists and you want to create a user for them.\n\nGraphQL endpoint: usersAddV2" }, { "info": { "name": "Retrieves the a specific user.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The user key of the user to retrieve." } ] }, "docs": "GraphQL endpoint: users" }, { "info": { "name": "Updates the specific user.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: usersSet" }, { "info": { "name": "Patches the current logged in user.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: usersModifyv2" }, { "info": { "name": "Delete the user.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "User key." } ] }, "docs": "This is a soft delete by setting the user record status to terminated.\n\nGraphQL endpoint: usersDelete" }, { "info": { "name": "Searches the specific user for upcoming and past bookings.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/bookings", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." }, { "name": "AssociatedFirstName", "value": "", "type": "query", "description": "An associated passenger/contact first name.\n " }, { "name": "AssociatedLastName", "value": "", "type": "query", "description": "An associated passenger/contact last name.\n " }, { "name": "PhoneticSearch", "value": "", "type": "query", "description": "Flag indicating to search using the phonetic option.\n " }, { "name": "TripIdentifier", "value": "", "type": "query", "description": "Filter by trip identifier.\n " }, { "name": "Origin", "value": "", "type": "query", "description": "Filter by origin station code.\n " }, { "name": "Destination", "value": "", "type": "query", "description": "Filter by destination station code.\n " }, { "name": "SearchArchive", "value": "", "type": "query", "description": "Flag indicating to search archived bookings.\n " }, { "name": "TripDate", "value": "", "type": "query", "description": "Filter by trip date.\n " }, { "name": "StartDate", "value": "", "type": "query", "description": "Filter by starting search date.\n " }, { "name": "EndDate", "value": "", "type": "query", "description": "Filter by ending search date.\n " }, { "name": "SearchByCustomerNumber", "value": "", "type": "query", "description": "Flag indicating to search by the users customer number instead of user identifier.\n " }, { "name": "ReturnCount", "value": "", "type": "query", "description": "The number of results to be returned.\n " }, { "name": "LastBookingKey", "value": "", "type": "query", "description": "The last booking key.\n " }, { "name": "StartingIndex", "value": "", "type": "query", "description": "The starting index of the next set of bookings (used for paging).\n " } ] }, "docs": "GraphQL endpoint: usersBookingsv2" }, { "info": { "name": "Searches the specific user upcoming and past bookings by passenger.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/bookingsByPassenger", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The user key." }, { "name": "StartDate", "value": "", "type": "query", "description": "Booking start search date.\n " }, { "name": "EndDate", "value": "", "type": "query", "description": "Booking end search date.\n " } ] }, "docs": "This is similar to the user booking endpoint but returns more focused trip information.\nThis endpoint will only return data where a bookings passenger customer number matches the current logged in user.\nBookings made by the user but where the passenger customer are not assigned are ignored.\nThe BeginDate will default to today, and the EndDate defaults to one month from today unless a value is provided.\n\nGraphQL endpoint: usersBookingsByPassenger" }, { "info": { "name": "Changes a specifics user's password.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/password/change", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Requires agent permissions.\n\nGraphQL endpoint: usersChangePassword" }, { "info": { "name": "Invokes the forgot password reset for a specific user.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/password/reset", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." } ] }, "docs": "Requires agent permissions.\n\nGraphQL endpoint: usersForgotPassword" }, { "info": { "name": "Retrieves the specific user's person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The user key of the person record to retrieve." } ] }, "docs": "GraphQL endpoint: usersPerson" }, { "info": { "name": "Updates the specific user's person record basic information.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: usersPersonSet" }, { "info": { "name": "Patches the specific user's person records basic information.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: usersPersonModify" }, { "info": { "name": "Gets all addresses from the specific user's person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/addresses", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." } ] }, "docs": "Gets all addresses from the specific user's person." }, { "info": { "name": "Creates a new address on the specific user's person.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/addresses", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: usersPersonAddressAdd" }, { "info": { "name": "Gets a specific address from the specific user's person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/addresses/:personAddressKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." }, { "name": "personAddressKey", "value": "", "type": "path", "description": "The unique person address key." } ] }, "docs": "GraphQL endpoint: usersPersonAddress" }, { "info": { "name": "Updates a specific address on the specific user's person.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/addresses/:personAddressKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." }, { "name": "personAddressKey", "value": "", "type": "path", "description": "The unique person address key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: usersPersonAddressSet" }, { "info": { "name": "Patches a specific address on the specific user's person.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/addresses/:personAddressKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." }, { "name": "personAddressKey", "value": "", "type": "path", "description": "The unique person address key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: usersPersonAddressModify" }, { "info": { "name": "Deletes a specific address on the specific user's person.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/addresses/:personAddressKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." }, { "name": "personAddressKey", "value": "", "type": "path", "description": "The unique person address key." } ] }, "docs": "GraphQL endpoint: usersPersonAddressDelete" }, { "info": { "name": "Gets all affiliations from the specific user's person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/affiliations", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." } ] }, "docs": "GraphQL endpoint: usersPersonAffiliations" }, { "info": { "name": "Creates a new affiliation for the specific user's person.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/affiliations", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: usersPersonAffiliationAdd" }, { "info": { "name": "Gets a specific affiliation from the specific user's person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/affiliations/:personAffiliationKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." }, { "name": "personAffiliationKey", "value": "", "type": "path", "description": "The unique person affiliation key." } ] }, "docs": "GraphQL endpoint: usersPersonAffiliation" }, { "info": { "name": "Updates a specific affiliation for the specific user's person.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/affiliations/:personAffiliationKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." }, { "name": "personAffiliationKey", "value": "", "type": "path", "description": "The unique person affiliation key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: usersPersonAffiliationSet" }, { "info": { "name": "Deletes a specific affiliation for the specific user's person.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/affiliations/:personAffiliationKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." }, { "name": "personAffiliationKey", "value": "", "type": "path", "description": "The unique person affiliation key." } ] }, "docs": "GraphQL endpoint: usersPersonAffiliationDelete" }, { "info": { "name": "Gets all aliases from the specific user's person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/aliases", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." } ] }, "docs": "Gets all aliases from the specific user's person." }, { "info": { "name": "Creates a new alias on the specific user's person.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/aliases", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: usersPersonAliasAdd" }, { "info": { "name": "Gets a specific alias from the specific user's person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/aliases/:personAliasKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." }, { "name": "personAliasKey", "value": "", "type": "path", "description": "The unique person alias key." } ] }, "docs": "GraphQL endpoint: usersPersonAlias" }, { "info": { "name": "Updates a specific alias on the specific user's person.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/aliases/:personAliasKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." }, { "name": "personAliasKey", "value": "", "type": "path", "description": "The unique person alias key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: usersPersonAliasSet" }, { "info": { "name": "Patches a specific alias on the specific user's person.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/aliases/:personAliasKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." }, { "name": "personAliasKey", "value": "", "type": "path", "description": "The unique person alias key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: usersPersonAliasModify" }, { "info": { "name": "Deletes a specific alias on the specific user's person.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/aliases/:personAliasKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." }, { "name": "personAliasKey", "value": "", "type": "path", "description": "The unique person alias key." } ] }, "docs": "GraphQL endpoint: usersPersonAliasDelete" }, { "info": { "name": "Gets all comments from the specific user's person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/comments", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." } ] }, "docs": "GraphQL endpoint: usersPersonComments" }, { "info": { "name": "Creates a new comment on the specific user's person.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/comments", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: usersPersonCommentAdd" }, { "info": { "name": "Gets a specific comment from the specific user's person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/comments/:personCommentKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." }, { "name": "personCommentKey", "value": "", "type": "path", "description": "The unique person comment key." } ] }, "docs": "GraphQL endpoint: usersPersonComment" }, { "info": { "name": "Updates a specific comment on the specific user's person.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/comments/:personCommentKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." }, { "name": "personCommentKey", "value": "", "type": "path", "description": "The unique person comment key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: usersPersonCommentSet" }, { "info": { "name": "Patches a specific comment on the specific user's person.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/comments/:personCommentKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." }, { "name": "personCommentKey", "value": "", "type": "path", "description": "The unique person comment key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: usersPersonCommentModify" }, { "info": { "name": "Deletes a specific comment on the specific user's person.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/comments/:personCommentKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." }, { "name": "personCommentKey", "value": "", "type": "path", "description": "The unique person comment key." } ] }, "docs": "GraphQL endpoint: usersPersonCommentDelete" }, { "info": { "name": "Gets all email addresses from the specific user's person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/emails", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The user key of the user whose email addresses to retrieve." } ] }, "docs": "Gets all email addresses from the specific user's person." }, { "info": { "name": "Creates a new email address on the specific user's person.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/emails", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "The \"type\" property for the request is a single character. See the \"/resources/EmailTypes\"\nendpoint for valid email type codes.\n\nGraphQL endpoint: usersPersonEmailAdd" }, { "info": { "name": "Gets a specific email address from the specific user's person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/emails/:personEmailAddressKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." }, { "name": "personEmailAddressKey", "value": "", "type": "path", "description": "The unique person email address key." } ] }, "docs": "GraphQL endpoint: usersPersonEmail" }, { "info": { "name": "Updates a specific email address on the specific user's person.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/emails/:personEmailAddressKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The specific user key." }, { "name": "personEmailAddressKey", "value": "", "type": "path", "description": "The unique person email address key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: usersPersonEmailSet" }, { "info": { "name": "Patches a specific email address on the specific user's person.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/emails/:personEmailAddressKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." }, { "name": "personEmailAddressKey", "value": "", "type": "path", "description": "The unique person email address key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: usersPersonEmailModify" }, { "info": { "name": "Deletes a specific email address on the specific user's person.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/emails/:personEmailAddressKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." }, { "name": "personEmailAddressKey", "value": "", "type": "path", "description": "The unique person email address key." } ] }, "docs": "GraphQL endpoint: usersPersonEmailDelete" }, { "info": { "name": "Gets all information for a specific user's person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/information", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." } ] }, "docs": "GraphQL endpoint: usersPersonInformations" }, { "info": { "name": "Creates new information for a specific user's person.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/information", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: usersPersonInformationAdd" }, { "info": { "name": "Gets specific information for a specific user's person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/information/:personInformationKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." }, { "name": "personInformationKey", "value": "", "type": "path", "description": "The unique person information key." } ] }, "docs": "GraphQL endpoint: usersPersonInformation" }, { "info": { "name": "Updates specific information for a specific user's person.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/information/:personInformationKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." }, { "name": "personInformationKey", "value": "", "type": "path", "description": "The unique person information key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: usersPersonInformationSet" }, { "info": { "name": "Patches specific information for a specific user's person.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/information/:personInformationKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." }, { "name": "personInformationKey", "value": "", "type": "path", "description": "The unique person information key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: usersPersonInformationModify" }, { "info": { "name": "Deletes specific information for a specific user's person.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/information/:personInformationKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." }, { "name": "personInformationKey", "value": "", "type": "path", "description": "The unique person information key." } ] }, "docs": "GraphQL endpoint: usersPersonInformationDelete" }, { "info": { "name": "Gets all phone numbers from the specific user's person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/phoneNumbers", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." } ] }, "docs": "Gets all phone numbers from the specific user's person." }, { "info": { "name": "Creates a new phone number on the specific user's person.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/phoneNumbers", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: usersPersonPhoneNumberAdd" }, { "info": { "name": "Gets a specific phone number from the specific user's person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/phoneNumbers/:personPhoneNumberKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." }, { "name": "personPhoneNumberKey", "value": "", "type": "path", "description": "The unique person phone number key." } ] }, "docs": "GraphQL endpoint: usersPersonPhoneNumber" }, { "info": { "name": "Updates a specific phone number on the specific user's person.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/phoneNumbers/:personPhoneNumberKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." }, { "name": "personPhoneNumberKey", "value": "", "type": "path", "description": "The unique person phone number key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: usersPersonPhoneNumberSet" }, { "info": { "name": "Patches a specific phone number on the specific user's person.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/phoneNumbers/:personPhoneNumberKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." }, { "name": "personPhoneNumberKey", "value": "", "type": "path", "description": "The unique person phone number key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: usersPersonPhoneNumberModify" }, { "info": { "name": "Deletes a specific phone number on the specific user's person.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/phoneNumbers/:personPhoneNumberKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." }, { "name": "personPhoneNumberKey", "value": "", "type": "path", "description": "The unique person phone number key." } ] }, "docs": "GraphQL endpoint: usersPersonPhoneNumberDelete" }, { "info": { "name": "Gets all preferences for a specific user's person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/preferences", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique person key." } ] }, "docs": "Gets all preferences for a specific user's person." }, { "info": { "name": "Creates a new preference for a specific user's person.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/preferences", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: usersPersonPreferenceAdd" }, { "info": { "name": "Gets a specific preference for a specific user's person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/preferences/:personPreferenceKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." }, { "name": "personPreferenceKey", "value": "", "type": "path", "description": "The unique person preference key." } ] }, "docs": "GraphQL endpoint: usersPersonPreference" }, { "info": { "name": "Updates a specific preference for a specific user's person.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/preferences/:personPreferenceKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." }, { "name": "personPreferenceKey", "value": "", "type": "path", "description": "The unique person preference key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: usersPersonPreferenceSet" }, { "info": { "name": "Patches a specific preference for a specific user's person.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/preferences/:personPreferenceKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." }, { "name": "personPreferenceKey", "value": "", "type": "path", "description": "The unique person preference key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: usersPersonPreferenceModify" }, { "info": { "name": "Deletes a specific preference for a specific user's person.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/preferences/:personPreferenceKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." }, { "name": "personPreferenceKey", "value": "", "type": "path", "description": "The unique person preference key." } ] }, "docs": "GraphQL endpoint: usersPersonPreferenceDelete" }, { "info": { "name": "Gets all programs from the specific user's person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/programs", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." } ] }, "docs": "GraphQL endpoint: usersPersonPrograms" }, { "info": { "name": "Creates a new program on the specific user's person.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/programs", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: usersPersonProgramAdd" }, { "info": { "name": "Gets a specific program from the specific user's person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/programs/:personProgramKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." }, { "name": "personProgramKey", "value": "", "type": "path", "description": "The unique person program key." } ] }, "docs": "GraphQL endpoint: usersPersonProgram" }, { "info": { "name": "Updates a specific program on the specific user's person.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/programs/:personProgramKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." }, { "name": "personProgramKey", "value": "", "type": "path", "description": "The unique person program key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: usersPersonProgramSet" }, { "info": { "name": "Patches a specific program on the specific user's person.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/programs/:personProgramKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." }, { "name": "personProgramKey", "value": "", "type": "path", "description": "The unique person program key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: usersPersonProgramModify" }, { "info": { "name": "Deletes a specific program on the specific user's person.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/programs/:personProgramKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." }, { "name": "personProgramKey", "value": "", "type": "path", "description": "The unique person address key." } ] }, "docs": "GraphQL endpoint: usersPersonProgramDelete" }, { "info": { "name": "Gets all stored payments from the specific user's person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/storedPayments", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." } ] }, "docs": "Gets all stored payments from the specific user's person." }, { "info": { "name": "Creates a new stored payment on the specific user's person.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/storedPayments", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: usersPersonStoredPaymentAdd" }, { "info": { "name": "Gets a specific stored payment from the specific user's person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/storedPayments/:personStoredPaymentKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." }, { "name": "personStoredPaymentKey", "value": "", "type": "path", "description": "The unique person stored payment key." } ] }, "docs": "GraphQL endpoint: usersPersonStoredPayment" }, { "info": { "name": "Updates a specific stored payment on the specific user's person.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/storedPayments/:personStoredPaymentKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." }, { "name": "personStoredPaymentKey", "value": "", "type": "path", "description": "The unique person stored payment key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "To update the account number please DELETE and POST a new stored payment.\n\nGraphQL endpoint: usersPersonStoredPaymentSet" }, { "info": { "name": "Patches a specific stored payment on the specific user's person.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/storedPayments/:personStoredPaymentKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." }, { "name": "personStoredPaymentKey", "value": "", "type": "path", "description": "The unique person stored payment key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "To update the account number please DELETE and POST a new stored payment.\n\nGraphQL endpoint: usersPersonStoredPaymentModify" }, { "info": { "name": "Deletes a specific stored payment on the specific user's person.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/storedPayments/:personStoredPaymentKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." }, { "name": "personStoredPaymentKey", "value": "", "type": "path", "description": "The unique person stored payment key." } ] }, "docs": "GraphQL endpoint: usersPersonStoredPaymentDelete" }, { "info": { "name": "Gets all travel documents from the specific user's person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/travelDocuments", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." } ] }, "docs": "Gets all travel documents from the specific user's person." }, { "info": { "name": "Creates a new travel document on the specific user's person.\nNote: Gender and Date of Birth on the Travel Document will overwrite the values on the related person object.\nThis is by design due to New Skies validation on the Gender property, and on the Travel Document\nDate of Birth being trusted over the person record Date of Birth.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/travelDocuments", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: usersPersonTravelDocumentAddv2" }, { "info": { "name": "Gets a specific travel document from the specific user's person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/travelDocuments/:personTravelDocumentKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." }, { "name": "personTravelDocumentKey", "value": "", "type": "path", "description": "The unique person travel document key." } ] }, "docs": "GraphQL endpoint: usersPersonTravelDocumentv2" }, { "info": { "name": "Deletes a specific travel document on the specific user's person.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/travelDocuments/:personTravelDocumentKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." }, { "name": "personTravelDocumentKey", "value": "", "type": "path", "description": "The unique person travel document key." } ] }, "docs": "GraphQL endpoint: usersPersonTravelDocumentDeletev2" }, { "info": { "name": "Updates a specific travel document on the specific user's person.\nNote: Gender and Date of Birth on the Travel Document will overwrite the values on the related person object.\nThis is by design due to New Skies validation on the Gender property, and on the Travel Document\nDate of Birth being trusted over the person record Date of Birth.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/users/:userKey/person/travelDocuments/:personTravelDocumentKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." }, { "name": "personTravelDocumentKey", "value": "", "type": "path", "description": "The unique person travel document key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: usersPersonTravelDocumentSetv2" }, { "info": { "name": "Patches a specific travel document on the specific user's person.\nNote: Gender and Date of Birth on the Travel Document will overwrite the values on the related person object.\nThis is by design due to New Skies validation on the Gender property, and on the Travel Document\nDate of Birth being trusted over the person record Date of Birth.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/users/:userKey/person/travelDocuments/:personTravelDocumentKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." }, { "name": "personTravelDocumentKey", "value": "", "type": "path", "description": "The unique person travel document key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: usersPersonTravelDocumentModifyv2" }, { "info": { "name": "Gets person travel notifications for a user's person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/travelNotifications", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The user key." } ] }, "docs": "GraphQL endpoint: usersPersonTravelNotifications" }, { "info": { "name": "Creates a person travel notification for a user's person.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/travelNotifications", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The user key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: usersPersonTravelNotificationAdd" }, { "info": { "name": "Gets a person travel notification for a user's person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/travelNotifications/:travelNotificationKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The user key." }, { "name": "travelNotificationKey", "value": "", "type": "path", "description": "The person travel notification key." } ] }, "docs": "GraphQL endpoint: usersPersonTravelNotification" }, { "info": { "name": "Updates a person travel notification for a user's person.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/travelNotifications/:travelNotificationKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The user key." }, { "name": "travelNotificationKey", "value": "", "type": "path", "description": "The travel notification key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: usersPersonTravelNotificationSet" }, { "info": { "name": "Patches a person travel notification for a user's person.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/travelNotifications/:travelNotificationKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The user key." }, { "name": "travelNotificationKey", "value": "", "type": "path", "description": "The travel notification key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: usersPersonTravelNotificationModify" }, { "info": { "name": "Deletes a person travel notification for a user's person.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/travelNotifications/:travelNotificationKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The user key." }, { "name": "travelNotificationKey", "value": "", "type": "path", "description": "The travel notification key." } ] }, "docs": "GraphQL endpoint: usersPersonTravelNotificationDelete" }, { "info": { "name": "Gets notification events for a person travel notification for a user's person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/travelNotifications/:travelNotificationKey/events", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The user key." }, { "name": "travelNotificationKey", "value": "", "type": "path", "description": "The travel notification key." } ] }, "docs": "GraphQL endpoint: usersPersonNotificationEvents" }, { "info": { "name": "Creates a notification event for a person travel notification for a user's person.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/travelNotifications/:travelNotificationKey/events", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The user key." }, { "name": "travelNotificationKey", "value": "", "type": "path", "description": "The travel notification key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: usersPersonNotificationEventAdd" }, { "info": { "name": "Gets a notification event for a person travel notification for a user's person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/travelNotifications/:travelNotificationKey/events/:eventType", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The user key." }, { "name": "travelNotificationKey", "value": "", "type": "path", "description": "The travel notification key." }, { "name": "eventType", "value": "", "type": "path", "description": "The event type. \nEnumeration values: 0 = DepartureDelay, 1 = ArrivalDelay, 2 = ScheduleChange, 3 = CheckIn, 4 = GateInformation" } ] }, "docs": "GraphQL endpoint: usersPersonNotificationEvent" }, { "info": { "name": "Deletes a notification event from a person travel notification for a user's person.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/travelNotifications/:travelNotificationKey/events/:eventType", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The user key." }, { "name": "travelNotificationKey", "value": "", "type": "path", "description": "The travel notification key." }, { "name": "eventType", "value": "", "type": "path", "description": "The notification event type. \nEnumeration values: 0 = DepartureDelay, 1 = ArrivalDelay, 2 = ScheduleChange, 3 = CheckIn, 4 = GateInformation" } ] }, "docs": "GraphQL endpoint: usersPersonNotificationEventDelete" }, { "info": { "name": "Gets notification timed events for a person travel notification for a user's person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/travelNotifications/:travelNotificationKey/timedEvents", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The user key." }, { "name": "travelNotificationKey", "value": "", "type": "path", "description": "The travel notification key." } ] }, "docs": "GraphQL endpoint: usersPersonNotificationTimedEvents" }, { "info": { "name": "Creates a notification timed event for a person travel notification for a user's person.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/travelNotifications/:travelNotificationKey/timedEvents", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The user key." }, { "name": "travelNotificationKey", "value": "", "type": "path", "description": "The travel notification key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: usersPersonNotificationTimedEventAdd" }, { "info": { "name": "Gets a notification timed event for a person travel notification for a user's person.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/travelNotifications/:travelNotificationKey/timedEvents/:timedEventType", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The user key." }, { "name": "travelNotificationKey", "value": "", "type": "path", "description": "The travel notification key." }, { "name": "timedEventType", "value": "", "type": "path", "description": "The timed event type. \nEnumeration values: 0 = Departure, 1 = Arrival" } ] }, "docs": "GraphQL endpoint: usersPersonNotificationTimedEvent" }, { "info": { "name": "Updates a notification timed event for a person travel notification for a user's person.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/travelNotifications/:travelNotificationKey/timedEvents/:timedEventType", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The user key." }, { "name": "travelNotificationKey", "value": "", "type": "path", "description": "The travel notification key." }, { "name": "timedEventType", "value": "", "type": "path", "description": "The notification timed event type. \nEnumeration values: 0 = Departure, 1 = Arrival" } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: usersPersonNotificationTimedEventSet" }, { "info": { "name": "Deletes a notification timed event from a person travel notification for a user's person.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/person/travelNotifications/:travelNotificationKey/timedEvents/:timedEventType", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The user key." }, { "name": "travelNotificationKey", "value": "", "type": "path", "description": "The travel notification key." }, { "name": "timedEventType", "value": "", "type": "path", "description": "The notification timed event type. \nEnumeration values: 0 = Departure, 1 = Arrival" } ] }, "docs": "GraphQL endpoint: usersPersonNotificationTimedEventDelete" }, { "info": { "name": "Retrieves the default SkySpeed settings user preferences of the specified user.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/preferences/skySpeedSettings", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique identifier of the user." } ] }, "docs": "GraphQL endpoint: usersPreferencesSkySpeedSettings" }, { "info": { "name": "Updates the default SkySpeed settings user preferences of the specified user.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/preferences/skySpeedSettings", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique identifier of the user." } ], "body": { "type": "json", "data": "{}" } }, "docs": "If the SkySpeed settings of the current user is disabled and an update is made,\nthe settings will automatically be enabled and updated.\n\nIf given, each string property is validated if it exists and is active.\n\nThe collection currency setting can only be CollectionCurrencySetting.None if the collection currency code is\nnull or empty.\n\nA bad request will be returned if the collection currency code and collection currency setting are:\n- Collection Currency Code is not null or empty and the Collecti" }, { "info": { "name": "Retrieves the default SkySpeed settings user preferences of the specified user.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/users/:userKey/preferences/skySpeedSettings", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique identifier of the user." } ] }, "docs": "GraphQL endpoint: usersPreferencesSkySpeedSettingsv2" }, { "info": { "name": "Updates the default SkySpeed settings user preferences of the specified user.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/users/:userKey/preferences/skySpeedSettings", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique identifier of the user." } ], "body": { "type": "json", "data": "{}" } }, "docs": "If the SkySpeed settings of the current user is disabled and an update is made,\nthe settings will automatically be enabled and updated.\n\nIf given, each string property is validated if it exists and is active.\n\nThe collection currency setting can only be CollectionCurrencySetting.None if the collection currency code is\nnull or empty.\n\nA bad request will be returned if the collection currency code and collection currency setting are:\n- Collection Currency Code is not null or empty and the Collecti" }, { "info": { "name": "Gets all roles for a specific user.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/roles", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." } ] }, "docs": "Gets all roles for a specific user." }, { "info": { "name": "Creates a new role for a specific user.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/roles", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: usersRoleAdd" }, { "info": { "name": "Gets a specific role for a specific user.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/roles/:userRoleKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." }, { "name": "userRoleKey", "value": "", "type": "path", "description": "The unique user role key" } ] }, "docs": "GraphQL endpoint: usersRole" }, { "info": { "name": "Updates a specific role for a specific user.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/roles/:userRoleKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." }, { "name": "userRoleKey", "value": "", "type": "path", "description": "The unique user role key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: usersRoleSet" }, { "info": { "name": "Patches a specific role for a specific user.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/roles/:userRoleKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." }, { "name": "userRoleKey", "value": "", "type": "path", "description": "The unique user role key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GraphQL endpoint: usersRoleModify" }, { "info": { "name": "Deletes a specific role for a specific user.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/:userKey/roles/:userRoleKey", "params": [ { "name": "userKey", "value": "", "type": "path", "description": "The unique user key." }, { "name": "userRoleKey", "value": "", "type": "path", "description": "The unique user role key." } ] }, "docs": "GraphQL endpoint: usersRoleDelete" }, { "info": { "name": "Retrieves the a specific user by the person key.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/users/byPerson/:personKey", "params": [ { "name": "personKey", "value": "", "type": "path", "description": "The person key of the user to retrieve." } ] }, "docs": "GraphQL endpoint: usersByPerson" } ] }, { "info": { "name": "utilities", "type": "folder" }, "items": [ { "info": { "name": "Retrieves the station local time.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/utilities/stationLocalTime/:stationCode", "params": [ { "name": "stationCode", "value": "", "type": "path", "description": "The station code to get the local time for." } ] }, "docs": "Retrieves the station local time." } ] }, { "info": { "name": "verifiedTravelDocuments", "type": "folder" }, "items": [ { "info": { "name": "Updates a list of verified travel documents for a passenger and associated infant.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/dcs/v1/verifiedTravelDocuments", "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\nThe following items are required to use this endpoint.\nAgent permissions.\nGovernment Security Drivers need to be enabled under government security configurations.\nGovernment Security Drivers need to be configured to approve the given document type.\nThe given document must be a document type approved by customs.\nThe target passenger must be either checked in or boarded on the t" }, { "info": { "name": "Adds a new verified travel document to a passenger or the associated infant.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/dcs/v1/verifiedTravelDocuments/:recordLocator/segments/:segmentKey/passengers/:passengerKey", "params": [ { "name": "recordLocator", "value": "", "type": "path", "description": "The record locator of the target booking." }, { "name": "segmentKey", "value": "", "type": "path", "description": "The target segment key." }, { "name": "passengerKey", "value": "", "type": "path", "description": "The target passenger key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\nThe following items are required to use this endpoint.\nAgent permissions.\nGovernment Security Drivers need to be enabled under government security configurations.\nGovernment Security Drivers need to be configured to approve the given document type.\nThe given document must be a document type approved by customs.\nThe target passenger must be either checked in or boarded on the t" }, { "info": { "name": "Deletes the verified travel documents for a passenger and associated infant.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/dcs/v1/verifiedTravelDocuments/:recordLocator/segments/:segmentKey/passengers/:passengerKey", "params": [ { "name": "recordLocator", "value": "", "type": "path", "description": "The record locator of the target booking." }, { "name": "segmentKey", "value": "", "type": "path", "description": "The target segment key." }, { "name": "passengerKey", "value": "", "type": "path", "description": "The target passenger key." } ] }, "docs": "Requires agent permissions.\nThis will delete all verified documents associated with the passenger which includes infant travel documents.\nIf you would like to update the list without removing all of them please use PUT\n`/api/dcs/v1/verifiedTravelDocuments`\nIMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.\n\nGraphQL endpoint: verifiedTravelDocumentsDelete" }, { "info": { "name": "Adds a new verified travel document to a passenger or the associated infant by the document key.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/dcs/v1/verifiedTravelDocuments/:recordLocator/segments/:segmentKey/passengers/:passengerKey/documents/:documentKey", "params": [ { "name": "recordLocator", "value": "", "type": "path", "description": "The record locator of the target booking." }, { "name": "segmentKey", "value": "", "type": "path", "description": "The target segment key." }, { "name": "passengerKey", "value": "", "type": "path", "description": "The target passenger key." }, { "name": "documentKey", "value": "", "type": "path", "description": "The document key of the document you would like to verify." } ] }, "docs": "`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance\nproblems.`\nThe following items are required to use this endpoint.\nAgent permissions.\nGovernment Security Drivers need to be enabled under government security configurations.\nGovernment Security Drivers need to be configured to approve the given document type.\nThe given document must be a document type approved by customs.\nThe target passenger must be either checked in or boarded on the t" } ] }, { "info": { "name": "voucherIssuance", "type": "folder" }, "items": [ { "info": { "name": "Creates vouchers based upon data in the request.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/voucherIssuance", "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint requires agent permissions.\nNote that creating high volume voucher issuance results in a batch job which may not process immediately.\n\nGraphQL endpoint: voucherIssuanceAdd" }, { "info": { "name": "Creates vouchers based upon data in the request.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/voucherIssuance", "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint requires agent permissions.\nNote that creating high volume voucher issuance results in a batch job which may not process immediately.\n\nGraphQL endpoint: voucherIssuanceAdd" }, { "info": { "name": "Gets a voucher issuance based upon the voucher issuance key.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/voucherIssuance/:voucherIssuanceKey", "params": [ { "name": "voucherIssuanceKey", "value": "", "type": "path", "description": "The voucher issuance key." } ] }, "docs": "This endpoint requires agent permissions.\n\nGraphQL endpoint: voucherIssuance" } ] }, { "info": { "name": "vouchers", "type": "folder" }, "items": [ { "info": { "name": "Gets vouchers based upon data in the request.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/vouchers", "params": [ { "name": "VoucherIssuanceKey", "value": "", "type": "query", "description": "The unique voucher issuance key.\n " }, { "name": "Market.Destination", "value": "", "type": "query", "description": "Gets or sets the leg arrival station.\n " }, { "name": "Market.Origin", "value": "", "type": "query", "description": "Gets or sets the leg departure station.\n " }, { "name": "Market.DepartureDate", "value": "", "type": "query", "description": "The departure date.\n " }, { "name": "Market.Identifier", "value": "", "type": "query", "description": "The unique transportation identifier.\n " }, { "name": "Market.CarrierCode", "value": "", "type": "query", "description": "The carrier code.\n " }, { "name": "Market.OpSuffix", "value": "", "type": "query", "description": "The op suffix.\nPlease note that this should be a char and not a string.\n " }, { "name": "Agent.Name", "value": "", "type": "query", "description": "The agent name associated with the voucher.\n " }, { "name": "Agent.Domain", "value": "", "type": "query", "description": "The domain code associated with the voucher.\n " }, { "name": "BeginDate", "value": "", "type": "query", "description": "The starting date.\n " }, { "name": "EndDate", "value": "", "type": "query", "description": "The ending date.\n " }, { "name": "PageSize", "value": "", "type": "query", "description": "The Page Size, Default 1000\n " }, { "name": "LastPageKey", "value": "", "type": "query", "description": "The LastPageKey, where to start paged query.\n " }, { "name": "SortCriteria", "value": "", "type": "query", "description": "Defines the criteria in which the find vouchers result can be sorted. Defaults to `CreatedDateAscending` if not specified or invalid.\n \nEnumeration values: 0 = CreatedDateAscending, 1 = Name, 2 = CreatedDateDescending" }, { "name": "RecordLocator", "value": "", "type": "query", "description": "The record locator associated with the voucher.\n " }, { "name": "CustomerName.FirstName", "value": "", "type": "query", "description": "The first name associated with the voucher.\n " }, { "name": "CustomerName.LastName", "value": "", "type": "query", "description": "The last name associated with the voucher.\n " }, { "name": "CustomerNumber", "value": "", "type": "query", "description": "The customer number associated with the voucher.\n " }, { "name": "ActiveOnly", "value": "", "type": "query", "description": "The flag to indicate if only active items should be returned.\n " }, { "name": "CultureCode", "value": "", "type": "query", "description": "The culture code of the paged request.\n " } ] }, "docs": "This endpoint requires agent permissions.\nOnly vouchers from the agent's non-restricted voucher configurations will be returned. To check which voucher\nconfigurations are allowed, kindly use the GET /api/nsk/v1/settings/booking/paymentCodes endpoint.\nIf given a date, one of the following properties are required:\n- CustomerName.LastName\n- CustomerNumber\n- Agent\n\t- Agent.Name\n\t- Agent.Domain\nIf only the begin date is given, the default value of the end date will be the day after the begin date.\nIf" }, { "info": { "name": "Gets a specific voucher based upon the voucher key.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/vouchers/:voucherKey", "params": [ { "name": "voucherKey", "value": "", "type": "path", "description": "The voucher key." } ] }, "docs": "This endpoint requires agent permissions.\n\nGraphQL endpoint: voucher" }, { "info": { "name": "Changes the voucher status, type, or expiration date.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/vouchers/:voucherKey", "params": [ { "name": "voucherKey", "value": "", "type": "path", "description": "The voucher key" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint requires agent permissions.\nDue to system limitations only one field can be updated per call.\nVoucher types of 0 and 2 (Credit and Service) have been removed from the request for this endpoint\nas they are not valid type to be updated to.\n\nGraphQL endpoint: voucherModify" }, { "info": { "name": "Changes the voucher owner.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/vouchers/:voucherKey/owner", "params": [ { "name": "voucherKey", "value": "", "type": "path", "description": "The voucher key" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint requires agent permissions.\nIf the personKey is populated, the voucher owner's first and last name will be updated to match what\ncorresponds with the person.\nIf no personKey is given, the names in the request will be used to update the voucher.\nAdditionally, there are configuration restrictions to be able to use this endpoint.\nFirst, the voucher must be allowed to be used by the Agent, under Booking Payments Codes -> Voucher Basis Codes.\nSecond, the voucher basis must have usage ty" }, { "info": { "name": "Gets a collection of vouchers based on the specified agent information.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/vouchers/byAgent", "params": [ { "name": "Name", "value": "", "type": "query", "description": "The agent name associated with the voucher.\n " }, { "name": "Domain", "value": "", "type": "query", "description": "The domain code associated with the voucher.\n " }, { "name": "BeginDate", "value": "", "type": "query", "description": "The starting date.\n " }, { "name": "EndDate", "value": "", "type": "query", "description": "The ending date.\n " }, { "name": "PageSize", "value": "", "type": "query", "description": "The Page Size, Default 1000\n " }, { "name": "LastPageKey", "value": "", "type": "query", "description": "The LastPageKey, where to start paged query.\n " }, { "name": "SortCriteria", "value": "", "type": "query", "description": "Defines the criteria in which the find vouchers result can be sorted. Defaults to `CreatedDateAscending` if not specified or invalid.\n \nEnumeration values: 0 = CreatedDateAscending, 1 = Name, 2 = CreatedDateDescending" } ] }, "docs": "This endpoint requires agent permissions.\nOnly vouchers from the agent's non-restricted voucher configurations will be returned. To check which voucher\nconfigurations are allowed, kindly use the GET /api/nsk/v1/settings/booking/paymentCodes endpoint.\n\nGraphQL endpoint: vouchersByAgentv2" }, { "info": { "name": "Searches for vouchers issued within the given date range.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/vouchers/byDate", "params": [ { "name": "PageSize", "value": "", "type": "query", "description": "The number of items to return.\n " }, { "name": "LastPageKey", "value": "", "type": "query", "description": "The key returned previously to get the next page of items.\n " }, { "name": "BeginDate", "value": "", "type": "query", "description": "The starting date.\n " }, { "name": "EndDate", "value": "", "type": "query", "description": "The ending date.\n " } ] }, "docs": "This endpoint requires agent permissions.\nOnly vouchers from the agent's non-restricted voucher configurations will be returned. To check which voucher\nconfigurations are allowed, kindly use the GET /api/nsk/v1/settings/booking/paymentCodes endpoint.\n\nGraphQL endpoint: vouchersByDate" }, { "info": { "name": "Gets vouchers associated with a voucher issuance.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/vouchers/byIssuance/:voucherIssuanceKey", "params": [ { "name": "voucherIssuanceKey", "value": "", "type": "path", "description": "The voucher issuance key." }, { "name": "PageSize", "value": "", "type": "query", "description": "The Page Size, Default 1000\n " }, { "name": "LastPageKey", "value": "", "type": "query", "description": "The LastPageKey, where to start paged query.\n " }, { "name": "sortCriteria", "value": "", "type": "query", "description": "Indicates how the search results will be sorted. Defaults to `CreatedDate` if not specified\nor invalid.\n \nEnumeration values: 0 = CreatedDateAscending, 1 = Name, 2 = CreatedDateDescending" } ] }, "docs": "This endpoint requires agent permissions.\nOnly vouchers from the agent's non-restricted voucher configurations will be returned. To check which voucher\nconfigurations are allowed, kindly use the GET /api/nsk/v1/settings/booking/paymentCodes endpoint.\n\nGraphQL endpoint: vouchersByIssuancev2" }, { "info": { "name": "Gets a collection of vouchers based on the market information.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/vouchers/byMarket", "params": [ { "name": "Destination", "value": "", "type": "query", "description": "Gets or sets the leg arrival station.\n " }, { "name": "Origin", "value": "", "type": "query", "description": "Gets or sets the leg departure station.\n " }, { "name": "DepartureDate", "value": "", "type": "query", "description": "The departure date.\n " }, { "name": "Identifier", "value": "", "type": "query", "description": "The unique transportation identifier.\n " }, { "name": "CarrierCode", "value": "", "type": "query", "description": "The carrier code.\n " }, { "name": "OpSuffix", "value": "", "type": "query", "description": "The op suffix.\nPlease note that this should be a char and not a string.\n " }, { "name": "PageSize", "value": "", "type": "query", "description": "The Page Size, Default 1000\n " }, { "name": "LastPageKey", "value": "", "type": "query", "description": "The LastPageKey, where to start paged query.\n " }, { "name": "SortCriteria", "value": "", "type": "query", "description": "Defines the criteria in which the find vouchers result can be sorted. Defaults to `CreatedDateAscending` if not specified or invalid.\n \nEnumeration values: 0 = CreatedDateAscending, 1 = Name, 2 = CreatedDateDescending" } ] }, "docs": "This endpoint requires agent permissions.\nOnly vouchers from the agent's non-restricted voucher configurations will be returned. To check which voucher\nconfigurations are allowed, kindly use the GET /api/nsk/v1/settings/booking/paymentCodes endpoint.\n\nGraphQL endpoint: vouchersByMarketv2" }, { "info": { "name": "Gets a specific voucher based upon the voucher reference number.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/vouchers/byReference/:voucherReferenceNumber", "params": [ { "name": "voucherReferenceNumber", "value": "", "type": "path", "description": "The voucher reference number." } ] }, "docs": "This endpoint requires agent permissions. If you are not seeing a voucher reference number, and you are expecting\nto,\nmake sure that voucher masking is turned off or that you have permissions to view voucher reference numbers.\n\nGraphQL endpoint: voucherByReferenceNumber" }, { "info": { "name": "Performs a shallow call to get all available voucher configurations.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/vouchers/configuration" }, "docs": "This endpoint requires agent permissions.\nSince this performs a shallow call, some voucher configuration list properties come back empty. To get the complete\ndata, use GET `/api/nsk/v1/vouchers/configuration/{configurationCode}` which performs a deep call to get a specific\nvoucher configuration based on the configuration code.\n\nGraphQL endpoint: voucherConfigurations" }, { "info": { "name": "Creates a new voucher configuration.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/vouchers/configuration", "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint requires agent permissions.\n\nGraphQL endpoint: addVoucherConfigurations" }, { "info": { "name": "Updates a voucher configuration.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/vouchers/configuration", "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint requires agent permissions.\nWhen updating the market or travel restrictions, you will need to specify the market or travel restrictions\nsequence number in order to properly update\nthe associated restriction.\nIn order to add new market or travel restrictions on this endpoint, the sequence number on the restriction needs to\nbe set to `-1` to indicate to\nNewSkies that it is an added restriction.\n\nGraphQL endpoint: setVoucherConfigurations" }, { "info": { "name": "Deletes a voucher configuration.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/vouchers/configuration", "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint requires agent permissions.\nA voucher configuration can only be deleted if no vouchers are associated with it.\nOtherwise, it cannot be deleted, regardless of the status of the associated vouchers\n(Active, Redeemed, Void, Expired).\n\nGraphQL endpoint: deleteVoucherConfigurations" }, { "info": { "name": "Creates a new voucher configuration.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/vouchers/configuration", "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint requires agent permissions.\n\nGraphQL endpoint: addVoucherConfigurationsv2" }, { "info": { "name": "Updates a voucher configuration.", "type": "http" }, "http": { "method": "PUT", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/vouchers/configuration", "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint requires agent permissions.\nWhen updating the market or travel restrictions, you will need to specify the market or travel restrictions\nsequence number in order to properly update\nthe associated restriction.\nIn order to add new market or travel restrictions on this endpoint, the sequence number on the restriction needs to\nbe set to `-1` to indicate to\nNewSkies that it is an added restriction.\n\nGraphQL endpoint: setVoucherConfigurationsv2" }, { "info": { "name": "Performs a deep call to get a specific voucher configuration based on the configuration code.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/vouchers/configuration/:configurationCode", "params": [ { "name": "configurationCode", "value": "", "type": "path", "description": "The code of the voucher configuration to retrieve." } ] }, "docs": "This endpoint requires agent permissions.\n\nGraphQL endpoint: voucherConfiguration" } ] }, { "info": { "name": "watchList", "type": "folder" }, "items": [ { "info": { "name": "Searches for a collection of watch list persons.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/watchList/:watchListKey/persons", "params": [ { "name": "watchListKey", "value": "", "type": "path", "description": "The watch list key." }, { "name": "ReferenceNumber", "value": "", "type": "query", "description": "The watch list reference number.\n " } ] }, "docs": "GraphQL endpoint: personsWatchList" }, { "info": { "name": "Searches for a collection of watch list persons based on a specific watch list key.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v2/watchList/:watchListKey/persons", "params": [ { "name": "watchListKey", "value": "", "type": "path", "description": "The watch list key." }, { "name": "ReferenceNumber", "value": "", "type": "query", "description": "The watch list reference number.\n " }, { "name": "LastPageKey", "value": "", "type": "query", "description": "The key of the last booking history item returned.\n " }, { "name": "PageSize", "value": "", "type": "query", "description": "The page size for the response.\n " } ] }, "docs": "The watch list key is required for this endpoint and will be validated. If it is an invalid watch list key,\nthe API will return a BadRequest.\nThe results returned will be for all persons belonging to the watch list key. This endpoint also supports paging.\nPlease refer to documentation of watch list functionality in Management Console for further guidance and more\ninformation.\n\nGraphQL endpoint: personsWatchListv2" }, { "info": { "name": "Searches for a collection of all watch list persons.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/watchList/persons", "params": [ { "name": "ReferenceNumber", "value": "", "type": "query", "description": "The watch list reference number.\n " }, { "name": "LastPageKey", "value": "", "type": "query", "description": "The key of the last booking history item returned.\n " }, { "name": "PageSize", "value": "", "type": "query", "description": "The page size for the response.\n " } ] }, "docs": "This endpoint is designed to return all person watch list results. The response is organized into a dictionary\nof watch list key to persons result list, per watch list. It should be noted that, since this endpoint supports\npaging, results from one watch list may span more than one page. So the end user should watch the paged results\nto make sure they collect all results from one particular watch list.\nThe returned page key is for all results returned, so should be used as is to get the next s" }, { "info": { "name": "Gets a specific watch list person by key.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.api.tui/flight/newskies/rest/api/nsk/v1/watchList/persons/:watchListPersonKey", "params": [ { "name": "watchListPersonKey", "value": "", "type": "path", "description": "The watch list person key." } ] }, "docs": "GraphQL endpoint: personWatchList" } ] } ], "bundled": true }