AddSecondChanceItem
Use this call to create a Second Chance Offer (that is, an offer for an unsold item) for one of that item's non-winning bidders.
AddSecondChanceItem creates a special type of listing in which only the specified Second Chance Offer recipient may purchase the item. The recipient who is chosen by the seller must be one of the non-winning bidders from the ended listing. The listing must have ended with a winning bidder, but the item did not sell for some reason. For example, the winning bidder, for whatever reason, did not purchase the item. Alternately, the seller may offer an item that is similar to the one previously listed as a Second Chance Offer item. In this case, the specified recipient may be either one of the non-winning bidders, or the winning bidder in the ended listing.
Use GetAllBidders to retrieve a list of bidders from the item that ended. The seller needs to select the recipient for the Second Chance Offer from this list.
For general information on Second Chance Offers and more detailed information on using AddSecondChanceItem, see Making Second Chance Offers for Items.
Usage Details
To call AddSecondChanceItem, the requestor must be the one who listed the original item and the item must meet the Second Chance Offer eligibility requirements (see Determining Item Eligibility for a Second Chance Offer).
AddSecondChanceItem takes as input the following values:
- ItemID - The original listing's item ID.
- RecipientBidderUserID - The eBay user ID for the recipient of the offer.
- Duration - The length of time the offer is valid.
- SellerMessage - Optionally, a message to the buyer.
If the call is successful, it returns the following information:
- ItemID - The new listing's item ID.
- StartTime - The start date and time for the listing.
- EndTime - The date and time the listing ends.
When you create a Second Chance Offer, eBay sends the recipient a message letting them know that the offer has been made. The price of the offer is normally set to the highest bid the recipient made on the original item.
Note that sending a Second Chance Offer, a new listing is not created on the eBay site. Instead, a special item is created for the targeted buyer. If you want to relist an item, use RelistItem, this can help to save on relisting fees.
Use VerifyAddSecondChanceItem to test an item's definition before calling AddSecondChanceItem. This can reduce the number of item listing errors the application needs to handle.
Testing AddSecondChanceItem
You can test AddSecondChanceItem in the Sandbox environment. To test the call, you need three or more test users. One test user is needed to act as the seller, the others act as bidders.
- List an auction item using a test user account.
- Have two or more other test users submit bids on the item. This can be done in the Sandbox UI (
http://sandbox.ebay.com
). - Have the seller end the item early using EndItem with EndingReason set to
SellToHighBidder
, which results in the listing ending as a successfully concluded auction with a winning bidder. - Call AddSecondChanceItem to extend a Second Chance Offer to one of the non-winning test users that bid on the item.
- Use an item data retrieval call (like GetSellerList or GetItem) to retrieve the data for the Second Chance Offer you just created. Verify that the listing has all of the desired values, including the value in the Item.ListingDetails.SecondChanceOriginalItemID property: it should contain the item ID for the original listing.
Optionally perform a search using findItemsAdvanced (Finding API). This search should use criteria that would definitely find the item.
Related Information
See Second chance offers.
See also the reference documentation for this call:
- VerifyAddSecondChanceItem - Simulates the creation of a new Second Chance Offer listing of an item without actually creating a listing.
Output Detail Controls Samples Change History |
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"?> <AddSecondChanceItemRequest xmlns="urn:ebay:apis:eBLBaseComponents"> <!-- Call-specific Input Fields --> <BuyItNowPrice> AmountType (double) </BuyItNowPrice> <Duration> SecondChanceOfferDurationCodeType </Duration> <ItemID> ItemIDType (string) </ItemID> <RecipientBidderUserID> UserIDType (string) </RecipientBidderUserID> <SellerMessage> string </SellerMessage> <!-- Standard Input Fields --> <ErrorLanguage> string </ErrorLanguage> <MessageID> string </MessageID> <Version> string </Version> <WarningLevel> WarningLevelCodeType </WarningLevel> </AddSecondChanceItemRequest>
Argument | Type | Occurrence | Meaning |
---|
Call-specific Input Fields [Jump to standard fields] |
BuyItNowPrice | AmountType (double) | Optional | The amount the offer recipient must pay to purchase the item as a Second Chance Offer. This field should only be used when the original item was listed in an eBay Motors vehicle category (or in some categories on U.S. and international sites for high-priced items, such as items in many U.S. and Canada Business and Industrial categories) and it ended unsold because the reserve price was not met. Otherwise, eBay establishes the price and no price should be submitted. The price offered to the Second Chance Offer recipient is generally the highest bid that the user made on the original listing. |
Duration | SecondChanceOfferDurationCodeType | Required |
This enumeration value indicates the length of time (in days) that the Second Chance Offer will be available to the recipient. Upon receiving the Second Chance Offer, the recipient bidder will have this many days to accept the offer before the offer expires. One of the values in SecondChanceOfferDurationCodeType must be used.
Applicable values: |
ItemID | ItemIDType (string) | Required | This field is used to identify the original auction listing through its unique identifier (Item ID). Upon a successful call, the Second Chance Offer will be identified by a new ItemID in the response. |
RecipientBidderUserID | UserIDType (string) | Required | This field is used to specify the bidder that is being offered the Second Chance Offer. The eBay User ID of the bidder is used in this field. Specify only one RecipientBidderUserID per call. If multiple users are specified, only the last one specified receives the offer. User ID values will be returned in the Offer.User.UserID field of the GetAllBidders call response. |
SellerMessage | string | Optional |
This optional field is used to provide a message to the recipient of the Second Chance Offer. This message cannot contain HTML, asterisks, or quotes. The content in this field will be included in the Second Chance Offer email that is sent to the recipient. Max length: 1000. |
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. 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. |
Input Detail Controls Samples Change History |
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"?> <AddSecondChanceItemResponse xmlns="urn:ebay:apis:eBLBaseComponents"> <!-- Call-specific Output Fields --> <EndTime> dateTime </EndTime> <ItemID> ItemIDType (string) </ItemID> <StartTime> dateTime </StartTime> <!-- Standard Output Fields --> <Ack> AckCodeType </Ack> <Build> string </Build> <CorrelationID> string </CorrelationID> <DuplicateInvocationDetails> DuplicateInvocationDetailsType <DuplicateInvocationID> UUIDType (string) </DuplicateInvocationID> <InvocationTrackingID> string </InvocationTrackingID> <Status> InvocationStatusType </Status> </DuplicateInvocationDetails> <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> </AddSecondChanceItemResponse>
Return Value | Type | Occurrence | Meaning |
---|
Call-specific Output Fields [Jump to standard fields] |
EndTime | dateTime | Always | This timestamp indicates the date and time when the Second Chance Offer listing will expire, at which time the recipient will no longer be able to purchase the item. |
ItemID | ItemIDType (string) | Always | This field contains the Item ID for the Second Chance Offer that was just created with the AddSecondChanceItem call. Note that this Item ID will be different from the Item ID in the original auction listing that was passed in the request. |
StartTime | dateTime | Always | This timestamp indicates the date and time when the Second Chance Offer became available to the recipient. |
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: (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. |
DuplicateInvocationDetails | DuplicateInvocationDetailsType | Conditionally | Information that explains a failure due to a duplicate InvocationID being passed in. |
DuplicateInvocationDetails .DuplicateInvocationID |
UUIDType (string) | Conditionally | This value represents the duplicate InvocationID or InvocationTrackingID that was used in the call request. |
DuplicateInvocationDetails .InvocationTrackingID |
string | Conditionally | This unique identifier identifies the business item the previous API invocation created. For example, the Item ID of the item created by an AddItem call. |
DuplicateInvocationDetails .Status |
InvocationStatusType | Conditionally |
This enumeration value indicates the status of the previous call that used the InvocationID or InvocationTrackingID specified in the DuplicateInvocationID.
Applicable values: Code so that your app gracefully handles any future changes to this list. |
Errors | ErrorType | Conditionally,
repeatable: [0..*] |
A list of application-level errors (if any) that occurred when eBay processed the request. |
Errors.ErrorClassification | ErrorClassificationCodeType | Conditionally |
API errors are divided between two classes: system errors and request errors.
Applicable values: 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 Errors By Number. |
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: If the source of the problem is within the application (such as a missing required element), change the application before you retry the request.
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. |
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 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. |
Input Output Samples Change History |
Detail Controls
DetailLevel
This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.
Input Output Detail Controls Change History |
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.
Extends a Second Chance Offer to a bidder that did not win the auction.
Description
The prospective buyer (b************r) bid on a book, but did not win the auction. The seller (M*****l B********r) came across another copy of the book in the same condition and decided to offer the second copy to the second-highest bidder, b************r.
When a Second Chance Offer is created, the recipient is given a chance to purchase the item at the highest price that they bid on the original item. eBay sends the buyer a message stating that the Second Chance Offer has been made, along with any message the seller included in the offer.
Input
XML format.
<?xml version="1.0" encoding="utf-8"?>
<AddSecondChanceItemRequest xmlns="urn:ebay:apis:eBLBaseComponents">
<RequesterCredentials>
<eBayAuthToken>A*******3</eBayAuthToken>
</RequesterCredentials>
<!-- The user ID of an user who made a bid on the auction item. The GetAllBidders call can be used to get bidders on a listing -->
<RecipientBidderUserID>b************r</RecipientBidderUserID>
<!-- The offer duration must be one of the values defined in SecondChanceOfferDurationCodeType -->
<Duration>Days_3</Duration>
<ItemID>1**********1</ItemID>
<SellerMessage>
I just got another copy of the book in stock, would
you be interested in purchasing the copy?
</SellerMessage>
</AddSecondChanceItemRequest>
Output
XML format.
<AddSecondChanceItemResponse xmlns="urn:ebay:apis:eBLBaseComponents">
<Timestamp>2015-12-22T17:45:31.032Z</Timestamp>
<Ack>Success</Ack>
<Version>967</Version>
<Build>E967_CORE_BUNDLED_10284414_R1</Build>
<ItemID>1**********4</ItemID>
<StartTime>2015-12-22T17:45:30.000Z</StartTime>
<EndTime>2015-12-25T17:45:30.000Z</EndTime>
</AddSecondChanceItemResponse>
Input Output Detail Controls Samples |
Change History
Change Date | Description |
---|---|
529 2007-09-05 |
|
499 2007-02-07 |
|
479 2006-09-20 |
|
457 2006-04-19 |
|
449 2006-02-22 |
|
409 2005-5-18 |
|