You are reading the documentation for SDK v2, which is no longer the latest version. Switch to current
customerSignMeIn
Endpoint for logging in a user. By default, it uses the customerSignMeInDefaultQuery GraphQL query
Signature
export declare function customerSignMeIn(
context: SetupContext,
draft: CustomerSignMeInDraft,
customQuery?: CustomQuery,
responseOptions?: ResponseOptions
): Promise<CustomerSignMeInResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
context | Required | SetupContext | Automatically injected context. Refer to SetupContext |
draft | Required | CustomerSignMeInDraft | User credentials |
customQuery | Optional | CustomQuery | |
responseOptions | Optional | ResponseOptions |
Returns
User information