List gift cards

get

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

Returns your gift cards, oldest first, with their initial_amount, current_amount and expiration.

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
Customers	List and view gift cards; manage = issue and extend
Customers	Create, edit and delete gift cards; manage = issue and extend (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.

serial

string

Partial match on serial.

reason

string

Exact match on reason.

reason_in

string

Comma-separated list matched against reason.

current_amount_min

date-time

Minimum current amount, inclusive. (You can also use min_current_amount.)

initial_amount_min

date-time

Minimum initial amount, inclusive. (You can also use min_initial_amount.)

expiration_min

date-time

Greater than (not including) the expiration.

expiration_max

date-time

Less than (not including) the expiration.

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.

ids

string

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

Matches one ids 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).

sale_id

string

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

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

account_id

string

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

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

min_current_amount

number

Minimum current amount, inclusive.

max_current_amount

number

Maximum current amount, inclusive.

min_initial_amount

number

Minimum initial amount, inclusive.

max_initial_amount

number

Maximum initial amount, inclusive.

expiration_from

string

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

expiration_to

string

Up to this expiration. 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.

string

Text search: matches records where any of serial, reason contains this text (up to 200 characters).

sort

string

Sort order. Use sort=key for ascending or sort=-key for descending, for example sort=-created. Keys: id, serial, currentamount, initialamount, created, updated, expiration. 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 giftcards found not authorised