Sign in
latestOpenAPI 3.0.12026-08-102668257.3 KB

8e9a8f8010ab

Post Ticketing Service

Search Ancillary

Dependency: No preceding function needs to be carried out. The order should be ticketed and the departure date should be in the future.

Please note the below "Rules & Restrictions" while initiating a post-ticketing transaction.

  1. Single Booking Limit: Check-in baggage and Carry-on baggage can be added to the segment of passenger either in-booking or post-booking phase altogether or separately, but each type of baggage can only be added one time for the given segment throughout the whole flow. This rule aims to simplify the baggage booking flow for customers by sending the query only one time to book multiple baggages.
  2. Product Code: "Product code" contains various baggage offerings in aspects of baggage pieces and weights for each airline.
  3. Restrictions for Infants: Baggage ancillary is not allowed to be booked for infant passenger.
  4. Post-Booking Baggage Additions: It is not allowed to add the same type of post-booking baggage to a ticketed order the second time unless the first purchase fails in payment. Please refer to the below scenarios: a. When the post-booking order is in "ticket-in-process" and "ticketed" status, it's not allowed to order another one. If any query is called, API will respond with an error message. b. When the post-booking order is in "cancelled" status, the customer can create another order. c. When the post-booking order is in "unpaid" status, the customer can create another order. However, if one of the orders completes the payment and moves to "ticketing-in-process" status, the other orders will stop processing the payment.
  5. Existing Baggage Policies: In case the air ticket order already contains free baggage, it’s subject to airline’s ancillary policy whether additional baggage is allowed to be purchase either at the booking flow or the post-booking flow.
  6. Consistent Product Codes in Connecting Flights: Same “product code” for baggage is mandatory to be added to each segment in connecting flights. If the "product code" is different for each of the segment (in the same direction) or not added for all the sectors, the API will respond with an error message.
  7. Round-Trip Baggage Rule: Rule No.6 doesn't work for round trip flights. This means that the outbound and inbound segments can have different product codes. For example, outbound journey may have a product code of 1PC and 10KG while the inbound journey may have a product code of 20KG. This is allowed.
  8. API Request Information: The details of only the passenger for whom the ancillary needs to be added must be sent in the API RQ.

Endpoint: https://sandbox.atriptech.com/postBookingAncillarySearch.do

post/postBookingAncillarySearch.do

Headers

Acceptstring required
Content-Typestring required
Accept-Encodingstring required
x-atlas-client-idstring required
x-atlas-client-secretstring required

Request body

ticketOrderNostring nullable

Order number. It is the original order number.

ancillaryCategorystring required

Ancillary Category. Different categories of ancillaries need to be separately requested. Currently we only supportBAGGAGE.

paymentMethodinteger nullable

The payment method you prefer to use. If you specify a payment method (provided that the fare supports it), then you can only use that method for payment.

Response

status117 | 118 | 119 | 120 | 121 | 125 required
msgstring

It serves as an additional description of the response result. Especially when the interface reports an error (status !=0), it is usually a human-readable error message. Note: Do not use this field in any programming scenarios. For example, do not judge whether the interface responds successfully based on this field. Instead, you should only determine it by checking whether the status is equal to0at any time.

sessionIdstring required

The unique identifier for this search. It is required when you call order function to make a reservation to identify which ancillary the client is choosing.

ticketOrderNostring required

Order number. It is the original order number.

supportCreditTransPaymentstring required

This tag is used to identify if the fare needs to be paid using the client's credit card. This field has been deprecated, please use supportPaymentMethods instead.

currencystring required

The currency in which Atlas settles transactions with you.

supportPaymentMethodsPaymentMethod[] nullable

Support payment methods. If payment is not supported in any way, this will be nullor[]