List products

get

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

Returns your products with their items, 50 at a time by default, in ascending ID order. Narrow the list with the filters below (including active) and page through it with the X-Next-Page header.

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

Required permission (any one of these):

Group	Permission
Products	View item cost history
Products	Change item costs (includes view)
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.

since_id

integer

Only return products with an ID greater than this one. Handy for picking up where you left off.

ids

string

Comma-separated list of product IDs to fetch, e.g. 392056,392058.

string

Free-text search, for example on the product name.

tagged

string

Only records with any of these tags. Send one tag or a comma-separated list, up to 50.

type

string

Only return products of this type. See GET /products/types.json for the values.

vendor

string

Only return products from this vendor. See GET /products/vendors.json for the values.

created_min

date-time

Only return products created on or after this date/time (ISO 8601).

created_max

date-time

Only return products created on or before this date/time (ISO 8601).

sort_field

string

Older way to choose the sort field, used with sort=asc or sort=desc. Still supported. Keys: id, name, style, type, vendor, created, updated.

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.

name

string

Partial match on name.

style

string

Partial match on style.

updated_min

date-time

Greater than (not including) the updated.

updated_max

date-time

Less than (not including) the updated.

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.

active

boolean

Filter on whether the product is active: true or false (1/0 work too). Leave it out to return 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.

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