Sign in

v1

latestOpenAPI 3.0.12026-07-242871595.3 MB
INVENTORY

Get all items in a single category

Retrieves all items in a category.

get/v3/merchants/{mId}/categories/{catId}/items

Path parameters

mIdstring required

Merchant identifier.

catIdstring required

Category identifier.

Query parameters

filterstring

Filter fields to display search results: [modifiedTime, deleted, sortOrder, name, colorCode, id]

expandstring

Expandable fields to display additional nested information: [categories, itemStock, modifierRates, options, tags, taxRates]

offsetinteger

Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.

limitinteger

Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000

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 all items in a category.

idstring

Merchant identifier (mId).

hiddenboolean

Indicates whether the inventory item does not display on the Register app.

availableboolean

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

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

Name of the item.

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

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 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.

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.