getReturnDetail

Note: The Return Management API is enabled in production. The getReturnDetail call will only return data for US sellers that are opted into eBay Return Center and have returns associated to them. The eBay Return Center pilot launched on July 10, 2012. The eBay Return Center full launch is scheduled for early August 2012. Please refer to http://pages.ebay.com/help/sell/return-process.html for more information on eBay returns and seller opt-in process.

This call retrieves detailed information on one return.

Request Details

To retrieve a specific return, the caller passes a return ID into the ReturnId.id field. The Return ID value can be obtained with the getUserReturns call.

Working with the Response

A ReturnSummary and a ReturnDetail container is returned if a return matches the return ID passed in the request.

The ReturnSummary container consists of the following information:

creationDate: timestamp indicating when the return was opened by the buyer.
lastModifiedDate: timestamp indicating the last time the buyer, seller, or eBay initiated an action on the return.
ReturnId.id: the unique identifier of the return. This value will be used in other Return Management API calls to provide an Return Merchandise Authorization number, to issue a refund, to provide an alternative return shipping address, or to get the next possible action to take on the return.
status: this field contains an enumeration value that indicates the current status of the return.
otherParty: this container identifies the eBay user on the other side of the return.
returnRequest: this container consists of details related to the item being returned, including the buyer's reason for returning the item.
responseDue: this container is returned if the buyer or seller has a pending response due in the return. The current status of the return dictates the type or response that is due.

The ReturnDetail container consists of the following information:

refundInfo.estimatedRefundDetail: the data in this container will reflect the buyer's costs in the original transaction, including the purchase price and shipping costs.
refundInfo.actualRefundDetail: the data in this container will reflect the actual refund transaction issued from the seller to the buyer during the return flow. An itemizedRefund container is required for each refund type, such as purchase price, original shipping, return shipping, and restocking fee. The total refund amount is indicated in the actualRefund.totalAmount field.
refundInfo.refundDue: the date on which the buyer's refund is due from the seller.
returnHistory: a returnHistory node is returned for each activity logged in the return. Each node includes the date, description, and author (actor) of each activity.
globalId: string value that indicates the site ID where the order occurred.
buyerReturnShipment: this container consists of return shipping details, including the seller's return shipping address, the shipping carrier used, the shipping costs, the estimated delivery date range, and the status of the shipment. The tracking number (if provided by buyer) and Return Merchandise Authorization number (if provided by seller) may also appear in this container.
caseId: this container will appear in the response if there is an eBay Buyer Protection case filed against the item.

getReturnDetail Input

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

getReturnDetail Output

The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

<?xml version="1.0" encoding="utf-8"?>
<getReturnDetailResponse xmlns="http://www.ebay.com/marketplace/returns/v1/services">
  <!-- Standard Output Fields -->
  <ack> AckValue </ack>
  <errorMessage> ErrorMessage
    <error> ErrorData
      <category> ErrorCategory </category>
      <domain> string </domain>
      <errorId> long </errorId>
      <exceptionId> token </exceptionId>
      <message> string </message>
      <parameter name="string"> ErrorParameter (string) </parameter>
      <!-- ... more parameter nodes here ... -->
      <severity> ErrorSeverity </severity>
      <subdomain> string </subdomain>
    </error>
    <!-- ... more error nodes here ... -->
  </errorMessage>
  <timestamp> dateTime </timestamp>
  <version> string </version>
  <!-- Call-specific Output Fields -->
  <ReturnDetail> ReturnDetailType
    <buyerReturnShipment> ShipmentType
      <carrierUsed> string </carrierUsed>
      <deliveryDate> dateTime </deliveryDate>
      <maxEstDeliveryDate> dateTime </maxEstDeliveryDate>
      <minEstDeliveryDate> dateTime </minEstDeliveryDate>
      <returnMerchandiseAuthorization> string </returnMerchandiseAuthorization>
      <shipmentStatus> ShipmentStatusType </shipmentStatus>
      <shippingAddress> Address
        <city> string </city>
        <country> string </country>
        <county> string </county>
        <name> string </name>
        <postalCode> string </postalCode>
        <stateOrProvince> string </stateOrProvince>
        <street1> string </street1>
        <street2> string </street2>
      </shippingAddress>
      <shippingCost> Amount (double) </shippingCost>
      <trackingNumber> string </trackingNumber>
    </buyerReturnShipment>
    <caseId> CaseIdType
      <id> string </id>
      <type> CaseType </type>
    </caseId>
    <globalId> token </globalId>
    <refundInfo> RefundInfoType
      <actualRefundDetail> ActualRefundDetailType
        <actualRefund> RefundDetailType
          <itemizedRefund> ItemizedRefundDetailType
            <amount> Amount (double) </amount>
            <refundFeeType> RefundFeeType </refundFeeType>
          </itemizedRefund>
          <!-- ... more itemizedRefund nodes here ... -->
          <totalAmount> Amount (double) </totalAmount>
        </actualRefund>
        <refundDate> dateTime </refundDate>
        <refundStatus> RefundStatusType </refundStatus>
      </actualRefundDetail>
      <estimatedRefundDetail> EstimatedRefundDetailType
        <estimatedRefund> RefundDetailType
          <itemizedRefund> ItemizedRefundDetailType
            <amount> Amount (double) </amount>
            <refundFeeType> RefundFeeType </refundFeeType>
          </itemizedRefund>
          <!-- ... more itemizedRefund nodes here ... -->
          <totalAmount> Amount (double) </totalAmount>
        </estimatedRefund>
        <itemizedOptionalRefund> ItemizedRefundDetailType
          <amount> Amount (double) </amount>
          <refundFeeType> RefundFeeType </refundFeeType>
        </itemizedOptionalRefund>
        <!-- ... more itemizedOptionalRefund nodes here ... -->
      </estimatedRefundDetail>
      <refundDue> dateTime </refundDue>
    </refundInfo>
    <returnHistory> ReturnResponseHistoryType
      <activityDetail> ActivityDetailType (EnumerationDetailType)
        <code> token </code>
        <content> token </content>
        <description> token </description>
      </activityDetail>
      <author> ReturnUserType
        <role> ReturnUserRoleType </role>
        <userId> string </userId>
      </author>
      <creationDate> dateTime </creationDate>
      <note> string </note>
    </returnHistory>
    <!-- ... more returnHistory nodes here ... -->
    <returnPolicy> ReturnPolicyInfoType
      <optedForMultipleReturnAddress> boolean </optedForMultipleReturnAddress>
      <optedForRMA> boolean </optedForRMA>
    </returnPolicy>
  </ReturnDetail>
  <ReturnSummary> ReturnSummaryType
    <creationDate> dateTime </creationDate>
    <lastModifiedDate> dateTime </lastModifiedDate>
    <otherParty> ReturnUserType
      <role> ReturnUserRoleType </role>
      <userId> string </userId>
    </otherParty>
    <responseDue> ReturnResponseDueType
      <party> ReturnUserType
        <role> ReturnUserRoleType </role>
        <userId> string </userId>
      </party>
      <respondByDate> dateTime </respondByDate>
    </responseDue>
    <ReturnId> ReturnIdType
      <id> string </id>
    </ReturnId>
    <returnRequest> ReturnRequestType
      <comments> string </comments>
      <returnItem> ReturnItemType
        <itemId> string </itemId>
        <returnQuantity> int </returnQuantity>
        <transactionId> string </transactionId>
      </returnItem>
      <!-- ... more returnItem nodes here ... -->
      <returnReason> ReturnReasonType (EnumerationDetailType)
        <code> token </code>
        <content> token </content>
        <description> token </description>
      </returnReason>
    </returnRequest>
    <status> ReturnStatusType </status>
  </ReturnSummary>
</getReturnDetailResponse>

Return Value	Type	Occurrence	Meaning

Standard Output Fields [Jump to call-specific fields]

ack	AckValue	Always	Applicable values: • Failure (out) 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. • PartialFailure (out) 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. • Success (out) 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. • Warning (out) The request that triggered the error was processed successfully but with one or more warnings.
errorMessage	ErrorMessage	Conditionally	Information for an error or warning that occurred when eBay processed the request. This field is not returned if the ack value is Success.
errorMessage.error	ErrorData	Conditionally, repeatable: [0..*]	Details about a single error.
errorMessage.error.category	ErrorCategory	Conditionally	There are three categories of errors: request errors, application errors, and system errors. Applicable values: • Application (out) 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. • Request (out) 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. • System (out) 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.
errorMessage.error.domain	string	Conditionally	Name of the domain in which the error occurred.
errorMessage.error.errorId	long	Conditionally	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.
errorMessage.error.exceptionId	token	Conditionally	Unique identifier for an exception associated with an error.
errorMessage.error.message	string	Conditionally	A detailed description of the condition that caused the error.
errorMessage.error.parameter	ErrorParameter (string)	Conditionally, repeatable: [0..*]	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.
errorMessage.error.parameter [ attribute name ]	string	Conditionally	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.
errorMessage.error.severity	ErrorSeverity	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. Applicable values: • Error (out) 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. • Warning (out) 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.
errorMessage.error.subdomain	string	Conditionally	Name of the subdomain in which the error occurred.
timestamp	dateTime	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.
version	string	Always	The version of the response payload schema. Indicates the version of the schema that eBay used to process the request.

Call-specific Output Fields

ReturnDetail	ReturnDetailType	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).
ReturnDetail .buyerReturnShipment	ShipmentType	Always	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.
ReturnDetail .buyerReturnShipment .carrierUsed	string	Conditionally	This value is the name of the shipping carrier.
ReturnDetail .buyerReturnShipment .deliveryDate	dateTime	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.
ReturnDetail .buyerReturnShipment .maxEstDeliveryDate	dateTime	Conditionally	This date is the latest date that the seller can expect to receive a returned item from the buyer.
ReturnDetail .buyerReturnShipment .minEstDeliveryDate	dateTime	Conditionally	This date is the earliest date that the seller can expect to receive a returned item from the buyer.
ReturnDetail .buyerReturnShipment .returnMerchandiseAuthorization	string	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.
ReturnDetail .buyerReturnShipment .shipmentStatus	ShipmentStatusType	Conditionally	This value indicates the current shipping status of the item. Applicable values: • ITEM_DELIVERED (out) This value indicates that the returned item has been received by the seller. • ITEM_SHIPPED (out) This value indicates that the item has been shipped by the buyer. • OTHER (out) This value is reserved for future use. • READY_FOR_SHIPPING (out) This value indicates that the item is ready to be return shipped by the buyer. • WAITING_FOR_SELLER_INFO (out) 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.
ReturnDetail .buyerReturnShipment .shippingAddress	Address	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.
ReturnDetail .buyerReturnShipment .shippingAddress.city	string	Conditionally	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.
ReturnDetail .buyerReturnShipment .shippingAddress.country	string	Conditionally	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.
ReturnDetail .buyerReturnShipment .shippingAddress.county	string	Conditionally	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.
ReturnDetail .buyerReturnShipment .shippingAddress.name	string	Conditionally	The name on record for the seller's shipping address.
ReturnDetail .buyerReturnShipment .shippingAddress.postalCode	string	Conditionally	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.
ReturnDetail .buyerReturnShipment .shippingAddress .stateOrProvince	string	Conditionally	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.
ReturnDetail .buyerReturnShipment .shippingAddress.street1	string	Conditionally	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.
ReturnDetail .buyerReturnShipment .shippingAddress.street2	string	Conditionally	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.
ReturnDetail .buyerReturnShipment .shippingCost	Amount (double)	Conditionally	This dollar value indicates the total shipping costs incurred by the buyer to ship the returned item.
ReturnDetail .buyerReturnShipment .trackingNumber	string	Conditionally	This value is the tracking number used by the shipping carrier.
ReturnDetail.caseId	CaseIdType	Conditionally	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.
ReturnDetail.caseId.id	string	Conditionally	Unique identifier of an eBay Buyer Protection case. Max length: 38.
ReturnDetail.caseId.type	CaseType	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). Applicable values: • EBP_SNAD (out) This value indicates that the eBay Buyer Protection case involves a "significantly not as described" item. • OTHER (out) This value is reserved for future use.
ReturnDetail.globalId	token	Always	Unique identifier of the eBay site (such as EBAY-US) where the order occurred.
ReturnDetail.refundInfo	RefundInfoType	Always	Container consisting of details and values related to estimated, actual, and itemized refunds to the buyer.
ReturnDetail.refundInfo .actualRefundDetail	ActualRefundDetailType	Conditionally	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.
ReturnDetail.refundInfo .actualRefundDetail .actualRefund	RefundDetailType	Conditionally	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.
ReturnDetail.refundInfo .actualRefundDetail .actualRefund.itemizedRefund	ItemizedRefundDetailType	Always, repeatable: [1..*]	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.
ReturnDetail.refundInfo .actualRefundDetail .actualRefund.itemizedRefund .amount	Amount (double)	Conditionally	This dollar amount indicates the amount of the corresponding refund fee type.
ReturnDetail.refundInfo .actualRefundDetail .actualRefund.itemizedRefund .refundFeeType	RefundFeeType	Conditionally	This value indicates the type of refund fee, such as purchase price or original shipping. Applicable values: • ORIGINAL_SHIPPING (in/out) This value indicates that the refund to the buyer is for the original shipping costs of the item, or items (for multiple quantity purchases). • OTHER (in/out) This value is reserved for future use. • PURCHASE_PRICE (in/out) This value indicates that the refund to the buyer is for the purchase price of the item, or items (for multiple quantity purchases). • RESTOCKING_FEE (in/out) This is the only RefundFeeType value that will be a negative dollar value, as a restocking fee is a charge against the buyer for returning the item. In order to enforce a restocking fee on an item, the seller must include a restocking fee value as part of the listing's return policy. In the listing APIs, this field is Item.ReturnPolicy.RestockingFeeValue.
ReturnDetail.refundInfo .actualRefundDetail .actualRefund.totalAmount	Amount (double)	Conditionally	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).
ReturnDetail.refundInfo .actualRefundDetail.refundDate	dateTime	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.
ReturnDetail.refundInfo .actualRefundDetail .refundStatus	RefundStatusType	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. Applicable values: • FAILED (out) This value indicates that the seller's refund to the buyer failed. • PENDING (out) This value indicates that the seller's refund to the buyer is pending. This value is commonly returned if the payment method was eCheck. • SUCCESS (out) This value indicates that the seller's refund to the buyer was successful.
ReturnDetail.refundInfo .estimatedRefundDetail	EstimatedRefundDetailType	Always	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.
ReturnDetail.refundInfo .estimatedRefundDetail .estimatedRefund	RefundDetailType	Always	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).
ReturnDetail.refundInfo .estimatedRefundDetail .estimatedRefund .itemizedRefund	ItemizedRefundDetailType	Always, repeatable: [1..*]	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.
ReturnDetail.refundInfo .estimatedRefundDetail .estimatedRefund .itemizedRefund.amount	Amount (double)	Conditionally	This dollar amount indicates the amount of the corresponding refund fee type.
ReturnDetail.refundInfo .estimatedRefundDetail .estimatedRefund .itemizedRefund.refundFeeType	RefundFeeType	Conditionally	This value indicates the type of refund fee, such as purchase price or original shipping. Applicable values: • ORIGINAL_SHIPPING (in/out) This value indicates that the refund to the buyer is for the original shipping costs of the item, or items (for multiple quantity purchases). • OTHER (in/out) This value is reserved for future use. • PURCHASE_PRICE (in/out) This value indicates that the refund to the buyer is for the purchase price of the item, or items (for multiple quantity purchases). • RESTOCKING_FEE (in/out) This is the only RefundFeeType value that will be a negative dollar value, as a restocking fee is a charge against the buyer for returning the item. In order to enforce a restocking fee on an item, the seller must include a restocking fee value as part of the listing's return policy. In the listing APIs, this field is Item.ReturnPolicy.RestockingFeeValue.
ReturnDetail.refundInfo .estimatedRefundDetail .estimatedRefund.totalAmount	Amount (double)	Conditionally	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).
ReturnDetail.refundInfo .estimatedRefundDetail .itemizedOptionalRefund	ItemizedRefundDetailType	Conditionally, repeatable: [0..*]	One itemizedOptionalRefund container will be present for each optional refund fee type that a seller can issue to a buyer.
ReturnDetail.refundInfo .estimatedRefundDetail .itemizedOptionalRefund.amount	Amount (double)	Conditionally	This dollar amount indicates the amount of the corresponding refund fee type.
ReturnDetail.refundInfo .estimatedRefundDetail .itemizedOptionalRefund .refundFeeType	RefundFeeType	Conditionally	This value indicates the type of refund fee, such as purchase price or original shipping. Applicable values: • ORIGINAL_SHIPPING (in/out) This value indicates that the refund to the buyer is for the original shipping costs of the item, or items (for multiple quantity purchases). • OTHER (in/out) This value is reserved for future use. • PURCHASE_PRICE (in/out) This value indicates that the refund to the buyer is for the purchase price of the item, or items (for multiple quantity purchases). • RESTOCKING_FEE (in/out) This is the only RefundFeeType value that will be a negative dollar value, as a restocking fee is a charge against the buyer for returning the item. In order to enforce a restocking fee on an item, the seller must include a restocking fee value as part of the listing's return policy. In the listing APIs, this field is Item.ReturnPolicy.RestockingFeeValue.
ReturnDetail.refundInfo .refundDue	dateTime	Conditionally	This field indicates the refund due date, and will only appear if a refund to the buyer has not been issued by the seller.
ReturnDetail.returnHistory	ReturnResponseHistoryType	Always, repeatable: [1..*]	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.
ReturnDetail.returnHistory .activityDetail	ActivityDetailType (EnumerationDetailType)	Conditionally	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.
ReturnDetail.returnHistory .activityDetail.code	token	Always	Unique identifier of the enumeration value.
ReturnDetail.returnHistory .activityDetail.content	token	Always	Reserved for future use.
ReturnDetail.returnHistory .activityDetail.description	token	Always	A description of the enumeration value.
ReturnDetail.returnHistory .author	ReturnUserType	Always	Container that identifies the initiator of the action by eBay user ID and role in the return.
ReturnDetail.returnHistory .author.role	ReturnUserRoleType	Always	The role (such as buyer or seller) of the party involved in the return. Applicable values: • BUYER (out) This value indicates that the user's role in the return is buyer. • EBAY (out) This value indicates that the user's role in the return is eBay. • OTHER (out) This value is reserved for future use. • SELLER (out) This value indicates that the user's role in the return is seller. • SYSTEM (out) This value indicates that the user's role in the return is system.
ReturnDetail.returnHistory .author.userId	string	Always	The eBay user ID for the party involved in the return.
ReturnDetail.returnHistory .creationDate	dateTime	Always	The timestamp of the return activity.
ReturnDetail.returnHistory .note	string	Conditionally	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.
ReturnDetail.returnPolicy	ReturnPolicyInfoType	Conditionally	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 Return Center. This container will only be returned if at least one of the flags is turned on.
ReturnDetail.returnPolicy .optedForMultipleReturnAddress	boolean	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.
ReturnDetail.returnPolicy .optedForRMA	boolean	Conditionally	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'.
ReturnSummary	ReturnSummaryType	Always	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.
ReturnSummary.creationDate	dateTime	Always	This date indicates the date on which the return was created.
ReturnSummary.lastModifiedDate	dateTime	Always	This date indicates the date on which the return was last modified.
ReturnSummary.otherParty	ReturnUserType	Always	Container that identifies the other party involved in the return. The party is identified by eBay user ID and role (BUYER or SELLER).
ReturnSummary.otherParty.role	ReturnUserRoleType	Always	The role (such as buyer or seller) of the party involved in the return. Applicable values: • BUYER (out) This value indicates that the user's role in the return is buyer. • EBAY (out) This value indicates that the user's role in the return is eBay. • OTHER (out) This value is reserved for future use. • SELLER (out) This value indicates that the user's role in the return is seller. • SYSTEM (out) This value indicates that the user's role in the return is system.
ReturnSummary.otherParty .userId	string	Always	The eBay user ID for the party involved in the return.
ReturnSummary.responseDue	ReturnResponseDueType	Conditionally	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.
ReturnSummary.responseDue .party	ReturnUserType	Conditionally	Container that identifies the party whose response is due. The party is identified by eBay user ID and role (BUYER or SELLER).
ReturnSummary.responseDue .party.role	ReturnUserRoleType	Always	The role (such as buyer or seller) of the party involved in the return. Applicable values: • BUYER (out) This value indicates that the user's role in the return is buyer. • EBAY (out) This value indicates that the user's role in the return is eBay. • OTHER (out) This value is reserved for future use. • SELLER (out) This value indicates that the user's role in the return is seller. • SYSTEM (out) This value indicates that the user's role in the return is system.
ReturnSummary.responseDue .party.userId	string	Always	The eBay user ID for the party involved in the return.
ReturnSummary.responseDue .respondByDate	dateTime	Conditionally	This date indicates the due date of the party's response.
ReturnSummary.ReturnId	ReturnIdType	Always	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.
ReturnSummary.ReturnId.id	string	Always	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. Max length: 38.
ReturnSummary.returnRequest	ReturnRequestType	Always	Container consisting of details on the item being returned and the return reason.
ReturnSummary.returnRequest .comments	string	Conditionally	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.
ReturnSummary.returnRequest .returnItem	ReturnItemType	Always, repeatable: [1..*]	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.
ReturnSummary.returnRequest .returnItem.itemId	string	Always	The unique identifier for an eBay item listing. Max length: 19.
ReturnSummary.returnRequest .returnItem.returnQuantity	int	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. Min: 1.
ReturnSummary.returnRequest .returnItem.transactionId	string	Always	The unique identifier for an eBay order line item.
ReturnSummary.returnRequest .returnReason	ReturnReasonType (EnumerationDetailType)	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).
ReturnSummary.returnRequest .returnReason.code	token	Always	Unique identifier of the enumeration value.
ReturnSummary.returnRequest .returnReason.content	token	Always	Reserved for future use.
ReturnSummary.returnRequest .returnReason.description	token	Always	A description of the enumeration value.
ReturnSummary.status	ReturnStatusType	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. Applicable values: • CLOSED (out) This value indicates that the return has been closed. • ESCALATED (out) 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. • ITEM_DELIVERED (out) This value indicates that the returned item has been received by the seller. • ITEM_SHIPPED (out) This value indicates that the buyer has shipped the item back to the seller. • READY_FOR_SHIPPING (out) This value indicates that the buyer is cleared to ship the item back to the seller. • UNKNOWN (out) This value indicates that the status of the return is unknown. • WAITING_FOR_SELLER_INFO (out) 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.

getReturnDetail Samples

getReturnDetail Change History

Version	Description
1.0.0 2012-04-23	(added) New call.

User-Contributed Notes

ReturnId	ReturnIdType	Required	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.
ReturnId.id	string	Required	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. Max length: 38.

Return Management API Call Reference Version 1.0.0