CLcloudbeds
Item

postVoidItem

Changed on

Voids the itemID transaction on the specified Reservation ID, House Account ID, or Group. If payments were sent in calls postItem or postCustomItem, they will be deleted too.

post/postVoidItem

Request

  • Base URL
    https://api.cloudbeds.com/api/v1.3
  • URL
    https://api.cloudbeds.com/api/v1.3/postVoidItem
  • Auth
    • API key in header x-api-key
    • or OAuth 2
      Authorization code
      Scopes: write:item

Request body application/x-www-form-urlencoded

propertyIDstring nullable

Property ID

reservationIDstring nullable

Reservation identifier. Required if no houseAccountID or eventCode is provided.

houseAccountIDstring nullable

House Account identifier. Required if no reservationID or eventCode is provided.

eventCodestring nullable

Event (group profile) code. Required if no reservationID or houseAccountID is provided.

soldProductIDstring

Item identifier

Response

200 Response

successboolean

Returns if the request could be completed

messagestring nullable

To be used in case any error occurs (if success = false). If success = true, it does not exist.

Changes