Typescript SDK Type Docs
    Preparing search index...

    Interface CustomerSignin

    interface CustomerSignin {
        anonymousCart?: CartResourceIdentifier;
        anonymousCartId?: string;
        anonymousCartSignInMode?: AnonymousCartSignInMode;
        anonymousId?: string;
        email: string;
        password: string;
        updateProductData?: boolean;
    }
    Index

    Properties

    anonymousCart? anonymousCartId? anonymousCartSignInMode? anonymousId? email password updateProductData?

    Properties

    anonymousCart?: CartResourceIdentifier

    Assigns the Customer to the specified Cart.

    anonymousCartId?: string

    Deprecated since it is now possible to identify an anonymous cart by using its id or external key.

    anonymousCartSignInMode?: AnonymousCartSignInMode
    • Set to MergeWithExistingCustomerCart if LineItems of the anonymous Cart should be merged with the active Customer Cart that has been modified most recently.
      • Set to UseAsNewActiveCustomerCart if the anonymous Cart should be used as the new active Customer Cart and no LineItems are to be merged.
    anonymousId?: string

    Assigns the Customer to all Carts, Orders, ShoppingLists, and Payments with the same anonymousId.

    If `anonymousCart` is provided, this value must match the `anonymousId` of the anonymous [Cart](ctp:api:type:Cart); otherwise, an [InvalidOperation](ctp:api:type:InvalidOperationError) error is returned.
    email: string

    Email address of the Customer treated as case-insensitive.

    password: string

    Password of the Customer.

    updateProductData?: boolean
    • If true, the LineItem Product data (name, variant, and productType) of the returned Cart will be updated.
      • If false, only the prices, discounts, and tax rates will be updated.

    Settings

    Member Visibility

    On This Page

    Properties