List promotions

get

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

Returns your promotions, 50 at a time by default. Page through them 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
Sales	List and view promotions
Sales	Create, edit and delete promotions (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 promotions with an ID greater than this one. Handy for picking up where you left off.

name

string

Partial match on name.

market_id

string

Exact match on market_id.

market_ids

string

Comma-separated list matched against market_id.

ids

string

Comma-separated list matched against id.

updated_min

date-time

Greater than (not including) the updated.

updated_max

date-time

Less than (not including) the updated.

created_min

date-time

Greater than (not including) the created.

created_max

date-time

Less than (not including) the created.

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.

from_date_from

string

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

from_date_to

string

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

to_date_from

string

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

to_date_to

string

Up to this to date. 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, created, updated, position. 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.

400A filter value isn't valid. The message names the parameter, for example: created_from must be a date (YYYY-MM-DD) or RFC3339 timestamp cannot sort by "<key>" Text filters over 200 characters return <param> value is too long (max 200 characters).

404Not found. Smooth POS also answers with a 404 when your token is missing or invalid, so check the error message. Possible error messages: no promotions found not authorised