Class: Item

inventory.Item()

new Item()

Source:

Methods

(static) Item#getAlternateName() → {Null|String}

Get the field value Alternate name of the item
Source:
Returns:
Type
Null | String

(static) Item#getCanonical() → {Null|base.Reference}

Get the field value Reference to canonical items
Source:
Returns:
Type
Null | base.Reference

(static) Item#getCategories() → {Null|Array.<inventory.Category>}

Get the field value Categories associated with this item
Source:
Returns:
An array of
Type
Null | Array.<inventory.Category>

(static) Item#getCode() → {Null|String}

Get the field value Product code, e.g. UPC or EAN
Source:
Returns:
Type
Null | String

(static) Item#getCost() → {Null|Number}

Get the field value Cost of the item to merchant, as opposed to customer price
Source:
Returns:
must be a long integer
Type
Null | Number

(static) Item#getDefaultTaxRates() → {Boolean|Null}

Get the field value Flag to indicate whether or not to use default tax rates
Source:
Returns:
Type
Boolean | Null

(static) Item#getDeletedTime() → {Null|Number}

Get the field value Timestamp when item was last deleted
Source:
Returns:
must be a long integer
Type
Null | Number

(static) Item#getHidden() → {Boolean|Null}

Get the field value True if this item is hidden from Clover Register App
Source:
Returns:
Type
Boolean | Null

(static) Item#getId() → {String}

Get the field value Unique identifier
Source:
Returns:
Type
String

(static) Item#getIsRevenue() → {Boolean|Null}

Get the field value True if this item should be counted as revenue, for example gift cards and donations would not
Source:
Returns:
Type
Boolean | Null

(static) Item#getItemGroup() → {Null|base.Reference}

Get the field value Reference to an item group
Source:
Returns:
Type
Null | base.Reference

(static) Item#getItemStock() → {Null|inventory.ItemStock}

Get the field value Item stock attribute that can be expanded to show stock quantity
Source:
Returns:
Type
Null | inventory.ItemStock

(static) Item#getMenuItem() → {Null|inventory.MenuItem}

Get the field value Menu Item attribute that can be expanded to menu specific attributes
Source:
Returns:
Type
Null | inventory.MenuItem

(static) Item#getModifiedTime() → {Null|Number}

Get the field value
Source:
Returns:
must be a long integer
Type
Null | Number

(static) Item#getModifierGroups() → {Null|Array.<inventory.ModifierGroup>}

Get the field value
Source:
Returns:
An array of
Type
Null | Array.<inventory.ModifierGroup>

(static) Item#getName() → {String}

Get the field value Name of the item
Source:
Returns:
Type
String

(static) Item#getOptions() → {Null|Array.<inventory.Option>}

Get the field value List of options pertaining to this item's attribute variation
Source:
Returns:
An array of
Type
Null | Array.<inventory.Option>

(static) Item#getPrice() → {Number}

Get the field value Price of the item, typically in cents; use priceType and merchant currency to determine actual item price. For non-VAT merchants, this field is exclusive of tax. For VAT merchants, this field is inclusive of tax.
Source:
Returns:
must be a long integer
Type
Number

(static) Item#getPriceType() → {inventory.PriceType}

Get the field value
Source:
Returns:
Type
inventory.PriceType

(static) Item#getPriceWithoutVat() → {Null|Number}

Get the field value The price without value-added tax (VAT). For non-VAT merchants, this field is ignored. For VAT merchants, this field is the base price of an item.
Source:
Returns:
must be a long integer
Type
Null | Number

(static) Item#getSku() → {Null|String}

Get the field value SKU of the item
Source:
Returns:
Type
Null | String

(static) Item#getStockCount() → {Null|Number}

Get the field value Deprecated, use itemStock instead.
Source:
Returns:
must be a long integer
Type
Null | Number

(static) Item#getTags() → {Null|Array.<inventory.Tag>}

Get the field value Tags associated with this item
Source:
Returns:
An array of
Type
Null | Array.<inventory.Tag>

(static) Item#getTaxRates() → {Null|Array.<inventory.TaxRate>}

Get the field value
Source:
Returns:
An array of
Type
Null | Array.<inventory.TaxRate>

(static) Item#getUnitName() → {Null|String}

Get the field value Unit name, e.g. oz, lb
Source:
Returns:
Type
Null | String

(static) Item#setAlternateName(alternateName)

Set the field value Alternate name of the item
Parameters:
Name Type Description
alternateName Null | String
Source:

(static) Item#setCanonical(canonical)

Set the field value Reference to canonical items
Parameters:
Name Type Description
canonical Null | base.Reference
Source:

(static) Item#setCategories(categories)

Set the field value Categories associated with this item
Parameters:
Name Type Description
categories Null | Array.<inventory.Category> An array of
Source:

(static) Item#setCode(code)

Set the field value Product code, e.g. UPC or EAN
Parameters:
Name Type Description
code Null | String
Source:

(static) Item#setCost(cost)

Set the field value Cost of the item to merchant, as opposed to customer price
Parameters:
Name Type Description
cost Null | Number must be a long integer
Source:

(static) Item#setDefaultTaxRates(defaultTaxRates)

Set the field value Flag to indicate whether or not to use default tax rates
Parameters:
Name Type Description
defaultTaxRates Boolean | Null
Source:

(static) Item#setDeletedTime(deletedTime)

Set the field value Timestamp when item was last deleted
Parameters:
Name Type Description
deletedTime Null | Number must be a long integer
Source:

(static) Item#setHidden(hidden)

Set the field value True if this item is hidden from Clover Register App
Parameters:
Name Type Description
hidden Boolean | Null
Source:

(static) Item#setId(id)

Set the field value Unique identifier
Parameters:
Name Type Description
id String
Source:

(static) Item#setIsRevenue(isRevenue)

Set the field value True if this item should be counted as revenue, for example gift cards and donations would not
Parameters:
Name Type Description
isRevenue Boolean | Null
Source:

(static) Item#setItemGroup(itemGroup)

Set the field value Reference to an item group
Parameters:
Name Type Description
itemGroup Null | base.Reference
Source:

(static) Item#setItemStock(itemStock)

Set the field value Item stock attribute that can be expanded to show stock quantity
Parameters:
Name Type Description
itemStock Null | inventory.ItemStock
Source:

(static) Item#setMenuItem(menuItem)

Set the field value Menu Item attribute that can be expanded to menu specific attributes
Parameters:
Name Type Description
menuItem Null | inventory.MenuItem
Source:

(static) Item#setModifiedTime(modifiedTime)

Set the field value
Parameters:
Name Type Description
modifiedTime Null | Number must be a long integer
Source:

(static) Item#setModifierGroups(modifierGroups)

Set the field value
Parameters:
Name Type Description
modifierGroups Null | Array.<inventory.ModifierGroup> An array of
Source:

(static) Item#setName(name)

Set the field value Name of the item
Parameters:
Name Type Description
name String
Source:

(static) Item#setOptions(options)

Set the field value List of options pertaining to this item's attribute variation
Parameters:
Name Type Description
options Null | Array.<inventory.Option> An array of
Source:

(static) Item#setPrice(price)

Set the field value Price of the item, typically in cents; use priceType and merchant currency to determine actual item price. For non-VAT merchants, this field is exclusive of tax. For VAT merchants, this field is inclusive of tax.
Parameters:
Name Type Description
price Number must be a long integer
Source:

(static) Item#setPriceType(priceType)

Set the field value
Parameters:
Name Type Description
priceType inventory.PriceType
Source:

(static) Item#setPriceWithoutVat(priceWithoutVat)

Set the field value The price without value-added tax (VAT). For non-VAT merchants, this field is ignored. For VAT merchants, this field is the base price of an item.
Parameters:
Name Type Description
priceWithoutVat Null | Number must be a long integer
Source:

(static) Item#setSku(sku)

Set the field value SKU of the item
Parameters:
Name Type Description
sku Null | String
Source:

(static) Item#setStockCount(stockCount)

Set the field value Deprecated, use itemStock instead.
Parameters:
Name Type Description
stockCount Null | Number must be a long integer
Source:

(static) Item#setTags(tags)

Set the field value Tags associated with this item
Parameters:
Name Type Description
tags Null | Array.<inventory.Tag> An array of
Source:

(static) Item#setTaxRates(taxRates)

Set the field value
Parameters:
Name Type Description
taxRates Null | Array.<inventory.TaxRate> An array of
Source:

(static) Item#setUnitName(unitName)

Set the field value Unit name, e.g. oz, lb
Parameters:
Name Type Description
unitName Null | String
Source: