eBay Post-Order APIVersion 2

Issue Inquiry Refund

POST /post-order/v2/inquiry/{inquiryId}/issue_refund

Issues a full refund to the buyer for the missing line item. This call will be used if the buyer is seeking a full refund for the missing line item and the seller has yet to ship the line item.

Input

See also Samples.

Resource URI (production)

POST https://api.ebay.com/post-order/v2/inquiry/{inquiryId}/issue_refund

URI parameters

Parameter Type Required? Meaning
inquiryId string Required The unique ID of the inquiry for which a refund is to be issued.

Note: This is the value that was returned by the POST /post-order/v2/inquiry/ call in an HTTP location code: /post-order/v2/inquiry/{INQUIRYID}, in which INQUIRYID identifies the newly created inquiry.


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.

{ /* InquiryVoluntaryRefundRequest */
"comments":
    { /* Text */
    "content": string,
    "language": string,
    "translatedFromContent": string,
    "translatedFromLanguage": string
    }
}

Request field descriptions



Input Container/Field Type Occurrence Meaning
comments Text Optional This optional container allows the seller to provide more information to the buyer about the refund being issued.
comments.content string Conditional This field displays the actual textual content in the language specified in the language field. This field is always used for containers using the Text type.
comments.language string Conditional This two-letter code indicates the language used to display the content in the content field. The language will default to the language used on the eBay site if a specific language is not specified through the Accept-Language HTTP header. This field is always used for containers using the Text type.

Applicable values are from LanguageEnum:See language.
comments.translatedFromContent string Conditional If language translation/localization is required, this field displays the actual textual content in the language specified in the translatedFromLanguage field. If language translation was not required, this field is not applicable.
comments
  .translatedFromLanguage
string Conditional If language translation/localization is required, this two-letter code indicates the language used to display the content in the translatedFromContent field. If language translation was not required, this field is not applicable.

Applicable values are from LanguageEnum:See translatedFromLanguage.

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.

{ /* VoluntaryRefundResponse */
"refundResult":
    { /* VoluntaryRefundResult */
    "refundSource": token,
    "refundStatus": token
    }
}

Response field descriptions



Output Container/Field Type Occurrence Meaning
refundResult VoluntaryRefundResult Always Contains information about the status and the source of the refund.
refundResult.refundSource token Always This enumeration value indicates the payment source used to refund the buyer to resolve an inquiry or case.

Applicable values: See RefundPaymentTypeEnum
refundResult.refundStatus token Always Indicates the success or failure of a full refund being issued by the seller through an issue_refund call. PENDING will be returned if the refundSource value is ECHECK, or if the seller and buyer are handling the refund through a source other than PayPal.

Applicable values: See RefundStatusEnum



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: Issue a Refund

This operation issues a refund to the buyer.

Description

You can use this operation on behalf of the seller to issue a refund for an order line item after the buyer has filed an INR inquiry. A refund should only be issued by the seller if a refund is what the buyer is expecting. In some cases, the buyer still wants the item. The buyer's desired outcome is stated when the buyer creates the inquiry (either 'I want a full refund' or 'I still want the item').

Input

The inquiryId path parameter identifies the INR inquiry asociated with the order line item being refunded. This call includes an optional comment from the seller to the buyer.

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

POST https://api.ebay.com/post-order/v2/inquiry/5003176669/issue_refund
{
  "comments": 
  {
    "content": "Your refund is on its way."
  }
}

Output

The reponse payload indicates that an instant refund was successfully issued to the buyer from the seller's PayPal account.

JSON format.
{
  "refundResult": {
    "refundSource": "INSTANT_REFUND",
    "refundStatus": "SUCCESS"
  }
}



Change History

Change Date Description