Order Ancillary - Atlas API-Sabre

Request

Header Params

Accept

string

required

Example:

application/json

Content-Type

string

required

Example:

application/json

Accept-Encoding

string

required

Example:

gzip

x-atlas-client-id

string

required

Example:

<YOUR_CLIENT_ID>

x-atlas-client-secret

string

required

Example:

<YOUR_CLIENT_SECRET>

Body Params application/json

sessionId

string

required

Identifier of the searched ancillary, received from the ancillary search response.

ancillaryCategory

string

required

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

ticketOrderNo

string

required

Order number. It is the original order number.

passengers

array [object {3}]

required

Passengers who need to purchase ancillary services and the ancillary services they choose

name

string

required

The passenger's name. Please send it in the following format: Family Name/Given Name

passengerType

enum<integer>

required

Type of passenger

Allowed values:

012

ancillaries

array [object {2}] | null

optional

Ancillaries selection for the specific passenger

payment

object | null

optional

cardType

enum<string>

required

The card type you wish to use for payment. Send this information when generating an order can be used to calculate the payment handling fee. This parameter is only effective and required in the MoR payment scenario.

Allowed values:

AmexVisaMasterCardJCBDiscoverDinersClub

Example

{"allowGenerateMultipleOrders":false,"ancillaryCategory":"BAGGAGE","baggagePiece":0,"baggageWeight":0,"cid":"ttxzp62405","passengers":[{"ancillaries":[{"productCode":"SCI_BAG_1PC_20KG","segmentIndex":1}],"name":"TEST/DIANA","passengerType":0}],"requestIp":"35.192.181.145","seatStrongVerify":false,"sessionId":"97223dc1-83c8-4e1f-8035-08225a3b542a","skipDuplicateCheck":false,"ticketOrderNo":"AHRXX20250508172501676","useAtlasMailForContact":false}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://sandbox.atriptech.compostBookingAncillaryOrder.do' \
--header 'Accept: application/json' \
--header 'Accept;' \
--header 'Accept-Encoding: gzip' \
--header 'Accept-Encoding;' \
--header 'x-atlas-client-id: <YOUR_CLIENT_ID>' \
--header 'x-atlas-client-id;' \
--header 'x-atlas-client-secret: <YOUR_CLIENT_SECRET>' \
--header 'x-atlas-client-secret;' \
--header 'Content-Type: application/json' \
--data-raw '{"allowGenerateMultipleOrders":false,"ancillaryCategory":"BAGGAGE","baggagePiece":0,"baggageWeight":0,"cid":"ttxzp62405","passengers":[{"ancillaries":[{"productCode":"SCI_BAG_1PC_20KG","segmentIndex":1}],"name":"TEST/DIANA","passengerType":0}],"requestIp":"35.192.181.145","seatStrongVerify":false,"sessionId":"97223dc1-83c8-4e1f-8035-08225a3b542a","skipDuplicateCheck":false,"ticketOrderNo":"AHRXX20250508172501676","useAtlasMailForContact":false}'

Responses

🟢200Success

application/json

Body

status

enum<integer>

required

501: Add purchase not allowed. Description: Ancillary addition is not allowed for this order. Check with the airline or open a Service Request with Atlas for the same.

502: The price has increased, and the order creation has failed. Please perform a new search.. Description: There is a price change from the time the ancillary order search was conducted.

503: Incorrect baggage selection

504: Additional baggage not allowed. Ancillary baggage already exists in the original order. Description: Atlas only allows the attachment of ancillary baggage only once

505: Additional baggage not allowed. Baggage already booked as post-ticket ancillary.. Description: Atlas only allows the attachment of ancillary baggage only once

506: Ancillary addition is not supported for infants

507: It's not allowed to purchase ancillary in 24 hours before departure

508: No payment method is available. Please check whether the quotation currency or account configuration is correct.

509: Illegal request param

Allowed values:

301302303304305307308309310312313315316317318319320321322323324325326327328329330

msg

string

required

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.

sessionId

string

required

Echo thesessionIdin the request parameters.

orderNo

string

required

Order number of the created order.

totalPrice

number

required

Total price(not including service fee) of this order in the currency TheAtlas settled with you

totalTransactionFee

number

required

Total technical fees for this order in the currency TheAtlas settled with you.

currency

string

required

The currency TheAtlas settled with you.

vendorTotalPrice

number | null

optional

Total price of this order in the vendor's currency, reference for you to generate the specific credit card.

vendorCurrency

string | null

optional

Vendor's currency.

tktLimitTime

string

required

Payment deadline for this order. This time will be displayed in SGT (GMT +8). The fromat is:yyyy-MM-dd HH:mm:ss.

paxTicketInfos

array [object {12}]

required

Ticket and ancillary information for passengers who purchased ancillary services.

name

string

required

Echo the passenger's name, in the format of last name/first name

passengerType

enum<integer>

required

Echo the passenger's type

Allowed values:

012

birthday

string

required

Echo the passenger's birthday

gender

string

required

Echo the passenger's gender

cardNum

string | null

optional

Echo the passenger's identity document number

cardType

string | null

optional

Echo the passenger's identity document type

cardIssuePlace

string | null

optional

Echo the country where the passenger's identification document was issued.

cardExpired

string | null

optional

Echo the expiration date of the passenger's identification document.

nationality

string | null

optional

Echo the passenger's nationality

ticketNos

array[string]

required

Ticket numbers

airlinePNRs

array[string]

required

Airline PNRs. The array count would be the same as ticketnos count

ancillaries

array [object {10}] | null

optional

Ancillaries selection for the specific passenger

paymentOptions

array [object {5}]

required

Available paymebt options for this order

paymentMethod

integer

required

serviceFee

object (PaymentOption)

required

ticketFare

object (PaymentOption)

required

paymentFee

object (PaymentOption)

required

cardType

string | null

required

Example

{"currency":"USD","orderNo":"BFGFE20250509210115665","paxTicketInfos":[{"airlinePNRs":[],"ancillaries":[{"ancillaryPrice":17.43,"auxBaggageElement":{"allWeight":true,"piece":1,"weight":20},"buyMethod":"0","currency":"USD","displayCurrency":"PLN","displayPrice":66.11,"productCode":"SCI_BAG_1PC_20KG","segmentIndex":1}],"birthday":"19850814","cardExpired":"20270125","cardIssuePlace":"PL","cardNum":"PB7343999","cardType":"PP","contactEmails":["DIANAZUBIAK@INTERIA.PL"],"contactPhones":["0048-667976991"],"gender":"F","name":"TEST/DIANA","nationality":"PL","passengerType":0,"ticketNos":[]}],"paymentOptions":[{"paymentMethod":3,"serviceFee":{"amount":0.75,"currency":"USD","deductFrom":"DEPOSIT"},"ticketFare":{"amount":2490.00,"currency":"JPY","deductFrom":"CARD"}},{"paymentFee":{"amount":0.87,"currency":"USD","deductFrom":"CARD","displayAmount":3.31,"displayCurrency":"PLN"},"paymentMethod":5,"serviceFee":{"amount":0.75,"currency":"USD","deductFrom":"DEPOSIT"},"ticketFare":{"amount":17.43,"currency":"USD","deductFrom":"CARD"}}],"sessionId":"97223dc1-83c8-4e1f-8035-08225a3b542a","status":0,"success":true,"ticketOrderNo":"AHRXX20250508172501676","tktLimitTime":"2025-05-09 21:17:15","totalPrice":17.43,"totalTransactionFee":0.75,"vendorCurrency":"JPY","vendorTotalPrice":2490.00}