/api/user37
Authenticated user profile with tours, addresses, boxes, discounts, vouchers, bonus data and outstanding payments. Data is ultimately updated only upon login, except the outstanding payments, which are read on every call.
Change Note: same as user36, UserInfo v24 adds nobonus
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 |
Error Responses
| HTTP Status | Error Code | Description |
|---|---|---|
| 403 | not_authenticated | User session is not authenticated |
| 403 | violation | Security violation detected |
| 400 | parameter_error | Address action (NewAddress/UpdateAddress) failed due to invalid parameter |
Response Types
| Type | Version | Description |
|---|---|---|
| UserInfo | 24 | Authenticated user profile and preferences |
| Tour | 6 | A delivery tour assigned to the customer |
| Address | 23 | A delivery address with geo-coordinates and delivery hints, extended with driver tour-plan info (translated hints, box placement position) and the customer-facing placement note. |
| Box | 2 | A subscription box assigned to the customer |
| Discount | 2 | An active discount for the customer. If this record is provided, it must be active for the caller. |
| Voucher | 1 | A voucher code assigned to the customer |
| BonusCampaign | 1 | A bonus campaign defining rules for point collection and rewards |
| BonusReward | 4 | Rewards possible for the campaigns and their state |
| BonusDiscount | 1 | A discount granted to the customer when a bonus reward is reached. Referenced by BonusReward.discount. Not necessarily currently active for the caller. Class Derived from userDiscount. |
| OutstandingPayment | 1 | An open position of the customer that the back office has not settled yet, e.g. deposit |
OpenAPI
See user37.yaml