eBay Post-Order APIVersion 2.6

Mark Return Refund Sent

POST /post-order/v2/return/{returnId}/mark_refund_sent

The seller uses this call to notify eBay and the buyer that a refund has been issued.

Input

See also Samples.

Resource URI (production)

POST https://api.ebay.com/post-order/v2/return/{returnId}/mark_refund_sent

URI parameters

Parameter Type Required? Meaning
returnId string Required The unique eBay-assigned ID of the return. The returnId value is required to identify the return for which the refund was issued.


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.

{ /* MarkRefundSentRequest */
"comments": string,
"partialRefundAmount":
    { /* Amount */
    "convertedFromCurrency": string,
    "convertedFromValue": number,
    "currency": string,
    "value": number
    },
"refundDetail":
    { /* RefundDetailType */
    "itemizedRefundDetail": [
        { /* ItemizedRefundDetailType */
        "refundAmount":
            { /* Amount */
            "convertedFromCurrency": string,
            "convertedFromValue": number,
            "currency": string,
            "value": number
            },
        "refundFeeType": token,
        "restockingFeePercentage": string
        }
        /* More ItemizedRefundDetailType nodes here */
      ],
    "totalAmount":
        { /* Amount */
        "convertedFromCurrency": string,
        "convertedFromValue": number,
        "currency": string,
        "value": number
        }
    }
}

Request field descriptions



Input Container/Field Type Occurrence Meaning
comments string Optional This optional string field allows the seller to communicate any details about the refund being issued.
partialRefundAmount Amount Conditional This field is conditionally required if the buyer and seller agreed upon a partial refund to settle the case. This amount is the dollar value of the partial refund.
partialRefundAmount
  .convertedFromCurrency
string Optional Gets the original transaction currency, if the transaction involves a currency conversion. The currency is represented as a 3-letter currency code from ISO4217. See http://en.wikipedia.org/wiki/ISO_4217 If no conversion occurs, this should not be populated.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
partialRefundAmount
  .convertedFromValue
number Optional Gets the original transaction amount, if the transaction involves a currency conversion. If no conversion occurs, this should not be populated.
partialRefundAmount.currency string Optional Gets the transaction currency. This is the currency in which the transaction occurs: in the case of currency conversion, this is the post-conversion currency.

Applicable values are from CurrencyCodeEnum:See currency.
partialRefundAmount.value number Optional Gets the amount of the transaction, expressed in the specified request.
refundDetail RefundDetailType Required This container is used to specify the total amount of the refund, as well as an itemizedRefundDetail container for each refund type (refund on purchase price, refund on original shipping, or any other costs paid by the buyer). The amount(s) in the itemizedRefundDetail.amount field(s) should equal the amount in the refundDetail.totalAmount field.
refundDetail
  .itemizedRefundDetail
array of ItemizedRefundDetailType Required This container is used to declare a refund that is being issued, or has been issued to the buyer. An itemizedRefundDetail container is required for each different refund type, such as purchase price and original shipping. This container is required when using the POST /post-order/v2/return/{returnId}/issue_refund call to issue a refund, or when using the POST /post-order/v2/return/{returnId}/mark_refund_sent call to mark a refund as sent. In the POST /post-order/v2/return and GET /post-order/v2/return/{returnId} calls, this container will be returned under the actualRefund container if a refund has occurred.
refundDetail
  .itemizedRefundDetail
  .refundAmount
Amount Required This dollar value is the amount of the refund for the particular refund type (specified in the refundFeeType field). When issuing a refund through the POST /post-order/v2/return/{returnId}/issue_refund call, or if marking a refund as sent with the POST /post-order/v2/return/{returnId}/mark_refund_sent 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).
refundDetail
  .itemizedRefundDetail
  .refundAmount
  .convertedFromCurrency
string Optional Gets the original transaction currency, if the transaction involves a currency conversion. The currency is represented as a 3-letter currency code from ISO4217. See http://en.wikipedia.org/wiki/ISO_4217 If no conversion occurs, this should not be populated.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
refundDetail
  .itemizedRefundDetail
  .refundAmount
  .convertedFromValue
number Optional Gets the original transaction amount, if the transaction involves a currency conversion. If no conversion occurs, this should not be populated.
refundDetail
  .itemizedRefundDetail
  .refundAmount.currency
string Optional Gets the transaction currency. This is the currency in which the transaction occurs: in the case of currency conversion, this is the post-conversion currency.

Applicable values are from CurrencyCodeEnum:See currency.
refundDetail
  .itemizedRefundDetail
  .refundAmount.value
number Optional Gets the amount of the transaction, expressed in the specified request.
refundDetail
  .itemizedRefundDetail
  .refundFeeType
token Required This enumerated value indicates the type of refund. When issuing a refund through the POST /post-order/v2/return/{returnId}/issue_refund call, or if marking a refund as sent with the POST /post-order/v2/return/{returnId}/mark_refund_sent 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
refundDetail
  .itemizedRefundDetail
  .restockingFeePercentage
string Optional Restocking fees are no longer supported by eBay. Input values for this field are not read nor returned.
refundDetail.totalAmount Amount Required This value is the total cumulative amount of the refund issued to the buyer. This value should equal the sum of the values in the itemizedRefundDetail.refundAmount field(s). This container is required when using the POST /post-order/v2/return/{returnId}/issue_refund call to issue a refund, or when using the POST /post-order/v2/return/{returnId}/mark_refund_sent call to mark a refund as sent. In the POST /post-order/v2/return and GET /post-order/v2/return/{returnId} calls, this container will be returned under the actualRefund container if a refund has occurred.
refundDetail.totalAmount
  .convertedFromCurrency
string Optional Gets the original transaction currency, if the transaction involves a currency conversion. The currency is represented as a 3-letter currency code from ISO4217. See http://en.wikipedia.org/wiki/ISO_4217 If no conversion occurs, this should not be populated.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
refundDetail.totalAmount
  .convertedFromValue
number Optional Gets the original transaction amount, if the transaction involves a currency conversion. If no conversion occurs, this should not be populated.
refundDetail.totalAmount
  .currency
string Optional Gets the transaction currency. This is the currency in which the transaction occurs: in the case of currency conversion, this is the post-conversion currency.

Applicable values are from CurrencyCodeEnum:See currency.
refundDetail.totalAmount.value number Optional Gets the amount of the transaction, expressed in the specified request.

Output

See also Samples.

Payload model

This call has no response payload.

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: Mark a Refund Sent

Communicate to the buyer that the refund has been sent.

Description

With this operation, the seller can notify the buyer that a refund has been sent for the specified return, and provide a breakdown of the costs being refunded.

Input

The returnId parameter is required to identify the return for which the refund was sent. In this request, there are two amounts being refunded: The purchase price of AUD 40.00 and the corresponding original shipping cost of AUD 3.10. The totalAmount container provides the sum of those two values (AUD 43.10).

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

POST https://api.sandbox.ebay.com/post-order/v2/return/5000121144/mark_refund_sent
{ 
  "refundDetail":
  { 
    "itemizedRefundDetail": [
      {
        "refundAmount":
        { 
          "currency": "AUD",
          "value": "40.0"
        },
        "refundFeeType": "PURCHASE_PRICE",
        "restockingFeePercentage": "0"
      },
      { 
        "refundAmount":
        { 
          "currency": "AUD",
          "value": "3.1"
        },
        "refundFeeType": "ORIGINAL_SHIPPING",
        "restockingFeePercentage": "0"
      }
    ],
    "totalAmount":
    { 
        "currency": "AUD",
        "value": "43.1"
    }
  }
}

Output

A successful call returns an HTTP code of 200; there is no payload for the response.

JSON format.



Change History

Change Date Description