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:
- In the Sandbox, use AddItem to list an item that can be ended early with EndItem.
- Call EndItem with the item ID and review the results.
- Next, add an item to the Sandbox and have a different user place a bid on the item.
- Test setting EndingReason to
SellToHighBidderto 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>
| Argument | Type | Occurrence | Meaning |
|---|
ProductDeleted value, as this ending reason can only be used internally by eBay to administratively end a listing due to the associated Catalog product being removed from the eBay Catalog.
Applicable values: See EndingReason.
| ErrorLanguage | string | Optional |
Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Below are some examples from different countries.
|
||||||||||||||||||||||||||||||||||||||||
| MessageID | string | Optional |
Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned. Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable. |
||||||||||||||||||||||||||||||||||||||||
| Version | string | Conditional |
The version number of the API code that you are programming against (e.g., 1149). The version you specify for a call has these basic effects:
For the SOAP API: If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using. For the XML API: If you are using the XML API, this field has no effect. Instead, specify the version in the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. (If you specify Version in the body of an XML API request and it is different from the value in the HTTP header, eBay returns an informational warning that the value in the HTTP header was used instead.) See:
|
||||||||||||||||||||||||||||||||||||||||
| WarningLevel | WarningLevelCodeType | Optional |
Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request. An unrecognized element is one that is not defined in any supported version of the schema. Schema element names are case-sensitive, so using WarningLevel can also help you remove any potential hidden bugs within your application due to incorrect case or spelling in field names before you put your application into the Production environment. WarningLevel only validates elements; it doesn't validate XML attributes. It also doesn't control warnings related to user-entered strings or numbers, or warnings for logical errors. We recommend that you only use this during development and debugging. Do not use this in requests performed in the Production environment. Applicable values: High if the user wishes to receive warnings when the application passes unrecognized or deprecated elements in an API call request. Setting the WarningLevel value to High is not recommended in a production environment. Instead, it should only be used during the development/debugging stage.Low if the user does not wish to receive warnings when the application passes unrecognized or deprecated elements in an API call request. This is the default value if WarningLevel is not specified in the call request.See Warning Level. |
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>
| Return Value | Type | Occurrence | Meaning |
|---|
Applicable values:
(Not all values in AckCodeType apply to this field.)
Code so that your app gracefully handles any future changes to this list.
Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
repeatable: [0..*] A list of application-level errors (if any) that occurred when eBay processed the request.
Applicable values:
Code so that your app gracefully handles any future changes to this list.
See Errors By Number.
repeatable: [0..*] This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
[ attribute ParamID ] string Conditionally This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Applicable values:
If the source of the problem is within the application (such as a missing required element), change the application before you retry the request.
- If the problem is due to end-user input data, please alert the end-user to the problem and provide the means for them to correct the data. Once the problem in the application or data is resolved, you can attempt to re-send the request to eBay.
- If the source of the problem is on eBay's side, An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.
See the Error handling section of the Making a Trading API call guide for more information.
When a warning occurs, the error is returned in addition to the business data. In this case, you do not need to retry the request (as the original request was successful). However, depending on the cause or nature of the warning, you might need to contact either the end user or eBay to effect a long term solution to the problem to prevent it from reoccurring in the future.
Code so that your app gracefully handles any future changes to this list.
Applications must recognize when the Message field is returned and provide a means to display the listing hints and error message explanations to the user.
The string can return HTML, including TABLE, IMG, and HREF elements. In this case, an HTML-based application should be able to include the HTML as-is in the HTML page that displays the results. A non-HTML application would need to parse the HTML and convert the table elements and image references into UI elements particular to the programming language used. As usual for string data types, the HTML markup elements are escaped with character entity references (e.g.,<table><tr>...).
Note: GetCategories and other Trading API calls are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed.
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月04日T17:33:35.145Z</Timestamp>
<Ack>Success</Ack>
<Version>1131</Version>
<Build>E1131_UNI_API5_19098188_R1</Build>
<EndTime>2019年11月04日T17:33:35.145Z</EndTime>
</EndItemResponse>
Change History
| Change Date | Description |
|---|---|
| 1077 2018年08月31日 |
|
| 1027 2017年08月04日 |
|
| 0511 2007年05月02日 |
|
| 0481 2006年10月04日 |
|