customerAccounts/ endpoint provides a REST interface for managing customer data in the shop system. The API enables creating, retrieving, updating, and deleting customer accounts, addresses, and bank details. Additionally, data can be exported or password resets initiated. All endpoints are designed to enable systematic management and maintenance of customer data beyond the admin interface.
Supported methods
List of all supported methods.Data fields
Data fields of a customer account
Example
Data fields of an address
Example
Data fields of a bank account
Example
Methods for customer data
The methods described here enable complete management of customer data in the system. This includes retrieving, creating, updating, and deleting customer accounts as well as exporting data and resetting passwords. In addition, information about already deleted accounts can be retrieved. Different permissions apply to each operation to ensure that only authorized users can access the respective functions.GET customerAccounts
This method retrieves a paginated list of all customers in the shop system. In addition to basic customer information such as ID, email address, and phone number, each response also contains associated address and bank data. Optional filter and sort parameters allow the results to be specifically restricted and sorted. The maximum number of results per request is 300. Read permissions for customer data are required to access this interface.Example
Response
Filter fields
id, customerNumber, loginBlocked, deleted, createdAt, updatedAt
Sort fields
id, customerNumber, loginBlockedAt, deletedAt, createdAt, updatedAt
Error codes
GET customerAccounts/{accountId}
This method loads the complete data of a customer account by its ID. In addition to the master data such as email address, phone number, and customer number, the response also contains additional information such as allowed subshops, bank data, addresses, and metadata (e.g. last login or payment method used). Read permissions for customer data are required to access this method. If no account with the specified ID is found, a corresponding error is returned.Example
Response
Error codes
GET customerDataDeleted
This method returns a list of customer data records that have been marked as deleted. Each entry contains the account ID, the time of deletion (deletedAt), and a type value describing the type of deleted data.
Filter and sort parameters are available to specifically restrict the result set. Read permissions for customer data are required.
Example
Response
Filter fields
id, type, deletedAt
Sort fields
id, type, deletedAt
Error codes
POST customerAccounts
This method creates a new customer account. In addition to basic data such as email address, phone number, or password, settings for subshop assignment and preferred addresses can also be provided. The request body must contain at least a valid email address and a password. Further optional fields such asmainAddress or allowedSubshopIds allow finer configuration of the account.
Optionally, an accountId (positive integer) can be provided to create the account with a specific ID. If no accountId is specified, the system automatically assigns a new ID.
Create rights for customer data are required.
Example
Response
Error codes
POST customerAccounts/{accountId}/passwordReset
This method sends a password reset link to the email address stored in the customer account. This is helpful if a user has lost access to their account or wants to reset their password. Write rights for customer data are required.Example
Response
Error codes
PUT customerAccounts/{accountId}
This method updates an existing customer account by its ID. Among other things, the email address, phone number, address references, and subshop assignment can be changed. Write rights for customer data are required.Example
Request body
Response
Error codes
DELETE customerAccounts/{accountId}
This method deletes a customer account by its ID. The deletion is permanent and removes the account, including all associated data, from the system. Delete rights for customer data are required.Example
Response
Error codes
GET customerAccounts/deleted
Returns a paginated list of deleted customer accounts. This method complementsGET customerDataDeleted (section 3.3), which returns deleted address and bank data. Read rights for customer data are required.
Example
Response
Error codes
POST customerAccounts/{accountId}/activate
Activates a customer account and sends an invitation email to the stored email address. The account must have a verified email address (or email verification must be disabled in the configuration). Invitation links can be sent at most once per 24 hours. Write rights for customer data are required.Example
Response
Error codes
GET customerAccounts/{accountId}/link
Generates a temporary login link via which a customer can log in directly to the shop. The link is valid for 30 seconds. Write and delete rights for customer data are required.Example
Response
Error codes
Methods for addresses and bank data
This section describes the methods for managing addresses and bank data within a customer account. Both data types are handled structurally the same: storage and loading are done in the same way. The only difference lies in the endpoint — instead ofaddresses, bankData is used in the URL for bank data.
GET customerAccounts/{accountId}/addresses
This method retrieves all available addresses of a specific customer account. The request returns a list of all address data records linked to the specified account. The endpoint described here applies analogously to bank data — simply replaceaddresses with bankData in the path.
A corresponding read permission is required for access.
Example
Response
Error codes
GET customerAccounts/{accountId}/addresses/{id}
This method returns the details of a single address assigned to a specific customer account. The address is retrieved by its ID. The endpoint described here applies analogously to bank data — simply replaceaddresses with bankData in the path.
Access requires a valid read permission for customer data.
Example
Response
Error codes
POST customerAccounts/{accountId}/addresses
This method creates a new address for a specific customer account. The required fields for the address are provided in the request body. Validation is performed server-side, and erroneous fields are specifically named in the server response. The endpoint described here applies analogously to bank data — simply replaceaddresses with bankData in the path.
Write and create rights for customer data are required for execution.
Example
Request body
Response
Error codes
PUT customerAccounts/{accountId}/addresses/{id}
This method updates an existing address of a customer account. Only the fields provided are changed; a complete address structure is not required. Validation is performed server-side — erroneous fields are indicated in the response. The endpoint described here applies analogously to bank data — simply replaceaddresses with bankData in the path.
Permission to write customer data is required for execution.
Example
Request body
Response
Error codes
DELETE customerAccounts/{accountId}/addresses/{id}
This method deletes an address from a customer account. It is checked whether the address actually belongs to the specified account. The endpoint described here applies analogously to bank data — simply replaceaddresses with bankData in the path.
Write and delete rights for customer data are required for execution.
Example
Response
Error codes
Bulk methods
This section describes the bulk endpoints that can be used to query or process multiple data records in a single request.GET bulk/lastOrderTimestamp
Returns the timestamp of the last order for multiple customer accounts. Invalid account IDs and accounts without orders are skipped. Read rights for customer data are required. The mandatoryaccountId (Integer) parameter specifies the customer account ID and can be specified multiple times to query multiple accounts.