retrieve-booking

متد GetHistory

با استفاده از این متد می توان کلیه اطلاعات مربوط به یک رزرو را دریافت نمود

این اطلاعات شامل آخرین وضعیت رزرو، رزرو اولیه و تاریخچه اتفاقات – مثلا سگمنت های کنسل شده یا تغییر اطلاعات میهمانان- را شامل می گردد.

زمان (تاریخ و ساعت) هایی که در این وب سرویس خروجی داده میشود – مثلا فیلد BookingDateTime – بر اساس ناحیه زمانی UTC می باشد و در صورت نیاز باید آنها را به زمان ایران تبدیل نمایید.

API Endpoint

POST https://{SupplierWebsiteUrl}/api/Partners/Hotel/RetrieveBooking/V1/GetHistory

Request Parameters

Username

string

required

نام کاربری
Password

string

required

رمز عبور به صورت MD5 شده
Pnr

string

required

رفرنس سیستم سپهر که بعد از فراخوانی متد Book دریافت نموده اید

Sample Request

curl -X POST https://SepehrApiTest.ir/api/Partners/Hotel/RetrieveBooking/V1/GetHistory \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "Accept: application/json" \
  -H "Accept-Encoding: gzip, deflate" \
  -d '{
    "Username": "testdev1",
    "Password": "25f9e794323b453885f5181f1b624d0b",
    "Pnr": "ES566K"
}'

Response Parameters

LastState

complex type

اطلاعات مربوط به آخرین وضعیت رزرو

مستندات این بخش در آینده تکمیل می گردد.
History_InitialBooking

complex type

اطلاعات مربوط به رزرو اولیه

مستندات این بخش در آینده تکمیل می گردد.
History_Cancelation

complex type

تاریخچه مربوط به سگمنت های کنسل شده

مستندات این بخش در آینده تکمیل می گردد.
History_PassengerInfoChanged

complex type

تاریخچه مربوط به تغییرات اسامی و اطلاعات شخصی مسافران

مستندات این بخش در آینده تکمیل می گردد.
History_TransferChanged

complex type

تاریخچه مربوط به تغییرات ترانسفر هتل

مستندات این بخش در آینده تکمیل می گردد.

Sample Response

{
  "LastState": {
    "RoomList": [
      {
        "HotelGlobalId": 1136,
        "HotelName": "سارينا",
        "RoomTypeGlobalId": 8572,
        "RoomTypeName": "يک تخته",
        "BoardTypeCode": "RO",
        "ExtrabedsCount": 1,
        "CheckinDate": "2026-06-28",
        "CheckoutDate": "2026-07-01",
        "PassengerList": [
          {
            "Id": "138280c7-268d-493f-86b5-ddab142c39e6",
            "FirstName": "SEYED MOHAMMAD AMIN",
            "LastName": "TARI MORADI",
            "AgeType": "ADL",
            "Gender": "M",
            "Birthdate": "1996-06-27",
            "NationalityCountry": "IR",
            "IranianCartMelli": {
              "CodeMelli": "0012409235"
            },
            "Passport": null
          },
          {
            "Id": "94d3a98d-ab64-4441-ad9f-d013b4fe5c67",
            "FirstName": "HASSSAN",
            "LastName": "HOSSEYNI",
            "AgeType": "ADL",
            "Gender": "M",
            "Birthdate": "1996-06-27",
            "NationalityCountry": "IR",
            "IranianCartMelli": {
              "CodeMelli": "0012015563"
            },
            "Passport": null
          }
        ],
        "RoomPriceList": [
          {
            "StayDate": "2026-06-28",
            "Room_CommissionPercent": 0,
            "Room_VAT_Tax_Percent": 0,
            "Room_VAT_Levy_Percent": 0,
            "Room_BoardPrice": 200000.00,
            "Room_CalculatedAmountOfCommissionPercent": 0.00,
            "Room_Discount": 0.00,
            "Room_Surcharge": 0.00,
            "Room_NetPrice_TaxExcluded": 200000.00,
            "Room_VAT_Tax_CalculatedAmountOfPercent": 0.00,
            "Room_VAT_Levy_CalculatedAmountOfPercent": 0.00,
            "Room_NetPrice_TaxIncluded": 200000.00,
            "Extrabed_CommissionPercent": 0,
            "Extrabed_VAT_Tax_Percent": 0,
            "Extrabed_VAT_Levy_Percent": 0,
            "Extrabed_BoardPrice": 1000.00,
            "Extrabed_CalculatedAmountOfCommissionPercent": 0.00,
            "Extrabed_Discount": 0.00,
            "Extrabed_Surcharge": 0.00,
            "Extrabed_NetPrice_TaxExcluded": 1000.00,
            "Extrabed_VAT_Tax_CalculatedAmountOfPercent": 0.00,
            "Extrabed_VAT_Levy_CalculatedAmountOfPercent": 0.00,
            "Extrabed_NetPrice_TaxIncluded": 1000.00
          }
          // ... بیشتر تاریخ‌های اقامت
        ]
      }
    ],
    "TransferList": [
      {
        "HotelGlobalId": 1136,
        "HotelName": "سارينا",
        "IncomingTransferType": "Flight",
        "IncomingFlightNumber": "7057",
        "IncomingFlightArrivalTime": "12:30",
        "IncomingFlightOriginCity": "تهران",
        "IncomingFlightAirlineName": "کیش ایر",
        "IncomingTrainNumber": null,
        "IncomingTrainArrivalTime": null,
        "IncomingTrainOriginCity": null,
        "IncomingTrainCarrierName": null,
        "IncomingBusArrivalTime": null,
        "IncomingBusOriginCity": null,
        "IncomingBusCarrierName": null,
        "IncomingBusArrivalTerminal": null,
        "IncomingPrivateVehicle": null,
        "OutgoingTransferType": "Flight",
        "OutgoingFlightNumber": "2323",
        "OutgoingFlightTime": "15:45",
        "OutgoingTrainNumber": null,
        "OutgoingTrainTime": null,
        "OutgoingBusTime": null,
        "OutgoingBusDepartureTerminal": null,
        "OutgoingPrivateVehicle": null
      }
    ]
  },
  "History_InitialBooking": {
    "BookingDateTime": "2026-06-27 14:25:54",
    "Phone": "+989352283333",
    "Email": "your-email-address@your-domain.com",
    "Remarks": "",
    "HotelSegmentList": [
      {
        "HotelGlobalId": 1136,
        "HotelName": "سارينا",
        "CheckinDate": "2026-06-28",
        "CheckoutDate": "2026-07-01",
        "RoomList": [
          {
            "RoomTypeGlobalId": 8572,
            "RoomTypeName": "يک تخته",
            "BoardTypeCode": "RO",
            "ExtrabedsCount": 1,
            "PassengerList": [
              {
                "Id": "138280c7-268d-493f-86b5-ddab142c39e6",
                "FirstName": "SEYED MOHAMMAD AMIN",
                "LastName": "TARI MORADI",
                "AgeType": "ADL",
                "Gender": "M",
                "Birthdate": "1996-06-27",
                "NationalityCountry": null,
                "IranianCartMelli": {
                  "CodeMelli": "0012409235"
                },
                "Passport": null
              },
              {
                "Id": "94d3a98d-ab64-4441-ad9f-d013b4fe5c67",
                "FirstName": "ABED",
                "LastName": "HOSSEYNI",
                "AgeType": "ADL",
                "Gender": "M",
                "Birthdate": "1996-06-27",
                "NationalityCountry": null,
                "IranianCartMelli": {
                  "CodeMelli": "0012015563"
                },
                "Passport": null
              }
            ],
            "RoomPriceList": [
              {
                "StayDate": "2026-06-28",
                "Room_CommissionPercent": 0,
                "Room_VAT_Tax_Percent": 0,
                "Room_VAT_Levy_Percent": 0,
                "Room_BoardPrice": 200000.00,
                "Room_CalculatedAmountOfCommissionPercent": 0.00,
                "Room_Discount": 0.00,
                "Room_Surcharge": 0.00,
                "Room_NetPrice_TaxExcluded": 200000.00,
                "Room_VAT_Tax_CalculatedAmountOfPercent": 0.00,
                "Room_VAT_Levy_CalculatedAmountOfPercent": 0.00,
                "Room_NetPrice_TaxIncluded": 200000.00,
                "Extrabed_CommissionPercent": 0,
                "Extrabed_VAT_Tax_Percent": 0,
                "Extrabed_VAT_Levy_Percent": 0,
                "Extrabed_BoardPrice": 1000.00,
                "Extrabed_CalculatedAmountOfCommissionPercent": 0.00,
                "Extrabed_Discount": 0.00,
                "Extrabed_Surcharge": 0.00,
                "Extrabed_NetPrice_TaxExcluded": 1000.00,
                "Extrabed_VAT_Tax_CalculatedAmountOfPercent": 0.00,
                "Extrabed_VAT_Levy_CalculatedAmountOfPercent": 0.00,
                "Extrabed_NetPrice_TaxIncluded": 1000.00
              }
              // ... بیشتر تاریخ‌های اقامت
            ]
          }
        ]
      }
    ]
  },
  "History_Cancelation": {
    "HistoryList": []
  },
  "History_PassengerInfoChanged": {
    "HistoryList": [
      {
        "HistoryTimestamp": "2026-06-27 14:27:05",
        "PassengerList": [
          {
            "Id": "138280c7-268d-493f-86b5-ddab142c39e6",
            "AgeTypeCode": "ADL",
            "OldInfo": {
              "FirstName": "SEYED MOHAMMAD AMIN",
              "LastName": "TARI MORADI",
              "Gender": "M",
              "Birthdate": "1996-06-27",
              "NationalityCountry": "IR",
              "IranianCartMelli": {
                "CodeMelli": "0012409235"
              },
              "Passport": null
            },
            "NewInfo": {
              "FirstName": "SEYED MOHAMMAD AMIN",
              "LastName": "TARI MORADI",
              "Gender": "M",
              "Birthdate": "1996-06-27",
              "NationalityCountry": "IR",
              "IranianCartMelli": {
                "CodeMelli": "0012409235"
              },
              "Passport": null
            },
            "PenaltyList": [
              {
                "HotelName": "سارينا",
                "PenaltyAmount": 500000.00,
                "DiscountAmount": 0.00
              }
            ]
          },
          {
            "Id": "94d3a98d-ab64-4441-ad9f-d013b4fe5c67",
            "AgeTypeCode": "ADL",
            "OldInfo": {
              "FirstName": "ABED",
              "LastName": "HOSSEYNI",
              "Gender": "M",
              "Birthdate": "1996-06-27",
              "NationalityCountry": "IR",
              "IranianCartMelli": {
                "CodeMelli": "0012015563"
              },
              "Passport": null
            },
            "NewInfo": {
              "FirstName": "HASSSAN",
              "LastName": "HOSSEYNI",
              "Gender": "M",
              "Birthdate": "1996-06-27",
              "NationalityCountry": "IR",
              "IranianCartMelli": {
                "CodeMelli": "0012015563"
              },
              "Passport": null
            },
            "PenaltyList": [
              {
                "HotelName": "سارينا",
                "PenaltyAmount": 0.00,
                "DiscountAmount": 0.00
              }
            ]
          }
        ]
      }
    ]
  },
  "History_TransferChanged": {
    "HistoryList": [
      {
        "HistoryTimestamp": "2026-06-27 14:26:29",
        "HotelGlobalId": 1136,
        "HotelName": "سارينا",
        "OldData": {
          "IncomingTransferType": null,
          "IncomingFlightNumber": null,
          "IncomingFlightArrivalTime": null,
          "IncomingFlightOriginCity": null,
          "IncomingFlightAirlineName": null,
          "IncomingTrainNumber": null,
          "IncomingTrainArrivalTime": null,
          "IncomingTrainOriginCity": null,
          "IncomingTrainCarrierName": null,
          "IncomingBusArrivalTime": null,
          "IncomingBusOriginCity": null,
          "IncomingBusCarrierName": null,
          "IncomingBusArrivalTerminal": null,
          "IncomingPrivateVehicle": null,
          "OutgoingTransferType": null,
          "OutgoingFlightNumber": null,
          "OutgoingFlightTime": null,
          "OutgoingTrainNumber": null,
          "OutgoingTrainTime": null,
          "OutgoingBusTime": null,
          "OutgoingBusDepartureTerminal": null,
          "OutgoingPrivateVehicle": null
        },
        "NewData": {
          "IncomingTransferType": "Flight",
          "IncomingFlightNumber": "7057",
          "IncomingFlightArrivalTime": "12:30",
          "IncomingFlightOriginCity": "تهران",
          "IncomingFlightAirlineName": "کیش ایر",
          "IncomingTrainNumber": null,
          "IncomingTrainArrivalTime": null,
          "IncomingTrainOriginCity": null,
          "IncomingTrainCarrierName": null,
          "IncomingBusArrivalTime": null,
          "IncomingBusOriginCity": null,
          "IncomingBusCarrierName": null,
          "IncomingBusArrivalTerminal": null,
          "IncomingPrivateVehicle": null,
          "OutgoingTransferType": "Flight",
          "OutgoingFlightNumber": "2323",
          "OutgoingFlightTime": "15:45",
          "OutgoingTrainNumber": null,
          "OutgoingTrainTime": null,
          "OutgoingBusTime": null,
          "OutgoingBusDepartureTerminal": null,
          "OutgoingPrivateVehicle": null
        }
      }
    ]
  }
}

Response common exceptions

در جدول زیر لیستی از خطاهایی که ممکن است بعد از فراخوانی این متد برگشت داده شود، فهرست شده است.

ExceptionType	توضیح خطا
Exception	خطای نامشخص. جهت دریافت اطلاعات بیشتر باید به ErrorMessage داخل json برگشتی مراجعه نمود.