Class ByProjectKeyInStoreKeyByStoreKeyCustomersRequestBuilder

Constructors

constructor

Properties

args

Methods

emailConfirm emailToken get head password passwordReset passwordToken post withEmailToken withId withKey withPasswordToken

Constructors

constructor

Properties

Protected Readonlyargs

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

Methods

emailConfirm

emailToken

get

  • get(
        methodArgs?: {
            headers?: { [key: string]: string | string[] };
            queryArgs?: {
                expand?: string | string[];
                limit?: number;
                offset?: number;
                sort?: string | string[];
                where?: string | string[];
                withTotal?: boolean;
                [key: string]: QueryParam;
            };
        },
    ): ApiRequest<CustomerPagedQueryResponse>

    Parameters

    • OptionalmethodArgs: {
          headers?: { [key: string]: string | string[] };
          queryArgs?: {
              expand?: string | string[];
              limit?: number;
              offset?: number;
              sort?: string | string[];
              where?: string | string[];
              withTotal?: boolean;
              [key: string]: QueryParam;
          };
      }

    Returns ApiRequest<CustomerPagedQueryResponse>

head

password

passwordReset

passwordToken

post

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

    When using this endpoint, if omitted, the Customer stores field is set to the Store specified in the path parameter.

    If the `anonymousCart` field is set on the [CustomerDraft](ctp:api:type:CustomerDraft), then the newly created Customer will be assigned to that [Cart](ctp:api:type:Cart).
Similarly, if the `anonymousId` field is set, the Customer will be set on all [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), [ShoppingLists](ctp:api:type:ShoppingList) and [Payments](ctp:api:type:Payment) with the same `anonymousId`.
If a Cart with a `store` field specified, the `store` field must reference the same [Store](ctp:api:type:Store) specified in the `{storeKey}` path parameter.

Creating a Customer produces the [CustomerCreated](ctp:api:type:CustomerCreatedMessage) Message. Simultaneously creating two Customers with the same email address can return a [LockedField](ctp:api:type:LockedFieldError) error.

    Parameters

    • methodArgs: {
          body: CustomerDraft;
          headers?: { [key: string]: string | string[] };
          queryArgs?: { expand?: string | string[]; [key: string]: QueryParam };
      }

    Returns ApiRequest<CustomerSignInResult>

withEmailToken

withId

withKey

withPasswordToken

Settings

Member Visibility

On This Page

Constructors
Properties
Methods