eBay Return Management APIVersion 1.1.0

getReturnDetail



Note: The Return Management API is no longer recommended. Instead, current users of the Return Management API should make plans to migrate to, and use the Return operations of the Post-Order API. New users interested is programmatically managing return requests, should also make plans to integrate with the Post-Order API. The Return Management API was developed to be used by sellers who had opted in to "Hassle-free Returns". Hassle-free Returns have been replaced by a new Returns Platform, where sellers fully or partially automate the processing of return requests through Return Automation Rules. The Return Management API does not support all features and logic of the new Returns Platform, and this API will be deprecated in the near future.

This call retrieves detailed information on one eBay-Managed return.

Note: Users of this call should start using the GET /post-order/v2/return/{returnId} call of the Post-Order API instead.

Request Details

To retrieve a specific return, the caller passes a return ID into the ReturnId.id field. The Return ID value can be obtained with the getUserReturns call.

Working with the Response

A ReturnSummary and a ReturnDetail container is returned if a return matches the return ID passed in the request.

The ReturnSummary container consists of the following information:

The ReturnDetail container consists of the following information:



Input

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

<?xml version="1.0" encoding="utf-8"?>
<getReturnDetailRequest xmlns="http://www.ebay.com/marketplace/returns/v1/services">
  <!-- Call-specific Input Fields -->
  <ReturnId> ReturnIdType
    <id> string </id>
  </ReturnId>
</getReturnDetailRequest>
Argument Type Occurrence Meaning
ReturnId ReturnIdType Required Container consisting of the unique identifier for a return case. A ReturnId value is the only input parameter for getReturnDetail, and is required. ReturnId values are returned in the ReturnId.id field of each ReturnSummary container returned in the getUserReturns response.
ReturnId.id string Required This string value is the unique identifier for a return case, and is returned in the responses of getUserReturns and getReturnDetail. For getReturnDetail, a ReturnId is a required input field.
Max length: 38.



Output

The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

<?xml version="1.0" encoding="utf-8"?>
<getReturnDetailResponse xmlns="http://www.ebay.com/marketplace/returns/v1/services">
  <!-- Call-specific Output Fields -->
  <ReturnDetail> ReturnDetailType
    <buyerReturnShipment> ShipmentType
      <carrierUsed> string </carrierUsed>
      <deliveryDate> dateTime </deliveryDate>
      <maxEstDeliveryDate> dateTime </maxEstDeliveryDate>
      <minEstDeliveryDate> dateTime </minEstDeliveryDate>
      <returnMerchandiseAuthorization> string </returnMerchandiseAuthorization>
      <shipmentStatus> ShipmentStatusType </shipmentStatus>
      <shippingAddress> Address
        <city> string </city>
        <country> string </country>
        <county> string </county>
        <name> string </name>
        <postalCode> string </postalCode>
        <stateOrProvince> string </stateOrProvince>
        <street1> string </street1>
        <street2> string </street2>
      </shippingAddress>
      <shippingCost> Amount (double) </shippingCost>
      <trackingNumber> string </trackingNumber>
    </buyerReturnShipment>
    <caseId> CaseIdType
      <id> string </id>
      <type> CaseType </type>
    </caseId>
    <globalId> token </globalId>
    <refundInfo> RefundInfoType
      <actualRefundDetail> ActualRefundDetailType
        <actualRefund> RefundDetailType
          <itemizedRefund> ItemizedRefundDetailType
            <amount> Amount (double) </amount>
            <refundFeeType> RefundFeeType </refundFeeType>
          </itemizedRefund>
          <!-- ... more itemizedRefund nodes allowed here ... -->
          <totalAmount> Amount (double) </totalAmount>
        </actualRefund>
        <refundDate> dateTime </refundDate>
        <refundStatus> RefundStatusType </refundStatus>
      </actualRefundDetail>
      <estimatedRefundDetail> EstimatedRefundDetailType
        <estimatedRefund> RefundDetailType
          <itemizedRefund> ItemizedRefundDetailType
            <amount> Amount (double) </amount>
            <refundFeeType> RefundFeeType </refundFeeType>
          </itemizedRefund>
          <!-- ... more itemizedRefund nodes allowed here ... -->
          <totalAmount> Amount (double) </totalAmount>
        </estimatedRefund>
        <itemizedOptionalRefund> ItemizedRefundDetailType
          <amount> Amount (double) </amount>
          <refundFeeType> RefundFeeType </refundFeeType>
        </itemizedOptionalRefund>
        <!-- ... more itemizedOptionalRefund nodes allowed here ... -->
      </estimatedRefundDetail>
      <refundDue> dateTime </refundDue>
    </refundInfo>
    <returnHistory> ReturnResponseHistoryType
      <activityDetail> ActivityDetailType (EnumerationDetailType)
        <code> token </code>
        <content> token </content>
        <description> token </description>
      </activityDetail>
      <author> ReturnUserType
        <role> ReturnUserRoleType </role>
        <userId> string </userId>
      </author>
      <creationDate> dateTime </creationDate>
      <note> string </note>
    </returnHistory>
    <!-- ... more returnHistory nodes allowed here ... -->
    <returnPolicy> ReturnPolicyInfoType
      <optedForMultipleReturnAddress> boolean </optedForMultipleReturnAddress>
      <optedForRMA> boolean </optedForRMA>
    </returnPolicy>
    <shipmentInfo> ShipmentType
      <carrierUsed> string </carrierUsed>
      <deliveryDate> dateTime </deliveryDate>
      <maxEstDeliveryDate> dateTime </maxEstDeliveryDate>
      <minEstDeliveryDate> dateTime </minEstDeliveryDate>
      <returnMerchandiseAuthorization> string </returnMerchandiseAuthorization>
      <shipmentStatus> ShipmentStatusType </shipmentStatus>
      <shippingAddress> Address
        <city> string </city>
        <country> string </country>
        <county> string </county>
        <name> string </name>
        <postalCode> string </postalCode>
        <stateOrProvince> string </stateOrProvince>
        <street1> string </street1>
        <street2> string </street2>
      </shippingAddress>
      <shippingCost> Amount (double) </shippingCost>
      <trackingNumber> string </trackingNumber>
    </shipmentInfo>
    <!-- ... more shipmentInfo nodes allowed here ... -->
  </ReturnDetail>
  <ReturnSummary> ReturnSummaryType
    <creationDate> dateTime </creationDate>
    <lastModifiedDate> dateTime </lastModifiedDate>
    <otherParty> ReturnUserType
      <role> ReturnUserRoleType </role>
      <userId> string </userId>
    </otherParty>
    <responseDue> ReturnResponseDueType
      <party> ReturnUserType
        <role> ReturnUserRoleType </role>
        <userId> string </userId>
      </party>
      <respondByDate> dateTime </respondByDate>
    </responseDue>
    <ReturnId> ReturnIdType
      <id> string </id>
    </ReturnId>
    <returnRequest> ReturnRequestType
      <comments> string </comments>
      <returnItem> ReturnItemType
        <itemId> string </itemId>
        <returnQuantity> int </returnQuantity>
        <transactionId> string </transactionId>
      </returnItem>
      <!-- ... more returnItem nodes allowed here ... -->
      <returnReason> ReturnReasonType (EnumerationDetailType)
        <code> token </code>
        <content> token </content>
        <description> token </description>
      </returnReason>
    </returnRequest>
    <ReturnType> ReturnType </ReturnType>
    <status> ReturnStatusType </status>
  </ReturnSummary>
  <!-- Standard Output Fields -->
  <ack> AckValue </ack>
  <errorMessage> ErrorMessage
    <error> ErrorData
      <category> ErrorCategory </category>
      <domain> string </domain>
      <errorId> long </errorId>
      <exceptionId> token </exceptionId>
      <message> string </message>
      <parameter name="string"> ErrorParameter (string) </parameter>
      <!-- ... more parameter nodes allowed here ... -->
      <severity> ErrorSeverity </severity>
      <subdomain> string </subdomain>
    </error>
    <!-- ... more error nodes allowed here ... -->
  </errorMessage>
  <timestamp> dateTime </timestamp>
  <version> string </version>
</getReturnDetailResponse>
Return Value Type Occurrence Meaning
Call-specific Output Fields [Jump to standard fields]
ReturnDetail ReturnDetailType Always Container consisting of detailed, dynamic information for the return case matching the ReturnId specified in the request. This information includes the return case status, return case activity log, returned item status, return shipping information (including an RMA if applicable), refund details, and eBay Buyer Protection case information (if applicable).
ReturnDetail
  .buyerReturnShipment
ShipmentType Conditionally DEPRECATED. Please use the element shipmentInfo to obtain both seller and buyer shipping information. This container consists of details related to the buyer's return shipment to the seller. Information in the buyerReturnShipment container include the seller's shipping address on record, expected delivery date, shipping carrier used, tracking number and the delivery status.
ReturnDetail
  .buyerReturnShipment
  .carrierUsed
string Conditionally This value is the name of the shipping carrier.
ReturnDetail
  .buyerReturnShipment
  .deliveryDate
dateTime Conditionally This value indicates the actual date of delivery for the returned item. This field is only returned after the seller has received the returned item from the buyer.
ReturnDetail
  .buyerReturnShipment
  .maxEstDeliveryDate
dateTime Conditionally This date is the latest date that the seller can expect to receive a returned item from the buyer.
ReturnDetail
  .buyerReturnShipment
  .minEstDeliveryDate
dateTime Conditionally This date is the earliest date that the seller can expect to receive a returned item from the buyer.
ReturnDetail
  .buyerReturnShipment
  .returnMerchandiseAuthorization
string Conditionally This value is the Return Merchandize Authorization (RMA) number associated with the item. The RMA number for an item is expected to be provided by the seller to the buyer upon request. This field is only returned if the buyer requests an RMA number and it is provided by the seller.
ReturnDetail
  .buyerReturnShipment
  .shipmentStatus
ShipmentStatusType Conditionally This value indicates the current shipping status of the item.

Applicable values:

ITEM_DELIVERED
This value indicates that the returned item has been received by the seller.
ITEM_SHIPPED
This value indicates that the item has been shipped by the buyer.
OTHER
This value is reserved for future use.
READY_FOR_SHIPPING
This value indicates that the item is ready to be shipped by the buyer.
WAITING_FOR_SELLER_INFO
This value indicates that the buyer is waiting for an Return Merchandise Authorization (RMA) number before returning the item to seller. A seller can provide a buyer with an RMA by using the provideSellerInfo call.

ReturnDetail
  .buyerReturnShipment
  .shippingAddress
Address Conditionally This container consists of the seller's shipping address.
ReturnDetail
  .buyerReturnShipment
  .shippingAddress.city
string Conditionally The city on record for the seller's shipping address. If a seller is updating a shipping address using the provideSellerInfo call, this field is required.
ReturnDetail
  .buyerReturnShipment
  .shippingAddress.country
string Conditionally The country on record for the seller's shipping address. If a seller is updating a shipping address using the provideSellerInfo call, this field is required.
ReturnDetail
  .buyerReturnShipment
  .shippingAddress.county
string Conditionally The county on record for the seller's shipping address. This field is not always used, but it should be provided (if applicable) if a seller is updating a shipping address using the provideSellerInfo call.
ReturnDetail
  .buyerReturnShipment
  .shippingAddress.name
string Conditionally The name on record for the seller's shipping address.
ReturnDetail
  .buyerReturnShipment
  .shippingAddress.postalCode
string Conditionally The postal code on record for the seller's shipping address. If a seller is updating a shipping address using the provideSellerInfo call, this field is required.
ReturnDetail
  .buyerReturnShipment
  .shippingAddress
  .stateOrProvince
string Conditionally The state or province on record for the seller's shipping address. If a seller is updating a shipping address using the provideSellerInfo call, this field is required.
ReturnDetail
  .buyerReturnShipment
  .shippingAddress.street1
string Conditionally The street address on record for the seller's shipping address. If a seller is updating a shipping address using the provideSellerInfo call, this field is required.
ReturnDetail
  .buyerReturnShipment
  .shippingAddress.street2
string Conditionally The second line of the street address on record for the seller's shipping address. This field is not always used, but it should be provided (if applicable) if a seller is updating a shipping address using the provideSellerInfo call.
ReturnDetail
  .buyerReturnShipment
  .shippingCost
Amount (double) Conditionally This dollar value indicates the total shipping costs incurred by the buyer to ship the returned item.
ReturnDetail
  .buyerReturnShipment
  .trackingNumber
string Conditionally This value is the tracking number used by the shipping carrier.
ReturnDetail.caseId CaseIdType Conditionally Container consisting of the eBay Buyer Protection case ID and case type. This container is only returned if a return case is escalated to the eBay Buyer Protection system and accepted as an eBP case.
ReturnDetail.caseId.id string Conditionally Unique identifier of an eBay Buyer Protection case.
Max length: 38.
ReturnDetail.caseId.type CaseType Conditionally This value indicates the type of eBay Buyer Protection case. For an escalated return case, the value will most likely be EBP_SNAD (item Significantly Not As Described).

Applicable values:

EBP_SNAD
This value indicates that the eBay Buyer Protection case involves a "significantly not as described" item.
OTHER
This value is reserved for future use.

ReturnDetail.globalId token Always Unique identifier of the eBay site (such as EBAY-US) where the return case was filed.
ReturnDetail.refundInfo RefundInfoType Always Container consisting of details and values related to estimated, actual, and itemized refunds to the buyer.
ReturnDetail.refundInfo
  .actualRefundDetail
ActualRefundDetailType Conditionally Container consisting of the actual amount of a seller's refund to the buyer. The actualRefundDetail container will contain one itemizedRefund container for each refund fee type issued to the buyer (such as purchase price or original shipping). Similarly, one itemizedOptionalRefund container will be present for each optional refund fee type that a seller can issue to a buyer (such as return shipping or restocking fee).
ReturnDetail.refundInfo
  .actualRefundDetail
  .actualRefund
RefundDetailType Conditionally Container consisting of the total refund amount awarded to the buyer and one or more itemizedRefund containers. One itemizedRefund container will be present for each refund fee type (such as purchase price or original shipping). This container is only returned if a refund has been issued by the seller.
ReturnDetail.refundInfo
  .actualRefundDetail
  .actualRefund.itemizedRefund
ItemizedRefundDetailType Always,
repeatable: [1..*]
Container used to track estimated and actual individual refund amounts by fee type (such as purchase price, original shipping, return shipping, or restocking fee). At least one itemizedRefund container is required when the seller is issuing a refund to the buyer through the issueRefund call.
ReturnDetail.refundInfo
  .actualRefundDetail
  .actualRefund.itemizedRefund
  .amount
Amount (double) Conditionally This dollar amount indicates the amount of the corresponding refund fee type.
ReturnDetail.refundInfo
  .actualRefundDetail
  .actualRefund.itemizedRefund
  .refundFeeType
RefundFeeType Conditionally This value indicates the type of refund fee, such as purchase price or original shipping.

Applicable values:

ORIGINAL_SHIPPING
This value indicates that the refund to the buyer is for the original shipping costs of the item, or items (for multiple quantity purchases).
OTHER
This value is reserved for future use.
PURCHASE_PRICE
This value indicates that the refund to the buyer is for the purchase price of the item, or items (for multiple quantity purchases).
RESTOCKING_FEE
This value indicates that the refund to the buyer is for the restocking fee that was charged to the buyer to restock the item, or items (for multiple quantity purchases).

ReturnDetail.refundInfo
  .actualRefundDetail
  .actualRefund.totalAmount
Amount (double) Conditionally This dollar value indicates the total amount of actual refunds issued by the seller to the buyer. This is a dynamic value while the return case is open. The refundDetail.totalAmount value is required in the issueRefund call and it should match the refundDetail.itemizedRefundAmount value (if only one refund type is being issued by the seller) or the composite value of multiple refundDetail.itemizedRefundAmount values (if multiple refund types are being issued by the seller).
ReturnDetail.refundInfo
  .actualRefundDetail.refundDate
dateTime Conditionally This date indicates the date of the seller's refund to the buyer. This field is only returned if a refund has been issued by the seller.
ReturnDetail.refundInfo
  .actualRefundDetail
  .refundStatus
RefundStatusType Conditionally This value indicates the result of the seller's refund attempt. The two valid values are SUCCESS or FAILED. PENDING is for future use.

Applicable values:

FAILED
This value indicates that the seller's refund to the buyer failed.
PENDING
This value indicates that the seller's refund to the buyer is pending.
SUCCESS
This value indicates that the seller's refund to the buyer was successful.

ReturnDetail.refundInfo
  .estimatedRefundDetail
EstimatedRefundDetailType Always Container consisting of the estimated amount of a seller's refund to the buyer. The estimatedRefundDetail container will contain one itemizedRefund container for each refund fee type due to the buyer (such as purchase price or original shipping). Similarly, if the seller elects to issue additional refund(s) beyond what is required, one itemizedOptionalRefund container will be present for each optional refund issued to the buyer (such as return shipping or restocking fee).
ReturnDetail.refundInfo
  .estimatedRefundDetail
  .estimatedRefund
RefundDetailType Always Container consisting of the total estimated refund amount due to the buyer and one or more itemizedRefund containers. One itemizedRefund container will be present for each refund fee type (such as purchase price or original shipping).
ReturnDetail.refundInfo
  .estimatedRefundDetail
  .estimatedRefund
  .itemizedRefund
ItemizedRefundDetailType Always,
repeatable: [1..*]
Container used to track estimated and actual individual refund amounts by fee type (such as purchase price, original shipping, return shipping, or restocking fee). At least one itemizedRefund container is required when the seller is issuing a refund to the buyer through the issueRefund call.
ReturnDetail.refundInfo
  .estimatedRefundDetail
  .estimatedRefund
  .itemizedRefund.amount
Amount (double) Conditionally This dollar amount indicates the amount of the corresponding refund fee type.
ReturnDetail.refundInfo
  .estimatedRefundDetail
  .estimatedRefund
  .itemizedRefund.refundFeeType
RefundFeeType Conditionally This value indicates the type of refund fee, such as purchase price or original shipping.

Applicable values:

ORIGINAL_SHIPPING
This value indicates that the refund to the buyer is for the original shipping costs of the item, or items (for multiple quantity purchases).
OTHER
This value is reserved for future use.
PURCHASE_PRICE
This value indicates that the refund to the buyer is for the purchase price of the item, or items (for multiple quantity purchases).
RESTOCKING_FEE
This value indicates that the refund to the buyer is for the restocking fee that was charged to the buyer to restock the item, or items (for multiple quantity purchases).

ReturnDetail.refundInfo
  .estimatedRefundDetail
  .estimatedRefund.totalAmount
Amount (double) Conditionally This dollar value indicates the total amount of actual refunds issued by the seller to the buyer. This is a dynamic value while the return case is open. The refundDetail.totalAmount value is required in the issueRefund call and it should match the refundDetail.itemizedRefundAmount value (if only one refund type is being issued by the seller) or the composite value of multiple refundDetail.itemizedRefundAmount values (if multiple refund types are being issued by the seller).
ReturnDetail.refundInfo
  .estimatedRefundDetail
  .itemizedOptionalRefund
ItemizedRefundDetailType Conditionally,
repeatable: [0..*]
One itemizedOptionalRefund container will be present for each optional refund fee type that a seller can issue to a buyer (such as return shipping or restocking fee).
ReturnDetail.refundInfo
  .estimatedRefundDetail
  .itemizedOptionalRefund.amount
Amount (double) Conditionally This dollar amount indicates the amount of the corresponding refund fee type.
ReturnDetail.refundInfo
  .estimatedRefundDetail
  .itemizedOptionalRefund
  .refundFeeType
RefundFeeType Conditionally This value indicates the type of refund fee, such as purchase price or original shipping.

Applicable values:

ORIGINAL_SHIPPING
This value indicates that the refund to the buyer is for the original shipping costs of the item, or items (for multiple quantity purchases).
OTHER
This value is reserved for future use.
PURCHASE_PRICE
This value indicates that the refund to the buyer is for the purchase price of the item, or items (for multiple quantity purchases).
RESTOCKING_FEE
This value indicates that the refund to the buyer is for the restocking fee that was charged to the buyer to restock the item, or items (for multiple quantity purchases).

ReturnDetail.refundInfo
  .refundDue
dateTime Conditionally This field indicates the refund due date, and will only appear if a refund to the buyer has not been issued by the seller.
ReturnDetail.returnHistory ReturnResponseHistoryType Always,
repeatable: [1..*]
Repeatable container consisting of details related to each activity in a return case. A returnHistory node is returned for each activity that has occurred with the return case, and each node contains the type of activity, the timestamp for the activity, the initiator of the activity, and any notes related to the case. Additionally, if the activity is related to a money movement transaction, a ReturnDetail.returnHistory.attributes container is returned providing more information on the transaction.
ReturnDetail.returnHistory
  .activityDetail
ActivityDetailType (EnumerationDetailType) Conditionally This container consists of the enumeration ID value and description of the case activity. Note that the content element of this container is reserved for future use.
ReturnDetail.returnHistory
  .activityDetail.code
token Always Unique identifier of the enumeration value.
ReturnDetail.returnHistory
  .activityDetail.content
token Always Reserved for future use.
ReturnDetail.returnHistory
  .activityDetail.description
token Always A description of the enumeration value.
ReturnDetail.returnHistory
  .author
ReturnUserType Always Container that identifies the initiator of the action by eBay user ID and role in the return case.
ReturnDetail.returnHistory
  .author.role
ReturnUserRoleType Always The role (such as buyer or seller) of the party involved in the return case.

Applicable values:

BUYER
This value indicates that the user's role in the return case is buyer.
EBAY
This value indicates that the user's role in the return case is eBay.
OTHER
This value is reserved for future use.
SELLER
This value indicates that the user's role in the return case is seller.
SYSTEM
This value indicates that the user's role in the return case is system.

ReturnDetail.returnHistory
  .author.userId
string Always The eBay user ID for the party involved in the return case.
ReturnDetail.returnHistory
  .creationDate
dateTime Always The timestamp of the return case activity.
ReturnDetail.returnHistory
  .note
string Conditionally This field is returned if the party initiating the action included a note. The text in this field will mirror any text input into the text box in the Return Management Center.
ReturnDetail.returnPolicy ReturnPolicyInfoType Conditionally Container consisting of details and values related to estimated, actual, and itemized refunds to the buyer.
ReturnDetail.returnPolicy
  .optedForMultipleReturnAddress
boolean Conditionally This field indicates that seller specified that returns can be accepted at multiple return addresses. Return address will be defaulted to default return address in MyEbay. Seller will have chance to change the return address after return creation when the status is WAITING_FOR_SELLER_INFO.
ReturnDetail.returnPolicy
  .optedForRMA
boolean Conditionally This field indicates that RMA information will be provided by the seller. Seller will have chance to provide RMA after return creation when the status is WAITING_FOR_SELLER_INFO.
ReturnDetail.shipmentInfo ShipmentType Conditionally,
repeatable: [0..*]
Container consisting of details related to the buyer and/or seller shipments. Information in the shipmentInfo container include destination shipping address on record, expected delivery date, shipping carrier used, tracking number and the delivery status.
ReturnDetail.shipmentInfo
  .carrierUsed
string Conditionally This value is the name of the shipping carrier.
ReturnDetail.shipmentInfo
  .deliveryDate
dateTime Conditionally This value indicates the actual date of delivery for the returned item. This field is only returned after the seller has received the returned item from the buyer.
ReturnDetail.shipmentInfo
  .maxEstDeliveryDate
dateTime Conditionally This date is the latest date that the seller can expect to receive a returned item from the buyer.
ReturnDetail.shipmentInfo
  .minEstDeliveryDate
dateTime Conditionally This date is the earliest date that the seller can expect to receive a returned item from the buyer.
ReturnDetail.shipmentInfo
  .returnMerchandiseAuthorization
string Conditionally This value is the Return Merchandize Authorization (RMA) number associated with the item. The RMA number for an item is expected to be provided by the seller to the buyer upon request. This field is only returned if the buyer requests an RMA number and it is provided by the seller.
ReturnDetail.shipmentInfo
  .shipmentStatus
ShipmentStatusType Conditionally This value indicates the current shipping status of the item.

Applicable values:

ITEM_DELIVERED
This value indicates that the returned item has been received by the seller.
ITEM_SHIPPED
This value indicates that the item has been shipped by the buyer.
OTHER
This value is reserved for future use.
READY_FOR_SHIPPING
This value indicates that the item is ready to be shipped by the buyer.
WAITING_FOR_SELLER_INFO
This value indicates that the buyer is waiting for an Return Merchandise Authorization (RMA) number before returning the item to seller. A seller can provide a buyer with an RMA by using the provideSellerInfo call.

ReturnDetail.shipmentInfo
  .shippingAddress
Address Conditionally This container consists of the seller's shipping address.
ReturnDetail.shipmentInfo
  .shippingAddress.city
string Conditionally The city on record for the seller's shipping address. If a seller is updating a shipping address using the provideSellerInfo call, this field is required.
ReturnDetail.shipmentInfo
  .shippingAddress.country
string Conditionally The country on record for the seller's shipping address. If a seller is updating a shipping address using the provideSellerInfo call, this field is required.
ReturnDetail.shipmentInfo
  .shippingAddress.county
string Conditionally The county on record for the seller's shipping address. This field is not always used, but it should be provided (if applicable) if a seller is updating a shipping address using the provideSellerInfo call.
ReturnDetail.shipmentInfo
  .shippingAddress.name
string Conditionally The name on record for the seller's shipping address.
ReturnDetail.shipmentInfo
  .shippingAddress.postalCode
string Conditionally The postal code on record for the seller's shipping address. If a seller is updating a shipping address using the provideSellerInfo call, this field is required.
ReturnDetail.shipmentInfo
  .shippingAddress
  .stateOrProvince
string Conditionally The state or province on record for the seller's shipping address. If a seller is updating a shipping address using the provideSellerInfo call, this field is required.
ReturnDetail.shipmentInfo
  .shippingAddress.street1
string Conditionally The street address on record for the seller's shipping address. If a seller is updating a shipping address using the provideSellerInfo call, this field is required.
ReturnDetail.shipmentInfo
  .shippingAddress.street2
string Conditionally The second line of the street address on record for the seller's shipping address. This field is not always used, but it should be provided (if applicable) if a seller is updating a shipping address using the provideSellerInfo call.
ReturnDetail.shipmentInfo
  .shippingCost
Amount (double) Conditionally This dollar value indicates the total shipping costs incurred by the buyer to ship the returned item.
ReturnDetail.shipmentInfo
  .trackingNumber
string Conditionally This value is the tracking number used by the shipping carrier.
ReturnSummary ReturnSummaryType Always Container consisting of high-level information for the return case matching the RefundId specified in the request. This information includes the creation and modification dates for the return case, the estimated refund amount, the reason for the return, item information, response date, and the current status of the return case.
ReturnSummary.creationDate dateTime Always This date indicates the date on which the return case was created.
ReturnSummary.lastModifiedDate dateTime Always This date indicates the date on which the return case was last modified.
ReturnSummary.otherParty ReturnUserType Always Container that identifies the other party involved in the return case. The party is identified by eBay user ID and role (BUYER or SELLER).
ReturnSummary.otherParty.role ReturnUserRoleType Always The role (such as buyer or seller) of the party involved in the return case.

Applicable values:

BUYER
This value indicates that the user's role in the return case is buyer.
EBAY
This value indicates that the user's role in the return case is eBay.
OTHER
This value is reserved for future use.
SELLER
This value indicates that the user's role in the return case is seller.
SYSTEM
This value indicates that the user's role in the return case is system.

ReturnSummary.otherParty
  .userId
string Always The eBay user ID for the party involved in the return case.
ReturnSummary.responseDue ReturnResponseDueType Conditionally This container consists of the party whose response is due and the due date of that response. This container is only returned in the requests of the getUserReturns and getReturnDetail calls if a response is due from the seller or other party involved in the return case.
ReturnSummary.responseDue
  .party
ReturnUserType Conditionally Container that identifies the party whose response is due. The party is identified by eBay user ID and role (BUYER or SELLER).
ReturnSummary.responseDue
  .party.role
ReturnUserRoleType Always The role (such as buyer or seller) of the party involved in the return case.

Applicable values:

BUYER
This value indicates that the user's role in the return case is buyer.
EBAY
This value indicates that the user's role in the return case is eBay.
OTHER
This value is reserved for future use.
SELLER
This value indicates that the user's role in the return case is seller.
SYSTEM
This value indicates that the user's role in the return case is system.

ReturnSummary.responseDue
  .party.userId
string Always The eBay user ID for the party involved in the return case.
ReturnSummary.responseDue
  .respondByDate
dateTime Conditionally This date indicates the due date of the party's response.
ReturnSummary.ReturnId ReturnIdType Always Container consisting of the unique identifier for a return case. ReturnId values are returned in the ReturnId.id field of each ReturnSummary container returned in the getUserReturns and getReturnDetail calls.
ReturnSummary.ReturnId.id string Always This string value is the unique identifier for a return case, and is returned in the responses of getUserReturns and getReturnDetail. For getReturnDetail, a ReturnId is a required input field.
Max length: 38.
ReturnSummary.returnRequest ReturnRequestType Always Container consisting of details on the item being returned and the return reason.
ReturnSummary.returnRequest
  .comments
string Conditionally This field contains any comments posted by the buyer upon opening the return case. For a SNAD case, the buyer might state the discrepancies between the actual item received and the item described in the listing.
ReturnSummary.returnRequest
  .returnItem
ReturnItemType Always,
repeatable: [1..*]
Container consisting of the eBay item ID, the transaction ID, and quantity of the item being returned to the seller. The returnItem container is returned in the getUserReturns and getReturnDetail calls.
ReturnSummary.returnRequest
  .returnItem.itemId
string Always The unique identifier for an eBay item listing.
Max length: 19.
ReturnSummary.returnRequest
  .returnItem.returnQuantity
int Always This value indicates the quantity of items to be returned. This value is usually '1' unless multiple identical items were purchased by the buyer.
Min: 1.
ReturnSummary.returnRequest
  .returnItem.transactionId
string Always The unique identifier for an eBay order line item.
ReturnSummary.returnRequest
  .returnReason
ReturnReasonType (EnumerationDetailType) Always This value indicates the buyer's reason for returning an item. Possible values include I_DONT_WANT_IT (buyer remorse) and SNAD (item Significantly Not As Described).
ReturnSummary.returnRequest
  .returnReason.code
token Always Unique identifier of the enumeration value.
ReturnSummary.returnRequest
  .returnReason.content
token Always Reserved for future use.
ReturnSummary.returnRequest
  .returnReason.description
token Always A description of the enumeration value.
ReturnSummary.ReturnType ReturnType Always This field indicates what type of return it is.

Applicable values:

MONEY_BACK
The buyer is returning the item for a refund.
REPLACEMENT
The buyer is requesting a replacement item to be ship.
UNKNOWN
This enumeration is returned if client is running an older version after new enumeration types are introduced.

ReturnSummary.status ReturnStatusType Always This field indicates the current status of the return case. This value will often give the seller a good idea about the next step to take in the return case.

Applicable values: See status.
Standard Output Fields  
ack AckValue Always

Applicable values:

Failure
eBay encountered a fatal error during the processing of the request, causing the request to fail. When a serious application-level error occurs, the error is returned instead of the business data.
PartialFailure
eBay successfully processed the request, but one or more non-fatal errors occurred during the processing. Inspect the message details and resolve any problems before resubmitting the request.
Success
eBay successfully processed the request and the business data is returned in the response. Note that it is possible for a response to return Success, but still not contain the expected data in the result.
Warning
The request that triggered the error was processed successfully but with one or more warnings.

errorMessage ErrorMessage Conditionally Information for an error or warning that occurred when eBay processed the request. This field is not returned if the ack value is Success.
errorMessage.error ErrorData Conditionally,
repeatable: [0..*]
Details about a single error.
errorMessage.error.category ErrorCategory Conditionally There are three categories of errors: request errors, application errors, and system errors.

Applicable values:

Application
An error occurred due to a problem with the request, with the most likely source being the application sending the request. For example, the request is missing a required data element or it contains an invalid field. The problem must be corrected before the request can be resent. Inspect the error message to find the cause of the problem. If the problem is due to an application error, modify the application and resend the request. If the error is due to invalid data, the source of the data must be corrected before you resend the resend request to eBay.
Request
An error occurred due to a problem with the request, with the most likely source being missing or invalid data in the request. The problem must be corrected before the request can be retried. Inspect the error message to find the cause of the problem. If the problem is a result of end-user data, alert the end-user to the problem and provide the means for them to correct the problem. Once the problem is resolved, resend the request to eBay.
System
Indicates that an error has occurred on the eBay system side. For example, a database or server could be down. Inspect the error message to find the cause of the problem. If the problem is on the eBay side, an application can retry the request a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.

errorMessage.error.domain string Conditionally Name of the domain in which the error occurred.
errorMessage.error.errorId long Conditionally A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.
errorMessage.error.exceptionId token Conditionally Unique identifier for an exception associated with an error.
errorMessage.error.message string Conditionally A detailed description of the condition that caused the error.
errorMessage.error.parameter ErrorParameter (string) Conditionally,
repeatable: [0..*]
Various warning and error messages return one or more variables that contain contextual information about the error. This is often the field or value that triggered the error.
errorMessage.error.parameter
  [ attribute name ]
string Conditionally Various warning and error messages return one or more variables that contain contextual information about the error. This is often the field or value that triggered the error.
errorMessage.error.severity ErrorSeverity Conditionally Indicates whether the reported problem is fatal (an error) or is less- severe (a warning). Review the error message details for information on the cause.

If the request fails and the application is the source of the error (for example, a required element is missing), update the application before you retry the request. If the problem is due to incorrect user data, alert the end-user to the problem and provide the means for them to correct the data. Once the problem in the application or data is resolved, re-send the request to eBay.

If the source of the problem is on eBay's side, you can retry the request a reasonable number of times (eBay recommends you try the request twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, you can resend the request in its original form.

If a warning occurs, warning information is returned in addition to the business data. Normally, you do not need to resend the request (as the original request was successful). However, depending on the cause of the warning, you might need to contact the end user, or eBay, to effect a long term solution to the problem.

Applicable values:

Error
eBay encountered a fatal error during the processing of the request, causing the request to fail. When eBay encounters an error, it returns error data instead of the requested business data. Inspect the error details and resolve the problem before resubmitting the request.
Warning
The request was successfully processed, but eBay encountered a non-fatal error during the processing that could affect the data returned. For example, eBay might have changed the value of an input field. In this Return, eBay returns a successful response, but it also returns a warning. For best results, requests should return without warnings. Inspect the warning details and resolve the problem before resubmitting the request.

errorMessage.error.subdomain string Conditionally Name of the subdomain in which the error occurred.
timestamp dateTime Always This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone.
version string Always The version of the response payload schema. Indicates the version of the schema that eBay used to process the request.



Samples

Code samples not yet added for this call's documentation.



Change History

Change Date Description
1.1.0
2014-01-14
  • ReturnDetail.shipmentInfo (added): The shipmentInfo container consists of detailed information for a buyer's return shipment or a seller's replacement item shipment. This container has replaced buyerReturnShipment.
  • ReturnDetail.buyerReturnShipment (deprecated): buyerReturnShipment has been replaced by shipmentInfo.
  • ReturnSummary.ReturnType (added): Indicates the return type as a refund ('Money_Back') or as a replacement item.
1.0.0
2012-04-23
  • (added) New call.