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

Lightspeed Commerce Consignments API

Stock control operations

Lightspeed Commerce Consignments 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 Consignments. 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 6 operations across 3 paths, and defines 6 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.

6 operations 3 paths 6 schemas 1 DELETE3 GET1 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
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Lightspeed Commerce Consignments 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 6

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

Consignments 6

Stock control operations

GET
/consignments
List consignments
GetConsignments 6 params → 200
POST
/consignments
Create a consignment
CreateConsignment body → 201
DELETE
/consignments/{consignment_id}
Delete a consignment
DeleteConsignmentByID 1 param → 204
GET
/consignments/{consignment_id}
Get a single consignment
GetConsignmentByID 1 param → 200
PUT
/consignments/{consignment_id}
Update a consignment
UpdateConsignmentByID 1 param body → 200
GET
/consignments/{consignment_id}/totals
Get consignment totals
ListConsignmentTotals 1 param → 200

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Consignment (20 properties), ConsignmentCollection (2 properties), Version (2 properties), ConsignmentTotalsResponse (1 property). Each schema is shown below with its type and property counts.

Version
object
An object containing the highest and lowest version numbers for all items of the returned collection.
2 properties 2 required
ConsignmentCollection
object
2 properties
Consignment
object
20 properties 3 required
ConsignmentResponse
object
1 property
ConsignmentRequest
object
1 property 1 required
ConsignmentTotalsResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lightspeed-consignments-api-openapi.yml Raw ↑

Other APIs Lightspeed Commerce publishes across the network.

Lightspeed Retail R-Series API
Lightspeed eCom API
Lightspeed eCom E-Series (Ecwid) API
Lightspeed Restaurant O-Series (Kounta) API
Lightspeed Golf (Chronogolf) Partner API
Lightspeed Commerce Audit API
Lightspeed Commerce Brands API
Lightspeed Commerce Channel Request Log API
Lightspeed Commerce Consignment Products API
Lightspeed Commerce Customer Addresses API
Lightspeed Commerce Customer Groups API
Lightspeed Commerce Customers API
Where this information came from

This is an independent, third-party profile of Lightspeed Commerce Consignments 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.