eBay Post-Order APIVersion 2

Check Inquiry Eligibility

POST /post-order/v2/inquiry/check_eligibility

Determines if the buyer is eligible to file an inquiry for a particular order line item. Various criteria must be satisfied, including the timing of the inquiry, the eBay site involved, and approval of eligibility by PayPal.

Input

See also Samples.

Resource URI (production)

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

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.

{ /* CheckInquiryEligibilityRequest */
"itemId": string,
"transactionId": string
}

Request field descriptions



Input Container/Field Type Occurrence Meaning
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

See also Samples.

Payload model

Note: For information about the error fields and how to work with them, see Error Handling.

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

{ /* CheckInquiryEligibilityResponse */
"earliestPossibleFilingDate":
    { /* DateTime */
    "formattedValue": string,
    "value": datetime
    },
"errors": [
    { /* EligibilityResponseError */
    "id": string,
    "severity": string
    }
    /* More EligibilityResponseError nodes here */
  ],
"estimatedDeliveryDate":
    { /* DateTime */
    "formattedValue": string,
    "value": datetime
    },
"inquiryEligibilityStatus": string,
"inquiryId": string,
"latestPossibleFilingDate":
    { /* DateTime */
    "formattedValue": string,
    "value": datetime
    },
"nonOverridableErrors": [
    { /* EligibilityResponseError */
    "id": string,
    "severity": string
    }
    /* More EligibilityResponseError nodes here */
  ],
"paypalReasonToDenyRequestFiling": string,
"returnFilingDate":
    { /* DateTime */
    "formattedValue": string,
    "value": datetime
    },
"returnId": string,
"warnings": [
    { /* EligibilityResponseError */
    "id": string,
    "severity": string
    }
    /* More EligibilityResponseError nodes here */
  ]
}

Response field descriptions



Output Container/Field Type Occurrence Meaning
earliestPossibleFilingDate DateTime Conditionally This timestamp indicates the earliest possible date that the buyer can file an inquiry against the specified order line item. This field will not be returned if the value of the inquiryEligibilityStatus field is INELIGIBLE.
earliestPossibleFilingDate
  .formattedValue
string Conditionally This field is for internal or future use.
earliestPossibleFilingDate
  .value
datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
errors array of EligibilityResponseError Conditionally This container is an array of one or more error messages regarding the buyer's eligibility to file an inquiry for a particular order line item. This container is generally returned if the value of the inquiryEligibilityStatus field is INELIGIBLE. However, based on the error(s) that appear here, it is possible that the buyer can address and resolve these errors/issues and become eligible to file an inquiry against the order line item.
errors.id string Conditionally The unique identifier of this error or warning. This field is always returned with each error or warning that is retrieved in the response.
errors.severity string Conditionally This field indicates if the issue is an error or a warning. This field is always returned with each error or warning that is retrieved in the response.
estimatedDeliveryDate DateTime Conditionally Contains a timestamp specifying the estimated delivery date of the order line item associated with this inquiry.
estimatedDeliveryDate
  .formattedValue
string Conditionally This field is for internal or future use.
estimatedDeliveryDate.value datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
inquiryEligibilityStatus string Always This value indicates the eligibility of the buyer to file an Item Not Received inquiry against the order line item.

Applicable values are from InquiryEligibilityStatusEnum:

ELIGIBLE_TO_FILE_REQUEST
The buyer is eligible to file an inquiry against the specified line item.
ELIGIBLE_TO_FILE_WITH_WARNING
The buyer is eligible to file an inquiry against the specified line item, but must comply with warnings that are revealed under the warnings container in the response.
INELIGIBLIE
The buyer is not eligible to file an inquiry against the specified line item. The buyer should read the errors that are returned in the errrors and/or nonOverridableErrors containers.

Code so that your app gracefully handles any future changes to this list.
inquiryId string Conditionally The unique identifier of an inquiry that was filed against the order line item that was specified in the request. This field is only returned if an existing inquiry request already exists for the order line item.
latestPossibleFilingDate DateTime Conditionally This timestamp indicates the latest possible date that the buyer can file an inquiry against the specified order line item. This field will not be returned if the value of the inquiryEligibilityStatus field is INELIGIBLE.
latestPossibleFilingDate
  .formattedValue
string Conditionally This field is for internal or future use.
latestPossibleFilingDate.value datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
nonOverridableErrors array of EligibilityResponseError Conditionally This container is an array of one or more error messages regarding the buyer's eligibility to file an inquiry for a particular order line item. This container is generally returned if the value of the inquiryEligibilityStatus field is INELIGIBLE. these errors/issues cannot be addressed and resolved by the buyer, and the buyer will not be eligible to file an inquiry against the order line item.
nonOverridableErrors.id string Conditionally The unique identifier of this error or warning. This field is always returned with each error or warning that is retrieved in the response.
nonOverridableErrors.severity string Conditionally This field indicates if the issue is an error or a warning. This field is always returned with each error or warning that is retrieved in the response.
paypalReasonToDenyRequestFiling string Conditionally This field will be returned if PayPal is blocking the INR inquiry request. The enumeration value will state the reason.

Applicable values are from PaymentDenialReasonEnum:See paypalReasonToDenyRequestFiling.
Code so that your app gracefully handles any future changes to this list.
returnFilingDate DateTime Conditionally This timestamp specifies the latest possible date that the buyer can create a return request for an order line item. This field is only applicable if the buyer has received and wants to return an item.
returnFilingDate
  .formattedValue
string Conditionally This field is for internal or future use.
returnFilingDate.value datetime Conditionally This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
returnId string Conditionally This string value is the unique identifier of a return request. This field is only returned if the buyer filed a return request against the order line item associated with the inquiry.
warnings array of EligibilityResponseError Conditionally This container is an array of one or more warning messages regarding the buyer's eligibility to file an inquiry for a particular order line item. This container is generally returned if the value of the inquiryEligibilityStatus field is ELIGIBLE_TO_FILE_WITH_WARNING. The buyer may need to address these warnings prior to filing an inquiry against the order line item.
warnings.id string Conditionally The unique identifier of this error or warning. This field is always returned with each error or warning that is retrieved in the response.
warnings.severity string Conditionally This field indicates if the issue is an error or a warning. This field is always returned with each error or warning that is retrieved in the response.
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: Check Inquiry Eligibility

This call determines if the buyer is eligible to file an INR inquiry for a particular line item.

Description

This call determines if an INR inquiry can be filed against a particular order line item. Several factors go into to determining whether an INR inquiry can be filed against an order line item, such as listing site, order creation date, estimated delivery date and more.

Input

The combination of the itemId and transactionId fields identifies a specific order line item, and by inference the order details such as the payment date and the site, all of which might affect the buyer's eligibility to file an inquiry.

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

POST https://api.ebay.com/post-order/v2/inquiry/check_eligibility
{
  "itemId": "130007266495",
  "transactionId": "8545116003"
}

Output

By returning an inquiryEligibilityStatus value of INELIGIBLE this response indicates that the buyer cannot file an INR inquiry, and the errors.id value of INELIGIBLE_TRANSACTION_SITE indicates that the order line item was sold from an eBay site, EBAY_FR, that does not support INR inquiries.

JSON format.
{
  "inquiryEligibilityStatus": "INELIGIBLIE",
  "warnings": [ ],
  "errors": [
    {
      "severity": "ERROR",
      "parameters": {
        "empty": false,
        "values": [
          "EBAY_FR"
        ]
      },
      "id": "INELIGIBLE_TRANSACTION_SITE"
    }
  ]
}



Change History

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