CLclover
INVENTORY

Get the stock of an inventory item

get/v3/merchants/{mId}/item_stocks/{itemId}

Request

  • Base URL
    https://apisandbox.dev.clover.com
  • URL
    https://apisandbox.dev.clover.com/v3/merchants/{mId}/item_stocks/{itemId}
  • Auth
    HTTP bearer

Path parameters

mIdstring required

Merchant Id

itemIdstring required

Item Id

Headers

User-Agentstring required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <product> / <product-version> <comment>

Response

Successful response. Displays stock of an item in the inventory.

stockCountinteger

Deprecated. Use quantity instead.

quantitynumber double

Current count of the items in stock.

stockAlertThresholdnumber double

The quantity threshold at which a low stock alert is triggered. Only appears if the Low Stock Alert feature is enabled.

modifiedTimeinteger

Time when the item stock was modified.

Changes

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