JSON API - GETSUPPLIERINFO

Owned by Vincent Josset
Last updated: Feb 20, 2023
1 min read

Returns supplier details. Most common use case is for hotel information. Includes image gallery, amenity description, and features of the supplier.
Note that the array of Amenities arrays (Facilities, Dining, Wedding etc.) may be different for each Softrip client, depending on what is loaded and what they choose to return in the API.

 

Input

  • ProductCode (if caller wants details for ALL suppliers in the given product)
    OR

  • SupplierID (if caller wants details for a specific supplier)

  • ServiceID (if caller wants details for just a specific service)

 

Output

  • Supplier Array

    • Supplier:

      • SupplierID

      • SupplierName

      • Address fields

      • SupplierDetail (one-paragraph detailed description of the hotel)

      • Thumbnail (single image/thumbnail for this hotel)

      • Facilities Amenities array (from SupplierAmenities table, type "FACILITIES" and "FACILITIES-PROFILE")

      • All-Inclusive Amenities array (from SupplierAmenities table, type "ALLINCLUSIVE" and "ALLINCLUSIVE-PROFILE")

      • Dining Amenities array (from SupplierAmenities table, type "DINING" and "DINING-PROFILE")

      • Golf Amenities array (from SupplierAmenities table, type "GOLF" and "GOLF-PROFILE")

      • Group Amenities array (from SupplierAmenities table, type "GROUPS" and "GROUPS-PROFILE")

      • Kids Amenities array (from SupplierAmenities table, type "KIDS" and "KIDS-PROFILE")

      • Recreation Amenities array (from SupplierAmenities table, type "RECREATION" and "RECREATION-PROFILE")

      • Spa Amenities array (from SupplierAmenities table, type "SPA" and "SPA-PROFILE")

      • Wedding Amenities array (from SupplierAmenities table, type "WEDDDING" and "WEDDING-PROFILE")

      • General Amenities array (from SupplierAmenities table, type "WELCOME" and "WELCOME-PROFILE")

      • Photos array (from SupplierAmenities table, type "IMAGES")

      • Services array (for each hotel room category)

        • ServiceID (room category ID)

        • ServiceDescription (room category name)

        • Thumbnail (single image/thumbnail for this room category)

        • ServiceDetail (one-paragraph detailed description of room category)

        • Amenities array (from SupplierAmenities table, type "ROOMAMENITIES")

        • DetailedAmenities array (from SupplierAmenities table, all amenity types and descriptions)