v1

latestOpenAPI 3.0.12026-07-242871595.3 MB

INVENTORY

Get items by tax rate

get/v3/merchants/{mId}/tax_rates/{taxId}/items

Path parameters

mIdstring required

Merchant Id

taxIdstring required

Tax Id

Query parameters

filterstring

Filter fields: [modifiedTime, hidden, itemCode, available, option.id, modifierGroup.id, autoManage, price, id, sku, defaultTaxRates, tags.id, alternateName, isRevenue, tags.name, deleted, item.id, name, itemStock.quantity, itemGroup.id]

expandstring

Expandable fields: [items]

Headers

User-Agentstring required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <AppName>/<Version> <Comment>

Response

idstring

Unique identifier

hiddenboolean

True if this item is hidden from Clover Register App

availableboolean

True if this item is available for sale across all channels

autoManageboolean

False manually manage item availability, True item availability depends on stock count

namestring required

Name of the item

alternateNamestring

Alternate name of the item

codestring

Product code, e.g. UPC or EAN

skustring

SKU of the item

priceinteger required

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.

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

defaultTaxRatesboolean

Flag to indicate whether or not to use default tax rates

unitNamestring

Unit name, e.g. oz, lb

costinteger

Cost of the item to merchant, as opposed to customer price

isRevenueboolean

True if this item should be counted as revenue. For example, gift cards and donations would not be counted as revenue.

stockCountinteger

Deprecated, use itemStock instead.

modifiedTimeinteger

deletedTimeinteger

Timestamp when item was last deleted

priceWithoutVatinteger

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.

colorCodestring

Hex code representation of the color assigned to item in the form of #fff, #ffffff, or #ffffffff