Description

Login as a customer via one-time password sent to email. This endpoint generates and sends the code. It will also implicitly create the customer if necessary.

Topic: Auth

Arguments

data: CustomerLogin!

Main argument for mutations.

shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"

Data Argument Fields

email: String

The email address of the customer

Example: "bob.norman@hostmail.com"

Valid when: email is not empty

language: String

Preferred language of the customer

oauth_code: String

OAuth2 authorization code provided by the provider

oauth_provider: CustomerOAuthProviderKind

OAuth provider kind for customer login

oauth_session_id: String

OAuth session id (for special implicit connection flow)

oauth_token: String

OAuth1 token provided by the provider

oauth_verifier: String

OAuth1 verifier provided by the provider

password: String

The customer's password

Example: "34hb5kj3h45k3"

preferred_currency: String

Currency customer prefers

Example: "USD"

timezone: String

Name of the time zone the customer is in

Example: "(GMT-05:00) Eastern Time"

Valid when: timezone's length doesn't exceed 50 characters

timezone_hint: String

Timezone hint. When provided it overrides timezone field, but only if it's correct. If it's incorrect, the value is ignored.

Example: "(GMT-05:00) Eastern Time"

Valid when: timezone_hint's length doesn't exceed 50 characters

webauthn_credential: String

JSON-encoded PublicKeyCredential

webauthn_session_id: String

Session ID associated with webauthn login process

Result

Boolean

Preview (typescript)

Loading module