ResponseHistoryAttributesType

This complex type is used by the responseHistory.attributes container, which consists of various return shipping and refund information.

Type that uses ResponseHistoryAttributesType:

ReturnResponseHistoryType

Calls that use ResponseHistoryAttributesType:

/post-order/v2/return POST, /post-order/v2/return/{returnId} GET

Fields

escalateReason ( string )

keepOriginalItem ( boolean )

moneyMovementRef ( MoneyMovementRef )

partialRefundAmount ( Amount )

refundDeductionType ( RefundDeductionType )

rlspType ( RlspTypeEnum )

RMA ( string )

sellerReturnAddress ( ReturnAddressType )

toEmailAddress ( string )

updatedTrackingNumber ( string )

escalateReason ( string ) [0..?]

Indicates why the buyer or seller escalated the return request to a return case. This field is only returned if a return request was escalated to a return case.

The applicable values are defined in the EscalateReasonEnum type definition.

See the Field Index to learn which calls use escalateReason.

keepOriginalItem ( boolean ) [0..?]

If set to true, the seller indicates that the buyer can keep the item they received instead of shipping it back to the seller when the refund request is accepted.

Default: false

See the Field Index to learn which calls use keepOriginalItem.

moneyMovementRef ( MoneyMovementRef ) [0..?]

This container provides the unique eBay-assigned ID of a monetary transaction associated with a return. This container is not returned if no monetary transaction occurred for this particular return activity (identified in the responseHistory.activity field).

See the Field Index to learn which calls use moneyMovementRef.

partialRefundAmount ( Amount ) [0..?]

This container shows the partial refund amount that the seller is offering to the buyer in order to settle the return request. This field is not applicable and not returned if the seller is not offering the buyer a partial refund.

See the Field Index to learn which calls use partialRefundAmount.

refundDeductionType ( RefundDeductionType ) [0..?]

This container shows the amount/type of deduction that is taken off the refund amount, if any.

The deduction amount can be either a percentage off the refund amount or a monetary amount that is deducted.

See the Field Index to learn which calls use refundDeductionType.

rlspType ( RlspTypeEnum ) [0..?]

This field indicates which AU carrier the seller has provided to the buyer for their use.

See the Field Index to learn which calls use rlspType.

RMA ( string ) [0..?]

This field shows the return merchandise authorization (RMA) number for the return. This field is only returned if an RMA is associated with the return request.

See the Field Index to learn which calls use RMA.

sellerReturnAddress ( ReturnAddressType ) [0..?]

This container consists of the seller's return address. This container is generally returned if the buyer will be returning an item to the seller.

See the Field Index to learn which calls use sellerReturnAddress.

toEmailAddress ( string ) [0..?]

This string value is the email address of the applicable eBay party (the responseHistory.author field identifies this party, such as buyer, seller, eBay). This field will only be returned if necessary/applicable.

See the Field Index to learn which calls use toEmailAddress.

updatedTrackingNumber ( string ) [0..?]

This value is the tracking number of the return shipment. Providing a tracking number is mandatory except in countries where shipment tracking is not available. This field is not returned if this particular return activity (identified in the responseHistory.activity field) did not involve shipping.

See the Field Index to learn which calls use updatedTrackingNumber.