List registers

get deprecatedhttps://{domain_prefix}.retail.lightspeed.app/api/registers

DEPRECATED This endpoint has a 2.0 equivalent. We recommend using that instead.

Returns a non-paginated list of registers.

Response

Response body

object

registers

array of objects

An array of register objects.

registers

object

uuid

Auto-generated object ID.

name

string

The name of the register.

outlet_id

uuid

The ID of the outlet the register is associated with.

button_layout_id

uuid

internal The ID of the button layout associated with this register.

print_receipt

string

Indicates whether the receipt will be printed after the sale is completed. "0" or "1".

email_receipt

string

Indicates whether the receipt should be emailed after the sale is completed. "0" or "1".

ask_for_note_on_save

string

Indicates whether the user will be asked to enter a note when saving a sale. "0" or "1".

print_note_on_receipt

string

Indicates whether the sale note should be printed on the receipt. "0" or "1".

ask_for_user_on_sale

string

Indicates whether the user prompt should appear after the sale. "0" or "1".

show_discounts_on_receipt

string

Indicates whether discounts values should appear on the receipt. "0" or "1".

receipt_header

string

Content of the receipt header. May contain HTML.

receipt_barcoded

string

Indicates whether the barcode should be printed on the receipt. "0" or "1".

receipt_footer

string

Content of the receipt footer. May contain HTML.

receipt_style_class

string

internal

invoice_prefix

string

Text to be used as prefix of the invoice number.

invoice_suffix

string

Text to be used as suffix of the invoice number.

invoice_sequence

int32

The numeric part of the last created invoice number.

register_open_count_sequence

string

internal The number of the current register closure.

register_open_sequence_id

uuid

internal The ID of the current register closure.

register_open_time

string

The time when the register was opened.

register_close_time

string

Time time when the register was closed. May be blank if the register is currently open.

cash_managed_payment_type_id

uuid

internal The ID of the payment type used for cash management functionality.

is_quick_keys_enabled

boolean

internal Indicated whether the register is using quick keys.

quick_key_template_id

uuid

internal The ID of the quick keys template the register is using.

pagination

object

Optional pagination object

results

int32

Total amount of objects matching the query.

page

int32

Current page.

page_size

int32

Current page size.

pages

int32

The total amount of pages to iterate through.

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://example.retail.lightspeed.app/api/registers \
3
     --header 'accept: application/json'

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

application/json

200