eBay Return Management APIVersion 1.1.0

Field Index

This is a list of all fields in the schema, by name. The same field name may be used by several calls. Note that the underlying type of the field may or may not be the same.

A

A  B  C  D  E  F  G  I  L  M  N  O  P  R  S  T  U  V 

Field name Subfield of
ack getActivityOptions
getReturnDetail
getReturnMetadata
getUserReturns
getVersion
issueRefund
provideSellerInfo
provideTrackingInfo
setItemAsReceived
activityDetail getReturnDetail.ReturnDetail.returnHistory
activityOptions getActivityOptions
actualRefund getReturnDetail.ReturnDetail.refundInfo.actualRefundDetail
actualRefundDetail getReturnDetail.ReturnDetail.refundInfo
amount getReturnDetail.ReturnDetail.refundInfo.actualRefundDetail.actualRefund
  .itemizedRefund
getReturnDetail.ReturnDetail.refundInfo.estimatedRefundDetail.estimatedRefund
  .itemizedRefund
getReturnDetail.ReturnDetail.refundInfo.estimatedRefundDetail
  .itemizedOptionalRefund
issueRefund.refundDetail.itemizedRefund
author getReturnDetail.ReturnDetail.returnHistory

B

A  B  C  D  E  F  G  I  L  M  N  O  P  R  S  T  U  V 

Field name Subfield of
buyerReturnShipment getReturnDetail.ReturnDetail

C

A  B  C  D  E  F  G  I  L  M  N  O  P  R  S  T  U  V 

Field name Subfield of
carrierUsed getReturnDetail.ReturnDetail.buyerReturnShipment
getReturnDetail.ReturnDetail.shipmentInfo
provideTrackingInfo
caseId getReturnDetail.ReturnDetail
category getActivityOptions.errorMessage.error
getReturnDetail.errorMessage.error
getReturnMetadata.errorMessage.error
getUserReturns.errorMessage.error
getVersion.errorMessage.error
issueRefund.errorMessage.error
provideSellerInfo.errorMessage.error
provideTrackingInfo.errorMessage.error
setItemAsReceived.errorMessage.error
city getReturnDetail.ReturnDetail.buyerReturnShipment.shippingAddress
getReturnDetail.ReturnDetail.shipmentInfo.shippingAddress
provideSellerInfo.returnAddress
code getReturnDetail.ReturnDetail.returnHistory.activityDetail
getReturnDetail.ReturnSummary.returnRequest.returnReason
getUserReturns.returns.returnRequest.returnReason
codeName getReturnMetadata.metadataCodeValues
comments getReturnDetail.ReturnSummary.returnRequest
getUserReturns.returns.returnRequest
issueRefund
provideTrackingInfo
content getReturnDetail.ReturnDetail.returnHistory.activityDetail
getReturnDetail.ReturnSummary.returnRequest.returnReason
country getReturnDetail.ReturnDetail.buyerReturnShipment.shippingAddress
getReturnDetail.ReturnDetail.shipmentInfo.shippingAddress
provideSellerInfo.returnAddress
county getReturnDetail.ReturnDetail.buyerReturnShipment.shippingAddress
getReturnDetail.ReturnDetail.shipmentInfo.shippingAddress
provideSellerInfo.returnAddress
creationDate getReturnDetail.ReturnDetail.returnHistory
getReturnDetail.ReturnSummary
getUserReturns.returns
creationDateRangeFilter getUserReturns

D

A  B  C  D  E  F  G  I  L  M  N  O  P  R  S  T  U  V 

Field name Subfield of
deliveryDate getReturnDetail.ReturnDetail.buyerReturnShipment
getReturnDetail.ReturnDetail.shipmentInfo
description getReturnDetail.ReturnDetail.returnHistory.activityDetail
getReturnDetail.ReturnSummary.returnRequest.returnReason
domain getActivityOptions.errorMessage.error
getReturnDetail.errorMessage.error
getReturnMetadata.errorMessage.error
getUserReturns.errorMessage.error
getVersion.errorMessage.error
issueRefund.errorMessage.error
provideSellerInfo.errorMessage.error
provideTrackingInfo.errorMessage.error
setItemAsReceived.errorMessage.error

E

A  B  C  D  E  F  G  I  L  M  N  O  P  R  S  T  U  V 

Field name Subfield of
entriesPerPage getUserReturns.paginationInput
getUserReturns.paginationOutput
error getActivityOptions.errorMessage
getReturnDetail.errorMessage
getReturnMetadata.errorMessage
getUserReturns.errorMessage
getVersion.errorMessage
issueRefund.errorMessage
provideSellerInfo.errorMessage
provideTrackingInfo.errorMessage
setItemAsReceived.errorMessage
errorId getActivityOptions.errorMessage.error
getReturnDetail.errorMessage.error
getReturnMetadata.errorMessage.error
getUserReturns.errorMessage.error
getVersion.errorMessage.error
issueRefund.errorMessage.error
provideSellerInfo.errorMessage.error
provideTrackingInfo.errorMessage.error
setItemAsReceived.errorMessage.error
errorMessage getActivityOptions
getReturnDetail
getReturnMetadata
getUserReturns
getVersion
issueRefund
provideSellerInfo
provideTrackingInfo
setItemAsReceived
estimatedRefund getReturnDetail.ReturnDetail.refundInfo.estimatedRefundDetail
estimatedRefundDetail getReturnDetail.ReturnDetail.refundInfo
exceptionId getActivityOptions.errorMessage.error
getReturnDetail.errorMessage.error
getReturnMetadata.errorMessage.error
getUserReturns.errorMessage.error
getVersion.errorMessage.error
issueRefund.errorMessage.error
provideSellerInfo.errorMessage.error
provideTrackingInfo.errorMessage.error
setItemAsReceived.errorMessage.error

F

A  B  C  D  E  F  G  I  L  M  N  O  P  R  S  T  U  V 

Field name Subfield of
fromDate getUserReturns.creationDateRangeFilter

G

A  B  C  D  E  F  G  I  L  M  N  O  P  R  S  T  U  V 

Field name Subfield of
globalId getReturnDetail.ReturnDetail

I

A  B  C  D  E  F  G  I  L  M  N  O  P  R  S  T  U  V 

Field name Subfield of
id getActivityOptions.ReturnId
getReturnDetail.ReturnDetail.caseId
getReturnDetail.ReturnId
getReturnDetail.ReturnSummary.ReturnId
getUserReturns.returns.ReturnId
issueRefund.ReturnId
provideSellerInfo.ReturnId
itemFilter getUserReturns
itemId getReturnDetail.ReturnSummary.returnRequest.returnItem
getUserReturns.itemFilter
getUserReturns.returns.returnRequest.returnItem
itemizedOptionalRefund getReturnDetail.ReturnDetail.refundInfo.estimatedRefundDetail
itemizedRefund getReturnDetail.ReturnDetail.refundInfo.actualRefundDetail.actualRefund
getReturnDetail.ReturnDetail.refundInfo.estimatedRefundDetail.estimatedRefund
issueRefund.refundDetail

L

A  B  C  D  E  F  G  I  L  M  N  O  P  R  S  T  U  V 

Field name Subfield of
lastModifiedDate getReturnDetail.ReturnSummary
getUserReturns.returns

M

A  B  C  D  E  F  G  I  L  M  N  O  P  R  S  T  U  V 

Field name Subfield of
maxEstDeliveryDate getReturnDetail.ReturnDetail.buyerReturnShipment
getReturnDetail.ReturnDetail.shipmentInfo
message getActivityOptions.errorMessage.error
getReturnDetail.errorMessage.error
getReturnMetadata.errorMessage.error
getUserReturns.errorMessage.error
getVersion.errorMessage.error
issueRefund.errorMessage.error
provideSellerInfo.errorMessage.error
provideTrackingInfo.errorMessage.error
setItemAsReceived.errorMessage.error
metadataCodeValues getReturnMetadata
metadataEntryCode getReturnMetadata
minEstDeliveryDate getReturnDetail.ReturnDetail.buyerReturnShipment
getReturnDetail.ReturnDetail.shipmentInfo

N

A  B  C  D  E  F  G  I  L  M  N  O  P  R  S  T  U  V 

Field name Subfield of
name getReturnDetail.ReturnDetail.buyerReturnShipment.shippingAddress
getReturnDetail.ReturnDetail.shipmentInfo.shippingAddress
provideSellerInfo.returnAddress
note getReturnDetail.ReturnDetail.returnHistory

O

A  B  C  D  E  F  G  I  L  M  N  O  P  R  S  T  U  V 

Field name Subfield of
optedForMultipleReturnAddress getReturnDetail.ReturnDetail.returnPolicy
optedForRMA getReturnDetail.ReturnDetail.returnPolicy
orderId getUserReturns
otherParty getReturnDetail.ReturnSummary
getUserReturns.returns
otherUserFilter getUserReturns

P

A  B  C  D  E  F  G  I  L  M  N  O  P  R  S  T  U  V 

Field name Subfield of
pageNumber getUserReturns.paginationInput
getUserReturns.paginationOutput
paginationInput getUserReturns
paginationOutput getUserReturns
parameter getActivityOptions.errorMessage.error
getReturnDetail.errorMessage.error
getReturnMetadata.errorMessage.error
getUserReturns.errorMessage.error
getVersion.errorMessage.error
issueRefund.errorMessage.error
provideSellerInfo.errorMessage.error
provideTrackingInfo.errorMessage.error
setItemAsReceived.errorMessage.error
party getReturnDetail.ReturnSummary.responseDue
getUserReturns.returns.responseDue
postalCode getReturnDetail.ReturnDetail.buyerReturnShipment.shippingAddress
getReturnDetail.ReturnDetail.shipmentInfo.shippingAddress
provideSellerInfo.returnAddress

R

A  B  C  D  E  F  G  I  L  M  N  O  P  R  S  T  U  V 

Field name Subfield of
refundDate getReturnDetail.ReturnDetail.refundInfo.actualRefundDetail
refundDetail issueRefund
refundDue getReturnDetail.ReturnDetail.refundInfo
refundFeeType getReturnDetail.ReturnDetail.refundInfo.actualRefundDetail.actualRefund
  .itemizedRefund
getReturnDetail.ReturnDetail.refundInfo.estimatedRefundDetail.estimatedRefund
  .itemizedRefund
getReturnDetail.ReturnDetail.refundInfo.estimatedRefundDetail
  .itemizedOptionalRefund
issueRefund.refundDetail.itemizedRefund
refundInfo getReturnDetail.ReturnDetail
RefundStatus issueRefund
refundStatus getReturnDetail.ReturnDetail.refundInfo.actualRefundDetail
respondByDate getReturnDetail.ReturnSummary.responseDue
getUserReturns.returns.responseDue
responseDue getReturnDetail.ReturnSummary
getUserReturns.returns
returnAddress provideSellerInfo
ReturnDetail getReturnDetail
returnHistory getReturnDetail.ReturnDetail
ReturnId getActivityOptions
getReturnDetail
getReturnDetail.ReturnSummary
getUserReturns.returns
issueRefund
provideSellerInfo
provideTrackingInfo
setItemAsReceived
returnItem getReturnDetail.ReturnSummary.returnRequest
getUserReturns.returns.returnRequest
returnMerchandiseAuthorization getReturnDetail.ReturnDetail.buyerReturnShipment
getReturnDetail.ReturnDetail.shipmentInfo
provideSellerInfo
returnPolicy getReturnDetail.ReturnDetail
returnQuantity getReturnDetail.ReturnSummary.returnRequest.returnItem
getUserReturns.returns.returnRequest.returnItem
returnReason getReturnDetail.ReturnSummary.returnRequest
getUserReturns.returns.returnRequest
returnRequest getReturnDetail.ReturnSummary
getUserReturns.returns
returns getUserReturns
ReturnStatus getUserReturns.ReturnStatusFilter
ReturnStatusFilter getUserReturns
ReturnSummary getReturnDetail
ReturnType getReturnDetail.ReturnSummary
getUserReturns.returns
role getReturnDetail.ReturnDetail.returnHistory.author
getReturnDetail.ReturnSummary.otherParty
getReturnDetail.ReturnSummary.responseDue.party
getUserReturns.otherUserFilter
getUserReturns.returns.otherParty
getUserReturns.returns.responseDue.party

S

A  B  C  D  E  F  G  I  L  M  N  O  P  R  S  T  U  V 

Field name Subfield of
severity getActivityOptions.errorMessage.error
getReturnDetail.errorMessage.error
getReturnMetadata.errorMessage.error
getUserReturns.errorMessage.error
getVersion.errorMessage.error
issueRefund.errorMessage.error
provideSellerInfo.errorMessage.error
provideTrackingInfo.errorMessage.error
setItemAsReceived.errorMessage.error
shipmentInfo getReturnDetail.ReturnDetail
shipmentStatus getReturnDetail.ReturnDetail.buyerReturnShipment
getReturnDetail.ReturnDetail.shipmentInfo
shippingAddress getReturnDetail.ReturnDetail.buyerReturnShipment
getReturnDetail.ReturnDetail.shipmentInfo
shippingCost getReturnDetail.ReturnDetail.buyerReturnShipment
getReturnDetail.ReturnDetail.shipmentInfo
sortOrderType getUserReturns
sortType getUserReturns
stateOrProvince getReturnDetail.ReturnDetail.buyerReturnShipment.shippingAddress
getReturnDetail.ReturnDetail.shipmentInfo.shippingAddress
provideSellerInfo.returnAddress
status getReturnDetail.ReturnSummary
getUserReturns.returns
street1 getReturnDetail.ReturnDetail.buyerReturnShipment.shippingAddress
getReturnDetail.ReturnDetail.shipmentInfo.shippingAddress
provideSellerInfo.returnAddress
street2 getReturnDetail.ReturnDetail.buyerReturnShipment.shippingAddress
getReturnDetail.ReturnDetail.shipmentInfo.shippingAddress
provideSellerInfo.returnAddress
subdomain getActivityOptions.errorMessage.error
getReturnDetail.errorMessage.error
getReturnMetadata.errorMessage.error
getUserReturns.errorMessage.error
getVersion.errorMessage.error
issueRefund.errorMessage.error
provideSellerInfo.errorMessage.error
provideTrackingInfo.errorMessage.error
setItemAsReceived.errorMessage.error

T

A  B  C  D  E  F  G  I  L  M  N  O  P  R  S  T  U  V 

Field name Subfield of
timestamp getActivityOptions
getReturnDetail
getReturnMetadata
getUserReturns
getVersion
issueRefund
provideSellerInfo
provideTrackingInfo
setItemAsReceived
toDate getUserReturns.creationDateRangeFilter
totalAmount getReturnDetail.ReturnDetail.refundInfo.actualRefundDetail.actualRefund
getReturnDetail.ReturnDetail.refundInfo.estimatedRefundDetail.estimatedRefund
issueRefund.refundDetail
totalEntries getUserReturns.paginationOutput
totalPages getUserReturns.paginationOutput
trackingNumber getReturnDetail.ReturnDetail.buyerReturnShipment
getReturnDetail.ReturnDetail.shipmentInfo
provideTrackingInfo
transactionId getReturnDetail.ReturnSummary.returnRequest.returnItem
getUserReturns.itemFilter
getUserReturns.returns.returnRequest.returnItem
type getReturnDetail.ReturnDetail.caseId

U

A  B  C  D  E  F  G  I  L  M  N  O  P  R  S  T  U  V 

Field name Subfield of
userId getReturnDetail.ReturnDetail.returnHistory.author
getReturnDetail.ReturnSummary.otherParty
getReturnDetail.ReturnSummary.responseDue.party
getUserReturns.otherUserFilter
getUserReturns.returns.otherParty
getUserReturns.returns.responseDue.party
userLoginName getUserReturns.otherUserFilter

V

A  B  C  D  E  F  G  I  L  M  N  O  P  R  S  T  U  V 

Field name Subfield of
value getReturnMetadata.metadataCodeValues
version getActivityOptions
getReturnDetail
getReturnMetadata
getUserReturns
getVersion
issueRefund
provideSellerInfo
provideTrackingInfo
setItemAsReceived