Lightspeed Restaurant K-Series API documentation

Get item by Id

GET /items/v1/items/{id}

OAuth2

Returns the details of a specific item.

Path parameters

id integer(int64) Required

Query parameters

businessLocationId integer(int64) Required

the id of the businessLocation

Responses

• 200 application/json

Item found
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
• 404 */*

Item not found
Hide response attributes Show response attributes object
- status string
  
  Value is 404.
- timestamp string(date-time)
- message string
- apiSubExceptions array[object]
  
  Hide apiSubExceptions attributes Show apiSubExceptions attributes object
  
  field string
  
  rejectedValue string
  
  message string

GET /items/v1/items/{id}

curl \
 -X GET https://api.trial.lsk.lightspeed.app/items/v1/items/3012455645?businessLocationId=45454565682155 \
 -H "Authorization: Bearer $ACCESS_TOKEN"

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