1. AncillaryStatusPush
PKFARE Flight Buyer API
  • Guides
    • Quick Start
    • Tricks for Playing with PKFARE API
    • Book air tickets with ancillaries
    • Raise refund requests
    • Raise change requests
    • Receive flight rescheduled notification
    • Add Paid Bags after the Booking
    • Branded Fare Integration Guide
  • API Reference
    • Air ticket booking APIs
      • TicketIssuanceNotify_V2
      • Shopping V10
      • PrecisePricing V12
      • Penalty V4
      • PreciseBooking V8
      • CancelOrder
      • OrderPricing V6
      • Ticketing
      • OrderDetail V14
      • RequestTicketing
      • ModifyOrderStatus
    • Ancillary booking APIs
      • AncillaryStatusPush
      • AncillaryPricing V6
      • AncillaryBooking
      • CancelAncillaryOrder
      • AncillaryTicketing
      • AncillaryOrderDetail
    • Flight schedule change APIs
      • ScheduleChangeNotify
      • GetScheduleChangeReply
      • GetScheduleChangeList
      • AcknowledgeScheduleChange
      • AcceptScheduleChange
    • Refund APIs
      • RefundResultNotify
      • ReimbursedResultNotify
      • Refund Pricing
      • CheckRefundPricing
      • RefundRequest
      • CheckRefund
      • CheckReimbursed
      • DownloadAttachmentFile API
      • UploadAttachmentFile API
    • Change APIs
      • ChangeResultPush
      • Change Reshop
      • Change Request
      • Change Passenger Info
      • Change Reprice
      • ChangeRepricePush
    • Void APIs
      • ReimbursedResultPush
      • VoidRequest
    • Cache APIs
      • CacheShopping
      • ValidateItinerary API
    • APIs with all versions
      • CheckInInfoPush
      • Raise change requests Copy
      • Shopping
        • Shopping
        • Shopping_V2
        • Shopping_V4
        • Shopping V7
        • Shopping V9
        • Shopping V8
      • PrecisePricing
        • PrecisePricing
        • PrecisePricing_V2
        • PrecisePricing_V6
        • PrecisePricing V9
        • PrecisePricing V10
        • PrecisePricing V11
      • Penalty
        • Penalty
        • Penalty V2
        • Penalty V3
      • PreciseBooking
        • PreciseBooking
        • PreciseBooking_V2
        • PreciseBooking_V5
        • PreciseBooking V6
        • PreciseBooking V7
      • OrderPricing
        • OrderPricing_V2
        • OrderPricing V4
        • OrderPricing V5
      • Ticketing
        • Ticketing
      • TicketNumPush
        • TicketingNumPush
        • TicketingNumPush_V2
        • TicketingNumPush_V3
        • TicketIssuanceNotify
      • CancelOrder
        • CancelOrder
      • OrderDetail
        • OrderDetail_V2
        • OrderDetail_V3
        • OrderDetail_V4
        • OrderDetail_V5
        • Json_OrderDetail_V7
        • Json_OrderDetail_V8
        • OrderDetail V9
        • OrderDetail V13
      • AncillaryPricing
        • AncillaryPricing
        • AncillaryPricing V5
      • AncillaryBooking
        • AncillaryBooking
      • CancelAncillaryOrder
        • CancelAncillaryOrder
      • AncillaryTicketing
        • AncillaryTicketing_V2
      • AncillaryStatusPush
        • AncillaryStatusPush
      • AncillaryOrderDetail
        • AncillaryOrderDetail
      • RequestTicketing
        • RequestTicketing
      • ScheduleChangeNotify
        • ScheduleChangeNotify
      • GetScheduleChangeList
        • GetScheduleChangeList
      • AcknowledgeScheduleChange
        • AcknowledgeScheduleChange
      • AcceptScheduleChange
        • AcceptScheduleChange
      • GetScheduleChangeReply
        • GetScheduleChangeReply
      • RefundPricing
        • RefundPricing
      • CheckRefundPricing
        • CheckRefundPricing
      • RefundRequest
        • RefundRequest
      • RefundResultNotify
        • RefundResultNotify
      • CheckRefund
        • CheckRefund
      • ReimbursedResultNotify
        • ReimbursedResultNotify
      • CheckReimbursed
        • CheckReimbursed
      • UploadAttachmentFile
        • UploadAttachmentFile
      • DownloadAttachmentFile
        • DownloadAttachmentFile
      • ChangeReshop
        • ChangeReshop
      • ChangeRequest
        • ChangeRequest
      • ChangePassengerInfo
        • ChangePassengerInfo
      • VoidRequest
        • VoidRequest
        • VoidRequest_V2
      • ReimbursedResultPush
        • ReimburseResultPush_V2
  • Development Instructions
    • Signature
    • Order Status Explanation
    • Booking errors explanation and suggestions
    • Price Breakdown Explanation
    • Airlines available from PKFARE
    • PKFARE Operation Notice
    • How to retrieve airlines'PNR and ticket numbers
    • PKFARE Buyer API solutionId Usage Guide
  • Notice
    • Release Note
  • Schemas
    • Schemas
      • ShoppingReq
      • Result«ShoppingResult»
      • Authentication
      • SearchDTO
      • JourneysDTO_1
      • PassengersDTO
      • ShoppingResult
      • SegmentsDTO
      • SolutionsDTO
      • BaggageDTO
      • ConditionsDTO
      • ChangeDTO
      • OtherDTO
      • RefundDTO
      • JourneysDTO
      • SegmentInfoDTO
  1. AncillaryStatusPush

AncillaryStatusPush

1 Function#

You can be notified when the status of ancillary is updated as long as the URL has been provided.

2 Versioning#

VersionSandbox Invoking AddressUpdate
ancillaryStatusPushThis address is provided by the customer.Support postbooking paid baggage
Below is the most updated version

#

3 Charater Encoding#

The character code of this API is UTF-8.

#

4 Request#

The request is sent by PKFARE API. Requesting method would be POST.
|Name |Type |Parameter Description |Sample
|:--|
|Basic Parameter | | | |
|ancillaryOrderNum |string |PKFARE ancillary order number |917049521951368302
|buyerOrder |string |your order number if you want to store at PKFARE side, which is sent by ancillaryBooking request|
|status |string |the status of ancillary order, Fulfilled-success: Failed-failure |Fulfilled
|errorMsg |string |the failure reason |
|passengers |array |passenger detail |-|
|journeys |array |journey information |-|
|ancillaries |object |ancillary detail |-|
|Passengers | | | |
|lastName |string | last name |Zhong |
|firstName |string |first name |XiaoJun
|sex |string |gender;M-male,F-female |M|
|birthday |string |birthday |2003-03-23 |
|psgType |string |passenger type including ADT for adults, CHD for children |ADT |
|passengerID |string |unique identification of the passenger |-|
|Journeys | | |
|journeyID |string |unique identification of the journey |-|
|segments |array |segment detail |-|
|Segments | | | |
|airline |string |airline code |FD |
|departure |string |origin[IATA airport code] |DMK |
|departureDate |string |departure date[yyyy-MM-dd] |2022-10-01 |
|departureTime |string |departure time[hh:mm] |09:55 |
|arrival |string |destination[IATA airport code] |CNX |
|arrivalDate |string |arrival date[yyyy-MM-dd] |2022-10-01 |
|arrivalTime |string |arrival time[hh:mm] |11:25 |
|flightNum |string |flight number |513 |
|bookingCode |string |cabin code |N |
|segmentKey |string |unique identification of the segment |- |
|Ancillaries | | | |
|baggages |array |baggage detail |- |
|Baggages | | | |
|EMD |string |EMD number |-|
|payBaggageType |integer |baggage type; 1-checked baggage, 2-carry-on baggage
|baggagePiece |integer |baggage piece; -1 - no limit to baggage piece |-1|
|baggageWeight |string |baggage weight |20KG |
|description |string |baggage description |1PC x 25lb Cabin Bag |
|journeyID |string |unique identification of the journey |
|passengerID |string |unique identification of the passenger |

4.2 Example#

Request Sample
{
    "ancillaries": {
        "baggages": [
            {
                "baggagePiece": 1,
                "baggageWeight": "18KG",
                "description": "1PC x 40lb Checked Bag",
                "journeyId": "152254",
                "passengerId": "242475",
                "payBaggageType": 1
            },
            {
                "baggagePiece": 1,
                "baggageWeight": "11KG",
                "description": "1PC x 25lb Cabin Bag",
                "journeyId": "152253",
                "passengerId": "242475",
                "payBaggageType": 2
            },
            {
                "baggagePiece": 1,
                "baggageWeight": "18KG",
                "description": "1PC x 40lb Checked Bag",
                "journeyId": "152254",
                "passengerId": "242474",
                "payBaggageType": 1
            },
            {
                "baggagePiece": 1,
                "baggageWeight": "11KG",
                "description": "1PC x 25lb Cabin Bag",
                "journeyId": "152253",
                "passengerId": "242474",
                "payBaggageType": 2
            },
            {
                "baggagePiece": 1,
                "baggageWeight": "18KG",
                "description": "1PC x 40lb Checked Bag",
                "journeyId": "152254",
                "passengerId": "242473",
                "payBaggageType": 1
            },
            {
                "baggagePiece": 1,
                "baggageWeight": "11KG",
                "description": "1PC x 25lb Cabin Bag",
                "journeyId": "152253",
                "passengerId": "242473",
                "payBaggageType": 2
            }
        ]
    },
    "ancillaryOrderNum": "917049521951368302",
    "errorMsg": "The specified bag allowance is unavailable",
    "journeys": [
        {
            "journeyId": "152254",
            "segments": [
                {
                    "airline": "NK",
                    "arrival": "SAN",
                    "arrivalDate": "20240210",
                    "arrivalTime": "2311",
                    "bookingCode": "W",
                    "departure": "LAS",
                    "departureDate": "20240210",
                    "departureTime": "2153",
                    "flightNum": "1850",
                    "segmentKey": "176710"
                }
            ]
        },
        {
            "journeyId": "152253",
            "segments": [
                {
                    "airline": "NK",
                    "arrival": "LAS",
                    "arrivalDate": "20240126",
                    "arrivalTime": "2131",
                    "bookingCode": "U",
                    "departure": "SAN",
                    "departureDate": "20240126",
                    "departureTime": "2006",
                    "flightNum": "744",
                    "segmentKey": "176709"
                }
            ]
        }
    ],
    "passengers": [
        {
            "birthday": "20030323",
            "firstName": "XIAOJUN",
            "lastName": "ZHONG",
            "passengerId": "242473",
            "psgType": "ADT",
            "sex": "M"
        },
        {
            "birthday": "20030323",
            "firstName": "HARRIS",
            "lastName": "KAUFMAN",
            "passengerId": "242474",
            "psgType": "ADT",
            "sex": "M"
        },
        {
            "birthday": "20150323",
            "firstName": "YUE",
            "lastName": "HONG",
            "passengerId": "242475",
            "psgType": "CHD",
            "sex": "M"
        }
    ],
    "status": "Failed"
}

5 Response#

5.1 Schema#

NameTypeParameter DescriptionSample
errorCodeStringerror code0
errorMsgStringerror messageok

5.2 Example#

1.
Success Response
{"errorCode":0,"errorMsg":"ok"}
Modified at 2024-05-06 01:58:52
Previous
AncillaryTicketing_V2
Next
AncillaryOrderDetail