/api/system/bonus/list
Lists all available bonus campaigns. When not authenticated, only campaigns are shown that are not limited by customer group. When authenticated, only available campaigns are shown
Parameters
| Name | Description | Type |
|---|---|---|
| oo-rf | optionally define the response-format for this call. One of: compact (default) | compacts | full | fulls | json | md | html | js | openapi | yaml | String |
| oo-auth | optionally force the API to check against the role (instead of silently not returning data). For guests or public access, the default is -1. 0 (regular customer) and above define the role for which the current session is expected to be authorized. | int |
Response Types
| Type | Version | Description |
|---|---|---|
| BonusCampaign | 1 | A bonus campaign defining rules for point collection and rewards |
OpenAPI
See list.yaml
Referenced in skills
Other versions
- /api/system/bonus/list2 (newer)