Package com.commercetools.api.client

Class ByProjectKeyMeLoginPostString

java.lang.Object
io.vrap.rmf.base.client.ApiMethod<T,TResult>
io.vrap.rmf.base.client.BodyApiMethod<T,TResult,TBody>
io.vrap.rmf.base.client.TypeBodyApiMethod<T,TResult,String>
io.vrap.rmf.base.client.StringBodyApiMethod<ByProjectKeyMeLoginPostString,CustomerSignInResult>
com.commercetools.api.client.ByProjectKeyMeLoginPostString
All Implemented Interfaces:
ErrorableTrait<ByProjectKeyMeLoginPostString>, ClientRequestCommand<CustomerSignInResult>, CreateHttpRequestCommand, HttpRequestCommand<CustomerSignInResult>, RequestCommand<CustomerSignInResult>
public class ByProjectKeyMeLoginPostString extends StringBodyApiMethod<ByProjectKeyMeLoginPostString,CustomerSignInResult> implements ErrorableTrait<ByProjectKeyMeLoginPostString>

Retrieves the authenticated customer (that matches the given email/password pair).

If used with an optional access token for an anonymous session, all Orders and Carts that belong to the anonymousId are assigned to the newly logged-in Customer.

  • If the Customer does not have a Cart yet, the most recently modified anonymous cart becomes the Customer's Cart.
  • If the Customer already has a Cart, the most recently modified anonymous cart is handled in accordance with AnonymousCartSignInMode.

A Cart returned in the CustomerSignInResult has any invalid Line Items removed and is updated with the latest prices, taxes, and discounts. During these updates, the following errors can be returned: MatchingPriceNotFound and MissingTaxRateForCountry.

If an account with the given credentials is not found, an InvalidCredentials error is returned.


   CompletableFuture<ApiHttpResponse<com.commercetools.api.models.customer.CustomerSignInResult>> result = apiRoot
            .withProjectKey("{projectKey}")
            .me()
            .login()
            .post("")
            .execute()