Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

API provides:

  • General shopping flow: searching, booking and ticketing flight solutions;
  • Service operations with bookings (read, change and cancel) and tickets (read and void);
  • Information such as flight details, ancillaries and fare pricing, raw fare rules directly from S7

Also service makes available shopping with 3D agreements Corporate Program (Agent sell S7 flights for theirs corporate clients with special discounts).

All operations use synchronous behaviour, generally stateless model and IATA NDC schema v15.2

Note

Before you can send a request to S7 Agent API, you must get an SSL certificate and configure your software.


Table of contents:

Table of Contents

Page tree:

Children Display
depth6

Operation list

Legend: (tick) — available in the version, (error) — not available in the version

#Operation nameInput messageOutput messagev0.52Description / Use casesSamples
1
searchFlights
searchFlightsFlexAirShoppingRQAirShoppingRS

Search flight solutions with use cases:

  1. Low fare
  2. Branded fares
  3. Flight info
(tick)Search operation finds one cheapest solution for each day of given range for the specified search criteria


Expand
titleSamples

Children Display
alltrue
pagesearchFlightsFlex operation

Children DisplaypagesearchFlight operation

| Samples


2
findRules
searchFlightsJourney
FareRulesRQ
AirShoppingRQ
FareRulesRS

Get fare rules for a flight

3seatMapSeatAvailabilityRQSeatAvailabilityRS

Get seat map for a flight

4baggageChargesBaggageChargesRQBaggageChargesRS

Get extra baggage pricing for a whole requested itinerary

5servicePriceServicePriceRQServicePriceRS

Get seats and extra baggage pricing for a whole requested itinerary

6bookOrderCreateRQOrderViewRSCreate booking by flight solution

Children Display
pagebook operation | Samples

7readOrderRetrieveRQOrderViewRSRead booking by PNR8changeBookOrderChangeRQOrderViewRS

Change booking by PNR:

  1. Add remarks
  2. Seats assignment
  3. Change seats assignment
  4. Add request for extra baggage
9cancelBookingOrderCancelRQOrderCancelRSCancel booking by PNR10repriceItinReshopRQItinReshopRSGet actual flight pricing by PNR

Children Display
pagereprice operation | Samples

11demandTicketAirDocIssueRQAirDocDisplayRS

Issuing documents:

  1. e-tickets (ETK)
  2. seats assignment EMD
  3. extra baggage EMD

Children Display
pagedemandTicket operation | Samples

12retrieveTicketAirDocDisplayRQAirDocDisplayRSRead ticket (ETK) by number13voidTicketAirDocVoidRQAirDocVoidRSVoid ticket (ETK) by number14agentPaymentOrderCreateRQOrderViewRS

Create booking by flight solution, proceed payment, issue ETK for all passengers and send receipts to lead passenger

Note

It is not public. Request our technical support for access to documentation by JIRA or email at api.support@s7.ru

Children Display
pageagentPayment operation | Samples

API provides:

  • General shopping flow: searching, booking and ticketing flight solutions;
  • Service operations with bookings (read, change and cancel) and tickets (read and void);
  • Information such as flight details, ancillaries and fare pricing, raw fare rules directly from S7. 

Also service makes available shopping with 3D agreements (Agent sell S7 flights for theirs corporate clients with special discounts).

All operations use synchronous behaviour, generally stateless model and IATA NDC schema v15.2

Note

Before you can send a request to S7 Agent API, you must get an SSL certificate and configure your software.

AirShoppingRS(tick)Search flights request the whole trip for the specified itinerary data


Expand
titleSamples

Children Display
alltrue
pagesearchFlightsJourney operation | Samples


3searchFlightsBySliceAirShoppingRQAirShoppingRS(tick)Search flights request slice by slice for the specified itinerary data


Expand
titleSamples

Children Display
alltrue
pagesearchFlightsBySlice operation | Samples


4flightInfoAirShoppingRQAirShoppingRS(tick)Flight info request for a specified single flight


Expand
titleSamples

Children Display
alltrue
pageflightInfo operation | Samples


5findRulesFareRulesRQFareRulesRS(error)

Returns the filed details of a specific fare basis code


6seatMapSeatAvailabilityRQSeatAvailabilityRS(tick)

Returns data used to construct seat map with prices


Expand
titleSamples

Children Display
alltrue
pageseatMap operation | Samples


7baggageChargesBaggageChargesRQBaggageChargesRS(error)Returns pricing for extra baggage
(warning) Deprecated. Use servicePrice operation instead

8servicePriceServicePriceRQServicePriceRS(tick)

Returns pricing of ancillary services


Expand
titleSamples

Children Display
alltrue
pageservicePrice operation | Samples


9bookOrderCreateRQOrderViewRS(tick)Creates new reservation (PNR) in PSS


Expand
titleSamples

Children Display
alltrue
pagebook operation | Samples


10readOrderRetrieveRQOrderViewRS(tick)Returns information about existing PNR by PNR number


Expand
titleSamples

Children Display
alltrue
pageread operation | Samples


11changeBookOrderChangeRQOrderViewRS(tick)

Modification of PNR by specifying which PNR items to change and what to change
(add/change/delete ancillary services, remarks or passengers information)


Expand
titleSamples

Children Display
alltrue
pageread operation | Samples


12cancelBookingOrderCancelRQOrderCancelRS(tick)Operation of cancellation of a specified PNR, and returns confirmation of cancellation
13repriceItinReshopRQItinReshopRS(tick)Operation returns the actual fares (for ticketing operation) according to the specified itinerary parameters


Expand
titleSamples

Children Display
alltrue

Table of contents:

Table of Contents

Page tree:

Children Display
depth6

Operation list

#Operation nameInput messageOutput messageDescription / Use casesSamples1searchFlightsAirShoppingRQAirShoppingRS

Search flight solutions with use cases:

  1. Low fare
  2. Branded fares
  3. Flight info

Children Display
pagesearchFlight operation | Samples

2findRulesFareRulesRQFareRulesRS

Get fare rules for a flight

3seatMapSeatAvailabilityRQSeatAvailabilityRS

Get seat map for a flight

4baggageChargesBaggageChargesRQBaggageChargesRS

Get extra baggage pricing for a whole requested itinerary

5servicePriceServicePriceRQServicePriceRS

Get seats and extra baggage pricing for a whole requested itinerary

6bookOrderCreateRQOrderViewRSCreate booking by flight solution

Children Display
pagebook operation | Samples

7readOrderRetrieveRQOrderViewRSRead booking by PNR8changeBookOrderChangeRQOrderViewRS

Change booking by PNR:

  1. Add remarks
  2. Seats assignment
  3. Change seats assignment
  4. Add request for extra baggage
9cancelBookingOrderCancelRQOrderCancelRSCancel booking by PNR10repriceItinReshopRQItinReshopRSGet actual flight pricing by PNRchildren

pagereprice operation | Samples

11


14
demandTicket
demandTicketsAirDocIssueRQAirDocDisplayRS

Issuing documents:

  1. e-tickets (ETK)
  2. seats assignment EMD
  3. extra baggage EMD

Children Display
pagedemandTicket operation | Samples

12
(tick)

Operation set requests an Airline to issue flight (ETK) and/or ancillary (EMD) document(s)



15retrieveTicketAirDocDisplayRQAirDocDisplayRS
Read ticket (ETK) by number13
(tick)Returns information about existing ETK/EMD by ETK/EMD number
16voidTicketAirDocVoidRQAirDocVoidRS
Void ticket (ETK) by number
(tick)Allows to void existing ETK
17
14
agentPaymentOrderCreateRQOrderViewRS(tick)

Create booking by flight solution, proceed payment, issue ETK for all passengers and send receipts to lead passenger
(warning) Deprecated. Use orderCreate and orderChange operations instead

Note

It is not public. Request our technical support for access to documentation by 

JIRA



18orderCreateorderCreateRQOrderViewRS(tick)

Create booking by flight solution, proceed payment, issue ETK for all passengers and send receipts to lead passenger

Note

It is not public. Request our technical support for access to documentation by Kaiten or email at api.support@s7.

Children DisplaypageagentPayment operation | Samples

ru



19orderChangeorderChangeRQOrderViewRS(tick)

Complete 3DS payment started with the orderCreate operation, and continue issue ETK for all passengers and send receipts to lead passenger

Note

It is not public. Request our technical support for access to documentation by Kaiten or email at api.support@s7.ru