Create Inquiry

POST /post-order/v2/inquiry

This method is used to create an Item Not Received (INR) inquiry for the specified order line item on behalf of the buyer.

If the inquiry is successfully created, an HTTP status code of 201 is returned, and the Location response header will contain the call URI that can be used to retrieve the newly-created inquiry.

Input

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": string,
"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 container can be used if the buyer wants to provide more information about initiating 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. The full list of language enumeration values are defined in the LanguageEnum type definition. Applicable values: See LanguageEnum
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. The full list of language enumeration values are defined in the LanguageEnum type definition. Applicable values: See LanguageEnum
desiredOutcome	string	Optional	This field is used to indicate whether the buyer still wants the item (`STILL_WANT_ITEM` is passed in), or whether the buyer is now looking to receive a full refund (`FULL_REFUND` is passed in) for the line item even if it received by the buyer. If this field is omitted, the desiredOutcome value defaults to `STILL_WANT_ITEM`. Applicable values are from DesiredOutcomeTypeEnum: FULL_REFUND This enumeration value indicates that the buyer no longer wants the item, and prefers a full refund from the seller instead. If this value is specified by the buyer, and the order line item still hasn't been shipped, the seller can use the POST /post-order/v2/inquiry/{inquiryId}/issue_refund method to issue a refund to the buyer instead of fulfilling and shipping the order line item. STILL_WANT_ITEM This enumeration value indicates that the buyer still wants the seller to ship the missing order line item. If this value is specified by the buyer, the seller should ship the order line item as soon as possible (to avoid the inquiry being escalated to a case), and then use the POST /post-order/v2/inquiry/{inquiryId}/provide_shipment_info method to provide shipment tracking information and inform the buyer that the order line item is on its way.
itemId	string	Required	The unique identifier of the eBay listing where the line item was purchased. This field and the transactionId field are required in order to identify the line item for which an INR inquiry will be created.
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 and the itemId field are required in order to identify the line item for which an INR inquiry will be created.

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

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.

Change History

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