List sale lines

get

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

Returns individual sale lines across all your sales, one row per line, with the sale's receipt number, store and status alongside each line. Handy for reporting at item level.

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.

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

limit

integer

1 to 250

Defaults to 50

How many results 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.

store_in

string

Comma-separated list matched against store_id.

register_in

string

Comma-separated list matched against register.

ids

string

Comma-separated list matched against id.

since_id

integer

Greater than (not including) the id.

created_min

date-time

Greater than (not including) the created.

created_max

date-time

Less than (not including) the created.

customer_ids

string

Comma-separated list matched against customer_id.

quantity_min

date-time

Greater than (not including) the quantity.

quantity_max

date-time

Less than (not including) the quantity.

string

Partial match on first_name; Partial match on last_name; Partial match on email; Exact match on receipt_number; Partial match on serial_number; Partial match on style; Partial match on sku; Partial match on name; Partial match on description.

store_id

string

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

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

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.

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.

item_id

string

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

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

min_item_price

number

Minimum item price, inclusive.

max_item_price

number

Maximum item price, inclusive.

serial_number

string

Exact match on serial number. Send one value or a comma-separated list.

sort

string

Sort order. Use sort=key for ascending or sort=-key for descending, for example sort=-created. Keys: created, updated. The older sort_field=key&sort=asc|desc style still works.

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