Update an existing inventory item

post

https://apisandbox.dev.clover.com/v3/merchants/{mId}/items/{itemId}

Updates an existing inventory item. Use the POST HTTP method to create an inventory item.

Note: This endpoint cannot be used to update an item's stock quantity. To create or update stock for an item, you must use the Update item stock endpoint.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

mId

string

required

Merchant identifier.

itemId

string

required

Unique identifier of an item in the inventory.

Query Params

expand

string

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

Body Params

string

Unique identifier of the inventory item.

hidden

boolean

Defaults to false

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

available

boolean

Defaults to true

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

autoManage

boolean

Defaults to false

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.

itemGroup

object

Information regarding the item group.

options

array of objects

List of variants (options) available within an attribute. For example, an attribute of size can have small, medium, and large options.

options

name

string

Item name.

alternateName

string

Alternate name of the item.

code

string

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

sku

string

Stock keeping unit (SKU).

price

int64

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

string

enum

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

Allowed:

defaultTaxRates

boolean

Defaults to true

Indicates whether or not to use the default tax rate.

unitName

string

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

cost

integer

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

isRevenue

boolean

Defaults to false

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

isAgeRestricted

boolean

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

ageRestrictedObj

object

Contains the details for the age restriction. Required when isAgeRestricted is set to true.

modifierGroups

array of objects

modifierGroups

200Successful response. Existing inventory item updated.