Jump to Content

Home Tutorials API Reference Changelog

Tutorials

Home Tutorials API Reference Changelog

All

Pages

Start typing to search…

Step by Step Tutorials

Quick Start
How to React to Lightspeed Retail (X-Series) Events
Syncing an Entity to an External System
Synchronizing Sales from External Systems into Lightspeed Retail (X-Series)

Introduction

Authorization
Data Security
Versioning Strategy
Dates and Times
Introduction to the Lightspeed Retail (X-Series) API
Outbound Request Origins
Pagination
Rate Limiting
Request Format
OAuth Scopes
User Agent

Gift Cards

Gift Cards

Inventory

Creating Inventory Counts
Creating Stock Orders
Inventory Updates

Loyalty

Loyalty 101

Pricebooks

Pricebooks

Products

Creating Composite Products
Updating Composite Products
Image Upload Basics
Image Upload Code Sample - Golang
Image Upload Code Sample - Java with Jersey
Image Upload Code Sample - JavaScript with Request
Image Upload Code Sample - JavaScript with Superagent
Image Upload Code Sample - PHP with Guzzle
Image Upload Code Sample - Python with Requests
Image Upload Code Sample - Ruby with Typhoeus
Variants
Creating Variants
Updating Variants

Promotions

Promotions

Registers

Closing

Sales

Introduction
Discounts
Editing Sales
Fulfillments
Returns
Sales with Services
States and attributes
Statuses
Delivery Sales with Customer Addresses

Service Orders

Introduction

Store Credit

Store Credit

Webhooks

Webhooks
Webhooks - Example Payloads

Workflows

Business Rules
Custom Fields

Redirect API

Redirect API

Client API

Outlet Hooks
Reference
Register Hooks
Sale Hooks

Payments API

Getting Started
Pairing Flow
Reference

Third Party Billing

Activating a Subscription
Canceling a Subscription
Updating an Existing Subscription

Ecommerce

Theme Filters
Theme Objects

Miscellaneous

Community Client Libraries
Interesting Projects

Deprecations

Deprecations

Fulfillments

Fulfillments

Release notes

2026-01

Powered by

Introduction

Updated 3 months ago