Get Return Estimate

POST /post-order/v2/return/estimate

Buyer-facing call to retrieve the estimated refund amount and return shipping costs associated with returning an item. This call can be used regardless of whether or not a return request was actually filed against the item.

Input

Resource URI (production)

POST https://api.ebay.com/post-order/v2/return/estimate

This call has no path or query parameters.

HTTP request headers

All requests made to eBay REST operations require you to provide the authorization HTTP header for authentication.
See HTTP request headers for details.

Authorization

This call uses standard authorization tokens. See Making a Call for details.

Payload model

The following lists all fields that could be included in the request.

{ /* GetEstimateRequest */
"itemId": string,
"reason": token,
"returnQuantity": integer,
"transactionId": string
}

Request field descriptions

Input Container/Field	Type	Occurrence	Meaning
itemId	string	Required	The unique identifier for 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.
reason	token	Optional	This enumeration value indicates the reason why the buyer is returning the item. See the ReturnReasonEnum type for valid values that may be passed into this field. Applicable values: See ReturnReasonEnum
returnQuantity	integer	Optional	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 must be provided to get accurate estimates in the response.
transactionId	string	Required	The unique identifier for the purchase of the 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.

Output

Payload model

Note: For information about the error fields and how to work with them, see Error Handling.

The following lists all fields that could be included in the response.

Supported response formats: application/json, application/xml

For more information:
- See GetEstimateResponse for a description of the response structure
- See the following table for descriptions of each of the data elements returned
- See the Samples for an example of the response format

{ /* GetEstimateResponse */
"refundInfo":
    { /* EstimatedRefundInfoType */
    "buyerTotalAmount":
        { /* Amount */
        "convertedFromCurrency": string,
        "convertedFromValue": number,
        "currency": string,
        "exchangeRate": string,
        "value": number
        },
    "estimatedRefundDetail":
        { /* EstimatedRefundDetailType */
        "itemizedRefundDetails": [
            { /* EstimatedRefundType */
            "estimatedAmount":
                { /* Amount */
                "convertedFromCurrency": string,
                "convertedFromValue": number,
                "currency": string,
                "exchangeRate": string,
                "value": number
                },
            "maxAmount":
                { /* Amount */
                "convertedFromCurrency": string,
                "convertedFromValue": number,
                "currency": string,
                "exchangeRate": string,
                "value": number
                },
            "minAmount":
                { /* Amount */
                "convertedFromCurrency": string,
                "convertedFromValue": number,
                "currency": string,
                "exchangeRate": string,
                "value": number
                },
            "purchasePriceDeductedPercentageList": [
                integer
                /* More integer nodes here */
              ],
            "refundFeeType": token,
            "restockingFeePercentage": string
            }
            /* More EstimatedRefundType nodes here */
          ],
        "optionalRefundLineItems": [
            { /* EstimatedRefundType */
            "estimatedAmount":
                { /* Amount */
                "convertedFromCurrency": string,
                "convertedFromValue": number,
                "currency": string,
                "exchangeRate": string,
                "value": number
                },
            "maxAmount":
                { /* Amount */
                "convertedFromCurrency": string,
                "convertedFromValue": number,
                "currency": string,
                "exchangeRate": string,
                "value": number
                },
            "minAmount":
                { /* Amount */
                "convertedFromCurrency": string,
                "convertedFromValue": number,
                "currency": string,
                "exchangeRate": string,
                "value": number
                },
            "purchasePriceDeductedPercentageList": [
                integer
                /* More integer nodes here */
              ],
            "refundFeeType": token,
            "restockingFeePercentage": string
            }
            /* More EstimatedRefundType nodes here */
          ]
        },
    "sellerTotalAmount":
        { /* Amount */
        "convertedFromCurrency": string,
        "convertedFromValue": number,
        "currency": string,
        "exchangeRate": string,
        "value": number
        }
    },
"returnShippingCostInfo":
    { /* EstimatedShippingInfoType */
    "carriers": [
        { /* CarrierShippingCostInfoType */
        "carrier": token,
        "shippingCost":
            { /* ReturnShippingCostDetailType */
            "itemizedReturnShippingCost": [
                { /* ItemizedReturnShippingCostType */
                "amount":
                    { /* Amount */
                    "convertedFromCurrency": string,
                    "convertedFromValue": number,
                    "currency": string,
                    "exchangeRate": string,
                    "value": number
                    },
                "returnShippingCostType": string
                }
                /* More ItemizedReturnShippingCostType nodes here */
              ],
            "totalAmount":
                { /* Amount */
                "convertedFromCurrency": string,
                "convertedFromValue": number,
                "currency": string,
                "exchangeRate": string,
                "value": number
                }
            }
        }
        /* More CarrierShippingCostInfoType nodes here */
      ],
    "returnShipmentPayer": token
    }
}

Response field descriptions

Output Container/Field	Type	Occurrence	Meaning
refundInfo	EstimatedRefundInfoType	Always	This container gives an overview of estimated refund information if the buyer creates a return request and is expecting money back.
refundInfo.buyerTotalAmount	Amount	Always	This dollar value is the estimated amount of money that the buyer will receive for the refund.
refundInfo.buyerTotalAmount .convertedFromCurrency	string	Conditionally	The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. If no conversion occurs, this should not be populated. Applicable values are from CurrencyCodeEnum:See convertedFromCurrency. Code so that your app gracefully handles any future changes to this list.
refundInfo.buyerTotalAmount .convertedFromValue	number	Conditionally	The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. If no conversion occurs, this should not be populated.
refundInfo.buyerTotalAmount .currency	string	Conditionally	A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. Default: The currency of the authenticated user's country. Applicable values are from CurrencyCodeEnum:See currency. Code so that your app gracefully handles any future changes to this list.
refundInfo.buyerTotalAmount .exchangeRate	string	Conditionally	This field shows the exchange rate used to convert the amount in the convertedFromValue field to amount in the value field. This field is only returned when eBay does a currency version.
refundInfo.buyerTotalAmount .value	number	Conditionally	The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type.
refundInfo .estimatedRefundDetail	EstimatedRefundDetailType	Always	This container shows estimated refund information for the buyer. There will be one itemizedRefundDetail container returned under this container for each refund fee type (such as purchase price and original shipping).
refundInfo .estimatedRefundDetail .itemizedRefundDetails	array of EstimatedRefundType	Conditionally	This container shows the estimated refund information before the seller issues a refund to the buyer.
refundInfo .estimatedRefundDetail .itemizedRefundDetails .estimatedAmount	Amount	Always	This dollar value is the estimated amount of the refund.
refundInfo .estimatedRefundDetail .itemizedRefundDetails .estimatedAmount .convertedFromCurrency	string	Conditionally	The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. If no conversion occurs, this should not be populated. Applicable values are from CurrencyCodeEnum:See convertedFromCurrency. Code so that your app gracefully handles any future changes to this list.
refundInfo .estimatedRefundDetail .itemizedRefundDetails .estimatedAmount .convertedFromValue	number	Conditionally	The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. If no conversion occurs, this should not be populated.
refundInfo .estimatedRefundDetail .itemizedRefundDetails .estimatedAmount.currency	string	Conditionally	A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. Default: The currency of the authenticated user's country. Applicable values are from CurrencyCodeEnum:See currency. Code so that your app gracefully handles any future changes to this list.
refundInfo .estimatedRefundDetail .itemizedRefundDetails .estimatedAmount.exchangeRate	string	Conditionally	This field shows the exchange rate used to convert the amount in the convertedFromValue field to amount in the value field. This field is only returned when eBay does a currency version.
refundInfo .estimatedRefundDetail .itemizedRefundDetails .estimatedAmount.value	number	Conditionally	The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type.
refundInfo .estimatedRefundDetail .itemizedRefundDetails .maxAmount	Amount	Always	This dollar value is the maximum amount that the refund could be based on the cost of the order.
refundInfo .estimatedRefundDetail .itemizedRefundDetails .maxAmount .convertedFromCurrency	string	Conditionally	The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. If no conversion occurs, this should not be populated. Applicable values are from CurrencyCodeEnum:See convertedFromCurrency. Code so that your app gracefully handles any future changes to this list.
refundInfo .estimatedRefundDetail .itemizedRefundDetails .maxAmount.convertedFromValue	number	Conditionally	The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. If no conversion occurs, this should not be populated.
refundInfo .estimatedRefundDetail .itemizedRefundDetails .maxAmount.currency	string	Conditionally	A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. Default: The currency of the authenticated user's country. Applicable values are from CurrencyCodeEnum:See currency. Code so that your app gracefully handles any future changes to this list.
refundInfo .estimatedRefundDetail .itemizedRefundDetails .maxAmount.exchangeRate	string	Conditionally	This field shows the exchange rate used to convert the amount in the convertedFromValue field to amount in the value field. This field is only returned when eBay does a currency version.
refundInfo .estimatedRefundDetail .itemizedRefundDetails .maxAmount.value	number	Conditionally	The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type.
refundInfo .estimatedRefundDetail .itemizedRefundDetails .minAmount	Amount	Always	This dollar value is the minimum amount that the refund could be based on the cost of the order.
refundInfo .estimatedRefundDetail .itemizedRefundDetails .minAmount .convertedFromCurrency	string	Conditionally	The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. If no conversion occurs, this should not be populated. Applicable values are from CurrencyCodeEnum:See convertedFromCurrency. Code so that your app gracefully handles any future changes to this list.
refundInfo .estimatedRefundDetail .itemizedRefundDetails .minAmount.convertedFromValue	number	Conditionally	The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. If no conversion occurs, this should not be populated.
refundInfo .estimatedRefundDetail .itemizedRefundDetails .minAmount.currency	string	Conditionally	A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. Default: The currency of the authenticated user's country. Applicable values are from CurrencyCodeEnum:See currency. Code so that your app gracefully handles any future changes to this list.
refundInfo .estimatedRefundDetail .itemizedRefundDetails .minAmount.exchangeRate	string	Conditionally	This field shows the exchange rate used to convert the amount in the convertedFromValue field to amount in the value field. This field is only returned when eBay does a currency version.
refundInfo .estimatedRefundDetail .itemizedRefundDetails .minAmount.value	number	Conditionally	The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type.
refundInfo .estimatedRefundDetail .itemizedRefundDetails .purchasePriceDeductedPercentageList	array of integer	Conditionally	This array shows one or percentage values, and these values indicate the percentage value(s) deducted off of the purchase price.
refundInfo .estimatedRefundDetail .itemizedRefundDetails .refundFeeType	token	Always	This enumerated value indicates the type of refund. When issuing a refund through the POST /post-order/v2/return/{returnId}/issue_refund call, the seller must use a separate itemizedRefundDetail container for each refund type, such as one for the purchase price, one for original shipping, and one for a restocking fee (if applicable). Applicable values: See RefundFeeTypeEnum
refundInfo .estimatedRefundDetail .itemizedRefundDetails .restockingFeePercentage	string	Conditionally	Restocking fees are no longer supported by eBay. Input values for this field are not read nor returned.
refundInfo .estimatedRefundDetail .optionalRefundLineItems	array of EstimatedRefundType	Conditionally	This container shows the optional refund information that the seller can issue to the buyer at his/her discretion. The seller is not obligated to issue this type of refund, but might do so as a matter of good customer service.
refundInfo .estimatedRefundDetail .optionalRefundLineItems .estimatedAmount	Amount	Always	This dollar value is the estimated amount of the refund.
refundInfo .estimatedRefundDetail .optionalRefundLineItems .estimatedAmount .convertedFromCurrency	string	Conditionally	The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. If no conversion occurs, this should not be populated. Applicable values are from CurrencyCodeEnum:See convertedFromCurrency. Code so that your app gracefully handles any future changes to this list.
refundInfo .estimatedRefundDetail .optionalRefundLineItems .estimatedAmount .convertedFromValue	number	Conditionally	The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. If no conversion occurs, this should not be populated.
refundInfo .estimatedRefundDetail .optionalRefundLineItems .estimatedAmount.currency	string	Conditionally	A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. Default: The currency of the authenticated user's country. Applicable values are from CurrencyCodeEnum:See currency. Code so that your app gracefully handles any future changes to this list.
refundInfo .estimatedRefundDetail .optionalRefundLineItems .estimatedAmount.exchangeRate	string	Conditionally	This field shows the exchange rate used to convert the amount in the convertedFromValue field to amount in the value field. This field is only returned when eBay does a currency version.
refundInfo .estimatedRefundDetail .optionalRefundLineItems .estimatedAmount.value	number	Conditionally	The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type.
refundInfo .estimatedRefundDetail .optionalRefundLineItems .maxAmount	Amount	Always	This dollar value is the maximum amount that the refund could be based on the cost of the order.
refundInfo .estimatedRefundDetail .optionalRefundLineItems .maxAmount .convertedFromCurrency	string	Conditionally	The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. If no conversion occurs, this should not be populated. Applicable values are from CurrencyCodeEnum:See convertedFromCurrency. Code so that your app gracefully handles any future changes to this list.
refundInfo .estimatedRefundDetail .optionalRefundLineItems .maxAmount.convertedFromValue	number	Conditionally	The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. If no conversion occurs, this should not be populated.
refundInfo .estimatedRefundDetail .optionalRefundLineItems .maxAmount.currency	string	Conditionally	A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. Default: The currency of the authenticated user's country. Applicable values are from CurrencyCodeEnum:See currency. Code so that your app gracefully handles any future changes to this list.
refundInfo .estimatedRefundDetail .optionalRefundLineItems .maxAmount.exchangeRate	string	Conditionally	This field shows the exchange rate used to convert the amount in the convertedFromValue field to amount in the value field. This field is only returned when eBay does a currency version.
refundInfo .estimatedRefundDetail .optionalRefundLineItems .maxAmount.value	number	Conditionally	The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type.
refundInfo .estimatedRefundDetail .optionalRefundLineItems .minAmount	Amount	Always	This dollar value is the minimum amount that the refund could be based on the cost of the order.
refundInfo .estimatedRefundDetail .optionalRefundLineItems .minAmount .convertedFromCurrency	string	Conditionally	The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. If no conversion occurs, this should not be populated. Applicable values are from CurrencyCodeEnum:See convertedFromCurrency. Code so that your app gracefully handles any future changes to this list.
refundInfo .estimatedRefundDetail .optionalRefundLineItems .minAmount.convertedFromValue	number	Conditionally	The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. If no conversion occurs, this should not be populated.
refundInfo .estimatedRefundDetail .optionalRefundLineItems .minAmount.currency	string	Conditionally	A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. Default: The currency of the authenticated user's country. Applicable values are from CurrencyCodeEnum:See currency. Code so that your app gracefully handles any future changes to this list.
refundInfo .estimatedRefundDetail .optionalRefundLineItems .minAmount.exchangeRate	string	Conditionally	This field shows the exchange rate used to convert the amount in the convertedFromValue field to amount in the value field. This field is only returned when eBay does a currency version.
refundInfo .estimatedRefundDetail .optionalRefundLineItems .minAmount.value	number	Conditionally	The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type.
refundInfo .estimatedRefundDetail .optionalRefundLineItems .purchasePriceDeductedPercentageList	array of integer	Conditionally	This array shows one or percentage values, and these values indicate the percentage value(s) deducted off of the purchase price.
refundInfo .estimatedRefundDetail .optionalRefundLineItems .refundFeeType	token	Always	This enumerated value indicates the type of refund. When issuing a refund through the POST /post-order/v2/return/{returnId}/issue_refund call, the seller must use a separate itemizedRefundDetail container for each refund type, such as one for the purchase price, one for original shipping, and one for a restocking fee (if applicable). Applicable values: See RefundFeeTypeEnum
refundInfo .estimatedRefundDetail .optionalRefundLineItems .restockingFeePercentage	string	Conditionally	Restocking fees are no longer supported by eBay. Input values for this field are not read nor returned.
refundInfo.sellerTotalAmount	Amount	Always	This dollar value is the estimated amount of money that the seller owes the buyer for the refund. This will generally be a negative value because it is money that the seller owes the buyer.
refundInfo.sellerTotalAmount .convertedFromCurrency	string	Conditionally	The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. If no conversion occurs, this should not be populated. Applicable values are from CurrencyCodeEnum:See convertedFromCurrency. Code so that your app gracefully handles any future changes to this list.
refundInfo.sellerTotalAmount .convertedFromValue	number	Conditionally	The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. If no conversion occurs, this should not be populated.
refundInfo.sellerTotalAmount .currency	string	Conditionally	A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. Default: The currency of the authenticated user's country. Applicable values are from CurrencyCodeEnum:See currency. Code so that your app gracefully handles any future changes to this list.
refundInfo.sellerTotalAmount .exchangeRate	string	Conditionally	This field shows the exchange rate used to convert the amount in the convertedFromValue field to amount in the value field. This field is only returned when eBay does a currency version.
refundInfo.sellerTotalAmount .value	number	Conditionally	The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type.
returnShippingCostInfo	EstimatedShippingInfoType	Always	This container gives an overview of estimated return shipping cost information if the buyer creates a return request.
returnShippingCostInfo .carriers	array of CarrierShippingCostInfoType	Conditionally	This container consists of an array of shipping carriers that can be used to return ship an item, and how much each shipping carrier will approximately cost. One or more shipping carriers will be returned if available.
returnShippingCostInfo .carriers.carrier	token	Conditionally	Indicates a shipping carrier that can 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. Applicable values: See ShippingCarrierEnum
returnShippingCostInfo .carriers.shippingCost	ReturnShippingCostDetailType	Conditionally	This container provides an estimate of itemized and total shipping costs if the buyer was to use the shipping carrier specified in the carrier field.
returnShippingCostInfo .carriers.shippingCost .itemizedReturnShippingCost	array of ItemizedReturnShippingCostType	Conditionally	This container consists of the shipping cost to return ship an item. An itemizedReturnShippingCost container is required for each shipping cost type, such as label cost, shipping insurance, or the signature confirmation service.
returnShippingCostInfo .carriers.shippingCost .itemizedReturnShippingCost .amount	Amount	Conditionally	This dollar value indicates the amount for the shipping cost type shown in the returnShippingCostType field.
returnShippingCostInfo .carriers.shippingCost .itemizedReturnShippingCost .amount.convertedFromCurrency	string	Conditionally	The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. If no conversion occurs, this should not be populated. Applicable values are from CurrencyCodeEnum:See convertedFromCurrency. Code so that your app gracefully handles any future changes to this list.
returnShippingCostInfo .carriers.shippingCost .itemizedReturnShippingCost .amount.convertedFromValue	number	Conditionally	The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. If no conversion occurs, this should not be populated.
returnShippingCostInfo .carriers.shippingCost .itemizedReturnShippingCost .amount.currency	string	Conditionally	A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. Default: The currency of the authenticated user's country. Applicable values are from CurrencyCodeEnum:See currency. Code so that your app gracefully handles any future changes to this list.
returnShippingCostInfo .carriers.shippingCost .itemizedReturnShippingCost .amount.exchangeRate	string	Conditionally	This field shows the exchange rate used to convert the amount in the convertedFromValue field to amount in the value field. This field is only returned when eBay does a currency version.
returnShippingCostInfo .carriers.shippingCost .itemizedReturnShippingCost .amount.value	number	Conditionally	The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type.
returnShippingCostInfo .carriers.shippingCost .itemizedReturnShippingCost .returnShippingCostType	string	Conditionally	This enumerated value indicates the type of shipping cost, such as the cost of the shipping label, shipping insurance, or the signature confirmation service. Applicable values are from ReturnShippingCostType: INSURANCE Indicates the shipping cost is the price of shipping insurance if it used to return ship the item back to the seller. LABEL_COST Indicates the shipping cost is the price of the shipping label to return the item to the seller. OTHER Indicates the shipping cost is not classified or is not known. SIGNATURE_CONFIRMATION_COST Indicates the shipping cost is the price to return ship the item to the seller using certified shipping. Code so that your app gracefully handles any future changes to this list.
returnShippingCostInfo .carriers.shippingCost .totalAmount	Amount	Conditionally	This value is the total amount of shipping costs associated with return shipping the item. This value should equal the sum of the values in the itemizedReturnShippingCost.amount field(s).
returnShippingCostInfo .carriers.shippingCost .totalAmount .convertedFromCurrency	string	Conditionally	The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. If no conversion occurs, this should not be populated. Applicable values are from CurrencyCodeEnum:See convertedFromCurrency. Code so that your app gracefully handles any future changes to this list.
returnShippingCostInfo .carriers.shippingCost .totalAmount .convertedFromValue	number	Conditionally	The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. If no conversion occurs, this should not be populated.
returnShippingCostInfo .carriers.shippingCost .totalAmount.currency	string	Conditionally	A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. Default: The currency of the authenticated user's country. Applicable values are from CurrencyCodeEnum:See currency. Code so that your app gracefully handles any future changes to this list.
returnShippingCostInfo .carriers.shippingCost .totalAmount.exchangeRate	string	Conditionally	This field shows the exchange rate used to convert the amount in the convertedFromValue field to amount in the value field. This field is only returned when eBay does a currency version.
returnShippingCostInfo .carriers.shippingCost .totalAmount.value	number	Conditionally	The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type.
returnShippingCostInfo .returnShipmentPayer	token	Always	Indicates the party that is responsible for return shipping cost, such as buyer, seller, or eBay. Applicable values: See ReturnUserRoleEnum

null

Samples

New to making API calls? Please see Making a Call.

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Sample: Basic Call

Returns return shipping costs and estimated refund amount.

Description

This call is used to return shipping costs and the estimated refund amount for a specified order line item. This call will work regardless of whether or not there's an open return request against the order line item.

Input

In the request payload, the user identifies the order line item with the itemId and transactionId fields, and also provides the return reason and the quantity of the line item being returned.

URL format. See also the non-wrapped version of this URL.

POST https://api.ebay.com/post-order/v2/return/estimate

{ 
"itemId": "190004540256",
"transactionId": "8154427009",
"reason": NO_LONGER_NEED_ITEM,
"returnQuantity": 1
}

Output

The returnShippingCostInfo container first indicates who is responsible for return shippping costs. For this sample, the returnShipmentPayer field indicates that the seller is responsible for return shipping costs, which total 3.00 USD.

Under the carriers container, the cost to return the line item is given for one or more shipping carriers. In this sample call, the only shipping carrier given is USPS. The total return shipping cost is given in the shippingCost.totalAmount container, and the itemized shipping costs are shown in the itemizedReturnShippingCost container. For this sample, the only return shipping cost is the cost of the shipping label; however, it is possible that other related shipping costs can be returned in the itemizedReturnShippingCost container, such as shipping insurance, or certified/signature confirmation shipping costs.

In the refundInfo container, the expected refund to the buyer is 18.00 USD, as shown in the buyerTotalAmount container. The estimatedRefundDetail container shows the itemized refund amounts. The buyer will be refunded the purchase price of 20.00 USD, but the seller will deduct 2.00 USD from this amount for a restocking fee. This accounts for the total refund amount of 18.00 USD.

JSON format.
{
	"returnShippingCostInfo": {
			"returnShipmentPayer": "SELLER",
			"carriers": [
					{
					"carrier": "USPS",
					"shippingCost": {
							"totalAmount": {
									"value": 3.0,
									"currency": "USD"
							},
							"itemizedReturnShippingCost": [
									{
									"returnShippingCostType": "LABEL_COST",
									"amount": 
											{
											"value": 3.0,
											"currency": "USD"
											}
									}
							]
					}
			}
		]
	},
	"refundInfo": {
			"buyerTotalAmount": {
					"value": 18.0,
					"currency": "USD"
			},
			"sellerTotalAmount": {
					"value": 18.0,
					"currency": "USD"
			},
			"estimatedRefundDetail": {
					"itemizedRefundDetail": [
						{
						"refundFeeType": "PURCHASE_PRICE",
						"estimatedAmount": {
								"value": 20.0,
								"currency": "USD"
								},
						},
						{
						"refundFeeType": "RESTOCKING_FEE",
						"estimatedAmount": {
								"value": -2.0,
								"currency": "USD"
								},
						"restockingFeePercentage": "10"
					}
				]
			}
		}
}

Change History

Change Date	Description
1.0 2015-06-30	Call (added): New call.