Package com.commercetools.api.client
Class ByProjectKeyOrdersPost
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<ByProjectKeyOrdersPost,Order,OrderFromCartDraft>
com.commercetools.api.client.ByProjectKeyOrdersPost
- All Implemented Interfaces:
ConflictingTrait<ByProjectKeyOrdersPost>,Deprecatable201Trait<ByProjectKeyOrdersPost>,ErrorableTrait<ByProjectKeyOrdersPost>,ExpandableTrait<ByProjectKeyOrdersPost>,ClientRequestCommand<Order>,CreateHttpRequestCommand,HttpRequestCommand<Order>,RequestCommand<Order>
public class ByProjectKeyOrdersPost
extends TypeBodyApiMethod<ByProjectKeyOrdersPost,Order,OrderFromCartDraft>
implements ConflictingTrait<ByProjectKeyOrdersPost>, ExpandableTrait<ByProjectKeyOrdersPost>, Deprecatable201Trait<ByProjectKeyOrdersPost>, ErrorableTrait<ByProjectKeyOrdersPost>
Creates an Order from a Cart.
The Cart must have a shipping address and an active Shipping Method set.
The shipping address is used for tax calculation for a Cart with Platform TaxMode.
Creating an Order produces the OrderCreated Message. If the Order is created from a Recurring Order schedule, the OrderCreatedFromRecurringOrder Message is generated.
If a server-side problem occurs, indicated by a 500 Internal Server Error HTTP response, the Order creation may still successfully complete after the error is returned. If you receive this error, you should verify the status of the Order by querying a unique identifier supplied during the creation request, such as the Order number.
Specific Error Codes:
- OutOfStock
- PriceChanged
- DiscountCodeNonApplicable
- ShippingMethodDoesNotMatchCart
- InvalidItemShippingDetails
- InvalidOperation
- MatchingPriceNotFound
- MissingTaxRateForCountry
CompletableFuture<ApiHttpResponse<com.commercetools.api.models.order.Order>> result = apiRoot
.withProjectKey("{projectKey}")
.orders()
.post(null)
.execute()
-
Nested Class Summary
Nested classes/interfaces inherited from class io.vrap.rmf.base.client.ApiMethod
ApiMethod.ParamEntry<K,V> -
Constructor Summary
ConstructorsConstructorDescriptionByProjectKeyOrdersPost(ApiHttpClient apiHttpClient, String projectKey, OrderFromCartDraft orderFromCartDraft) -
Method Summary
Modifier and TypeMethodDescription<TValue> ByProjectKeyOrdersPostaddExpand(Collection<TValue> expand) add additional expand query parametersadd additional expand query parameteradd additional expand query parameter<TValue> ByProjectKeyOrdersPostaddExpand(TValue expand) add additional expand query parameterbooleanexecute(ApiHttpClient client) executeBlocking(ApiHttpClient client, Duration timeout) getBody()inthashCode()intcom.fasterxml.jackson.core.type.TypeReference<Order>voidsetProjectKey(String projectKey) toString()withBody(OrderFromCartDraft orderFromCartDraft) <TValue> ByProjectKeyOrdersPostwithExpand(Collection<TValue> expand) set expand with the specified valuesset expand with the specified valuewithExpand(Supplier<String> supplier) set expand with the specified value<TValue> ByProjectKeyOrdersPostwithExpand(TValue expand) set expand with the specified valueMethods inherited from class io.vrap.rmf.base.client.ApiMethod
addHeader, addQueryParam, addQueryParams, contentType, createHttpRequest, execute, execute, execute, execute, execute, execute, execute, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, getFirstQueryParam, getHeaders, getQueryParam, getQueryParams, getQueryParamUriString, getQueryParamUriStrings, send, sendBlocking, sendBlocking, with, with, withHeader, withHeaders, withHttpRequest, withoutHeader, withoutQueryParam, withQueryParam, withQueryParamsMethods inherited from interface io.vrap.rmf.base.client.ClientRequestCommand
executeBlockingMethods inherited from interface com.commercetools.api.client.ConflictingTrait
asConflictingTrait, asConflictingTraitToBaseTypeMethods inherited from interface io.vrap.rmf.base.client.CreateHttpRequestCommand
createHttpRequestMethods inherited from interface com.commercetools.api.client.Deprecatable201Trait
asDeprecatable201Trait, asDeprecatable201TraitToBaseTypeMethods inherited from interface com.commercetools.api.client.ErrorableTrait
asErrorableTrait, asErrorableTraitToBaseTypeMethods inherited from interface com.commercetools.api.client.ExpandableTrait
asExpandableTrait, asExpandableTraitToBaseTypeMethods inherited from interface io.vrap.rmf.base.client.RequestCommand
executeBlocking
-
Constructor Details
-
ByProjectKeyOrdersPost
public ByProjectKeyOrdersPost(ApiHttpClient apiHttpClient, String projectKey, OrderFromCartDraft orderFromCartDraft) -
ByProjectKeyOrdersPost
-
-
Method Details
-
resultType
- Specified by:
resultTypein interfaceHttpRequestCommand<Order>
-
executeBlocking
- Specified by:
executeBlockingin interfaceClientRequestCommand<Order>- Specified by:
executeBlockingin classApiMethod<ByProjectKeyOrdersPost,Order>
-
execute
- Specified by:
executein interfaceClientRequestCommand<Order>- Specified by:
executein classApiMethod<ByProjectKeyOrdersPost,Order>
-
getProjectKey
-
getExpand
- Specified by:
getExpandin interfaceExpandableTrait<ByProjectKeyOrdersPost>
-
setProjectKey
-
withExpand
set expand with the specified value- Specified by:
withExpandin interfaceExpandableTrait<ByProjectKeyOrdersPost>- Type Parameters:
TValue- value type- Parameters:
expand- value to be set- Returns:
- ByProjectKeyOrdersPost
-
addExpand
add additional expand query parameter- Specified by:
addExpandin interfaceExpandableTrait<ByProjectKeyOrdersPost>- Type Parameters:
TValue- value type- Parameters:
expand- value to be added- Returns:
- ByProjectKeyOrdersPost
-
withExpand
set expand with the specified value- Parameters:
supplier- supplier for the value to be set- Returns:
- ByProjectKeyOrdersPost
-
addExpand
add additional expand query parameter- Parameters:
supplier- supplier for the value to be added- Returns:
- ByProjectKeyOrdersPost
-
withExpand
set expand with the specified value- Parameters:
op- builder for the value to be set- Returns:
- ByProjectKeyOrdersPost
-
addExpand
add additional expand query parameter- Parameters:
op- builder for the value to be added- Returns:
- ByProjectKeyOrdersPost
-
withExpand
set expand with the specified values- Type Parameters:
TValue- value type- Parameters:
expand- values to be set- Returns:
- ByProjectKeyOrdersPost
-
addExpand
add additional expand query parameters- Type Parameters:
TValue- value type- Parameters:
expand- values to be added- Returns:
- ByProjectKeyOrdersPost
-
getBody
- Overrides:
getBodyin classTypeBodyApiMethod<ByProjectKeyOrdersPost,Order, OrderFromCartDraft>
-
withBody
- Overrides:
withBodyin classTypeBodyApiMethod<ByProjectKeyOrdersPost,Order, OrderFromCartDraft>
-
equals
-
hashCode
public int hashCode() -
toString
-
reflectionHashCode
public int reflectionHashCode()
-