eBay Return Management APIVersion 1.1.0

ReturnStatusInputType ( token )

Enumerated type that defines the return status values that can be passed into the ReturnStatusFilter container and used as filters for the getUserReturns call.

Type that uses ReturnStatusInputType:

Call that uses ReturnStatusInputType:

Enumeration Values

Value Description
CLOSED This value is passed into the ReturnStatusFilter.ReturnStatus field of the getUserReturns request to retrieve all closed return cases. If CLOSED is used as a filter, return cases in the following states (these values are indicated in the Returns.ReturnSummary.status field) are returned:
  • CLOSED
  • CS_CLOSED
  • EXPIRED
  • YOU_CONTACTED_CS_ABOUT_CLOSED_Return
ITEM_SHIPPED This value is passed into the ReturnStatusFilter.ReturnStatus field of the getUserReturns request to retrieve all return cases with the status of WAITING_DELIVERY. Return status values are indicated in the Returns.ReturnSummary.status field.
MY_RESPONSE_DUE This value is passed into the ReturnStatusFilter.ReturnStatus field of the getUserReturns request to retrieve all return cases in which the seller's response is due. The two applicable return status values returned in the Returns.ReturnSummary.status field are MY_PAYMENT_DUE and MY_RESPONSE_DUE. The MY_PAYMENT_DUE value indicates that the seller is expected to issue a refund to the buyer. The MY_RESPONSE_DUE value can indicate that the seller must provide an RMA number to the buyer, or the seller must contact eBay customer support.
OTHER_PARTY_RESPONSE_DUE This value is passed into the ReturnStatusFilter.ReturnStatus field of the getUserReturns request to retrieve all return cases in which the other party's response is due. The only applicable return status value returned in Returns.ReturnSummary.status field is OTHER_PARTY_RESPONSE_DUE.
RETURN_STARTED This value is passed into the ReturnStatusFilter.ReturnStatus field of the getUserReturns request to retrieve all open return cases. If RETURN_STARTED is used as a filter, return cases in the following states (these values are indicated in the Returns.ReturnSummary.status field) are returned:
  • MY_PAYMENT_DUE
  • MY_RESPONSE_DUE
  • OTHER_PARTY_CONTACTED_CS_AWAITING_RESPONSE
  • OTHER_PARTY_RESPONSE_DUE
  • PAID
  • WAITING_DELIVERY
  • YOU_CONTACTED_CS_AWAITING_RESPONSE
  * See the Enumeration Index to see exact use of each enumeration value in the API.