OrderDetail V13

Function

Through OrderDetail_V9 API, users can check order details including all journey details, ancillary bookings, order status, Airline's PNR schedule change history.

Besides, users could check more detailed schedule change acceptance status regarding a specific flight change.

Through orderDetail_V12 API, the information of the origional order and all associated post-booking service orders will be displayed in the response. Except for the original order and the current queried order types, only basic informations are returned for other orders.

Versioning

Version	Sandbox Invoking Address	Update
OrderDetail	https://api.pkfare.com/orderDetail/v2?param=reqParam
OrderDetail_V3	https://api.pkfare.com/orderDetail/v3?param=reqParam	Paid baggage information is available in order details.
OrderDetail_V4	https://api.pkfare.com/orderDetail/v4?param=reqParam
OrderDetail_V5	https://api.pkfare.com/orderDetail/v5?param=reqParam	Schedule change information is available in order details.
OrderDetail_V6	https://api.pkfare.com/orderDetail/v6?param=reqParam	Infant ticket info is available in order details. Ticket voidable info and reject info for change orders is provided. ScheduleChange is optional in includeFields.
OrderDetail_V7	https://api.pkfare.com/orderDetail/v7?param=reqParam	seat information is available in order details; Checkin information is available as well
OrderDetail_V7 (json format)	https://api.pkfare.com/json/orderDetail/v7	seat information is available in order details; Checkin information is available as well; Support json-formatted requesting structure
OrderDetail_V8 (json format)	https://api.pkfare.com/json/orderDetail/v8	Includes more details (message ID and acceptance status) for schedule change history information
OrderDetail_V9 (json format)	https://api.pkfare.com/json/orderDetail/v9	Includes more details for passengers' associated seat information per flight
OrderDetail_V10 (json format)	https://api.pkfare.com/json/orderDetail/v10	Includes more details for different product tags, including PKFARE-defined special product types and airline-standard branded fares, etc.
OrderDetail_V12 (json format)	https://api.pkfare.com/json/orderDetail/v12	Includes function to check information of both the parent order and associated post-booking service orders (void, change, refund)
OrderDetail_V13 (json format)	https://api.pkfare.com/json/orderDetail/v13	When orderStatus is CHG_RQ, UNDER_REVIEW, CNCL, CHG_REJ, REFD_REJ, VOID_REJ, the price realted fields will not be returned.

Order Status List

Order Status List
Enum	Description
ISS_PRC	Ticket is issuing.
CHG_PRC	Change order is proceeding.
REFD_PRC	Refund order is proceeding.
VOID_PRC	Ticket is voiding.
TO_BE_PAID	To be Paid.
ISSED	Ticket issued.
TO_BE_RSV	To be reserved.
UNDER_REVIEW	Under review.
HOLD	Order is holding manually, please contact customer service for further action.
RSV_FAIL	Reservation failed
CLOSED	Order closed.
CNCL	Order Cancelled.
CNCL_TO_BE_REIM	Order Cancelled, and reimbursement is under processing.
CNCL_REIMED	Order Cancelled, and payment has been reimbused.
CHG_RQ	Change Order is requested.
CHG_TO_BE_PAID	Change Order is to be paid.
CHG_REJ	Change Order is rejected.
CHGD	Change Order is changed.
REDF_RQ	Refund Order is under review.
REFD_REJ	Refund Order is rejected.
REFD_TO_BE_REIM	Refunded to be reimbursed.
REFD_REIMED	Refunded and reimbursed.
REFD	Refunded
VOID_REJ	Void request is rejected.
VOID_TO_BE_REIM	Void to be reimbursed.
VOID_REIMED	Void and reimbursed
VOID	Void

Error Code List

erroCode	erroMsg	Description
0	ok	Request has been processed successfully.
S001	System error	System error
S002	timeout	Request timeout
P001	-	Parameter is illegal
B002	Partner is not exists.	PartnerID does not exist
B003	Illegal sign	Illegal sign. Please check your signature
B048	Invalid buyer	Request buyer is not matched with order.
B037	Order is not exists.	Order is not exist.

application/json

Bodyapplication/json

Examples

Response including allResponse including Infant Passenger Journey and ScheduleChangeResponse including Passenger Schedulechange and AncillaryResponse with Passenger Solutions and Ancillary including baggage and seatResponse including passenger's seat informationResponse With Fare FamilyMultiple PNRs - Single Passenger Round TripResponse of orderDetail_V12 - request original orderResponse of orderDetail_V12 - request post-booking service order

{
    "errorCode": "0",
    "errorMsg": "ok",
    "data": {
        "orderStatus": "ISSED",
        "orderNum": "917070354395357001",
        "refOrderNum": "9170703543953570",
        "extOrderNum": "123456789",
        "orderType": "O",
        "createdTime": "2024-02-04 16:30:40",
        "postingDate": "2024-02-04 16:31:13",
        "pnr": "6y6d34",
        "airPnr": "C3pyn0",
        "platingCarrier": "VJ",
        "payGate": "Prepay",
        "paySerialNum": "PREPAY_20240204163055_917070354395357001_2477",
        "passengers": [
            {
                "firstName": "SHASHA",
                "lastName": "XIA",
                "psgType": "ADT",
                "nationality": "CN",
                "sex": "M",
                "birthday": "2003-03-23",
                "cardType": "P",
                "cardNum": "E11887134",
                "cardExpiredDate": "2027-03-31",
                "ticketNum": "C3pyn0",
                "passengerIndex": 1,
                "seats": [
                    {
                        "airline": "VJ",
                        "flightNum": "813",
                        "seatNum": "30C"
                    }
                ]
            }
        ],
        "journeys": [
            {
                "journeyTime": 145,
                "transferCount": 0,
                "segments": [
                    {
                        "airline": "VJ",
                        "flightNum": "813",
                        "equipment": "321",
                        "cabinClass": "ECONOMY",
                        "bookingCode": "T",
                        "departure": "SGN",
                        "arrival": "SIN",
                        "departureTerminal": "2",
                        "arrivalTerminal": "4",
                        "departureDate": "2024-03-04",
                        "arrivalDate": "2024-03-04",
                        "departureTime": "06:50",
                        "arrivalTime": "10:15",
                        "flightTime": 145,
                        "codeShare": "N"
                    }
                ],
                "departureTime": "06:50",
                "arrivalTime": "10:15",
                "departureDate": "2024-03-04",
                "arrivalDate": "2024-03-04"
            }
        ],
        "solutions": [
            {
                "currency": "CNY",
                "adtFare": 1574,
                "adtTax": 291,
                "tktFee": 0,
                "merchantFee": 0,
                "distCost": 0,
                "coupon": 0,
                "buyerAmount": 1865
            }
        ],
        "lastTktTime": "2024-02-04 18:30:00",
        "ancillaryItems": [
            {
                "itemNumber": "917070354395357002",
                "itemStatus": "ISSED",
                "createdTime": "2024-02-04 16:30:40",
                "saleStage": 0,
                "ancillaryType": 1,
                "ancillaryInfo": [
                    {
                        "baggage": {
                            "lastName": "XIA",
                            "firstName": "SHASHA",
                            "psgType": "ADT",
                            "ancillaryType": 1,
                            "payBaggageType": 2,
                            "baggagePiece": 1,
                            "baggageWeight": "30KG",
                            "baggageCurrency": "CNY",
                            "baggagePrice": 40,
                            "segments": [
                                {
                                    "airline": "VJ",
                                    "departure": "SGN",
                                    "departureDate": "2024-03-04",
                                    "departureTime": "06:50",
                                    "arrival": "SIN",
                                    "arrivalDate": "2024-03-04",
                                    "arrivalTime": "10:15",
                                    "flightNum": "813",
                                    "bookingCode": "T",
                                    "cabinClassType": 3
                                }
                            ]
                        }
                    }
                ]
            },
            {
                "itemNumber": "917070354395357004",
                "itemStatus": "ISSED",
                "createdTime": "2024-02-04 16:31:18",
                "saleStage": 1,
                "ancillaryType": 1,
                "ancillaryInfo": [
                    {
                        "baggage": {
                            "lastName": "XIA",
                            "firstName": "SHASHA",
                            "psgType": "ADT",
                            "ancillaryType": 1,
                            "payBaggageType": 1,
                            "baggagePiece": 1,
                            "baggageWeight": "10KG",
                            "baggageCurrency": "CNY",
                            "baggagePrice": 20,
                            "segments": [
                                {
                                    "airline": "VJ",
                                    "departure": "SGN",
                                    "departureDate": "2024-03-04",
                                    "departureTime": "06:50",
                                    "arrival": "SIN",
                                    "arrivalDate": "2024-03-04",
                                    "arrivalTime": "10:15",
                                    "flightNum": "813",
                                    "bookingCode": "T",
                                    "cabinClassType": 3
                                }
                            ]
                        }
                    }
                ]
            },
            {
                "itemNumber": "917070354395357003",
                "itemStatus": "ISSED",
                "createdTime": "2024-02-04 16:30:40",
                "saleStage": 0,
                "ancillaryType": 2,
                "ancillaryInfo": [
                    {
                        "seat": {
                            "lastName": "XIA",
                            "firstName": "SHASHA",
                            "psgType": "ADT",
                            "seatName": "5A",
                            "column": "A",
                            "row": "5",
                            "seatCurrency": "CNY",
                            "seatPrice": "81.00",
                            "characteristics": [
                                "window"
                            ],
                            "segment": {
                                "airline": "VJ",
                                "departure": "SGN",
                                "departureDate": "2024-03-04",
                                "departureTime": "06:50",
                                "arrival": "SIN",
                                "arrivalDate": "2024-03-04",
                                "arrivalTime": "10:15",
                                "flightNum": "813",
                                "bookingCode": "T",
                                "cabinClassType": 3
                            }
                        }
                    }
                ]
            }
        ],
        "pnrList": [
            {
                "segmentNo": 1,
                "departure": "SGN",
                "arrival": "SIN",
                "flightNum": "813",
                "pnr": "6y6d34",
                "airPnr": "C3pyn0",
                "cabinClass": "ECONOMY",
                "bookingCode": "T",
                "ticketNums": [
                    {
                        "ticketNum": "C3pyn0",
                        "passengerIndex": 1
                    }
                ]
            }
        ],
        "scheduleChangeList": [
            {
                "scheduleChangeVersion": "1",
                "journeys": [
                    {
                        "journeyTime": 205,
                        "transferCount": 0,
                        "segments": [
                            {
                                "airline": "VJ",
                                "flightNum": "813",
                                "equipment": "321",
                                "cabinClass": "ECONOMY",
                                "bookingCode": "T",
                                "departure": "SGN",
                                "arrival": "SIN",
                                "departureTerminal": "2",
                                "arrivalTerminal": "4",
                                "departureDate": "2024-03-04",
                                "arrivalDate": "2024-03-04",
                                "departureTime": "06:50",
                                "arrivalTime": "10:15",
                                "flightTime": 205
                            }
                        ],
                        "departureTime": "06:50",
                        "arrivalTime": "10:15",
                        "departureDate": "2024-03-04",
                        "arrivalDate": "2024-03-04"
                    }
                ]
            },
            {
                "scheduleChangeVersion": "2",
                "journeys": [
                    {
                        "journeyTime": 200,
                        "transferCount": 0,
                        "segments": [
                            {
                                "airline": "VJ",
                                "flightNum": "813",
                                "cabinClass": "Y",
                                "bookingCode": "Y",
                                "departure": "SGN",
                                "arrival": "SIN",
                                "departureTerminal": "",
                                "arrivalTerminal": "",
                                "departureDate": "2024-03-04",
                                "arrivalDate": "2024-03-04",
                                "departureTime": "06:55",
                                "arrivalTime": "10:15",
                                "flightTime": 200,
                                "codeShare": "N"
                            }
                        ],
                        "departureTime": "06:55",
                        "arrivalTime": "10:15",
                        "departureDate": "2024-03-04",
                        "arrivalDate": "2024-03-04"
                    }
                ],
                "messageId": "4431377",
                "passengers": [
                    {
                        "lastName": "XIA",
                        "firstName": "SHASHA",
                        "acceptStatus": "ACCEPTED"
                    }
                ]
            }
        ],
        "permitVoid": 0,
        "checkInInfos": [
            {
                "firstName": "SHASHA",
                "lastName": "XIA",
                "ticketNum": "C3pyn0",
                "pnr": "C3pyn0",
                "airPnr": "C3pyn0",
                "airline": "VJ",
                "mailAccount": "aaaaaa",
                "airlineWebsite": "https://www.spirit.com/home-check-in"
            }
        ]
    }
}

Function

Versioning

Order Status List

Error Code List

Request

Request Code Samples

Responses

OrderDetail V13

Function#

Versioning#

Order Status List#

Error Code List#

Request

Request Code Samples

Responses

Function

Versioning

Order Status List

Error Code List