List sales

get

https://api.smoothpos.net/sales.json

Returns your sales as a JSON array, oldest first. Narrow it down with the filters below, for example by date, store or receipt number.

Sales in this list don't include their lines. Add get_lines=true if you need them.

Results are paged (50 per page by default, up to 250 with limit). If there's another page, you'll get an X-Next-Page header. Request that path to continue.

Keeping in sync? Save the highest id you've processed and pass it as since_id next time.

See Filtering, sorting and search for how the filters, ranges and sort work.

Required permission (any one of these):

Group	Permission
Sales	List and view sales; manage = create sales and change their staff member or customer
Sales	Create, edit and delete sales; manage = create sales and change their staff member or customer (includes view)

Query Params

since_id

integer

Only return sales with an id greater than this one. Use it for incremental syncs.

ids

array of int64s

Only return these sales, comma-separated, e.g. 1152264,1157926.

ids

created_min

date-time

Only return sales created on or after this time (UTC). Accepts 2026-09-01 or 2026-09-01T00:00:00Z. An invalid value returns an empty list.

created_max

date-time

Only return sales created on or before this time (UTC).

receipt_number

string

Find the sale with this exact receipt number.

string

Search by receipt number or by customer name or email.

store_in

array of int64s

Only return sales from these store IDs, comma-separated.

store_in

total_price_min

number

Only return sales with a total_price of at least this amount.

sort_field

string

Older way to choose the sort field, used with sort=asc or sort=desc. Still supported. Keys: id, created, updated, localcreated, receiptnumber, totalprice, totalpaid, totaldiscount, totalquantity, customerid, storeid.

sort

string

Sort order. Use sort=key for ascending or sort=-key for descending, for example sort=-created. Keys: id, created, updated, localcreated, receiptnumber, totalprice, totalpaid, totaldiscount, totalquantity, customerid, storeid. The older sort_field=key&sort=asc|desc style still works.

get_lines

boolean

Set to true to include each sale's lines.

limit

integer

1 to 250

Defaults to 50

How many sales per page. Defaults to 50, maximum 250.

cursor

string

Paging cursor. Don't build it yourself; take the whole path from the X-Next-Page header.

register_in

string

Comma-separated list matched against register.

total_price_max

date-time

Less than (not including) the total_price.

total_discount_max

date-time

Less than (not including) the total_discount.

total_discount_min

date-time

Greater than (not including) the total_discount.

total_loyalty_max

date-time

Less than (not including) the total_loyalty.

total_loyalty_min

date-time

Greater than (not including) the total_loyalty.

total_loyalty_points_max

date-time

Less than (not including) the total_loyalty_points.

total_loyalty_points_min

date-time

Greater than (not including) the total_loyalty_points.

customer_ids

string

Comma-separated list matched against customer_id.

store_id

string

^\d+(,\d+)*$

Matches one store id or a comma-separated list (up to 200).

store_ids

string

Comma-separated list matched against store_id.

customer_id

string

^\d+(,\d+)*$

Matches one customer id or a comma-separated list (up to 200).

employee_id

string

^\d+(,\d+)*$

Matches one employee id or a comma-separated list (up to 200).

string

^\d+(,\d+)*$

Matches one register or a comma-separated list (up to 200).

min_total_price

number

Minimum total price, inclusive.

max_total_price

number

Maximum total price, inclusive.

min_total_paid

number

Minimum total paid, inclusive.

max_total_paid

number

Maximum total paid, inclusive.

min_total_tax

number

Minimum total tax, inclusive.

max_total_tax

number

Maximum total tax, inclusive.

min_total_discount

number

Minimum total discount, inclusive.

max_total_discount

number

Maximum total discount, inclusive.

total_quantity

string

^\d+(,\d+)*$

Matches one total quantity or a comma-separated list (up to 200).

min_total_quantity

integer

Minimum total quantity, inclusive.

max_total_quantity

integer

Maximum total quantity, inclusive.

local_created_from

string

From this local created. Accepts YYYY-MM-DD (a _to date covers the whole day) or a full timestamp (RFC 3339, converted to UTC). Inclusive.

local_created_to

string

Up to this local created. Accepts YYYY-MM-DD (a _to date covers the whole day) or a full timestamp (RFC 3339, converted to UTC). Inclusive.

created_from

string

From this created. Accepts YYYY-MM-DD (a _to date covers the whole day) or a full timestamp (RFC 3339, converted to UTC). Inclusive.

created_to

string

Up to this created. Accepts YYYY-MM-DD (a _to date covers the whole day) or a full timestamp (RFC 3339, converted to UTC). Inclusive.

updated_from

string

From this updated. Accepts YYYY-MM-DD (a _to date covers the whole day) or a full timestamp (RFC 3339, converted to UTC). Inclusive.

updated_to

string

Up to this updated. Accepts YYYY-MM-DD (a _to date covers the whole day) or a full timestamp (RFC 3339, converted to UTC). Inclusive.

Responses

Language

Credentials

Header

Loading…

Response

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

application/json

200Success.

404Not found, or your X-Smoothpos-Auth token is missing or invalid. (Smooth POS uses 404 for auth failures too.) Possible error messages: no products found not authorised