Get Offer

Use this page for the endpoint details of the independent Get Offer flow.

Use OpenAPI naming as the source of truth.

Use getOffers.do in implementation and documentation.

Main API

• getOffers.do

Use this when you need

• An offer lookup flow without standard search

• A real-time price check before order creation

• A lowest-price validation step before ticketing

Best practice

• use getOffers.do when the target itinerary is already known

• keep the returned OfferId for downstream order creation

• refresh the offer if passenger mix, flight choice, or expected fare changes

• use order.do and pay.do as the standard downstream path

• query getLuggage.do or seatAvailability.do only when ancillaries matter before booking

Related pages

• Get Offer

• Create Order

• Payment & Ticketing

• Search & Booking

Get Offer

post

Dependency: No preceding function needs to be called before Get Offer.

• Compared to the Verify API, the GetOffer API does not rely on Search results and improves the success rate of price verify. Since using our GetOffer real-time search increases the L2B Ratio of our requesting carrier API, not all carriers support price verification via the GetOffer.

• Please contact your Key Account Manager if you want to use the GetOffer API. Atlas will review your workflow and if deemed aplicable, Atlas will provide further information and support you with the implementation of this API.

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

Header parameters

AcceptstringRequiredExample: application/json

Content-TypestringRequiredExample: application/json

Accept-EncodingstringRequiredExample: gzip

x-atlas-client-idstringRequiredExample: NAR65434_api_1

x-atlas-client-secretstringRequiredExample: <YOUR_CLIENT_ID>

Body

application/json

adultsinteger · min: 1 · max: 9Required

Number of adults

Default: 0Example: 1

childreninteger · max: 9 · nullableOptional

Number of children

Default: 0Example: 0

infantsinteger · max: 9 · nullableOptional

Number of infants

Default: 0Example: 0

currencystring · nullableOptional

Quotation currency, optional, default will be determined based on a certain strategy, such as the currency of the customer's pre deposit account

Example: USD

residentCodestring · nullableOptional

Resident discount code

Responses

200Success

application/json

statusinteger · enumRequired

• 0: success
• 116: airline error
• 112: timed out
• 9999: system error

Possible values:

msgstring · nullableOptional

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, such as judging whether the interface response is successful based on this field. You should always judge solely based on whether the status is equal to 0.

post

/getOffers.do

HTTPcURLJavaScriptPython

POST /getOffers.do HTTP/1.1
Accept: text
Accept-Encoding: text
x-atlas-client-id: NAR65434_api_1
x-atlas-client-secret: <YOUR_CLIENT_ID>
Content-Type: application/json
Content-Length: 304

{
  "adults": 1,
  "children": 0,
  "infants": 0,
  "inboundSegments": [
    {
      "arrivalAirport": "NRT",
      "carrier": "IJ",
      "departureAirport": "PVG",
      "departureDate": "20250908",
      "flightNumber": "004"
    }
  ],
  "outboundSegments": [
    {
      "arrivalAirport": "PVG",
      "carrier": "IJ",
      "departureAirport": "NRT",
      "departureDate": "20250904",
      "flightNumber": "001"
    }
  ]
}

200Success

{
  "data": [
    {
      "bookingRequirement": {
        "passenger": {
          "cardIssuePlace": {
            "required": true,
            "type": "string"
          },
          "birthday": {
            "required": true,
            "type": "string"
          },
          "cardNum": {
            "required": true,
            "type": "string"
          },
          "passengerType": {
            "required": true,
            "type": "int"
          },
          "nationality": {
            "required": true,
            "type": "string"
          },
          "gender": {
            "required": true,
            "type": "string"
          },
          "cardExpired": {
            "required": true,
            "type": "string"
          },
          "cardType": {
            "required": true,
            "type": "string"
          },
          "name": {
            "required": true,
            "type": "string"
          }
        }
      },
      "offer": {
        "inboundJourney": {
          "journeyID": "ij",
          "segments": [
            {
              "cabinClass": "Economy",
              "carrier": "IJ",
              "duration": 180,
              "fareFamily": "Lucky Spring",
              "flightNumber": "4",
              "legs": [
                {
                  "aircraftType": "",
                  "arrivalAirport": "NRT",
                  "arrivalTerminal": "",
                  "arrivalTime": "202509082135",
                  "departureAirport": "PVG",
                  "departureTerminal": "",
                  "departureTime": "202509081735"
                }
              ],
              "rBD": "R1",
              "seatsLeft": 9,
              "segmentID": "is-2"
            }
          ]
        },
        "offerID": "o_e11c74d10d85485a8732b3800aa55f1d_1",
        "offerToken": "VFlPX1NIQV8yXzIwMjUwOTA0XzIwMjUwOTA4XzFfMF8wfFJDUzc3NDc4X2FwaV8xfDF8MTg0LjcyXzE2Ny41OV81NS43M18wLjUwXzQwOC41NF9VU0R8VFlPX1NIQV8xXzIwMjUwOTA0XzIwMjUwOTA4XzFfMF8wXk5SVC1JSjAwMS1SMS1QVkctMjAyNTA5MDQyMjQ1LTIwMjUwOTA1MDEyNS1MdWNreSBTcHJpbmctMS0jUFZHLUlKMDA0LVIxLU5SVC0yMDI1MDkwODE3MzUtMjAyNTA5MDgyMTM1LUx1Y2t5IFNwcmluZy0yLV4xODQuNzJfMTY3LjU5XzU1LjczXzAuNTBfNDA4LjU0XkFJSl9BSUpeXl5DTlleMTMyNi4wMF4xMjAzLjAwXjQwMC4wMF4wfDB8MjAyNTA4MTYxNzA4MTl8MHxvX2UxMWM3NGQxMGQ4NTQ4NWE4NzMyYjM4MDBhYTU1ZjFkfHx8R2V0T2ZmZXJ8fDAuNTB8M3wwfHxub3JtYWx8ZmFsc2U=.PaLlOsP6tMoDuhw9U/VyFOL5mcAdLP2PeAGRBzPunwg=",
        "outboundJourney": {
          "journeyID": "oj",
          "segments": [
            {
              "cabinClass": "Economy",
              "carrier": "IJ",
              "duration": 220,
              "fareFamily": "Lucky Spring",
              "flightNumber": "1",
              "legs": [
                {
                  "aircraftType": "",
                  "arrivalAirport": "PVG",
                  "arrivalTerminal": "",
                  "arrivalTime": "202509050125",
                  "departureAirport": "NRT",
                  "departureTerminal": "",
                  "departureTime": "202509042245"
                }
              ],
              "rBD": "R1",
              "seatsLeft": 9,
              "segmentID": "os-1"
            }
          ]
        },
        "paxFares": [
          {
            "paxType": "ADT",
            "price": {
              "baseAmount": 94.73,
              "currency": "USD",
              "taxes": 89.99
            }
          },
          {
            "paxType": "CHD",
            "price": {
              "baseAmount": 94.73,
              "currency": "USD",
              "taxes": 72.86
            }
          },
          {
            "paxType": "INF",
            "price": {
              "baseAmount": 55.73,
              "currency": "USD",
              "taxes": 0
            }
          }
        ],
        "penalties": [
          {
            "amount": 576,
            "currency": "CNY",
            "journeyRefIDs": [
              "oj"
            ],
            "rule": {
              "airlineFee": 0,
              "currency": "CNY",
              "effectiveMinutes": 525600,
              "expirationMinutes": 43200,
              "fixedAmount": 576,
              "levelType": "Partial",
              "paxTypes": [
                "ADT",
                "CHD"
              ],
              "percent": 0,
              "percentBase": "fare+tax",
              "type": "Refund"
            }
          },
          {
            "amount": 615,
            "currency": "CNY",
            "journeyRefIDs": [
              "oj"
            ],
            "rule": {
              "airlineFee": 0,
              "currency": "CNY",
              "effectiveMinutes": 43200,
              "expirationMinutes": 21600,
              "fixedAmount": 615,
              "levelType": "Partial",
              "paxTypes": [
                "ADT",
                "CHD"
              ],
              "percent": 0,
              "percentBase": "fare+tax",
              "type": "Refund"
            }
          },
          {
            "amount": 654,
            "currency": "CNY",
            "journeyRefIDs": [
              "oj"
            ],
            "rule": {
              "airlineFee": 0,
              "currency": "CNY",
              "effectiveMinutes": 21600,
              "expirationMinutes": 10080,
              "fixedAmount": 654,
              "levelType": "Partial",
              "paxTypes": [
                "ADT",
                "CHD"
              ],
              "percent": 0,
              "percentBase": "fare+tax",
              "type": "Refund"
            }
          },
          {
            "amount": 693,
            "currency": "CNY",
            "journeyRefIDs": [
              "oj"
            ],
            "rule": {
              "airlineFee": 0,
              "currency": "CNY",
              "effectiveMinutes": 10080,
              "expirationMinutes": 1440,
              "fixedAmount": 693,
              "levelType": "Partial",
              "paxTypes": [
                "ADT",
                "CHD"
              ],
              "percent": 0,
              "percentBase": "fare+tax",
              "type": "Refund"
            }
          },
          {
            "amount": 771,
            "currency": "CNY",
            "journeyRefIDs": [
              "oj"
            ],
            "rule": {
              "airlineFee": 0,
              "currency": "CNY",
              "effectiveMinutes": 1440,
              "expirationMinutes": 0,
              "fixedAmount": 771,
              "levelType": "Partial",
              "paxTypes": [
                "ADT",
                "CHD"
              ],
              "percent": 0,
              "percentBase": "fare+tax",
              "type": "Refund"
            }
          },
          {
            "amount": 771,
            "currency": "CNY",
            "journeyRefIDs": [
              "oj"
            ],
            "rule": {
              "airlineFee": 0,
              "currency": "CNY",
              "effectiveMinutes": 0,
              "expirationMinutes": -43200,
              "fixedAmount": 771,
              "levelType": "Partial",
              "paxTypes": [
                "ADT",
                "CHD"
              ],
              "percent": 0,
              "percentBase": "fare+tax",
              "type": "Refund"
            }
          },
          {
            "amount": 410,
            "currency": "CNY",
            "journeyRefIDs": [
              "ij"
            ],
            "rule": {
              "airlineFee": 0,
              "currency": "CNY",
              "effectiveMinutes": 525600,
              "expirationMinutes": 43200,
              "fixedAmount": 410,
              "levelType": "Partial",
              "paxTypes": [
                "ADT",
                "CHD"
              ],
              "percent": 0,
              "percentBase": "fare+tax",
              "type": "Refund"
            }
          },
          {
            "amount": 439,
            "currency": "CNY",
            "journeyRefIDs": [
              "ij"
            ],
            "rule": {
              "airlineFee": 0,
              "currency": "CNY",
              "effectiveMinutes": 43200,
              "expirationMinutes": 21600,
              "fixedAmount": 439,
              "levelType": "Partial",
              "paxTypes": [
                "ADT",
                "CHD"
              ],
              "percent": 0,
              "percentBase": "fare+tax",
              "type": "Refund"
            }
          },
          {
            "amount": 468,
            "currency": "CNY",
            "journeyRefIDs": [
              "ij"
            ],
            "rule": {
              "airlineFee": 0,
              "currency": "CNY",
              "effectiveMinutes": 21600,
              "expirationMinutes": 10080,
              "fixedAmount": 468,
              "levelType": "Partial",
              "paxTypes": [
                "ADT",
                "CHD"
              ],
              "percent": 0,
              "percentBase": "fare+tax",
              "type": "Refund"
            }
          },
          {
            "amount": 497,
            "currency": "CNY",
            "journeyRefIDs": [
              "ij"
            ],
            "rule": {
              "airlineFee": 0,
              "currency": "CNY",
              "effectiveMinutes": 10080,
              "expirationMinutes": 1440,
              "fixedAmount": 497,
              "levelType": "Partial",
              "paxTypes": [
                "ADT",
                "CHD"
              ],
              "percent": 0,
              "percentBase": "fare+tax",
              "type": "Refund"
            }
          },
          {
            "amount": 555,
            "currency": "CNY",
            "journeyRefIDs": [
              "ij"
            ],
            "rule": {
              "airlineFee": 0,
              "currency": "CNY",
              "effectiveMinutes": 1440,
              "expirationMinutes": 0,
              "fixedAmount": 555,
              "levelType": "Partial",
              "paxTypes": [
                "ADT",
                "CHD"
              ],
              "percent": 0,
              "percentBase": "fare+tax",
              "type": "Refund"
            }
          },
          {
            "amount": 555,
            "currency": "CNY",
            "journeyRefIDs": [
              "ij"
            ],
            "rule": {
              "airlineFee": 0,
              "currency": "CNY",
              "effectiveMinutes": 0,
              "expirationMinutes": -43200,
              "fixedAmount": 555,
              "levelType": "Partial",
              "paxTypes": [
                "ADT",
                "CHD"
              ],
              "percent": 0,
              "percentBase": "fare+tax",
              "type": "Refund"
            }
          }
        ],
        "services": [
          {
            "level": "Free",
            "metadata": {
              "maximumDimension": "",
              "maximumPiece": 0,
              "maximumWeight": 0,
              "type": "StandardCheckInBaggage"
            },
            "paxTypes": [
              "CHD"
            ],
            "segmentRefIDs": [
              "os-1",
              "is-2"
            ],
            "serviceID": "fbs-1",
            "type": "Baggage"
          },
          {
            "level": "Free",
            "metadata": {
              "maximumDimension": "",
              "maximumPiece": 0,
              "maximumWeight": 0,
              "type": "StandardCheckInBaggage"
            },
            "paxTypes": [
              "INF"
            ],
            "segmentRefIDs": [
              "os-1",
              "is-2"
            ],
            "serviceID": "fbs-2",
            "type": "Baggage"
          },
          {
            "level": "Free",
            "metadata": {
              "maximumDimension": "",
              "maximumPiece": 0,
              "maximumWeight": 0,
              "type": "StandardCheckInBaggage"
            },
            "paxTypes": [
              "ADT"
            ],
            "segmentRefIDs": [
              "os-1",
              "is-2"
            ],
            "serviceID": "fbs-3",
            "type": "Baggage"
          },
          {
            "level": "Free",
            "metadata": {
              "maximumDimension": "56*36*23cm",
              "maximumPiece": 0,
              "maximumWeight": 0,
              "type": "CabinBaggageUnderSeat"
            },
            "paxTypes": [
              "INF"
            ],
            "segmentRefIDs": [
              "os-1",
              "is-2"
            ],
            "serviceID": "fbs-4",
            "type": "Baggage"
          },
          {
            "level": "Free",
            "metadata": {
              "maximumDimension": "56*36*23cm",
              "maximumPiece": 1,
              "maximumWeight": 7,
              "type": "CabinBaggageUnderSeat"
            },
            "paxTypes": [
              "CHD"
            ],
            "segmentRefIDs": [
              "os-1",
              "is-2"
            ],
            "serviceID": "fbs-5",
            "type": "Baggage"
          },
          {
            "level": "Free",
            "metadata": {
              "maximumDimension": "56*36*23cm",
              "maximumPiece": 1,
              "maximumWeight": 7,
              "type": "CabinBaggageUnderSeat"
            },
            "paxTypes": [
              "ADT"
            ],
            "segmentRefIDs": [
              "os-1",
              "is-2"
            ],
            "serviceID": "fbs-6",
            "type": "Baggage"
          },
          {
            "level": "Chargeable",
            "paxTypes": [
              "ADT",
              "CHD"
            ],
            "segmentRefIDs": [
              "os-1"
            ],
            "serviceID": "fss-1",
            "type": "Seat"
          },
          {
            "level": "Chargeable",
            "paxTypes": [
              "ADT",
              "CHD"
            ],
            "segmentRefIDs": [
              "is-2"
            ],
            "serviceID": "fss-2",
            "type": "Seat"
          },
          {
            "level": "Chargeable",
            "paxTypes": [
              "ADT",
              "CHD"
            ],
            "segmentRefIDs": [
              "os-1"
            ],
            "serviceID": "fms-1",
            "type": "Meal"
          },
          {
            "level": "Chargeable",
            "paxTypes": [
              "ADT",
              "CHD"
            ],
            "segmentRefIDs": [
              "is-2"
            ],
            "serviceID": "fms-2",
            "type": "Meal"
          }
        ],
        "terms": []
      },
      "serviceFee": {
        "amountPerUnit": 0.5,
        "currency": "USD",
        "unit": "PER_PAX"
      },
      "supportedPaymentMethods": [
        "Deposit"
      ]
    }
  ],
  "status": 0
}