eBay Post-Order APIVersion 2

Close Inquiry

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

Closes the specified inquiry.

Input

See also Samples.

Resource URI (production)

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

URI parameters

Parameter Type Required? Meaning
inquiryId string Required The unique identifier of the inquiry to be closed.

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.

{ /* BuyerCloseInquiryRequest */
"closeReason": token,
"comments":
    { /* Text */
    "content": string,
    "language": string,
    "translatedFromContent": string,
    "translatedFromLanguage": string
    }
}

Request field descriptions



Input Container/Field Type Occurrence Meaning
closeReason token Optional The reason why the buyer is closing the inquiry. This is an optional but recommended field to include in the request.

Applicable values: See BuyerCloseReasonEnum
comments Text Optional This optional container allows the buyer to provide more information to the seller about why the inquiry is being closed.
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

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: Close an Inquiry

This operation closes an INR inquiry.

Description

Use this operation to close a specified inquiry on behalf of the buyer, according to the reason that the buyer supplies.

Input

Supply the inquiry ID as a path parameter in the call. The value of the recommended closeReason field indicates that the buyer and seller have arrived at a solution that warrants closing the inquiry.

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

POST https://api.ebay.com/post-order/v2/inquiry/5003176669/close
{
    "closeReason": "WORKED_OUT_WITH_SELLER",
    "comments":
    {
      "content": "The seller has assured me that the item is on its way."
    }
}

Output

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

JSON format.



Change History

Change Date Description
1.0
2015-08-10
  • Call (added): New call.