GUguesty
Channel Commission

Update channel commission

Changed on

Updates an existing channel commission identified by channelCommissionId (the _id from a GET response).

Omit unitTypeId for an account-level commission. Provide unitTypeId for a listing-level commission.

The body must use the same channel and source as the existing entry.

Omit commission or tax to remove them from this entry. isPreDeduct defaults to false when omitted. Listing-level commissions are used for reservations only when levelEntityType is UNIT_TYPE (see GET/PUT unit-type/{unitTypeId}/level-configurations).

patch/channel-commissions-v2/{channelCommissionId}

Request

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

Path parameters

channelCommissionIdstring required
Example:5f3f7b2f5d7b9b001f6f6c9d

Channel commission ID (for example 5f3f7b2f5d7b9b001f6f6c9d) — the _id of an item from GET /account, GET /unit-type/{unitTypeId}, or GET /unit-type/{unitTypeId}/actual

Request body

unitTypeIdstring

Listing / unit type ID. Omit for an account-level entry; provide to create or update a listing-level entry. Must be a unit type (parent listing), not a sub-unit.

taxnumber

Tax percentage on the channel commission (0–100). On create, omit to save the entry without tax. On update, omit to remove the existing tax from this entry.

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

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

Response

The updated channel commission entry

_idstring

ID of this channel commission entry. Use this value as channelCommissionId on PATCH and DELETE.

taxnumber

Tax percentage on the channel commission (0–100). Omitted when no tax is set.

sourcestring required

Booking source within the channel. Often the same as channel for direct channels; can differ for channel managers.

channelstring required

Booking channel name (for example bookingCom, airbnb2, homeaway2, or manual)

isPreDeductboolean

When true, Guesty automatically deducts the channel commission from the host payout for this source. Applies only to the manual channel. Omitted or false when not used.

Example response

{
  "_id": "5f3f7b2f5d7b9b001f6f6c9d",
  "commission": {
    "value": 10,
    "of": [
      "PAYOUT"
    ]
  },
  "tax": 10,
  "source": "homeaway2",
  "channel": "homeaway2"
}

Changes