Body Required
-
The name of the item.
Minimum length is
1
, maximum length is180
. -
businessLocationId integer(int64)
The unique identifier for the business location.
-
docketName string
The name used in the docket for the item.
Maximum length is
64
. -
sku string
A stock keeping unit.
Minimum length is
1
, maximum length is32
. -
active boolean
Indicates whether or not the item is archived from the menu.
-
barcode string
The item barcode.
Maximum length is
64
. -
barcodes array[string]
A list of barcodes associated with the item.
Minimum length of each is
1
, maximum length of each is64
. -
accountingGroupId integer(int64)
The unique identifier for the accounting group. Must be an existing
accountingGroupId
. -
costPrice number
The cost price of the item.
-
defaultPrice number
The default price of the item.
-
priceMode string
The type of price for the item.
Values are
AMOUNT
,PERCENT
,POSITIVE_OPEN_PRICE
, orNEGATIVE_OPEN_PRICE
. Default value isAMOUNT
.
POST /items/v1/items
curl \
-X POST https://api.trial.lsk.lightspeed.app/items/v1/items \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"Burger","businessLocationId":45454565682155,"docketName":"The Burger","sku":"UGG-BB-PUR-06","active":true,"barcode":"10011101100","barcodes":["10011101100"],"accountingGroupId":462478248241,"costPrice":5.0,"defaultPrice":10,"priceMode":"PERCENT"}'
Request examples
{
"name": "Burger",
"businessLocationId": 45454565682155,
"docketName": "The Burger",
"sku": "UGG-BB-PUR-06",
"active": true,
"barcode": "10011101100",
"barcodes": [
"10011101100"
],
"accountingGroupId": 462478248241,
"costPrice": 5.0,
"defaultPrice": 10,
"priceMode": "PERCENT"
}
Response examples (201)
{
"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.0,
"prices": [
{
"amount": 10.0,
"name": "Tuesday Special"
}
],
"sharingType": "SHARED",
"priceMode": "POSITIVE_OPEN_PRICE",
"inventorySource": "PURCHASED",
"disabled": false,
"contentDimension": "MASS",
"contentUom": "kg",
"contentValue": 1,
"itemType": "ITEM"
}
Response examples (404)
{"status"=>"404", "timestamp"=>"2024-05-04T09:42:00+00:00", "message"=>"string", "apiSubExceptions"=>[{"field"=>"string", "rejectedValue"=>"string", "message"=>"string"}]}