try out ↗

← API Index · ↑ methods


/api/client

Methods

Endpoint Description
/api/client/actiongroup Join or leave an Aktionsgruppe (action group) as the authenticated customer. Admins may act on behalf of another customer via the 'cid' parameter.
/api/client/addfavourite1 Add an item or entity to the user's favourites (shelf)
/api/client/addpause2 Add a delivery pause for the authenticated user
/api/client/addsubscription2 Create a new item or assortment subscription
/api/client/applybonus Apply for a bonus campaign. The customer opts into a campaign that requires explicit application.
/api/client/cancelorder7 Cancel an existing order
/api/client/changeorder8 Modify an existing order
/api/client/changesubscription2 Modify an existing subscription
/api/client/claimbonus Claim a bonus reward. Deducts the required points from the customer's balance.
/api/client/delivery3 Estimated delivery state for the caller's tour stops, plus the driver's current position.
/api/client/dropdeselected1 Remove a deselected item or group from the customer's exclusion list
/api/client/dropfavourite1 Remove an item or entity from the user's favourites (shelf)
/api/client/droppause2 Remove a delivery pause
/api/client/droppushtoken Remove a previously registered FCM device token; works for guests (no session) as well as logged-on customers
/api/client/dropsubscription2 Delete an existing subscription
/api/client/frequentitems1 The items most often in the logged-on customer's orders (Oft in deinen Bestellungen), most often first. Items that are not offered are left out.
/api/client/log1 Write a customer-related entry to the shop event log. The entry is attached to a customer record and shows up in the customer's activity log (also visible to the backend).
/api/client/newclient1 Create a new user account. Returns registration result and user profile on success.
/api/client/neworder8 Create a new order for a delivery date. If the shop allows only one order per delivery (setup allowmultiorders off, the default) and the customer already has an open order on that date and tour, the request is treated as a change of that order: the posted cart becomes its content and its id is returned, no second order is created (locked -> the one order of that date is in processing). Clients should normally send changeorder for a date that already has an order (see ShopDate.orderId)
/api/client/nudge1 Switch the cart suggestion (Nicht vergessen) off for the logged-on customer, or on again. The setting is kept in the customer profile, see nonudge in the user data.
/api/client/password2 Request a new password mail for an existing user. Looks up the account by email (and optional /cid suffix) or by numeric id, generates a password if none is set, and sends it to the user's mail address.
/api/client/ppauthorize1 Initiate a PayPal payment authorization. On success returns the PayPal token (orderID for the SDK).
/api/client/ppresponse1 Finalize a PayPal payment: shop calls this when the customer returns from the PayPal flow. Confirms or cancels the previously authorized payment.
/api/client/pushdelivered Report that an FCM push was delivered to this device; no session required
/api/client/pushopened Report that the user tapped an FCM push notification; no session required
/api/client/registerpushtoken Register an FCM device token; works for guests (no session) as well as logged-on customers
/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.
/api/client/reorderhints1 Items the logged-on customer buys regularly and may want to order for the selected delivery (Nicht vergessen), most due first. Items already in that order, unavailable ones and those that come with a subscription or box are left out.
/api/client/savecart1 Save the current cart server-side. Always updates the session cart from the given positions (backup of an unsubmitted cart). If cart autosave is active for the customer (shop setting cartAutosave plus customer opt-in), the cart is additionally written into an order: a new order on the first storable save, the same order on every following save - its id is returned as oid. Order mails of such autosaved orders are deferred to the end of the session. (JS) clients can call this periodically after cart changes; a later NewOrder/ChangeOrder for the same cart is routed to that order server-side, never to a duplicate.
/api/client/setprofile10 Update user profile/address and return the updated user data with tours, addresses, boxes, discounts, vouchers and bonus.
/api/client/setprofile11 Update user profile/address and return the updated user data with tours, addresses, boxes, discounts, vouchers and bonus.
/api/client/setprofile5 Update user profile/address and return the updated user data with tours, addresses, boxes, discounts, vouchers and bonus.
/api/client/setprofile6 Update user profile/address and return the updated user data with tours, addresses, boxes, discounts, vouchers and bonus.
/api/client/setprofile7 Update user profile/address and return the updated user data with tours, addresses, boxes, discounts, vouchers and bonus.
/api/client/setprofile8 Update user profile/address and return the updated user data with tours, addresses, boxes, discounts, vouchers and bonus.
/api/client/setprofile9 Update user profile/address and return the updated user data with tours, addresses, boxes, discounts, vouchers and bonus.
/api/client/settour5 Set the active delivery date and tour for the current shopping session
/api/client/state1 Polling endpoint: client passes a known order id (with its last-changed timestamp) OR a delivery date and tour id, server tells whether the order / date is still actionable.

Subdirectories