try out ↗

← API Index


/api/client/newclient1

Create a new user account. Returns registration result and user profile on success.

Change Note: dedicated newclient endpoint using POJO pattern, replaces user21.jsp dispatch

Parameters

Name Description Type
opener title/salutation (1-20 chars) string
firstname first name (1-35 chars) string
name surname (2-100 chars, name and email cannot both be empty) string
street street and house number (2-35 chars) string
zip postal code (3-5 chars) string
city city (2-150 chars) string
country ISO country code (2-3 chars, defaults to system setting) string
lang ISO language code (2 chars) string
email email address (required per system settings) string
email1 secondary email for CC copies (cannot be used for login) string
phone phone number (3-30 chars) string
mobile mobile number (3-30 chars, numeric preferred) string
regreasons register reasons the customer picked (how did you find us): ids of /api/system/register_reasons, comma separated; unknown ids are ignored string
dstreet alternate delivery street (2-35 chars) string
dzip alternate delivery postal code (3-5 chars) string
dcity alternate delivery city (2-150 chars) string
passwd password (0-20 chars, requires verify parameter) string
verify password confirmation (must match passwd) string
e_bank bank name (4-99 chars, required if system demands bank data) string
e_blz BIC/SWIFT code (8-11 chars, required if system demands bank data) string
e_konto IBAN/bank account (4-34 chars, required if system demands bank data) string
agb terms acceptance flag (1=accepted, required if system has AGB configured) int
checkemail fail if email already exists (1=check, recommended) int
dupcheck random value for duplicate submission detection string
silent suppress client emails during this session (1=silent) int
usenct assign configured new customer tour (1=assign, overrides tourid1) int
tourid1 internal tour ID for customer assignment int
placenote delivery instructions (max 200 chars) string
company company name string
dept department 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 not authenticated at all
403 violation illegal attempt to change security relevant settings
400 email_exists email is already in the system and the call configuration requires a unique email
400 email_required no email provided, but system requires an email
400 duplicate double request detected via dupcheck
400 agb_required AGB/terms not accepted and the system has AGB configured
400 dse_required privacy policy not accepted
400 parameter_error parameter validation failed (detail in error_field:error_reason, e.g. iban, too_short, too_long, is_null, verify, email_wrong)
400 tblocked temporarily blocked because of too many registration attempts
400 bank_required system requires bank data but it was not provided
400 address_not_new address already exists, no update performed

Response Types

Type Version Description
NewClientResult 1 Result of a new client registration attempt
UserInfo 21 Authenticated user profile and preferences
Tour 5 A delivery tour assigned to the customer
Address 15 A delivery address with geo-coordinates and delivery hints. A customer must have one, but may have more delivery addresses (=delivery options)
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.
ShopDate 8 A delivery date with order, tour, shipping, and address information

OpenAPI

See newclient1.yaml

Referenced in skills