Home > @vsf-enterprise/bigcommerce-api > Endpoints > loginCustomerGql
# Endpoints.loginCustomerGql() method
Logs in a customer using a GraphQL mutation. Returns an object containing the status of authentication and customer ID on the successful login.
Signature:
loginCustomerGql(context: BigcommerceIntegrationContext, params: LoginCustomerParameters): Promise<LoginCustomerGqlResponse>;
# 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<LoginCustomerGqlResponse>