eBay Trading APIVersion 1085

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.

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 Ending Items Early.

See also the reference documentation for these calls:



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
Call-specific Input Fields [Jump to standard fields]
EndingReason EndReasonCodeType Required The seller's reason for ending the listing early is input into this required field. The seller is not allowed to use the 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.
ItemID ItemIDType (string) Required Unique item ID that identifies the listing that you want to end.
Max length: 19 (Note: Currently, Item IDs are usually 9 to 12 digits).
Standard Input Fields  
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. Specify the standard RFC 3066 language identification tag (e.g., en_US).

ID Country
en_AU Australia
de_AT Austria
nl_BE Belgium (Dutch)
fr_BE Belgium (French)
en_CA Canada
fr_CA Canada (French)
zh_CN China
fr_FR France
de_DE Germany
zh_HK Hong Kong
en_IN India
en_IE Ireland
it_IT Italy
nl_NL Netherlands
en_SG Singapore
es_ES Spain
de_CH Switzerland
en_GB United Kingdom
en_US United States

See Tags for the Identification of Languages.

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., 859). The version you specify for a call has these basic effects:
  • It indicates the version of the code lists and other data that eBay should use to process your request.
  • It indicates the schema version you are using.
You need to use a version that is greater than or equal to the lowest supported version.
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:
    Routing the Request (Gateway URLs)
    eBay Schema Versioning Strategy
    Lowest Supported Version

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
(in) The WarningLevel value is set to 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
(in) The WarningLevel value is set to 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
Call-specific Output Fields [Jump to standard fields]
EndTime dateTime Always This timestamp indicates the date and time (returned in GMT) when the specified eBay listing was ended.
Standard Output Fields  
Ack AckCodeType Always A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for the Ack field.

Applicable values:

CustomCode
(out) Reserved for internal or future use.
Failure
(out) This value indicates that the call request processing failed.
Success
(out) This value indicates that the call request was processed successfully without any issues.
Warning
(out) This value indicates that the call request was successful, but processing was not without any issues. These issues can be checked in the Errors container, that will also be returned when one or more known issues occur with the call request.

(Not all values in AckCodeType apply to this field.)

Code so that your app gracefully handles any future changes to this list.
Build string Always This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues.
CorrelationID string Conditionally 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.
Errors ErrorType Conditionally,
repeatable: [0..*]
A list of application-level errors (if any) that occurred when eBay processed the request.

See Error Handling.

Errors.ErrorClassification ErrorClassificationCodeType Conditionally API errors are divided between two classes: system errors and request errors.

Applicable values:

CustomCode
(out) Reserved for internal or future use.
RequestError
(out) An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data.
SystemError
(out) Indicates that an error has occurred on the eBay system side, such as a database or server down. 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.

Code so that your app gracefully handles any future changes to this list.
Errors.ErrorCode token Conditionally A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. See the "Errors by Number" document.
Errors.ErrorParameters ErrorParameterType Conditionally,
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.
Errors.ErrorParameters
  [ 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.
Errors.ErrorParameters.Value string Conditionally This is the value of the request parameter noted in the ParamID attribute. So, if the ParamID value was ItemID, the value in this field would be the actual value of that ItemID.
Errors.LongMessage string Conditionally A more detailed description of the condition that raised the error.
Errors.SeverityCode SeverityCodeType Conditionally Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user.

Applicable values:

CustomCode
(out) Reserved for internal or future use.
Error
(out) The request that triggered the error was not processed successfully. When a serious application-level error occurs, the error is returned instead of the business data.

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 Compatible Application Check section of the eBay Features Guide for more information.
Warning
(out) The request was processed successfully, but something occurred that may affect your application or the user. For example, eBay may have changed a value the user sent in. In this case, eBay returns a normal, successful response and also returns the warning.

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.
Errors.ShortMessage string Conditionally A brief description of the condition that raised the error.
HardExpirationWarning string Conditionally Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token.
Message string Conditionally Supplemental information from eBay, if applicable. May elaborate on errors (such as how a listing violates eBay policies) or provide useful hints that may help a seller increase sales. This data can accompany the call's normal data result set or a result set that contains only errors.

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>...).

See Standard Data for All Calls.

Timestamp dateTime Always This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See the Time Values section in the eBay Features Guide for information about this time format and converting to and from the GMT time zone.

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.
Version string Always The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See the Standard Data for All Calls section in the eBay Features Guide for information on using the response version when troubleshooting CustomCode values that appear in the response.



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.

Available samples:

Sample: Basic Call

The following sample shows how to end a listing.

Description

Magical Bookseller 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, Magical Bookseller 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>ABC...123</eBayAuthToken>
  </RequesterCredentials>
  <ItemID>110025786968</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>2015-08-08T19:21:18.423Z</Timestamp>
  <Ack>Success</Ack>
  <Version>967</Version>
  <Build>e967_core_Bundled_7010443_R1</Build>
  <EndTime>2015-08-08T19:21:18.000Z</EndTime>
</EndItemResponse>

Back to list of samples

Sample: Sell to Highest Bidder

The sellers ends the item listing by selling the item to the current high bidder.

Description

Magical Bookseller listed a Harry Potter book, and she recieved a nice bid on the volume. Wanting to move inventory, she decides to end the auction early by selling the book to the current high bidder.

Input

Magical Bookseller has the option to terminate her Chinese auction early by selling her item to the current high bidder. To do so, she calls EndItem and sets the EndingReason field to SellToHighBidder. This action terminates the auction with a sale.

XML format.

<?xml version="1.0" encoding="utf-8"?>
<EndItemRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>ABC...123</eBayAuthToken>
  </RequesterCredentials>
  <ItemID>110043671232</ItemID>
  <EndingReason>SellToHighBidder</EndingReason>
</EndItemRequest>

Output

The call returns Success in the Ack field, indicating that the call was successful.

XML format.
<EndItemResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2016-02-17T17:32:41.733Z</Timestamp>
  <Ack>Success</Ack>
  <Version>967</Version>
  <Build>E967_CORE_BUNDLED_10639415_R1</Build>
  <EndTime>2016-02-17T17:32:40.000Z</EndTime>
</EndItemResponse>

Back to list of samples



Change History

Change Date Description
511
2007-05-02
  • EndItemRequestType (doc change): EndItem does not require users to manually cancel bids beforehand. If an item listing has bids (and the item is not in the last 12 hours of an auction), ending the item with an EndingReason of SellToHighBidder sells the item to the high bidder. Ending the item with any other EndingReason value will automatically cancel bids.
481
2006-10-04
  • EndReasonCodeType.SellToHighBidder (added): Enables the seller to specify that the listed item is sold to the highest bidder (a transaction is created).
1077
2018-08-31
  • EndingReason (doc change): Noted that the new enumeration value, ProductDeleted, can only be used by eBay, and not by sellers to end a listing.
1027
2017-08-04
  • EndItemRequestType.SellerInventoryID (deprecated): This field is being deprecated. It is exclusively for Half.com listings, and API support for Half.com listings is being deprecated.