Create Inquiry
POST /post-order/v2/inquiry
Creates an Item Not Received (INR) inquiry for the specified order line item on behalf of the buyer.
Note: A successful call will return an HTTP status code 201
, with the following location code: /post-order/v2/inquiry/{INQUIRYID}
, in which INQUIRYID
identifies the newly created inquiry. This value is required as input for most of the Inquiry calls.
Output Samples Change History |
Input
See also Samples.
Resource URI (production)
POST https://api.ebay.com/post-order/v2/inquiry
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.
{ /* CreateInquiryRequest */ "claimQuantity": integer, "comments": { /* Text */ "content": string, "language": string, "translatedFromContent": string, "translatedFromLanguage": string }, "desiredOutcome": token, "itemId": string, "transactionId": string }
Request field descriptions
Input Container/Field | Type | Occurrence | Meaning |
---|---|---|---|
claimQuantity | integer | Optional |
This integer is the quantity of the line item purchased by the buyer. This value will usually be 1 unless the buyer purchased multiple quantity of a line item in a multiple-quantity, fixed-priced listing. If this field is omitted, its value defaults to 1 .
|
comments | Text | Optional | This optional container allows the buyer to provide more information about opening up the INR inquiry. |
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. |
desiredOutcome | token | Optional |
This field is used to indicate whether the buyer still wants the item, or whether the buyer is now looking to receive a full refund for the line item. Although this field is optional, it should be specified by the buyer so the seller knows the next action to perform based on what the buyer is looking for. If this field is omitted, the desiredOutcome value defaults to STILL_WANT_ITEM . Applicable values:
Applicable values: See DesiredOutcomeTypeEnum |
itemId | string | Required | The unique identifier for the eBay listing where the item was purchased. This field is used in conjunction with the transactionId field to identify a line item within an order. |
transactionId | string | Required | The unique identifier for the purchase of a item. This value is created right when the buyer is committed to buying the item, whether that buyer uses a 'Buy it Now' capability, is the winning bidder of an auction, or the buyer's Best Offer is accepted by the seller. This field is used in conjunction with the itemId field to identify a line item within an order. |
Input Samples Change History |
Output
See also Samples.
Payload model
This call has no response payload.
nullInput Output Change History |
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.
This operation creates an Item Not Received (INR) inquiry.
Description
You can use this operation to submit an INR inquiry for a specified order line item that has not been received by the buyer within the estimated delivery timeframe.
Input
The combination of an itemId and a transactionId identifies the order line item (the purchased item) that has not been received.
URL format. See also the non-wrapped version of this URL. POST https://api.ebay.com/post-order/v2/inquiry/ { "itemId": "2**********9", "transactionId": "1*********5" }
Output
A successful operation has no response payload, but returns an HTTP status code of 201
, with the following accompanying location code: /post-order/v2/inquiry/{INQUIRYID}
, in which INQUIRYID
identifies the newly created inquiry.
JSON format.
Input Output Samples |
Change History
Change Date | Description |
---|---|
1.0 2015-08-10 |
|