loginCustomerGql

Logs in the customer

This method sends a POST request to the loginCustomerGql endpoint of the Vue Storefront API Middleware. In turn, it receives data from the BigCommerce loginCustomerGql GraphQL API.

Signature

loginCustomerGql: (
	props: LoginCustomerParameters,
	options?: MethodOptions
) => Promise<LoginCustomerGqlResponse>

Parameters

Name	Required	Type	Description
`props`	Required	`LoginCustomerParameters`	Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.
`options`	Optional	`MethodOptions`

Returns

Returns a response with the matching category data.

Referenced Types

LoginCustomerParameters
LoginCustomerGqlResponse

Examples

Fetching category that matches the id from the query

import { sdk } from '~/sdk.config.ts';

const login = await sdk.bigcommerce.loginCustomerGql({ email: 'test@test.com', password: 'pas55w0rd' });