Lightspeed Restaurant K-Series API documentation

Update an item

PUT /items/v1/items/{id}

OAuth2

Modifies the values of an existing item.

Path parameters

id integer(int64) Required

application/json

Body Required

name string Required

Minimum length is 1, maximum length is 180.
businessLocationId integer(int64) Required

the id of the businessLocation
docketName string

Maximum length is 64.
sku string Required

Minimum length is 1, maximum length is 32.
active boolean
barcode string

Maximum length is 64.
costPrice number
priceMode string

Values are AMOUNT, PERCENT, POSITIVE_OPEN_PRICE, or NEGATIVE_OPEN_PRICE. Default value is AMOUNT.
defaultPrice number Required
accountingGroupId integer(int64) Required

Needs to be an existing accountingId

Responses

• 200 application/json

Item updated
Hide response attributes Show response attributes object
- accountingGroup object
  
  Hide accountingGroup attributes Show accountingGroup attributes
  
  id integer(int64)
  
  name string
- active boolean
- barcode string
- contentDimension string
  
  Values are DIMENSION_LESS, VOLUME, or MASS.
- contentUom string
- contentValue number
- costPrice number
- disabled boolean
- docketName string
- id integer(int64)
- inventorySource string
  
  Values are PURCHASED or PRODUCED.
- itemType string
  
  Values are ITEM, SEQUENCE, GROUP, or SUB_ITEM.
- name string
- priceMode string
  
  Values are AMOUNT, PERCENT, POSITIVE_OPEN_PRICE, or NEGATIVE_OPEN_PRICE. Default value is AMOUNT.
- prices array[object]
  
  Hide prices attributes Show prices attributes object
  
  amount number
  
  name string
- sharingType string
  
  Values are GLOBAL_NO_BL, GLOBAL, LOCAL, or SHARED.
- sku string
- statisticGroups array[object]
  
  Hide statisticGroups attributes Show statisticGroups attributes object
  
  category string
  
  value string
• 400 */*

Constraint violation
Hide response attributes Show response attributes object
- status string
  
  Value is 400.
- timestamp string(date-time)
- message string
- apiSubExceptions array[object]
  
  Hide apiSubExceptions attributes Show apiSubExceptions attributes object
  
  field string
  
  rejectedValue string
  
  message string

PUT /items/v1/items/{id}

curl \
 -X PUT https://api.trial.lsk.lightspeed.app/items/v1/items/3012455645 \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"name":"cola","businessLocationId":45454565682155,"docketName":"docketName","sku":"sku123577","active":true,"barcode":"10011101100","costPrice":42.0,"priceMode":"PERCENT","defaultPrice":3,"accountingGroupId":462478248241}'

Request example

{
  "name": "cola",
  "businessLocationId": 45454565682155,
  "docketName": "docketName",
  "sku": "sku123577",
  "active": true,
  "barcode": "10011101100",
  "costPrice": 42.0,
  "priceMode": "PERCENT",
  "defaultPrice": 3,
  "accountingGroupId": 462478248241
}

Response examples (200)

{
  "accountingGroup": {
    "id": 42,
    "name": "string"
  },
  "active": true,
  "barcode": "string",
  "contentDimension": "DIMENSION_LESS",
  "contentUom": "string",
  "contentValue": 42.0,
  "costPrice": 42.0,
  "disabled": true,
  "docketName": "string",
  "id": 42,
  "inventorySource": "PURCHASED",
  "itemType": "ITEM",
  "name": "string",
  "priceMode": "AMOUNT",
  "prices": [
    {
      "amount": 42.0,
      "name": "string"
    }
  ],
  "sharingType": "GLOBAL_NO_BL",
  "sku": "string",
  "statisticGroups": [
    {
      "category": "string",
      "value": "string"
    }
  ]
}