eBay Post-Order APIVersion 2

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} calls. This container provides a summary of information for the return request. This container is not returned 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 container consists of the next option(s) that are available to the buyer to move the return request to the next stage. A buyerAvailableOptions container will be returned for each option that is available to the buyer.
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 when the next buyer response on the return is due.
See the Field Index to learn which calls use buyerResponseDue.

buyerTotalRefund ( TotalRefundAmountType ) [0..?]
This container shows the estimated and actual refund to the buyer. A refund to the buyer will generally be coming from 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 (in the case of a SNAD item).
See the Field Index to learn which calls use currentType.

dispositionRuleTriggered ( array of DispositionRuleTemplateTypeEnum ) [0..?]
This enumerated value indicates the type of disposition rule triggered by the return request. More than one dispositionRuleTriggered field may be returned.
See the Field Index to learn which calls use dispositionRuleTriggered.

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.

returnId ( string ) [0..?]
The unique identifier 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 call to provide the buyer with the RMA number.
See the Field Index to learn which calls use returnPolicy.

sellerAvailableOptions ( array of AvailableOptionType ) [0..?]
This container consists of the next option(s) that are available to the seller to move the return request to the next stage. A sellerAvailableOptions container will be returned for each option that is available to the seller.
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 when the next seller response on the return is due.
See the Field Index to learn which calls use sellerResponseDue.

sellerTotalRefund ( TotalRefundAmountType ) [0..?]
This container shows the estimated and actual refund to the seller. A refund to the seller will generally be coming from eBay.
See the Field Index to learn which calls use sellerTotalRefund.

state ( token ) [0..?]
Indicates the current state of the return.
See the Field Index to learn which calls use state.

status ( token ) [0..?]
Indicates the current status of the return request.
See the Field Index to learn which calls use status.