Create a fully-populated quote through the X-Series gateway

post

https://{domain_prefix}.retail.lightspeed.app/api/2026-10/invoicing-quotes/v1/quotes/populated

Creates a fully-populated quote through the X-Series gateway.
The gateway forwards this request to Quote Service.

🔒 Requires: a valid Lightspeed Auth bearer token.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

companyName

string

Display name of the outlet/company.

currency

string

ISO 4217 currency code for the outlet (e.g. "USD", "CAD").

customer

object

Customer information.

deposit

object

Optional up-front deposit configuration.

footerNote

string

Optional footer note to set at creation. Customer-facing content (closing messages, terms, policies, legal clauses) shown at the bottom of the customer-facing quote and printed/PDF quote; the merchant can edit or clear it while the quote is in draft or revising status.

headerNote

string

Optional header note to set at creation (e.g. the register sale note). Shown on the customer-facing proposal above the pricing table; the merchant can edit or remove it in the quote builder before sending.

internalNote

string

Optional internal note from the source system. Visible only to merchant staff; never shown to the customer.

lineItems

array of objects

required

length ≥ 1

Pre-populated line items from source system.

lineItems*

basePrice

string

required

Catalog price anchor (e.g. "19.99"). Send the same value as unitPrice when there is no distinct catalog price.

discountPercent

number

required

Line-item discount as percentage (0-100).

metadata

object

Optional custom metadata for line item.

note

string

Optional line item note.

productName

string

required

Product name/description.

quantity

number

required

Line item quantity.

sku

string

Product SKU.

taxRate

number

required

Tax rate as decimal (0.0-1.0, e.g. 0.15 for 15%).

unitPrice

string

required

Unit price as decimal string (e.g. "19.99").

metadata

object

Optional custom metadata for quote.

pli

string

required

Lightspeed product location identifier.

projectTitle

string

Optional project title.

saleDiscount

object | null

Optional sale-level discount from source system.

source

string

required

Origin system identifier (e.g. "invoicing_quote_widget").

taxLabel

string

Optional quote-level tax label (e.g. "GST (15%)"). Stored on the quote at creation so it displays before send; preserved through a later send that omits a tax label.

Responses

400

Request validation failed.

401

Missing or invalid bearer token.

409

Idempotency key conflict.

500

Internal server error.

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Quote created.