Get items by business location

GET /items/v1/items

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

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