Update a sale

put

https://{domain_prefix}.retail.lightspeed.app/api/2026-01/sales/{sale_id}

Update an existing sale by ID.

🔒 Requires: sales:write scope

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

sale_id

uuid

required

A valid sale ID.

Body Params

Updated sale object.

Editable attributes of the sale.

_metadata

object

attributes

array of strings

An array of attributes

attributes

customer_id

uuid

The ID of the customer associated with this sale.

date

string

The date of the sale in RFC3339 format. If not provided will be added as the time the sale reached the server.

fulfillment_details

array of objects

Fulfillment details for DISPATCH or PICKUP fulfillments.

fulfillment_details

invoice_number

string

The invoice number for the sale. If left null it will be populated by Lightspeed with the next available invoice number.

line_items

array of objects

Line items.

line_items

note

string

A note on the sale entered by the cashier.

payments

array of objects

Payments.

payments

pricing

object

service_fields

object

short_code

string

Short, unique code to be printed on the receipt for loyalty tracking purposes.

source

object

required

state

string

enum

required

State of the sale.

Allowed:

Response

204

Sale updated successfully.

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here!