Jump to Content
Lightspeed Retail (X-Series) API Documentation Hub
HomeTutorialsAPI ReferenceChangelog
Log InLightspeed Retail (X-Series) API Documentation Hub
Tutorials
Log In
HomeTutorialsAPI ReferenceChangelog

Step by Step Tutorials

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

Introduction

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

Gift Cards

  • Gift Cards

Inventory

  • Creating Stock Orders
  • Inventory Updates
  • Creating Inventory Counts

Loyalty

  • Loyalty 101

Pricebooks

  • Pricebooks

Products

  • Variants
  • Creating Variants
  • Updating Variants
  • 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 - Python with Requests
    • Image Upload Code Sample - Ruby with Typhoeus
    • Image Upload Code Sample - PHP with Guzzle

Promotions

  • Promotions

Registers

  • Closing

Sales

  • Introduction
  • Editing Sales
  • Discounts
  • Returns
  • Fulfillments
  • Statuses
  • Sales with Services

Store Credit

  • Store Credit

Webhooks

  • Webhooks - Example Payloads
  • Webhooks

Workflows

  • Business Rules
  • Custom Fields

Redirect API

  • Redirect API

Client API

  • Sale Hooks
  • Reference
  • Register Hooks
  • Outlet Hooks

Payments API

  • Getting Started
  • Pairing Flow
  • Reference

Third Party Billing

  • Activating a Subscription
  • Updating an Existing Subscription
  • Canceling a Subscription

Deprecations

  • Deprecations
Powered by