Sign in

v1

latestOpenAPI 3.0.12026-07-242871595.3 MB
INVENTORY

View items in a subcategory

Retrieves details for an inventory item, primarily to view its associations with categories and subcategories. Include the expand=categories.items query parameter in your request to return a detailed categories section listing both top-level categories and subcategories linked to the item. You can identify subcategories by their parentCategory field. If you omit this parameter, the response does not include category or subcategory data. For more information, see Manage subcategories.

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

Path parameters

mIdstring required

Merchant identifier.

subcategoryitemIdstring required

Unique identifier of an item in the inventory.

Query parameters

expand'categories.items'

Expandable fields to display additional nested information: [categories.items].

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. Displays a single inventory item and its category associations.

idstring required

Unique identifier of the 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, including point-of-sale (POS) devices and customer-facing platforms such as kiosks and merchant online ordering websites.

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 required

Item name.

alternateNamestring

Item alternate name.

codestring

Item product code, such as universal product code (UPC) or European Article Number (EAN).

skustring

Stock keeping unit (SKU).

priceinteger required

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' required

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 merchant, as opposed to customer price. 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.

stockCountinteger

Deprecated. Use itemStock.quantity.

modifiedTimeinteger

Time when the item was modified.

deletedboolean

Whether the inventory item has been deleted.

Example response

{
  "id": "V0VCQ4DC668E0",
  "available": true,
  "name": "Breakfast Burrito",
  "price": 365,
  "priceType": "FIXED",
  "defaultTaxRates": true,
  "isRevenue": true,
  "modifiedTime": 1746637041000
}