CLcloudbeds
Item

postItem

Changed on

Adds an item either to a reservation or to a house account.

post/postItem

Request

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

subReservationIDstring nullable

Sub Reservation identifier.

itemIDstring

Item identifier

itemQuantityinteger

Items quantity

itemPricestring nullable

Item price, if not sent, items registered price will be used

itemNotestring nullable

Item note

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. If payments is set, itemPaid is ignored.

saleDatestring date-time nullable

Posting date. Defaults to current date.

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