CLcloudbeds
Item

getCustomItem

Changed on

Returns every item and payment of one posting made with postCustomItem, including the items and payments added to it later with appendCustomItem. Look the posting up by any of its items or any of its payments. Postings made by any application on the property are returned.<br> Every item and payment carries the keys of its Accounting API transactions: query the Accounting API by its sourceKind and sourceID, then match externalRelationKind and externalRelationID.

get/getCustomItem

Request

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

Query parameters

propertyIDstring

Property ID

soldProductIDstring

Sold product identifier of any item of the posting, as returned by postCustomItem (with or without the p_ prefix). Required if no paymentID is provided.

paymentIDstring

Identifier of any payment sent with the posting. Required if no soldProductID is provided.

Response

200 Response

successboolean

Returns if the request could be completed

Changes