/**
* This code was auto-generated by a Codezu.
*
* Changes to this file may cause incorrect behavior and will be lost if
* the code is regenerated.
*/
package com.mozu.api.clients.commerce;
import java.util.List;
import java.util.ArrayList;
import com.mozu.api.MozuClient;
import com.mozu.api.MozuClientFactory;
import com.mozu.api.MozuUrl;
import com.mozu.api.Headers;
import org.joda.time.DateTime;
import com.mozu.api.security.AuthTicket;
import org.apache.commons.lang.StringUtils;
/** <summary>
* Use the Orders resource to manage all components of order processing, payment, and fulfillment.
* </summary>
*/
public class OrderClient {
/**
* Retrieves a list of orders according to any specified filter criteria and sort options.
* <p><pre><code>
* MozuClient<com.mozu.api.contracts.commerceruntime.orders.OrderCollection> mozuClient=GetOrdersClient();
* client.setBaseAddress(url);
* client.executeRequest();
* OrderCollection orderCollection = client.Result();
* </code></pre></p>
* @return Mozu.Api.MozuClient <com.mozu.api.contracts.commerceruntime.orders.OrderCollection>
* @see com.mozu.api.contracts.commerceruntime.orders.OrderCollection
*/
public static MozuClient<com.mozu.api.contracts.commerceruntime.orders.OrderCollection> getOrdersClient() throws Exception
{
return getOrdersClient( null, null, null, null, null, null, null);
}
/**
* Retrieves a list of orders according to any specified filter criteria and sort options.
* <p><pre><code>
* MozuClient<com.mozu.api.contracts.commerceruntime.orders.OrderCollection> mozuClient=GetOrdersClient( startIndex, pageSize, sortBy, filter, q, qLimit, responseFields);
* client.setBaseAddress(url);
* client.executeRequest();
* OrderCollection orderCollection = client.Result();
* </code></pre></p>
* @param filter A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters.
* @param pageSize The number of results to display on each page when creating paged results from a query. The maximum value is 200.
* @param q A list of order search terms (not phrases) to use in the query when searching across order number and the name or email of the billing contact. When entering, separate multiple search terms with a space character.
* @param qLimit The maximum number of search results to return in the response. You can limit any range between 1-100.
* @param responseFields Use this field to include those fields which are not included by default.
* @param sortBy
* @param startIndex
* @return Mozu.Api.MozuClient <com.mozu.api.contracts.commerceruntime.orders.OrderCollection>
* @see com.mozu.api.contracts.commerceruntime.orders.OrderCollection
*/
public static MozuClient<com.mozu.api.contracts.commerceruntime.orders.OrderCollection> getOrdersClient(Integer startIndex, Integer pageSize, String sortBy, String filter, String q, Integer qLimit, String responseFields) throws Exception
{
MozuUrl url = com.mozu.api.urls.commerce.OrderUrl.getOrdersUrl(filter, pageSize, q, qLimit, responseFields, sortBy, startIndex);
String verb = "GET";
Class<?> clz = com.mozu.api.contracts.commerceruntime.orders.OrderCollection.class;
MozuClient<com.mozu.api.contracts.commerceruntime.orders.OrderCollection> mozuClient = (MozuClient<com.mozu.api.contracts.commerceruntime.orders.OrderCollection>) MozuClientFactory.getInstance(clz);
mozuClient.setVerb(verb);
mozuClient.setResourceUrl(url);
return mozuClient;
}
/**
* Retrieves the actions available to perform for an order based on its current status.
* <p><pre><code>
* MozuClient<List<String>> mozuClient=GetAvailableActionsClient( orderId);
* client.setBaseAddress(url);
* client.executeRequest();
* string string = client.Result();
* </code></pre></p>
* @param orderId Unique identifier of the order.
* @return Mozu.Api.MozuClient <List<string>>
* @see string
*/
public static MozuClient<List<String>> getAvailableActionsClient(String orderId) throws Exception
{
MozuUrl url = com.mozu.api.urls.commerce.OrderUrl.getAvailableActionsUrl(orderId);
String verb = "GET";
Class<?> clz = new ArrayList<String>(){}.getClass();
MozuClient<List<String>> mozuClient = (MozuClient<List<String>>) MozuClientFactory.getInstance(clz);
mozuClient.setVerb(verb);
mozuClient.setResourceUrl(url);
return mozuClient;
}
/**
* Retrieves an order for the purpose of splitting it into multiple taxable orders in order to fulfill the order in multiple locations.
* <p><pre><code>
* MozuClient<List<com.mozu.api.contracts.pricingruntime.TaxableOrder>> mozuClient=GetTaxableOrdersClient( orderId);
* client.setBaseAddress(url);
* client.executeRequest();
* TaxableOrder taxableOrder = client.Result();
* </code></pre></p>
* @param orderId Unique identifier of the order.
* @return Mozu.Api.MozuClient <List<com.mozu.api.contracts.pricingruntime.TaxableOrder>>
* @see com.mozu.api.contracts.pricingruntime.TaxableOrder
*/
public static MozuClient<List<com.mozu.api.contracts.pricingruntime.TaxableOrder>> getTaxableOrdersClient(String orderId) throws Exception
{
MozuUrl url = com.mozu.api.urls.commerce.OrderUrl.getTaxableOrdersUrl(orderId);
String verb = "GET";
Class<?> clz = new ArrayList<com.mozu.api.contracts.pricingruntime.TaxableOrder>(){}.getClass();
MozuClient<List<com.mozu.api.contracts.pricingruntime.TaxableOrder>> mozuClient = (MozuClient<List<com.mozu.api.contracts.pricingruntime.TaxableOrder>>) MozuClientFactory.getInstance(clz);
mozuClient.setVerb(verb);
mozuClient.setResourceUrl(url);
return mozuClient;
}
/**
* Retrieves the details of an order specified by the order ID.
* <p><pre><code>
* MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order> mozuClient=GetOrderClient( orderId);
* client.setBaseAddress(url);
* client.executeRequest();
* Order order = client.Result();
* </code></pre></p>
* @param orderId Unique identifier of the order.
* @return Mozu.Api.MozuClient <com.mozu.api.contracts.commerceruntime.orders.Order>
* @see com.mozu.api.contracts.commerceruntime.orders.Order
*/
public static MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order> getOrderClient(String orderId) throws Exception
{
return getOrderClient( orderId, null, null);
}
/**
* Retrieves the details of an order specified by the order ID.
* <p><pre><code>
* MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order> mozuClient=GetOrderClient( orderId, draft, responseFields);
* client.setBaseAddress(url);
* client.executeRequest();
* Order order = client.Result();
* </code></pre></p>
* @param draft If true, retrieve the draft version of the order, which might include uncommitted changes to the order or its components.
* @param orderId Unique identifier of the order.
* @param responseFields Use this field to include those fields which are not included by default.
* @return Mozu.Api.MozuClient <com.mozu.api.contracts.commerceruntime.orders.Order>
* @see com.mozu.api.contracts.commerceruntime.orders.Order
*/
public static MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order> getOrderClient(String orderId, Boolean draft, String responseFields) throws Exception
{
MozuUrl url = com.mozu.api.urls.commerce.OrderUrl.getOrderUrl(draft, orderId, responseFields);
String verb = "GET";
Class<?> clz = com.mozu.api.contracts.commerceruntime.orders.Order.class;
MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order> mozuClient = (MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order>) MozuClientFactory.getInstance(clz);
mozuClient.setVerb(verb);
mozuClient.setResourceUrl(url);
return mozuClient;
}
/**
* Creates a new order from an existing cart when the customer chooses to proceed to checkout.
* <p><pre><code>
* MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order> mozuClient=CreateOrderFromCartClient( cartId);
* client.setBaseAddress(url);
* client.executeRequest();
* Order order = client.Result();
* </code></pre></p>
* @param cartId Identifier of the cart to delete.
* @return Mozu.Api.MozuClient <com.mozu.api.contracts.commerceruntime.orders.Order>
* @see com.mozu.api.contracts.commerceruntime.orders.Order
*/
public static MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order> createOrderFromCartClient(String cartId) throws Exception
{
return createOrderFromCartClient( cartId, null);
}
/**
* Creates a new order from an existing cart when the customer chooses to proceed to checkout.
* <p><pre><code>
* MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order> mozuClient=CreateOrderFromCartClient( cartId, responseFields);
* client.setBaseAddress(url);
* client.executeRequest();
* Order order = client.Result();
* </code></pre></p>
* @param cartId Identifier of the cart to delete.
* @param responseFields Use this field to include those fields which are not included by default.
* @return Mozu.Api.MozuClient <com.mozu.api.contracts.commerceruntime.orders.Order>
* @see com.mozu.api.contracts.commerceruntime.orders.Order
*/
public static MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order> createOrderFromCartClient(String cartId, String responseFields) throws Exception
{
MozuUrl url = com.mozu.api.urls.commerce.OrderUrl.createOrderFromCartUrl(cartId, responseFields);
String verb = "POST";
Class<?> clz = com.mozu.api.contracts.commerceruntime.orders.Order.class;
MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order> mozuClient = (MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order>) MozuClientFactory.getInstance(clz);
mozuClient.setVerb(verb);
mozuClient.setResourceUrl(url);
return mozuClient;
}
/**
* Creates a new order for no-cart quick-ordering scenarios.
* <p><pre><code>
* MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order> mozuClient=CreateOrderClient( order);
* client.setBaseAddress(url);
* client.executeRequest();
* Order order = client.Result();
* </code></pre></p>
* @param order Properties of an order, including its components.
* @return Mozu.Api.MozuClient <com.mozu.api.contracts.commerceruntime.orders.Order>
* @see com.mozu.api.contracts.commerceruntime.orders.Order
* @see com.mozu.api.contracts.commerceruntime.orders.Order
*/
public static MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order> createOrderClient(com.mozu.api.contracts.commerceruntime.orders.Order order) throws Exception
{
return createOrderClient( order, null);
}
/**
* Creates a new order for no-cart quick-ordering scenarios.
* <p><pre><code>
* MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order> mozuClient=CreateOrderClient( order, responseFields);
* client.setBaseAddress(url);
* client.executeRequest();
* Order order = client.Result();
* </code></pre></p>
* @param responseFields Use this field to include those fields which are not included by default.
* @param order Properties of an order, including its components.
* @return Mozu.Api.MozuClient <com.mozu.api.contracts.commerceruntime.orders.Order>
* @see com.mozu.api.contracts.commerceruntime.orders.Order
* @see com.mozu.api.contracts.commerceruntime.orders.Order
*/
public static MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order> createOrderClient(com.mozu.api.contracts.commerceruntime.orders.Order order, String responseFields) throws Exception
{
MozuUrl url = com.mozu.api.urls.commerce.OrderUrl.createOrderUrl(responseFields);
String verb = "POST";
Class<?> clz = com.mozu.api.contracts.commerceruntime.orders.Order.class;
MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order> mozuClient = (MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order>) MozuClientFactory.getInstance(clz);
mozuClient.setVerb(verb);
mozuClient.setResourceUrl(url);
mozuClient.setBody(order);
return mozuClient;
}
/**
* Perform the specified action for an order. The actions you can perform depend on the current status of the order.
* <p><pre><code>
* MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order> mozuClient=PerformOrderActionClient( action, orderId);
* client.setBaseAddress(url);
* client.executeRequest();
* Order order = client.Result();
* </code></pre></p>
* @param orderId Unique identifier of the order.
* @param action The action to perform for the order.
* @return Mozu.Api.MozuClient <com.mozu.api.contracts.commerceruntime.orders.Order>
* @see com.mozu.api.contracts.commerceruntime.orders.Order
* @see com.mozu.api.contracts.commerceruntime.orders.OrderAction
*/
public static MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order> performOrderActionClient(com.mozu.api.contracts.commerceruntime.orders.OrderAction action, String orderId) throws Exception
{
return performOrderActionClient( action, orderId, null);
}
/**
* Perform the specified action for an order. The actions you can perform depend on the current status of the order.
* <p><pre><code>
* MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order> mozuClient=PerformOrderActionClient( action, orderId, responseFields);
* client.setBaseAddress(url);
* client.executeRequest();
* Order order = client.Result();
* </code></pre></p>
* @param orderId Unique identifier of the order.
* @param responseFields Use this field to include those fields which are not included by default.
* @param action The action to perform for the order.
* @return Mozu.Api.MozuClient <com.mozu.api.contracts.commerceruntime.orders.Order>
* @see com.mozu.api.contracts.commerceruntime.orders.Order
* @see com.mozu.api.contracts.commerceruntime.orders.OrderAction
*/
public static MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order> performOrderActionClient(com.mozu.api.contracts.commerceruntime.orders.OrderAction action, String orderId, String responseFields) throws Exception
{
MozuUrl url = com.mozu.api.urls.commerce.OrderUrl.performOrderActionUrl(orderId, responseFields);
String verb = "POST";
Class<?> clz = com.mozu.api.contracts.commerceruntime.orders.Order.class;
MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order> mozuClient = (MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order>) MozuClientFactory.getInstance(clz);
mozuClient.setVerb(verb);
mozuClient.setResourceUrl(url);
mozuClient.setBody(action);
return mozuClient;
}
/**
* Processes a digital wallet (used to hold 3rd party payment and shipping information).
* <p><pre><code>
* MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order> mozuClient=ProcessDigitalWalletClient( digitalWallet, orderId, digitalWalletType);
* client.setBaseAddress(url);
* client.executeRequest();
* Order order = client.Result();
* </code></pre></p>
* @param digitalWalletType The type of digital wallet to be processed.
* @param orderId Unique identifier of the order.
* @param digitalWallet The details of the digitial wallet.
* @return Mozu.Api.MozuClient <com.mozu.api.contracts.commerceruntime.orders.Order>
* @see com.mozu.api.contracts.commerceruntime.orders.Order
* @see com.mozu.api.contracts.commerceruntime.orders.DigitalWallet
*/
public static MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order> processDigitalWalletClient(com.mozu.api.contracts.commerceruntime.orders.DigitalWallet digitalWallet, String orderId, String digitalWalletType) throws Exception
{
return processDigitalWalletClient( digitalWallet, orderId, digitalWalletType, null);
}
/**
* Processes a digital wallet (used to hold 3rd party payment and shipping information).
* <p><pre><code>
* MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order> mozuClient=ProcessDigitalWalletClient( digitalWallet, orderId, digitalWalletType, responseFields);
* client.setBaseAddress(url);
* client.executeRequest();
* Order order = client.Result();
* </code></pre></p>
* @param digitalWalletType The type of digital wallet to be processed.
* @param orderId Unique identifier of the order.
* @param responseFields Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss.
* @param digitalWallet The details of the digitial wallet.
* @return Mozu.Api.MozuClient <com.mozu.api.contracts.commerceruntime.orders.Order>
* @see com.mozu.api.contracts.commerceruntime.orders.Order
* @see com.mozu.api.contracts.commerceruntime.orders.DigitalWallet
*/
public static MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order> processDigitalWalletClient(com.mozu.api.contracts.commerceruntime.orders.DigitalWallet digitalWallet, String orderId, String digitalWalletType, String responseFields) throws Exception
{
MozuUrl url = com.mozu.api.urls.commerce.OrderUrl.processDigitalWalletUrl(digitalWalletType, orderId, responseFields);
String verb = "PUT";
Class<?> clz = com.mozu.api.contracts.commerceruntime.orders.Order.class;
MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order> mozuClient = (MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order>) MozuClientFactory.getInstance(clz);
mozuClient.setVerb(verb);
mozuClient.setResourceUrl(url);
mozuClient.setBody(digitalWallet);
return mozuClient;
}
/**
* Update the properties of a discount applied to an order.
* <p><pre><code>
* MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order> mozuClient=UpdateOrderDiscountClient( discount, orderId, discountId);
* client.setBaseAddress(url);
* client.executeRequest();
* Order order = client.Result();
* </code></pre></p>
* @param discountId discountId parameter description DOCUMENT_HERE
* @param orderId Unique identifier of the order.
* @param discount Properties of all applied discounts for an associated cart, order, or product.
* @return Mozu.Api.MozuClient <com.mozu.api.contracts.commerceruntime.orders.Order>
* @see com.mozu.api.contracts.commerceruntime.orders.Order
* @see com.mozu.api.contracts.commerceruntime.discounts.AppliedDiscount
*/
public static MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order> updateOrderDiscountClient(com.mozu.api.contracts.commerceruntime.discounts.AppliedDiscount discount, String orderId, Integer discountId) throws Exception
{
return updateOrderDiscountClient( discount, orderId, discountId, null, null, null);
}
/**
* Update the properties of a discount applied to an order.
* <p><pre><code>
* MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order> mozuClient=UpdateOrderDiscountClient( discount, orderId, discountId, updateMode, version, responseFields);
* client.setBaseAddress(url);
* client.executeRequest();
* Order order = client.Result();
* </code></pre></p>
* @param discountId discountId parameter description DOCUMENT_HERE
* @param orderId Unique identifier of the order.
* @param responseFields Use this field to include those fields which are not included by default.
* @param updateMode Specifies whether to update the original order, update the order in draft mode, or update the order in draft mode and then commit the changes to the original. Draft mode enables users to make incremental order changes before committing the changes to the original order. Valid values are "ApplyToOriginal," "ApplyToDraft," or "ApplyAndCommit."
* @param version System-supplied integer that represents the current version of the order, which prevents users from unintentionally overriding changes to the order. When a user performs an operation for a defined order, the system validates that the version of the updated order matches the version of the order on the server. After the operation completes successfully, the system increments the version number by one.
* @param discount Properties of all applied discounts for an associated cart, order, or product.
* @return Mozu.Api.MozuClient <com.mozu.api.contracts.commerceruntime.orders.Order>
* @see com.mozu.api.contracts.commerceruntime.orders.Order
* @see com.mozu.api.contracts.commerceruntime.discounts.AppliedDiscount
*/
public static MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order> updateOrderDiscountClient(com.mozu.api.contracts.commerceruntime.discounts.AppliedDiscount discount, String orderId, Integer discountId, String updateMode, String version, String responseFields) throws Exception
{
MozuUrl url = com.mozu.api.urls.commerce.OrderUrl.updateOrderDiscountUrl(discountId, orderId, responseFields, updateMode, version);
String verb = "PUT";
Class<?> clz = com.mozu.api.contracts.commerceruntime.orders.Order.class;
MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order> mozuClient = (MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order>) MozuClientFactory.getInstance(clz);
mozuClient.setVerb(verb);
mozuClient.setResourceUrl(url);
mozuClient.setBody(discount);
return mozuClient;
}
/**
* Deletes the current draft version of the order, which also deletes any uncommitted changes made to the order in draft mode.
* <p><pre><code>
* MozuClient mozuClient=DeleteOrderDraftClient( orderId);
* client.setBaseAddress(url);
* client.executeRequest();
* </code></pre></p>
* @param orderId Unique identifier of the order.
* @return Mozu.Api.MozuClient
*/
public static MozuClient deleteOrderDraftClient(String orderId) throws Exception
{
return deleteOrderDraftClient( orderId, null);
}
/**
* Deletes the current draft version of the order, which also deletes any uncommitted changes made to the order in draft mode.
* <p><pre><code>
* MozuClient mozuClient=DeleteOrderDraftClient( orderId, version);
* client.setBaseAddress(url);
* client.executeRequest();
* </code></pre></p>
* @param orderId Unique identifier of the order.
* @param version Determines whether or not to check versioning of items for concurrency purposes.
* @return Mozu.Api.MozuClient
*/
public static MozuClient deleteOrderDraftClient(String orderId, String version) throws Exception
{
MozuUrl url = com.mozu.api.urls.commerce.OrderUrl.deleteOrderDraftUrl(orderId, version);
String verb = "PUT";
MozuClient mozuClient = (MozuClient) MozuClientFactory.getInstance();
mozuClient.setVerb(verb);
mozuClient.setResourceUrl(url);
return mozuClient;
}
/**
* Triggers an order confirmation email to be resent.
* <p><pre><code>
* MozuClient mozuClient=ResendOrderConfirmationEmailClient( action, orderId);
* client.setBaseAddress(url);
* client.executeRequest();
* </code></pre></p>
* @param orderId Unique identifier of the order.
* @param action The action to perform for the order.
* @return Mozu.Api.MozuClient
* @see com.mozu.api.contracts.commerceruntime.orders.OrderAction
*/
public static MozuClient resendOrderConfirmationEmailClient(com.mozu.api.contracts.commerceruntime.orders.OrderAction action, String orderId) throws Exception
{
MozuUrl url = com.mozu.api.urls.commerce.OrderUrl.resendOrderConfirmationEmailUrl(orderId);
String verb = "PUT";
MozuClient mozuClient = (MozuClient) MozuClientFactory.getInstance();
mozuClient.setVerb(verb);
mozuClient.setResourceUrl(url);
mozuClient.setBody(action);
return mozuClient;
}
/**
* Changes the price list associated with an order. The desired price list code should be specified in the ApiContext.
* <p><pre><code>
* MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order> mozuClient=ChangeOrderPriceListClient( priceListCode, orderId);
* client.setBaseAddress(url);
* client.executeRequest();
* Order order = client.Result();
* </code></pre></p>
* @param orderId Unique identifier of the order.
* @param priceListCode The unique price list code.
* @return Mozu.Api.MozuClient <com.mozu.api.contracts.commerceruntime.orders.Order>
* @see com.mozu.api.contracts.commerceruntime.orders.Order
* @see string
*/
public static MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order> changeOrderPriceListClient(String priceListCode, String orderId) throws Exception
{
return changeOrderPriceListClient( priceListCode, orderId, null, null, null);
}
/**
* Changes the price list associated with an order. The desired price list code should be specified in the ApiContext.
* <p><pre><code>
* MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order> mozuClient=ChangeOrderPriceListClient( priceListCode, orderId, updateMode, version, responseFields);
* client.setBaseAddress(url);
* client.executeRequest();
* Order order = client.Result();
* </code></pre></p>
* @param orderId Unique identifier of the order.
* @param responseFields Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss.
* @param updateMode Specifies whether to update the original order, update the order in draft mode, or update the order in draft mode and then commit the changes to the original. Draft mode enables users to make incremental order changes before committing the changes to the original order. Valid values are "ApplyToOriginal," "ApplyToDraft," or "ApplyAndCommit."
* @param version Determines whether or not to check versioning of items for concurrency purposes.
* @param priceListCode The unique price list code.
* @return Mozu.Api.MozuClient <com.mozu.api.contracts.commerceruntime.orders.Order>
* @see com.mozu.api.contracts.commerceruntime.orders.Order
* @see string
*/
public static MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order> changeOrderPriceListClient(String priceListCode, String orderId, String updateMode, String version, String responseFields) throws Exception
{
MozuUrl url = com.mozu.api.urls.commerce.OrderUrl.changeOrderPriceListUrl(orderId, responseFields, updateMode, version);
String verb = "PUT";
Class<?> clz = com.mozu.api.contracts.commerceruntime.orders.Order.class;
MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order> mozuClient = (MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order>) MozuClientFactory.getInstance(clz);
mozuClient.setVerb(verb);
mozuClient.setResourceUrl(url);
mozuClient.setBody(priceListCode);
return mozuClient;
}
/**
* Updates the user ID of the shopper who placed the order to the current user.
* <p><pre><code>
* MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order> mozuClient=ChangeOrderUserIdClient( orderId);
* client.setBaseAddress(url);
* client.executeRequest();
* Order order = client.Result();
* </code></pre></p>
* @param orderId Unique identifier of the order.
* @return Mozu.Api.MozuClient <com.mozu.api.contracts.commerceruntime.orders.Order>
* @see com.mozu.api.contracts.commerceruntime.orders.Order
*/
public static MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order> changeOrderUserIdClient(String orderId) throws Exception
{
return changeOrderUserIdClient( orderId, null);
}
/**
* Updates the user ID of the shopper who placed the order to the current user.
* <p><pre><code>
* MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order> mozuClient=ChangeOrderUserIdClient( orderId, responseFields);
* client.setBaseAddress(url);
* client.executeRequest();
* Order order = client.Result();
* </code></pre></p>
* @param orderId Unique identifier of the order.
* @param responseFields Use this field to include those fields which are not included by default.
* @return Mozu.Api.MozuClient <com.mozu.api.contracts.commerceruntime.orders.Order>
* @see com.mozu.api.contracts.commerceruntime.orders.Order
*/
public static MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order> changeOrderUserIdClient(String orderId, String responseFields) throws Exception
{
MozuUrl url = com.mozu.api.urls.commerce.OrderUrl.changeOrderUserIdUrl(orderId, responseFields);
String verb = "PUT";
Class<?> clz = com.mozu.api.contracts.commerceruntime.orders.Order.class;
MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order> mozuClient = (MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order>) MozuClientFactory.getInstance(clz);
mozuClient.setVerb(verb);
mozuClient.setResourceUrl(url);
return mozuClient;
}
/**
* Updates the specified order when additional order information, such as shipping or billing information, is modified during the checkout process.
* <p><pre><code>
* MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order> mozuClient=UpdateOrderClient( order, orderId);
* client.setBaseAddress(url);
* client.executeRequest();
* Order order = client.Result();
* </code></pre></p>
* @param orderId Unique identifier of the order.
* @param order Properties of an order, including its components.
* @return Mozu.Api.MozuClient <com.mozu.api.contracts.commerceruntime.orders.Order>
* @see com.mozu.api.contracts.commerceruntime.orders.Order
* @see com.mozu.api.contracts.commerceruntime.orders.Order
*/
public static MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order> updateOrderClient(com.mozu.api.contracts.commerceruntime.orders.Order order, String orderId) throws Exception
{
return updateOrderClient( order, orderId, null, null, null);
}
/**
* Updates the specified order when additional order information, such as shipping or billing information, is modified during the checkout process.
* <p><pre><code>
* MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order> mozuClient=UpdateOrderClient( order, orderId, updateMode, version, responseFields);
* client.setBaseAddress(url);
* client.executeRequest();
* Order order = client.Result();
* </code></pre></p>
* @param orderId Unique identifier of the order.
* @param responseFields Use this field to include those fields which are not included by default.
* @param updateMode Specifies whether to update the original order, update the order in draft mode, or update the order in draft mode and then commit the changes to the original. Draft mode enables users to make incremental order changes before committing the changes to the original order. Valid values are "ApplyToOriginal," "ApplyToDraft," or "ApplyAndCommit."
* @param version System-supplied integer that represents the current version of the order, which prevents users from unintentionally overriding changes to the order. When a user performs an operation for a defined order, the system validates that the version of the updated order matches the version of the order on the server. After the operation completes successfully, the system increments the version number by one.
* @param order Properties of an order, including its components.
* @return Mozu.Api.MozuClient <com.mozu.api.contracts.commerceruntime.orders.Order>
* @see com.mozu.api.contracts.commerceruntime.orders.Order
* @see com.mozu.api.contracts.commerceruntime.orders.Order
*/
public static MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order> updateOrderClient(com.mozu.api.contracts.commerceruntime.orders.Order order, String orderId, String updateMode, String version, String responseFields) throws Exception
{
MozuUrl url = com.mozu.api.urls.commerce.OrderUrl.updateOrderUrl(orderId, responseFields, updateMode, version);
String verb = "PUT";
Class<?> clz = com.mozu.api.contracts.commerceruntime.orders.Order.class;
MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order> mozuClient = (MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order>) MozuClientFactory.getInstance(clz);
mozuClient.setVerb(verb);
mozuClient.setResourceUrl(url);
mozuClient.setBody(order);
return mozuClient;
}
}