EndFixedPriceItem

Ends the specified fixed-price listing before the date and time at which it would normally end (per the listing duration).

Only the item's seller can use EndFixedPriceItem to end an item listing.

You can also use EndItem to end fixed-price listings. EndFixedPriceItem is nearly identical to EndItem, but EndFixedPriceItem also accepts a seller's SKU to identify the listing (if the seller listed the item with SKU-based inventory tracking). Note: When you use EndFixedPriceItem within a Merchant Data file, it must be enclosed within two BulkDataExchangeRequest tags. After release 637, a namespace is returned in the BulkDataExchangeResponseType (top level) of the response. The BulkDataExchange tags are not shown in the call input/output descriptions, but you can see them in the samples at the end of this page.

See Ending Items 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).
RelistFixedPriceItem - Enables a seller to take a single item (or a single multi-item listing) and relist it on a specified eBay site. If the listing ended with no buyers, the relisted item may be eligible for a relist credit for the insertion fee under some conditions.

EndFixedPriceItem 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"?>
<EndFixedPriceItemRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
  <!-- Call-specific Input Fields -->
  <EndingReason> EndReasonCodeType </EndingReason>
  <ItemID> ItemIDType (string) </ItemID>
  <SKU> SKUType (string) </SKU>
</EndFixedPriceItemRequest>

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
EndingReason	EndReasonCodeType	Required	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. 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.
ItemID	ItemIDType (string)	Conditional	Unique item ID that identifies the item listing that you want to end.. In the EndFixedPriceItem request, either ItemID or SKU is required. If both are passed in and they don't refer to the same listing, eBay ignores SKU and considers only the ItemID. Max length: 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits).
SKU	SKUType (string)	Conditional	The unique SKU of the item being ended. A SKU (stock keeping unit) is an identifier defined by a seller. SKU can only be used to end an item if you listed the item by using AddFixedPriceItem or RelistFixedPriceItem, and you set Item.InventoryTrackingMethod to SKU at the time the item was listed. (These criteria are necessary to uniquely identify the listing by a SKU.) In the EndFixedPriceItem request, either ItemID or SKU is required. If both are passed in and they don't refer to the same listing, eBay ignores SKU and considers only the ItemID. To remove a SKU when you revise or relist an item, use DeletedField in the revision or relist call. Max length: 50.

EndFixedPriceItem 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"?>
<EndFixedPriceItemResponse 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 -->
  <SKU> SKUType (string) </SKU>
</EndFixedPriceItemResponse>

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
SKU	SKUType (string)	Conditionally	The SKU (stock-keeping unit) that the seller specified for the listing, if any. Max length: 50.

EndFixedPriceItem Detail Controls

Detail Control: DetailLevel

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

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

Available samples:

Basic Call ↓ - The following sample shows how to end a fixed-price listing.
End Multiple Listings in Bulk (for Large Merchants) ↓ - Identifies items that will be removed from the eBay site with the Large Merchant Services solution. This sample demonstrates a data file that you would zip and then upload using the Bulk Data Exchange API and File Transfer API. (You cannot do bulk uploads with the Trading API.)

Sample: Basic Call

The following sample shows how to end a fixed-price listing.

Description

A salesperson from megaonlinemerchant has determined that some of the details in a fixed price listing are incorrect. As the listing already has some transactions, he can't correct the necessary details. To avoid confusing buyers and risking concerns that the items are not as he describes, he decides to end the listing (and he'll later create a new one).

Input

The request include the ItemID of the listing, and the reason he wants to end it.

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

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

Output

The response indicates that the listing was ended successfully, and it shows the time the listing was ended.

As a result of successfully submitting this request, eBay's View Item page and GetItem show buyers that the listing has ended.

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

<?xml version="1.0" encoding="utf-8"?>
<EndFixedPriceItemResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2009-02-12T07:56:58.154Z</Timestamp>
  <Ack>Success</Ack>
  <Version>615</Version>
  <Build>e615_core_Bundled_7934516_R1</Build>
  <EndTime>2009-02-12T07:56:57.000Z</EndTime>
</EndFixedPriceItemResponse>

Back to list of samples

Sample: End Multiple Listings in Bulk (for Large Merchants)

Identifies items that will be removed from the eBay site with the Large Merchant Services solution. This sample demonstrates a data file that you would zip and then upload using the Bulk Data Exchange API and File Transfer API. (You cannot do bulk uploads with the Trading API.)

Description

A salesperson from megaonlinemerchant wants to remove one of her listings of shoes from the eBay US site, because she has agreed to donate them to the Boys and Girls' Club in her neighborhood. She creates a data file with the information about the listing she wants to remove.

As a result of this call, megaonlinemerchant has removed a listing for the Nike Shox on eBay. You can call GetItem with the ItemID found in the EndFixedPriceItem response to confirm that the shoes have been removed.

Note: This sample shows the data file format that you use when you upload multiple EndFixedPriceItem requests in a .zip file by using the File Transfer API and Bulk Data Exchange API. See Large Merchant Services for information about uploading and managing inventory changes in bulk.

Input

The following EndFixedPriceItem request sample contains the SKU for the shoes that megaonlinemerchant's wants to remove, and the reason for removing them from the site. In this sample, we have included a basic EndFixedPricedItem request. However, in a single data file, you can include thousands of listings.

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

<?xml version="1.0" encoding="utf-8"?>
<BulkDataExchangeRequests xmlns="urn:ebay:apis:eBLBaseComponents">
  <Header>
    <Version>583</Version>
    <SiteID>0</SiteID>
  </Header>
 <EndFixedPriceItemRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <ErrorLanguage>en_US</ErrorLanguage>
  <WarningLevel>High</WarningLevel>
  <Version>583</Version>
    <SKU>1122334455-17</SKU>
    <EndingReason>NotAvailable</EndingReason>
 </EndFixedPriceItemRequest>
</BulkDataExchangeRequests>

Output

A successful response includes the the ItemID, the seller's SKU, and the time that the listing ended.

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

<?xml version="1.0" encoding="utf-8"?>
<BulkDataExchangeResponses xmlns="urn:ebay:apis:eBLBaseComponents">
  <EndFixedPriceItemResponse xmlns="urn:ebay:apis:eBLBaseComponents">
   <Timestamp>2009-10-02T01:15:16.008Z</Timestamp>
   <Ack>Success</Ack>
   <Version>637</Version>
   <Build>e637_core_API_7225127_R1</Build>
   <EndTime>2008-12-02T01:15:15.000Z</EndTime>
   <SKU>1122334455-17</SKU>
  </EndFixedPriceItemResponse>
</BulkDataExchangeResponses>

Back to list of samples

EndFixedPriceItem Change History

Version	Description
615 2008-04-29	(added) Call moved from Merchant Data API to Trading API.
589 2008-11-29	(added) New call in Merchant Data API.

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