Class CustomerLoginRequest

Commercetools\Core\Request\AbstractApiRequest implements Commercetools\Core\Request\ClientRequestInterface, Commercetools\Core\Model\Common\ContextAwareInterface uses Commercetools\Core\Model\Common\ContextTrait

Commercetools\Core\Request\Customers\CustomerLoginRequest

Namespace: Commercetools\Core\Request\Customers
API documentation: https://docs.commercetools.com/http-api-projects-customers.html#authenticate-customer-sign-in
Located at Core/Request/Customers/CustomerLoginRequest.php

Methods summary

Magic methods summary

`public Commercetools\Core\Model\Customer\CustomerSigninResult`	# `mapResponse( Commercetools\Core\Response\ApiResponseInterface $response )` Parameters `$response` Returns `Commercetools\Core\Model\Customer\CustomerSigninResult` Overrides `Commercetools\Core\Request\AbstractApiRequest::mapResponse`
`public Commercetools\Core\Model\Customer\CustomerSigninResult`	# `mapFromResponse( Commercetools\Core\Response\ApiResponseInterface $response, Commercetools\Core\Model\MapperInterface $mapper = null )` Parameters `$response` `$mapper` Returns `Commercetools\Core\Model\Customer\CustomerSigninResult` Overrides `Commercetools\Core\Request\AbstractApiRequest::mapFromResponse`

Constants summary

`string`	`EMAIL`	# `'email'`
`string`	`PASSWORD`	# `'password'`
`string`	`ANONYMOUS_CART`	# `'anonymousCart'`
`string`	`ANONYMOUS_CART_ID`	# `'anonymousCartId'`
`string`	`ANONYMOUS_CART_SIGN_IN_MODE`	# `'anonymousCartSignInMode'`
`string`	`SIGN_IN_MODE_MERGE`	# `'MergeWithExistingCustomerCart'`
`string`	`SIGN_IN_MODE_NEW`	# `'UseAsNewActiveCustomerCart'`
`string`	`UPDATE_PRODUCT_DATA`	# `'updateProductData'`

Constants inherited from Commercetools\Core\Request\AbstractApiRequest

EXTERNAL_USER_HEADER

`public`	# `__construct( string $email, string $password, Commercetools\Core\Model\Cart\CartReference\|string\|null $anonymousCart = null, Commercetools\Core\Model\Common\Context $context = null )` Parameters `$email` `$password` `$anonymousCart` `$context` Overrides `Commercetools\Core\Request\AbstractApiRequest::__construct`
`public string`	# `getEmail( )` Returns string
`public Commercetools\Core\Request\Customers\CustomerLoginRequest`	# `setEmail( string $email )` Parameters `$email` Returns `Commercetools\Core\Request\Customers\CustomerLoginRequest` $this
`public string`	# `getPassword( )` Returns string
`public Commercetools\Core\Request\Customers\CustomerLoginRequest`	# `setPassword( string $password )` Parameters `$password` Returns `Commercetools\Core\Request\Customers\CustomerLoginRequest` $this
`public string`	# `getAnonymousCartId( )` Deprecated use $getAnonymousCart instead Returns string
`public Commercetools\Core\Request\Customers\CustomerLoginRequest`	# `setAnonymousCartId( string $anonymousCartId )` Deprecated use $setAnonymousCart instead Parameters `$anonymousCartId` Returns `Commercetools\Core\Request\Customers\CustomerLoginRequest` $this
`public mixed`	# `getAnonymousCartSignInMode( )` Returns mixed
`public Commercetools\Core\Request\Customers\CustomerLoginRequest`	# `setAnonymousCartSignInMode( mixed $anonymousCartSignInMode )` Parameters `$anonymousCartSignInMode` Returns `Commercetools\Core\Request\Customers\CustomerLoginRequest` $this
`public boolean`	# `getUpdateProductData( )` Returns boolean
`public Commercetools\Core\Request\Customers\CustomerLoginRequest`	# `setUpdateProductData( boolean $updateProductData )` Parameters `$updateProductData` Returns `Commercetools\Core\Request\Customers\CustomerLoginRequest` $this
`public Commercetools\Core\Model\Cart\CartReference`	# `getAnonymousCart( )` Returns `Commercetools\Core\Model\Cart\CartReference`
`public Commercetools\Core\Request\Customers\CustomerLoginRequest`	# `setAnonymousCart( Commercetools\Core\Model\Cart\CartReference $anonymousCart )` Parameters `$anonymousCart` Returns `Commercetools\Core\Request\Customers\CustomerLoginRequest` $this
`public static Commercetools\Core\Request\Customers\CustomerLoginRequest`	# `ofEmailAndPassword( string $email, string $password, Commercetools\Core\Model\Cart\CartReference\|string $anonymousCart = null, Commercetools\Core\Model\Common\Context $context = null )` Parameters `$email` `$password` `$anonymousCart` `$context` Returns `Commercetools\Core\Request\Customers\CustomerLoginRequest`
`public static Commercetools\Core\Request\Customers\CustomerLoginRequest`	# `ofEmailPasswordAndUpdateProductData( string $email, string $password, boolean $updateProductData, Commercetools\Core\Model\Cart\CartReference\|string $anonymousCart = null, Commercetools\Core\Model\Common\Context $context = null )` Parameters `$email` `$password` `$updateProductData` `$anonymousCart` `$context` Returns `Commercetools\Core\Request\Customers\CustomerLoginRequest`

Namespaces

Classes

Class CustomerLoginRequest

Methods summary

Parameters

Overrides

Returns

Parameters

Returns

Returns

Parameters

Returns

Deprecated

Returns

Deprecated

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Methods inherited from Commercetools\Core\Request\AbstractApiRequest

Methods inherited from Commercetools\Core\Model\Common\ContextAwareInterface

Methods inherited from Commercetools\Core\Request\ClientRequestInterface

Methods used from Commercetools\Core\Model\Common\ContextTrait

Magic methods summary

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Constants summary

Constants inherited from Commercetools\Core\Request\AbstractApiRequest