Get Return Estimate

POST /post-order/v2/return/estimate

This method is used on behalf of a buyer to retrieve the estimated refund amount and return shipping costs associated with returning an item. This method can be used regardless of whether or not a return request was actually filed against the line item.

Input

See also Samples.

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": string,
"returnQuantity": integer,
"transactionId": string
}

Request field descriptions

Output

See also Samples.

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": string,
            "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": string,
            "restockingFeePercentage": string
            }
            /* More EstimatedRefundType nodes here */
          ]
        },
    "sellerTotalAmount":
        { /* Amount */
        "convertedFromCurrency": string,
        "convertedFromValue": number,
        "currency": string,
        "exchangeRate": string,
        "value": number
        }
    },
"returnShippingCostInfo":
    { /* EstimatedShippingInfoType */
    "carriers": [
        { /* CarrierShippingCostInfoType */
        "carrier": string,
        "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": string
    }
}

Response field descriptions

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.

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": "1**********6",
"transactionId": "8********9",
"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