This is a request object containing input for the find product operation
Finds products for a given category and search criteria.
ProductMetadata
http://developer.ebay.com/DevZone/product-metadata/CallRef
getProductSearchNames
Retrieves all properties available for a given catalog-enabled category.
getProductSearchValues
Retrieves property values for the specified property.
User can findproducts for one
catalog at a time or batch up to
10 catalogs.
10
findProducts
No
Retrieve product details for the specified product ID, including whether
the product has fitment information or not.
Retrieve product details for the specified product ID, including whether
the product has fitment information or not.
Contains product details.
getProductDetails
No
Container for product details.
Details for a single product.
getProductDetails
Conditionally
Response container for the product search results.
Container for the products that matched the search criteria.
The data for each product is returned in individual containers, if
any matches were found.
findProducts
findProductsByCompatibility
Conditionally
This is a request object containing input for the
findProductsByCompatibility operation.
Finds products for the specified category, catalog property name-value
pairs, and compatibility property name-value pairs.
ProductMetadata
http://developer.ebay.com/DevZone/product-metadata/CallRef
getCompatibilitySearchNames
Retrieves all compatibilities available for a given compatibility-enabled category.
getCompatibilitySearchValues
Retrieves values for the specified compatibility.
Container for an individual product search query.
findProductsByCompatibility
No
Request object for getProductFitmentDetails operation.
Returns all available compatibility details for the specified product.
The ProductIdentifierType and a
value for one of the supported
ProductIdentifierTypes which are
unique across all sites (ePID,
MementoString)
getProductCompatibilities
Yes
Controls the pagination of the result set. Child elements specify the
maximum number of products to return per call and the page of
data to return. Controls the number of products returned in the
response, but does not specify the amount of data to return for each
product.
<br><br>
<span class="tablenote"><strong>Note:</strong>
No more than 10,000 products can be retrieved for a given search,
regardless of how many matches are found. This limit is enforced
by the maximum page number allowed (100) and the maximum entries per
page allowed (20). </span>
getProductCompatibilities
No
This will contain the property name value pairs of the application,
such as a particular vehicle make and model. Application property
filters are specified as name-value pairs.
getProductCompatibilities
No
This will define what are properties that will be returned for this
catelog-enabled category.
<dl>
<dt>
<strong>Dataset values:</strong>
</dt>
<dt>
DisplayableProductDetails
</dt>
<dd>
Properies for use in a user interface to describe products.
</dd>
<dt>
DisplayableSearchResults
</dt>
<dd>
Properties for use in results for product searches.
</dd>
<dt>
Searchable
</dt>
<dd>
Properties for use in searches.
</dd>
<dt>
Sortable
</dt>
<dd>
Properties that are suitable for sorting.
</dd>
</dl>
User can either enter dataset name or enter individual property names
(datasetPropertyName) from the dataset. Only one should be preset at
a time.
getProductCompatibilities
No
We need to allow multiple sort
orders. This is very specific to
fitment. We allow the caller
sorty by Make + Model + year. To
start with we will only allow 5
sorts.
getProductCompatibilities
No
Specifies whether or not to filter out the products which
are disabled for selling on eBay, disabled for product reviews, or
disabled for selling on half.com.
getProductCompatibilities
No
Individual property name from the dataset. You can either enter
dataset name or enter individual property names from the dataset.
Only one should be preset at a time.
getProductCompatibilities
Yes
Response object for getProductFitmentDetails operation.
Indicates the pagination of the result set. Child elements indicate
the maximum number of compatibilityDetails nodes returned per
response and which page of data has been returned.
getProductCompatibilities
Always
Compatibility details for a single product.
getProductCompatibilities
Conditionally
Thumbnail and standard stockphoto URLs.
Fully qualified URL for the thumbnail of a stock image (if any) that is
associated with a catalog product. The URL is for the image eBay usually
displays in product search results (usually 40px tall). It may be helpful
to calculate the dimensions of the photo programmatically before
displaying it. Only returned if a URL is available for the product.
400
Conditionally
Fully qualified URL for a stock image (if any) that is associated with a
catalog product. The URL is for the image eBay usually displays in
product search results (usually 70px tall). It may be helpful to
calculate the dimensions of the photo programmatically before displaying
it. Only returned if a URL is available for the product.
400
Conditionally
Container for a single compatibility filter.
Filter consisting of name-value pairs that describe compatibilities for
a product.
findProductsByCompatibility
No
Not used.
Ignore
Not used.
Ignore
Container for request data used in product search calls.
A unique identifer for a given product request. Use invocationId to
prevent the submission of duplicate data. In the event of a partial
failure, the invocation ID can also be used to identify a product request
that did not succeed.
<br><br>
If the same invocationId is passed in more than once in the same request,
then an error will be returned. The identifier must be a number .
-9223372036854775808
9223372036854775807
findProducts
findProductsByCompatibility
Yes
Specifies the category from which you want to retrieve product details.
When categoryId is used with findProducts, the category must be catalog-
enabled, or it will contain no product data, and the request will fail.
When categoryId is used with findProductsByCompatibility, the category
must be compatibility-enabled. A category must be catalog-enabled to be compatibility-enabled.
<br><br>
Your request must contain categoryId and/or keywords.
10
findProducts
findProductsByCompatibility
Conditionally
http://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetCategoryFeatures.html
GetCategoryFeatures
information to identify compatibility-enabled categories.
Use keywords to refine your product search query. Products whose catalog
searchable property values contain these keywords will be returned.
Returned products must match both the specified keywords and the name-
value pairs constraint.
<br><br>
Keyword searches are not case sensitive. Keywords are used for exact word
matching only, wildcards or search string modifiers are not supported.
<br><br>
Your request must contain categoryId and/or keywords.
350. The maximum length for a single word is 98
findProducts
findProductsByCompatibility
Conditionally
One or more name-value pairs that describe the product.
findProducts
findProductsByCompatibility
No
Sort Order for the result set. Any of the searchable property can be used
to specify the sort order. If no sort order is specified then default
sort order(popularity descending) will be applied.
findProducts
findProductsByCompatibility
No
This will define what are properties that will be returned for this
catelog-enabled category.
<dl>
<dt>
<strong>Dataset values:</strong>
</dt>
<dt>
DisplayableProductDetails
</dt>
<dd>
Properies for use in a user interface to describe products.
</dd>
<dt>
DisplayableSearchResults
</dt>
<dd>
Properties for use in results for product searches.
</dd>
<dt>
Searchable
</dt>
<dd>
Properties for use in searches.
</dd>
<dt>
Sortable
</dt>
<dd>
Properties that are suitable for sorting.
</dd>
</dl>
User can either enter dataset name or enter individual property names
(datasetPropertyName) from the dataset. Only one should be preset at
a time.
Searchable
findProducts
findProductsByCompatibility
No
Individual property name from the dataset. You can either enter
dataset name or enter individual property names from the dataset.
Only one should be preset at a time.
findProducts
findProductsByCompatibility
No
Controls the pagination of the result set. Child elements specify the
maximum number of products to return per call and the page of
data to return. Controls the number of products returned in the
response, but does not specify the amount of data to return for each
product.
<br><br>
<span class="tablenote"><strong>Note:</strong>
No more than 10,000 products can be retrieved for a given search,
regardless of how many matches are found. This limit is enforced
by the maximum page number allowed (100) and the maximum entries per
page allowed (20). </span>
findProducts
findProductsByCompatibility
No
Specifies whether or not to filter out the products which
are disabled for selling, product reviews, or use on half.com.
findProducts
findProductsByCompatibility
No
Container for product information returned by product search calls.
Container for multiple products.
findProducts
findProductsByCompatibility
Conditionally
Indicates the pagination of the result set. Child elements indicate the
maximum number of productSearchResult nodes returned per response and
which page of data has been returned.
findProducts
findProductsByCompatibility
Conditionally
A unique identifer for a given product response, corresponding to a
specific product request.
-9223372036854775808
9223372036854775807
findProducts
findProductsByCompatibility
Conditionally
This is the base class for product queries by compatible application.
This will contain the property name-value pairs of the application. For
example, an application property filter can consist of name-value pairs
that describe a particular make and model of a car.
findProductsByCompatibility
No
User can findproducts for one
catalog at a time or batch up to
10 catalogs.
findProductsByCompatibility
No
Container for request data for retrieving product details.
The product identifier type and value. Product identifiers, such as ePID
values or ISBN values, are unique across all sites.
getProductDetails
Yes
Individual property name from the dataset. You can either enter
dataset name or enter individual property names from the dataset.
Only one should be preset at a time.
getProductDetails
No
This will define what are properties that will be returned for this
catelog-enabled category.
<dl>
<dt>
<strong>Dataset values:</strong>
</dt>
<dt>
DisplayableProductDetails
</dt>
<dd>
Properies for use in a user interface to describe products.
</dd>
<dt>
DisplayableSearchResults
</dt>
<dd>
Properties for use in results for product searches.
</dd>
<dt>
Searchable
</dt>
<dd>
Properties for use in searches.
</dd>
<dt>
Sortable
</dt>
<dd>
Properties that are suitable for sorting.
</dd>
</dl>
User can either enter dataset name or enter individual property names
(datasetPropertyName) from the dataset. Only one should be preset at
a time.
getProductDetails
No
Specifies whether or not to filter out the products which are disabled
for selling on eBay, disabled for product reviews, or disabled for
selling on half.com.
getProductDetails
No
This is the base class for request container for
all service operations.
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.
The request that triggered the error was not processed successfully. When
a serious application-level error occurs, the error is returned instead
of the business data.
The request was processed successfully, but something occurred that may
affect your application or the user.
The request that triggered the error was processed successfully but with
some warnings.
The request that triggered the error was processed successfully but with
some warnings.
Base response container for all service operations. Contains error
information associated with the request.
Indicates whether or not errors or warnings were generated during the
processing of the request.
Always
Description of an error or warning that occurred when eBay processed the
request. Not returned if the ack value is Success.
Conditionally
The release version that eBay used to process the request. Developer
Technical Support may ask you for the version value if you work with them
to troubleshoot issues.
<br><br>
<span class="tablenote"><strong>Note:</strong>
The version in use is normally the latest release version, as specified
in the release notes. Note that eBay releases the API to international
sites about a week after the API version is released to the US site.
</span>
Always
This value represents the date and time when eBay processed the request.
This value is returned in GMT, the ISO 8601 date and time format (YYYY-
MM- DDTHH:MM:SS.SSSZ). See the "dateTime" type for information about the
time format, and for details on converting to and from the GMT time zone.
Always
There are three categories of error: request errors, application errors,
and system errors. Request and application errors are often caused by
passing invalid data in the request. System errors are primarily caused by
application failures and cannot be corrected by changing request values.
Indicates that an error has occurred on the eBay system side. For
example, a database or server could be down. Inspect the error message to
find the cause of the problem. If the problem is on the eBay side, 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.
An error occurred due to a problem with the request, with the most likely
source being the application sending the request. For example, the
request is missing a required data element or it contains an invalid
field. The problem must be corrected before the request can be resent.
Inspect the error message to find the cause of the problem. If the
problem is due to an application error, modify the application and resend
the request. If the error is due to invalid data, the source of the data
must be corrected before you resend the resend request to eBay.
An error occurred due to a problem with the request, with the most likely
source being missing or invalid data in the request. The problem must be
corrected before the request can be retried. Inspect the error message to
find the cause of the problem. If the problem is a result of end-user
data, alert the end-user to the problem and provide the means for them to
correct the problem. Once the problem is resolved, resend the request to
eBay.
A container for error details.
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.
Conditionally
Name of the domain in which the error occurred.
<dl>
<dt>
<strong>domain values:</strong>
</dt>
<dt>
Marketplace
</dt>
<dd>
A business or validation error occurred in the service.
</dd>
<dt>
SOA
</dt>
<dd>
An exception occurred in the Service Oriented Architecture (SOA)
framework.
</dd>
</dl>
Conditionally
Name of the subdomain in which the error occurred.
<dl>
<dt>
<strong>subdomain values:</strong>
</dt>
<dt>
MarketplaceCatalog
</dt>
<dd>
The error is specific to the Marketplace Catalog subdomain.
</dd>
<dt>
MarketplaceCommon
</dt>
<dd>
The error is common to all Marketplace services.
</dd>
</dl>
Conditionally
Indicates whether the reported problem is fatal (an error) or is less-
severe (a warning). Review the error message details for information on
the cause.
<br><br>
If the request fails and the application is the source of the error (for
example, a required element is missing), update the application before
you retry the request. If the problem is due to incorrect user data,
alert the end-user to the problem and provide the means for them to
correct the data. Once the problem in the application or data is
resolved, re-send the request to eBay.
<br><br>
If the source of the problem is on eBay's side, you can retry the request
a reasonable number of times (eBay recommends you try the request twice).
If the error persists, contact Developer Technical Support. Once the
problem has been resolved, you can resend the request in its original
form.
<br><br>
If a warning occurs, warning information is returned in addition to the
business data. Normally, you do not need to resend the request (as the
original request was successful). However, depending on the cause of the
warning, you might need to contact the end user, or eBay, to effect a
long term solution to the problem.
Conditionally
There are three categories of errors: request errors, application
errors, and system errors.
Conditionally
A detailed description of the condition that caused in the error.
Conditionally
Unique identifier for an exception associated with an error.
Conditionally
Various warning and error messages return one or more variables that
contain contextual information about the error. This is often the
field or value that triggered the error.
Conditionally
Information regarding an error or warning that occurred when eBay processed
the request. Not returned when the ack value is Success. Run-time errors are
not reported here, but are instead reported as part of a SOAP fault.
Details about a single error.
Conditionally
Contextual data associated with an error.
The name of the input parameter returned with the error.
Inspecting the parameter (or its input value) will often aid in
understanding the cause of the error. Not all error messages
contain this value.
Conditionally
Indicates whether the error is a fatal error (causing the request to fail)
or a less severe error (a warning) that should be communicated to the user.
eBay encountered a fatal error during the processing of the request,
causing the request to fail. When eBay encounters an error, it returns
error data instead of the requested business data. Inspect the error
details and resolve the problem before resubmitting the request.
The request was successfully processed, but eBay encountered a non-fatal
error during the processing that could affect the data returned. For
example, eBay might have changed the value of an input field. In this
case, eBay returns a successful response, but it also returns a warning.
For best results, requests should return without warnings. Inspect the
warning details and resolve the problem before resubmitting the request.
Controls the pagination of the result set. Child elements specify the maximum
number of item listings to return per call and which page of data to return.
Controls which listings are returned in the response, but does not control
the details associated with the returned items.
Specifies which subset of data (or "page") to return in the call
response. The number of data pages is determined by the total number of
items matching the request search criteria (returned in
paginationOutput.totalEntries) divided by the number of entries to
display in each response (entriesPerPage). You can return up to the first
100 pages of the result set by issuing multiple requests and specifying,
in sequence, the pages to return.
1
100
No
Specifies the maximum number of entries to return in a single call. If
the number of entries found on the specified pageNumber is less than the
value specified here, the number of items returned will be less than the
value of entriesPerPage. This indicates the end of the result set.
<br><br>
If entriesPerPage is set to a number greater than 100, the default value,
100, will be used.
100
100
No
Shows the pagination data for the item search. Child elements include the
page number returned, the maximum entries returned per page, the total number
of pages that can be returned, and the total number of entries that match the
search criteria.
The total number of pages of data that could be returned by repeated
search requests. Note that if you modify the value of
inputPagination.entriesPerPage in a request, the value output for
totalPages will change. A value of "0" is returned if eBay does not find
any entries that match the search criteria.
Conditionally
The total number of entries found that match the search criteria in your
request. Depending on the input value for entriesPerPage, the response
might include only a portion (a page) of the entire result set. A value
of "0" is returned if eBay does not find any entries that match the
search criteria.
Conditionally
The subset of item data returned in the current response. Search results
are divided into sets, or "pages," of item data. The number of pages is
equal to the total number of entries matching the search criteria divided
by the value specified for entriesPerPage in the request. The response
for a request contains one "page" of data.
<br> <br>
This returned value indicates the page number of data returned (a
subset of the complete result set). If this field contains 1, the
response contains the first page of item data (the default). If the value
returned in totalEntries is less than the value for entriesPerPage,
pageNumber returns 1 and the response contains the entire result set.
<br> <br>
The value of pageNumber is normally equal to the value input for
paginationInput.pageNumber. However, if the number input for pageNumber
is greater than the total possible pages of output, eBay returns the last
page of item data in the result set, and the value for pageNumber is set
to the respective (last) page number.
Conditionally
The maximum number of items that can be returned in the response. This
number is always equal to the value input for
paginationInput.entriesPerPage.
<br> <br>
The end of the result set has been reached if the number specified for
entriesPerPage is greater than the number of items found on the specified
pageNumber. In this case, there will be fewer items returned than the
number specified in entriesPerPage. This can be determined by comparing
the entriesPerPage value with the value returned in the count attribute
for the searchResult field.
Conditionally
Type to specify order for sorting compatibility properties.
The property with its associated sort order, ascending or descending.
findCompatibilitiesBySpecification
getProductCompatibilities
No
Indicates where in the sequence of ordering the property should ordered.
There are five sorting steps, Sort1 through Sort5. When a property is
assigned Sort1 as its sort priority, its values are sorted first. Values
for the property assigned Sort2, are sorted second, and so on.
findCompatibilitiesBySpecification
getProductCompatibilities
No
Defines the order type as Ascending or Descending
The results will be sorted by the specified attribute in ascending (low
to high) order.
The results will be sorted by the specified attribute in descending (high
to low) order.
Sort order input for the result set. Any of the searchable properties can be
used for property name and order can be either Ascending or Descending.
Output can be sorted by one or more property names. You can look these
values up using the <b class="con">getProductSearchNames</b>
call in the Product Metadata API.
100
findCompatibilitiesBySpecification
findProducts
findProductsByCompatibility
getProductCompatibilities
No
Order of the sort, either Ascending or Descending.
Descending
findCompatibilitiesBySpecification
findProducts
findProductsByCompatibility
getProductCompatibilities
No
Specifies the order in which properties will considered for sorting.
Specifies that the associated property should be sorted first.
Specifies that the associated property should be sorted second.
Specifies that the associated property should be sorted third.
Specifies that the associated property should be sorted fourth.
Specifies that the associated property should be sorted fifth.
This operation returns all the compatiblilities for a given specification.
User can constrain the output further by specifiying the compatibility
propertiesthat they are interested in.
Retrieves compatible applications for a product based on its
specifications.
Category ID for which we want to find out the compatibility details
findCompatibilitiesBySpecification
No
This filter is used to restrict the number of compatible vehicles
that can be returned. Properties that can be used here include Make,
Model, Year and Trim
findCompatibilitiesBySpecification
No
The specifications for which we need the compatibility. Examples
include Aspect Ratio, Section Width etc.
findCompatibilitiesBySpecification
Yes
This will define what are properties that will be returned for this
catelog-enabled category.
<dl>
<dt>
<strong>Dataset values:</strong>
</dt>
<dt>
DisplayableProductDetails
</dt>
<dd>
Properies for use in a user interface to describe products.
</dd>
<dt>
DisplayableSearchResults
</dt>
<dd>
Properties for use in results for product searches.
</dd>
<dt>
Searchable
</dt>
<dd>
Properties for use in searches.
</dd>
<dt>
Sortable
</dt>
<dd>
Properties that are suitable for sorting.
</dd>
</dl>
User can either enter dataset name or enter individual property names
(datasetPropertyName) from the dataset. Only one should be preset at
a time.
findCompatibilitiesBySpecification
No
User can either enter dataset name or enter individual property names
from the dataset. Only one should be preset at a time.
findCompatibilitiesBySpecification
No
For certain specification properties the compatibility is defined not
by an exact match but by an expanded match on the input value by
greater or lesser values as well. E.g For Load Index a compatible
vehicle is the one which has a load index requirement which is less
than or equal to the input. By default we will do an expanded
compatibility match whenever it applies. However if you need to do
only exact match then you can specify that using this input.
false
findCompatibilitiesBySpecification
No
Controls the pagination of the result set. Child elements specify the
maximum number of products to return per call and the page of
data to return. Controls the number of products returned in the
response, but does not specify the amount of data to return for each
product.
<br><br>
<span class="tablenote"><strong>Note:</strong>
No more than 10,000 products can be retrieved for a given search,
regardless of how many matches are found. This limit is enforced
by the maximum page number allowed (100) and the maximum entries per
page allowed (20). </span>
findCompatibilitiesBySpecification
No
Sort Order for the result set. Any of the searchable property can be
used to specify the sort order. If no sort order is specified then
default sort order(popularity descending) will be applied.
findCompatibilitiesBySpecification
No
Container for the Compatibility by specification
operation output.
Sort Order for the result set. Any of the searchable property can be
used to specify the sort order. If no sort order is specified then
default sort order(popularity descending) will be applied.
findCompatibilitiesBySpecification
Always
List of compatibilties.
findCompatibilitiesBySpecification
Always
Name-Value pairs for each compatiblility property.
Name-Value pairs for each compatiblility property.
findCompatibilitiesBySpecification
Always
Container for notes related to a product in the eBay catalog.
Additional comments about the product in the form of name-value pairs.
Conditionally
This class holds a numeric value
A numeric value. For example, physical dimensions of a product, such as height or weight, are specified as nummeric values.
findCompatibilitiesBySpecification
findProducts
findProductsByCompatibility
getProductCompatibilities
No
addProducts
Conditionally
Conditionally
Unit of measure for a numeric value.
<dl>
<dt>
<b>Allowed values:</b>
</dt>
<dt>
bps
</dt>
<dd>
Bits per second. A unit of data transmission.
</dd>
<dt>
kbps
</dt>
<dd>
Kilobits per second. A unit of data transmission.
</dd>
<dt>
bit
</dt>
<dd>
Binary digit. A unit of information storage.
</dd>
<dt>
byte
</dt>
<dd>
An ordered collection of bits. A unit of information
storage equal to 8 bits in most contexts.
</dd>
<dt>
kb
</dt>
<dd>
Kilobit. A unit of information storage equal to 1024 bits.
</dd>
<dt>
MB
</dt>
<dd>
Megabyte. A unit of information storage equal to one million bytes.
</dd>
<dt>
mW
</dt>
<dd>
Megawatt. A unit of power equal to one million watts.
</dd>
<dt>
W
</dt>
<dd>
Watt. The base SI unit of power.
</dd>
<dt>
Hz
</dt>
<dd>
Hertz. A unit of frequency equal to one cycle per second.
</dd>
<dt>
kHz
</dt>
<dd>
Kilohertz. A unit of frequency equal to 1,000 cycles per second.
</dd>
<dt>
m
</dt>
<dd>
Meter. The base unit of distance.
</dd>
<dt>
mm
</dt>
<dd>
Megameter. A unit of distance equal to one million meters.
</dd>
<dt>
rph
</dt>
<dd>
Revolutions per hour. A unit of frequency.
</dd>
<dt>
hr
</dt>
<dd>
Hour. A unit of time equal to 3,600 seconds.
</dd>
<dt>
min
</dt>
<dd>
Minute. A unit of time equal to 60 seconds.
</dd>
<dt>
ms
</dt>
<dd>
Microsecond. A unit of time equal to one millionth of a second.
</dd>
<dt>
ns
</dt>
<dd>
Nanosecond. A unit of time equal to 10<sup>-9</sup>
seconds.
</dd>
<dt>
sec
</dt>
<dd>
Seconds. The base unit of time.
</dd>
<dt>
g
</dt>
<dd>
Grams. A unit of mass equal to one one-thousandth of the SI base unit,
the kilogram.
</dd>
<dt>
lbs
</dt>
<dd>
Pounds. The base Imperial unit of mass.
</dd>
</dl>
The allowed units of measure do not apply to all numeric values. For
example, when specifying the number of doors, unitOfMeasurement is not
needed.
findProducts
findProductsByCompatibility
getProductCompatibilities
No
findProducts
findProductsByCompatibility
getProductDetails
Conditionally
Container type for product data.
The eBay produdt ID (ePID) or external IDs associated with the product.
Use the Reference value as input to search for the same product in the
future, or use the ISBN, EAN, or UPC value (if returned). The ISBN, EAN,
and UPC values can also be useful as keys if your application is
comparing products across different sites. Always returned when Product
is returned.
Conditionally
Thumbnail and standard stockphoto URLs.
Conditionally
Details about the product in the form of name-value pairs.
Conditionally
Indicates whether or not a product is disabled for selling, product
reviews, or use on Half.com.
Conditionally
The quantity of compatibilities that have been specified for the product.
When returned, indicates that the product is Parts Compatibility eanbled.
ComingSoon
Conditionally
Indicates if a product is the top or main product in a family (Head) or a
variant of the head product (Member). If a product is not part of a
product family, it is also the Head.
<br><br>
Sometimes several versions (or editions) of a product may be available.
All versions of the same product are considered to be part of the same
product family. Some product families may contain only one product;
others may contain many products.
<dl>
<dt>
<b>Allowed values:</b>
</dt>
<dt>
Head
</dt>
<dd>
The product is the the head of the product family.
</dd>
<dt>
Member
</dt>
<dd>
The product is a variant of the head product.
</dd>
</dl>
Conditionally
Optional notes that provide additional information about the product,
such as the placement of the part or accessory on a vehicle or the type
of vehicle a part fits.
Conditionally
Type could be ePID, MementoString as well as ISBN, UPC, EAN, Brand_MPN.
eBay Product ID. eBay's global reference ID for a catalog product. On the
eBay Web site, this is known as the "ePID". A reference ID is a fixed
reference to a product (regardless of version). One reference ID can be
associated with multiple ProductID values. The value should start with
"EPID", for example "EPID30971438" (without quotes). You can find
reference IDs for products by using GetProducts (or FindProducts in the
Shopping API). You can also find the ePID on eBay's Web site.
<br><br>
If the primary and secondary categories are both catalog-enabled, this ID
should correspond to the primary category (not the secondary category).
38
getProductCompatibilities
getProductDetails
Conditionally
Conditionally
ISBN-10 or ISBN-13 value for books. (The string length of ProductID
indicates whether the ID is 10 or 13 characters.) If you know a book's
ISBN, you can use this instead of the eBay CatalogItem or Reference ID to
search for that book.
13
getProductCompatibilities
getProductDetails
Conditionally
Conditionally
eBay Product ID.
12
getProductCompatibilities
getProductDetails
Conditionally
Conditionally
European Article Number (EAN) value for books. (This is used more
commonly in European countries.) If you know a book's EAN, you can use
this instead of the eBay CatalogItem or Reference ID to search for that
book.
13
getProductCompatibilities
getProductDetails
Conditionally
Conditionally
eBay's unique identifier for a specific version of a product. This is the
long alphanumeric ID that is returned from GetProductSearchResults and
related calls. See the Trading API Guide for information about finding
this type of product ID. (For the shorter ePID value that is displayed on
the eBay Web site, see ProductReferenceID instead.)
4000
getProductCompatibilities
getProductDetails
Conditionally
Conditionally
This will indicate if the product is disabled for the
specific application like selling flow, review flow or
half sell flow.
Product cannot be used in selling flows on eBay.
false
No
Conditionally
Product cannot be used in product review flows.
false
No
Conditionally
Product cannot be used in selling flows on half.com.
false
No
Conditionally
A property name and corresponding value (a name/value pair).
This is the canonical name of the property. Used to identify a property
within a catalog that this category belongs to.
findProducts
findProductsByCompatibility
getProductCompatibilities
No
findCompatibilitiesBySpecification
compatibilityPropertyFilter
No
findCompatibilitiesBySpecification
specification
Yes
addProducts
Yes
Conditionally
A value for the property.
findProducts
findProductsByCompatibility
getProductCompatibilities
No
findCompatibilitiesBySpecification
compatibilityPropertyFilter
No
findCompatibilitiesBySpecification
specification
Yes
addProducts
Yes
Conditionally
This class holds a String value
A string value.
findCompatibilitiesBySpecification
findProducts
findProductsByCompatibility
getProductCompatibilities
No
addProducts
Conditionally
Conditionally
This class holds a URL value
As part of request, this will be the URL to
download media file. As part of response, this
will be the URL where the media file is stored
on eBay Picture Services (EPS).
400
findCompatibilitiesBySpecification
findProducts
findProductsByCompatibility
getProductCompatibilities
No
addProducts
Conditionally
Conditionally
A value can be one of the types: text (string), a number (
For string value type.
findCompatibilitiesBySpecification
findProducts
findProductsByCompatibility
getProductCompatibilities
No
addProducts
Conditionally
Conditionally
For numeric value type.
findCompatibilitiesBySpecification
findProducts
findProductsByCompatibility
getProductCompatibilities
No
addProducts
Conditionally
Conditionally
For URL value type.
findCompatibilitiesBySpecification
findProducts
findProductsByCompatibility
getProductCompatibilities
No
addProducts
Conditionally
Conditionally
This is a request object containing input for adding one or more products to
the eBay catalog.
Adds products to the eBay catalog.
getProductSubmissions
Trading
http://developer.ebay.com/DevZone/XML/docs/Reference/eBay
GetCategoryFeatures
Returns information about the features that are applicable to different categories, such as Product Creation.
ProductMetadata
http://developer.ebay.com/DevZone/product-metadata/CallRef
getProductMetadataBulk
Retrieves product metadata needed to add a product to the eBay catalog for the specified category.
Information about a single product to be added to the eBay catalog. The product information must include a category ID and a set of name-value properties that describe the product.
10
addProducts
No
Identifier to help users match requests and responses in multi-
threaded applications. When provided in the request, the value is
returned in the corresponding response.
64
addProducts
No
Container for all the information that describes a product.
A unique identifer for a given product request. Use invocationId to
prevent the submission of duplicate data. In the event of a partial
failure, the invocation ID can also be used to identify a product
request that did not succeed.
<br><br>
If the same invocationId is passed in more than once in the same
request, then an error will be returned. The identifier must be a
number.
-9223372036854775808
9223372036854775807
addProducts
No
Specifies the category to which you want to add a product.
Only select Electronics categories support product creation.
10
addProducts
Yes
getProductSubmissions
outputSelector: ProductSubmission
Conditionally
Name-value pairs that describe the product.
100
addProducts
Yes
getProductSubmissions
outputSelector: ProductSubmission
Conditionally
http://developer.ebay.com/DevZone/product-metadata/CallRef/getProductMetadataBulk.html
getProductMetadataBulk
details about required and optional product properties and value constraints.
Details for any media, such as images, associated with the product.
Currently, images are the only supported media type.
<br>
<br>
When submitting multiple images, the image specified in the first
media node will be used as the stock photo for the product.
10
addProducts
No
getProductSubmissions
outputSelector: ProductSubmission
Conditionally
Container for details about any media used to describe a product.
A reference to the media for you product. Currently, only URLs are
supported. You must specify a media identifier when you include media
details for your product.
addProducts
No
getProductSubmissions
outputSelector: ProductSubmission
Conditionally
The kind of media used to describe your product. Currently, images are
the only supported media type. You must specify a media type when you
include media details for your product.
addProducts
No
getProductSubmissions
outputSelector: ProductSubmission
Conditionally
Contains a reference that uniquely identifies the media for the product.
A URL to the media file for your product. You must specify a URL when you
include media details for your product.
400
addProducts
No
getProductSubmissions
outputSelector: ProductSubmission
Conditionally
Returns the processing status for products submitted with addProducts.
Status for an individual product submission.
addProducts
Always
Identifier to help users match requests and responses in
multi-threaded applications. Simple pass-thru of identifier
provided in the request. Only returned if it is specified in the
request.
???
addProducts
Conditionally
Returns the processing status for an individual product submitted with
addProducts.
A unique identifer for a given product submission, corresponding to a
specific product request. Only returned if it was specified in the addProductRequest when the product was submitted with addProducts.
-9223372036854775808
9223372036854775807
addProducts
Conditionally
Processing/acceptance status for a product submission.
addProducts
Always
Status details for a single product submission.
A unique [how unique?] identifier for a specific product submission.
[When is this not returned?]
addProducts
Conditionally
getProductSubmissions
outputSelector: none
Conditionally
The state of the product submission. When a product is submitted, its
status is Pending while eBay reviews the submission. Product submissions
may remain in a Pending state for several hours.
addProducts
Always
getProductSubmissions
outputSelector: none
Conditionally
Reserved for future use.
Reserved for future use.
The eBay Product Identifier (ePID) is the unique identifier for the
product in the eBay catalog.
<br><br>
Returned in the following conditions:
<ul>
<li>Product successfully added or updated—when a product
has been successfully added to or updated in the catalog (i.e., status is
Approved), the ePID for the new or updated product is returned.
</li>
<li>Matching product found—when the catalog already contains a product that matches the submitted product, the submission is rejected and the ePID of the existing product is returned. </li>
</ul>
addProducts
Conditionally
getProductSubmissions
outputSelector: none
Conditionally
This is a request object for retrieving status for one or more product
submissions.
Retrieves status and details for products submitted for addition to the
eBay catalog.
addProducts
Restrict the scope of product submissions for which to retrieve status
information.
getProductSubmissions
No
Defines what data to return, in addition to the default set of data,
in a response.
<br><br>
If you don't specify this field, eBay returns a default set of
product submission status information. Use outputSelector to include
the properties for the product submissions, as well.
<br><br>
If you specify this field, the additional fields returned can affect
the call's response time (performance)
getProductSubmissions
No
getProductSubmissions
No
Specifies the logic for sorting the productSubmissionResponse nodes in
the response. If sortOption is not specified, no sorting is applied to
the response.
getProductSubmissions
No
Specifies a single filter for restricting the ressult set when retrieving
status on product submissions.
Specify the name of the product submission filter you want to use. The
productSubmissionFilter filter name must have a corresponding value. You
can apply multiple productSubmissionFilter Name/Value pairs in a single
request.
getProductSubmissions
No
The value associated with the respective product submission filter name.
Allowed values and datatypes vary for a given filter name.
getProductSubmissions
No
Specifies the property value to sort on and the order of the sort.
Indicates the property value used for sorting. Currently, results can
only be sorted by product submission ID.
If you specify a sortOption, you must include sortType.
getProductSubmissions
Conditionally
This value specifies whether you want to sort search results in ascending
or descending order, in conjunction with the value you specify in
sortType.
If you specify a sortOption, you must include sortOrder.
getProductSubmissions
Conditionally
Specifies the property value to use for sorting.
Sorts the response by the product submission ID. The sortOrder
value determines whether results are returned in ascending or
descending order.
The kinds of media that can be used to describe your product.
Indicates that the specified media is an image.
Catalog inclusion status for a product submission.
The product submission is under review.
The product submission has been approved and added to the eBay
catalog.
The product submission was rejected. The product did not meet all
acceptance criteria.
Reserved for future use.
Reserved for future use.
The name of a filter for restricting the result set when retrieving
product submissions.
A simple code identifying the reason the product submission was
rejected.
<dl>
<dt>
<b>Allowed values:</b>
</dt>
<dt>
DateRange
</dt>
<dd>
Retrieve product submissions that were submitted within a specific range
of dates.
</dd>
<dt>
ProductSubmissionId
</dt>
<dd>
The unique identifier for a single product submission.
</dd>
<dt>
SellerId
</dt>
<dd>
The seller's eBay user name.
</dd>
<dt>
SellerProductId
</dt>
<dd>
A unique product ID for a product submited by the seller.
</dd>
</dl>
Specifies whether or not to return the product submission details, in
addition to the default set of data, in a response.
Include the product submission details in the response. These are the
name-value properties used to describe the product. In some cases, the
returned properties may vary from the submitted properties. [This was
mentioned in a meeting. When does this happen? Does this only happen for
submissions that are approved?]
Indicates the pagination of the result set. Child elements indicate
the page number that is returned, the maximum number of product
submission responses to return per page, total number of pages that
can be returned, and the total number of entries that match the
search criteria.
getProductSubmissions
outputSelector: none
Conditionally
Status information about the submitted product. This information may include API errors for failed submissions (not the same as a status of rejected), status of successful submissions (i.e., pending, approved, or rejected), and product submission details (i.e., name-value properties that describe the product).
getProductSubmissions
outputSelector: none
Conditionally
TBD
getProductSubmissions
outputSelector: ProductSubmission
Conditionally
Always returned when there are product submissions that match
the request criteria.
getProductSubmissions
outputSelector: none
Conditionally
1.4.0
1.4.0