Inventoried Items

Release Date: April 12th, 2021

Inventoried Items are defined as: Pre-made units of items that are currently available to purchase by a Retailer.

Depending on your Integration Method, you will provide Lightspeed with these Quantity on Hand values through one of the following methods:

• Direct API Sync with Lightspeed
• Via your Convictional Integration

 

Updating Inventory Values

When integrated directly through Lightspeed, you will update Inventory Quantity by specifying an Array of all items you wish to update:

{
“products”: [
{
“id”: “c5dc1ca6-ef75-4341-a89e-de80c288e292”,
“quantity”: 26543
},
{
“id”: “e100c6af-25f7-4016-a5a1-a573c6951226”,
“quantity”: 900
}
]
}

cURL Example:

curl --location --request PUT 'https://lsapi-product.lightspeedapp.com/inventory' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{TOKEN}}' \
--header 'Cookie: ' \
--data-raw '{
“products”: [
{
“id”: “c5dc1ca6-ef75-4341-a89e-de80c288e292”,
“quantity”: 26543
},
{
“id”: “e100c6af-25f7-4016-a5a1-a573c6951226”,
“quantity”: 900
}
]
}
'

products	the Array name
id	the specific item UUID
quantity	the updated Available Quantity

 

To acquire your item id's, perform the GET request detailed here.

Available Quantity sync intervals

Lightspeed API: Unlimited / as frequently as you prefer

Convictional: Every 15 minutes

 

To review Convictional Inventory Sync documentation, please navigate here:
API Sync Method
SFTP Feed Method

Inventory Flags

Each item will have 2 optional boolean flags that can be defined for your catalog items:

• isBackorderingEnabled
• isInventoryTrackingEnabled

 

Backordering:

Specifies whether the Item can be Ordered after reaching a zero-value available quantity.

 

When enabled (true), this tells the Merchants Backordering is Available:

Merchants who attempt to order more than what is available are presented an error notifying them:

When disabled (false), we display the remaining Quantity, and transition to "Sold Out" once all have been sold:

 

Regardless of your Inventory Setup on each item, we perform a validation on each product in the Cart prior to allowing the Merchant to place the order. If any items/inventory values need to be adjusted, we provide notifications on each line item.

Requirements:
None, defaults to false if not specified

Example:

"inventory": {
"isBackorderingEnabled": [true]
}
_______________________________

"inventory": {
"isBackorderingEnabled": [false]
}

 

Inventory Tracking

Specifies whether you would like to track the Inventory on a specific item. See Non-Inventoried Items for additional information.

Requirements:

None, defaults to false if not specified

Example:

"inventory": {
"isInventoryTrackingEnabled": [true]
}
____________________________________

"inventory": {
"isInventoryTrackingEnabled": [false]
}

You should specify both Backordering and Inventory Tracking in the same array:

"inventory": {
"isBackorderingEnabled": [true | false],
"isInventoryTrackingEnabled": [true | false]
}