Check Inquiry Eligibility

POST /post-order/v2/inquiry/check_eligibility

This method is used to determine 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.

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

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

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 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": "1**********5",
  "transactionId": "8********3"
}

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