Sign in
OpenAPI 3.1.02026-08-21911,278875.0 KB

93b2eed71a61

Items

Create Item

Create a new item for a specific business location.

post/items/v1/items

Request body

namestring required

The name of the item.

businessLocationIdinteger required

The unique identifier for the business location.

docketNamestring

The name used in the docket for the item.

skustring

A stock keeping unit.

activeboolean

Indicates whether or not the item is archived from the menu.

barcodestring

The item barcode.

barcodesstring[]

A list of barcodes associated with the item.

accountingGroupIdinteger required

The unique identifier for the accounting group. Must be an existing accountingGroupId.

costPricenumber

The cost price of the item.

defaultPricenumber required

The default price of the item.

priceMode'AMOUNT' | 'PERCENT' | 'POSITIVE_OPEN_PRICE' | 'NEGATIVE_OPEN_PRICE'

The type of price for the item.

Example request

{
  "name": "Burger",
  "businessLocationId": 45454565682155,
  "docketName": "The Burger",
  "sku": "UGG-BB-PUR-06",
  "active": true,
  "barcode": "10011101100",
  "barcodes": [
    "10011101100"
  ],
  "accountingGroupId": 462478248241,
  "costPrice": 5,
  "defaultPrice": 10,
  "priceMode": "PERCENT"
}

Response

Item created

idinteger

The unique identifier for the item.

namestring

The name of the item.

docketNamestring

The name used in the docket for the item.

skustring

A stock keeping unit.

activeboolean

Indicates whether or not the item is archived from the menu.

barcodestring

The item barcode.

barcodesstring[]

A list of barcodes associated with the item.

costPricenumber

The cost price of the item.

sharingType'GLOBAL_NO_BL' | 'GLOBAL' | 'LOCAL' | 'SHARED'

How the item is shared.

priceMode'AMOUNT' | 'PERCENT' | 'POSITIVE_OPEN_PRICE' | 'NEGATIVE_OPEN_PRICE'

The type of price for the item.

inventorySource'PURCHASED' | 'PRODUCED'

Source of inventory for the item.

disabledboolean

Whether or not stock management is disabled for the item.

contentDimension'DIMENSION_LESS' | 'VOLUME' | 'MASS'

How the item is measured for stock management.

contentUomstring

The unit of measure of the item for stock management.

contentValuenumber

The measurement value.

itemType'ITEM' | 'SEQUENCE' | 'GROUP' | 'SUB_ITEM'

Type of the item.

Example response

{
  "id": 3012455645,
  "name": "Burger",
  "docketName": "The Burger",
  "sku": "UGG-BB-PUR-06",
  "active": true,
  "barcode": "00000001",
  "barcodes": [
    "10011101100"
  ],
  "accountingGroup": {
    "id": 40570261078058,
    "name": "Alcoholic beverages"
  },
  "statisticGroups": [
    {
      "category": "default",
      "value": "Food"
    }
  ],
  "costPrice": 5,
  "prices": [
    {
      "amount": 10,
      "name": "Tuesday Special"
    }
  ],
  "sharingType": "SHARED",
  "priceMode": "POSITIVE_OPEN_PRICE",
  "inventorySource": "PURCHASED",
  "contentDimension": "MASS",
  "contentUom": "kg",
  "contentValue": 1,
  "itemType": "ITEM"
}