Lightspeed Commerce website screenshot

Lightspeed Commerce

Omnichannel commerce platform with REST APIs for retail and restaurant POS, inventory management, loyalty programs, and e-commerce integrations. Lightspeed serves retailers and restaurateurs with cloud-based point-of-sale systems, enabling custom integrations through APIs for sales, inventory, customers, orders, payments, and loyalty programs across multiple product lines including Retail X-Series, Retail R-Series, Restaurant K-Series, and eCom.

Lightspeed Commerce publishes 58 API contracts indexed on the APIs.io network, including Lightspeed eCom API, Audit API, Brands API, and 55 more. Tagged areas include Commerce, Point-of-Sale, Retail, Restaurant, and Inventory.

The Lightspeed Commerce catalog on APIs.io includes 1 event-driven AsyncAPI specification, 1 JSON-LD context, and 1 Spectral governance ruleset.

Lightspeed Commerce’s developer surface includes authentication, documentation, engineering blog, pricing, support, signup flow, sandbox, and 52 more developer resources.

83.8/100 exemplar ▬ flat Agent 43/100 agent ready saas Full breakdown ↓
scored 2026-10-17 · rubric v0.24.0
3 published contracts 1 MCP Servers
CommercePoint-of-SaleRetailRestaurantInventoryLoyaltyPaymentsE-CommerceOmnichannelCanada

What this lets a business do 10

Business capabilities this provider's published APIs can perform, derived from its own contracts. Browse all capabilities →

Product Information Management
BC-2370
ItemsProduct CategoriesProduct ImagesProductsRich Item
POST /products POST /product_categories/bulk POST /items/v1/items GET /product_images/{product_image_id}
Customer Relationship Management
BC-420
Customer AddressesCustomer GroupsCustomersLoyalty Adjustments [BETA]
POST /customers GET /customers/{customer_id}/addresses POST /customer_groups POST /customer_groups/{customer_group_id}/customers
Pricing Management
BC-440
Price BooksPromo CodePromotions
POST /price_books PATCH /price_books/{price_book_id}/products POST /discount POST /promotions
Point of Sale Operations Management
BC-2320
Gift CardsSales
POST /sales POST /sales/{sale_id}/actions/return POST /gift_cards POST /gift_cards/{card_number}/transactions
Inventory Management
BC-530
Inventory
POST /inventory POST /inventory/reorder_points POST /inventory_levels GET /stock_adjustments
Procurement Management
BC-500
Purchase Orders
GET /purchase_orders GET /purchase_orders/{purchase_order_id}/deliveries
Omnichannel Order & Fulfilment Management
BC-2330
Fulfillments
POST /fulfillments/fulfill POST /fulfillments/{fulfillment_id}/pick
Developer Platform & API Ecosystem Management
BC-4270
Order and Pay: Webhook
PUT /o/wh/1/webhook
Supplier Management
BC-510
Suppliers
POST /suppliers
Product Lifecycle Management
BC-820
Variant Attributes
POST /variant_attributes

What people ask Lightspeed Commerce 52

The questions people put to an LLM, and the jobs they hand an agent, that Lightspeed Commerce's APIs answer — each one linked to the operation that does it. Generated by API Evangelist

Lightspeed Commerce Order and Pay API List businesses and locations for my token “Which businesses and business locations can my access token reach?” List a location's floorplans “What floorplans are set up for my restaurant location?” List the tables on one floorplan “Which tables are on a particular floorplan in my venue?” List active order profiles for a location “What order profiles are active at my business location?”
Lightspeed Commerce Staff API List staff shifts at a business location “Which staff members clocked shifts at my restaurant last week?” List POS users at a business location “Who has a login on the point-of-sale devices at this venue?” Create a POS user “How do I add a new server or cashier who logs in on the POS terminal?” Update an existing POS user “Can I change the PIN code or roles of a POS user who already exists?”
Lightspeed Commerce Workflows API List custom field definitions for an entity “What custom fields are defined on sales or products in my store?” Define a new custom field “How do I add a new custom field to products or customers?” Get custom field values on a record “What custom field values are stored on a specific sale or customer?” Set custom field values on a record “How do I save custom field values onto a particular customer or sale?”
Lightspeed Commerce Reservations for Platforms API Complete restaurant onboarding for a platform “After I receive the onboarding webhook, how do I finish connecting the restaurant?” Get a reservation platform's profile “What webhook URLs and settings are saved on my reservation platform profile?” Create or update a reservation platform profile “How do I register my booking platform with its display name and webhook URLs?” Configure a platform's course settings “Can my reservation platform be allowed to update course numbers?”
Lightspeed Commerce Gift Cards API List gift cards “Which gift cards have been issued by my store?” Issue and activate a new gift card “How do I sell a new gift card with a starting balance?” Void a gift card by its internal ID “Can I cancel a gift card using its internal ID so its balance goes to zero?” Look up a gift card by its internal ID “Can I fetch a gift card and its transaction history using its internal ID rather than the card number?”
Lightspeed Commerce Rich Item API List allergens available for rich items “Which allergens can I tag on a menu item?” Get a business's item languages “Which languages are my item descriptions set up in?” Set a business's item languages “How do I add French as an item language for my business?” List all rich items for a business “How do I get all rich item descriptions and allergens for my business?”
Lightspeed Commerce Price Books API List price book products across all books “Which products have special prices across all my price books?” List price books “What price books do I have set up for customer groups and outlets?” Create a price book “How do I create special pricing for a customer group at certain outlets?” Get a single price book “Which outlets and customer groups does a specific price book cover?”
Lightspeed Commerce Service Orders API List a customer's service items “Which items has a customer brought in for repair or service?” List service order statuses “What statuses can a service order move through in my store?” Create a custom service status “How do I add a custom stage like 'Waiting for parts' to service orders?” Delete a custom service status “Can I delete a custom service status that is no longer used?”
Lightspeed Commerce Inventory API List custom inventory adjustment reasons “What custom reasons have we set up for adjusting stock?” Create a custom inventory adjustment reason “How do I add a new reason like 'water damage' for stock adjustments?” Rename or toggle an adjustment reason “How do I disable a custom stock adjustment reason we no longer use?” List inventory records across products “How do I pull inventory records for all products and outlets?”
Lightspeed Commerce Store Credits API List store credit customers and recent activity “Which customers have store credit and what have they done with it lately?” Get store credit balances in bulk “How do I get just the balances of all store credit customers in one call?” Get store credit customers and history in bulk “Can I bulk-fetch store credit customers with their recent transaction lists?” Get the store credit report “Where can I see a report of all store credit in my store?”
Lightspeed Commerce Financial API List businesses and their locations “Which businesses and restaurant locations can my API token see?” Get tax rates for a location “What tax rates are configured for my restaurant?” List payment methods for a location “Which payment methods, like card or cash, are set up at a venue?” List accounting groups for a location “What accounting groups are items assigned to at my restaurant?”
Lightspeed Commerce Products API List products in the catalog “How do I list all products in my retail catalog?” Create a new product “How do I add a new product with a price and SKU?” Delete a product or single variant “How do I delete one product or just one of its variants?” Get a single product “How do I fetch the full details of one product by ID?”

Showing 12 of 52 APIs with phrasing — see every API.

Kin Score

Kin Score Kin Score How this is scored →
scored 2026-10-17 · rubric v0.24.0
Regulatory Posture applies to this provider. Its tags matched the Payments regime, so Regulatory Posture carries 15 points of the composite. If this regime is wrong for your business, say so on your provider repo — the applicability map is public and we will correct it.
Create-or-Update Ergonomics applies to this provider. This API accepts writes, so it carries 10 points of the composite. It is scored from the published contracts themselves: whether a caller can create-or-update in one call, whether the write accepts a key the caller already holds, and whether the response says which branch ran. Without that, every write needs a search-and-branch in front of it, and the first time that check is skipped a duplicate record is created. Scored against the observed mean rather than raw — a provider at the catalog average is unchanged by this facet, not penalised by it.
The six quality facets above are damped to 75 points between them, because the conditional facet above carries the other 25. That is why each facet's contribution is shown against a damped maximum: raising a quality facet moves the composite by 75% of its nominal weight, not 100%. The full arithmetic is at apis.io/rating/.
Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. Every facet and dimension name above is a link: it opens that measurement's own page — what it means, the exact checks that feed it, how the whole catalog distributes on it, and the providers at the top of it. This rating is computed from github.com/api-evangelist/lightspeed: open an issue to ask a question, or submit a pull request to add artifacts. Submit an artifact on GitHub — free → Manage your own listing — the Influence plan, $499/mo →

Markets this provider is in provisional

The Kin Score Market layer reads a provider inside its market: its position, and how deep its integrations go. Depth is only comparable within a position. Provisional and unweighted: not part of the Kin Score or agent readiness.

MarketPositionDepthRegistered MCP serverDeclares compatibility
Commerce and CRM list 38.7 - -
Restaurants and POS list 38.7 - -

Registered MCP server and declares compatibility are report only — not weighted. Undeclared means we found nothing we can read, so there is no number: we never infer integrations.

APIs 58

Individual APIs this provider publishes, each with its own machine-readable definition.

Lightspeed Retail R-Series API

REST API for Lightspeed Retail R-Series (formerly Vend) providing access to sales, inventory, customers, products, and reporting data for retail point-of-sale systems.

Lightspeed eCom API

REST API for Lightspeed eCom (C-Series) e-commerce platform providing endpoints for products, orders, customers, shipments, payments, and inventory management. Requires Advanced...

Lightspeed eCom E-Series (Ecwid) API

REST API for Lightspeed eCom E-Series, the Ecwid storefront platform Lightspeed acquired in 2021 and now sells as eCom E-Series. Provides store profile, product catalog, categor...

Lightspeed Restaurant O-Series (Kounta) API

REST API for Lightspeed Restaurant O-Series, the Kounta hospitality point-of-sale platform Lightspeed acquired in 2019 and sells as O-Series. Exposes sites, registers, products,...

Lightspeed Golf (Chronogolf) Partner API

Partner REST API for Lightspeed Golf, the Chronogolf tee-sheet and golf course management platform Lightspeed acquired in 2019. Covers organizations, courses, tee times, green f...

Lightspeed Commerce Audit API

Audit and security operations

Lightspeed Commerce Channel Request Log API

A log of requests and responses between Lightspeed and an integration channel.

Lightspeed Commerce Consignment Products API

Consignment Product operations

Lightspeed Commerce Consignments API

Stock control operations

Lightspeed Commerce Customer Addresses API

Customer Address operations

Lightspeed Commerce Customer Groups API

Customer Group operations

Lightspeed Commerce Financial API

V1 endpoints (`/f/finance/...`) for retrieving sales and financial data. For the newer V2 versions of these endpoints see FinancialV2 ### V1 behaviour - **Sorting**: No guarante...

Lightspeed Commerce Financial V2 API

V2 endpoints (`/f/v2/...`) for retrieving sales and financial data. ### Endpoint Mapping | V1 Endpoint | V2 Endpoint | |-------------|-------------| | `getFinancials` (`/f/finan...

Lightspeed Commerce Fulfillments API

Fulfillment operations

Lightspeed Commerce ID Cards API

The ID Cards API from Lightspeed Commerce — 2 operation(s) for id cards.

Lightspeed Commerce Inventory API

Inventory operations

Lightspeed Commerce Items API

The Items API from Lightspeed Commerce — 2 operation(s) for items.

Lightspeed Commerce Loyalty Adjustments [BETA] API

The Loyalty Adjustments [BETA] API from Lightspeed Commerce — 1 operation(s) for loyalty adjustments [beta].

Lightspeed Commerce Order and Pay API

The Order and Pay API from Lightspeed Commerce — 19 operation(s) for order and pay.

Lightspeed Commerce Order and Pay: Webhook API

The Order and Pay: Webhook API from Lightspeed Commerce — 4 operation(s) for order and pay: webhook.

Lightspeed Commerce Outlet Product Taxes API

Outlet Product Tax operations

Lightspeed Commerce Packing Slips API

Packing slip rendering operations

Lightspeed Commerce Partner Billing API

Partner Billing operations

Lightspeed Commerce Payment Types API

Payment Type operations

Lightspeed Commerce PMS API

The PMS API from Lightspeed Commerce — 3 operation(s) for pms.

Lightspeed Commerce PMS Integration API

The PMS Integration API from Lightspeed Commerce — 0 operation(s) for pms integration.

Lightspeed Commerce Product Categories API

Product Categories operations

Lightspeed Commerce Product Images API

Product Image operations

Lightspeed Commerce Product Types API

Product Type operations

Lightspeed Commerce Promo Code API

The Promo Code API from Lightspeed Commerce — 2 operation(s) for promo code.

Lightspeed Commerce Purchase Orders API

Purchase order operations

Lightspeed Commerce Reservations for Platforms API

The Reservations for Platforms API from Lightspeed Commerce — 11 operation(s) for reservations for platforms.

Lightspeed Commerce Rich Item API

The Rich Item API from Lightspeed Commerce — 6 operation(s) for rich item.

Lightspeed Commerce Search API

Search related operations

Lightspeed Commerce Serial Numbers API

Serial number related operations

Lightspeed Commerce Service Orders API

Service orders and Job management

Lightspeed Commerce Shifts API

The Shifts API from Lightspeed Commerce — 1 operation(s) for shifts.

Lightspeed Commerce Staff API

Staff API. Authorisation Code grant type is required for this API with permission ROLE_CONFIG_USERS.

Lightspeed Commerce Store Credits API

Store Credit operations

Lightspeed Commerce Tax Breakdown API

The Tax Breakdown API from Lightspeed Commerce — 1 operation(s) for tax breakdown.

Lightspeed Commerce Variant Attributes API

The Variant Attributes API from Lightspeed Commerce — 2 operation(s) for variant attributes.

Scroll for all 58

MCP Servers 1

Model Context Protocol servers that expose these APIs to AI agents.

Lightspeed Commerce MCP Servers

Lightspeed runs two hosted, anonymous MCP servers — one per documentation platform. Both are documentation-plane servers: they let an agent read and search the API contract. Onl...

MCP SERVER

Pricing Plans 1

Published pricing tiers and plan structures.

Rate Limits 1

Documented rate limits and quota policies.

Lightspeed Rate Limits

6 limits

RATE LIMITS

FinOps 1

Cost, billing, and metering signals for API financial operations.

Event Specifications 1

AsyncAPI definitions for this provider's event-driven and streaming APIs.

Semantic Vocabularies 1

JSON-LD contexts and semantic vocabularies used across these APIs.

Lightspeed Context

120 classes · 311 properties

JSON-LD

Spectral Rules 1

Spectral governance rulesets for linting and validating these APIs.

Lightspeed Commerce API Rules

14 rules · 10 errors 2 warnings 2 info

SPECTRAL

OpenAPI Overlays 54

Overlays applied on top of this provider's contracts. Each card says who wrote it: a document the provider publishes, or one API Evangelist derived or generated.

Lightspeed Audit Api Phrasing Overlay

3 actions · phrasing · lightspeed-audit-api-openapi.yml

GENERATED

Lightspeed Brands Api Phrasing Overlay

6 actions · phrasing · lightspeed-brands-api-openapi.yml

GENERATED

Lightspeed Channel Request Log Api Phrasing Overlay

5 actions · phrasing · lightspeed-channel-request-log-api-openapi.yml

GENERATED

Lightspeed Consignment Products Api Phrasing Overlay

6 actions · phrasing · lightspeed-consignment-products-api-openapi.yml

GENERATED

Lightspeed Consignments Api Phrasing Overlay

7 actions · phrasing · lightspeed-consignments-api-openapi.yml

GENERATED

Lightspeed Customer Addresses Api Phrasing Overlay

6 actions · phrasing · lightspeed-customer-addresses-api-openapi.yml

GENERATED

Lightspeed Customer Groups Api Phrasing Overlay

8 actions · phrasing · lightspeed-customer-groups-api-openapi.yml

GENERATED

Lightspeed Customers Api Phrasing Overlay

6 actions · phrasing · lightspeed-customers-api-openapi.yml

GENERATED

Lightspeed Financial Api Phrasing Overlay

9 actions · phrasing · lightspeed-financial-api-openapi.yml

GENERATED

Lightspeed Financialv2 Api Phrasing Overlay

5 actions · phrasing · lightspeed-financialv2-api-openapi.yml

GENERATED

Lightspeed Fulfillments Api Phrasing Overlay

7 actions · phrasing · lightspeed-fulfillments-api-openapi.yml

GENERATED

Lightspeed Gift Cards Api Phrasing Overlay

12 actions · phrasing · lightspeed-gift-cards-api-openapi.yml

GENERATED

Lightspeed Id Cards Api Phrasing Overlay

3 actions · phrasing · lightspeed-id-cards-api-openapi.yml

GENERATED

Lightspeed Inventory Api Phrasing Overlay

11 actions · phrasing · lightspeed-inventory-api-openapi.yml

GENERATED

Lightspeed Items Api Phrasing Overlay

5 actions · phrasing · lightspeed-items-api-openapi.yml

GENERATED

Lightspeed K Series Overlay

6 actions · update · lightspeed-k-series-openapi.json

GENERATED

Lightspeed Loyalty Adjustments Beta Api Phrasing Overlay

2 actions · phrasing · lightspeed-loyalty-adjustments-beta-api-openapi.yml

GENERATED

Lightspeed Order And Pay Api Phrasing Overlay

21 actions · phrasing · lightspeed-order-and-pay-api-openapi.yml

GENERATED

Lightspeed Order And Pay Webhook Api Phrasing Overlay

8 actions · phrasing · lightspeed-order-and-pay-webhook-api-openapi.yml

GENERATED

Lightspeed Outlet Product Taxes Api Phrasing Overlay

2 actions · phrasing · lightspeed-outlet-product-taxes-api-openapi.yml

GENERATED

Lightspeed Outlets Api Phrasing Overlay

3 actions · phrasing · lightspeed-outlets-api-openapi.yml

GENERATED

Lightspeed Packing Slips Api Phrasing Overlay

3 actions · phrasing · lightspeed-packing-slips-api-openapi.yml

GENERATED

Lightspeed Partner Billing Api Phrasing Overlay

6 actions · phrasing · lightspeed-partner-billing-api-openapi.yml

GENERATED

Lightspeed Payment Types Api Phrasing Overlay

2 actions · phrasing · lightspeed-payment-types-api-openapi.yml

GENERATED

Lightspeed Pms Api Phrasing Overlay

7 actions · phrasing · lightspeed-pms-api-openapi.yml

GENERATED

Lightspeed Price Books Api Phrasing Overlay

11 actions · phrasing · lightspeed-price-books-api-openapi.yml

GENERATED

Lightspeed Product Categories Api Phrasing Overlay

4 actions · phrasing · lightspeed-product-categories-api-openapi.yml

GENERATED

Lightspeed Product Images Api Phrasing Overlay

4 actions · phrasing · lightspeed-product-images-api-openapi.yml

GENERATED

Lightspeed Product Types Api Phrasing Overlay

3 actions · phrasing · lightspeed-product-types-api-openapi.yml

GENERATED

Lightspeed Products Api Phrasing Overlay

9 actions · phrasing · lightspeed-products-api-openapi.yml

GENERATED

Lightspeed Promo Code Api Phrasing Overlay

3 actions · phrasing · lightspeed-promo-code-api-openapi.yml

GENERATED

Lightspeed Promotions Api Phrasing Overlay

9 actions · phrasing · lightspeed-promotions-api-openapi.yml

GENERATED

Lightspeed Purchase Orders Api Phrasing Overlay

6 actions · phrasing · lightspeed-purchase-orders-api-openapi.yml

GENERATED

Lightspeed Quotes Api Phrasing Overlay

3 actions · phrasing · lightspeed-quotes-api-openapi.yml

GENERATED

Lightspeed Registers Api Phrasing Overlay

8 actions · phrasing · lightspeed-registers-api-openapi.yml

GENERATED

Lightspeed Reservations For Platforms Api Phrasing Overlay

13 actions · phrasing · lightspeed-reservations-for-platforms-api-openapi.yml

GENERATED

Lightspeed Retailers Api Phrasing Overlay

2 actions · phrasing · lightspeed-retailers-api-openapi.yml

GENERATED

Lightspeed Rich Item Api Phrasing Overlay

11 actions · phrasing · lightspeed-rich-item-api-openapi.yml

GENERATED

Lightspeed Sales Api Phrasing Overlay

6 actions · phrasing · lightspeed-sales-api-openapi.yml

GENERATED

Lightspeed Search Api Phrasing Overlay

2 actions · phrasing · lightspeed-search-api-openapi.yml

GENERATED

Lightspeed Serial Numbers Api Phrasing Overlay

5 actions · phrasing · lightspeed-serial-numbers-api-openapi.yml

GENERATED

Lightspeed Service Orders Api Phrasing Overlay

11 actions · phrasing · lightspeed-service-orders-api-openapi.yml

GENERATED

Lightspeed Shifts Api Phrasing Overlay

2 actions · phrasing · lightspeed-shifts-api-openapi.yml

GENERATED

Lightspeed Staff Api Phrasing Overlay

18 actions · phrasing · lightspeed-staff-api-openapi.yml

GENERATED

Lightspeed Store Credits Api Phrasing Overlay

10 actions · phrasing · lightspeed-store-credits-api-openapi.yml

GENERATED

Lightspeed Suppliers Api Phrasing Overlay

6 actions · phrasing · lightspeed-suppliers-api-openapi.yml

GENERATED

Lightspeed Tags Api Phrasing Overlay

6 actions · phrasing · lightspeed-tags-api-openapi.yml

GENERATED

Lightspeed Tax Breakdown Api Phrasing Overlay

2 actions · phrasing · lightspeed-tax-breakdown-api-openapi.yml

GENERATED

Lightspeed Taxes Api Phrasing Overlay

4 actions · phrasing · lightspeed-taxes-api-openapi.yml

GENERATED

Lightspeed Users Api Phrasing Overlay

8 actions · phrasing · lightspeed-users-api-openapi.yml

GENERATED

Lightspeed Variant Attributes Api Phrasing Overlay

6 actions · phrasing · lightspeed-variant-attributes-api-openapi.yml

GENERATED

Lightspeed Webhooks Api Phrasing Overlay

6 actions · phrasing · lightspeed-webhooks-api-openapi.yml

GENERATED

Lightspeed Workflows Api Phrasing Overlay

13 actions · phrasing · lightspeed-workflows-api-openapi.yml

GENERATED

Lightspeed X Series Overlay

7 actions · update · lightspeed-x-series-openapi.json

GENERATED

Scroll for all 54

JSON Schema 183

Standalone JSON Schema definitions for this provider's data models.

apeAccountSnapshot

19 properties

JSON SCHEMA

apeCustomerInfo

9 properties

JSON SCHEMA

apeLocalOrderItemLine

10 properties

JSON SCHEMA

apeMenuV2

5 properties

JSON SCHEMA

apeStandalonePayment

12 properties

JSON SCHEMA

apeToGoOrderItemLine

9 properties

JSON SCHEMA

apeWebhookEndpointBusinessLocationDto

4 properties

JSON SCHEMA

apeWebhookEndpoint

9 properties

JSON SCHEMA

Audit Log Event

11 properties

JSON SCHEMA

Brand

2 properties

JSON SCHEMA

Brand Collection

2 properties

JSON SCHEMA

Brand Response

1 properties

JSON SCHEMA

Business Rule

4 properties

JSON SCHEMA

ButtonLayoutCollection

3 properties

JSON SCHEMA

ButtonLayout

5 properties

JSON SCHEMA

Channels response

1 properties

JSON SCHEMA

Consignment Collection

2 properties

JSON SCHEMA

Consignment Product Collection

1 properties

JSON SCHEMA

Consignment Product Request

1 properties

JSON SCHEMA

Consignment Product Response

1 properties

JSON SCHEMA

Consignment Product

11 properties

JSON SCHEMA

Consignment Request

1 properties

JSON SCHEMA

Consignment Response

1 properties

JSON SCHEMA

ConsignmentTotalsResponse

1 properties

JSON SCHEMA

CreateSupplierRequest

0 properties

JSON SCHEMA

CreateTagRequest

1 properties

JSON SCHEMA

CreateTaxRequest

5 properties

JSON SCHEMA

Custom Field Definition Parameters

7 properties

JSON SCHEMA

Custom Field Definition

8 properties

JSON SCHEMA

Custom Field Value Parameters

3 properties

JSON SCHEMA

Customer Address Base

9 properties

JSON SCHEMA

Customer Address Collection

1 properties

JSON SCHEMA

Customer Address Create Response

1 properties

JSON SCHEMA

Customer Address Response

1 properties

JSON SCHEMA

Customer Base

37 properties

JSON SCHEMA

Customer Collection

2 properties

JSON SCHEMA

Customer Group Collection

2 properties

JSON SCHEMA

Customer Group Response

1 properties

JSON SCHEMA

Customer Group

8 properties

JSON SCHEMA

Customer Response

1 properties

JSON SCHEMA

DailyAgenda

2 properties

JSON SCHEMA

DetailedService

3 properties

JSON SCHEMA

financial-apiAbortedOrderDto

4 properties

JSON SCHEMA

financial-apiFinancialDto

6 properties

JSON SCHEMA

financial-apiLSPaymentsDto

4 properties

JSON SCHEMA

financial-apiResourcesTaxRate

2 properties

JSON SCHEMA

financial-apiSaleDto

22 properties

JSON SCHEMA

financial-apiSalesDailyExportDto

3 properties

JSON SCHEMA

financial-apiSalesExportDto

2 properties

JSON SCHEMA

FulfillLineItemsRequest

2 properties

JSON SCHEMA

FulfillLineItemsResponse

1 properties

JSON SCHEMA

FulfillmentHistoryResponse

2 properties

JSON SCHEMA

GetUsersByIdsRequest

0 properties

JSON SCHEMA

Gift Card Activation Parameters

5 properties

JSON SCHEMA

Gift Card Collection

1 properties

JSON SCHEMA

Gift Card

11 properties

JSON SCHEMA

Gift Card Response

1 properties

JSON SCHEMA

Gift Card Transaction Parameters

6 properties

JSON SCHEMA

Gift Card Transaction Response

1 properties

JSON SCHEMA

id-cards-apiCreateIdCardBatchRequest

1 properties

JSON SCHEMA

id-cards-apiCreateIdCardsRequest

1 properties

JSON SCHEMA

id-cards-apiCreateIdCardsResponse

2 properties

JSON SCHEMA

id-cards-apiIdCardBatch

3 properties

JSON SCHEMA

Image Position

1 properties

JSON SCHEMA

Image Response

1 properties

JSON SCHEMA

Inventory Count Item Response

1 properties

JSON SCHEMA

InventoryLevel

15 properties

JSON SCHEMA

InventoryLevelsRequest

12 properties

JSON SCHEMA

InventoryRequest

7 properties

JSON SCHEMA

Inventory

12 properties

JSON SCHEMA

items-apiCreateItemDTO

11 properties

JSON SCHEMA

items-apiItemDTO

19 properties

JSON SCHEMA

items-apiUpdateItemDTO

11 properties

JSON SCHEMA

LoyaltyAdjustmentCreateBody

2 properties

JSON SCHEMA

LoyaltyAdjustmentResponse

2 properties

JSON SCHEMA

Outlet Collection

2 properties

JSON SCHEMA

Outlet Response

1 properties

JSON SCHEMA

OutletTaxCollection

2 properties

JSON SCHEMA

PackLineItemsRequest

2 properties

JSON SCHEMA

PackLineItemsResponse

1 properties

JSON SCHEMA

Partial Packing Slip Request

2 properties

JSON SCHEMA

PartnerSubscription

3 properties

JSON SCHEMA

PartnerSubscriptionTokenRequest

5 properties

JSON SCHEMA

PartnerSubscriptionTokenResponse

3 properties

JSON SCHEMA

PartnerSubscriptionToken

11 properties

JSON SCHEMA

PartnerSubscriptions

0 properties

JSON SCHEMA

PartnerUpdateSubscriptionTokenRequest

4 properties

JSON SCHEMA

PaymentTypeCollection

2 properties

JSON SCHEMA

PickLineItemsRequest

2 properties

JSON SCHEMA

pms-apiBusinessLocationId

0 properties

JSON SCHEMA

pms-apiGetProvider

6 properties

JSON SCHEMA

pms-apiProviderApiKey

0 properties

JSON SCHEMA

pms-apiProviderEndpoint

0 properties

JSON SCHEMA

pms-apiProviderFeatures

0 properties

JSON SCHEMA

pms-apiProviderName

0 properties

JSON SCHEMA

Price Book Collection

1 properties

JSON SCHEMA

Price Book Create Request

6 properties

JSON SCHEMA

Price Book Product Collection

1 properties

JSON SCHEMA

Price Book Product ID Collection

1 properties

JSON SCHEMA

Price Book Products Update Response

1 properties

JSON SCHEMA

Price Book Update Request

6 properties

JSON SCHEMA

ProductCategory

6 properties

JSON SCHEMA

Product Collection

2 properties

JSON SCHEMA

Product

35 properties

JSON SCHEMA

Product Response

1 properties

JSON SCHEMA

Product Type Collection

2 properties

JSON SCHEMA

Product Type Response

1 properties

JSON SCHEMA

Product Update 2.1 Request

2 properties

JSON SCHEMA

Map of Promo Codes to booleans

0 properties

JSON SCHEMA

Promotion Promo Codes response

0 properties

JSON SCHEMA

Promotion Products response

1 properties

JSON SCHEMA

Promotion Promo Codes response

1 properties

JSON SCHEMA

Promotion response

19 properties

JSON SCHEMA

Promotion

15 properties

JSON SCHEMA

Purchase Order Collection Response

2 properties

JSON SCHEMA

Purchase Order Response

1 properties

JSON SCHEMA

Quote

19 properties

JSON SCHEMA

QuotesCollection

3 properties

JSON SCHEMA

Register Close Request

1 properties

JSON SCHEMA

Register Collection

2 properties

JSON SCHEMA

Register Open Request

1 properties

JSON SCHEMA

Register Payments Summary Response

1 properties

JSON SCHEMA

Remote Business Rules

4 properties

JSON SCHEMA

Request Logs response

1 properties

JSON SCHEMA

Request Log response

1 properties

JSON SCHEMA

reservation-servicePlatformProfile

15 properties

JSON SCHEMA

reservation-servicePlatformReservation

13 properties

JSON SCHEMA

Retailer response

1 properties

JSON SCHEMA

Sale Collection

2 properties

JSON SCHEMA

Sale Create Response

1 properties

JSON SCHEMA

Sale Request

0 properties

JSON SCHEMA

Sale Response

1 properties

JSON SCHEMA

Sale Update Request

0 properties

JSON SCHEMA

Search Response

1 properties

JSON SCHEMA

Serial Number Collection

2 properties

JSON SCHEMA

Request to create a sale

3 properties

JSON SCHEMA

Serial Number Response

1 properties

JSON SCHEMA

ServiceOrderRequest

10 properties

JSON SCHEMA

ServiceOrder

13 properties

JSON SCHEMA

ServiceStatusDetails

8 properties

JSON SCHEMA

Set Reorder Points Request

0 properties

JSON SCHEMA

Shift Collection

2 properties

JSON SCHEMA

staff-apiBOStaff

13 properties

JSON SCHEMA

staff-apiPOSStaff

15 properties

JSON SCHEMA

staff-apiResponseSchema

3 properties

JSON SCHEMA

staff-apiShift

8 properties

JSON SCHEMA

staff-apiStaff

16 properties

JSON SCHEMA

staff-apiUpdatePosStaffDto

9 properties

JSON SCHEMA

Store Credit Bulk Response

1 properties

JSON SCHEMA

Store Credit Customer Balance

4 properties

JSON SCHEMA

Store Credit Customer

7 properties

JSON SCHEMA

Store Credit Report

3 properties

JSON SCHEMA

Store Credit Transaction for Customer

8 properties

JSON SCHEMA

Supplier Collection

2 properties

JSON SCHEMA

Supplier Response

1 properties

JSON SCHEMA

Tag Collection

2 properties

JSON SCHEMA

Tag Response

1 properties

JSON SCHEMA

Tax Collection

1 properties

JSON SCHEMA

Tax Response

1 properties

JSON SCHEMA

teckelLinkSelfPage

1 properties

JSON SCHEMA

teckelPictureSpecDto

4 properties

JSON SCHEMA

teckelRichItemDescriptionDto

3 properties

JSON SCHEMA

teckelRichItemDtoDates

2 properties

JSON SCHEMA

teckelRichItemDtoPictures

3 properties

JSON SCHEMA

teckelRichItemDto

4 properties

JSON SCHEMA

User Collection

2 properties

JSON SCHEMA

User Response

1 properties

JSON SCHEMA

User Sale Total Response

1 properties

JSON SCHEMA

VariantAttributeResponse

3 properties

JSON SCHEMA

WebhookRequest

3 properties

JSON SCHEMA

Webhook

5 properties

JSON SCHEMA

Scroll for all 183

Security Posture 4

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Lightspeed Authentication

http/oauth2 · 2 schemes

SECURITY

Lightspeed Domain Security

TLSv1.3 · HSTS · DMARC

SECURITY

Lightspeed Trust Center

PCI DSS, SOC 2, SOC 3, GDPR

SECURITY

Scopes 1

OAuth scopes governing access to this provider's APIs.

Lightspeed Scopes

90 scopes · authorizationCode

90 scopes

SCOPES

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Lightspeed Agentic Access

383 operations · 171 acting

383 operations · 171 acting

AGENTIC

Resources

Get Started 4

Portal, sign-up, and the first successful call

Documentation 4

Reference material describing how the API behaves

Agent Surfaces 4

MCP servers, agent skills, and machine-readable catalogs

Design & Contract 12

Pagination, idempotency, versioning, errors, and events

Scroll for all 12

Build 7

SDKs, sample code, and the tooling you integrate with

Scroll for all 7

Access & Security 8

Authentication, authorization, and security posture

Scroll for all 8

Operate 5

Status, limits, changes, and where to get help

Commercial 5

Pricing, plans, and the legal terms of use

Company 4

The organization behind the API

Other 6

Properties that don't map to a standard resource type

Source (apis.yml)

apis.yml Raw ↑
aid: lightspeed
name: Lightspeed Commerce
description: Omnichannel commerce platform with REST APIs for retail and restaurant POS, inventory management, loyalty programs,
  and e-commerce integrations. Lightspeed serves retailers and restaurateurs with cloud-based point-of-sale systems, enabling
  custom integrations through APIs for sales, inventory, customers, orders, payments, and loyalty programs across multiple
  product lines including Retail X-Series, Retail R-Series, Restaurant K-Series, and eCom.
deliveryModel:
  model: saas
  open_source: false
  commercial: true
  callable_host: false
  label: Hosted service · you call their endpoint
  confidence: medium
  source:
  - pricing
  generated: '2026-08-28'
  method: derived
accessModel:
  pricing: unknown
  onboarding: unknown
  trial: false
  try_now: false
  public: false
  label: Unknown
  confidence: low
  source: []
  generated: '2026-07-22'
  method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/lightspeed.png
url: https://raw.githubusercontent.com/api-evangelist/lightspeed/refs/heads/main/apis.yml
created: '2026-06-13'
modified: '2026-09-16'
specificationVersion: '0.23'
tags:
- Commerce
- Point-of-Sale
- Retail
- Restaurant
- Inventory
- Loyalty
- Payments
- E-Commerce
- Omnichannel
- Canada
tags_raw:
- Commerce
- Point of Sale
- POS
- Retail
- Restaurant
- Inventory
- Loyalty
- Payments
- E-Commerce
- Omnichannel
- Canada
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com
common:
- type: AgenticAccess
  url: agentic-access/lightspeed-agentic-access.yml
- type: Spectral
  url: rules/lightspeed-rules.yml
- type: JSONLD
  url: json-ld/lightspeed-context.jsonld
- type: Vocabulary
  url: vocabulary/lightspeed-vocabulary.yml
- type: Hosts
  url: hosts/lightspeed-hosts.yml
- type: IntegrationEdges
  url: integrations/lightspeed-integration-edges.yml
- type: Vendors
  url: vendors/lightspeed-vendors.yml
- type: Newsroom
  url: https://www.lightspeedhq.com/news/
- type: CapabilityMap
  url: capabilities/lightspeed-capability-edges.yml
  name: Lightspeed Commerce Business Capability Map
- type: OAuthScopes
  url: scopes/lightspeed-scopes.yml
- type: Authentication
  url: authentication/lightspeed-authentication.yml
- type: DomainSecurity
  url: security/lightspeed-domain-security.yml
- type: Website
  url: https://www.lightspeedhq.com/
- type: Documentation
  url: https://developers.lightspeedhq.com/
- type: GitHubOrganization
  url: https://github.com/LightspeedHQ
- type: LinkedIn
  url: https://www.linkedin.com/company/lightspeedcommerce
- type: Blog
  url: https://www.lightspeedhq.com/blog/
- type: Pricing
  url: https://www.lightspeedhq.com/pricing/
- type: StatusPage
  url: https://status.lightspeedhq.com/
- type: X
  url: https://x.com/LightspeedHQ
- type: Plans
  url: plans/lightspeed-plans-pricing.yml
- type: RateLimits
  url: rate-limits/lightspeed-rate-limits.yml
- type: FinOps
  url: finops/lightspeed-finops.yml
- type: DeveloperPortal
  url: https://developers.lightspeedhq.com/
- type: Support
  url: https://www.lightspeedhq.com/support/
- type: TermsOfService
  url: https://www.lightspeedhq.com/terms/
- type: PrivacyPolicy
  url: https://www.lightspeedhq.com/privacy-policy/
- type: SignUp
  url: https://www.lightspeedhq.com/login/
- type: TrustCenter
  url: https://trust.lightspeedhq.com/
- type: Packages
  url: packages/lightspeed-packages.yml
- type: SDKs
  url: packages/lightspeed-packages.yml
- type: MCPServer
  url: mcp/lightspeed-mcp.yml
- type: ToolCrosswalk
  url: mcp/lightspeed-tool-crosswalk.yml
- type: LLMsTxt
  url: llms/lightspeed-llms.txt
- type: Overlay
  url: overlays/lightspeed-x-series-overlay.yaml
- type: Overlay
  url: overlays/lightspeed-k-series-overlay.yaml
- type: Conformance
  url: conformance/lightspeed-conformance.yml
- type: Compliance
  url: security/lightspeed-trust-center.yml
- type: TrustCenter
  url: security/lightspeed-trust-center.yml
- type: ErrorCatalog
  url: errors/lightspeed-problem-types.yml
- type: Lifecycle
  url: lifecycle/lightspeed-lifecycle.yml
- type: Deprecation
  url: lifecycle/lightspeed-lifecycle.yml
- type: VulnerabilityDisclosure
  url: security/lightspeed-vulnerability-disclosure.yml
- type: Security
  url: security/lightspeed-vulnerability-disclosure.yml
- type: Sandbox
  url: sandbox/lightspeed-sandbox.yml
- type: Conventions
  url: conventions/lightspeed-conventions.yml
- type: Idempotency
  url: conventions/lightspeed-conventions.yml
- type: ChangeLog
  url: changelog/lightspeed-changelog.yml
- type: CLI
  url: cli/lightspeed-cli.yml
- type: Components
  url: components/lightspeed-components.yml
- type: DataModel
  url: data-model/lightspeed-data-model.yml
- type: Webhooks
  url: asyncapi/lightspeed-webhooks.yml
- type: AgentSkill
  url: skills/_index.yml
- type: OpenAPI
  url: openapi/_original/lightspeed-x-series-openapi.json
- type: OpenAPI
  url: openapi/_original/lightspeed-k-series-openapi.json
- type: JSONLD
  url: json-ld/lightspeed.json
- type: APIReference
  url: https://x-series-api.lightspeedhq.com/reference
- type: GettingStarted
  url: https://x-series-api.lightspeedhq.com/docs/quick_start
- type: Postman
  url: https://developers.lightspeedhq.com/ecom/introduction/images/Lightspeed_eCom.postman_collection.json
apis:
- aid: lightspeed:retail-r-series
  name: Lightspeed Retail R-Series API
  description: REST API for Lightspeed Retail R-Series (formerly Vend) providing access to sales, inventory, customers, products,
    and reporting data for retail point-of-sale systems.
  humanURL: https://developers.lightspeedhq.com/retail/
  baseURL: https://api.lightspeedapp.com
  tags:
  - Retail
  - Point-of-Sale
  - Inventory
  - Sales
  tags_raw:
  - Retail
  - POS
  - Inventory
  - Sales
  properties:
  - type: Documentation
    url: https://developers.lightspeedhq.com/retail/introduction/introduction/
  - type: APIReference
    url: https://developers.lightspeedhq.com/retail/endpoints/Account/
  - type: GettingStarted
    url: https://developers.lightspeedhq.com/retail/introduction/introduction/
  - type: Authentication
    url: https://developers.lightspeedhq.com/retail/authentication/authentication-overview/
  - type: ChangeLog
    url: https://developers.lightspeedhq.com/retail/introduction/changelog/
- aid: lightspeed:ecom-c-series
  name: Lightspeed eCom API
  description: REST API for Lightspeed eCom (C-Series) e-commerce platform providing endpoints for products, orders, customers,
    shipments, payments, and inventory management. Requires Advanced or Professional subscription.
  humanURL: https://developers.lightspeedhq.com/ecom/
  baseURL: https://api.shoplightspeed.com
  tags:
  - E-Commerce
  - Order
  - Product
  - Customers
  - Shipping
  tags_raw:
  - E-Commerce
  - Orders
  - Products
  - Customers
  - Shipping
  properties:
  - type: Documentation
    url: https://developers.lightspeedhq.com/ecom/introduction/introduction/
  - type: APIReference
    url: https://developers.lightspeedhq.com/ecom/endpoints/account/
  - type: Authentication
    url: https://developers.lightspeedhq.com/ecom/introduction/authentication/
  - type: Postman
    url: https://developers.lightspeedhq.com/ecom/introduction/images/Lightspeed_eCom.postman_collection.json
  - type: ChangeLog
    url: https://developers.lightspeedhq.com/ecom/introduction/releasenotes/
- aid: lightspeed:ecom-e-series
  name: Lightspeed eCom E-Series (Ecwid) API
  description: REST API for Lightspeed eCom E-Series, the Ecwid storefront platform Lightspeed acquired in 2021 and now sells
    as eCom E-Series. Provides store profile, product catalog, categories, orders, customers, discount coupons, shipping and
    payment application endpoints for building storefront apps and integrations.
  humanURL: https://api-docs.ecwid.com/
  baseURL: https://app.ecwid.com/api/v3
  tags:
  - E-Commerce
  - Storefront
  - Product
  - Order
  - Customers
  tags_raw:
  - E-Commerce
  - Storefront
  - Products
  - Orders
  - Customers
  properties:
  - type: Documentation
    url: https://api-docs.ecwid.com/
  - type: APIReference
    url: https://api-docs.ecwid.com/reference/get-store-profile
- aid: lightspeed:restaurant-o-series
  name: Lightspeed Restaurant O-Series (Kounta) API
  description: REST API for Lightspeed Restaurant O-Series, the Kounta hospitality point-of-sale platform Lightspeed acquired
    in 2019 and sells as O-Series. Exposes sites, registers, products, categories, orders, customers, staff and webhook endpoints
    for hospitality integrations.
  humanURL: https://apidoc.kounta.com/
  baseURL: https://api.kounta.com
  tags:
  - Restaurant
  - Point-of-Sale
  - Order
  - Inventory
  - Hospitality
  tags_raw:
  - Restaurant
  - POS
  - Orders
  - Inventory
  - Hospitality
  properties:
  - type: Documentation
    url: https://apidoc.kounta.com/
- aid: lightspeed:golf-g-series
  name: Lightspeed Golf (Chronogolf) Partner API
  description: Partner REST API for Lightspeed Golf, the Chronogolf tee-sheet and golf course management platform Lightspeed
    acquired in 2019. Covers organizations, courses, tee times, green fees, reservations and customers for golf booking partners,
    published as Postman-hosted partner documentation.
  humanURL: https://partner-api.docs.chronogolf.com/
  baseURL: https://partner-api.chronogolf.com
  tags:
  - Golf
  - Reservations
  - Tee Sheet
  - Booking
  - Point-of-Sale
  tags_raw:
  - Golf
  - Reservations
  - Tee Sheet
  - Booking
  - POS
  properties:
  - type: Documentation
    url: https://partner-api.docs.chronogolf.com/
- aid: lightspeed:lightspeed-audit-api
  name: Lightspeed Commerce Audit API
  description: Audit and security operations
  humanURL: https://x-series-api.lightspeedhq.com/
  baseURL: https://{domain_prefix}.retail.lightspeed.app
  tags:
  - Audit
  properties:
  - type: OpenAPI
    url: openapi/lightspeed-audit-api-openapi.yml
  - type: Documentation
    url: https://x-series-api.lightspeedhq.com/docs/introduction
  - type: APIReference
    url: https://x-series-api.lightspeedhq.com/reference
  - type: GettingStarted
    url: https://x-series-api.lightspeedhq.com/docs/quick_start
  - type: ChangeLog
    url: https://x-series-api.lightspeedhq.com/changelog
  - type: LLMsTxt
    url: llms/lightspeed-llms.txt
  - type: SignUp
    url: https://developers.retail.lightspeed.app/register
  - type: Documentation
    url: https://api-portal.lsk.lightspeed.app/
  - type: APIReference
    url: https://api-docs.lsk.lightspeed.app/
  - type: GettingStarted
    url: https://api-portal.lsk.lightspeed.app/quick-start/intro
  - type: ChangeLog
    url: https://api-docs.lsk.lightspeed.app/changes
  - type: JSONSchema
    url: json-schema/lightspeed-audit-log-event-schema.json
- aid: lightspeed:lightspeed-brands-api
  name: Lightspeed Commerce Brands API
  description: Brand operations
  humanURL: https://x-series-api.lightspeedhq.com/
  baseURL: https://{domain_prefix}.retail.lightspeed.app
  tags:
  - Brands
  properties:
  - type: OpenAPI
    url: openapi/lightspeed-brands-api-openapi.yml
  - type: Documentation
    url: https://x-series-api.lightspeedhq.com/docs/introduction
  - type: APIReference
    url: https://x-series-api.lightspeedhq.com/reference
  - type: GettingStarted
    url: https://x-series-api.lightspeedhq.com/docs/quick_start
  - type: ChangeLog
    url: https://x-series-api.lightspeedhq.com/changelog
  - type: LLMsTxt
    url: llms/lightspeed-llms.txt
  - type: SignUp
    url: https://developers.retail.lightspeed.app/register
  - type: Documentation
    url: https://api-portal.lsk.lightspeed.app/
  - type: APIReference
    url: https://api-docs.lsk.lightspeed.app/
  - type: GettingStarted
    url: https://api-portal.lsk.lightspeed.app/quick-start/intro
  - type: ChangeLog
    url: https://api-docs.lsk.lightspeed.app/changes
  - type: JSONSchema
    url: json-schema/lightspeed-brand-collection-schema.json
  - type: JSONSchema
    url: json-schema/lightspeed-brand-base-schema.json
  - type: JSONSchema
    url: json-schema/lightspeed-brand-response-schema.json
- aid: lightspeed:lightspeed-channel-request-log-api
  name: Lightspeed Commerce Channel Request Log API
  description: A log of requests and responses between Lightspeed and an integration channel.
  humanURL: https://x-series-api.lightspeedhq.com/
  baseURL: https://{domain_prefix}.retail.lightspeed.app
  tags:
  - Channel Request Log
  properties:
  - type: OpenAPI
    url: openapi/lightspeed-channel-request-log-api-openapi.yml
  - type: Documentation
    url: https://x-series-api.lightspeedhq.com/docs/introduction
  - type: APIReference
    url: https://x-series-api.lightspeedhq.com/reference
  - type: GettingStarted
    url: https://x-series-api.lightspeedhq.com/docs/quick_start
  - type: ChangeLog
    url: https://x-series-api.lightspeedhq.com/changelog
  - type: LLMsTxt
    url: llms/lightspeed-llms.txt
  - type: SignUp
    url: https://developers.retail.lightspeed.app/register
  - type: Documentation
    url: https://api-portal.lsk.lightspeed.app/
  - type: APIReference
    url: https://api-docs.lsk.lightspeed.app/
  - type: GettingStarted
    url: https://api-portal.lsk.lightspeed.app/quick-start/intro
  - type: ChangeLog
    url: https://api-docs.lsk.lightspeed.app/changes
  - type: JSONSchema
    url: json-schema/lightspeed-request-collection-response-schema.json
  - type: JSONSchema
    url: json-schema/lightspeed-channel-collection-response-schema.json
  - type: JSONSchema
    url: json-schema/lightspeed-request-single-response-schema.json
- aid: lightspeed:lightspeed-consignment-products-api
  name: Lightspeed Commerce Consignment Products API
  description: Consignment Product operations
  humanURL: https://x-series-api.lightspeedhq.com/
  baseURL: https://{domain_prefix}.retail.lightspeed.app
  tags:
  - Consignment Products
  properties:
  - type: OpenAPI
    url: openapi/lightspeed-consignment-products-api-openapi.yml
  - type: Documentation
    url: https://x-series-api.lightspeedhq.com/docs/introduction
  - type: APIReference
    url: https://x-series-api.lightspeedhq.com/reference
  - type: GettingStarted
    url: https://x-series-api.lightspeedhq.com/docs/quick_start
  - type: ChangeLog
    url: https://x-series-api.lightspeedhq.com/changelog
  - type: LLMsTxt
    url: llms/lightspeed-llms.txt
  - type: SignUp
    url: https://developers.retail.lightspeed.app/register
  - type: Documentation
    url: https://api-portal.lsk.lightspeed.app/
  - type: APIReference
    url: https://api-docs.lsk.lightspeed.app/
  - type: GettingStarted
    url: https://api-portal.lsk.lightspeed.app/quick-start/intro
  - type: ChangeLog
    url: https://api-docs.lsk.lightspeed.app/changes
  - type: JSONSchema
    url: json-schema/lightspeed-consignment-product-schema.json
  - type: JSONSchema
    url: json-schema/lightspeed-consignment-product-collection-schema.json
  - type: JSONSchema
    url: json-schema/lightspeed-consignment-product-response-schema.json
  - type: JSONSchema
    url: json-schema/lightspeed-inventory-count-item-response-schema.json
  - type: JSONSchema
    url: json-schema/lightspeed-consignment-product-request-schema.json
- aid: lightspeed:lightspeed-consignments-api
  name: Lightspeed Commerce Consignments API
  description: Stock control operations
  humanURL: https://x-series-api.lightspeedhq.com/
  baseURL: https://{domain_prefix}.retail.lightspeed.app
  tags:
  - Consignments
  properties:
  - type: OpenAPI
    url: openapi/lightspeed-consignments-api-openapi.yml
  - type: Documentation
    url: https://x-series-api.lightspeedhq.com/docs/introduction
  - type: APIReference
    url: https://x-series-api.lightspeedhq.com/reference
  - type: GettingStarted
    url: https://x-series-api.lightspeedhq.com/docs/quick_start
  - type: ChangeLog
    url: https://x-series-api.lightspeedhq.com/changelog
  - type: LLMsTxt
    url: llms/lightspeed-llms.txt
  - type: SignUp
    url: https://developers.retail.lightspeed.app/register
  - type: Documentation
    url: https://api-portal.lsk.lightspeed.app/
  - type: APIReference
    url: https://api-docs.lsk.lightspeed.app/
  - type: GettingStarted
    url: https://api-portal.lsk.lightspeed.app/quick-start/intro
  - type: ChangeLog
    url: https://api-docs.lsk.lightspeed.app/changes
  - type: JSONSchema
    url: json-schema/lightspeed-consignment-totals-response-schema.json
  - type: JSONSchema
    url: json-schema/lightspeed-consignment-collection-schema.json
  - type: JSONSchema
    url: json-schema/lightspeed-consignment-request-schema.json
  - type: JSONSchema
    url: json-schema/lightspeed-consignment-response-schema.json
- aid: lightspeed:lightspeed-customer-addresses-api
  name: Lightspeed Commerce Customer Addresses API
  description: Customer Address operations
  humanURL: https://x-series-api.lightspeedhq.com/
  baseURL: https://{domain_prefix}.retail.lightspeed.app
  tags:
  - Customer Addresses
  properties:
  - type: OpenAPI
    url: openapi/lightspeed-customer-addresses-api-openapi.yml
  - type: Documentation
    url: https://x-series-api.lightspeedhq.com/docs/introduction
  - type: APIReference
    url: https://x-series-api.lightspeedhq.com/reference
  - type: GettingStarted
    url: https://x-series-api.lightspeedhq.com/docs/quick_start
  - type: ChangeLog
    url: https://x-series-api.lightspeedhq.com/changelog
  - type: LLMsTxt
    url: llms/lightspeed-llms.txt
  - type: SignUp
    url: https://developers.retail.lightspeed.app/register
  - type: Documentation
    url: https://api-portal.lsk.lightspeed.app/
  - type: APIReference
    url: https://api-docs.lsk.lightspeed.app/
  - type: GettingStarted
    url: https://api-portal.lsk.lightspeed.app/quick-start/intro
  - type: ChangeLog
    url: https://api-docs.lsk.lightspeed.app/changes
  - type: JSONSchema
    url: json-schema/lightspeed-customer-address-base-schema.json
  - type: JSONSchema
    url: json-schema/lightspeed-customer-address-create-response-schema.json
  - type: JSONSchema
    url: json-schema/lightspeed-customer-address-collection-schema.json
  - type: JSONSchema
    url: json-schema/lightspeed-customer-address-response-schema.json
- aid: lightspeed:lightspeed-customer-groups-api
  name: Lightspeed Commerce Customer Groups API
  description: Customer Group operations
  humanURL: https://x-series-api.lightspeedhq.com/
  baseURL: https://{domain_prefix}.retail.lightspeed.app
  tags:
  - Customer Groups
  properties:
  - type: OpenAPI
    url: openapi/lightspeed-customer-groups-api-openapi.yml
  - type: Documentation
    url: https://x-series-api.lightspeedhq.com/docs/introduction
  - type: APIReference
    url: https://x-series-api.lightspeedhq.com/reference
  - type: GettingStarted
    url: https://x-series-api.lightspeedhq.com/docs/quick_start
  - type: ChangeLog
    url: https://x-series-api.lightspeedhq.com/changelog
  - type: LLMsTxt
    url: llms/lightspeed-llms.txt
  - type: SignUp
    url: https://developers.retail.lightspeed.app/register
  - type: Documentation
    url: https://api-portal.lsk.lightspeed.app/
  - type: APIReference
    url: https://api-docs.lsk.lightspeed.app/
  - type: GettingStarted
    url: https://api-portal.lsk.lightspeed.app/quick-start/intro
  - type: ChangeLog
    url: https://api-docs.lsk.lightspeed.app/changes
  - type: JSONSchema
    url: json-schema/lightspeed-customer-group-schema.json
  - type: JSONSchema
    url: json-schema/lightspeed-customer-group-collection-schema.json
  - type: JSONSchema
    url: json-schema/lightspeed-customer-collection-schema.json
  - type: JSONSchema
    url: json-schema/lightspeed-customer-group-response-schema.json
- aid: lightspeed:lightspeed-customers-api
  name: Lightspeed Commerce Customers API
  description: Customer operations
  humanURL: https://x-series-api.lightspeedhq.com/
  baseURL: https://{domain_prefix}.retail.lightspeed.app
  tags:
  - Customers
  properties:
  - type: OpenAPI
    url: openapi/lightspeed-customers-api-openapi.yml
  - type: Documentation
    url: https://x-series-api.lightspeedhq.com/docs/introduction
  - type: APIReference
    url: https://x-series-api.lightspeedhq.com/reference
  - type: GettingStarted
    url: https://x-series-api.lightspeedhq.com/docs/quick_start
  - type: ChangeLog
    url: https://x-series-api.lightspeedhq.com/changelog
  - type: LLMsTxt
    url: llms/lightspeed-llms.txt
  - type: SignUp
    url: https://developers.retail.lightspeed.app/register
  - type: Documentation
    url: https://api-portal.lsk.lightspeed.app/
  - type: APIReference
    url: https://api-docs.lsk.lightspeed.app/
  - type: GettingStarted
    url: https://api-portal.lsk.lightspeed.app/quick-start/intro
  - type: ChangeLog
    url: https://api-docs.lsk.lightspeed.app/changes
  - type: JSONSchema
    url: json-schema/lightspeed-customer-base-schema.json
  - type: JSONSchema
    url: json-schema/lightspeed-customer-collection-schema.json
  - type: JSONSchema
    url: json-schema/lightspeed-customer-response-schema.json
- aid: lightspeed:lightspeed-financial-api
  name: Lightspeed Commerce Financial API
  description: 'V1 endpoints (`/f/finance/...`) for retrieving sales and financial data.


    For the newer V2 versions of these endpoints see FinancialV2


    ### V1 behaviour


    - **Sorting**: No guaranteed sorting order; internal transformations may alter order unpredictably

    - **Transitory Accounts / Unsettled Sales**: Returns closed transactions only

    - **Pagination**: `pageSize` max of 1000. Uses HATEOAS `_links` with `self` and `nextPage` URLs

    - **Daily endpoints** (`getDailyFinancials`): No pagination, no hard cap on results. May have slower response times for
    larger data sets

    - **Backoffice transactions**: Historical dating supported. Transactions will be dated to a past date if the action impacts
    past reports. Can query transactions by original business date

    - **Backoffice modifications** (payment method change and canceling): Modifications appear on the original transaction
    date'
  humanURL: https://x-series-api.lightspeedhq.com/
  baseURL: https://{domain_prefix}.retail.lightspeed.app
  tags:
  - Finance
  tags_raw:
  - Financial
  properties:
  - type: OpenAPI
    url: openapi/lightspeed-financial-api-openapi.yml
  - type: Documentation
    url: https://x-series-api.lightspeedhq.com/docs/introduction
  - type: APIReference
    url: https://x-series-api.lightspeedhq.com/reference
  - type: GettingStarted
    url: https://x-series-api.lightspeedhq.com/docs/quick_start
  - type: ChangeLog
    url: https://x-series-api.lightspeedhq.com/changelog
  - type: LLMsTxt
    url: llms/lightspeed-llms.txt
  - type: SignUp
    url: https://developers.retail.lightspeed.app/register
  - type: Documentation
    url: https://api-portal.lsk.lightspeed.app/
  - type: APIReference
    url: https://api-docs.lsk.lightspeed.app/
  - type: GettingStarted
    url: https://api-portal.lsk.lightspeed.app/quick-start/intro
  - type: ChangeLog
    url: https://api-docs.lsk.lightspeed.app/changes
  - type: JSONSchema
    url: json-schema/lightspeed-financial-api-sale-dto-schema.json
  - type: JSONSchema
    url: json-schema/lightspeed-financial-api-financial-dto-schema.json
  - type: JSONSchema
    url: json-schema/lightspeed-financial-api-resources-tax-rate-schema.json
- aid: lightspeed:lightspeed-financialv2-api
  name: Lightspeed Commerce Financial V2 API
  description: 'V2 endpoints (`/f/v2/...`) for retrieving sales and financial data.


    ### Endpoint Mapping


    | V1 Endpoint | V2 Endpoint |

    |-------------|-------------|

    | `getFinancials` (`/f/finance/{id}/financials/{from}/{to}`) | `getSales` (`/f/v2/business-location/{id}/sales`) |

    | `getDailyFinancials` (`/f/finance/{id}/dailyFinancials`) | `getBusinessDaySales` (`/f/v2/business-location/{id}/sales-daily`)
    |


    Response DTOs are nearly identical to V1 with the exceptions noted below


    ### V2 behaviour


    - **Sorting**: Explicitly sorted by `timeClosed`

    - **Transitory Accounts /  Unsettled Sales**: Returns closed transactions and ensures no transitory (unclosed) transactions
    are included in reporting

    - **Pagination**: `pageSize` max of 100. No HATEOAS `_links`; uses `nextPageToken` string for pagination instead

    - **Daily endpoints** (`getBusinessDaySales`): No pagination, no hard cap on results. May have slower response times for
    larger data sets

    - **Backoffice transactions**: Historical dating not currently supported — transactions appear as if created at current
    time. Transactions can only be found by the date/time they were actually created. *Historical dating support is planned
    for a future release.*

    - **Backoffice modifications** (payment method change and canceling): Modifications appear on the date the modification
    was performed, not the original transaction date


    If you need to query transactions by their original business date (e.g. for historical reporting or reconciliation); The
    V1 endpoints may be more suitable until backwards compatibility is added to V2 for this aspect.'
  humanURL: https://x-series-api.lightspeedhq.com/
  baseURL: https://{domain_prefix}.retail.lightspeed.app
  tags:
  - FinancialV2
  properties:
  - type: OpenAPI
    url: openapi/lightspeed-financialv2-api-openapi.yml
  - type: Documentation
    url: https://x-series-api.lightspeedhq.com/docs/introduction
  - type: APIReference
    url: https://x-series-api.lightspeedhq.com/reference
  - type: GettingStarted
    url: https://x-series-api.lightspeedhq.com/docs/quick_start
  - type: ChangeLog
    url: https://x-series-api.lightspeedhq.com/changelog
  - type: LLMsTxt
    url: llms/lightspeed-llms.txt
  - type: SignUp
    url: https://developers.retail.lightspeed.app/register
  - type: Documentation
    url: https://api-portal.lsk.lightspeed.app/
  - type: APIReference
    url: https://api-docs.lsk.lightspeed.app/
  - type: GettingStarted
    url: https://api-portal.lsk.lightspeed.app/quick-start/intro
  - type: ChangeLog
    url: https://api-docs.lsk.lightspeed.app/changes
  - type: JSONSchema
    url: json-schema/lightspeed-financial-api-aborted-order-dto-schema.json
  - type: JSONSchema
    url: json-schema/lightspeed-financial-api-lspayments-dto-schema.json
  - type: JSONSchema
    url: json-schema/lightspeed-financial-api-sales-daily-export-dto-schema.json
  - type: JSONSchema
    url: json-schema/lightspeed-financial-api-sales-export-dto-schema.json
- aid: lightspeed:lightspeed-fulfillments-api
  name: Lightspeed Commerce Fulfillments API
  description: Fulfillment operations
  humanURL: https://x-series-api.lightspeedhq.com/
  baseURL: https://{domain_prefix}.retail.lightspeed.app
  tags:
  - Fulfillments
  properties:
  - type: OpenAPI
    url: openapi/lightspeed-fulfillments-api-openapi.yml
  - type: Documentation
    url: https://x-series-api.lightspeedhq.com/docs/introduction
  - type: APIReference
    url: https://x-series-api.lightspeedhq.com/reference
  - type: GettingStarted
    url: https://x-series-api.lightspeedhq.com/docs/quick_start
  - type: ChangeLog
    url: https://x-series-api.lightspeedhq.com/changelog
  - type: LLMsTxt
    url: llms/lightspeed-llms.txt
  - type: SignUp
    url: https://developers.retail.lightspeed.app/register
  - type: Documentation
    url: https://api-portal.lsk.lightspeed.app/
  - type: APIReference
    url: https://api-docs.lsk.lightspeed.app/
  - type: GettingStarted
    url: https://api-portal.lsk.lightspeed.app/quick-start/intro
  - type: ChangeLog
    url: https://api-docs.lsk.lightspeed.app/changes
  - type: JSONSchema
    url: json-schema/lightspeed-fulfillment-history-response-schema.json
  - type: JSONSchema
    url: json-schema/lightspeed-fulfill-line-items-request-schema.json
  - type: JSONSchema
    url: json-schema/lightspeed-pack-line-items-request-schema.json
  - type: JSONSchema
    url: json-schema/lightspeed-pick-line-items-request-schema.json
  - type: JSONSchema
    url: json-schema/lightspeed-fulfill-line-items-response-schema.json
  - type: JSONSchema
    url: json-schema/lightspeed-pack-line-items-response-schema.json
- aid: lightspeed:lightspeed-gift-cards-api
  name: Lightspeed Commerce Gift Cards API
  description: Gift Card operations
  humanURL: https://x-series-api.lightspeedhq.com/
  baseURL: https://{domain_prefix}.retail.lightspeed.app
  tags:
  - Gift Cards
  properties:
  - type: OpenAPI
    url: openapi/lightspeed-gift-cards-api-openapi.yml
  - type: Documentation
    url: https://x-series-api.lightspeedhq.com/docs/introduction
  - type: APIReference
    url: https://x-series-api.lightspeedhq.com/reference
  - type: GettingStarted
    url: https://x-series-api.lightspeedhq.com/docs/quick_start
  - type: ChangeLog
    url: https://x-series-api.lightspeedhq.com/changelog
  - type: LLMsTxt
    url: llms/lightspeed-llms.txt
  - type: SignUp
    url: https://developers.retail.lightspeed.app/register
  - type: Documentation
    url: https://api-portal.lsk.lightspeed.app/
  - type: APIReference
    url: https://api-docs.lsk.lightspeed.app/
  - type: GettingStarted
    url: https://api-portal.lsk.lightspeed.app/quick-start/intro
  - type: ChangeLog
    url: https://api-docs.lsk.lightspeed.app/changes
  - type: JSONSchema
    url: json-schema/lightspeed-gift-card-schema.json
  - type: JSONSchema
    url: json-schema/lightspeed-gift-card-transaction-params-schema.json
  - type: JSONSchema
    url: json-schema/lightspeed-gift-card-activation-params-schema.json
  - type: JSONSchema
    url: json-schema/lightspeed-gift-card-collection-schema.json
  - type: JSONSchema
    url: json-schema/lightspeed-gift-card-transaction-singleton-schema.json
  - type: JSONSchema
    url: json-schema/lightspeed-gift-card-singleton-schema.json
- aid: lightspeed:lightspeed-id-cards-api
  name: Lightspeed Commerce ID Cards API
  description: The ID Cards API from Lightspeed Commerce — 2 operation(s) for id cards.
  humanURL: https://x-series-api.lightspeedhq.com/
  baseURL: https://{domain_prefix}.retail.lightspeed.app
  tags:
  - ID Cards
  properties:
  - type: OpenAPI
    url: openapi/lightspeed-id-cards-api-openapi.yml
  - type: Documentation
    url: https://x-series-api.lightspeedhq.com/docs/introduction
  - type: APIReference
    url: https://x-series-api.lightspeedhq.com/reference
  - type: GettingStarted
    url: https://x-series-api.lightspeedhq.com/docs/quick_start
  - type: ChangeLog
    url: https://x-series-api.lightspeedhq.com/changelog
  - type: LLMsTxt
    url: llms/lightspeed-llms.txt
  - type: SignUp
    url: https://developers.retail.lightspeed.app/register
  - type: Documentation
    url: https://api-portal.lsk.lightspeed.app/
  - type: APIReference
    url: https://api-docs.lsk.lightspeed.app/
  - type: GettingStarted
    url: https://api-portal.lsk.lightspeed.app/quick-start/intro
  - type: ChangeLog
    url: https://api-docs.lsk.lightspeed.app/changes
  - type: JSONSchema
    url: json-schema/lightspeed-id-cards-api-id-card-batch-schema.json
  - type: JSONSchema
    url: json-schema/lightspeed-id-cards-api-create-id-cards-response-schema.json
  - type: JSONSchema
    url: json-schema/lightspeed-id-cards-api-create-id-cards-request-schema.json
  - type: JSONSchema
    url: json-schema/lightspeed-id-cards-api-create-id-card-batch-request-schema.json
- aid: lightspeed:lightspeed-inventory-api
  name: Lightspeed Commerce Inventory API
  description: Inventory operations
  humanURL: https://x-series-api.lightspeedhq.com/
  baseURL: https://{domain_prefix}.retail.lightspeed.app
  tags:
  - Inventory
  properties:
  - type: OpenAPI
    url: openapi/lightspeed-inventory-api-openapi.yml
  - type: Documentation
    url: https://x-series-api.lightspeedhq.com/docs/introduction
  - type: APIReference
    url: https://x-series-api.lightspeedhq.com/reference
  - type: GettingStarted
    url: https://x-series-api.lightspeedhq.com/docs/quick_start
  - type: ChangeLog
    url: https://x-series-api.lightspeedhq.com/changelog
  - type: LLMsTxt
    url: llms/lightspeed-llms.txt
  - type: SignUp
    url: https://developers.retail.lightspeed.app/register
  - type: Documentation
    url: https://api-portal.lsk.lightspeed.app/
  - type: APIReference
    url: https://api-docs.lsk.lightspeed.app/
  - type: GettingStarted
    url: https://api-portal.lsk.lightspeed.app/quick-start/intro
  - type: ChangeLog
    url: https://api-docs.lsk.lightspeed.app/changes
  - type: JSONSchema
    url: json-schema/lightspeed-inventory-level-schema.json
  - type: JSONSchema
    url: json-schema/lightspeed-inventory-schema.json
  - type: JSONSchema
    url: json-schema/lightspeed-inventory-levels-request-schema.json


# --- truncated at 32 KB (87 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/lightspeed/refs/heads/main/apis.yml

Work with this as data

Every provider here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for providers

9 MCP tools reach this
  • find_providersBrowse and filter every provider in the catalog.
  • get_provider_artifactsEvery artifact this provider publishes, grouped by type.
  • get_provider_operationsEvery operation across all of their OpenAPIs — one call instead of parsing every spec.
  • get_provider_toolsEvery MCP tool they ship, with the operation each wraps.
  • get_provider_evidenceHow each part of their score was established. Free — the basis for a claim should not sit behind it.
  • get_provider_ratingPRO — composite, band, trend and facet scores.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This provider
curl "https://apis.io/api/v1/providers/lightspeed"
All providers
curl "https://apis.io/api/v1/providers?limit=25"
Every operation they expose
curl "https://apis.io/api/v1/providers/lightspeed/operations?limit=25"
How their score was established
curl "https://apis.io/api/v1/providers/lightspeed/evidence"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.