AddItemResponseContainerType

Type defining the AddItemResponseContainer containers that are returned in an AddItems call. An AddItemResponseContainer container is returned for each item created through an AddItems call. Each item being created through an AddItems call is identified through a unique AddItemRequestContainer.MessageID value that is defined by the seller. To match up the AddItemResponseContainer to the AddItemRequestContainer, look for a AddItemResponseContainer.CorrelationID value that matches the AddItemRequestContainer.MessageID value in the request.

Type that uses AddItemResponseContainerType:

AddItemsResponseType

Call that uses AddItemResponseContainerType:

AddItems

Fields

Category2ID ( string )

CategoryID ( string )

CorrelationID ( string )

DiscountReason ( DiscountReasonCodeType )

EndTime ( dateTime )

Errors ( ErrorType )

Fees ( FeesType )

ItemID ( ItemIDType (string) )

Message ( string )

StartTime ( dateTime )

Category2ID ( string ) [0..1]

Unique identifier of the secondary category in which the item was listed. This field is only returned if the Item.CategoryMappingAllowed boolean field is set to true in the request (or omitted) and the Category ID passed in as the secondary listing category was automatically mapped to a new Category ID by eBay. If the secondary category ID passed in the request is still active/valid, this field is not returned.

Note: The Item.CategoryMappingAllowed field value in the request now defaults to true if omitted. Previously, the default value was false, so a user had to include this field and set it to true in order for eBay to map an outdated Primary or Secondary Category ID to the updated Category ID.

See the Field Index to learn which calls use Category2ID.

CategoryID ( string ) [0..1]

The unique identifier of the primary category in which the item was listed. This field is only returned if the Item.CategoryMappingAllowed boolean field is set to true in the request (or omitted) and the Category ID passed in as the primary listing category was automatically mapped to a new Category ID by eBay. If the primary category ID passed in the request is still active/valid, this field is not returned.

Note: The Item.CategoryMappingAllowed field value in the request now defaults to true if omitted. Previously, the default value was false, so a user had to include this field and set it to true in order for eBay to map an outdated Primary or Secondary Category ID to the updated Category ID.

See the Field Index to learn which calls use CategoryID.

CorrelationID ( string ) [0..1]

Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. With AddItems, a unique MessageID value is required for each AddItemRequestContainer container that is used in the request. The CorrelationID value returned under each AddItemResponseContainer container is used to correlate each item request container with its corresponding response container. The same MessageID value that you pass into a request will be returned in the CorrelationID field in the response.

See the Field Index to learn which calls use CorrelationID.

DiscountReason ( DiscountReasonCodeType ) [0..*]

This container is an array of one or more listing fee/upgrade discount types being offered by eBay to the seller.

See the Field Index to learn which calls use DiscountReason.

EndTime ( dateTime ) [0..1]

Date and time when the new listing is scheduled to end based on the start time and the listing duration value that was set in the ListingDuration field at listing time. If the value of ListingDuration was set to GTC (Good 'Til Cancelled) this value will be set one month ahead of the start time, and this value will continue to be updated one month ahead each time the GTC listing needs to be renewed. Fixed-price listings get renewed automatically as long as there is still a quantity of 1 or above, or even if the quantity is 0, but the 'out-of-stock control' feature is enabled.

Note that GTC is not a supported listing duration for auction listings, but is the only supported listing duration for fixed-price listings except for a few motor vehicle categories on eBay Motors US, eBay UK, and eBay Italy.

Note: As of July 1, 2019, the Good 'Til Cancelled renewal schedule has been modified from every 30 days to once per calendar month. For example, if a GTC listing is created July 5, the next monthly renewal date will be August 5. If a GTC listing is created on the 31st of the month, but the following month only has 30 days, the renewal will happen on the 30th in the following month. Finally, if a GTC listing is created on January 29-31, the renewal will happen on February 28th (or 29th during a 'Leap Year'). See the Good 'Til Cancelled listings update in the Spring 2019 Seller Updates for more information about this change.

See the Field Index to learn which calls use EndTime.

Errors ( ErrorType ) [0..*]

This container is an array of one or more errors and/or warnings (if any) that occurred when eBay attempted to create the corresponding listing. Note that one or more errors and/or warnings may also occur at the call-level.

This container is only returned if there were one or more warnings and/or errors that occurred with the creation of the corresponding listing.

See the Field Index to learn which calls use Errors.

Fees ( FeesType ) [0..1]

This container is an array of fees associated with the creation of the listing. The fees in this container will not include any fees that are based on the purchase price (such as Final Value Fee) and only come into play when the listing has a sale.

All listing fee types are returned, even if those fees are not applicable for the revised listings and are '0.0'.

Note: The currency used for all fees returned under the Fees container reflects the currency used for the listing site, and not necessarily in the seller's default/home currency. For example, if a Canadian seller is using the AddItems call to list items on the eBay US site, the currency type shown for each fee will be USD and not CAD.

See the Field Index to learn which calls use Fees.

ItemID ( ItemIDType (string) ) [0..1]

Unique identifier for the new listing. This field is returned as long as the listing was successfully created.

See the Field Index to learn which calls use ItemID.

Message ( string ) [0..1]

Supplemental information from eBay, if applicable. May elaborate on errors or provide useful hints for the seller. This data can accompany the call's normal data result set or a result set that contains only errors. The string can return HTML, including TABLE, IMG, and HREF elements. In this case, an HTML- based application should be able to include the HTML as-is in the HTML page that displays the results. A non-HTML application would need to parse the HTML and convert the table elements and image references into UI elements particular to the programming language used. Because this data is returned as a string, the HTML markup elements are escaped with character entity references (e.g.,<table><tr>...).

See the Field Index to learn which calls use Message.

StartTime ( dateTime ) [0..1]

Starting date and time for the new listing. This value is based on the time the listing was received and processed, or the time the item will be listed if the seller included the Item.ScheduleTime field in the request and set a custom start time of the listing (in the future).

See the Field Index to learn which calls use StartTime.