The following servlet beans are located in /atg/commerce/custsvc/returns/. For additional information, refer to the ATG Platform API Reference.
Return Droplet Servlet Bean
This servlet bean gets the returns and exchanges associated with an order.
Class |
|
|---|---|
Components |
|
Input Parameters:
orderId– The ID of the order.result– The list of return request items.itemReturnSummary– A map of commerce item to return quantity.searchByReplacementId– If true, the droplet will search for related replacement orders that haveorderIdas the original order, or related original orders that haveorderIdas the replacement orders.
Output Parameters:
outputerror
Is Exchange Order Droplet Servlet Bean
This servlet bean determines if an order is the replacement order for an exchange.
Class |
|
|---|---|
Components |
|
Input Parameters:
orderId– The ID of the order.
Open Parameters:
true– Indicates that this is a replacement order for an exchange, and provides thereturnRequestIdoutput parameter.false– Indicates that this is not a replacement order.
Output Parameters:
returnRequestId– This output parameter is used when rendering thetrueopen parameter.
Return Request Lookup Droplet Servlet Bean
This servlet bean returns the ReturnRequest by ID or by a specific user profile, optionally restricted by site. It also performs a security check to ensure that the profile referenced by the ReturnRequest is the same as in the session profile. CSC ONLY – uses the AdminReturnRequestLookup component where security is disabled through configuration.
Class |
|
|---|---|
Components |
|
Input Parameters:
returnRequestId– The ID of theReturnRequest.userId– The ID of the user profile.state– Optional input parameter to indicate how to further narrow the result set. The state may be one of the named return states or one of the two virtual states: open or closed.siteScope– Optional input parameter to indicate how to further narrow the result set. ThesiteScopeparameter can be current, all, or a shareable type ID such asatg.ShoppingCart.siteIds– Optional input parameter to indicate how to further narrow the results. If specified, thesiteIdsparameter must be a collection of strings.startIndex– The firstReturnRequestto return. This is useful for cycling through large numbers of returns.numReturns– An optional parameter that identifies the number ofReturnRequeststo return.openStates– An optional comma-separated list of states that correspond to open state.closedStates– An optional comma-separated list of states that correspond to closed state.sortBy– This optional parameter indicates the column to use for sorting. By default, sorting is done in descending order.sortAscending– This optional parameter specifies whether the results shown are sorted in ascending or descending order. By default sorting is done in descending order.queryTotalOnly– Optional boolean parameter indicating that only a count of ReturnRequest objects is needed.queryTotal– Optional boolean parameter that overrides thequeryTotalproperty for only the current lookup.
Open Parameters:
output– Rendered once to set the array of or singleReturnRequestobject in the result parameter.empty– Rendered if there are no results.error– Rendered if an error occurs.
Output Parameters:
result– Contains an array of or a singleReturnRequestobjects.count– Contains the size of the array ofReturnRequestobjects.totalCount– Contains the total number ofReturnRequestobjects.nextIndex– The index of the firstReturnRequestin the next set of results.previousIndex– The index of the firstReturnRequestin the previous set of results.startRange– The 1-based index of the firstReturnRequestin the results.endRange– The 1-based index of the lastReturnRequestin the results.errorMsg– The detailed error message displayed to the user if an error occurs.
Is Return Active Droplet Servlet Bean
This servlet bean determines if there is currently a return in progress. Use this droplet to enable site pages to do things such as conditionally affect navigation.
Class |
|
|---|---|
Components |
|
Open Parameters:
true– Rendered if there is a return in progress.false– Rendered if there is no return in progress.
Output Parameters:
returnRequest– When the oparam renderstrue, this parameter provides a reference to the currentReturnRequest.
Is Returnable Droplet Servlet Bean
This servlet bean takes an order ID or a commerce item ID and determines if the item can be returned. The droplet returns the returnable state of the order or commerce item, and a localized description of the returnable state.
Class |
|
|---|---|
Components |
|
Input Parameters:
item– TheCommerceItemobject or repository item.order– The order object or repository item.
Open Parameters:
true– Rendered if the item is returnable.false– Rendered if the item is not returnable.
Output Parameters:
returnableState– The returnable state value for the item or order.returnableDescription– The resource description for the state.
Get Related Return Requests Droplet Servlet Bean
This servlet bean provides related ReturnRequests for a specified order using the orderId parameter. Related ReturnRequests can be traced to the given order through the order or replacementOrder property.
Class |
|
|---|---|
Components |
|
Input Parameters:
orderId– The ID of the order that has relatedReturnRequests.
Open Parameters:
output– Rendered if there are related returns.empty– Rendered if there are no related returns.
Output Parameters:
relatedReturnRequests– Provides an array of relatedReturnRequests.
Non-Return Item Details Droplet Servlet Bean
This droplet provides information about refund adjustments that were applied to non-return items.
Class |
|
|---|---|
Components |
|
Input Parameters:
returnRequest– TheReturnRequestthat contains the non-return items.
Open Parameters:
returnDetail– Rendered once for each non-return item.outputStart– Rendered once before rendering any non-return items.outputEnd– Rendered once after all non-return items have been rendered.outputEmpty– Rendered if there are no non-return items.
Output Parameters:
commerceItem– The commerce item.shippingGroup– The shipping group.quantityAdjusted– The quantity of the items to which the adjustments apply.ItemCostAdjustments– The collection ofItemCostAdjustmentsthat apply to the non-return item.totalAdjustments– Sum of all amount, order discount and manual adjustments.totalAmountAdjustment– The total adjustment made to the item’s amount.totalTaxAdjustment– The total adjustment made to the item’s tax.totalShippingAdjustment– The total adjustment made to the item’s shipping.totalOrderDiscountAdjustment– The total adjustment made to the item’s order discount share.totalManualAdjustmentAdjustment– The total adjustment made to the item’s manual adjustment share.
