FAQ

Menus and Items

Menu and Item Sync

QUESTION

How can we retrieve the IDs for all items, categories, and menus from the Lightspeed API?

ANSWER

• You can retrieve all items using the GET Items endpoint.
• All accounting groups (item categories) can be retrieved using the GET Accounting Groups endpoint.
• All menus can be retrieved using the GET Menus endpoint.

QUESTION

What is the recommended approach for syncing item price changes between our integration and Lightspeed?

ANSWER

• The recommended approach is to perform nightly syncs for pricing and other item updates, using the Items API, or the Online Ordering API's menu endpoint.

QUESTION

Does Lightspeed provide webhooks or notifications for item price updates that we can subscribe to?

ANSWER

• Currently, there are no webhooks for menu or pricing updates.

Updating Items

QUESTION

Are there specific endpoints or batch processes for updating item prices in bulk?

ANSWER

• There is an Update an Item endpoint, but no specific endpoint for batch or bulk updates.

NOTE

In order for item changes to be reflected in the POS, the K-Series POS app must be reloaded.

A notification to direct onsite staff to reload the POS can be sent using the Print Message endpoint, which prints a message on the receipt printer and displays a popup notification on the POS app.

Item Settings

QUESTION

What does "Active" mean in the Items API

ANSWER

• "Active" indicates whether or not the item is archived from the menu.

QUESTION

What does it mean when an item is "Disabled"?

ANSWER

• If "Disabled" is true, it means that the recording of stock movements for this item is disabled in the back office. More information on stock movements can be found here.

Sub-Items

QUESTION

Are the prices of Sub-Items included in the price of the containing item, or in addition to it?

ANSWER

• Sub-item prices can either be included in the parent item price or defined as an additional cost by adding a default price for the sub-item. See Sub-Items for more details.

QUESTION

Can any sub-items be added to any main items?

ANSWER

• Yes, sub-items can be added to main items without restrictions.

Managing Orders

Order Creation

QUESTION

Is there an API endpoint for creating or updating orders in Lightspeed?

ANSWER

• Yes, orders can be created using the Create Local Order endpoint or the Create To Go Order endpoint.
• Orders can be updated using the Create Local Order endpoint by providing the accountIdentifier of the order you wish to update.

QUESTION

What data does Lightspeed require to synchronize orders placed from our integration?

ANSWER

• Order request payload requirements can be found in the Online Ordering Sample Payloads and the API Reference.

QUESTION

How are online order surcharges handled?

ANSWER

• Surcharges can be handled using the Service Charge feature, assigned to an Order Profile.

Refunds

QUESTION

What is the recommended workflow for handling refunds through the Lightspeed API?

ANSWER

• When an online order is voided on the POS, a webhook with the CANCELLED status is sent, allowing you to handle this event on your end.
• Currently, there is no endpoint to void a receipt; partial or full refunds must be completed on the POS.
• More details can be found in the Editing and Reviewing Orders guide.

QUESTION

Are there specific endpoints for processing refunds or updating the status of an order to "refunded"?

ANSWER

• No specific endpoints exist for processing refunds using the API. This process must be managed through the POS. See Managing and Refunding Receipts

More

For more answers to frequently asked questions, please see our Quick Start Guide