API Reference

List prices

get
https://api.smoothpos.net/prices.json

Returns your price records, 50 at a time by default, in ascending ID order. Page through them with the X-Next-Page header.

Required permission (any one of these):

GroupPermission
ProductsList and view retail prices
ProductsAdd, change and delete retail prices (includes view)
Query Params
integer
1 to 250
Defaults to 50

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

string

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

integer

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

string

Comma-separated list matched against id.

string

Comma-separated list matched against product_id.

string

Comma-separated list matched against item_id.

string

Exact match on market_id.

date-time

Greater than (not including) the updated.

date-time

Less than (not including) the updated.

date-time

Greater than (not including) the created.

date-time

Less than (not including) the created.

date-time

Greater than (not including) the start_date.

date-time

Less than (not including) the start_date.

string

Exact match on start_date.

date-time

Greater than (not including) the end_date.

date-time

Less than (not including) the end_date.

string

Exact match on end_date.

string

Only prices with any of these tags. These are the tags on the price records themselves, not the products' tags. Send one tag or a comma-separated list, up to 50.

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.

Responses

Updated 8 days ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 days ago

Did this page help you?