eBay Post-Order API Version 2

Create an Inquiry for the Buyer

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.

Input

Request model

The following lists all fields that could be included in the request.

See also Samples.

Resource URI (production)

POST https://api.ebay.com/post-order/v2/inquiry/

This call has no path or query parameters.



Supported HTTP request headers

Header Description Applicable Values
Accept The media type for the response. Defaults to JSON (the only supported media type). application/json
Authorization The Authentication Token that is used to validate the caller has permission to access the eBay servers. Prefix a valid eBay token with the word "TOKEN".
For more details, see Getting Tokens.
Required
TOKEN <authorization-token-value>
Content-Type The MIME type of the body of the request. Must be JSON.
Required
application/json
X-EBAY-C-MARKETPLACE-ID The global ID of the eBay site on which the transaction took place.
Required
Currently, the marketplaces are limited to:
EBAY-US, EBAY-UK, and EBAY-DE


Authorization

This call uses standard authorization tokens. See Making a Call for details.

Payload model

{ /* CreateInquiryRequest */
"claimQuantity": integer,
"comments":
    { /* Text */
    "content": string,
    "language": LanguageEnum,
    "translatedFromContent": string,
    "translatedFromLanguage": LanguageEnum
    },
"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 LanguageEnum 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:

de
This enumeration value indicates that the language is German.
el
This enumeration value indicates that the language is Greek.
en
This enumeration value indicates that the language is English.
eo
This enumeration value indicates that the language is Esperanto.
es
This enumeration value indicates that the language is Spanish
fr
This enumeration value indicates that the language is French.
hy
This enumeration value indicates that the language is Armenian.
it
This enumeration value indicates that the language is Italian.
ja
This enumeration value indicates that the language is Japanese.
ka
This enumeration value indicates that the language is Georgian.
nl
This enumeration value indicates that the language is Dutch.
pt
This enumeration value indicates that the language is Portuguese.
ru
This enumeration value indicates that the language is Russian.
sv
This enumeration value indicates that the language is Swedish.
tr
This enumeration value indicates that the language is Turkish.
xx
This enumeration value indicates that the language is unknown.

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
LanguageEnum 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:

de
This enumeration value indicates that the language is German.
el
This enumeration value indicates that the language is Greek.
en
This enumeration value indicates that the language is English.
eo
This enumeration value indicates that the language is Esperanto.
es
This enumeration value indicates that the language is Spanish
fr
This enumeration value indicates that the language is French.
hy
This enumeration value indicates that the language is Armenian.
it
This enumeration value indicates that the language is Italian.
ja
This enumeration value indicates that the language is Japanese.
ka
This enumeration value indicates that the language is Georgian.
nl
This enumeration value indicates that the language is Dutch.
pt
This enumeration value indicates that the language is Portuguese.
ru
This enumeration value indicates that the language is Russian.
sv
This enumeration value indicates that the language is Swedish.
tr
This enumeration value indicates that the language is Turkish.
xx
This enumeration value indicates that the language is unknown.

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:
  • FULL_REFUND — This value is used if the buyer wants a full refund of the missing order line item. 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 call to issue a refund to the buyer instead of fulfilling and shipping the order line item.
  • STILL_WANT_ITEM — This value is used if the buyer still wants the seller to ship the missing order line item. This is the default value if the desiredOutcome field is omitted. 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 call to provide shipment tracking information and inform the buyer that the order line item is on its way.
One of the values of DesiredOutcomeTypeEnum must be used.
itemId string Required The unique identifer of an item listing. The itemId and transactionId values identify a specific order line item, and both of these fields are required.
transactionId string Required The unique identifer of a purchase that occurred on an item listing. The itemId and transactionId values identify a specific order line item, and both of these fields are required.

Output

Response model

A successful POST /post-order/v2/inquiry/ call will return 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. This value is required as input for most of the Order Inquiry API calls.

See the HTTP Status Code Registry for a complete overview of HTTP status codes.

Note: The response information on this page applies to successful requests only. For information about the error fields and how to work with them, see Error Handling.

See also Samples.

Payload model

This call has no response payload.




Samples

Code samples not yet added for this call's documentation.



Change History

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