EndItems

Use this call to explicitly end multiple active item listings before they would ordinarily end (per the listing duration). You can specify up to ten listings to end in a single request.

This call works just like EndItem, the logic and restrictions that apply to EndItem apply equally to EndItems. The only difference is that this call lets you specify an array of EndItemRequestContainer nodes. Each EndItemRequestContainer is like a separate EndItem call, containing ItemID and EndingReason fields.

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. EndItems provides the means for ending multiple listings before any of these natural conditions occur to end the listings.

See Ending Listings Early for details on the effects of ending a listing early, and more on when it is required to specify a reason for ending the listing.

Usage Details

Only the item's seller can use EndItems to end item listings. In the call, specify the item IDs for the active listings you want to end.

For competitive-bid item listings that have bids on them (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. If a listing has no qualifying bids when you call EndItems, the listing also ends as an unsuccessful auction.

There are two restrictions for ending items early in the last 12 hours of a listing. First, if there is a qualified bid in the last 12 hours of a listing, the seller cannot end the item early. Second, 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 for each ended listing, which is the official date and time (in GMT) that the listing was ended. Ending an item with EndItems triggers an ItemUnsold notification or Client Alert, if the seller is subscribed to that notification.

Testing EndItems

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

1. In the Sandbox, use AddItem to list several items that can be ended early with EndItems.
2. Call EndItems with the item IDs and review the results.
3. Next, add several items to the Sandbox, and have a different users place bids on the items.
4. Test setting EndingReason to SellToHighBidder to successfully sell one 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:

• EndItem - Ends the specified item listing before the date and time at which it would normally end per the listing duration.
• EndFixedPriceItem - Ends the specified fixed-price listing before the date and time at which it 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"?>
<EndItemsRequest xmlns="urn:ebay:apis:eBLBaseComponents">
 <!-- Call-specific Input Fields -->
 <EndItemRequestContainer> EndItemRequestContainerType
 <EndingReason> EndReasonCodeType </EndingReason>
 <ItemID> ItemIDType (string) </ItemID>
 <MessageID> string </MessageID>
 </EndItemRequestContainer>
 <!-- ... more EndItemRequestContainer nodes allowed here ... -->
 <!-- Standard Input Fields -->
 <ErrorLanguage> string </ErrorLanguage>
 <MessageID> string </MessageID>
 <Version> string </Version>
 <WarningLevel> WarningLevelCodeType </WarningLevel>
</EndItemsRequest>

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"?>
<EndItemsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
 <!-- 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 allowed here ... -->
 <LongMessage> string </LongMessage>
 <SeverityCode> SeverityCodeType </SeverityCode>
 <ShortMessage> string </ShortMessage>
 </Errors>
 <!-- ... more Errors nodes allowed here ... -->
 </EndItemResponseContainer>
 <!-- ... more EndItemResponseContainer nodes allowed here ... -->
 <!-- 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>
 <Timestamp> dateTime </Timestamp>
 <Version> string </Version>
</EndItemsResponse>

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.

Defines and ends multiple items listed on the eBay site.

Description

User m***************r 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 m***************r's Harry Potter books.

XML format.
<?xml version="1.0" encoding="utf-8" ?>
<EndItemsRequest xmlns="urn:ebay:apis:eBLBaseComponents">
 <RequesterCredentials>
 <eBayAuthToken>A*******3</eBayAuthToken>
 </RequesterCredentials>
 <EndItemRequestContainer>
 <MessageID>***1</MessageID>
 <EndingReason>LostOrBroken</EndingReason>
 <ItemID>1**********5</ItemID>
 </EndItemRequestContainer>
 <EndItemRequestContainer>
 <MessageID>***2</MessageID>
 <EndingReason>LostOrBroken</EndingReason>
 <ItemID>1**********6</ItemID>
 </EndItemRequestContainer>
</EndItemsRequest>

Output

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

XML format.
<?xml version="1.0" encoding="utf-8"?>
<EndItemsResponse 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>
 <EndItemResponseContainer>
 <EndTime>2019年11月04日T17:33:35.145Z</EndTime>
 <CorrelationID>*1</CorrelationID>
 </EndItemResponseContainer>
 <EndItemResponseContainer>
 <EndTime>2019年11月04日T17:33:35.145Z</EndTime>
 <CorrelationID>*2</CorrelationID>
 </EndItemResponseContainer>
</EndItemsResponse>

Change History