مستندات وب سرویس

متد Get Flight List

Download Markdown for LLM

این متد برای دریافت پروازهای موجود در Inventory استفاده می‌گردد.

کاربرد این متد صرفا جهت اطلاع از جزئیات پروازهای ساخته شده در Inventory می‌باشد.

زمان پرواز به ناحیه زمانی محلی خروجی داده می شود. مثلا برای یک پرواز تهران استانبول، زمان خروج از مبدا به ناحیه زمانی ایران و زمان رسیدن به مقصد به ناحیه زمانی ترکیه خروجی داده می شود.

اگر در پارامترهای ورودی مقادیر OriginIataCode و DestinationIataCode بصورت یک رشته خالی یا null پاس داده شوند، تمام پروازهای تاریخ مورد نظر در همه‌ی مسیرها خروجی داده خواهد شد.


API Endpoint

POST https://{SupplierWebsiteUrl}/api/B2M/Bot/Flight/Charter/FlightManagement/Flight/GetList/V2

Request Parameters

  • UserName

    string

    [conditional-required]

    نام کاربری

    در صورت استفاده از روش Username/Password Authentication ارسال این فیلد الزامی است.

  • Password

    string

    [conditional-required]

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

    در صورت استفاده از روش Username/Password Authentication ارسال این فیلد الزامی است.

  • AccessToken

    string

    [conditional-required]

    توکن احراز هویت دریافت‌شده از طریق Single Sign-On (SSO).

    در صورت استفاده از روش Token-based Authentication این فیلد را ارسال کنید. در این حالت نیازی به ارسال UserName و Password نیست.

    برای آشنایی با روش‌های احراز هویت و نحوه انتخاب و استفاده از هر روش، به مستندات Authentication مراجعه کنید.

  • FlightDate

    string

    required

    تاریخ پروازها با فرمت yyyy-MM-dd به صورت میلادی

  • OriginIataCode

    string

    optional

    کد سه حرفی یاتای مبدا

  • DestinationIataCode

    string

    optional

    کد سه حرفی یاتای مقصد


Sample Request

curl -X POST https://SepehrApiTest.ir/api/B2M/Bot/Flight/Charter/FlightManagement/Flight/GetList/V2 \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "Accept: application/json" \
  -H "Accept-Encoding: gzip, deflate" \
  -d '{
    "UserName": "sample-head-office-user",
    "Password": "25f9e794323b453885f5181f1b624d0b",
    "FlightDate": "2025-01-25",
    "OriginIataCode": "",
    "DestinationIataCode": ""
}'

Response Parameters

  • flightList

    Array of flights

    لیست پروازها

    + نمایش ویژگی‌های زیرمجموعه

    • flightList.Id

      number

      شناسه منحصر به فرد یک پرواز

    • flightList.flightNumber

      string

      شماره پرواز

    • flightList.departureDateTime

      string

      زمان خروج پرواز از مبدا. با فرمت yyyy-MM-dd HH:mm به صورت میلادی و بر اساس ناحیه زمانی مبدا

    • flightList.originIataCode

      string

      کد سه حرفی یاتای مبدا

    • flightList.destinationIataCode

      string

      کد سه حرفی یاتای مقصد

    • flightList.flightDurationInMinute

      number

      مدت زمان طول کل پرواز به دقیقه

    • flightList.arrivalDateTime

      string

      زمان ورود پرواز به مقصد. با فرمت yyyy-MM-dd HH:mm به صورت میلادی و بر اساس ناحیه زمانی مقصد

    • flightList.airlineIataCode

      string

      کد یاتای ایرلاین

    • flightList.aircraftIataCode

      string

      کد یاتای هواپیما

    • flightList.aircraftRegister

      string

      کد رجیستر هواپیما

    • flightList.totalCapacity

      string

      ظرفیت کلی پرواز

    • flightList.status

      string

      وضعیت فعلی پرواز

    • flightList.lastUpdateDateTime

      string

      زمان اعمال آخرین ویرایش روی پرواز. با فرمت yyyy-MM-dd HH:mm:ss به صورت میلادی

    • flightList.lastUpdateByUserName

      string

      کاربری که آخرین ویرایش را روی پرواز اعمال کرده است

    • flightList.privateRemarks

      string

      ملاحظات خصوصی که روی پرواز نوشته شده است و فقط توسط کاربران دفترمرکزی قابل مشاهده می‌باشد

    • flightList.publicRemarks

      string

      ملاحظات عمومی که روی پرواز نوشته شده است و قابل مشاهده در صفحه رزرو پرواز می‌باشد

    • flightList.eTicketRemarks

      string

      ملاحظات عمومی که جهت نمایش روی بلیت نوشته شده است. این ملاحظات روی فایل بلیت به رنگ قرمز نمایش داده می‌شود

    • flightList.canIssueOpenReturning

      bool

      نشان دهنده امکان رزرو همزمان پرواز برگشت بصورت OPEN با این پرواز است

    • flightList.preventBookReturningFlightOnOtherAirlines

      bool

      نشان دهنده امکان رزرو همزمان پرواز برگشت روی ایرلاینی متفاوت با ایرلاین این پرواز می‌باشد

    • flightList.stop1IataCode

      string

      درصورتی که این پرواز حداقل یک استاپ داشته باشد کد یاتای سه حرفی فرودگاهی که در آن استاپ می‌کنیم نمایش داده می‌شود. در صورت null بودن یعنی پرواز بدون استاپ انجام می‌شود

    • flightList.stop2IataCode

      string

      درصورتی که این پرواز دو استاپ داشته باشد کد یاتای سه حرفی فرودگاهی که در آن استاپ دوم اتفاق می‌افتد نمایش داده می‌شود.

    • flightList.hideFlightFromSubsidiaryAgencies

      bool

      نشان دهنده امکان رزرو اختصاصی این پرواز برای کاربران دفترمرکزی است. در صورت true بودن یعنی فقط کاربران دفترمرکزی می‌توانند این پرواز را رزرو کنند.

    • flightList.closeTimeoutInMinute

      number

      نشان می‌دهد که چند دقیقه قبل از ساعت خروج، پرواز به صورت خودکار close می‌شود. مقدار 0 به معنای عدم close شدن خودکار می‌باشد

    • flightList.flightClassList

      Array Of Flight Classes

      لیست کلاس‌های پروازی

      + نمایش ویژگی‌های زیرمجموعه

      • flightList.flightClassList.Id

        number

        شناسه منحصر به فرد یک کلاس پروازی

      • flightList.flightClassList.capacity

        string

        ظرفیت این کلاس پروازی

      • flightList.flightClassList.lockedSeatCount

        string

        تعداد صندلی‌هاییکه روی این کلاس پروازی هم اکنون قفل شده و در حال رزرو می‌باشند

      • flightList.flightClassList.soldSeatCount_SharedQuota

        string

        تعداد صندلی‌هایی که تاکنون روی سهمیه شناوری این کلاس پروازی به فروش رفته‌اند

      • flightList.flightClassList.soldSeatCount_SubsidiaryCharterQuota

        string

        تعداد صندلی‌هایی که تاکنون روی سهمیه‌های این کلاس پروازی به فروش رفته‌اند

      • flightList.flightClassList.soldSeatCount_Total

        string

        مجموع تعداد صندلی‌هایی که تاکنون روی این کلاس پروازی به فروش رفته‌اند

      • flightList.flightClassList.availableSeatCount

        string

        تعداد صندلی‌های موجود و آماده برای فروش روی این کلاس پروازی

      • flightList.flightClassList.isAllAllowed

        bool

        در صورت true بودن به معنی وجود فیلتر مشاهده برای همه آژانس‌هاست. به عبارت دیگر همه کاربران و بازدید کنندگان سایت می‌توانند این کلاس پروازی را در صفحه رزرو پرواز مشاهده کنند

      • flightList.flightClassList.extraCommissionPercent

        number

        کمیسیون مازاد این کلاس پروازی به درصد

      • flightList.flightClassList.capacityShowCount

        number

        حداکثر تعداد نمایش صندلی‌های موجود در صفحه رزرو پرواز برای کاربران و بازدید کنندگان سایت

      • flightList.flightClassList.ruleList

        List Of Strings

        لیست قوانین ثبت شده روی این کلاس پروازی. مانند مخصوص تور، الزام فروش فقط به صورت رفت و برگشت و...

      • flightList.flightClassList.fare

        object

        جزئیات fare این کلاس پروازی

        + نمایش ویژگی‌های زیرمجموعه

        • flightList.flightClassList.fare.Id

          number

          شناسه منحصر به فرد یک fare

        • flightList.flightClassList.fare.name

          string

          نام این fare

        • flightList.flightClassList.fare.cabin

          string

          کابین این fare. مانند Economy ، Business و...

        • flightList.flightClassList.fare.bookingCode

          string

          booking code این fare

        • flightList.flightClassList.fare.oneWayAdult

          decimal

          مبلغ یک بزرگسال برای رزرو یکطرفه

        • flightList.flightClassList.fare.oneWayChild

          decimal

          مبلغ یک کودک برای رزرو یکطرفه

        • flightList.flightClassList.fare.oneWayInfant

          decimal

          مبلغ یک نوزاد برای رزرو یکطرفه

        • flightList.flightClassList.fare.roundTripAdultSameOrigin

          decimal

          مبلغ پرواز رفت برای یک بزرگسال در یک رزرو رفت و برگشتی (درصورتی مقدار این فیلد روی یک رزرو رفت و برگشتی اعمال می‌شود که این fare پیشرفته باشد)

        • flightList.flightClassList.fare.roundTripChildSameOrigin

          decimal

          مبلغ پرواز رفت برای یک کودک در یک رزرو رفت و برگشتی (درصورتی مقدار این فیلد روی یک رزرو رفت و برگشتی اعمال می‌شود که این fare پیشرفته باشد)

        • flightList.flightClassList.fare.roundTripInfantSameOrigin

          decimal

          مبلغ پرواز رفت برای یک نوزاد در یک رزرو رفت و برگشتی (درصورتی مقدار این فیلد روی یک رزرو رفت و برگشتی اعمال می‌شود که این fare پیشرفته باشد)

        • flightList.flightClassList.fare.roundTripAdultOppositeOrigin

          decimal

          مبلغ پرواز برگشت برای یک بزرگسال در یک رزرو رفت و برگشتی (درصورتی این مقدار فیلد روی یک رزرو رفت و برگشتی اعمال می‌شود که این fare پیشرفته باشد)

        • flightList.flightClassList.fare.roundTripChildOppositeOrigin

          decimal

          مبلغ پرواز برگشت برای یک کودک در یک رزرو رفت و برگشتی (درصورتی مقدار این فیلد روی یک رزرو رفت و برگشتی اعمال می‌شود که این fare پیشرفته باشد)

        • flightList.flightClassList.fare.roundTripInfantOppositeOrigin

          decimal

          مبلغ پرواز برگشت برای یک نوزاد در یک رزرو رفت و برگشتی (درصورتی مقدار این فیلد روی یک رزرو رفت و برگشتی اعمال می‌شود که این fare پیشرفته باشد)

        • flightList.flightClassList.fare.isAdvancedFare

          bool

          در صورت true بودن یعنی این fare پیشرفته است و در غیر این صورت fare ساده است.

        • flightList.flightClassList.fare.minimumStayDay

          number

          حداقل مدت اقامت. یعنی در رزروهای رفت و برگشتی این فیلد مشخص می‌کند که بین پرواز رفت با برگشت حداقل چند روز باید فاصله باشد (درصورتی مقدار این فیلد روی یک رزرو رفت و برگشتی اعمال می‌شود که این fare پیشرفته باشد)

        • flightList.flightClassList.fare.maximumStayDay

          number

          حداکثر مدت اقامت. یعنی در رزروهای رفت و برگشتی این فیلد مشخص می‌کند که بین پرواز رفت با برگشت حداکثر چند روز باید فاصله باشد (درصورتی مقدار این فیلد روی یک رزرو رفت و برگشتی اعمال می‌شود که این fare پیشرفته باشد)

        • flightList.flightClassList.fare.currencyCode

          string

          کد سه حرفی ارز این fare. مانند IRR ، USD و...


Sample Response

{
    "flightList": [
        {
            "id": 64511,
            "flightNumber": "2339",
            "departureDateTime": "2025-01-25 20:30",
            "originIataCode": "AWZ",
            "destinationIataCode": "IFN",
            "flightDurationInMinute": 60,
            "arrivalDateTime": "2025-01-25 21:30",
            "airlineIataCode": "PY",
            "aircraftIataCode": "AB6",
            "aircraftRegister": "EP-GHT",
            "totalCapacity": "100",
            "status": "OnTime",
            "lastUpdateDateTime": "2025-01-06 05:16:46",
            "lastUpdateByUserName": "admin",
            "privateRemarks": null,
            "publicRemarks": "",
            "eTicketRemarks": "",
            "canIssueOpenReturning": false,
            "preventBookReturningFlightOnOtherAirlines": false,
            "stop1IataCode": null,
            "stop2IataCode": null,
            "hideFlightFromSubsidiaryAgencies": false,
            "closeTimeoutInMinute": 0,
            "flightClassList": [
                {
                    "id": 843902,
                    "capacity": "40",
                    "lockedSeatCount": "0",
                    "soldSeatCount_SharedQuota": "0",
                    "soldSeatCount_SubsidiaryCharterQuota": "0",
                    "soldSeatCount_Total": "0",
                    "availableSeatCount": "40",
                    "isAllAllowed": true,
                    "extraCommissionPercent": 0,
                    "capacityShowCount": 9,
                    "ruleList": [],
                    "fare": {
                        "id": 4163,
                        "name": "Fare 720",
                        "cabin": "Economy",
                        "bookingCode": "T",
                        "oneWayAdult": 7200000.00,
                        "oneWayChild": 5000000.00,
                        "oneWayInfant": 550000.00,
                        "roundTripAdultSameOrigin": 0.00,
                        "roundTripChildSameOrigin": 0.00,
                        "roundTripInfantSameOrigin": 0.00,
                        "roundTripAdultOppositeOrigin": 0.00,
                        "roundTripChildOppositeOrigin": 0.00,
                        "roundTripInfantOppositeOrigin": 0.00,
                        "isAdvancedFare": false,
                        "minimumStayDay": 0,
                        "maximumStayDay": 0,
                        "currencyCode": "IRR"
                    }
                }
            ]
        }
    ]
}