Provide Inquiry Refund Info

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

This method on behalf of the seller to provide more information to the buyer about a refund, as is required in certain countries.

This method is not supported in the Sandbox environment.

Input

Resource URI (production)

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

URI parameters

Parameter	Type	Required?	Meaning
inquiryId	string	Required	The unique ID of the inquiry for which to provide refund information. The inquiry ID value is passed in as part of the call URI.

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.

{ /* SellerProvideRefundInfoRequest */
"message":
    { /* Text */
    "content": string,
    "language": string,
    "translatedFromContent": string,
    "translatedFromLanguage": string
    }
}

Request field descriptions

Input Container/Field	Type	Occurrence	Meaning
message	Text	Required	This container is used to provide relevant information about the buyer's refund.
message.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.
message.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. The full list of language enumeration values are defined in the LanguageEnum type definition. Applicable values: See LanguageEnum
message.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.
message.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. The full list of language enumeration values are defined in the LanguageEnum type definition. Applicable values: See LanguageEnum

Output

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: Provide Refund Information

The seller provides information about a refund to the buyer.

Description

This operation enables the seller to send a text message to the buyer about the refund issued for the specified INR inquiry. Some countries require the seller to confirm that the refund has been issued.

Input

The inquiryId path parameter identifies the INR inquiry for which a refund was issued. The call payload is a message about the refund associated with this INR inquiry.

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

POST https://api.ebay.com/post-order/v2/inquiry/5********9/provide_refund_info
{ 
"message":
    { 
    "content": "This refund applies to the order line items for which you filed inquiry #5********9."
    }
}

Output

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

JSON format.

Change History

Change Date	Description