List addons
get
https://api.flactrum.com/v1/addons
| Required scope | addons.read |
| Panel screen | Menu & products → Addons |
| Success status | 200 |
| Returns | A paginated list of Addon objects |
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| group_id | query | string | — |
| search | query | string | — |
| page | query | integer | Page number. |
| per_page | query | integer | Page size. Values above the maximum are rejected rather than silently clamped. |
| active | query | boolean | Filter by active flag. Omit to get both. |
| updated_since | query | string | Only records changed at or after this instant. Use it for incremental sync. |
| lang | query | string | Language for translatable fields. Must be configured for the brand. |
| sort | query | string | Column to sort by. Each endpoint lists what it accepts. |
| direction | query | string | Sort direction. |
Response fields
| Field | Type | Description |
|---|---|---|
| id | string | — |
| group_id | string | — |
| name | string | — |
| price | number | — |
| stock_item_id | string|null | Set when the addon consumes a raw material on sale. |
| quantity_per_use | number|null | Amount deducted per use, in the item's base unit. |
| quantity_unit | string|null | The stock item's own unit (kilogram, litre…). |
| entry_quantity_per_use | number|null | quantity_per_use expressed in quantity_unit. |
| waste_percent | number | Trim percentage added on top of quantity_per_use. It comes off stock AND goes into the cost: 30 ml at 10% deducts 33 ml and is costed at 33 ml. |
| gross_quantity_per_use | number|null | quantity_per_use with the trim added — what actually leaves stock. |
| is_active | boolean | — |
| sort_order | integer | — |
Examples
No recorded example yet.