eBay Post-Order APIVersion 2

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

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



Input Container/Field Type Occurrence Meaning
itemId string Required The unique identifier of the listing. The itemId and transactionId values are required to identify the order line item for which return shipping costs and refund estimates will be provided.
reason string 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 are from ReturnReasonEnum:See reason.
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 of the transaction. The itemId and transactionId values are required to identify the item for which return shipping costs and refund estimates will be provided.

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,
        "value": number
        },
    "estimatedRefundDetail":
        { /* EstimatedRefundDetailType */
        "itemizedRefundDetails": [
            { /* EstimatedRefundType */
            "estimatedAmount":
                { /* Amount */
                "convertedFromCurrency": string,
                "convertedFromValue": number,
                "currency": string,
                "value": number
                },
            "maxAmount":
                { /* Amount */
                "convertedFromCurrency": string,
                "convertedFromValue": number,
                "currency": string,
                "value": number
                },
            "minAmount":
                { /* Amount */
                "convertedFromCurrency": string,
                "convertedFromValue": number,
                "currency": string,
                "value": number
                },
            "refundFeeType": string,
            "restockingFeePercentage": string
            }
            /* More EstimatedRefundType nodes here */
          ],
        "optionalRefundLineItems": [
            { /* EstimatedRefundType */
            "estimatedAmount":
                { /* Amount */
                "convertedFromCurrency": string,
                "convertedFromValue": number,
                "currency": string,
                "value": number
                },
            "maxAmount":
                { /* Amount */
                "convertedFromCurrency": string,
                "convertedFromValue": number,
                "currency": string,
                "value": number
                },
            "minAmount":
                { /* Amount */
                "convertedFromCurrency": string,
                "convertedFromValue": number,
                "currency": string,
                "value": number
                },
            "refundFeeType": string,
            "restockingFeePercentage": string
            }
            /* More EstimatedRefundType nodes here */
          ]
        },
    "sellerTotalAmount":
        { /* Amount */
        "convertedFromCurrency": string,
        "convertedFromValue": number,
        "currency": string,
        "value": number
        }
    },
"returnShippingCostInfo":
    { /* EstimatedShippingInfoType */
    "carriers": [
        { /* CarrierShippingCostInfoType */
        "carrier": token,
        "shippingCost":
            { /* ReturnShippingCostDetailType */
            "itemizedReturnShippingCost": [
                { /* ItemizedReturnShippingCostType */
                "amount":
                    { /* Amount */
                    "convertedFromCurrency": string,
                    "convertedFromValue": number,
                    "currency": string,
                    "value": number
                    },
                "returnShippingCostType": string
                }
                /* More ItemizedReturnShippingCostType nodes here */
              ],
            "totalAmount":
                { /* Amount */
                "convertedFromCurrency": string,
                "convertedFromValue": number,
                "currency": 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 This field indicates the currency involved in a monetary transaction before a price conversion was performed. Generally, this is the currency used by the buyer. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.

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 This value is the dollar amount of the currency involved in a monetary transaction before a price conversion was performed. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.
refundInfo.buyerTotalAmount
  .currency
string Conditionally This field indicates the currency involved in a monetary transaction. Generally, this is the currency used by the listing site's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
refundInfo.buyerTotalAmount
  .value
number Conditionally The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the listing site.
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 This field indicates the currency involved in a monetary transaction before a price conversion was performed. Generally, this is the currency used by the buyer. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.

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 This value is the dollar amount of the currency involved in a monetary transaction before a price conversion was performed. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.
refundInfo
  .estimatedRefundDetail
  .itemizedRefundDetails
  .estimatedAmount.currency
string Conditionally This field indicates the currency involved in a monetary transaction. Generally, this is the currency used by the listing site'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.value
number Conditionally The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the listing site.
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 This field indicates the currency involved in a monetary transaction before a price conversion was performed. Generally, this is the currency used by the buyer. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.

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 This value is the dollar amount of the currency involved in a monetary transaction before a price conversion was performed. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.
refundInfo
  .estimatedRefundDetail
  .itemizedRefundDetails
  .maxAmount.currency
string Conditionally This field indicates the currency involved in a monetary transaction. Generally, this is the currency used by the listing site'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.value
number Conditionally The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the listing site.
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 This field indicates the currency involved in a monetary transaction before a price conversion was performed. Generally, this is the currency used by the buyer. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.

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 This value is the dollar amount of the currency involved in a monetary transaction before a price conversion was performed. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.
refundInfo
  .estimatedRefundDetail
  .itemizedRefundDetails
  .minAmount.currency
string Conditionally This field indicates the currency involved in a monetary transaction. Generally, this is the currency used by the listing site'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.value
number Conditionally The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the listing site.
refundInfo
  .estimatedRefundDetail
  .itemizedRefundDetails
  .refundFeeType
string 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 are from RefundFeeTypeEnum:See refundFeeType.
Code so that your app gracefully handles any future changes to this list.
refundInfo
  .estimatedRefundDetail
  .itemizedRefundDetails
  .restockingFeePercentage
string Always Indicates the restocking fee charged by the seller for returned items (if any). In order to charge the buyer a restocking fee when an item is returned, a US seller must input a restocking fee value as part of the return policy when listing the item.
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 This field indicates the currency involved in a monetary transaction before a price conversion was performed. Generally, this is the currency used by the buyer. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.

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 This value is the dollar amount of the currency involved in a monetary transaction before a price conversion was performed. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.
refundInfo
  .estimatedRefundDetail
  .optionalRefundLineItems
  .estimatedAmount.currency
string Conditionally This field indicates the currency involved in a monetary transaction. Generally, this is the currency used by the listing site'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.value
number Conditionally The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the listing site.
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 This field indicates the currency involved in a monetary transaction before a price conversion was performed. Generally, this is the currency used by the buyer. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.

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 This value is the dollar amount of the currency involved in a monetary transaction before a price conversion was performed. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.
refundInfo
  .estimatedRefundDetail
  .optionalRefundLineItems
  .maxAmount.currency
string Conditionally This field indicates the currency involved in a monetary transaction. Generally, this is the currency used by the listing site'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.value
number Conditionally The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the listing site.
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 This field indicates the currency involved in a monetary transaction before a price conversion was performed. Generally, this is the currency used by the buyer. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.

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 This value is the dollar amount of the currency involved in a monetary transaction before a price conversion was performed. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.
refundInfo
  .estimatedRefundDetail
  .optionalRefundLineItems
  .minAmount.currency
string Conditionally This field indicates the currency involved in a monetary transaction. Generally, this is the currency used by the listing site'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.value
number Conditionally The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the listing site.
refundInfo
  .estimatedRefundDetail
  .optionalRefundLineItems
  .refundFeeType
string 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 are from RefundFeeTypeEnum:See refundFeeType.
Code so that your app gracefully handles any future changes to this list.
refundInfo
  .estimatedRefundDetail
  .optionalRefundLineItems
  .restockingFeePercentage
string Always Indicates the restocking fee charged by the seller for returned items (if any). In order to charge the buyer a restocking fee when an item is returned, a US seller must input a restocking fee value as part of the return policy when listing the item.
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 This field indicates the currency involved in a monetary transaction before a price conversion was performed. Generally, this is the currency used by the buyer. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.

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 This value is the dollar amount of the currency involved in a monetary transaction before a price conversion was performed. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.
refundInfo.sellerTotalAmount
  .currency
string Conditionally This field indicates the currency involved in a monetary transaction. Generally, this is the currency used by the listing site's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
refundInfo.sellerTotalAmount
  .value
number Conditionally The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the listing site.
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 This field indicates the currency involved in a monetary transaction before a price conversion was performed. Generally, this is the currency used by the buyer. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.

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 This value is the dollar amount of the currency involved in a monetary transaction before a price conversion was performed. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.
returnShippingCostInfo
  .carriers.shippingCost
  .itemizedReturnShippingCost
  .amount.currency
string Conditionally This field indicates the currency involved in a monetary transaction. Generally, this is the currency used by the listing site'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.value
number Conditionally The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the listing site.
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 This field indicates the currency involved in a monetary transaction before a price conversion was performed. Generally, this is the currency used by the buyer. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.

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 This value is the dollar amount of the currency involved in a monetary transaction before a price conversion was performed. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.
returnShippingCostInfo
  .carriers.shippingCost
  .totalAmount.currency
string Conditionally This field indicates the currency involved in a monetary transaction. Generally, this is the currency used by the listing site'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.value
number Conditionally The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the listing site.
returnShippingCostInfo
  .returnShipmentPayer
token Always Indicates the party that is responsible for return shipping cost, such as buyer, seller, or eBay.

Applicable values: See ReturnUserRoleEnum



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.