Package com.commercetools.api.client

Class ByProjectKeyMeOrdersGet

java.lang.Object
io.vrap.rmf.base.client.ApiMethod<T,TResult>
io.vrap.rmf.base.client.TypeApiMethod<ByProjectKeyMeOrdersGet,OrderPagedQueryResponse>
com.commercetools.api.client.ByProjectKeyMeOrdersGet
All Implemented Interfaces:
Deprecatable200Trait<ByProjectKeyMeOrdersGet>, ErrorableTrait<ByProjectKeyMeOrdersGet>, ExpandableTrait<ByProjectKeyMeOrdersGet>, PagingTrait<ByProjectKeyMeOrdersGet>, QueryTrait<ByProjectKeyMeOrdersGet>, SortableTrait<ByProjectKeyMeOrdersGet>, ClientRequestCommand<OrderPagedQueryResponse>, CreateHttpRequestCommand, HttpRequestCommand<OrderPagedQueryResponse>, RequestCommand<OrderPagedQueryResponse>
public class ByProjectKeyMeOrdersGet extends TypeApiMethod<ByProjectKeyMeOrdersGet,OrderPagedQueryResponse> implements ExpandableTrait<ByProjectKeyMeOrdersGet>, SortableTrait<ByProjectKeyMeOrdersGet>, PagingTrait<ByProjectKeyMeOrdersGet>, QueryTrait<ByProjectKeyMeOrdersGet>, ErrorableTrait<ByProjectKeyMeOrdersGet>, Deprecatable200Trait<ByProjectKeyMeOrdersGet>

Returns all Orders that match a given Query Predicate.

A ResourceNotFound error is returned in the following scenarios:

  • If no Orders exist for a given Query Predicate.
  • If the Order exists but does not have a customerId that matches the customer:{id} scope, or anonymousId that matches the anonymous_id:{id} scope.

   CompletableFuture<ApiHttpResponse<com.commercetools.api.models.order.OrderPagedQueryResponse>> result = apiRoot
            .withProjectKey("{projectKey}")
            .me()
            .orders()
            .get()
            .execute()