How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Lightspeed Commerce

Lightspeed Commerce Workflows API

Workflow operations

Documentation Provider Profile APIs.io OpenAPI GitHub

Lightspeed Commerce Workflows API is one of 58 APIs that Lightspeed Commerce publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Workflows. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and a changelog.

This API exposes 12 operations across 7 paths, and defines 11 schemas. It is described by OpenAPI 3.2.0, at version 2026-07.

Requests are made against a single base URL, https://{domain_prefix}.retail.lightspeed.app/api/2026-07.

12 operations 7 paths 11 schemas 3 DELETE4 GET4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2026-07
Base URL
https://{domain_prefix}.retail.lightspeed.app
Authentication
HTTP Bearer
Contact
Lightspeed Developer Relations
License
Apache 2.0
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

Lightspeed Commerce Workflows API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer Token for API authentication.

Paths & Operations 12

Across 7 paths, the API surfaces 12 operations — 3 DELETE, 4 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Workflows 12

Workflow operations

GET
/workflows/custom_fields
List custom field definitions
GetCustomFields 1 param → 200
POST
/workflows/custom_fields
Define a new custom field
CreateCustomField body → 200
GET
/workflows/custom_fields/values
List custom field values
GetCustomFieldValues 2 params → 200
POST
/workflows/custom_fields/values
Set new custom field values
SetCustomFieldValues body → 200
DELETE
/workflows/custom_fields/{customFieldId}
Delete a custom field
delete-custom-field 1 param → 204
PUT
/workflows/custom_fields/{customFieldId}
Update a custom field
update-custom-field 1 param body → 200
GET
/workflows/remote_rules
List remote rules
get-remote-rules → 200
POST
/workflows/remote_rules
Create remote rule
create-remote-rule body → 200
DELETE
/workflows/remote_rules/{remoteRuleId}
Delete a remote rule
delete-remote-rule 1 param → 204
GET
/workflows/rules
List rules
get-rules → 200
POST
/workflows/rules
Create rule
create-rule body → 200
DELETE
/workflows/rules/{ruleId}
Delete a business rule
delete-rule 1 param → 204

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are CustomFieldDefinition (8 properties), CustomFieldValue (7 properties), CustomFieldDefinitionParams (7 properties), UpdateCustomFieldParams (4 properties). Each schema is shown below with its type and property counts.

BusinessRuleParams
object
The parameters that can be passed to the create rule API.
2 properties 2 required
CustomFieldDefinition
object
The type, name, and configuration of a custom field.
8 properties
CustomFieldValueCollection
object
The fields returned by the custom field value list API.
1 property 1 required
CustomFieldDefinitionParams
object
The parameters that can be passed to the create custom field definition API.
7 properties 4 required
CustomFieldDefinitionCollection
object
The fields returned by the custom fields definition list API.
1 property 1 required
RemoteBusinessRuleParams
object
The parameters that can be passed to the create remote rule API.
1 property 1 required
CustomFieldValue
object
The value of a custom field on an entity.
7 properties
CustomFieldValuesParams
object
The parameters that can be passed to the set custom field values API.
3 properties 3 required
BusinessRule
object
4 properties 2 required
RemoteBusinessRule
object
The configuration of a remote business rule.
4 properties 1 required
UpdateCustomFieldParams
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lightspeed-workflows-api-openapi.yml Raw ↑

Other APIs Lightspeed Commerce publishes across the network.

Lightspeed Retail R-Series API
AE Profile APIs.io
Lightspeed eCom API
AE Profile APIs.io
Lightspeed eCom E-Series (Ecwid) API
AE Profile APIs.io
Lightspeed Restaurant O-Series (Kounta) API
AE Profile APIs.io
Lightspeed Golf (Chronogolf) Partner API
AE Profile APIs.io
Lightspeed Commerce Audit API
AE Profile APIs.io
Lightspeed Commerce Brands API
AE Profile APIs.io
Lightspeed Commerce Channel Request Log API
AE Profile APIs.io
Lightspeed Commerce Consignment Products API
AE Profile APIs.io
Lightspeed Commerce Consignments API
AE Profile APIs.io
Lightspeed Commerce Customer Addresses API
AE Profile APIs.io
Lightspeed Commerce Customer Groups API
AE Profile APIs.io
#Workflows
← Back to L APIs
API Details
ID
lightspeed:lightspeed-workflows-api
Base URL
https://{domain_prefix}.retail.lightspeed.app
Docs
https://x-series-api.lightspeedhq.com/
Provider
Lightspeed Commerce
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=lightspeed-workflows-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/lightspeed-workflows-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Lightspeed Commerce Workflows API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.