Get items by business location

GET /items/v1/items

OAuth2

Returns the items for a specific business location. Supports searching by accounting group id, name, or SKU

Query parameters

businessLocationId integer(int64) Required

the id of the businessLocation
sku string

A stock-keeping unit

Minimum length is 1, maximum length is 32.
offset integer(int64)

Offset is the position in the dataset of a particular record. By specifying offset, you retrieve a subset of records starting with the offset value. Offset normally works with amount, which determines how many records to retrieve starting from the offset.

Default value is 0.
amount integer(int64)

Maximum value is 100. Default value is 100.
name string

the name of the object

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

the accounting group id

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
- barcodes array[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
• 404 */*

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

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

Response examples (200)

{
  "accountingGroup": {
    "id": 42,
    "name": "string"
  },
  "active": true,
  "barcode": "string",
  "barcodes": [
    "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"
    }
  ]
}

Response examples (400)

{
  "status": "400",
  "timestamp": "2024-05-04T09:42:00+00:00",
  "message": "string",
  "apiSubExceptions": [
    {
      "field": "string",
      "rejectedValue": "string",
      "message": "string"
    }
  ]
}

Response examples (404)

{
  "status": "404",
  "timestamp": "2024-05-04T09:42:00+00:00",
  "message": "string",
  "apiSubExceptions": [
    {
      "field": "string",
      "rejectedValue": "string",
      "message": "string"
    }
  ]
}