Home > @vsf-enterprise/bigcommerce-api > Endpoints > loginCustomer

Endpoints.loginCustomer() method

Logs in a customer using the Customer Login API and saves her data in cookie in the format of a JWT token coming from the Current Customer API. Return an object containing the status of authentication and an error message if applicable

Signature:

loginCustomer(context: BigcommerceIntegrationContext, params: LoginCustomerParameters): Promise<LoginCustomerResponse>;

Parameters

Parameter	Type	Description
context	BigcommerceIntegrationContext	An auto-generated value prepended to the method as a first parameter.
params	LoginCustomerParameters	Customer credentials for login (email, password).

Returns:

Promise<LoginCustomerResponse>