A token representing the application-level acknowledgement code that indicates the response status. Always eBay successfully processed the request and the business data is returned in the response. Note that it is possible for a response to return Success, but still not contain the expected data in the result. eBay encountered a fatal error during the processing of the request, causing the request to fail. When a serious application-level error occurs, the error is returned instead of the business data. The request that triggered the error was processed successfully but with one or more warnings. eBay successfully processed the request, but one or more non-fatal errors occurred during the processing. Inspect the message details and resolve any problems before resubmitting the request. This is the base class for the request container for all service operations. This is the base class for the response container for all service operations. Returns error information associated with the request. Always Information for an error or warning that occurred when eBay processed the request. This field is not returned if the ack value is Success. Conditionally The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. Always This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone. Always Reserved for future use. Returned errors are categorized as either Application, Request, or System errors. Request and application errors are often caused by passing invalid data in the call request. System errors are primarily caused by application failures and cannot be corrected by changing request values. Indicates that an error has occurred on the eBay system side. For example, a database or server could be down. Inspect the error message to find the cause of the problem. If the problem is on the eBay side, an application can retry the request a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form. An error occurred due to a problem with the request, with the most likely source being the application sending the request. For example, the request is missing a required data element or it contains an invalid field. The problem must be corrected before the request can be resent. Inspect the error message to find the cause of the problem. If the problem is due to an application error, modify the application and resend the request. If the error is due to invalid data, the source of the data must be corrected before you resend the resend request to eBay. An error occurred due to a problem with the request, with the most likely source being missing or invalid data in the request. The problem must be corrected before the request can be retried. Inspect the error message to find the cause of the problem. If the problem is a result of end-user data, alert the end-user to the problem and provide the means for them to correct the problem. Once the problem is resolved, resend the request to eBay. A container for error details. A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. Conditionally Name of the domain in which the error occurred. Conditionally Name of the subdomain in which the error occurred. Conditionally Indicates whether the reported problem is fatal (an error) or is less- severe (a warning). Review the error message details for information on the cause. If the request fails and the application is the source of the error (for example, a required element is missing), update the application before you retry the request. If the problem is due to incorrect user data, alert the end-user to the problem and provide the means for them to correct the data. Once the problem in the application or data is resolved, re-send the request to eBay. If the source of the problem is on eBay's side, you can retry the request a reasonable number of times (eBay recommends you try the request twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, you can resend the request in its original form. If a warning occurs, warning information is returned in addition to the business data. Normally, you do not need to resend the request (as the original request was successful). However, depending on the cause of the warning, you might need to contact the end user, or eBay, to effect a long term solution to the problem. Conditionally There are three categories of errors: request errors, application errors, and system errors. Conditionally A detailed description of the condition that caused the error. Conditionally Unique identifier for an exception associated with an error. Conditionally Various warning and error messages return one or more variables that contain contextual information about the error. This is often the field or value that triggered the error. Conditionally Information regarding an error or warning that occurred when eBay processed the request. Not returned when the ack value is Success. Details about a single error. Conditionally Contextual data associated with an error. The name of the input parameter returned with the error. Inspecting the parameter (or its input value) will often aid in understanding the cause of the error. Not all error messages contain this value. Conditionally Indicates whether the error is a fatal error (causing the request to fail) or a less severe error (a warning) that should be communicated to the user. eBay encountered a fatal error during the processing of the request, causing the request to fail. When eBay encounters an error, it returns error data instead of the requested business data. Inspect the error details and resolve the problem before resubmitting the request. The request was successfully processed, but eBay encountered a non-fatal error during the processing that could affect the data returned. For example, eBay might have changed the value of an input field. In this Return, eBay returns a successful response, but it also returns a warning. For best results, requests should return without warnings. Inspect the warning details and resolve the problem before resubmitting the request. Reserved for future use. Reserved for future use. Reserved for future use. Reserved for future use. Reserved for future use. This call is used to return the current version of Return Management Service. This call can be used to monitor the service for availability. This call has no input parameters and the response contains only the standard output fields.

Returns the current version of Return Management Service.

Response container for the getVersion API call. Type defining the getUserReturns request. This call is used by a seller or buyer to retrieve returns in which the eBay member is involved. This call can retrieve all returns, or filtering criteria can be used.

This call can be used by a seller or buyer to retrieve returns in which the eBay member is involved. This call can retrieve all returns created within the last 30 days, or filtering criteria can be used.

getReturnDetail ResoCase http://developer.ebay.com/Devzone/resolution-case-management/CallRef getUserCases

Retrieves all eBay Buyer Protection cases and older disputes filed against the eBay member.

Container used to retrieve all returns related to a specific eBay listing, or to retrieve a return related to a specific order line item. Boolean OR logic is used if an eBay item ID and transaction ID are both specified. If more than one filter type is used in one call, boolean AND logic is applied to the result set. getUserReturns No A unique identifier of an eBay order. This field will accept an eBay-generated OrderID value or an OrderLineItemID value, which is a concatenation of ItemID and TransactionID with a hyphen separating these two IDs. If an orderId value is specified, any return filed against this order is retrieved. It is possible that multiple returns can be retrieved if the order has multiple line items, and the buyer filed a return against more than one of these order line items. getUserReturns No Container used to restrict results to returns created within a specified date range. The specified date range is inclusive. The maximum date range that can be specified with this filter is 90 days. Returns with creation dates dating back more than 18 months cannot be retrieved. To retrieve returns for a period longer than 90 days, multiple getUserReturns calls must be made using this filter and specifying different date ranges in each subsequent call. If more than one filter type is used in one call, boolean AND logic is applied to the result set. getUserReturns No Container consisting of one or more ReturnStatus filters. If one or more ReturnStatus filters are used, results are restricted to returns in the specified states. If return status filtering is not used, returns in all states are retrieved. The ReturnStatusFilter container uses Boolean OR logic, which means that all returns matching the specified states are retrieved. If more than one filter type is used in one call, boolean AND logic is applied to the result set. getUserReturns No Container used to retrieve all returns related to a specific eBay member, who is identified by role and either by user ID or login name or both. This other user must be on the other side of one or more returns from the calling user. If more than one filter type is used in one call, boolean AND logic is applied to the result set. getUserReturns Yes Container used to control the pagination of the result set, including the number of returns to return per page and the page number you want to return in the output. Pagination is typically used when the result set is expected to be large. The caller can then use subsequent getUserReturns calls to retrieve results page by page by incrementing the pageNumber value in the request each time. The caller will know the total number of pages that need to be retrieved by looking at the paginationOutput.totalPages value in the response. If the paginationInput container is not used, all returns matching the filter criteria are retrieved and displayed on one "page" of the response. getUserReturns No This field is used to sort returns in the response based on either return filing date, estimated refund amount, refund due date, or buyer login name. If this field is not used, returns are sorted by filing date. FilingDate getUserReturns No This field is used to sort returns in the response in descending or ascending order. So, if FilingDate is the sortType being used, and sortOrderType is set to Descending, returns are sorted in the response from the most recent filing date to the oldest filing date. Descending is the default value, so here is how the results will appear for each sortType: <ul> <li>BuyerLoginName: Results are sorted based on name from Z to A</li> <li>EstimatedAmount: Results are sorted based on dollar amount from highest to lowest value</li> <li>FilingDate: Results are sorted based on filing date from most recent to oldest</li> <li>RefundDueDate: Results are sorted based on the date a refund is due to the seller from a date further in the future to a date less further in the future</li> </ul> Descending getUserReturns No Type defining the response container for the getUserReturns call. High-level information is shown for each return that is retrieved. Container consisting of high-level information for each return matching the input criteria. This information includes the creation and modification dates for the return, the reason for the return, item information, response date, and the current status of the return. getUserReturns Always Pagination container consisting of fields that indicate the total number of pages and returns that match the input criteria, the number of returns per page, and the current page number being viewed. The paginationOutput container is always returned even if pagination values are not specified in the request. getUserReturns Always Type defining the otherUserFilter container, which is a filter used in getUserReturns to restrict results to returns involving a specific buyer or seller. getUserReturns No The eBay user ID for the other party involved in the return. Either a userId or a userLoginName value must be specified in the otherUserFilter container. getUserReturns Conditionally The eBay user login name for the other party involved in the return. Either a userId or a userLoginName value must be specified in the otherUserFilter container. getUserReturns Conditionally The role (such as buyer or seller) of the other party involved in the return. This field is required if the otherUserFilter container is used. getUserReturns Conditionally Enumerated type that contains the valid values to use in the otherUserFilter.role field if a user filter is used in a getUserReturns request. This value is specified in the otherUserFilter.role field to retrieve returns where the other user's role is buyer. This value is specified in the otherUserFilter.role field to retrieve returns where the other user's role is seller. This value is specified in the otherUserFilter.role field to retrieve returns where the other user's role is buyer or seller. Type defining the unique identifier for a return. This string value is the unique identifier for a return, and is returned in the responses of getUserReturns and getReturnDetail. For getReturnDetail, getActivityOptions, issueRefund, and provideSellerInfo, a ReturnId is a required input field. 38 getReturnDetail getActivityOptions issueRefund provideSellerInfo Yes getReturnDetail getUserReturns Always Enumerated type that contains the valid values to use in the sortType field. This field is used to sort returns in the response based on either return filing date, estimated refund amount, refund due date, or buyer login name. If this field is not used, returns are sorted by filing date. If this value is specified, returns are sorted based on the filing date of the return. If sortOrder is set to Descending, the most recent returns will appear first in the results set. If sortOrder is set to Ascending, the oldest returns will appear first in the results set. FilingDate is the default value, so returns will be sorted by filing date if a sortOrder value is not specified in the getUserReturns request. If this value is specified, returns are sorted based on the estimated amount of the return. If sortOrder is set to Descending, the highest value returns will appear first in the results set. If sortOrder is set to Ascending, the lowest value returns will appear first in the results set. FilingDate is the default value, so returns will be sorted by filing date if a sortOrder value is not specified in the getUserReturns request. If this value is specified, returns are sorted alphabetically based on the buyer's eBay login name. If sortOrder is set to Ascending, returns are sorted in alphabetical order according to eBay login name. If sortOrder is set to Descending, returns are sorted in reverse alphabetical order according to eBay login name. FilingDate is the default value, so returns will be sorted by filing date if a sortOrder value is not specified in the getUserReturns request. If this value is specified, returns are sorted based on the refund due date. If sortOrder is set to Descending, returns with refund due dates the furthest in the future will appear first in the results set. If sortOrder is set to Ascending, returns with refund due dates the nearest in the future will appear first in the results set. FilingDate is the default value, so returns will be sorted by filing date if a sortOrder value is not specified in the getUserReturns request. This type defines the getReturnDetails request. This call requires the caller to pass in the Authentication Token as described in <a href="http://developer.ebay.com/DevZone/XML/docs/WebHelp/AuthAndAuth-.html">AuthNAuth</a>.

This call can be used by a seller or buyer to retrieve detailed information about a specific return in which they are involved.

Container consisting of the unique identifier for a return. A return ID value is the only input parameter for getReturnDetail, and is required. Return ID values are returned in the ReturnId.id field of each ReturnSummary container returned in the getUserReturns response. 38 getReturnDetail Yes Type defining the getReturnDetail response. Container consisting of high-level information for the return matching the return ID specified in the request. This information includes the creation and modification dates for the return, the estimated refund amount, the reason for the return, item information, response date, and the current status of the return. getReturnDetail Always Container consisting of detailed, dynamic information for the return matching the return ID specified in the request. This information includes the return status, return activity log, returned item status, return shipping information (including an RMA if applicable), refund details, and eBay Buyer Protection case information (if applicable). getReturnDetail Always Type defining the getActivityOptions request. This call is used by a seller to retrieve one or more actions that can be performed based on the status of the return.

This call is used by a seller to retrieve one or more actions that can be performed based on the status of the return.

Container consisting of the unique identifier for a return. A return ID value is the only input parameter for getActivityOptions, and is required. Return ID values are returned in the ReturnId.id field of each ReturnSummary container returned in the getUserReturns response. 38 getActivityOptions Yes Type defining the getActivityOptions response. The seller's possible next step(s) is returned in activityOptions field. Consumers of this service can map the activity to the corresponding Return Management API call. The returned value indicates the next possible action that a seller can take to resolve a return. If ISSUE_REFUND is returned, the next logical step would be to call issueRefund. If PROVIDE_SELLER_INFO is returned, the next logical step would be to call provideSellerInfo. The value that is returned is dependent on the status of the return. getActivityOptions Always Type defining the issueRefund request. This call is used by a seller to issue a refund (PayPal only) to the buyer to resolve a return. The refund operation may involve one or more of the following: purchase price refund, original shipping refund, and/or a restocking fee refund.

This call is used by a seller to issue a refund (PayPal only) to the buyer.

Container consisting of the unique identifier for a return. A return ID value is required and the seller should take all precautions to make sure this value is correct before making the call. Return ID values are returned in the ReturnId.id field of each ReturnSummary container returned in the getUserReturns response. 38 issueRefund Yes Container consisting of details related to the type and amount of the refund to the buyer. issueRefund Yes In this optional field, the seller can include a message to the buyer concerning the refund. issueRefund No Type defining the issueRefund response. The only call-specific output field of issueRefund is RefundStatus. The returned value indicates the result of the attempted refund. The three possible values are SUCCESS, FAILED, or PENDING. issueRefund Always Type defining the provideSellerInfo request. This call is used by a seller to provide a Return Merchandise Authorization number and/or a return shipping address to the buyer.

This call is used by a seller to provide a Return Merchandise Authorization number and/or an alternative return shipping address.

Container consisting of the unique identifier for a return. A return ID value is required and the seller should take all precautions to make sure this value and the Return Merchandise Authorization number match before making the call. Return ID values are returned in the ReturnId.id field of each ReturnSummary container returned in the getUserReturns response. 38 provideSellerInfo Yes The Return Merchandise Authorization number associated with the item to be returned. An RMA number is a unique identifier that is provided by a manufacturer and authorizes the return of an item. 15 provideSellerInfo Conditionally This optional container allows the seller to provide an alternative return shipping address to the buyer. If not provided, the seller's primary return address on record is used as the return address. provideSellerInfo No Type defining the provideSellerInfo response. There are no call-specific fields in the provideSellerInfo response. The caller should look for an ack value of success to determine the success of the call. Type defining the getReturnMetadata request. This call is used by a seller to get a list of possible return reasons, the refund due date, the RMA due date, or all three.

This call is used by a seller to get a list of possible return reasons, the refund due date, the RMA due date, or all three.

This optional, repeatable filter allows the seller to control which return metadata is retrieved in the response. If no filter is used, all return metadata is retrieved in the response. getReturnMetadata No Type defining the getReturnMetadata response. Container consisting of a return metadata type and value. The return metadata that is retrieved is dependent on the metadataEntryCode value(s) that are passed in the request. If no metadataEntryCode value(s) are passed in the request, all return metadata is retrieved. getReturnMetadata Always Type defining the itemFilter container in the getUserReturns request. This container is used to retrieve all returns related to a specific eBay listing or to a specific order line item. The unique identifier for an eBay item listing. If specified, all returns filed against any of this item listing's order line items are retrieved. An itemId value is required if the itemFilter container is used. If a transactionId value is used to identify a specific eBay order line item, that transactionId value must be associated with the itemId value or an error occurs. 19 getUserReturns Conditionally The unique identifier for an eBay order line item. If a transactionId value is specified, any return filed against this order line item is retrieved. The transactionId value must be associated with the itemId value or an error occurs. 19 getUserReturns No Type defining the dateRangeFilter container in the getUserReturns request. This container is used to restrict results to returns created within a specified date range. The starting date for the date range. The fromDate must be older than the toDate, and it cannot be set back more than 18 months in the past. This field is required if the dateRangeFilter container is used. If more than one filter type is used in one call, boolean AND logic is applied to the result set. getUserReturns Conditionally The ending date for the date range. The toDate must be more recent than the fromDate. This field is optional. If it is omitted, all returns created from the fromDate up to the present (system date) are returned, unless the range specified by the fromDate and the present date is greater than 90 days, in which case the toDate defaults to 90 days forward from the fromDate. getUserReturns No Type defining the ReturnStatusFilter container. This container is used to retrieve returns in specific states. If one or more ReturnStatus filters are used, results are restricted to returns in the specified states. If return status filtering is not used, returns in all states are retrieved. The ReturnStatusFilter container uses Boolean OR logic, which means that all returns matching the specified states are retrieved. To retrieve returns in a specific state (such as open, closed, item shipped, etc.), pass in a ReturnStatusInputType value. At least one ReturnStatus field is required if the ReturnStatusFilter container is used, and multiple ReturnStatus values are allowed. getUserReturns Conditionally Type defining the metadataCodeValues container that is returned in the getReturnMetadata response. The metadataCodeValues container consists of either a REFUND_DUE_UPON_ITEM_ARRIVAL, a RMA_DUE_UPON_RETURN_START, or a RETURN_REASONS value. The metadata that is returned is dependent on the metadataEntryCode value(s) that are passed in the request. Either RETURN_REASONS, REFUND_DUE_UPON_ITEM_ARRIVAL, or RMA_DUE_UPON_RETURN_START is returned in this field, based on the use (or omittance) of the metadataEntryCode field of the getReturnMetadata request. getReturnMetadata Always The string (token) value that appears here is associated with the codeName value. For RETURN_REASONS, values include CHANGED_MY_MIND, ARRIVED_DAMAGED, and NOT_AS_DESCRIBED. These values are dependent on the return reason the buyer selects when the return is opened. For REFUND_DUE_UPON_ITEM_ARRIVAL, the value indicates the maximum number of business days a seller has to issue a refund to the buyer after the seller receives the returned item. For RMA_DUE_UPON_RETURN_START, the value indicates the maximum number of business days a seller has to provide a Return Merchandise Authorization number (if an RMA is requested) to the buyer once a return is opened. getReturnMetadata Always Enumerated type that defines the possible values that can be passed into the metadataEntryType field of the getReturnMetadata request. If this value is passed in, only information related to specific metadata is returned in the getReturnMetadata response. If this value is passed in, all metadata information is returned in the getReturnMetadata response. ALL is the default value if the metadataEntryType field is not used in the getReturnMetadata request. Enumerated type that defines the metadata values used by the getReturnMetadata call. In the getReturnMetadata request, these values are passed into the metadataEntryCode field, and in the getReturnMetadata response, these values are returned in the metadataCodeValues.codeName field. This value is passed into the metadataEntryCode field of the getReturnMetadata request to retrieve the maximum number of business days a seller has to issue a refund to the buyer upon receiving the returned item. The number of days can be found in the metadataCodeValues.value field of the getReturnMetadata response. A refund can be issued to the buyer through the issueRefund call. This value is passed into the metadataEntryCode field of the getReturnMetadata request to retrieve the maximum number of business days after the return filing date that a seller has to provide an Return Merchandise Authorization number (if requested) to the buyer. The number of days can be found in the metadataCodeValues.value field of the getReturnMetadata response. An RMA can be provided to the buyer through the provideSellerInfo call. This value is passed into the metadataEntryCode field of the getReturnMetadata request to retrieve the reason the buyer is returning the item. The return reasons are found in the metadataCodeValues.value field of the getReturnMetadata response. Enumerated type that defines the return status values that can be passed into the ReturnStatusFilter container and used as filters for the getUserReturns call. CLOSED, ITEM_SHIPPED, MY_RESPONSE_DUE, OTHER_PARTY_RESPONSE_DUE, RETURN_STARTED This value is passed into the ReturnStatusFilter.ReturnStatus field of the getUserReturns request to retrieve all open returns. If RETURN_STARTED is used as a filter, returns in the following states (these values are indicated in the Returns.ReturnSummary.status field) are returned: <ul> <li>MY_PAYMENT_DUE</li> <li>MY_RESPONSE_DUE</li> <li>OTHER_PARTY_CONTACTED_CS_AWAITING_RESPONSE</li> <li>OTHER_PARTY_RESPONSE_DUE</li> <li>PAID</li> <li>WAITING_DELIVERY</li> <li>YOU_CONTACTED_CS_AWAITING_RESPONSE</li> </ul> This value is passed into the ReturnStatusFilter.ReturnStatus field of the getUserReturns request to retrieve all closed returns. If CLOSED is used as a filter, returns in the following states (these values are indicated in the Returns.ReturnSummary.status field) are returned: <ul> <li>CLOSED</li> <li>CS_CLOSED</li> <li>EXPIRED</li> <li>YOU_CONTACTED_CS_ABOUT_CLOSED_Return</li> </ul> This value is passed into the ReturnStatusFilter.ReturnStatus field of the getUserReturns request to retrieve all returns with the status of WAITING_DELIVERY. Return status values are indicated in the Returns.ReturnSummary.status field. This value is passed into the ReturnStatusFilter.ReturnStatus field of the getUserReturns request to retrieve all returns in which the seller's response is due. The two applicable return status values returned in the Returns.ReturnSummary.status field are MY_PAYMENT_DUE and MY_RESPONSE_DUE. The MY_PAYMENT_DUE value indicates that the seller is expected to issue a refund to the buyer. The MY_RESPONSE_DUE value can indicate that the seller must provide an RMA number to the buyer, or the seller must contact eBay customer support. This value is passed into the ReturnStatusFilter.ReturnStatus field of the getUserReturns request to retrieve all returns in which the other party's response is due. The only applicable return status value returned in Returns.ReturnSummary.status field is OTHER_PARTY_RESPONSE_DUE. Enumerated type that determines whether returns in the getUserReturns response are displayed in ascending or descending order. This value is passed into the sortOrderType field of the getUserReturns call to display all retrieved returns in ascending order. See the ReturnSortType documentation to get an idea about how Ascending affects the four different sort types. This value is passed into the sortOrderType field of the getUserReturns call to display all retrieved returns in descending order. See the ReturnSortType documentation to get an idea about how Descending affects the four different sort types. Descending is the default value and will be used if the sortOrderType field is not included in the getUserReturns request. Type defining the Returns container in the getUserReturns response. The Returns container is a root container that consists of one or more returns. A ReturnsSummary node is returned for each return that is retrieved. Container consisting of high-level information for a return. A ReturnSummary container is returned in the getUserReturns request for each return matching the input criteria. This information includes the creation and modification dates for the return, the estimated refund amount, the reason for the return, item information, response date, and the current status of the return. getUserReturns Always Type defining the responseDue container returned in the requests of the getUserReturns and getReturnDetail calls. The responseDue container is only returned if a response is due from the seller or other party involved in the return. Container that identifies the party whose response is due. The party is identified by eBay user ID and role (BUYER or SELLER). getUserReturns getReturnDetail Conditionally This date indicates the due date of the party's response. getUserReturns getReturnDetail Conditionally Type defining the ReturnSummary container. A ReturnSummary container is returned in the requests for the getUserReturns and getReturnDetail calls for each return matching the input criteria. Container consisting of the unique identifier for a return. Return ID values are returned in the ReturnId.id field of each ReturnSummary container returned in the getUserReturns and getReturnDetail calls. getUserReturns getReturnDetail Always Container that identifies the other party involved in the return. The party is identified by eBay user ID and role (BUYER or SELLER). getUserReturns getReturnDetail Always Container consisting of details on the item being returned and the return reason. getUserReturns getReturnDetail Always This field indicates the current status of the return. This value will often give the seller a good idea about the next step to take in the return. getUserReturns getReturnDetail Always This container consists of the party whose response is due and the due date of that response. This container is only returned in the requests of the getUserReturns and getReturnDetail calls if a response is due from the seller or other party involved in the return. getUserReturns getReturnDetail Conditionally This date indicates the date on which the return was created. getUserReturns getReturnDetail Always This date indicates the date on which the return was last modified. getUserReturns getReturnDetail Always Type used by the ReturnSummary.user and ReturnSummary.otherParty containers in the getUserReturns and getReturnDetail calls to identify a user involved in a return. getUserReturns getReturnDetail Always The eBay user ID for the party involved in the return. getUserReturns getReturnDetail Always The role (such as buyer or seller) of the party involved in the return. getUserReturns getReturnDetail Always Enumerated type that defines the user roles in a return. This value indicates that the user's role in the return is buyer. This value indicates that the user's role in the return is seller. This value indicates that the user's role in the return is eBay. This value indicates that the user's role in the return is system. This value is reserved for future use. Enumerated type that defines all possible shipment states relating to the buyer returning an item to the seller. The status of a buyer's return shipment is shown in the ReturnDetail.buyerReturnShipment.shipmentStatus field of the getReturnDetail response. This value indicates that the buyer is waiting for an Return Merchandise Authorization (RMA) number and/or an alternative return shipping address before returning the item to the seller. A seller can provide a buyer with this information by using the provideSellerInfo call. This value indicates that the item is ready to be return shipped by the buyer. This value indicates that the item has been shipped by the buyer. This value indicates that the returned item has been received by the seller. This value is reserved for future use. Enumerated type that indicates whether or not a seller's refund to a buyer using the issueRefund call was successful. This type is used by the RefundStatus field of the issueRefund request. This value indicates that the seller's refund to the buyer was successful. This value indicates that the seller's refund to the buyer failed. Enumerated type that indicates the current status of a seller's refund to a buyer. This value indicates that the seller's refund to the buyer was successful. This value indicates that the seller's refund to the buyer is pending. This value is commonly returned if the payment method was eCheck. This value indicates that the seller's refund to the buyer failed. This type defines the the buyer's reason for returning an item, and is used by the ReturnSummary.returnRequest.returnReason field in the response of the getUserReturns and getReturnDetail calls. The returnReason is always returned. Enumerated type that defines the reasons why a return is closed. These values are returned in getReturnDetail for closed returns. This value indicates that the seller has refunded the buyer and the return has been closed. This value indicates that the return expiration date has been reached, so the return has been closed. This value indicates that customer service has closed the return. This value indicates that the return has been closed due to the buyer opening up an eBay Buyer Protection case against the item. This value is reserved for future use. Type defining the returnItem container that is returned in the getUserReturns and getReturnDetail calls. The returnItem container consists of the eBay item ID, the transaction ID, and quantity of the item being returned to the seller. The unique identifier for an eBay item listing. 19 getUserReturns getReturnDetail Always The unique identifier for an eBay order line item. getUserReturns getReturnDetail Always This value indicates the quantity of items to be returned. This value is usually '1' unless multiple identical items were purchased by the buyer. 1 getUserReturns getReturnDetail Always Monetary amount. This type is used in several locations in the getUserReturns, getReturnDetails, and issueRefund responses. This attribute identifies the currency in which the monetary amount is specified. Type defining the totalRefundAmount container. This container contains the estimated and actual refund amounts. This field contains the estimated refund amount for the return. The estimated refund amount is based on the subtotal value of the order line item. getUserReturns getReturnDetail Always This field contains the actual refund amount for the return. This value reads 0.0 until a refund is actually issued by the seller to the buyer. getUserReturns getReturnDetail Always Type defining the returnRequest container that is returned in the getUserReturns and getReturnDetail calls. The returnRequest container consists of the return reason, the eBay item and transaction IDs, and the item quantity. Container consisting of the eBay item ID, the transaction ID, and quantity of the item being returned to the seller. The returnItem container is returned in the getUserReturns and getReturnDetail calls. getUserReturns getReturnDetail Always This value indicates the buyer's reason for returning an item. Possible values include I_DONT_WANT_IT (buyer remorse) and SNAD (item Significantly Not As Described). getUserReturns getReturnDetail Always This field contains any comments posted by the buyer upon opening the return. For a SNAD case, the buyer might state the discrepancies between the actual item received and the item described in the listing. getUserReturns getReturnDetail Conditionally Type defining the ReturnDetail container returned in getReturnDetail. All information for a single return is returned under the ReturnDetail container. Unique identifier of the eBay site (such as EBAY-US) where the order occurred. getReturnDetail Always Repeatable container consisting of details related to each activity in a return. A returnHistory node is returned for each activity that has occurred with the return, and each node contains the type of activity, the timestamp for the activity, the initiator of the activity, and any notes related to the return. Additionally, if the activity is related to a money movement transaction, a ReturnDetail.returnHistory.attributes container is returned providing more information on the transaction. getReturnDetail Always Container consisting of details and values related to estimated, actual, and itemized refunds to the buyer. getReturnDetail Always Container consisting of flags which indicate whether the seller is willing to provide the buyer a Return Merchandise Authorization number (if requested), and if the seller accepts returns to more than one address. These return policy preferences are set by the seller in the Returns Center. This container will only be returned if at least one of the flags is turned on. getReturnDetail Conditionally Container consisting of details related to the buyer's return shipment to the seller. Information in the buyerReturnShipment container include the seller's primary return address on record, the expected delivery date, the shipping carrier and tracking number, the delivery status, and the return shipping costs. getReturnDetail Always Container consisting of the eBay Buyer Protection case ID and case type. This container is only returned if a return is escalated to the eBay Buyer Protection system and accepted as an eBP case. getReturnDetail Conditionally Type defining the caseId container, which consists of a case ID and case type that uniquely identifies an eBay Buyer Protection case. Unique identifier of an eBay Buyer Protection case. 38 getReturnDetail Conditionally This value indicates the type of eBay Buyer Protection case. For an escalated return case, the value will most likely be EBP_SNAD (item Significantly Not As Described). getReturnDetail Conditionally Enumerated type that defines the eBay Buyer Protection case types. This value indicates that the eBay Buyer Protection case involves a "significantly not as described" item. This value is reserved for future use. Enumerated type that defines the types of itemized refunds. This value indicates that the refund to the buyer is for the purchase price of the item, or items (for multiple quantity purchases). This value indicates that the refund to the buyer is for the original shipping costs of the item, or items (for multiple quantity purchases). This value indicates that the refund to the buyer is for the restocking fee that was charged to the buyer to restock the item, or items (for multiple quantity purchases). This value is for internal or future use. This value is reserved for future use. Type defining the refundInfo container, which consists of details and values related to estimated, actual, and itemized refunds to the buyer. This field indicates the refund due date, and will only appear if a refund to the buyer has not been issued by the seller. getReturnDetail Conditionally Container consisting of the estimated amount of a seller's refund to the buyer. The estimatedRefundDetail container will contain one itemizedRefund container for each refund fee type due to the buyer (such as purchase price or original shipping). Similarly, if the seller elects to issue additional refund(s) beyond what is required, one itemizedOptionalRefund container will be present for each optional refund issued to the buyer (such as return shipping charge or restocking fee). getReturnDetail Always Container consisting of the actual amount of a seller's refund to the buyer. The actualRefundDetail container will contain one itemizedRefund container for each refund fee type issued to the buyer (such as purchase price or original shipping). Similarly, one itemizedOptionalRefund container will be present for each optional refund fee type that a seller can issue to a buyer (such as return shipping charge or restocking fee). getReturnDetail Conditionally Type defining the returnPolicy container, which consists of a flag to indicate whether the seller is willing to provide the buyer a Return Merchandise Authorization number (if requested), and a flag to indicate if the seller accepts returns to more than one address. This field indicates that the seller has agreed to provide a Return Merchandise Authorization (RMA) number to buyers upon request. A seller can provide an RMA to the buyer by using the returnMerchandiseAuthorization field of the provideSellerInfo call. A seller will use the provideSellerInfo call to provide an RMA to the buyer when the status of the return is 'WAITING_FOR_SELLER_INFO'. This field is only returned if 'true'. getReturnDetail Conditionally This field indicates that the seller has agreed to accept returns at multiple return addresses. A seller can provide an alternative return address to the buyer by using the returnAddress container of the provideSellerInfo call. A seller will use the provideSellerInfo call to provide an alternative return address to the buyer when the status of the return is 'WAITING_FOR_SELLER_INFO'. This field is only returned if 'true'. If the seller has not agreed to accept returns at multiple return addresses, the seller's primary return address in My eBay is used. getReturnDetail Conditionally Type defining the refundDetail container, which is the root container of all details related to actual and estimated refunds. This dollar value indicates the total amount of actual refunds issued by the seller to the buyer. This is a dynamic value while the return is open. The refundDetail.totalAmount value is required in the issueRefund call and it should match the refundDetail.itemizedRefundAmount value (if only one refund type is being issued by the seller) or the composite value of multiple refundDetail.itemizedRefundAmount values (if multiple refund types are being issued by the seller). getReturnDetail Conditionally issueRefund Yes Container used to track estimated and actual individual refund amounts by fee type (such as purchase price, original shipping, or restocking fee). At least one itemizedRefund container is required when the seller is issuing a refund to the buyer through the issueRefund call. getReturnDetail Always issueRefund Yes Type defining the actualRefundDetail container, which consists of details related to an actual seller refund, including the total refund amount, the date of the refund, the status of the refund, and an itemized list of one or more refund fee types (such as purchase price or original shipping). Container consisting of the total refund amount awarded to the buyer and one or more itemizedRefund containers. One itemizedRefund container will be present for each refund fee type (such as purchase price or original shipping). This container is only returned if a refund has been issued by the seller. getReturnDetail Conditionally This value indicates the result of the seller's refund attempt. The two valid values are SUCCESS or FAILED. PENDING is for future use. getReturnDetail Conditionally This date indicates the date of the seller's refund to the buyer. This field is only returned if a refund has been issued by the seller. getReturnDetail Conditionally Type defining the estimatedRefundDetail container, which consists of details related to an estimated seller refund, including the total refund amount, an itemized list of one or more anticipated refund fee types (such as purchase price or original shipping), and an itemized list of one or more optional refund fee types. Container consisting of the total estimated refund amount due to the buyer and one or more itemizedRefund containers. One itemizedRefund container will be present for each refund fee type (such as purchase price or original shipping). getReturnDetail Always One itemizedOptionalRefund container will be present for each optional refund fee type that a seller can issue to a buyer (such as return shipping charge or restocking fee). getReturnDetail Conditionally Type defining the itemizedRefund container. One itemizedRefund container appears under an estimatedRefundDetail or an actualRefundDetail container per refund fee type. The idea behind the itemizedRefund container is to track estimated and actual individual refund amounts by fee type (such as purchase price, original shipping, or restocking fee). This value indicates the type of refund fee, such as purchase price or original shipping. getReturnDetail Conditionally issueRefund Yes This dollar amount indicates the amount of the corresponding refund fee type. getReturnDetail Conditionally issueRefund Yes Type defining the returnHistory container, which consists of details related to each activity in a return. A returnHistory node is returned for each activity that has occurred with the return. This field is returned if the party initiating the action included a note. The text in this field will mirror any text input into the text box in the Return Management Center. getReturnDetail Conditionally Container that identifies the initiator of the action by eBay user ID and role in the return. getReturnDetail Always This container consists of the enumeration ID value and description of the return activity. Note that the content element of this container is reserved for future use. getReturnDetail Conditionally The timestamp of the return activity. getReturnDetail Always Type defining the buyerReturnShipment container, which consists of details related to the buyer's return shipment to the seller. Information in the buyerReturnShipment container include the seller's primary return address on record, the expected delivery date, the shipping carrier and tracking number, the delivery status, and the shipping costs. This value indicates the current shipping status of the item. getReturnDetail Conditionally This value is the tracking number used by the shipping carrier. getReturnDetail Conditionally This value is the name of the shipping carrier. getReturnDetail Conditionally This value indicates the actual date of delivery for the returned item. This field is only returned after the seller has received the returned item from the buyer. getReturnDetail Conditionally This dollar value indicates the total shipping costs incurred by the buyer to ship the returned item. getReturnDetail Conditionally This container consists of the seller's primary return address in My eBay, or the return address provided by the seller through the provideSellerInfo call. getReturnDetail Conditionally This value is the Return Merchandize Authorization (RMA) number associated with the item. The RMA number for an item is expected to be provided by the seller to the buyer upon request. This field is only returned if the buyer requests an RMA number and it is provided by the seller. getReturnDetail Conditionally This date is the earliest date that the seller can expect to receive a returned item from the buyer. getReturnDetail Conditionally This date is the latest date that the seller can expect to receive a returned item from the buyer. getReturnDetail Conditionally This type defines the return shipping address of the seller, and it is used by the returnAddress container of the provideSellerInfo request and by the shippingAddress container of the getReturnDetail response. The name on record for the seller's shipping address. getReturnDetail Conditionally provideSellerInfo No The street address on record for the seller's shipping address. If a seller is updating a shipping address using the provideSellerInfo call, this field is required. getReturnDetail Conditionally provideSellerInfo No The second line of the street address on record for the seller's shipping address. This field is not always used, but it should be provided (if applicable) if a seller is updating a shipping address using the provideSellerInfo call. getReturnDetail Conditionally provideSellerInfo No The city on record for the seller's shipping address. If a seller is updating a shipping address using the provideSellerInfo call, this field is required. getReturnDetail Conditionally provideSellerInfo No The county on record for the seller's shipping address. This field is not always used, but it should be provided (if applicable) if a seller is updating a shipping address using the provideSellerInfo call. getReturnDetail Conditionally provideSellerInfo No The state or province on record for the seller's shipping address. If a seller is updating a shipping address using the provideSellerInfo call, this field is required. getReturnDetail Conditionally provideSellerInfo No The country on record for the seller's shipping address. If a seller is updating a shipping address using the provideSellerInfo call, this field is required. getReturnDetail Conditionally provideSellerInfo No The postal code on record for the seller's shipping address. If a seller is updating a shipping address using the provideSellerInfo call, this field is required. getReturnDetail Conditionally provideSellerInfo No Type defining the paginationInput container, which is used to control the pagination of the result set, including the number of returns to return per page and the page number you want to return in the output. This integer value is used to specify the "page" of data to return in the call response. The total number of result pages is determined by the total number of returns (returned in paginationOutput.totalEntries) matching the request criteria divided by the number of returns to display per page of data (specified in entriesPerPage). This value defaults to '1' if not specified. If there are multiple pages of returns (see paginationOutput.totalPages) to view, multiple getUserReturns calls can be made to view all returns, and the pageNumber value can be incremented by 1 in each subsequent call. 1 100 1 getUserReturns No This integer value is used to specify the maximum number of returns to display in a single "page" of data. This value, along with the number of returns that match the input criteria, will determine the total pages (see paginationOutput.totalPages) in the result set. This value defaults to '200' (the maximum allowed value) if not specified. 1 200 200 getUserReturns No Type defining the paginationOutput container, which consists of fields that indicate the total number of pages and returns that match the input criteria, the number of returns per page, and the current page number being viewed. This integer value indicate the "page" number of the results set. The total number of result pages is determined by the total number of returns (returned in paginationOutput.totalEntries) matching the request criteria divided by the number of returns to display per page of data (indicated in paginationOutput.entriesPerPage). If there are multiple pages of returns (see paginationOutput.totalPages) to view, multiple getUserReturns calls can be made to view all returns, and the paginationInput.pageNumber value can be incremented by 1 in each subsequent call. 1 200 1 getUserReturns Always This integer value indicates the maximum number of returns to return in a single "page" of data. This value, along with the number of returns that match the input criteria, determines the total pages (see paginationOutput.totalPages) in the result set. 1 100 1 getUserReturns Always This value indicates the total number of result pages that exist based on the current input criteria, including the paginationInput fields. If totalPages is more than 1, multiple getUserReturns calls must be made to view all result pages, with the paginationInput.pageNumber value being incremented by 1 in each subsequent call. getUserReturns Always This value indicates the total number of returns that exist based on the current input criteria. Once this value is known, the caller may want to considering tweaking the paginationInput fields in the getUserReturns request and making another call. getUserReturns Always Parent type of the ActivityDetailType and ReturnReasonType enumeration types. Unique identifier of the enumeration value. getReturnDetail getUserReturns Always A description of the enumeration value. getReturnDetail Always Reserved for future use. getReturnDetail Always Parent type for the ProvideSellerInfoOptionType and IssueRefundOptionType types returned in the getActivityOptions response. This field indicates the action that the buyer is seeking from the seller. This field is only returned for the activity option if it is 'true'. Only one activity option returned to a seller in the getActivityOptions response can be the buyer's preference. In other words, the buyerPreference field can only be 'true' for one activity option returned to the seller in the response. Typically, the buyerPreference field is returned 'true' for the IssueRefundOptionType field, but if the buyer is requesting an RMA number, the buyerPreference field is returned 'true' for the ProvideSellerInfoOptionType field instead. getActivityOptions Conditionally Type defining the ISSUE_REFUND activity option. If the ISSUE_REFUND activity option is returned in the getActivityOptions response, the seller can use the issueRefund call to issue a refund to the buyer. container. getActivityOptions Conditionally This integer value indicates the maximum number of business days that a seller has to issue a refund to the buyer once the seller has received the returned item. getActivityOptions Conditionally Type defining the provideSellerInfo activity option. If the provideSellerInfo activity option is returned in the getActivityOptions response, the seller can use the provideSellerInfo call to provide an RMA (Return Merchandise Authorization) number to the buyer. The buyerPreference child field will indicate whether an RMA number is the buyer's preference. getActivityOptions Conditionally Enumerated type that defines a seller's next possible actions to take in a return. This value indicates that the seller's next action is to issue a refund to the buyer. This value indicates that the seller's next action is to provide an RMA (Return Merchandise Authorization) number to the buyer. This value is reserved for future use. Type that defines the activityOptions field, which contains an enumeration value that indicates the next possible action that a seller can take to resolve a return. This value is returned in the activityOptions field if the seller's next action is to issue a refund to the buyer. A selller can issue a refund to a buyer by using the issueRefund call. getActivityOptions Conditionally This value is returned in the activityOptions field if the seller's next action is to provide an RMA to the buyer. A selller can provide an RMA (Return Merchandise Authorization) number to a buyer by using the provideSellerInfo call. getActivityOptions Conditionally This type defines the returnDetail.returnHistory.activityDetail container returned in the getReturnDetail response. This container is always returned. The description child field describes the return activity. Enumerated type containing the possible states for a return. This value indicates that the the buyer is expecting to receive an RMA (Return Merchandise Authorization) number and/or an alternative return shipping address from the seller before the item is shipped back to the seller. This value indicates that the buyer is cleared to ship the item back to the seller. This value indicates that the buyer has shipped the item back to the seller. This value indicates that the returned item has been received by the seller. This value indicates that the return has been closed. This value indicates that the buyer has escalated the return to an eBay Buyer Protection case. When a return is escalated to an eBay Buyer Protection case, the return is closed. This value indicates that the status of the return is unknown. The Platform Notification event sent to a third party. Type defining the NotificationEvent element. One of the eight possible Platform Notification events for the Return Management API. See also http://developer.ebay.com/devzone/xml/docs/reference/ebay/SetNotificationPreferences.html#Request.EventProperty.EventType The user ID of the eBay user subscribed to Platform Notifications. Echo back of user data. See also http://developer.ebay.com/devzone/xml/docs/reference/ebay/SetNotificationPreferences.html#Request.UserData.ExternalUserData The unique identifier of an eBay Return. Timestamp for the creation of the Platform Notification (in UTC). The eBay user ID of the other party involved in the return. The other party's role in the return. The current return status of the item in the return. Global ID (such as EBAY-US) of the eBay site where the order occurred. Enumerated type containing the Platform Notification events associated with eBay Returns and the Return Management API. This notification type is sent to the subscribed user or application when a return is created by the buyer. This notification type is sent to the subscribed user or application when a return is waiting for the seller to provide an RMA number to the buyer. This notification type is sent to the subscribed user or application when the due date for an RMA is overdue. This notification type is sent to the subscribed user or application when the item associated with a return is shipped back to the seller. This notification type is sent to the subscribed user or application when the item associated with a return has been delivered to the seller. This notification type is sent to the subscribed user or application when the refund to the buyer is overdue. This notification type is sent to the subscribed user or application when a return is closed by the system. This notification type is sent to the subscribed user or application when a (SNAD) return is escalated to the eBay Buyer Protection system. Get current service version. Get list of Returns for an eBay member. Gets details on a specific Return. Get activity options for the current state of the Return. Issues full refund. Allow seller to provide the RMA and return address information. Allows third party developers to get the details of return management system. 1.0.0 Service allows consumers to get Resolution Return information, and its details.