/**
* Retrieves the cart specified in the request.
*
* <p>
*
* <pre><code>
* Cart cart = new Cart();
* Cart cart = cart.getCart( cartId, responseFields);
* </code></pre>
*
* @param cartId Identifier of the cart to delete.
* @param responseFields Use this field to include those fields which are not included by default.
* @return com.mozu.api.contracts.commerceruntime.carts.Cart
* @see com.mozu.api.contracts.commerceruntime.carts.Cart
*/
public com.mozu.api.contracts.commerceruntime.carts.Cart getCart(
String cartId, String responseFields) throws Exception {
MozuClient<com.mozu.api.contracts.commerceruntime.carts.Cart> client =
com.mozu.api.clients.commerce.CartClient.getCartClient(cartId, responseFields);
client.setContext(_apiContext);
client.executeRequest();
return client.getResult();
}
/**
* Retrieves the details of the product type specified in the request.
*
* <p>
*
* <pre><code>
* ProductType producttype = new ProductType();
* ProductType productType = producttype.getProductType( productTypeId, responseFields);
* </code></pre>
*
* @param productTypeId Identifier of the product type.
* @param responseFields Use this field to include those fields which are not included by default.
* @param dataViewMode DataViewMode
* @return com.mozu.api.contracts.productadmin.ProductType
* @see com.mozu.api.contracts.productadmin.ProductType
*/
public com.mozu.api.contracts.productadmin.ProductType getProductType(
Integer productTypeId, String responseFields) throws Exception {
MozuClient<com.mozu.api.contracts.productadmin.ProductType> client =
com.mozu.api.clients.commerce.catalog.admin.attributedefinition.ProductTypeClient
.getProductTypeClient(_dataViewMode, productTypeId, responseFields);
client.setContext(_apiContext);
client.executeRequest();
return client.getResult();
}
/**
* Retrieves the details of the order handling fee configured for the site.
*
* <p>
*
* <pre><code>
* SiteShippingHandlingFee siteshippinghandlingfee = new SiteShippingHandlingFee();
* SiteShippingHandlingFee siteShippingHandlingFee = siteshippinghandlingfee.getOrderHandlingFee( responseFields);
* </code></pre>
*
* @param responseFields Use this field to include those fields which are not included by default.
* @return com.mozu.api.contracts.sitesettings.shipping.SiteShippingHandlingFee
* @see com.mozu.api.contracts.sitesettings.shipping.SiteShippingHandlingFee
*/
public com.mozu.api.contracts.sitesettings.shipping.SiteShippingHandlingFee getOrderHandlingFee(
String responseFields) throws Exception {
MozuClient<com.mozu.api.contracts.sitesettings.shipping.SiteShippingHandlingFee> client =
com.mozu.api.clients.commerce.settings.shipping.SiteShippingHandlingFeeClient
.getOrderHandlingFeeClient(responseFields);
client.setContext(_apiContext);
client.executeRequest();
return client.getResult();
}
/**
* Suggests possible search terms as the shopper enters search text.
*
* <p>
*
* <pre><code>
* ProductSearchResult productsearchresult = new ProductSearchResult();
* SearchSuggestionResult searchSuggestionResult = productsearchresult.suggest( query, groups, pageSize, responseFields);
* </code></pre>
*
* @param groups
* @param pageSize The number of results to display on each page when creating paged results from
* a query. The maximum value is 200.
* @param query A query entered for searches and facet range.
* @param responseFields Use this field to include those fields which are not included by default.
* @return com.mozu.api.contracts.productruntime.SearchSuggestionResult
* @see com.mozu.api.contracts.productruntime.SearchSuggestionResult
*/
public com.mozu.api.contracts.productruntime.SearchSuggestionResult suggest(
String query, String groups, Integer pageSize, String responseFields) throws Exception {
MozuClient<com.mozu.api.contracts.productruntime.SearchSuggestionResult> client =
com.mozu.api.clients.commerce.catalog.storefront.ProductSearchResultClient.suggestClient(
query, groups, pageSize, responseFields);
client.setContext(_apiContext);
client.executeRequest();
return client.getResult();
}
/**
* Retrieve the settings of a third-party application.
*
* <p>
*
* <pre><code>
* Application application = new Application();
* Application application = application.thirdPartyGetApplication( responseFields);
* </code></pre>
*
* @param responseFields Use this field to include those fields which are not included by default.
* @return com.mozu.api.contracts.sitesettings.application.Application
* @see com.mozu.api.contracts.sitesettings.application.Application
*/
public com.mozu.api.contracts.sitesettings.application.Application thirdPartyGetApplication(
String responseFields) throws Exception {
MozuClient<com.mozu.api.contracts.sitesettings.application.Application> client =
com.mozu.api.clients.commerce.settings.ApplicationClient.thirdPartyGetApplicationClient(
responseFields);
client.setContext(_apiContext);
client.executeRequest();
return client.getResult();
}
/**
* This operation method is the external/public event entity used specifically in pull/poll event
* scenarios.
*
* <p>
*
* <pre><code>
* EventDeliverySummary eventdeliverysummary = new EventDeliverySummary();
* EventDeliverySummary eventDeliverySummary = eventdeliverysummary.getDeliveryAttemptSummary( subscriptionId, id, responseFields);
* </code></pre>
*
* @param id Unique identifier of the customer segment to retrieve.
* @param responseFields Use this field to include those fields which are not included by default.
* @param subscriptionId Unique identifier for a subscription, such as subscribing tenants for an
* event or to receive a notification.
* @return com.mozu.api.contracts.event.EventDeliverySummary
* @see com.mozu.api.contracts.event.EventDeliverySummary
*/
public com.mozu.api.contracts.event.EventDeliverySummary getDeliveryAttemptSummary(
String subscriptionId, Integer id, String responseFields) throws Exception {
MozuClient<com.mozu.api.contracts.event.EventDeliverySummary> client =
com.mozu.api.clients.event.push.subscriptions.EventDeliverySummaryClient
.getDeliveryAttemptSummaryClient(subscriptionId, id, responseFields);
client.setContext(_apiContext);
client.executeRequest();
return client.getResult();
}
/**
* couponsets-coupons Get GetCoupon description DOCUMENT_HERE
*
* <p>
*
* <pre><code>
* Coupon coupon = new Coupon();
* Coupon coupon = coupon.getCoupon( couponSetCode, couponCode, includeCounts, responseFields);
* </code></pre>
*
* @param couponCode Code associated with the coupon to remove from the cart.
* @param couponSetCode
* @param includeCounts
* @param responseFields A list or array of fields returned for a call. These fields may be
* customized and may be used for various types of data calls in Mozu. For example,
* responseFields are returned for retrieving or updating attributes, carts, and messages in
* Mozu.
* @return com.mozu.api.contracts.productadmin.Coupon
* @see com.mozu.api.contracts.productadmin.Coupon
*/
public com.mozu.api.contracts.productadmin.Coupon getCoupon(
String couponSetCode, String couponCode, Boolean includeCounts, String responseFields)
throws Exception {
MozuClient<com.mozu.api.contracts.productadmin.Coupon> client =
com.mozu.api.clients.commerce.catalog.admin.couponsets.CouponClient.getCouponClient(
couponSetCode, couponCode, includeCounts, responseFields);
client.setContext(_apiContext);
client.executeRequest();
return client.getResult();
}
/**
* Retrieves a list of product types according to any specified filter criteria and sort options.
*
* <p>
*
* <pre><code>
* ProductType producttype = new ProductType();
* ProductTypeCollection productTypeCollection = producttype.getProductTypes( startIndex, pageSize, sortBy, filter, responseFields);
* </code></pre>
*
* @param filter A set of filter expressions representing the search parameters for a query:
* eq=equals, ne=not equals, gt=greater than, lt = less than or equals, gt = greater than or
* equals, lt = less than or equals, sw = starts with, or cont = contains. Optional.
* @param pageSize The number of results to display on each page when creating paged results from
* a query. The maximum value is 200.
* @param responseFields Use this field to include those fields which are not included by default.
* @param sortBy
* @param startIndex
* @param dataViewMode DataViewMode
* @return com.mozu.api.contracts.productadmin.ProductTypeCollection
* @see com.mozu.api.contracts.productadmin.ProductTypeCollection
*/
public com.mozu.api.contracts.productadmin.ProductTypeCollection getProductTypes(
Integer startIndex, Integer pageSize, String sortBy, String filter, String responseFields)
throws Exception {
MozuClient<com.mozu.api.contracts.productadmin.ProductTypeCollection> client =
com.mozu.api.clients.commerce.catalog.admin.attributedefinition.ProductTypeClient
.getProductTypesClient(
_dataViewMode, startIndex, pageSize, sortBy, filter, responseFields);
client.setContext(_apiContext);
client.executeRequest();
return client.getResult();
}
/**
* orders-orderrefunds Post CreateRefund description DOCUMENT_HERE
*
* <p>
*
* <pre><code>
* Refund refund = new Refund();
* Refund refund = refund.createRefund( refund, orderId, responseFields);
* </code></pre>
*
* @param orderId Unique identifier of the order.
* @param responseFields A list or array of fields returned for a call. These fields may be
* customized and may be used for various types of data calls in Mozu. For example,
* responseFields are returned for retrieving or updating attributes, carts, and messages in
* Mozu.
* @param refund Mozu.CommerceRuntime.Contracts.Refunds.Refund ApiType DOCUMENT_HERE
* @return com.mozu.api.contracts.commerceruntime.refunds.Refund
* @see com.mozu.api.contracts.commerceruntime.refunds.Refund
* @see com.mozu.api.contracts.commerceruntime.refunds.Refund
*/
public com.mozu.api.contracts.commerceruntime.refunds.Refund createRefund(
com.mozu.api.contracts.commerceruntime.refunds.Refund refund,
String orderId,
String responseFields)
throws Exception {
MozuClient<com.mozu.api.contracts.commerceruntime.refunds.Refund> client =
com.mozu.api.clients.commerce.orders.RefundClient.createRefundClient(
refund, orderId, responseFields);
client.setContext(_apiContext);
client.executeRequest();
return client.getResult();
}
/**
*
*
* <pre><code>
* FulfillmentAction fulfillmentaction = new FulfillmentAction();
* Order order = fulfillmentaction.resendPackageFulfillmentEmail( action, orderId, responseFields);
* </code></pre>
*
* @param orderId
* @param responseFields
* @param action
* @return com.mozu.api.contracts.commerceruntime.orders.Order
* @see com.mozu.api.contracts.commerceruntime.orders.Order
* @see com.mozu.api.contracts.commerceruntime.fulfillment.FulfillmentAction
*/
public com.mozu.api.contracts.commerceruntime.orders.Order resendPackageFulfillmentEmail(
com.mozu.api.contracts.commerceruntime.fulfillment.FulfillmentAction action,
String orderId,
String responseFields)
throws Exception {
MozuClient<com.mozu.api.contracts.commerceruntime.orders.Order> client =
com.mozu.api.clients.commerce.orders.FulfillmentActionClient
.resendPackageFulfillmentEmailClient(action, orderId, responseFields);
client.setContext(_apiContext);
client.executeRequest();
return client.getResult();
}
/**
* Searches the categories displayed on the web storefront for products or product options that
* the shopper types in a search query.
*
* <p>
*
* <pre><code>
* ProductSearchResult productsearchresult = new ProductSearchResult();
* ProductSearchResult productSearchResult = productsearchresult.search( query, filter, facetTemplate, facetTemplateSubset, facet, facetFieldRangeQuery, facetHierPrefix, facetHierValue, facetHierDepth, facetStartIndex, facetPageSize, facetSettings, facetValueFilter, sortBy, pageSize, startIndex, searchSettings, enableSearchTuningRules, searchTuningRuleContext, searchTuningRuleCode, facetTemplateExclude, responseFields);
* </code></pre>
*
* @param enableSearchTuningRules
* @param facet Individually list the facet fields you want to display in a web storefront product
* search.
* @param facetFieldRangeQuery Display a range facet not specified in a template in a web
* storefront product search by listing the facet field and the range to display.
* @param facetHierDepth If filtering using category facets in a hierarchy, the number of category
* hierarchy levels to return for the facet. This option is only available for category
* facets.
* @param facetHierPrefix If filtering using category facets in a hierarchy, the parent categories
* you want to skip in the storefront product search. This parameter is only available for
* category facets.
* @param facetHierValue If filtering using category facets in a hierarchy, the category in the
* hierarchy to begin faceting on. This parameter is only available for category facets.
* @param facetPageSize The number of facet values to return for one or more facets.
* @param facetSettings Settings reserved for future facet search functionality on a web
* storefront product search.
* @param facetStartIndex When paging through multiple facets, the startIndex value for each
* facet.
* @param facetTemplate The facet template to use on the storefront. A template displays all
* facets associated with the template on the web storefront product search. Currently, only
* category-level facet templates are available.
* @param facetTemplateExclude
* @param facetTemplateSubset Display a subset of the facets defined in the template specified in
* facetTemplate parameter.
* @param facetValueFilter The facet values to apply to the filter.
* @param filter A set of filter expressions representing the search parameters for a query:
* eq=equals, ne=not equals, gt=greater than, lt = less than or equals, gt = greater than or
* equals, lt = less than or equals, sw = starts with, or cont = contains. Optional.
* @param pageSize The number of results to display on each page when creating paged results from
* a query. The maximum value is 200.
* @param query A query entered for searches and facet range.
* @param responseFields Use this field to include those fields which are not included by default.
* @param searchSettings
* @param searchTuningRuleCode
* @param searchTuningRuleContext
* @param sortBy
* @param startIndex
* @return com.mozu.api.contracts.productruntime.ProductSearchResult
* @see com.mozu.api.contracts.productruntime.ProductSearchResult
*/
public com.mozu.api.contracts.productruntime.ProductSearchResult search(
String query,
String filter,
String facetTemplate,
String facetTemplateSubset,
String facet,
String facetFieldRangeQuery,
String facetHierPrefix,
String facetHierValue,
String facetHierDepth,
String facetStartIndex,
String facetPageSize,
String facetSettings,
String facetValueFilter,
String sortBy,
Integer pageSize,
Integer startIndex,
String searchSettings,
Boolean enableSearchTuningRules,
String searchTuningRuleContext,
String searchTuningRuleCode,
String facetTemplateExclude,
String responseFields)
throws Exception {
MozuClient<com.mozu.api.contracts.productruntime.ProductSearchResult> client =
com.mozu.api.clients.commerce.catalog.storefront.ProductSearchResultClient.searchClient(
query,
filter,
facetTemplate,
facetTemplateSubset,
facet,
facetFieldRangeQuery,
facetHierPrefix,
facetHierValue,
facetHierDepth,
facetStartIndex,
facetPageSize,
facetSettings,
facetValueFilter,
sortBy,
pageSize,
startIndex,
searchSettings,
enableSearchTuningRules,
searchTuningRuleContext,
searchTuningRuleCode,
facetTemplateExclude,
responseFields);
client.setContext(_apiContext);
client.executeRequest();
return client.getResult();
}
/**
* Updates the definition of a property attribute for the specified product type.
*
* <p>
*
* <pre><code>
* ProductTypeProperty producttypeproperty = new ProductTypeProperty();
* AttributeInProductType attributeInProductType = producttypeproperty.updateProperty( attributeInProductType, productTypeId, attributeFQN, responseFields);
* </code></pre>
*
* @param attributeFQN The fully qualified name of the attribute, which is a user defined
* attribute identifier.
* @param productTypeId Identifier of the product type.
* @param responseFields Use this field to include those fields which are not included by default.
* @param dataViewMode DataViewMode
* @param attributeInProductType Properties of an attribute definition associated with a specific
* product type. When an attribute is applied to a product type, each product of that type
* maintains the same set of attributes.
* @return com.mozu.api.contracts.productadmin.AttributeInProductType
* @see com.mozu.api.contracts.productadmin.AttributeInProductType
* @see com.mozu.api.contracts.productadmin.AttributeInProductType
*/
public com.mozu.api.contracts.productadmin.AttributeInProductType updateProperty(
com.mozu.api.contracts.productadmin.AttributeInProductType attributeInProductType,
Integer productTypeId,
String attributeFQN,
String responseFields)
throws Exception {
MozuClient<com.mozu.api.contracts.productadmin.AttributeInProductType> client =
com.mozu.api.clients.commerce.catalog.admin.attributedefinition.producttypes
.ProductTypePropertyClient.updatePropertyClient(
_dataViewMode, attributeInProductType, productTypeId, attributeFQN, responseFields);
client.setContext(_apiContext);
client.executeRequest();
return client.getResult();
}
/**
* Retrieves a collection of data for delivery attempts of events and notifications. These are
* notifications sent to subscribing sites and tenants. A paged list is returned sorted and
* filtered per the entered parameters.
*
* <p>
*
* <pre><code>
* EventDeliverySummary eventdeliverysummary = new EventDeliverySummary();
* EventDeliverySummaryCollection eventDeliverySummaryCollection = eventdeliverysummary.getDeliveryAttemptSummaries( subscriptionId, startIndex, pageSize, sortBy, filter, responseFields);
* </code></pre>
*
* @param filter A set of expressions that consist of a field, operator, and value and represent
* search parameter syntax when filtering results of a query. Valid operators include equals
* (eq), does not equal (ne), greater than (gt), less than (lt), greater than or equal to
* (ge), less than or equal to (le), starts with (sw), or contains (cont). For example -
* "filter=IsDisplayed+eq+true"
* @param pageSize The number of results to display on each page when creating paged results from
* a query. The amount is divided and displayed on the `pageCount `amount of pages. The
* default is 20 and maximum value is 200 per page.
* @param responseFields Use this field to include those fields which are not included by default.
* @param sortBy The element to sort the results by and the channel in which the results appear.
* Either ascending (a-z) or descending (z-a) channel. Optional.
* @param startIndex When creating paged results from a query, this value indicates the zero-based
* offset in the complete result set where the returned entities begin. For example, with a
* `pageSize `of 25, to get the 51st through the 75th items, use `startIndex=3`.
* @param subscriptionId Unique identifier for a subscription, such as subscribing tenants for an
* event or to receive a notification.
* @return com.mozu.api.contracts.event.EventDeliverySummaryCollection
* @see com.mozu.api.contracts.event.EventDeliverySummaryCollection
*/
public com.mozu.api.contracts.event.EventDeliverySummaryCollection getDeliveryAttemptSummaries(
String subscriptionId,
Integer startIndex,
Integer pageSize,
String sortBy,
String filter,
String responseFields)
throws Exception {
MozuClient<com.mozu.api.contracts.event.EventDeliverySummaryCollection> client =
com.mozu.api.clients.event.push.subscriptions.EventDeliverySummaryClient
.getDeliveryAttemptSummariesClient(
subscriptionId, startIndex, pageSize, sortBy, filter, responseFields);
client.setContext(_apiContext);
client.executeRequest();
return client.getResult();
}
/**
* couponsets-coupons Get GetCoupons description DOCUMENT_HERE
*
* <p>
*
* <pre><code>
* Coupon coupon = new Coupon();
* CouponCollection couponCollection = coupon.getCoupons( couponSetCode, startIndex, pageSize, sortBy, filter, includeCounts, responseFields);
* </code></pre>
*
* @param couponSetCode
* @param filter A set of filter expressions representing the search parameters for a query:
* eq=equals, ne=not equals, gt=greater than, lt = less than or equals, gt = greater than or
* equals, lt = less than or equals, sw = starts with, or cont = contains. Optional.
* @param includeCounts
* @param pageSize The number of results to display on each page when creating paged results from
* a query. The amount is divided and displayed on the `pageCount `amount of pages. The
* default is 20 and maximum value is 200 per page.
* @param responseFields A list or array of fields returned for a call. These fields may be
* customized and may be used for various types of data calls in Mozu. For example,
* responseFields are returned for retrieving or updating attributes, carts, and messages in
* Mozu.
* @param sortBy The element to sort the results by and the channel in which the results appear.
* Either ascending (a-z) or descending (z-a) channel. Optional.
* @param startIndex When creating paged results from a query, this value indicates the zero-based
* offset in the complete result set where the returned entities begin. For example, with a
* `pageSize `of 25, to get the 51st through the 75th items, use `startIndex=3`.
* @return com.mozu.api.contracts.productadmin.CouponCollection
* @see com.mozu.api.contracts.productadmin.CouponCollection
*/
public com.mozu.api.contracts.productadmin.CouponCollection getCoupons(
String couponSetCode,
Integer startIndex,
Integer pageSize,
String sortBy,
String filter,
Boolean includeCounts,
String responseFields)
throws Exception {
MozuClient<com.mozu.api.contracts.productadmin.CouponCollection> client =
com.mozu.api.clients.commerce.catalog.admin.couponsets.CouponClient.getCouponsClient(
couponSetCode, startIndex, pageSize, sortBy, filter, includeCounts, responseFields);
client.setContext(_apiContext);
client.executeRequest();
return client.getResult();
}
