GUguesty
[Beta] Basic Fees

Get listing cleaning fee for channel

Changed on

Returns the effective cleaning fee for that channel (channel override if present, else listing default). When basic fees are configured for the listing but have neither a listing default nor a channel override, responds 200 without cleaningFee (field omitted). 404 only when the listing has no basic fees configured. There is no markup property — percentage listing markup that applies to cleaning fee is already baked into formula when applicable.

get/basic-fees/listings/{listingId}/channels/{channel}

Request

  • Base URL
    https://open-api.guesty.com/v1
  • URL
    https://open-api.guesty.com/v1/basic-fees/listings/{listingId}/channels/{channel}
  • Auth
    API key in header authorization

Path parameters

listingIdstring required
Example:5f8d0d55b54764421b7156c9

Listing id (for example 5f8d0d55b54764421b7156c9).

channel'airbnb2' | 'bookingCom' | 'homeaway2' | 'aabode' | 'alohacamp' | 'amaSelections' | 'allogio' | 'altoVita' | 'alluraDirect' | 'angells' | 'anystaysCom' | 'awaze' | 'beachguide' | 'belVilla' | 'bluegroundNestpick' | 'bnbFinder' | 'boarding' | 'bookingPalGcm' | 'bookripe' | 'boutiquehomeCom' | 'byndhomesCom' | 'bynd' | 'capitalOne' | 'cockpit' | 'cocoonr' | 'check24' | 'crewDogs' | 'cuddlyNest' | 'desVu' | 'easyReserve' | 'emeraldCoast' | 'etravel' | 'feratel' | 'findRentals' | 'floridaPanhandleCom' | 'floridaRentals' | 'flowOne' | 'getawayGoGo' | 'glampingHub' | 'golfhom' | 'gonesto' | 'googleVacationRentals' | 'got2Go' | 'groupRentals' | 'guestSmiles' | 'hawaiianIslandsCom' | 'helloLanding' | 'hiSite' | 'holidaySwap' | 'holidu' | 'homesVillasByMarriott' | 'homeToGo' | 'hopper' | 'hostelworld' | 'hotelbeds' | 'hotelsCombined' | 'houfy' | 'housingAnywhere' | 'houseStay' | 'housingPanda' | 'HVN' | 'hyperguest' | 'inntopia' | 'invenioHomes' | 'lakeCom' | 'livily' | 'livjaza' | 'luxico' | 'luxuryEscapes' | 'makeMyTrip' | 'mirai' | 'mrMrsSmith' | 'muchosol' | 'mysaGlobal' | 'nesto' | 'netAffinity' | 'oliversTravels' | 'onefinestay' | 'plumGuide' | 'priceTravelCom' | 'rakutenStayInc' | 'reconline' | 'rentalEscapes' | 'rentalz' | 'renters' | 'reserva' | 'revato' | 'roibos' | 'sabreSynxis' | 'situCom' | 'skiCom' | 'skyesCottages' | 'smilingHouse' | 'smokyMountainCom' | 'soujourn' | 'spacestCom' | 'square' | 'stay' | 'stayHvn' | 'stayLonger' | 'stayOne' | 'staySense' | 'stugaCa' | 'szallas' | 'theDyrt' | 'theMaimonGroup' | 'theQuintessCollection' | 'topVillas' | 'torontoBoutiqueApartments' | 'traveloka' | 'travelStaytion' | 'travelWithAspectCom' | 'tripco' | 'tripCom' | 'tripCom2' | 'traum' | 'tropicalEscape' | 'trustedStays' | 'tuiVillas' | 'vacasa' | 'vacationFinder' | 'vacationRenter' | 'vacayHome' | 'vacayMyWay' | 'viajesElCorteIngles' | 'vidle' | 'villaFinder' | 'villaway' | 'villaTracker' | 'vivreStays' | 'vrboLite' | 'wander' | 'weski' | 'weChalet' | 'whimstay' | 'zaaer' required

OTA (for example airbnb2, bookingCom, homeaway2) or Guesty Distribution Hub (GDH) channel to resolve the listing cleaning fee for. Same values as channel overrides on PUT.

Response

Effective cleaning fee for the listing on the given channel. When basic fees are configured but have no listing default and no override for this channel, cleaningFee is omitted. Percentage listing markup that applies to cleaning fee is already baked into formula when applicable; there is no separate markup property.

Example response

{
  "cleaningFee": {
    "value": {
      "_id": "5f8d0d55b54764421b7156c9",
      "multiplier": "PER_STAY",
      "formula": 100,
      "valueType": "FIXED"
    }
  }
}

Changes