Check Cancellation Eligibility

POST /post-order/v2/cancellation/check_eligibility

This method is used to check if a specified order is eligible to be cancelled.

The response contains information on cancellation eligibility at the order and order line-item levels.

Note: Currently, only an entire order can be cancelled; the cancellation of individual line items in the order is not supported.

For an order to be eligible for cancellation, all of the line items in the order must be eligible for cancellation.

Input

See also Samples.

Resource URI (production)

POST https://api.ebay.com/post-order/v2/cancellation/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.

{ /* OrderEligibilityCheckInfo */
"legacyOrderId": 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.

Supported response formats: application/json, application/xml

For more information:
- See OrderEligibilityResult for a description of the response structure
- See the following table for descriptions of each of the data elements returned
- See the Samples for an example of the response format

{ /* OrderEligibilityResult */
"eligible": boolean,
"eligibleCancelReason": [
    string
    /* More string nodes here */
  ],
"failureReason": [
    string
    /* More string nodes here */
  ],
"itemEligibilityResult": [
    { /* ItemEligibilityResult */
    "cancelQuantity": integer,
    "eligible": boolean,
    "failureReason": [
        string
        /* More string nodes here */
      ],
    "itemId": string,
    "transactionId": string
    }
    /* More ItemEligibilityResult nodes here */
  ],
"legacyOrderId": string
}

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 operation is used to see if an order is eligible for a cancellation.

Description

Users may check to see if an order is eligible to be cancelled before actually attempting to create a cancellation request.

Input

The user must supply the legacyOrderId for the order being checked for cancellation eligibility. The legacyOrderId value is actually the OrderID value that is returned in the Trading API's GetOrders call.

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

POST https://api.ebay.com/post-order/v2/cancellation/check_eligibility
{
  "legacyOrderId":"1**********6-8********7"
}

Output

A value of false in the eligible field indicates that the order is not eligible for cancellation. A value of CANCELLATION_EXIST in the failureReason array indicates that the order is not eligible for cancellation due to the fact that an order cancellation request already exists for the order. This particular order, 1**********6-8********7, has only one order line item, which is identified by the itemId and transactionId pair under the itemEligibilityResult container. Eligibility status (and reason for ineligibility, if applicable) is returned for each line item in the order, since some line items in the order may be eligible to be cancelled and other line items might not be eligible to be cancelled.

JSON format.
{
  "legacyOrderId": "1**********6-8********7",
  "eligible": false,
  "failureReason": [
    "CANCELLATION_EXIST"
  ],
  "itemEligibilityResult": [
    {
      "itemId": "1**********6",
      "transactionId": "8********7",
      "eligible": false,
      "failureReason": [
        "CANCELLATION_EXIST"
      ]
    }
  ]
}

Change History