b2b - Business-to-business (B2B) - WEBSALE Dokumentation

The b2b node contains the settings for shops with business customers. These include access restrictions, customer invitations, the management of employee accounts and the verification of new accounts. The following sections first describe the basic structure and then each sub-node individually.

`b2b*` - Basic structure

The basic structure of the b2b node is shown below:

{
  "b2b": {
    "access": {...},
    "accountVerification": {...},
    "subAccounts": {...},
    "userInvitation": {...}
  }
}

Parameter overview

Parameter	Description
`access`	Controls access restrictions.
`accountVerification`	Controls the verification of new B2B accounts.
`subAccounts`	Controls the invitation email for new employee accounts and the redirect for blocked pages.
`userInvitation`	Controls the invitation email for customers and the reminder email.

`b2b.access` - Access restrictions

This lets you configure the access restrictions for B2B customers, for example so that manual activation by the merchant is required before registration is complete.

Example configuration `b2b.access`

{
  "accessBeforeVerification": {
    "allowedTemplates": [
      "account/accountManagement.htm"
    ],
    "allowedUrls": [],
    "redirectTarget": "error.htm",
    "restricted": false
  },
  "allowedActions": [],
  "allowedTemplates": [],
  "allowedUrls": [],
  "redirectTarget": "error.htm",
  "restricted": false
}

Parameter overview

Parameter	Type	Description
`accessBeforeVerification`	object	Controls access restrictions for accounts that have not yet been verified. Only applies if the top-level `restricted` is active.
`accessBeforeVerification.restricted`	bool	Restricts access to pages (templates) for unverified accounts. Only the templates from `allowedTemplates` and the `redirectTarget` remain allowed. Whether category and product pages are visible is controlled by `b2b.accountVerification` via `permissionsBeforeVerification`. Default: false
`accessBeforeVerification.redirectTarget`	string	Name of the template an unverified account is redirected to if access is denied, for example `error.htm`. This template is always allowed.
`accessBeforeVerification.allowedTemplates`	list (string)	List of templates that may be called before verification, for example `account/accountManagement.htm`.
`accessBeforeVerification.allowedUrls`	list (string)	List of paths that may always be called before verification.
`restricted`	bool	Enables the access restrictions. Visitors who are not signed in can then only perform the `Login` and `GuestRegister` actions as well as the actions allowed in `allowedActions`. For signed-in accounts that are not yet verified, the settings from `accessBeforeVerification` also apply. Default: false
`redirectTarget`	string	Name of the template the visitor is redirected to when accessing a page that requires sign-in without being signed in, for example `error.htm`.
`allowedTemplates`	list (string)	List of templates that may also be called without sign-in.
`allowedUrls`	list (string)	List of paths that may also be called without sign-in, for example `/login` or `/register`.
`allowedActions`	list (string)	List of actions that visitors who are not signed in may perform despite the active restriction, for example `AccountRegister`. `Login` and `GuestRegister` are always allowed. If the list is empty, no further actions are allowed.

`b2b.userInvitation` - User invitation

This is where you configure the email used to invite a customer. The invitation is sent either via the Admin Interface or via the POST customerAccounts/{accountId}/activate endpoint of the Admin Interface API. The email contains a link the customer uses to accept the invitation with the AcceptInvitation action. In the template, you generate this link with the token name AcceptInvitation. Optionally, a reminder email can be sent as long as the invitation has not yet been accepted. The invitation link is valid for the duration defined in invitationLinkValidityInHours, but at least four hours. The same duration applies to the link in the password reset email (token name passwordReset). After the validity period expires, the invitation must be sent again. If reminderActive: true is set, a reminder email is sent for invitations that are still open as soon as reminderIntervalInHours hours have passed since the invitation was sent. Each open invitation receives at most one reminder.

The reminder email does not contain an opt-in token. In the reminder template, $wsOptIn.createTokenUrl() therefore only returns the URL without a token. In the reminder, link for example to a page where the customer can request a new invitation or contact the shop operator.

Example configuration b2b.userInvitation

{
  "email": {
    "fromAddress": "",
    "fromName": "",
    "subject": "",
    "template": ""
  },
  "invitationLinkValidityInHours": 24,
  "reminderActive": false,
  "reminderEmail": {
    "fromAddress": "",
    "fromName": "",
    "subject": "",
    "template": ""
  },
  "reminderIntervalInHours": 168
}

Parameter overview

Parameter	Type	Description
`email`	object	Configuration of the initial invitation email.
`fromAddress`	string	Sender address of the email, for example `noreply@mein-shop.de`.
`fromName`	string	Display name of the sender in the email, for example “Mein Onlineshop”.
`subject`	string	Subject line of the email as shown in the customer’s inbox.
`template`	string	Name or path of the email template to be used. This controls the content and layout of the email.
`invitationLinkValidityInHours`	int	Validity period of the invitation link in hours. Values below 4 are treated as 4 hours.
`reminderActive`	bool	Enables (`true`) or disables (`false`) the automatic sending of reminder emails for invitations that have not yet been accepted.
`reminderEmail`	object	Configuration of the reminder email. Only used if `reminderActive: true`.
`fromAddress`	string	Email address from which the reminder is sent.
`fromName`	string	Display name of the sender of the reminder email.
`subject`	string	Subject of the reminder email.
`template`	string	Name or path of the email template for the reminder email.
`reminderIntervalInHours`	int	Number of hours after the invitation was sent after which the reminder is sent if the invitation has not yet been accepted.

`b2b.subAccounts` - Employee accounts

Configures the invitation email a new employee receives when the administrator of a company account creates their employee account with the SubAccountCreate action. The email contains a link the employee uses to set their password with the ResetPassword action. In the template, you generate this link with the token name ResetPassword (with a capital R). The link is valid for four hours. The redirectTargetForForbiddenViews option also determines where an employee account is redirected when it calls a page that is blocked for its permission group. Example configuration b2b.subAccounts

{
  "email": {
    "fromAddress": "",
    "fromName": "",
    "subject": "",
    "template": ""
  },
  "redirectTargetForForbiddenViews": "error.htm"
}

Parameter overview

Parameter	Type	Description
`email`	object	Configuration of the invitation email for new employee accounts.
`fromAddress`	string	Sender address of the email, for example `noreply@mein-shop.de`.
`fromName`	string	Display name of the sender in the email.
`subject`	string	Subject line of the email.
`template`	string	Name or path of the email template.
`redirectTargetForForbiddenViews`	string	Template an employee account is redirected to when it calls a blocked page or URL. This template is always allowed. Default: `error.htm`

`b2b.accountVerification` - Account verification

Configures the verification process for B2B accounts. The requireEmailVerification and requireManualVerification options control which kind of verification is required. The verificationMerchantEmail option defines the emails sent during activation or on revocation of an account. If requireManualVerification is active, the shop sends this email to the address stored in toAddress as soon as a new account needs to be activated. If requireEmailVerification is also active, the email is only sent after the email address has been confirmed. With permissionsBeforeVerification you define the permissions a not-yet-verified account has in the shop. Example configuration b2b.accountVerification

{
  "requireEmailVerification": true,
  "requireManualVerification": false,
  "verificationMerchantEmail": {
    "fromAddress": "",
    "fromName": "",
    "toAddress": "",
    "subject": "",
    "template": "",
    "subjectForRevocation": "",
    "templateForRevocation": ""
  },
  "permissionsBeforeVerification": {
    "viewProducts": true,
    "viewCategories": true,
    "viewPrices": false,
    "placeOrders": false
  }
}

Parameter overview

Parameter	Type	Description
`requireEmailVerification`	bool	Determines whether an email verification is required for new B2B accounts.
`requireManualVerification`	bool	Determines whether new B2B accounts must additionally be approved manually by the merchant.
`verificationMerchantEmail`	object	Configuration of the emails for account activation and revocation.
`fromAddress`	string	Sender address of the email, for example `noreply@mein-shop.de`.
`fromName`	string	Display name of the sender in the email, for example “Mein Onlineshop”.
`toAddress`	string	Recipient address for the notification about a new account that needs to be activated manually.
`subject`	string	Subject line of the email.
`template`	string	Name or path of the email template to be used. This controls the content and layout of the email.
`subjectForRevocation`	string	Subject line of the email when the account activation is revoked.
`templateForRevocation`	string	Name or path of the email template to be used for the revocation email.
`permissionsBeforeVerification`	object	Defines which actions a not-yet-verified account may perform in the shop.
`viewProducts`	bool	Determines whether products are visible to unverified accounts.
`viewCategories`	bool	Determines whether categories are visible to unverified accounts.
`viewPrices`	bool	Determines whether prices are visible to unverified accounts.
`placeOrders`	bool	Determines whether unverified accounts can place orders. If `false`, basket actions are also blocked.

​b2b* - Basic structure

​Parameter overview

​b2b.access - Access restrictions

​Example configuration b2b.access

​Parameter overview

​b2b.userInvitation - User invitation

​b2b.subAccounts - Employee accounts

​b2b.accountVerification - Account verification

`b2b*` - Basic structure

Parameter overview

`b2b.access` - Access restrictions

Example configuration `b2b.access`

Parameter overview

`b2b.userInvitation` - User invitation

`b2b.subAccounts` - Employee accounts

`b2b.accountVerification` - Account verification