Jump to Content

Home Tutorials API Reference Changelog

API Reference

Home Tutorials API Reference Changelog

API 0.9

Customers
- List customersget
- Create or update a customerpost
Outlets
- List outletsget
Payment Types
- List payment typesget
Registers
- List registersget
Register Sales
Suppliers
Taxes
Users
- List usersget

API 2.0

Audit
- List security events for current userget
Brands
Consignments
Consignment Products
Customers
Channel Request Log
Customer Groups
Fulfillment
- List Sale Fulfillmentsget
- Fulfil a salepost
Inventory
- List inventory recordsget
Outlet Product Taxes
- List outlet product taxesget
Outlets
- List outletsget
- Get a single outletget
Payment Types
- List payment typesget
Price Books
Product Categories
Product Images
Product Types
- List product typesget
- Get a single product typeget
Products
Promotions
Quotes
- Get Quoteget
- List Quotesget
Registers
Retailers
- Get information about this retailerget
Sales
Search
- Search for resourcesget
Serial Numbers
Service Orders
Suppliers
Tags
Taxes
- List taxesget
Users
Variant Attributes
Promo Code
- Get the active status of promo codespost
- Delete promo codesdelete
Pick Lists
- List Sale Pick Listsget
Shifts
- List shiftsget

API 2.0 - BETA

Audit
- List audit eventsget
Gift Cards
Partner Billing
Store Credits
Webhooks
Workflows

API 2.1

Products
- Update a productput
- Create a single variantpost

API 3.0 - BETA

Products
- List Productsget
- Get Productget

API 3.0

Price Books

Powered by

Get current user

get https://{domain_prefix}.retail.lightspeed.app/api/2.0/user

Returns the current user.

Language

Credentials

Bearer

JWT

URL

Click Try It! to start a request and see the response here!