API Reference

Bulk delete products

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

Deletes every product that matches the filters you pass. The filters are the same ones GET /products.json takes.

This deletes every record that matches your filters, so double-check them with the matching list call first. Run GET /products.json with exactly the same filters and check the result before you delete.

Multiple tags delete more

tagged=a,b matches records with any of the tags, so this deletes everything tagged a or b. List first with the same filters to check what will go.

Required permission (any one of these):

GroupPermission
ProductsView item cost history
ProductsChange item costs (includes view)
ProductsCreate, edit and delete products (includes view)
Query Params
integer

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

string

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

string

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

string

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

string

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

string

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

date-time

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

date-time

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

string

Partial match on name.

string

Partial match on style.

date-time

Greater than (not including) the updated.

date-time

Less than (not including) the updated.

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?