CLcloudbeds
Item

putItemToInventory

Updates an item with information provided<br /> ¹ only if item.stockInventory = true<br />

put/putItemToInventory

Request

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

itemIDstring

Item identifier

itemNamestring nullable

Item name

itemType'product' | 'service' nullable

Item type

itemSKUstring nullable

Item SKU. Will be generated if not set

itemCodestring nullable

Item code

itemDescriptionstring nullable

Item description

itemPricenumber nullable

Item price

stockInventoryboolean nullable

Track stock inventory for this item

itemQuantityinteger nullable

¹ Current amount of item available

reorderThresholdinteger nullable

¹ Quantity at which to reorder item

stopSellMetboolean nullable

¹ true - Whether item is at or below value set for stop-sell threshold.

stopSellinteger nullable

¹ Quantity at which to stop selling product.

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

No recorded changes to this operation across all 2 revisions of this API.