ReturnRequestType

This type is used by the returnRequest container that is used in numerous methods to provide details about the buyer's return request, including the order line item (and quantity) that is being returned and the reason for the return.

Types that use ReturnRequestType:

CreateReturnRequest, GetReturnCreationSessionResponse, SetReturnCreationSessionRequest

Calls that use ReturnRequestType:

/post-order/v2/return POST, /post-order/v2/return/draft POST, /post-order/v2/return/draft/{draftId} GET

Fields

carrier ( string )

comments ( Text )

itemId ( string )

reason ( string )

requestType ( RequestTypeEnum )

returnQuantity ( integer )

transactionId ( string )

type ( ReturnTypeEnum )

carrier ( string ) [0..?]

This enumeration value indicates the shipping carrier that will be used to ship the return item.

The supported enumeration values representing shipping carriers are defined in the ShippingCarrierEnum type definition.

See the Field Index to learn which calls use carrier.

comments ( Text ) [0..?]

This container is used if the buyer wants to add a note or explanation about why the return request was created.

See the Field Index to learn which calls use comments.

itemId ( string ) [0..?]

The unique identifier of the eBay listing where the item was purchased. This field is used in conjunction with the transactionId field to identify a line item within an order.

See the Field Index to learn which calls use itemId.

reason ( string ) [0..?]

This enumerated value indicates the buyer's reason for creating a return request or draft.

The supported enumeration values representing valid return reasons are defined in the ReturnReasonEnum type definition.

See the Field Index to learn which calls use reason.

requestType ( RequestTypeEnum ) [0..?]

This enumeration value indicates if the return request is an actual return request or a return draft.

See the Field Index to learn which calls use requestType.

returnQuantity ( integer ) [0..?]

This integer value indicates the quantity of the line item being returned. This number is generally 1, unless the buyer bought multiple quantity of the item in a multiple-quantity, fixed-price listing. This value defaults to 1 if this field is omitted when a return is created.

See the Field Index to learn which calls use returnQuantity.

transactionId ( string ) [0..?]

The unique identifier for the purchase of a item. This value is created right when the buyer is committed to buying the item, whether that buyer uses a 'Buy it Now' capability, is the winning bidder of an auction, or the buyer's Best Offer is accepted by the seller. This field is used in conjunction with the itemId field to identify a line item within an order.

See the Field Index to learn which calls use transactionId.

type ( ReturnTypeEnum ) [0..?]

This enumeration value indicates the buyer's desired outcome.

Note: Currently, MONEY_BACK is the only supported value.

Default:: MONEY_BACK

See the Field Index to learn which calls use type.