Sign in

v1

latestOpenAPI 3.0.12026-07-242871595.3 MB
INVENTORY

Create an inventory item

Creates an inventory item.

post/v3/merchants/{mId}/items

Path parameters

mIdstring required

Merchant identifier.

Query parameters

expandstring

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

Headers

User-Agentstring required

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

Request body

idstring

Unique identifier of the inventory 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, customer-facing kiosks, and 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

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

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.

isAgeRestrictedboolean

Set to true to create an age-restricted item. If true, ageRestrictedObj must also be provided.

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.

Example request

{
  "ageRestrictedObj": {
    "name": "Alcohol",
    "minimumAge": 21
  }
}

Response

Successful response. Returns the newly created inventory item.

idstring

Unique identifier for the newly created item.

namestring

The name of the item.

priceinteger

The price of the item in cents.

priceType'FIXED' | 'VARIABLE' | 'PER_UNIT'
hiddenboolean
availableboolean
modifiedTimeinteger

Timestamp indicating when the item was created.

isAgeRestrictedboolean

If true, the item requires age verification. The ageRestrictedObj can be retrieved by using expand=ageRestricted.