LoginParams | @bloomreach/connector-components-react

Hierarchy

LoginParams

Index

Properties

Optional attrs

attrs?: Record<string, string>

Extra attributes for the login user

Optional country

country?: string

Visitor/Customer country

Optional currency

currency?: string

Visitor/Customer currency

Optional locale

locale?: string

Visitor/Customer locales

Optional mergeWithExistingCustomerCart

mergeWithExistingCustomerCart?: boolean

A boolean to indicate whether or not to merge the old cart with the customer's existing cart. Set to false to replace the existing cart instead of merging. To be used together with oldCartId. Default to true.

Optional oldCartId

oldCartId?: string

ID of the cart to merge with/replace the customer's existing cart. Usually this is the anonymous cart's ID. To be used together with mergeWithExistingCustomerCart. If no oldCartId is provided, mergeWithExistingCustomerCart will be ignored.

Optional password

password?: string

Password of the customer.

Optional type

type?: string

Authentication type.

Currently two types of authentication are supported:

Standard authentication based on username and password. In this case you don't need to specify the type param.
Token Refresh, based on the existing token. In this case you need to specify 'refresh' as the value.

Please note that the token refresh is only possible if the GraphQL Service TOKEN_REFRESH_ENABLED property is set to true and the commerce backend supports refresh token grant/flow: only then it is possible to refresh the store user session.

Optional username

username?: string

Username of the customer. Usually this is the email address.