Lightspeed Restaurant K-Series logo
API Changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
demo
  • demo default
  • prod

Topics

  • Introduction
  • Authentication

Endpoints

  • Rich Item
    • Get allergens GET
    • Get locales GET
    • Update locales PUT
    • Get rich items GET
    • Get rich item by sku GET
    • Create or update rich item PUT
    • Delete rich item DELETE
    • Update picture PATCH
    • Get rich items by SKUs POST
    • Get picture specifications GET
  • Tax Breakdown
    • Post proposed order POST
  • Staff
    • Get Shifts GET
    • Get All POS Users GET
    • Create POS User POST
    • Update POS User PUT
    • Get All Back Office Users GET
    • Get Single User GET
    • Get All User Groups GET
    • Get Single User Group GET
    • Add Business Location Access POST
    • Remove Business Location Access DELETE
    • Get Webhooks GET
    • Create Webhook POST
    • Delete Webhook DELETE
    • Update Existing Webhook PATCH
    • Get Report Access Levels GET
    • Get All Back Office User Permissions GET
    • Get All POS User Permissions GET
  • Reservations for Platforms
    • Callback to Complete Onboarding POST
    • Platform Profile Details GET
    • Create or Update Platform Profile POST
    • Platform course settings definition PATCH
    • Create or Update Reservation PUT
    • Add authentication by XApiKey PATCH
    • Add authentication with BasicAuth PATCH
    • Add authentication with BearerAuth PATCH
    • Add authentication with OAuth2 PATCH
    • Get Business Locations GET
    • Activate Integration for Restaurant POST
    • Deactivate Integration for Restaurant POST
  • PMS
    • Get PMS Revenue Centers GET
    • Get a PMS provider by ID GET
    • Update a PMS provider PUT
    • Delete a PMS provider DELETE
    • Get PMS providers GET
    • Create PMS provider POST
  • Items
    • Get Item by ID GET
    • Update Item by ID PUT
    • Get All Items GET
    • Create Item POST
  • Reservations
    • Seating of a reservation POST
    • Get businesses data GET
    • Seating of a reservation POST
    • Register a new webhook endpoint PUT
    • Update a webhook endpoint POST
    • Get a webhook endpoint GET
    • Delete a webhook endpoint DELETE
  • Financial
    • Get Businesses GET
    • Get Tax Rates GET
    • Get Payment Methods GET
    • Get Accounting Groups GET
    • Get Financials GET
    • Get Daily Financials GET
    • Get Receipt by External Reference GET
    • Get Aggregated Sales GET
  • FinancialV2
    • Get Sales GET
    • Get business day sales GET
    • BETA - Get Aborted Orders GET
  • Order and Pay
    • Get Businesses GET
    • Get All Floorplans GET
    • Get Floorplan Tables GET
    • Get All Order Profiles GET
    • Get Single Order Profile GET
    • Get All Menus GET
    • Get Single Menu GET
    • Get Modifiers GET
    • Get Discounts GET
    • Create Local Order POST
    • Create To Go Order POST
    • Get All Open Checks GET
    • Get Open Check by Table GET
    • Get Single Check GET
    • Apply a Payment POST
    • Print Message POST
    • Create a Webhook PUT
    • Update a webhook POST
    • Retrieve a Webhook GET

Webhooks

  • Staff
    • Shift notification POST
  • Reservations for Platforms
    • Order notification POST
    • Error notification POST
    • Integration notification POST
    • Onboarding notification POST
    • POS reservation updated notification POST
  • Order and Pay
    • Notifications payment POST
  • PMS Integration
    • Transaction Details POST
Powered by Bump.sh