CLcloudbeds
Item

postCustomItem

Changed on

Adds single, or multiple, custom items and their associated payments to a Reservation or House Account as a single transaction.

post/postCustomItem

Request

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

partner's transaction reference. If exist then Cloudbeds will prevent adding of duplicates

subReservationIDstring nullable

Sub Reservation identifier

roomIDstring nullable

Room identifier (Ignored if subReservationID exist)

saleDatestring date-time nullable

Posting date. Defaults to current date.

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