/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

(String) optionally define the response-format for this call. One of: compact (default) | compacts | full | fulls | json | md | html | js | openapi | yaml
(int) 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.

Error Responses

HTTP StatusError CodeDescription
403not_authenticatedUser session is not authenticated
403violationSecurity violation detected
400parameter_errorAddress action (NewAddress/UpdateAddress) failed due to invalid parameter

Response Types

UserInfo

UserInfo (v24) docs

Authenticated user profile and preferences

Fields (68)
#FieldTypeDescriptionLinks
0authstringauthentication state: SUPER, ADMIN, AUTH, VALID, INVALID, NONE
1idintcustomer id
2openerstringsalutation (e.g. Herr, Frau) (translatable)
3firstnamestringfirst name
4namestringlast name
5roleintuser role (negative value means blocked)
6debugintdebug mode flag
7d_loadintdisplay option: load indicator
8d_serveintdisplay option: serve indicator
9d_nextintdisplay option: next delivery info
10d_next_loadintdisplay option: next delivery load info
11d_trackingintdisplay option: delivery tracking
12pref_asdcintpreference: auto-ship date change
13emailstringprimary email address
14email1stringsecondary email address
15phonestringphone number
16mobilestringmobile phone number
17countrystringcountry code (e.g. DE)
18zipstringpostal code
19citystringcity name (translatable)
20streetstringstreet address (translatable)
21e_kontostringIBAN or bank account reference
22paycodeintpreferred payment method code (0=unknown, 1=invoice, 2=paypal, ...)
23notestringcustomer note
24placecodeintplacement/location code
25sepa_mandatestringSEPA mandate reference with date, empty if none
26dnamestringdelivery address name
27dzipstringdelivery address postal code
28dcitystringdelivery address city (translatable)
29dstreetstringdelivery address street (translatable)
30companystringcompany name (translatable)
31noadintno-advertising flag (1=opted out)
32placenotestringplacement/location note for delivery
33pref_abocartintpreference: subscription cart mode
34pref_partialintpreference: allow partial deliveries
35deptstringdepartment (translatable)
36vatidstringVAT identification number (translatable)
37dcompanystringdelivery address company name (translatable)
38ddeptstringdelivery address department (translatable)
39anotestringaddress note
40accountdoubleaccount balance
41tracemeinttracking opt-in flag
42trivialinttrivial customer flag (computed)
43nc_limitdoublenew customer order limit
44needs_tcintneeds to accept terms and conditions (again)
45e_blzstringbank code (BLZ)
46activeintaccount active flag
47boxcntintnumber of boxes managed by backend
48rgroup_untildatediscount group membership valid until
49event_notification1stringevent notification preference (ORDER_CONFIRMATION)
50event_notification2stringevent notification preference (FORGOTTEN_CART)
51event_notification3stringevent notification preference (DELIVERY_NOTICE))
52event_notification4stringevent notification preference (ORDER_CHANGE)
53event_notification5stringevent notification preference (ORDER_REMINDER))
54event_notification6stringevent notification preference (PROFILE_CHANGES)
55event_notification7stringevent notification preference (NEWSLETTER)
56event_notification8stringevent notification preference (box deposit))
57norefundintrefund disabled flag
58has_ordersintwhether the customer has ever placed orders
59items_overrideint[]array of item IDs with customer-specific price overrides
60autosaveintcart auto-save preference
61birthdaydatedate of birth
62allowed_paycodesint[]list of allowed payment method codes.
  • 0: Unknown / not set
  • 1: SEPA direct debit (Lastschrift). Requires SEPA mandate and mandate date.
  • 2: PayPal. Requires a PayPal account to be configured in shop settings.
  • 3: Other / legacy (Vereinbarte Zahlungsweise)
  • 4: Phone / legacy, no longer used
  • 5: Invoice (Rechnung). Requires invoice option to be enabled in shop settings.
  • 6: Prepaid bank transfer (Überweisung / Vorauskasse). Shows QR code and bank details.
  • 7: Wero
  • 8: Cash on delivery (Barzahlung)
  • 9: Prepaid via PayPal link. A PayPal payment link is sent in the confirmation email.
  • 10: Prepaid, shows QR code only
  • 11: Prepaid with PayPal link displayed in shop/profile (reserved)
  • 12: real-time transaction (reserved)
  • 13: BS Payone (reserved)
63rgroupintdiscount group id reference🔗 discount_groupid
64actiongroupsint[]IDs of Aktionsgruppen (action groups) this customer is a member of
65orgtypeintcustomer organization type: 0 unset/unknown, 1 company, 2 private
66nonudgebooltrue if the customer does not want the cart suggestion of regularly bought items (Nicht vergessen); set with api/client/nudge1
67nobonusbooltrue if the customer takes part in no bonus campaign (customers.nobonus): the bonus lists are empty, and joining or claiming is refused with not_eligible

Data (1 record)

authidopenerfirstnamenameroledebugd_loadd_served_nextd_next_loadd_trackingpref_asdcemailemail1phonemobilecountryzipcitystreete_kontopaycodenoteplacecodesepa_mandatednamedzipdcitydstreetcompanynoadplacenotepref_abocartpref_partialdeptvatiddcompanyddeptanoteaccounttracemetrivialnc_limitneeds_tce_blzactiveboxcntrgroup_untilevent_notification1event_notification2event_notification3event_notification4event_notification5event_notification6event_notification7event_notification8norefundhas_ordersitems_overrideautosavebirthdayallowed_paycodesrgroupactiongroupsorgtypenonudgenobonus
NONE000000000000000.0000.001000[]0[2, 1, 5]0[]0falsefalse