CLclover
INVENTORY

Update an existing inventory item

Updates an existing inventory item. Use the POST HTTP method to create an inventory item.<br><br><b>Note:</b> This endpoint cannot be used to update an item's stock quantity. To create or update stock for an item, you must use the <a href='https://docs.clover.com/dev/reference/inventoryupdateitemstock'>Update item stock</a> endpoint.

post/v3/merchants/{mId}/items/{itemId}

Request

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

Path parameters

mIdstring required

Merchant identifier.

itemIdstring required

Unique identifier of an item in the inventory.

Query parameters

expandstring

Additional information provided as an expanded response: [tags, categories, taxRates, modifierGroups, itemStock, options, ageRestricted]

Headers

User-Agentstring required

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

Request body

idstring

Unique identifier of the inventory item.

hiddenboolean

Indicates whether the inventory item is hidden on the Register app.

availableboolean

Indicates whether the inventory item is available for sale across all channels.

autoManageboolean

Indicates whether the inventory item's availability is automatically or manually managed. Values: True - Item availability is automatically managed. False - Item availability is manually managed.

namestring

Item name.

alternateNamestring

Alternate name of the item.

codestring

Item product code, such as Universal Product Code (UPC) or European Article Number (EAN).

skustring

Stock keeping unit (SKU).

priceinteger

Price of the item. Use price type and merchant currency to determine the actual item price. For non-VAT merchants who do not pay value-added tax, this field is exclusive of tax. For VAT merchants, this field is inclusive of tax. Format: Cents

priceType'FIXED' | 'VARIABLE' | 'PER_UNIT'

Price type, such as fixed, variable, or per unit price.

defaultTaxRatesboolean

Indicates whether or not to use the default tax rate.

unitNamestring

Unit of measurement for the item, such as pound or meter.

costinteger

Cost of the item to a merchant as compared to the price payable by the customer, for example: wholesale versus retail price.

isRevenueboolean

Indicates whether this item is counted as revenue, for example: gift cards and donations are not counted as revenue.

isAgeRestrictedboolean

Set to true to make the item age-restricted, or false to remove the restriction. If setting to true, ageRestrictedObj must also be provided.

modifiedTimeinteger

Time when the item was modified.

deletedTimeinteger

Time when the item was deleted.

priceWithoutVatinteger

Item price without value-added tax (VAT). For non-VAT merchants, this field is not used. For VAT merchants, this field is the base price of an item.

colorCodestring

Hex code of the color assigned to the category and its items. Format: #fff, #ffffff, or #ffffffff.

Example request

{
  "ageRestrictedObj": {
    "name": "Alcohol",
    "minimumAge": 21
  }
}

Response

Successful response. Existing inventory item updated.

idstring

Unique identifier of the inventory item.

hiddenboolean

Indicates whether the inventory item is hidden on the Register app.

availableboolean

Indicates whether the inventory item is available for sale across all channels.

autoManageboolean

Indicates whether the inventory item's availability is automatically or manually managed. Values: True - Item availability is automatically managed. False - Item availability is manually managed.

namestring

Item name.

alternateNamestring

Alternate name of the item.

codestring

Item product code, such as Universal Product Code (UPC) or European Article Number (EAN).

skustring

Stock keeping unit (SKU).

priceinteger

Price of the item. Use price type and merchant currency to determine the actual item price. For non-VAT merchants who do not pay value-added tax, this field is exclusive of tax. For VAT merchants, this field is inclusive of tax. Format: Cents

priceType'FIXED' | 'VARIABLE' | 'PER_UNIT'

Price type, such as fixed, variable, or per unit price.

defaultTaxRatesboolean

Indicates whether or not to use the default tax rate.

unitNamestring

Unit of measurement for the item, such as pound or meter.

costinteger

Cost of the item to a merchant as compared to the price payable by the customer, for example: wholesale versus retail price.

isRevenueboolean

Indicates whether this item is counted as revenue, for example: gift cards and donations are not counted as revenue.

isAgeRestrictedboolean

If true, the item requires age verification. The ageRestrictedObj can be retrieved by using expand=ageRestricted.

stockCountinteger

Deprecated. Use itemStock.

modifiedTimeinteger

Time when the item was modified.

deletedTimeinteger

Time when the item was deleted.

priceWithoutVatinteger

Item price without value-added tax (VAT). For non-VAT merchants, this field is not used. For VAT merchants, this field is the base price of an item.

colorCodestring

Hex code of the color assigned to the category and its items. Format: #fff, #ffffff, or #ffffffff.

Changes

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