Trading_AddItemResponseContainerType Class Reference
Inherits from | NSObject |
Conforms to | PicoBindable |
Declared in | Trading_AddItemResponseContainerType.h Trading_AddItemResponseContainerType.m |
Overview
This container has all of the resulting information from an AddItems call. There will be one
container per container specified in the request.
@ingroup EBayAPIInterface
Tasks
-
itemID
Unique item ID for the new listing.
property
Also applicable to Half.com.
Note: Although we
represent item IDs as strings in the schema, we recommend you store them
as 64-bit signed integers. If you choose to store item IDs as strings,
allocate at least 19 characters (assuming decimal digits are used) to hold
them. eBay will increase the size of IDs over time. Your code should be
prepared to handle IDs of up to 19 digits. For more information about item
IDs, see <a
href=“http://ebay.custhelp.com/cgi-bin/ebay.cfg/php/enduser/std_adp.php?p_faqid=468”>Common
FAQs on eBay Item IDs and other eBay IDs in the Knowledge
Base. -
startTime
Starting date and time for the new listing.
property
Also returned for Half.com (for Half.com, the start time is always the time the item was listed). -
endTime
Date and time when the new listing ends. This is the starting time
property
plus the listing duration.
Also returned for Half.com, but for Half.com the actual end time is GTC
(not the end time returned in the response). -
fees
Child elements contain the estimated listing fees for the new item listing.
property
The fees do not include the Final Value Fee (FVF), which cannot be determined
until an item is sold.
Also returned for Half.com, but the values are not applicable to Half.com listings. -
categoryID
ID of the primary category in which the item was listed.
property
Only returned if you set Item.CategoryMappingAllowed to true in the request
and the ID you passed in PrimaryCategory was mapped to a new ID by eBay.
If the primary category has not changed or it has expired with no replacement,
CategoryID does not return a value.
Not applicable to Half.com. -
category2ID
ID of the secondary category in which the item was listed.
property
Only returned if you set Item.CategoryMappingAllowed to true in the request
and the ID you passed in SecondaryCategory was mapped to a new ID by eBay.
If the secondary category has not changed or it has expired with no replacement,
Category2ID does not return a value.
Not applicable to Half.com. -
correlationID
Most Trading API calls support a MessageID element in the request
property
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. -
errors
A list of application-level errors or warnings (if any) that were raised
property
when eBay processed the request.
Application-level errors occur due to
problems with business-level data on the client side or on the eBay
server side. For example, an error would occur if the request contains
an invalid combination of fields, or it is missing a required field,
or the value of the field is not recognized. An error could also occur
if eBay encountered a problem in our internal business logic while
processing the request.
Only returned if there were warnings or errors. -
message
Supplemental information from eBay, if applicable. May elaborate on errors or
property
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
appendices in the eBay Web Services guide for general information about string
data types. -
discountReason
The nature of the discount, if a discount applied.
property -
any
(public property)
property
Properties
any
(public property)
@property (nonatomic, retain) NSMutableArray *any
Discussion
(public property)
entry type : PicoAnyElement, wrapper for primitive anyelement
Declared In
Trading_AddItemResponseContainerType.h
category2ID
ID of the secondary category in which the item was listed.
Only returned if you set Item.CategoryMappingAllowed to true in the request
and the ID you passed in SecondaryCategory was mapped to a new ID by eBay.
If the secondary category has not changed or it has expired with no replacement,
Category2ID does not return a value.
Not applicable to Half.com.
@property (nonatomic, retain) NSString *category2ID
Discussion
ID of the secondary category in which the item was listed.
Only returned if you set Item.CategoryMappingAllowed to true in the request
and the ID you passed in SecondaryCategory was mapped to a new ID by eBay.
If the secondary category has not changed or it has expired with no replacement,
Category2ID does not return a value.
Not applicable to Half.com.
type : NSString, wrapper for primitive string
Declared In
Trading_AddItemResponseContainerType.h
categoryID
ID of the primary category in which the item was listed.
Only returned if you set Item.CategoryMappingAllowed to true in the request
and the ID you passed in PrimaryCategory was mapped to a new ID by eBay.
If the primary category has not changed or it has expired with no replacement,
CategoryID does not return a value.
Not applicable to Half.com.
@property (nonatomic, retain) NSString *categoryID
Discussion
ID of the primary category in which the item was listed.
Only returned if you set Item.CategoryMappingAllowed to true in the request
and the ID you passed in PrimaryCategory was mapped to a new ID by eBay.
If the primary category has not changed or it has expired with no replacement,
CategoryID does not return a value.
Not applicable to Half.com.
type : NSString, wrapper for primitive string
Declared In
Trading_AddItemResponseContainerType.h
correlationID
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.
@property (nonatomic, retain) NSString *correlationID
Discussion
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.
type : NSString, wrapper for primitive string
Declared In
Trading_AddItemResponseContainerType.h
discountReason
The nature of the discount, if a discount applied.
@property (nonatomic, retain) NSMutableArray *discountReason
Discussion
The nature of the discount, if a discount applied.
entry type : string constant in Trading_DiscountReasonCodeType.h
Declared In
Trading_AddItemResponseContainerType.h
endTime
Date and time when the new listing ends. This is the starting time
plus the listing duration.
Also returned for Half.com, but for Half.com the actual end time is GTC
(not the end time returned in the response).
@property (nonatomic, retain) NSDate *endTime
Discussion
Date and time when the new listing ends. This is the starting time
plus the listing duration.
Also returned for Half.com, but for Half.com the actual end time is GTC
(not the end time returned in the response).
type : NSDate, wrapper for primitive date
Declared In
Trading_AddItemResponseContainerType.h
errors
A list of application-level errors or warnings (if any) that were raised
when eBay processed the request.
Application-level errors occur due to
problems with business-level data on the client side or on the eBay
server side. For example, an error would occur if the request contains
an invalid combination of fields, or it is missing a required field,
or the value of the field is not recognized. An error could also occur
if eBay encountered a problem in our internal business logic while
processing the request.
Only returned if there were warnings or errors.
@property (nonatomic, retain) NSMutableArray *errors
Discussion
A list of application-level errors or warnings (if any) that were raised
when eBay processed the request.
Application-level errors occur due to
problems with business-level data on the client side or on the eBay
server side. For example, an error would occur if the request contains
an invalid combination of fields, or it is missing a required field,
or the value of the field is not recognized. An error could also occur
if eBay encountered a problem in our internal business logic while
processing the request.
Only returned if there were warnings or errors.
entry type : class Trading_ErrorType
Declared In
Trading_AddItemResponseContainerType.h
fees
Child elements contain the estimated listing fees for the new item listing.
The fees do not include the Final Value Fee (FVF), which cannot be determined
until an item is sold.
Also returned for Half.com, but the values are not applicable to Half.com listings.
@property (nonatomic, retain) Trading_FeesType *fees
Discussion
Child elements contain the estimated listing fees for the new item listing.
The fees do not include the Final Value Fee (FVF), which cannot be determined
until an item is sold.
Also returned for Half.com, but the values are not applicable to Half.com listings.
type : class Trading_FeesType
Declared In
Trading_AddItemResponseContainerType.h
itemID
Unique item ID for the new listing.
Also applicable to Half.com.
Note: Although we
represent item IDs as strings in the schema, we recommend you store them
as 64-bit signed integers. If you choose to store item IDs as strings,
allocate at least 19 characters (assuming decimal digits are used) to hold
them. eBay will increase the size of IDs over time. Your code should be
prepared to handle IDs of up to 19 digits. For more information about item
IDs, see <a
href=“http://ebay.custhelp.com/cgi-bin/ebay.cfg/php/enduser/std_adp.php?p_faqid=468”>Common
FAQs on eBay Item IDs and other eBay IDs in the Knowledge
Base.
@property (nonatomic, retain) NSString *itemID
Discussion
Unique item ID for the new listing.
Also applicable to Half.com.
Note: Although we
represent item IDs as strings in the schema, we recommend you store them
as 64-bit signed integers. If you choose to store item IDs as strings,
allocate at least 19 characters (assuming decimal digits are used) to hold
them. eBay will increase the size of IDs over time. Your code should be
prepared to handle IDs of up to 19 digits. For more information about item
IDs, see <a
href=“http://ebay.custhelp.com/cgi-bin/ebay.cfg/php/enduser/std_adp.php?p_faqid=468”>Common
FAQs on eBay Item IDs and other eBay IDs in the Knowledge
Base.
type : NSString, wrapper for primitive string
Declared In
Trading_AddItemResponseContainerType.h
message
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
appendices in the eBay Web Services guide for general information about string
data types.
@property (nonatomic, retain) NSString *message
Discussion
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
appendices in the eBay Web Services guide for general information about string
data types.
type : NSString, wrapper for primitive string
Declared In
Trading_AddItemResponseContainerType.h
startTime
Starting date and time for the new listing.
Also returned for Half.com (for Half.com, the start time is always the time the item was listed).
@property (nonatomic, retain) NSDate *startTime
Discussion
Starting date and time for the new listing.
Also returned for Half.com (for Half.com, the start time is always the time the item was listed).
type : NSDate, wrapper for primitive date
Declared In
Trading_AddItemResponseContainerType.h