Point of sale favourites (add-on)
The product buttons on the Sell screen, and the product search that finds what to put on them.
All take kahunacart.pos.manage. A favourite is for one pickup location or, with no location_id, for every location. See Selling.
List the favourites
/api/v1/kahunacart/pos/admin/favourites
The product buttons on the till's Sell screen, per pickup location (location_id) or for every location (location_id null), in order, each with the variant it rings up.
Add a favourite
/api/v1/kahunacart/pos/admin/favourites
Add a variant as a button on the Sell screen, at the end of the list, for one pickup location or (without location_id) for every location.
Parameters
| Name | Type | Description |
|---|---|---|
| variant_id required | integer | The variant the button rings up. |
| location_id optional | integer | The pickup location whose tills show it. Leave out for every location. |
Reorder the favourites
/api/v1/kahunacart/pos/admin/favourites/order
Put favourites in a new order: their ids, first to last. A location's own buttons always come before the every-location ones.
Parameters
| Name | Type | Description |
|---|---|---|
| ids required | array of integer | Favourite ids in their new order. |
Remove a favourite
/api/v1/kahunacart/pos/admin/favourites/{id}
Take a button off the Sell screen.
Parameters
| Name | Type | Description |
|---|---|---|
| id required | integer | The favourite id. |
Find products for the favourites
/api/v1/kahunacart/pos/admin/products
Find products to put on the till's favourites grid, the way the till's own search finds them (title, SKU or barcode). Each answer is a variant with its product title, options, SKU, barcode, price, stock and picture. Pass its variant_id to add_favourite.
Parameters
| Name | Type | Description |
|---|---|---|
| q required | string | What to look for. |
| limit optional | integer | At least 1, at most 50. |