CLcloudbeds
Item

appendCustomItem

Changed on

Append single, or multiple, custom items and their associated payments to an existing one in a Reservation, House Account, or Group.

post/appendCustomItem

Request

  • Base URL
    https://api.cloudbeds.com/api/v1.3
  • URL
    https://api.cloudbeds.com/api/v1.3/appendCustomItem
  • 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.

referenceIDstring

partner's transaction reference of the existing posting to append the items to. Items are added on every call; duplicates are not prevented

subReservationIDstring nullable

Sub Reservation identifier

roomIDstring nullable

Room identifier (Ignored if subReservationID exist)

saleDatestring date-time nullable

Posting date. Defaults to now.

guestIDstring nullable

Guest identifier

guestNamestring nullable

(Ignored if guestID exist)

itemPaidboolean nullable

If the item is already paid. Note: If set to true, a payment in cash will be registered for the total value of the item, taxes and fees. If this is not the expected behavior, set to false, and register the operation manually. (Ignored if payments array exist)

Response

200 Response

successboolean

Returns if the request could be completed

Changes