Retrieves all properties available for a given catalog-enabled category.
These properties, along with their respective values, can be used as input
for find and get calls to retrive products.
<br><br>
Returns all properties available for a given catalog enabled category.
getProductSearchDataVersion, getProductSearchValues, getProductSearchValuesBulk
Specifies the category from which you want to retrieve properties
that can be used to search for products. The category must be
catalog-enabled, or it will contain no product data, and the request
will fail.
10
getProductSearchNames
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>
getProductSearchNames
Yes
Response containing the list of properties
The category specified in the request.
10
getCompatibilitySearchNames
getProductSearchNames
Always
This contains all the properties for the specified category, as well
as the dataset from which the properties are returned (e.g.,
DisplayableSearchResults). The properties container also includes the
metatdata version associated with the most recent update of the
properties.
getCompatibilitySearchNames
getProductSearchNames
Always
This is the canonical name of the property. Used
to identify a property within a catalog that
this category belongs to.
getCompatibilitySearchValues
getProductSearchValues
Yes
Base request type used by the GetProductSearchValuesRequest type.
Specifies the category from which you want to retrieve property
values that can be used to search for products.
<br><br>
If a specified category ID doesn't match an existing category for the
site, eBay returns an invalid-category error message. To determine
valid categories, use the Trading API <a
href="https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetCategories.html"
>GetCategories</a> call.
10
getCompatibilitySearchValues
getCompatibilitySearchValuesBulk
getProductSearchValues
getProductSearchValuesBulk
Yes
Constrains the output of values for the given PropertyLiteral (or
group of properties) as per given
ConstrainingPropertyLiteral:ConstrainingValueLiteral pair (or pairs)
according to the respective dependency graph. AND-logic will be
applied within the constraint.
getCompatibilitySearchValues
getCompatibilitySearchValuesBulk
getProductSearchValues
getProductSearchValuesBulk
No
Return properties for a given catalog enabled category. We will throw
an error if the category is not catalog enabled.
false
getCompatibilitySearchValues
getCompatibilitySearchValuesBulk
getProductSearchValues
getProductSearchValuesBulk
No
Sort order for property values in the result set. You can sort by any
of the searchable properties, such as Year, Make, or Model. If no
sort order is specified then values are sorted in ascending order.
<br><br>
Sorting can be applied only when the response is in list format
(i.e., <b class="con">treeFormat</b> in the response is
false).
<br><br>
For sorting, characters are compared at each position (i.e., first
character, second character, etc.). When values are sorted in
ascending order, numbers (0-9) sort before uppercase letters (A-Z),
which sort before lowercase letters (a-z). For example, 268 precedes
3, CTS comes before Camry, and 911 comes before A3.
<br><br>
Descending order is the opposite of ascending, with lowercase letters (z-a) before uppercase letters (Z-A) and numbers last (9-0).
getCompatibilitySearchValues
getCompatibilitySearchValuesBulk
getProductSearchValues
getProductSearchValuesBulk
No
Version information reflects the last update of the values within the
dependency graph.
getCompatibilitySearchValues
getCompatibilitySearchValuesBulk
getProductSearchValues
getProductSearchValuesBulk
Conditionally
This will be populated for the
non-fitment enabled category
getCompatibilitySearchValues
getCompatibilitySearchValuesBulk
getProductSearchValues
getProductSearchValuesBulk
Conditionally
This will be populated for
non-fitment enabled category
getCompatibilitySearchValues
getCompatibilitySearchValuesBulk
getProductSearchValues
getProductSearchValuesBulk
Conditionally
Indicates whether the response is flat or in a hierarchical tree
format.
false
getCompatibilitySearchValues
getCompatibilitySearchValuesBulk
getProductSearchValues
getProductSearchValuesBulk
Always
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 (for bulk calls) property names. You
can look up valid values using either the <b
class="con">getProductSearchNames</b> call or the <b
class="con">getCompatibilitySearchNames</b> call.
getCompatibilitySearchValues
getCompatibilitySearchValuesBulk
getProductSearchValues
getProductSearchValuesBulk
No
Order of the sort, either Ascending or Descending.
getCompatibilitySearchValues
getCompatibilitySearchValuesBulk
getProductSearchValues
getProductSearchValuesBulk
No
[NOT USED BY ANY CALLS] Orphan type.
Sorts results in ascending (low to high) order.
Sorts results in descending (high to low) order.
This operation will provide the ability to get properties of the application.
For example, if the input category is tires, then the response would return
the following properties:
<ul>
<li>Make</li>
<li>Model</li>
<li>Year</li>
<li>Trim</li>
<li>Engine</li>
</ul>
Returns all properties within a fitment category of the specified catalog-
enabled category.
getCompatibilitySearchDataVersion, getCompatibilitySearchValues, getCompatibilitySearchValuesBulk
Specifies the category from which you want to retrieve compatibility
property names that can be used to search for products. Provide the
interface category ID. For example, to get the cars properties,
provide tires category ID. The category must be compatibility-
enabled.
<br><br>
If a specified category ID doesn't match an existing compatibility-
enabled category for the site, eBay returns an error. To determine
valid compatibility-enabled categories, use the Trading API <a
href="https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetCategoryFeatures.html"
>GetCategoryFeatures</a> call.
10
getCompatibilitySearchNames
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>
DisplayableSearchResults
getCompatibilitySearchNames
No
Response containter for getProductSearchValuesBulk call.
Response containter for getCompatibilitySearchValuesBulk call.
TBD
getCompatibilitySearchValuesBulk
Always
Container for request to retrieve product search values in bulk.
Retrieves property values for multiple fields (up to 10).
This is the canonical name of the property. Used
to identify a property within a catalog that
this category belongs to.
10
100
getCompatibilitySearchValuesBulk
getProductSearchValuesBulk
No
Specifies the type of dataset.
Indicates ....
Indicates ....
Indicates ....
Indicates ....
Indicates ....
Indicates ....
This will return the metadata version of the name and/or
value metadata for the input catalog id.
Get the metadata version for the specified category.
Specifies the category for which you want to retrieve version
information about the product metadata.
<br><br>
If a specified category ID doesn't match an existing category for the
site, eBay returns an invalid-category error message. To determine
valid categories, use the Trading API <a
href="https://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetCategories.html">GetCategories</a>
call.
10
getCompatibilitySearchDataVersion
getProductSearchDataVersion
Yes
Response container for getCompatibilitySearchDataVersion and
getProductSearchDataVersion calls.
Time and version for the most recent update of catalog property names
for the specified category.
getCompatibilitySearchDataVersion
getProductSearchDataVersion
Conditionally
Time and version for the most recent update of catalog property
values for the specified category.
getCompatibilitySearchDataVersion
getProductSearchDataVersion
Conditionally
Details about the current version of the metadata used for searching for compatibilities or products.
Version number for the current search metadata (product or
compatibility). If you are maintaining search metadata locally, compare
this value to the version of the search metadata you last downloaded to
determine whether the data may have changed.
getCompatibilitySearchDataVersion
getProductSearchDataVersion
Always
Indicates the date and time the current search metadata was updated.
getCompatibilitySearchDataVersion
getProductSearchDataVersion
Always
This is the base class for request container for
all service operations.
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
Documentation goes here
This is the base class for request container for
all service operations.
Base response container for service operations. Contains error information
associated with 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
Version number for the current search metadata (product or
compatibility). If you are maintaining search metadata locally, compare
this value to the version of the search metadata you last downloaded to
determine whether the data may have changed.
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.
This type holds a numeric value.
A number value.
getCompatibilitySearchValues
getCompatibilitySearchValuesBulk
getProductSearchValues
getProductSearchValuesBulk
No
getCompatibilitySearchValues
getCompatibilitySearchValuesBulk
getProductSearchValues
getProductSearchValuesBulk
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.
getCompatibilitySearchValues
getCompatibilitySearchValuesBulk
getProductSearchValues
getProductSearchValuesBulk
No
getCompatibilitySearchValues
getCompatibilitySearchValuesBulk
getProductSearchValues
getProductSearchValuesBulk
Conditionally
Properties about ...
Version information reflects the latest update of the properties or
values.
getCompatibilitySearchNames
getProductSearchNames
Conditionally
This is the canonical name of the property. Used
to identify a property within a catalog that
this category belongs to.
getCompatibilitySearchNames
getProductSearchNames
Conditionally
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>
getCompatibilitySearchNames
getProductSearchNames
Conditionally
Container for details about an individual compatibility or product property.
This is the canonical name of the property. Used
to identify a property within a catalog that
this category belongs to.
getCompatibilitySearchNames
getProductSearchNames
Conditionally
Metadata for the property.
getCompatibilitySearchNames
getProductSearchNames
Conditionally
This will be the display name of the property
getCompatibilitySearchNames
getProductSearchNames
Conditionally
This will contain any metadata about the propert name.
A numeric value indicating the ordering position for the property.
getCompatibilitySearchNames
getProductSearchNames
Conditionally
Container type for property name value pairs.
This is the canonical name of the property. Used
to identify a property within a catalog that
this category belongs to.
getCompatibilitySearchValues
getCompatibilitySearchValuesBulk
getProductSearchValues
getProductSearchValuesBulk
Conditionally
A value for the property.
getCompatibilitySearchValues
getCompatibilitySearchValuesBulk
getProductSearchValues
getProductSearchValuesBulk
Conditionally
Property name value pairs that are children to other properties. Only
returned when the response is returned as a propertyValuesTree.
2
getCompatibilitySearchValues
getCompatibilitySearchValuesBulk
getProductSearchValues
getProductSearchValuesBulk
Conditionally
Contains a property name and corresponding value or values.
This is the canonical name of the property. Used
to identify a property within a catalog that
this category belongs to.
getCompatibilitySearchValues
getCompatibilitySearchValuesBulk
getProductSearchValues
getProductSearchValuesBulk
No
getCompatibilitySearchValues
getCompatibilitySearchValuesBulk
getProductSearchValues
getProductSearchValuesBulk
Conditionally
A value for the property.
getCompatibilitySearchValues
getCompatibilitySearchValuesBulk
getProductSearchValues
getProductSearchValuesBulk
No
getCompatibilitySearchValues
getCompatibilitySearchValuesBulk
getProductSearchValues
getProductSearchValuesBulk
Conditionally
This class holds a String value
A string value.
getCompatibilitySearchValues
getCompatibilitySearchValuesBulk
getProductSearchValues
getProductSearchValuesBulk
No
getCompatibilitySearchValues
getCompatibilitySearchValuesBulk
getProductSearchValues
getProductSearchValuesBulk
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.
getCompatibilitySearchValues
getCompatibilitySearchValuesBulk
getProductSearchValues
getProductSearchValuesBulk
No
getCompatibilitySearchValues
getCompatibilitySearchValuesBulk
getProductSearchValues
getProductSearchValuesBulk
Conditionally
Defines the different types of values that a property can have.
For string value type.
getCompatibilitySearchValues
getCompatibilitySearchValuesBulk
getProductSearchValues
getProductSearchValuesBulk
No
getCompatibilitySearchValues
getCompatibilitySearchValuesBulk
getProductSearchValues
getProductSearchValuesBulk
Conditionally
For numeric value type.
getCompatibilitySearchValues
getCompatibilitySearchValuesBulk
getProductSearchValues
getProductSearchValuesBulk
No
getCompatibilitySearchValues
getCompatibilitySearchValuesBulk
getProductSearchValues
getProductSearchValuesBulk
Conditionally
For URL value type.
getCompatibilitySearchValues
getCompatibilitySearchValuesBulk
getProductSearchValues
getProductSearchValuesBulk
No
getCompatibilitySearchValues
getCompatibilitySearchValuesBulk
getProductSearchValues
getProductSearchValuesBulk
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.
The request was processed successfully, but something occurred that may
affect your application or 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 that triggered the error was processed successfully but with some warnings.
The request that triggered the error was processed successfully but with
some warnings.
Defines the characteristics of a property for a community catalog metadata.
this is label for the property that
should be used for making products data.
getProductMetadataBulk
Always
Value that may be used in place of the property name value
(propertyMetadata.propertyName) when adding a product to an eBay catalog.
Only returned when there are synonymous property names available.
getProductMetadataBulk
Conditionally
The data type for the property value.
<dl>
<dt>
<strong>dataType values:</strong>
</dt>
<dt>
STRING
</dt>
<dd>
A string of characters. This data type typically applies to
text-based property values, such as names, titles, and descriptions.
All characters in the Unicode character set are supported.
<br><br>
Refer to <b
class="con">typeSpecificInformation.stringTypeSpecificInformation</b>
for additional value constraints.
</dd>
<dt>
NUMERIC
</dt>
<dd>
A number, which typically describes a product dimension, such as
weight or memory capacity.
<br><br>
Refer to <b
class="con">typeSpecificInformation.numericTypeSpecificInformation</b>
for additional value constraints.
</dd>
<dt>
URI
</dt>
<dd>
Specifies a Uniform Resource Identifier (URI), a compact sequence of
characters that identifies an abstract or physical resource.
<br><br>
Refer to <b
class="con">typeSpecificInformation.uriTypeSpecificInformation</b>
for additional value constraints.
</dd>
<dt>
MEDIA
</dt>
<dd>
Reserved for future use.
<br><br>
Refer to <b
class="con">typeSpecificInformation.stringTypeSpecificInformation</b>
for additional value constraints.
</dd>
</dl>
getProductMetadataBulk
Always
Container for any type-specific constraints for property values.
getProductMetadataBulk
Always
Indicates whether or not more than one value can be specified for a given
property when adding a product to an eBay catalog. When true, multiple values can be specified for the given property.
getProductMetadataBulk
Always
The official unique property name for use as a primary key for locally
stored metadata. This value is not used for product creation. Use
productMetadata.propertyName instead for adding a product to an eBay
catalog.
getProductMetadataBulk
Always
Name-value pairs that provide additional descriptive details about the
property when needed. This information is not used for adding a product
to an eBay catalog, but can provide clarification about an individual
property. For example, propertyTags information could indicate that a
specific property constitutes a unique product identifier.
getProductMetadataBulk
Conditionally
Describes the given property.
getProductMetadataBulk
Conditionally
Container for data type-specific constraints for property values.
Specifies the constraints for property values that are of type URI.
Currently, there are no constraints for URI type properties.
getProductMetadataBulk
Conditionally
Specifies the constraints for property values that are of type numeric.
getProductMetadataBulk
Conditionally
Specifies the constraints, if any, for property values that are of type
media. Currently, there are no constraints for media type properties,
which apply to images only. Media type properties are specified as a URL
in the addProducts request.
getProductMetadataBulk
Conditionally
Specifies the constraints for property values that are of type string. In
most cases, this is simply the maximum number of characters allowed in
the string. In some cases, a list of managed (known good) values may also
be returned.
getProductMetadataBulk
Conditionally
Container for any string type constraint information.
Specifies a known good value for the given property. For example, for
digital cameras, eBay may maintain a list of brands, camera types, lens
types, focus types, etc. When possible, use a managed value to ensure
consistent spelling and capitalization.
getProductMetadataBulk
Conditionally
Specifies the maximum number of characters that can be submitted for the
given property value. Always returned for string values.
getProductMetadataBulk
Conditionally
Container for any numeric type constraint information.
Specifies the unit of measurement (e.g., lb or kg) associated with the
given numeric value.
getProductMetadataBulk
Conditionally
Specifies the highest numeric value that can be submitted for the given
property value. Always returned for numeric values.
getProductMetadataBulk
Conditionally
Container for any URI type constraint information.
Container for any media type constraint information.
Defines the product metadata associated with eBay catalog products for the
given category.
Contains all the metadata associated with a specific property, such as
Title or Brand.
getProductMetadataBulk
Always
Some product properties share a common characteristic, such as being
required for product creation or qualifying as a globally unique
identifier (GUID). The required properties group contains the minimum set
of properties you must submit to add a product to an eBay catalog. GUID
properties make products easier to find and can improve search rankings
for associated listings.
getProductMetadataBulk
Conditionally
Specifies the current version of the metadata for the given category.
getProductMetadataBulk
Always
contains the product metadata ( aka catalog metadata)
Product metadata for the specified category. This product metadata
provides all the requirements and constraints to submit a new product
for inclusion into the eBay catalog associated with the given
category. Product metadata consists of metadata for individual
properties, property group information, and the version of the
product metadata for the category.
getProductMetadataBulk
Always
The corresponding productMetadataRequest that was passed in the
getProductMetadataBulk request.
getProductMetadataBulk
Always
Request container for a batch of individual requests for product metadata for
a specific category.
Retrieves product metadata needed to add a product to the eBay catalog for
the specified category.
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.
Product
http://developer.ebay.com/DevZone/product/CallRef
addProducts
Adds products to the eBay catalog.
Request to retrieve product metadata for a single category. Your
getProductMetadtaBulk request may contain three
productMetadataRequest containers. Each container must specify a
valid category ID for the eBay site specified in the
X-EBAY-SOA-GLOBAL-ID header.
3
getProductMetadataBulk
Yes
Defines single request to fetch product metadata( aka catalog metadata) based on category
id and site id and some optional parameters
Specifies the leaf category from which you want to retrieve product metadata information that can be used to add products into the corresponding eBay catalog.
<br><br>
If the specified category is not enabled for product creation, eBay returns an error. Use <a
href="http://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetCategoryFeatures.html"
>GetCategoryFeatures</a> (Trading API) with <b
class="con">FeatureID</b> set to "ProductCreationEnabled"
to identify categories that are enabled for product creation.
10
getProductMetadataBulk
Yes
Always
If true, the response will include managed values (approved standard
values) for certain string-based properties, such as brand or device
type. Managed values are not maintained for all properties, but when
they are available, they can be used as an enumeration list to create
a selection list. When possible, use a managed value to ensure
consistent spelling and capitalization.
false
getProductMetadataBulk
No
Conditionally
Reserved for future use. Currently, both group properties (<b
class="con"
>productMetadataResponse.productMetadata.groupProperties</b>)
and property metadata (<b
class="con"
>productMetadataResponse.productMetadata.propertyMetadata</b>)
are always returned.
false
getProductMetadataBulk
No
Conditionally
Reserved for future use. Currently, all supported group types are
returned.
getProductMetadataBulk
No
Conditionally
Defines batch response where each response elements contains product metadata ( aka catalog
metadata) based on request criteria
Product metadata for the category specified in the corresponding <b
class="con">productMetadataRequest</b> in the request.
Product metadata consists of individual property metadata, group
properties, the metadata version, and the corresponding request.+++
getProductMetadataBulk
Always
Supplemental information about a property in the form of name-value pairs.
The name part of the name-value pair.
getProductMetadataBulk
Conditionally
The datatype of the value part of the name-value pair (e.g., BOOLEAN,
STRING, or NUMERIC).
getProductMetadataBulk
Conditionally
Value part of the name-value pair. One or more values may be associated
with a given name.
getProductMetadataBulk
Conditionally
Reserved for future use.
getProductMetadataBulk
Conditionally
Response container for defining a group of properties. It contains the group
type, the display name of the group, and the properties included in the
group.
Identifies the nature of a given group of properties.
<dl>
<dt>
<b>Allowed values:</b>
</dt>
<dt>
REQUIRED_PROPERTIES
</dt>
<dd>
Properties that must be specified to add a product to the eBay
catalog for the given category.
</dd>
<dt>
GUID_PROPERTIES
</dt>
<dd>
Properties (e.g., EAN or MPN) that qualify as globally unique
identifiers (GUIDs) for a product. GUID properties make products
easier to find and can improve search rankings for associated
listings.
</dd>
</dl>
getProductMetadataBulk
Conditionally
A displayable name for the given group type.
getProductMetadataBulk
Conditionally
Basic information for an individual property, consisting of the property
name and any supplemental tags (name-value pair information) to describe
the property, when needed. Use property metadata for more details about a property, including datatype constraints.
getProductMetadataBulk
Conditionally
Reserved for future use.
getProductMetadataBulk
Conditionally
Defines a container for properties contained in this group.
Name of the property for use as input in the corresponding propertyName
field in the addProducts request. See the corresponding propertyMetadata
container with the same propertyName for property details.
getProductMetadataBulk
Conditionally
Name-value pairs that provide additional descriptive details about the
property when needed. This information is not used for adding a product
to an eBay catalog, but can provide clarification about an individual
property. For example, tag information could indicate that a specific
property constitutes a unique product identifier.
getProductMetadataBulk
Conditionally
Retrieves all available values and their dependencies for a given product
property or a group of properties (of the product catalog). These values,
along with their respective properties, can be used to search for products.
Retrieves all available values and their dependencies for a given compatibility
property or a group of compatibility properties. These values, along with their
respective properties, can be used to search for products .
This operation provides product metadata( aka catalog metadata). This can be used to create addProduct call in ProductService API.
1.3
This service provides the ability to get product medata. Metadata includes
product property names and values. This also provides the ability to get metadata
about specific kind of properties like searchable, sortable, displayable etc
1.3.0
1.3.0