EndItem

Use this call to explicitly end a currently active item listing before it would ordinarily end (per the listing duration).

Normally, item listings end when the specified duration has passed, when a Buy It Now option for a Chinese auction is exercised, or (in the case of multi-item fixed-price listings) when the last item in the listing has been sold. EndItem provides the means for ending the listing before any of these natural conditions occur to end the listing.

If the seller listed the item with InventoryTrackingMethod set to SKU, they can use EndFixedPriceItem instead of EndItem, and specify the SKU instead of the item ID.

Usage Details

Only the item's seller can use EndItem to end an item listing. In the call, specify the item ID for the listing you want to end. Depending on certain conditions, you might also be required to include EndingReason to specify the reason for ending the listing.

If the listing has no qualifying bids when you call EndItem, the listing is ended as an unsuccessful auction.

For competitive-bid item listings that have qualifying bids (for example, a bid that meets the minimum reserve price), you must specify an EndingReason value. If you specify SellToHighBidder, the listing ends as a successful auction with winning bidder(s). If you specify a different EndingReason value (such as LostOrBroken), all bids are automatically canceled and the item is terminated as an unsuccessful auction.

There are two restrictions for ending items in the last 12 hours of a listing. First, if there is a qualified bid, the seller cannot end the item within the last 12 hours of the auction. Also, if the seller has canceled a bid during the last 12 hours of the listing, the seller cannot end the item early.

A successfully completed call returns EndTime, the official date and time (in GMT) that the listing was ended. Ending an item with EndItem triggers an ItemUnsold notification or Client Alert, if the seller is subscribed to that notification.

Note to Sell Feed API users: When you use this call with the Sell Feed API, you must wrap the file to be uploaded within BulkDataExchangeRequest tags, which will also be returned in the response. This container is not shown in the standard Input/Output sections for this call. See XML data files overview in the LMS Feed API Guide for additional information.

Testing EndItem

You should test ending items early using both items that have bids and items that do not have bids. This ensures the application is able to accommodate both use cases. Test EndItem in the Sandbox as follows:

1. In the Sandbox, use AddItem to list an item that can be ended early with EndItem.
2. Call EndItem with the item ID and review the results.
3. Next, add an item to the Sandbox and have a different user place a bid on the item.
4. Test setting EndingReason to SellToHighBidder to successfully sell the item, and then test ending another listing with EndingReason set to another value to cancel bids and end the item as an unsuccessful auction.

Related Information

See End a listing early.

See also the reference documentation for these calls:

• EndFixedPriceItem - Ends the specified fixed-price listing before the date and time at which it would normally end (per the listing duration).
• EndItems - The EndItems call is used to end up to 10 specified eBay listings before the date and time at which those listings would normally end per the listing duration.

Input

See also Samples.

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.

The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).

<?xml version="1.0" encoding="utf-8"?>
<EndItemRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Input Fields -->
  <EndingReason> EndReasonCodeType </EndingReason>
  <ItemID> ItemIDType (string) </ItemID>
  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
</EndItemRequest>

Output

See also Samples.

The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).

<?xml version="1.0" encoding="utf-8"?>
<EndItemResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <EndTime> dateTime </EndTime>
  <!-- Standard Output Fields -->
  <Ack> AckCodeType </Ack>
  <Build> string </Build>
  <CorrelationID> string </CorrelationID>
  <Errors> ErrorType
    <ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
    <ErrorCode> token </ErrorCode>
    <ErrorParameters ParamID="string"> ErrorParameterType
      <Value> string </Value>
    </ErrorParameters>
    <!-- ... more ErrorParameters nodes allowed here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes allowed here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Message> string </Message>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
</EndItemResponse>

Detail Controls

DetailLevel

This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.

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.

The following sample shows how to end a listing.

Description

Seller m***************r listed a book for sale, but then she accidentally spilled a cup of coffee on the rare volume and ruined its sale value. She decided to end the auction early as a result.

Input

In order to end an item before its normal listing duration, the authenticated user of this call must be the one who originally listed the item. The call requires a ItemID and an EndingReason. Here, m***************r lists NotAvailable, indicating that the item is no longer available for sale. This action cancels all existing bids on the item.

XML format.

<?xml version="1.0" encoding="utf-8"?>
<EndItemRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>A*******3</eBayAuthToken>
  </RequesterCredentials>
  <ItemID>1**********8</ItemID>
  <EndingReason>NotAvailable</EndingReason>
</EndItemRequest>

Output

Success in the Ack field indicates that the auction was successfully ended.

XML format.
<?xml version="1.0" encoding="utf-8"?>
<EndItemResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2019-11-04T17:33:35.145Z</Timestamp>
  <Ack>Success</Ack>
  <Version>1131</Version>
  <Build>E1131_UNI_API5_19098188_R1</Build>
  <EndTime>2019-11-04T17:33:35.145Z</EndTime>
</EndItemResponse>

Change History