List items

get

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

Returns your items (product variants) across all products, 50 at a time by default. Page through them with the X-Next-Page header.

Each row includes the parent product's active flag. Filter with active=true or active=false.

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

Required permission (any one of these):

Group	Permission
Products	List and view products
Products	Create, edit and delete products (includes view)

Query Params

limit

integer

1 to 250

Defaults to 50

How many records to return per page. Defaults to 50, maximum 250.

cursor

string

Opaque paging cursor. Don't build this yourself: follow the path in the X-Next-Page or X-Prev-Page response header.

name

string

Partial match on name.

style

string

Partial match on style.

type

string

Partial match on type.

vendor

string

Partial match on vendor.

ids

string

Comma-separated list matched against id.

since_id

integer

Greater than (not including) the id.

string

Partial match on name; Partial match on style; Partial match on sku; Partial match on description; Partial match on type; Partial match on vendor; Exact match on barcode.

vendor_in

string

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

type_in

string

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

style_in

string

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

barcode

string

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

sku

string

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

product_id

string

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

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

item_id

string

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

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

active

boolean

Filter on whether the parent product is active: true or false (1/0 work too). Leave it out to return items for both active and inactive products. Works with the other filters, sorting and cursor paging.

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.

sort

string

Sort order. Use sort=key for ascending or sort=-key for descending, for example sort=-created. Keys: id, name, style, type, vendor, created, updated. The older sort_field=key&sort=asc|desc style still works. Only id gives reliable X-Next-Page links on this list, so use one of those if you're paging through more than one page.

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. Smooth POS also answers with a 404 when your token is missing or invalid, so check the error message. Possible error messages: not authorised