Ticketing Complete Notification

Webhook event sent when ticketing is completed and ticket details are available.

Use this webhook when you need the final ticketed result for an order.

Trigger

Atlas sends order.ticketed after ticketing is completed.

What you should do

When you receive this event:

  • mark the order as ticketed

  • store ticket numbers and airline PNRs

  • update traveler-facing itinerary details

  • trigger booking confirmation messaging if needed

Endpoint

POST to the webhook URL you registered with Atlas.

Fields to read first

  • type

  • data.orderNo

  • data.orderStatus

  • data.paxTicketInfos[].ticketNos

  • data.paxTicketInfos[].airlinePNRs

Typical payload

Notes

  • orderStatus=2 means ticketed

  • status is internal and should not drive business logic

  • use the order number and ticket numbers for downstream reconciliation

cid

  • Type: String

  • Required: Yes

  • Description: Unique client identifier for tracking requests.

  • Default: None

  • Example: "XXXXXXX"

data

  • Type: Object

  • Required: Yes

  • Description: Contains order-related information.

  • Default: None

  • Example:

data.orderNo

  • Type: String

  • Required: Yes

  • Description: Unique order number associated with the ticket purchase.

  • Default: None

  • Example: "TESTL20230922153224323"

data.orderStatus

  • Type: Integer

  • Required: Yes

  • Description: Status of the order.

  • Valid values:

    • 0: Unpaid

    • 1: Ticketing-in-Process

    • 2: Ticketed

    • -3: Cancelled(When the booking is failed due to the request information) Order number

  • Default: None

  • Example: 2

data.paxTicketInfos

  • Type: Array of Objects

  • Required: Yes

  • Description: Contains details of passengers and their associated ticket information.

  • Default: None

data.paxTicketInfos[]

  • Type: Object

  • Required: Yes

  • Description: Individual passenger ticket details.

  • Example:

data.paxTicketInfos[].name

  • Type: String

  • Required: Yes

  • Description: Passenger name in standard airline format (LastName/FirstName MiddleName).

  • Default: None

  • Example: "zhang/lisi"

data.paxTicketInfos[].passengerType

  • Type: Integer

  • Required: Yes

  • Description: Type of passenger.

    Valid values:

    • 0 = Adult

    • 1 = Child

    • 2 = Infant

  • Default: None

  • Example: 1

data.paxTicketInfos[].birthday

  • Type: String

  • Required: Yes

  • Description: Passenger's date of birth in YYYYMMDD format.

  • Default: None

  • Example: "20160202"

data.paxTicketInfos[].gender

  • Type: String

  • Required: Yes

  • Description: Passenger gender. Valid values:

    • M for Male

    • F for Female

  • Default: None

  • Example: "F"

data.paxTicketInfos[].cardNum

  • Type: String

  • Required: Yes

  • Description: Identification document number (passport or national ID).

  • Default: None

  • Example: "123458"

data.paxTicketInfos[].cardType

  • Type: String

  • Required: Yes

  • Description: Type of identification document.

  • Valid values:

    • PP - Passport

    • GA - Hong Kong Macau Pass for China mainland citizens

    • TW - Taiwan Pass for China mainland citizens

    • TB - China mainland pass for Taiwanese

    • HY - International Seaman's Certificate

  • Default: None

  • Example: "PP"

data.paxTicketInfos[].cardIssuePlace

  • Type: String

  • Required: Yes

  • Description: Country or authority that issued the identification document.

  • Default: None

  • Example: "CN"

data.paxTicketInfos[].cardExpired

  • Type: String

  • Required: Yes

  • Description: Expiry date of the identification document in YYYYMMDD format. Must be a valid date in the future.

  • Default: None

  • Example: "20400101"

data.paxTicketInfos[].nationality

  • Type: String

  • Required: Yes

  • Description: Passenger’s nationality using country codes (ISO 3166-1 alpha-2).

  • Default: None

  • Example: "CN"

data.paxTicketInfos[].ticketNos

  • Type: Array of Strings

  • Required: Yes

  • Description: List of issued ticket numbers associated with the passenger.

  • Default: None

  • Example: ["S30814"]

data.paxTicketInfos[].airlinePNRs

  • Type: Array of Strings

  • Required: Yes

  • Description: List of Passenger Name Record (PNR) codes.

  • Default: None

  • Example: ["S30814"]

data.paxTicketInfos[].ancillaries

  • Type: Array

  • Required: Yes

  • Description: List of ancillary services associated with the passenger (e.g., extra baggage, seat selection).

  • Default: []

  • Example: []

status

  • Type: Integer

  • Required: Yes

  • Description: Indicates the response status.

  • Default: None

  • Example: -1

type

  • Type: String

  • Required: Yes

  • Description: Specifies the type of response message.

  • Default: None

  • Example: "order.ticketed"

Last updated

Was this helpful?