try out ↗

← API Index


/api/client/setprofile8

Update user profile/address and return the updated user data with tours, addresses, boxes, discounts, vouchers and bonus.

Change Note: v7 + Tour v6 (adds shipping)

Parameters

Name Description Type
opener salutation (e.g. Herr, Frau) string
firstname first name string
name last name string
street street and house number string
zip postal code string
city city string
country ISO country code (2-3 chars) string
email email address string
email1 secondary email address (CC only, cannot login) string
phone phone number string
mobile mobile number string
note delivery hints string
passwd new password (requires verify parameter) string
verify password confirmation (must match passwd) string
e_bank bank name string
e_blz BIC/SWIFT code string
e_konto IBAN/bank account string
noad no-advertising flag (1=opted out) int
autosave cart autosave opt-in of the customer (1=on, 0=off). Effective only if the shop has cart autosave enabled; see the cart-autosave skill int
placenote delivery placement instructions string
company company name string
dept department string
chint- customer-facing placement note for the given own address string
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 (e.g. attempt to change protected fields)
400 email_exists new email address already exists in the system
400 parameter_error parameter validation failed (detail in X-oekobox-error header as parameter_error:field:reason)
400 no_such_user user does not exist

Response Types

Type Version Description
UserInfo 21 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 1 Rewards possible for the campaigns and their state

OpenAPI

See setprofile8.yaml

Other versions