v1

latestOpenAPI 3.1.02026-08-06911,228852.2 KB

Items

Get All Items

Returns the items for a specific business location. Supports searching by accountingGroupId, name, sku, or itemIds.

get/items/v1/items

Query parameters

businessLocationIdinteger required

The unique identifier for the business location.

Example:45454565682155

skustring

A stock keeping unit.

Example:UGG-BB-PUR-06

namestring

The name of the item.

Example:Burger

accountingGroupIdinteger

The unique identifier for the accounting group.

Example:44874545485

itemIdsinteger[]

Optional list of item IDs to retrieve. When provided, offset and amount are ignored; all matching items are returned.

offsetinteger

Offset allows you to retrieve a subset of records starting from a specified position in the dataset. Offset normally works with amount, which designates how many records to retrieve, starting from the offset position.

Example:10

amountinteger

The number of results to return with each request.

Example:10

Response

Item found

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"
}