Sign in

v1

latestOpenAPI 3.0.12026-07-242871595.3 MB
INVENTORY

Get a single inventory item

Retrieves an existing inventory item.

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

Path parameters

mIdstring required

Merchant idenitifier.

itemIdstring required

Inventory item identifier.

Query parameters

expandstring

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

Headers

User-Agentstring required

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

Response

Successful response. Inventory item displayed.

idstring

Unique identifier of the inventory item.

hiddenboolean

Indicates whether the inventory item is hidden on the Register app. Default: False

availableboolean

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

autoManageboolean

Indicates whether the inventory item's availability is automatically or manually managed. Values: True - Item availability is automatically managed. False(default) - 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 based on the merchant's local currency and price type, such as fixed, variable, or per unit 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. Default: True

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. Default: False

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.