- Guides
- API Reference
- Air ticket booking APIs
- Ancillary booking APIs
- Flight schedule change APIs
- Refund APIs
- Change APIs
- Void APIs
- Cache APIs
- APIs with all versions
- CheckInInfoPush
- Raise change requests Copy
- Shopping
- PrecisePricing
- Penalty
- PreciseBooking
- OrderPricing
- Ticketing
- TicketNumPush
- CancelOrder
- OrderDetail
- AncillaryPricing
- AncillaryBooking
- CancelAncillaryOrder
- AncillaryTicketing
- AncillaryStatusPush
- AncillaryOrderDetail
- RequestTicketing
- ScheduleChangeNotify
- GetScheduleChangeList
- AcknowledgeScheduleChange
- AcceptScheduleChange
- GetScheduleChangeReply
- RefundPricing
- CheckRefundPricing
- RefundRequest
- RefundResultNotify
- CheckRefund
- ReimbursedResultNotify
- CheckReimbursed
- UploadAttachmentFile
- DownloadAttachmentFile
- ChangeReshop
- ChangeRequest
- ChangePassengerInfo
- VoidRequest
- ReimbursedResultPush
- Development Instructions
- Notice
- Schemas
CacheShopping
POST
/airline-data/cacheShopping
Function#
Versioning#
| Version | Sandbox Invoking Address | Update |
|---|---|---|
| Shopping | http://data-cache-api-test.pkfare.com/airline-data/cacheShopping |
Error Code List#
| erroCode | erroMsg | Description |
|---|---|---|
| 0 | ok | Request has been processed successfully. |
| S001 | System error. | System error. |
| B002 | Partner is not exists. | PartnerID does not exist. |
| B003 | Illegal sign. | Illegal sign. Please check your signature. |
| P001 | XXX is illegal. | The field of XXX is illegal. |
| P002 | XXX is missing. | The field of XXX is missing. |
| P004 | The maximum number of passengers with seat is 9. | Wrong parameter. The maximum number of passengers with seat is 9. |
| P005 | There should be at least one adult. | Wrong parameter. There should be at least one adult. |
| P009 | The number of infant passengers can not exceed the number of adult passengers. | Wrong parameter. The number of infant passengers can not exceed the number of adult passengers. |
| B013 | Interface is limited, please contact the system administrator. | The route that you request is limited, please contact system administrator. |
| B014 | Shopping failed. | Shopping failed caused by other reasons. |
| B024 | Time-out, please try later. | Time-out. You can try the second searching after a few seconds. |
| B034 | Shopping interface is offline. | Shopping service is limited. |
| B035 | Concurrency limited. Please contact PKFARE API support team for assistant. | Concurrent users control. Please contact PKFARE API support for assistant. |
| B038 | Departure date must be today to a year. | Wrong parameter. Departure date must be today to a year. |
| B039 | Can't find the related data of XXX. | Wrong parameter. Can't find the related data of XXX, like illegal city/country/area/airline. |
| B046 | Interface is limited, the routing is offlined by PKFARE. | Look to book control. If you need this routing, please contact PKFARE API for assistant. |
| B059 | Shopping failed from upstream. | Shopping failed, shopping error from upstream. Please contact PKFARE API support. |
| B060 | Interface is limited, please contact PKFARE. | Interface is limited, due to restriction rules, please contact PKFARE API support. |
| B009 | Supplier is offline | Supplier is not at working time, please contact PKFARE API support. |
| B066 | Only 2 journeys can be supported, please check your itinerary. | System support maximum 2 journeys shopping at this moment. |
Request
Body Params application/json
Example
{
"authentication": {
"partnerId": "string",
"sign": "string"
},
"search": {
"airline": "FR",
"cabinClass": "economy",
"journeys": [
{
"origin": "DUB",
"destination": "MIL",
"departureDate": "2024-10-26"
}
],
"maxConnections": 0,
"passengers": {
"adults": 1,
"teens": 0,
"children": 0,
"infants": 0
},
"solutions": 0
}
}Request Code Samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.pkfare.com/airline-data/cacheShopping' \
--header 'Content-Type: application/json' \
--data '{
"authentication": {
"partnerId": "string",
"sign": "string"
},
"search": {
"airline": "FR",
"cabinClass": "economy",
"journeys": [
{
"origin": "DUB",
"destination": "MIL",
"departureDate": "2024-10-26"
}
],
"maxConnections": 0,
"passengers": {
"adults": 1,
"teens": 0,
"children": 0,
"infants": 0
},
"solutions": 0
}
}'Responses
🟢200Success
application/json
Bodyapplication/json
Example
{
"data": {
"searchKey": "DUBMIL20241026Y1000",
"segments": [
{
"segmentIndex": 1,
"airline": "FR",
"flightNum": "4038",
"equipment": "7M8",
"departure": "DUB",
"departureDate": "2024-10-26",
"departureTime": "12:25",
"departureTerminal": "1",
"arrival": "BGY",
"arrivalDate": "2024-10-26",
"arrivalTime": "15:55",
"arrivalTerminal": "1",
"flightTime": 150,
"codeShare": "Y",
"opFltAirline": "KM",
"opFltNo": null,
"stopover": null,
"stayTime": null
},
{
"segmentIndex": 2,
"airline": "FR",
"flightNum": "4844",
"equipment": "73H",
"departure": "DUB",
"departureDate": "2024-10-26",
"departureTime": "16:30",
"departureTerminal": "1",
"arrival": "BGY",
"arrivalDate": "2024-10-26",
"arrivalTime": "20:00",
"arrivalTerminal": "1",
"flightTime": 150,
"codeShare": "N",
"opFltAirline": null,
"opFltNo": null,
"stopover": null,
"stayTime": null
},
{
"segmentIndex": 3,
"airline": "FR",
"flightNum": "1454",
"equipment": "7S8",
"departure": "DUB",
"departureDate": "2024-10-26",
"departureTime": "18:30",
"departureTerminal": "1",
"arrival": "MXP",
"arrivalDate": "2024-10-26",
"arrivalTime": "22:10",
"arrivalTerminal": "1",
"flightTime": 160,
"codeShare": "N",
"opFltAirline": null,
"opFltNo": null,
"stopover": null,
"stayTime": null
}
],
"solutions": [
{
"solutionKey": "1q2w3e4r",
"fareType": "PUBPISH",
"fareName": "BASIC",
"currency": "EUR",
"adultFare": 83.09,
"adultTax": 30,
"adultTotalPerPerson": 113.09,
"teenFare": 0,
"teenTax": 0,
"teenTotalPerPerson": 0,
"childFare": 0,
"childTax": 0,
"childTotalPerPerson": 0,
"infantFare": 0,
"infantTax": 0,
"infantTotalPerPerson": 0,
"platingCarrier": "FR",
"baggages": {},
"conditions": {
"seatSelection": false,
"priorityBoarding": false,
"other": [],
"change": {
"allowed": false,
"description": "",
"penaltyAmount": 0,
"penaltyCurrency": ""
},
"refund": {
"allowed": false,
"description": "",
"penaltyAmount": 0,
"penaltyCurrency": ""
}
},
"journeys": [
{
"segments": [
{
"segmentIndex": 1,
"cabinClass": "economy",
"bookingCode": "Y",
"availabilityCount": 9,
"fareBasis": ""
}
]
}
]
},
{
"solutionKey": "2w3e4r5t",
"fareType": "PUBPISH",
"fareName": "REGULAR",
"currency": "EUR",
"adultFare": 113.09,
"adultTax": 30,
"adultTotalPerPerson": 143.09,
"teenFare": 0,
"teenTax": 0,
"teenTotalPerPerson": 0,
"childFare": 0,
"childTax": 0,
"childTotalPerPerson": 0,
"infantFare": 0,
"infantTax": 0,
"infantTotalPerPerson": 0,
"platingCarrier": "FR",
"baggages": {
"adt": {
"segmentIndex": 1,
"type": "carryon",
"amount": 1,
"weight": 10,
"size": "55 x 40 x 20 cm"
}
},
"conditions": {
"seatSelection": true,
"priorityBoarding": true,
"other": [],
"change": {
"allowed": false,
"description": "",
"penaltyAmount": 0,
"penaltyCurrency": ""
},
"refund": {
"allowed": false,
"description": "",
"penaltyAmount": 0,
"penaltyCurrency": ""
}
},
"journeys": [
{
"segments": [
{
"segmentIndex": 1,
"cabinClass": "economy",
"bookingCode": "Y",
"availabilityCount": 9,
"fareBasis": ""
}
]
}
]
},
{
"solutionKey": "3e4r5t6y",
"fareType": "PUBPISH",
"fareName": "PLUS",
"currency": "EUR",
"adultFare": 118.09,
"adultTax": 30,
"adultTotalPerPerson": 148.09,
"teenFare": 0,
"teenTax": 0,
"teenTotalPerPerson": 0,
"childFare": 0,
"childTax": 0,
"childTotalPerPerson": 0,
"infantFare": 0,
"infantTax": 0,
"infantTotalPerPerson": 0,
"platingCarrier": "FR",
"baggages": {
"adt": {
"segmentIndex": 1,
"type": "checked",
"amount": 1,
"weight": 20,
"size": ""
}
},
"conditions": {
"seatSelection": true,
"priorityBoarding": false,
"other": [
{
"serviceName": "Free check-in at the airport",
"available": true,
"description": "Up to 40 minutes before flying"
}
],
"change": {
"allowed": false,
"description": "",
"penaltyAmount": 0,
"penaltyCurrency": ""
},
"refund": {
"allowed": false,
"description": "",
"penaltyAmount": 0,
"penaltyCurrency": ""
}
},
"journeys": [
{
"segments": [
{
"segmentIndex": 1,
"cabinClass": "economy",
"bookingCode": "Y",
"availabilityCount": 9,
"fareBasis": ""
}
]
}
]
},
{
"solutionKey": "4r5t6y7u",
"fareType": "PUBPISH",
"fareName": "FLEXI PLUS",
"currency": "EUR",
"adultFare": 183.09,
"adultTax": 30,
"adultTotalPerPerson": 213.09,
"teenFare": 0,
"teenTax": 0,
"teenTotalPerPerson": 0,
"childFare": 0,
"childTax": 0,
"childTotalPerPerson": 0,
"infantFare": 0,
"infantTax": 0,
"infantTotalPerPerson": 0,
"platingCarrier": "FR",
"baggages": {
"adt": {
"segmentIndex": 1,
"type": "carryon",
"amount": 1,
"weight": 10,
"size": "55 x 40 x 20 cm"
}
},
"conditions": {
"seatSelection": true,
"priorityBoarding": true,
"other": [
{
"serviceName": "Free check-in at the airport",
"available": true,
"description": "Up to 40 minutes before flying"
},
{
"serviceName": "Speed through security",
"available": true,
"description": "Beat the queues with Fast Track"
}
],
"change": {
"allowed": true,
"description": "https://www.ryanair.com/gb/en/useful-info/help-centre/fees",
"penaltyAmount": 0,
"penaltyCurrency": "EUR"
},
"refund": {
"allowed": false,
"description": "",
"penaltyAmount": 0,
"penaltyCurrency": ""
}
},
"journeys": [
{
"segments": [
{
"segmentIndex": 1,
"cabinClass": "economy",
"bookingCode": "Y",
"availabilityCount": 9,
"fareBasis": ""
}
]
}
]
},
{
"solutionKey": "5t6y7u8i",
"fareType": "PUBPISH",
"fareName": "BASIC",
"currency": "EUR",
"adultFare": 23.37,
"adultTax": 30,
"adultTotalPerPerson": 53.37,
"teenFare": 0,
"teenTax": 0,
"teenTotalPerPerson": 0,
"childFare": 0,
"childTax": 0,
"childTotalPerPerson": 0,
"infantFare": 0,
"infantTax": 0,
"infantTotalPerPerson": 0,
"platingCarrier": "FR",
"baggages": {},
"conditions": {
"seatSelection": false,
"priorityBoarding": false,
"other": [],
"change": {
"allowed": false,
"description": "",
"penaltyAmount": 0,
"penaltyCurrency": ""
},
"refund": {
"allowed": false,
"description": "",
"penaltyAmount": 0,
"penaltyCurrency": ""
}
},
"journeys": [
{
"segments": [
{
"segmentIndex": 2,
"cabinClass": "economy",
"bookingCode": "Y",
"availabilityCount": 5,
"fareBasis": ""
}
]
}
]
}
]
},
"errorCode": "0",
"errorMsg": "success"
}🟢201Created
🟠401Unauthorized
🟠403Forbidden
🟠404Not Found
Modified at 2025-04-18 08:05:08