AddToItemDescription

Sellers use this call to add text to the end of the item description section of a listing. You can append text to an item description if you are the item's seller and if there are 12 or more hours remaining in the auction. Text added to a description must abide by all the rules for item descriptions (for example, JavaScript is not allowed). In general, your application should not use AddToItemDescription as part of its standard listing process.

AddToItemDescription appends text to the listing's description--it does not modify the existing description. To change the description text in its entirety, use ReviseItem.

Usage Details

When calling AddToItemDescription, specify the item ID for the active listing you want to modify, as well as the text that you want to append to the listing's description. The response consists only of the standard values defined in the abstract response object; there are no call-specific values returned.

You cannot use AddToItemDescription to modify the description of an eBay Giving Works listing (for more on eBay Giving Works, see Charitable listings).

Testing AddToItemDescription

Test AddToItemDescription in the Sandbox:

1. Use AddItem to list an item on the My eBay Sandbox page (http://sandbox.ebay.com) and get the ItemID value.
2. Test adding data to a listing's description multiple times, both to ensure the application can accommodate this use case and to see the effects of multiple description changes.
3. Use an item retrieving call (such as GetSellerList) to view the modified listing both before and after you make changes with AddToItemDescription.

Related Information

See Revise a listing.

See also the reference documentation for these calls:

• ReviseItem - Enables a seller to revise a listing on a specified eBay site.
• ReviseFixedPriceItem - Enables a seller to revise a fixed-price listing on a specified eBay site.

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"?>
<AddToItemDescriptionRequest xmlns="urn:ebay:apis:eBLBaseComponents">
 <!-- Call-specific Input Fields -->
 <Description> string </Description>
 <ItemID> ItemIDType (string) </ItemID>
 <!-- Standard Input Fields -->
 <ErrorLanguage> string </ErrorLanguage>
 <InvocationID> UUIDType (string) </InvocationID>
 <MessageID> string </MessageID>
 <Version> string </Version>
 <WarningLevel> WarningLevelCodeType </WarningLevel>
</AddToItemDescriptionRequest>

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"?>
<AddToItemDescriptionResponse xmlns="urn:ebay:apis:eBLBaseComponents">
 <!-- (No call-specific Output fields) -->
 <!-- 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>
 <Message> string </Message>
 <Timestamp> dateTime </Timestamp>
 <Version> string </Version>
</AddToItemDescriptionResponse>

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.

Append text to the bottom of an item's description.

Input

Seller m***************r wants to update the listing for her Harry Potter book. AddToItemDescription makes use of two call-specific input fields, both of which must be supplied in the call: ItemID and Description. In addition, the caller must be the same as the one who originally listed the item.

XML format.
<?xml version="1.0" encoding="utf-8"?>
<AddToItemDescriptionRequest xmlns="urn:ebay:apis:eBLBaseComponents">
 <RequesterCredentials>
 <eBayAuthToken>A*******3</eBayAuthToken>
 </RequesterCredentials>
 <!-- The user must be the seller of the item, and the listing must be active -->
 <ItemID>1**********0</ItemID>
 <Description>
 Perfect timing for Halloween!
 </Description>
</AddToItemDescriptionRequest>

Output

An error message is returned if a problem is encountered during the processing of the call. Here, the call succeeds.

XML format.
<AddToItemDescriptionResponse xmlns="urn:ebay:apis:eBLBaseComponents">
 <Timestamp>2018年10月29日T20:07:21.065Z</Timestamp>
 <Ack>Success</Ack>
 <Version>1081</Version>
 <Build>E1081_UNI_API5_18856241_R1</Build>
</AddToItemDescriptionResponse>

Change History