Typescript SDK Type Docs
    Preparing search index...

    Class ByProjectKeyLoginRequestBuilder

    Index

    Constructors

    constructor

    Properties

    args

    Methods

    post

    Constructors

    Properties

    args: {
        baseUri?: string;
        executeRequest: executeRequest;
        pathArgs: { projectKey: string };
    }

    Methods

    post

    • post(
          methodArgs: {
              body: CustomerSignin;
              headers?: { [key: string]: string | string[] };
          },
      ): ApiRequest<CustomerSignInResult>

      Authenticates a global Customer.

      Allows [merging](/../api/customers-overview#cart-merge-during-sign-in-and-sign-up) items from an anonymous Cart into the most recently modified active Cart of a Customer.
If no active Cart exists, the anonymous Cart becomes the Customer's active Cart.
If the Customer has multiple active Carts, the anonymous Cart is merged into the most recently modified active Cart.

If an account with the given credentials is not found, an [InvalidCredentials](ctp:api:type:InvalidCredentialsError) error is returned.

      Parameters

      • methodArgs: { body: CustomerSignin; headers?: { [key: string]: string | string[] } }

      Returns ApiRequest<CustomerSignInResult>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods