ReturnRequestType

This type is used by the returnRequest container that is used in numerous calls to provide 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.

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 ( token )

comments ( Text )

itemId ( string )

reason ( ReturnReasonEnum )

requestType ( token )

returnQuantity ( integer )

transactionId ( string )

type ( ReturnTypeEnum )

carrier ( token ) [0..?]

Indicates the shipping carrier that will be used to ship the return item. ShippingCarrierEnum contains some popular shipping carriers for the US, UK, Germany, Canada, and Australia, but it is not a complete list.

See the Field Index to learn which calls use carrier.

comments ( Text ) [0..?]

This optional container allows the buyer to provide more information to the seller about why the item is being returned.

See the Field Index to learn which calls use comments.

itemId ( string ) [0..?]

The unique identifier of a listing. The itemID and transactionId fields are required to identify the order line item for which a return (or return draft) is being requested by the buyer.

See the Field Index to learn which calls use itemId.

reason ( ReturnReasonEnum ) [0..?]

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

See the Field Index to learn which calls use reason.

requestType ( token ) [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 of a transaction. The itemID and transactionId fields are required to identify the order line item for which a return (or return draft) is being requested by the buyer.

See the Field Index to learn which calls use transactionId.

type ( ReturnTypeEnum ) [0..?]

This enumeration value indicates the buyer's desired outcome - money back for the order or a replacement item (in the case of a SNAD item). MONEY_BACK is the default value.

See the Field Index to learn which calls use type.