EndItems - Call Reference - eBay Trading API

EndItems

Ends the specified item listings before the date and time at which it would normally end (per the listing duration). As many as ten (10) listings can be ended per request.

For competitive-bidding listings that have bids on them, you must specify an EndingReason value. If you specify SellToHighBidder, the listing ends as a successful auction with winning bidder(s). Otherwise, all bids are cancelled before the item is ended.

There are two restrictions for ending items early in the last 12 hours of a listing. If there is a qualified bid (i.e., current high bid that, when applicable, meets the minimum reserve price) in the last 12 hours of a listing, the seller cannot end the item early. If the seller has cancelled a bid in the last 12 hours of the listing, the seller cannot end the item early.

Only the item's seller can use EndItems to end an item listings.

See Ending Items Early.

See also the reference documentation for these calls:

AddItems - Defines one to five items and lists them on a specified eBay site. Returns the item ID for each. Returns fees the seller will incur for each listing (not including the Final Value Fee, which cannot be calculated until the item is sold).
EndItem - Ends the specified item listing before the date and time at which it would normally end (per the listing duration).
RelistItem - Enables a seller to take a single item (or a single multi-item listing) that ended without bidders or buyers and re-list it on a specified eBay site.

EndItems Input

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

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"?>
<EndItemsRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
  <!-- Call-specific Input Fields -->
  <EndItemRequestContainer> EndItemRequestContainerType 
    <EndingReason> EndReasonCodeType </EndingReason>
    <ItemID> ItemIDType (string) </ItemID>
    <MessageID> string </MessageID>
  </EndItemRequestContainer>
  <!-- ... more EndItemRequestContainer nodes here ... -->
</EndItemsRequest>

Argument	Type	Occurrence	Meaning

Standard Input Fields [Jump to call-specific 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 ----- ----- de_AT Austria de_CH Switzerland de_DE Germany en_AU Australia en_CA Canada en_GB United Kingdom en_SG Singapore en_US United States es_ES Spain fr_BE Belgium (French) fr_CA Canada (French) fr_FR France it_IT Italy nl_BE Belgium (Dutch) nl_NL Netherlands zh_CN China en_IN India en_IE Ireland zh_HK Hong Kong See Tags for the Identification of Languages.
MessageID	string	Optional	In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage 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, 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., 549). 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: HTTP Headers (XML API Only) 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 in your production code. Applicable values: • High (in) Return warnings when the application passes unrecognized or deprecated elements in a request. • Low (in) Do not return warnings when the application passes unrecognized or deprecated elements in a request. This is the default value if WarningLevel is not specified. See Warning Level.

Call-specific Input Fields
EndItemRequestContainer	EndItemRequestContainerType	Required, repeatable: [1..10]	A single container for an end item request. Multiple containers should be used to end multiple items. Up to ten (10) containers can be included per a given EndItems request.
EndItemRequestContainer .EndingReason	EndReasonCodeType	Conditional	Indicates the seller's reason for ending the listing early. This field is required if the seller is ending the item early and the item did not successfully sell. Also applicable to Half.com. Applicable values: • CustomCode (in) Reserved for internal or future use. • Incorrect (in) The start price or reserve price is incorrect. • LostOrBroken (in) The item was lost or broken. • NotAvailable (in) The item is no longer available for sale. • OtherListingError (in) The listing contained an error (other than start price or reserve price). • SellToHighBidder (in) The listing has qualifying bids (i.e., there is a current high bid that, when applicable, meets the minimum reserve price) and there are more than 12 hours before the listing ends. Sell the item to the highest eligible bidder. In the last 12 hours of an item listing, you cannot end an item early if it has bids. • Sold (in) The vehicle was sold. Applies to local classified listings for vehicles only.
EndItemRequestContainer.ItemID	ItemIDType (string)	Required	Unique item ID that identifies the item listing to end. Also applicable to Half.com. For Half.com listings, you can either specify ItemID or SellerInventoryID. For eBay Live Auctions, you cannot delete items that have been closed or that are part of a Live Auction event that has started. Max length: 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits).
EndItemRequestContainer .MessageID	string	Optional	The MessageID element is used to correlate a given EndItemRequestContainer in the request with the corresponding EndItemResponseContainer in the response. If you pass a message ID in a request container, the same value is returned in the CorrelationID field in the matching response container. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned.

EndItems Output

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

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

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"?>
<EndItemsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- 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 here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
  <!-- Call-specific Output Fields -->
  <EndItemResponseContainer> EndItemResponseContainerType 
    <CorrelationID> string </CorrelationID>
    <EndTime> dateTime </EndTime>
    <Errors> ErrorType 
      <ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
      <ErrorCode> token </ErrorCode>
      <ErrorParameters ParamID="string"> ErrorParameterType 
        <Value> string </Value>
      </ErrorParameters>
      <!-- ... more ErrorParameters nodes here ... -->
      <LongMessage> string </LongMessage>
      <SeverityCode> SeverityCodeType </SeverityCode>
      <ShortMessage> string </ShortMessage>
    </Errors>
    <!-- ... more Errors nodes here ... -->
  </EndItemResponseContainer>
  <!-- ... more EndItemResponseContainer nodes here ... -->
</EndItemsResponse>

Return Value	Type	Occurrence	Meaning

Standard Output Fields [Jump to call-specific 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 Ack. Applicable values: • CustomCode (out) Reserved for internal or future use. • Failure (out) Request processing failed • Success (out) Request processing succeeded • Warning (out) Request processing completed with warning information being included in the response message (Not all values in AckCodeType apply to this field.)
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	In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage 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, 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.
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	The index of the parameter in the list of parameter types returned within the error type.
Errors.ErrorParameters.Value	string	Conditionally	The value of the variable (e.g., the attribute set ID)
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) Application-level error • Warning (out) Warning or informational error
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.
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 Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage 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 "Standard Data for All Calls" in the eBay Web Services Guide for information on using the response version when troubleshooting "CustomCode" values that appear in the response.

Call-specific Output Fields
EndItemResponseContainer	EndItemResponseContainerType	Always, repeatable: [1..*]	Returns a response for an individually ended item. Mutiple containers will be listed if multiple items are ended.
EndItemResponseContainer .CorrelationID	string	Conditionally	CorrelationID is used to correlate a given EndItemRequestContainer in the request with the corresponding EndItemResponseContainer in the response. If you pass a message ID in a request container, the same value is returned in the CorrelationID field in the matching response container. You can use this for tracking that a response container is returned for every request container and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned.
EndItemResponseContainer .EndTime	dateTime	Always	Indicates the date and time (returned in GMT) the specified item listing was ended. Also applicable to Half.com.
EndItemResponseContainer .Errors	ErrorType	Conditionally, repeatable: [0..*]	A list of application-level errors or warnings (if any) that were raised when eBay processed the request. Application-level errors occur due to problems with business-level data on the client side or on the eBay server side. For example, an error would occur if the request contains an invalid combination of fields, or it is missing a required field, or the value of the field is not recognized. An error could also occur if eBay encountered a problem in our internal business logic while processing the request. Only returned if there were warnings or errors.
EndItemResponseContainer .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.
EndItemResponseContainer .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.
EndItemResponseContainer .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.
EndItemResponseContainer .Errors.ErrorParameters [ attribute ParamID ]	string	Conditionally	The index of the parameter in the list of parameter types returned within the error type.
EndItemResponseContainer .Errors.ErrorParameters.Value	string	Conditionally	The value of the variable (e.g., the attribute set ID)
EndItemResponseContainer .Errors.LongMessage	string	Conditionally	A more detailed description of the condition that raised the error.
EndItemResponseContainer .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) Application-level error • Warning (out) Warning or informational error
EndItemResponseContainer .Errors.ShortMessage	string	Conditionally	A brief description of the condition that raised the error.

EndItems Detail Controls

Detail Control: DetailLevel

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

EndItems Samples

New to making API calls? Please see Routing the Request.

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.

Sample: Basic Call

Defines and ends multiple items listed on the eBay site.

Description

User magicalbookseller just spilled water all over her inventory of Harry Potter books. In a sincere effort to not mislead buyers she needs to end several listings. Using EndItems she is able to quickly end multiple listings, save time, and prevent a potential catastrophe with her buyers.

Input

All fields in the following EndItems request sample are the basic input to end a batch listing for magicalbookseller's Harry Potter books.

XML format (HTTP POST). Also available is the .txt version of this XML.

<?xml version="1.0" encoding="utf-8" ?>
<EndItemsRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <ErrorLanguage>en_US</ErrorLanguage>
  <WarningLevel>High</WarningLevel>
  <EndItemRequestContainer>
    <MessageID>1</MessageID>
    <EndingReason>LostOrBroken</EndingReason>
    <ItemID>190001224035</ItemID>
  </EndItemRequestContainer>
  <EndItemRequestContainer>
    <MessageID>2</MessageID>
    <EndingReason>LostOrBroken</EndingReason>
    <ItemID>190001224036</ItemID>
  </EndItemRequestContainer>
  <RequesterCredentials>
        <eBayAuthToken>ABC...123</eBayAuthToken>
  </RequesterCredentials>
</EndItemsRequest>

Output

The response includes the EndTime and the CorrelationID used in the end items request.

XML format. Also available is the .txt version of this XML.

<?xml version="1.0" encoding="utf-8"?>
<EndItemsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2008-10-01T21:56:07.014Z</Timestamp>
  <Ack>Success</Ack>
  <Version>585</Version>
  <Build>e585_core_Bundled_7337210_R1</Build>
  <EndItemResponseContainer>
    <EndTime>2008-10-01T21:57:01.000Z</EndTime>
    <CorrelationID>1</CorrelationID>
  </EndItemResponseContainer>
  <EndItemResponseContainer>
    <EndTime>2008-10-01T21:57:01.000Z</EndTime>
    <CorrelationID>2</CorrelationID>
  </EndItemResponseContainer>
</EndItemsResponse>

EndItems Change History

Version	Description
595 2008-12-10	EndItemRequestContainer.MessageID (doc change): EndItemRequestContainer.MessageID is optional input for this call. This field had been omitted inadvertently from the documentation.
585 2008-10-01	(added) New call.

This document was generated with a customized version of the apireferencedocs tool.

eBay Trading API Call Reference Version 643

eBay Trading API
Call Reference Version 643