eBay Post-Order APIVersion 2.7.3
 

ReturnSummaryType

This type is used by the summary container in the GET /post-order/v2/return/search, POST /post-order/v2/return/, and GET /post-order/v2/return/{returnId} methods. This container provides a summary of information for the return request. This container is not returned in the 'Get' methods if the fieldgroups query parameter is omitted, or if it is used and its value is set to FULL.

Types that use ReturnSummaryType:

Calls that use ReturnSummaryType:

Fields



buyerAvailableOptions ( array of AvailableOptionType ) [0..?]
This array consists one or more options that are available to the buyer to move the return request to the next stage. If the return request is currently waiting for a response from the seller, this array may not appear at all.
See the Field Index to learn which calls use buyerAvailableOptions.

buyerLoginName ( string ) [0..?]
This string value is the eBay user name of the buyer.
See the Field Index to learn which calls use buyerLoginName.

buyerResponseDue ( ReturnResponseDueType ) [0..?]
This container indicates the next action the buyer is responsible for, and the 'due date' for this action. This container might not be returned if there is currently no action due from the buyer.
See the Field Index to learn which calls use buyerResponseDue.

buyerTotalRefund ( TotalRefundAmountType ) [0..?]
This container returns the total refund amount for the buyer. This container will either show the estimated amount due if the buyer refund has yet to be issued, or will show the actual amount paid if buyer refund has been issued.

In some cases, the buyerTotalRefund differs from the sellerTotalRefund because the buyer may receive refunds from eBay instead of from the seller.
See the Field Index to learn which calls use buyerTotalRefund.

creationInfo ( ReturnCreationInfoType ) [0..?]
This container provides details about the buyer's return request, including the order line item (and quantity) that is being returned, the reason for the return, and the buyer's preference to either get money back for item or to get a replacement item from the seller.
See the Field Index to learn which calls use creationInfo.

currentType ( ReturnTypeEnum ) [0..?]
This enumerated value indicates the buyer's desired outcome - money back for the order or a replacement item.
See the Field Index to learn which calls use currentType.

escalationInfo ( EscalationInfoType ) [0..?]
This container provides information on whether or not the buyer or seller is eligible to escalate a return request to a case, and if a return request was escalated, a caseId can be found in this container.
See the Field Index to learn which calls use escalationInfo.

orderId ( string ) [0..?]
The unique eBay-assigned ID of the order being returned.
See the Field Index to learn which calls use orderId.

returnId ( string ) [0..?]
The unique eBay-assigned ID of the return request.
See the Field Index to learn which calls use returnId.

returnPolicy ( ReturnPolicyType ) [0..?]
This container indicates whether or not the seller is required to provide an RMA (return merchandise authorization) number to the buyer. The seller can use the POST /post-order/v2/return/{returnId}/decide method to provide the buyer with the RMA number.
See the Field Index to learn which calls use returnPolicy.

sellerAvailableOptions ( array of AvailableOptionType ) [0..?]
This array consists one or more options that are available to the seller to move the return request to the next stage. If the return request is currently waiting for a response from the buyer, this array may not appear at all.
See the Field Index to learn which calls use sellerAvailableOptions.

sellerLoginName ( string ) [0..?]
This string value is the eBay user name of the seller.
See the Field Index to learn which calls use sellerLoginName.

sellerResponseDue ( ReturnResponseDueType ) [0..?]
This container indicates the next action the seller is responsible for, and the 'due date' for this action. This container might not be returned if there is currently no action due from the seller.
See the Field Index to learn which calls use sellerResponseDue.

sellerTotalRefund ( TotalRefundAmountType ) [0..?]
This container returns the total buyer refund amount due from the seller. This container will either show the estimated amount due if the buyer refund has yet to be issued, or will show the actual amount paid if buyer refund has been issued.

In some cases, the buyerTotalRefund differs from the sellerTotalRefund because the buyer may receive refunds from eBay instead of from the seller.
See the Field Index to learn which calls use sellerTotalRefund.

This enumeration value indicates the current state of the return request.
See the Field Index to learn which calls use state.

This enumeration value indicates the current status of the return request.
See the Field Index to learn which calls use status.

timeoutDate ( DateTime ) [0..?]
The timestamp in this container indicates the date and time when eBay may administratively close the return request is either a buyer's or seller's response is nor made by this deadline.
See the Field Index to learn which calls use timeoutDate.