GUguesty
Channel Commission

Update or create account level channel commission

Changed on

Replaces all account-level channel commissions for the authenticated account.

Send an array of channel and source commission definitions. Each item requires channel and source; tax and commission are optional (same as POST/PATCH). If none exist yet, they are created. Any account-level commissions missing from the body are removed (an empty array removes all account-level commissions).

put/channel-commissions-v2/account

Request

  • Base URL
    https://open-api.guesty.com/v1
  • URL
    https://open-api.guesty.com/v1/channel-commissions-v2/account
  • Auth
    API key in header authorization

Request body

taxnumber

Tax percentage on the channel commission (0–100). Omit to save the entry without tax (same optional behavior as POST/PATCH create and update).

channelstring required

Booking channel name (for example bookingCom, airbnb2, homeaway2, or manual). Must form a valid pair with source: either manual (always allowed), or an active pair from the channel-commission configurations catalog. The Guesty Open API Valid Enumerations — Channel Commission Sources guide is a product overview of sources; acceptance here is the active catalog (invalid pairs return 400). The guide’s “Set Commission” column may disagree with the catalog for a given source.

sourcestring required

Booking source within the channel. Often the same as channel for direct channels; can differ for channel managers (for example channel rentalsUnited with source homeAway). Must form a valid pair with channel (see channel for the catalog rule).

isPreDeductboolean

When true, Guesty automatically deducts the channel commission from the host payout for reservations from this source (adds a negative host channel fee on the folio). This API only honors isPreDeduct for the manual channel — for any other channel the value is ignored and stored as false. The Valid Enumerations guide may list Pre-deduct for other sources (for example expedia) as a product/UI capability; that is not controlled by this field. Defaults to false when omitted.

Example request

[
  {
    "commission": {
      "value": 5,
      "of": [
        "ACCOMMODATION_FARE",
        "CLEANING_FEE",
        "LOCAL_TAX",
        "DAMAGE_WAIVER"
      ]
    },
    "tax": 3,
    "channel": "bookingCom",
    "source": "bookingCom"
  }
]

Response

The saved account-level channel commissions. Each item in channels includes _id for use as channelCommissionId on PATCH and DELETE.

accountIdstring

Account ID that owns these channel commissions

unitTypeIdstring

Listing / unit type ID for listing-level commissions; omitted for account-level commissions

Example response

{
  "channels": [
    {
      "commission": {
        "value": 5,
        "of": [
          "ACCOMMODATION_FARE",
          "CLEANING_FEE",
          "LOCAL_TAX",
          "DAMAGE_WAIVER"
        ]
      },
      "tax": 3,
      "channel": "bookingCom",
      "source": "bookingCom",
      "_id": "5f3f7b2f5d7b9b001f6f6c9d"
    }
  ],
  "accountId": "df7hf01cnduhdb2125854dj8",
  "unitTypeId": "df7hf01cnduhdb2125854dj8"
}

Changes

  • 3122b8618183Revision changes
    • breaking

      the request's body type changed from object to array

    • warning

      removed the request property

    • warning

      removed the request property

    • info

      api operation id ChannelCommissionController_updateAccountChannelCommission1 removed and replaced with ChannelCommissionsOpenApiController_updateChannelCommissionAccountLevel

    • info

      added the media type application/json for the response with the status