try out ↗

← API Index


/api/client/regorder2

Guest registration including an order: create a new customer account and place an order in a single call. Combines the NewAddress and StoreOrder actions; logs out at the end unless no_logout=1 is set. Use dcity/dzi/dstreet for the delivery address.

Change Note: replaces legacy regorder1

Parameters

Name Description Type
opener salutation/title (1-20 chars) string
firstname first name (1-35 chars) string
name surname (2-100 chars, name and email cannot both be empty) string
company company name string
street optional for invoicing, street and house number (2-35 chars) string
zip optional for invoicing postal code (3-5 chars) string
city optional for invoicing 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 required delivery street (2-35 chars) string
dzip required delivery postal code (3-5 chars) string
dcity required delivery city (2-150 chars) string
dcompany delivery address company name (2-150 chars) string
ddept delivery address department name (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); regorder2 disables this by default 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). Use this when not previously figuring out a tour using findTour() calls. int
tourid1 internal tour ID for customer assignment - if you already know the tour to be assigned. int
placenote delivery instructions (max 200 chars) string
dept department string
ddate_iso delivery date: yyyy-MM-dd, or an ISO 8601 timestamp (2026-10-13T22:00:00.000Z as sent by the JS client, or 2026-10-14T00:00:00+02:00); a timestamp is resolved to its day in the shop's time zone string
tour tour id int
opos order positions as HTTP POST list parameter string
order order data as HTTP POST list parameter string
shot internal: indicates single-shot order mode string
no_logout if 1, do not log out the guest customer after the order is placed int
used_paycode payment code the customer indicated for this order (must be one of the customer's allowed paycodes) int
ragb if 1, the customer accepts the terms and conditions (AGB) again with this order and the acceptance date is stored. Send it when UserInfo.needs_tc is 1, i.e. the shop changed its terms (public config key agbChangeDate, hint text agbChangeHint) after the customer's last acceptance. There is no per-order re-approval; the order is stored either way, the client has to insist on the checkbox int
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
409 email_exists email is already in the system and the call configuration requires a unique email
409 email_required no email provided, but system requires an email
409 agb_required AGB/terms not accepted and the system has AGB configured
409 dse_required privacy policy not accepted
409 bank_required system requires bank data but it was not provided
409 address_not_new address already exists, no update performed
400 parameter_error parameter validation failed (detail in X-oekobox-error header as parameter_error:field:reason)
409 tblocked temporarily blocked because of too many registration attempts
409 not_stored general error storing order
409 no_date no delivery date
404 empty no items in order
409 too_late order stop has passed
409 locked order is locked
409 protected_items order contains protected items
409 below_mbw order is below minimum order value
409 exceeded order limit exceeded
409 no_change no changes detected
409 duplicate duplicate order detected
409 insufficient_sales_items insufficient sales items in stock
409 retry temporary conflict, please retry
403 security_error security violation

Response Types

Type Version Description
ChangeOrderResult 1 Optional Result of a order mutation action (order submission, cancellation, etc.)
ShopDate 8 A delivery date with order, tour, shipping, and address information
Pause 1 A delivery pause period
Subscription 4 A standing subscription (item or assortment box)
Favourite 1 A shelf favourite (bookmarked item or menu level)
AuxDate 1 An auxiliary calendar event or notice
DeselectedItem 1 An item preferably excluded from a customer's assortment
DeselectedGroup 1 A category preferably excluded from a customer's assortment

OpenAPI

See regorder2.yaml

Referenced in skills