Create or update a register sale

post

https://{domain_prefix}.retail.lightspeed.app/api/register_sales

Create or update a register sale. Returns a single new or updated sale object. See Sales Tutorials for usage information.

Note: Promotions cannot be used with this endpoint.

🔒 Requires: sales:write scope

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

New or updated register sale object.

Editable attributes of the sale

source

string

This is the identifier of the 3rd party system that the source_id is associated with. 'Xero' or 'Magento' would be examples.

source_id

string

The ID of the sale on the client side or another system where the sale was originally created.

register_id

uuid

The ID of the register where the sale was created.

customer_id

uuid

The ID of the customer associated with this sale.

user_id

uuid

required

The ID of the user (cashier) who created the sale.

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.

note

string

A note on the sale entered by the cashier.

state

string

enum

required

State of the sale.

Allowed:

status

string

enum

deprecated

Status of the sale.

short_code

string

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

invoice_number

string

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

accounts_transaction_id

string

Xero invoice reference ID. Only editable for ONACCOUNT sales.

register_sale_products

array of objects

Line items.

register_sale_products

register_sale_payments

array of objects

Payments.

register_sale_payments

register_sale_attributes

array of strings

An array of attributes

register_sale_attributes

adjustments

array of objects

Adjustments.

adjustments

service_fields

object

fulfillment_details

array of objects

Fulfillment details for DISPATCH or PICKUP fulfillments.

fulfillment_details

Response

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

200