No longer recommended, except for determining whether a category is catalog-enabled. All other features of this call relate to an older format for listing with item specifics and catalog details, which is no longer supported.
The following information is being provided for developers who are still migrating their applications off of this call. New applications should not use GetCategory2CS in most cases.
Use this call to retrieve the mappings between categories and their corresponding characteristic sets. You can retrieve all category mappings, or just those that match the category ID passed in the call. (This process is similar to using GetCategories to retrieve the eBay category structure for a specified site.)
When using GetCategory2CS, you also typically also use GetCategories. Use GetCategories to build a category tree and determine parent-child relationships between categories. Using this information, you can then use GetCategory2CS to determine which categories are attribute-enabled and which ones are catalog-enabled for the categories in which you are interested.
Any category ID you pass into GetCategory2CS must be a valid; use GetCategories (or use GetCategory2CS without specifying a category ID) to determine the current list of valid category IDs on the target eBay site.
GetCategory2CS returns detailed information for each mapping into MappedCategoryArray and UnmappedCategoryArray containers. Within these containers, mappings are returned in CategoryArrayType objects. As applicable for the application, store the mappings for each category locally. Also store the current version of the meta-data so that in the future you can use it as a filter to retrieve only the data that has changed.
Note that changes to the mappings on one site are independent of changes to another site. So while one site's mappings may not have changed, the mappings for other sites may have. Because of this, the mapping version must be checked separately for each eBay site supported by the application.
You can control the fields returned by the call by specifying different DetaileLevel values. As well, you can use the CategoryID property to retrieve mappings for only the category specified.
Use AttributeSystemVersion to specify the last version for which your application has mappings. eBay returns the mapping information that has changed since the version you specify in AttributeSystemVersion.
If you do not specify a category ID, GetCategory2CS might return zero, one, or multiple category mappings. There is no maximum limit to the quantity of mappings that can be returned.
Use AttributeSystemVersion in combination with a DetailLevel settings to control the data that is returned from this call:
ReturnAll, and not setting AttributeSystemVersion or CategoryID filters. This retrieves a complete set of the latest information for all of the site's characteristics sets. Save the AttributeSystemVersion value and all the mapping information that is returned.Note that the current value of AttributeSystemVersion is not necessarily "greater than" the previous value. Therefore, when comparing versions, you should merely test whether or not the current value of AttributeVersion is identical to the version information you have stored locally. If the version has changed, you can perform a step to retrieve the latest mappings.
ReturnAll to retrieve all information about the mappings that have changed.Using the AttributeSystemVersion input argument, specify the version for the most recent complete set of results that you saved. This retrieves all changes that have occurred since that version of the mapping. Save the new AttributeSystemVersion value (as a reference point for the next time you execute the call) and all mapping information that is returned in the result set.
You can also use the CategoryID as a filter to limit the results to the updated mappings for a specific category. Use caution when working with result sets that are filtered by CategoryID. For example, do not overwrite the last version information you saved (for the complete mapping) with the version value of a CategoryID filtered result set. Otherwise, the next time you execute GetCategory2CS with the AttributeSystemVersion filter, you will pass the wrong version information and your locally stored mapping information might become inconsistent with respect to eBay's mapping structure.
In general, it is sufficient to execute GetCategory2CS once on each day that you are using the meta-data. To reduce the number of calls you need to make, retrieve all the characteristics set data for the site, rather than just the information individual categories. Store the data locally and reuse it for the rest of the day.
Test calls to GetCategory2CS with different combinations of detail level and category ID filtering to cover all of the possible scenarios the application might have to accommodate under real world usage conditions.
| Output Detail Controls Samples Change History Top Errors for GetCategory2CS User Notes |
The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).
See also Samples.
See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.
The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).
<?xml version="1.0" encoding="utf-8"?>
<GetCategory2CSRequest xmlns="urn:ebay:apis:eBLBaseComponents">
<!-- Call-specific Input Fields -->
<AttributeSystemVersion> string </AttributeSystemVersion>
<CategoryID> string </CategoryID>
<!-- Standard Input Fields -->
<DetailLevel> DetailLevelCodeType </DetailLevel>
<!-- ... more DetailLevel values allowed here ... -->
<ErrorLanguage> string </ErrorLanguage>
<MessageID> string </MessageID>
<Version> string </Version>
<WarningLevel> WarningLevelCodeType </WarningLevel>
</GetCategory2CSRequest>
| Argument | Type | Occurrence | Meaning |
|---|
| Call-specific Input Fields [Jump to standard fields] |
| AttributeSystemVersion | string | Optional | A version of the mappings for the site. Typically, an application passes the version value that was returned the last time the application executed this call. Filter that causes the call to return only the categories for which the mappings have changed since the specified version. If not specified, all category-to-characteristics set mappings are returned. This value changes each time changes are made to the mappings. The current version value is not necessarily greater than the previous value. Therefore, when comparing versions, only compare whether the value has changed. |
| CategoryID | string | Optional |
ID of a category for which to retrieve mappings. If not specified, the call retrieves a map for all categories. Max length: 10. |
| Standard Input Fields |
| DetailLevel | DetailLevelCodeType | Optional,
repeatable: [0..*] |
Detail levels are instructions that define standard subsets of data to return for particular data components (e.g., each Item, Transaction, or User) within the response payload. For example, a particular detail level might cause the response to include buyer-related data in every result (e.g., for every Item), but no seller-related data. Specifying a detail level is like using a predefined attribute list in the SELECT clause of an SQL query. Use the DetailLevel element to specify the required detail level that the client application needs pertaining to the data components that are applicable to the request. The DetailLevelCodeType defines the global list of available detail levels for all request types. Most request types support certain detail levels or none at all. If you pass a detail level that exists in the schema but that isn't valid for a particular request, eBay ignores it processes the request without it. For each request type, see the detail level tables in the Input/Output Reference to determine which detail levels are applicable and which elements are returned for each applicable detail level. (Some detail level tables are still in the eBay Web Services guide. They will be moved to the Input/Output Reference in a future release.) Note that DetailLevel is required input for GetMyMessages. With GetSellerList and other calls that retrieve large data sets, please avoid using ReturnAll when possible. For example, if you use GetSellerList, use a GranularityLevel or use the GetSellerEvents call instead. If you do use ReturnAll with GetSellerList, use a small EntriesPerPage value and a short EndTimeFrom/EndTimeTo range for better performance. Applicable values: • ReturnAll (in) Returns all available data. With GetSellerList and other calls that retrieve large data sets, please avoid using ReturnAll when possible. For example, if you use GetSellerList, use a GranularityLevel or use the GetSellerEvents call instead. If you use ReturnAll with GetSellerList, use a small EntriesPerPage value and a short EndTimeFrom/EndTimeTo range for better performance. (Not all values in DetailLevelCodeType apply to this field.) |
| ErrorLanguage | string | Optional |
Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Specify the standard RFC 3066 language identification tag (e.g., en_US). ID--- country ----- ----- de_AT Austria de_CH Switzerland de_DE Germany en_AU Australia en_CA Canada en_GB United Kingdom en_SG Singapore en_US United States es_ES Spain fr_BE Belgium (French) fr_CA Canada (French) fr_FR France it_IT Italy nl_BE Belgium (Dutch) nl_NL Netherlands zh_CN China en_IN India en_IE Ireland zh_HK Hong Kong |
| MessageID | string | Optional |
Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned. Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable. |
| Version | string | Conditional |
The version number of the API code that you are programming against (e.g., 549). The version you specify for a call has these basic effects: - It indicates the version of the code lists and other data that eBay should use to process your request. - It indicates the schema version you are using. You need to use a version that is greater than or equal to the lowest supported version. For the SOAP API: If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using. For the XML API: If you are using the XML API, this field has no effect. Instead, specify the version in the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. (If you specify Version in the body of an XML API request and it is different from the value in the HTTP header, eBay returns an informational warning that the value in the HTTP header was used instead.) See:
|
| WarningLevel | WarningLevelCodeType | Optional |
Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request. An unrecognized element is one that is not defined in any supported version of the schema. Schema element names are case-sensitive, so using WarningLevel can also help you remove any potential hidden bugs within your application due to incorrect case or spelling in field names before you put your application into the Production environment. WarningLevel only validates elements; it doesn't validate XML attributes. It also doesn't control warnings related to user-entered strings or numbers, or warnings for logical errors. We recommend that you only use this during development and debugging. Do not use this in requests in your production code. Applicable values: • High (in) Return warnings when the application passes unrecognized or deprecated elements in a request. • Low (in) Do not return warnings when the application passes unrecognized or deprecated elements in a request. This is the default value if WarningLevel is not specified. See Warning Level. |
| Input Detail Controls Samples Change History Top Errors for GetCategory2CS User Notes |
The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).
See also Samples.
See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).
<?xml version="1.0" encoding="utf-8"?>
<GetCategory2CSResponse xmlns="urn:ebay:apis:eBLBaseComponents">
<!-- Call-specific Output Fields -->
<AttributeSystemVersion> string </AttributeSystemVersion>
<MappedCategoryArray> CategoryArrayType
<Category> CategoryType
<CatalogEnabled> boolean </CatalogEnabled>
<CategoryID> string </CategoryID>
<CharacteristicsSets> CharacteristicsSetType
<AttributeSetID> int </AttributeSetID>
<AttributeSetVersion> string </AttributeSetVersion>
<Name> string </Name>
</CharacteristicsSets>
<!-- ... more CharacteristicsSets nodes allowed here ... -->
<ProductFinderIDs> ExtendedProductFinderIDType
<ProductFinderBuySide> boolean </ProductFinderBuySide>
<ProductFinderID> int </ProductFinderID>
</ProductFinderIDs>
<!-- ... more ProductFinderIDs nodes allowed here ... -->
<ProductSearchPageAvailable> boolean </ProductSearchPageAvailable>
</Category>
<!-- ... more Category nodes allowed here ... -->
</MappedCategoryArray>
<SiteWideCharacteristicSets> SiteWideCharacteristicsType
<CharacteristicsSet> CharacteristicsSetType
<AttributeSetID> int </AttributeSetID>
<AttributeSetVersion> string </AttributeSetVersion>
<Name> string </Name>
</CharacteristicsSet>
<ExcludeCategoryID> string </ExcludeCategoryID>
<!-- ... more ExcludeCategoryID values allowed here ... -->
</SiteWideCharacteristicSets>
<!-- ... more SiteWideCharacteristicSets nodes allowed here ... -->
<UnmappedCategoryArray> CategoryArrayType
<Category> CategoryType
<CategoryID> string </CategoryID>
</Category>
<!-- ... more Category nodes allowed here ... -->
</UnmappedCategoryArray>
<!-- Standard Output Fields -->
<Ack> AckCodeType </Ack>
<Build> string </Build>
<CorrelationID> string </CorrelationID>
<Errors> ErrorType
<ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
<ErrorCode> token </ErrorCode>
<ErrorParameters ParamID="string"> ErrorParameterType
<Value> string </Value>
</ErrorParameters>
<!-- ... more ErrorParameters nodes allowed here ... -->
<LongMessage> string </LongMessage>
<SeverityCode> SeverityCodeType </SeverityCode>
<ShortMessage> string </ShortMessage>
</Errors>
<!-- ... more Errors nodes allowed here ... -->
<HardExpirationWarning> string </HardExpirationWarning>
<Timestamp> dateTime </Timestamp>
<Version> string </Version>
</GetCategory2CSResponse>
| Return Value | Type | Occurrence | Meaning |
|---|
| Call-specific Output Fields [Jump to standard fields] |
| AttributeSystemVersion | string | Always |
Current version of the mappings for the site. This value changes each time changes are made to the mappings. The current version value is not necessarily greater than the previous value. Therefore, when comparing versions, only compare whether the value has changed.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| MappedCategoryArray | CategoryArrayType | Conditionally |
Contains data about categories that are mapped to characteristics sets. Use this data to determine: - The names and IDs of the characteristics sets - The availability of the Pre-filled Item Information feature for listings in that category (i.e., whether the category is catalog-enabled) - For catalog-enabled categories, the available product search methods - The current version information for the complete mapping - The version information for each characteristics set DetailLevel: ReturnAll. |
| MappedCategoryArray.Category | CategoryType | Always,
repeatable: [1..*] |
Contains details about one category. For GetCategories, this node is not returned when no detail level is specified. |
|
MappedCategoryArray.Category .CatalogEnabled |
boolean | Conditionally |
If true, the category supports catalog product details. Not returned if false.
DetailLevel: ReturnAll. |
|
MappedCategoryArray.Category .CategoryID |
string | Always |
Distinct numeric ID for a category on eBay. In GetItem and related calls, see CategoryName for the text name of the category. Use GetCategories to look up the category parent ID. For GetItem, Half.com items return the Half.com category ID in PrimaryCategory. This ID is not necessarily returned in GetCategories. Max length: 10. DetailLevel: ReturnAll. |
|
MappedCategoryArray.Category .CharacteristicsSets |
CharacteristicsSetType | Conditionally,
repeatable: [0..*] |
Deprecated as of version 773. No longer recommended. Use FindProducts (Shopping API) instead. No longer applicable to any category. DetailLevel: ReturnAll. Deprecation version: 773. See also Deprecated Objects. |
|
MappedCategoryArray.Category .CharacteristicsSets .AttributeSetID |
int | Conditionally |
Deprecated as of version 773. Numeric value that identifies the characteristic set in a language-independent way. Identifies the characteristic set that is mapped to a catalog-enabled category associated with the product. Unique across all eBay sites. DetailLevel: ReturnAll. Deprecation version: 773. See also Deprecated Objects. |
|
MappedCategoryArray.Category .CharacteristicsSets .AttributeSetVersion |
string | Conditionally |
Deprecated as of version 773. Version of the characteristics set. Not to be confused with AttributeSystemVersion, which can be used to retrieve changes to attribute meta-data. In item-listing requests, if you specify the version of the attribute set that you have stored locally, eBay will compare it to the current version on the site and return a warning if the versions do not match. If an error occurs due to invalid attribute data, this warning can be useful to help determine if you might be sending outdated data. The current value of version is not necessarily "greater than" the previous value. DetailLevel: ReturnAll. Deprecation version: 773. See also Deprecated Objects. |
|
MappedCategoryArray.Category .CharacteristicsSets.Name |
string | Conditionally |
Deprecated as of version 773. The well-known name of the characteristic set (e.g., "Tickets" or "Books"). DetailLevel: ReturnAll. Deprecation version: 773. See also Deprecated Objects. |
|
MappedCategoryArray.Category .ProductFinderIDs |
ExtendedProductFinderIDType | Conditionally,
repeatable: [0..*] |
Deprecated as of version 773. No longer recommended. Use FindProducts (Shopping API) instead. No longer applicable to any category. DetailLevel: ReturnAll. Deprecation version: 773. See also Deprecated Objects. |
|
MappedCategoryArray.Category .ProductFinderIDs .ProductFinderBuySide |
boolean | Conditionally |
Deprecated as of version 773. If false or not present, the product finder can be used as input to GetProductSearchResults to search for catalog data (Pre-filled Item Information) that a seller might want to include in a listing. DetailLevel: ReturnAll. See Knowledge Base: ProductFinderID for Buy-Side Searches. Deprecation version: 773. See also Deprecated Objects. |
|
MappedCategoryArray.Category .ProductFinderIDs .ProductFinderID |
int | Conditionally |
Deprecated as of version 773. A product finder ID. GetCategory2CS always (and only) returns this when Category.ProductFinderIDs is returned. DetailLevel: ReturnAll. Deprecation version: 773. See also Deprecated Objects. |
|
MappedCategoryArray.Category .ProductSearchPageAvailable |
boolean | Conditionally |
Deprecated as of version 773. No longer recommended. Use FindProducts (Shopping API) instead. No longer applicable to any category. DetailLevel: ReturnAll. Deprecation version: 773. See also Deprecated Objects. |
| SiteWideCharacteristicSets | SiteWideCharacteristicsType | Conditionally,
repeatable: [0..*] |
Deprecated as of version 773. No longer recommended. Use GetCategoryFeatures instead. A list of one or more characteristics sets mapped to the category, if any. Use this information when working with Item Specifics (Attributes) and Pre-filled Item Information (Catalogs) functionality. DetailLevel: ReturnAll. Deprecation version: 773. See also Deprecated Objects. |
|
SiteWideCharacteristicSets .CharacteristicsSet |
CharacteristicsSetType | Conditionally |
Deprecated as of version 773. No longer applicable to any category. DetailLevel: ReturnAll. Deprecation version: 773. See also Deprecated Objects. |
|
SiteWideCharacteristicSets .CharacteristicsSet .AttributeSetID |
int | Conditionally |
Deprecated as of version 773. Numeric value that identifies the characteristic set in a language-independent way. Identifies the characteristic set that is mapped to a catalog-enabled category associated with the product. Unique across all eBay sites. DetailLevel: ReturnAll. Deprecation version: 773. See also Deprecated Objects. |
|
SiteWideCharacteristicSets .CharacteristicsSet .AttributeSetVersion |
string | Conditionally |
Deprecated as of version 773. Version of the characteristics set. Not to be confused with AttributeSystemVersion, which can be used to retrieve changes to attribute meta-data. In item-listing requests, if you specify the version of the attribute set that you have stored locally, eBay will compare it to the current version on the site and return a warning if the versions do not match. If an error occurs due to invalid attribute data, this warning can be useful to help determine if you might be sending outdated data. The current value of version is not necessarily "greater than" the previous value. DetailLevel: ReturnAll. Deprecation version: 773. See also Deprecated Objects. |
|
SiteWideCharacteristicSets .CharacteristicsSet.Name |
string | Conditionally |
Deprecated as of version 773. The well-known name of the characteristic set (e.g., "Tickets" or "Books"). DetailLevel: ReturnAll. Deprecation version: 773. See also Deprecated Objects. |
|
SiteWideCharacteristicSets .ExcludeCategoryID |
string | Conditionally,
repeatable: [0..*] |
Deprecated as of version 773. A category that does not support the specified site-wide characteristics set. DetailLevel: ReturnAll. Deprecation version: 773. See also Deprecated Objects. |
| UnmappedCategoryArray | CategoryArrayType | Conditionally |
Deprecated as of version 773. No longer recommended. Contains data about categories (if any) whose characteristics set mappings have changed since the version specified in the request. When a characteristics set mapping changes, the data appears in both the UnmappedCategoryArray object (to indicate that the change occurred) and the MappedCategoryArray object. DetailLevel: ReturnAll. Deprecation version: 773. See also Deprecated Objects. |
| UnmappedCategoryArray.Category | CategoryType | Always,
repeatable: [1..*] |
Deprecated as of version 773. Contains details about one category. For GetCategories, this node is not returned when no detail level is specified. Deprecation version: 773. See also Deprecated Objects. |
|
UnmappedCategoryArray.Category .CategoryID |
string | Conditionally |
Deprecated as of version 773. Distinct numeric ID for a category on eBay. In GetItem and related calls, see CategoryName for the text name of the category. Use GetCategories to look up the category parent ID. For GetItem, Half.com items return the Half.com category ID in PrimaryCategory. This ID is not necessarily returned in GetCategories. Max length: 10. DetailLevel: ReturnAll. Deprecation version: 773. See also Deprecated Objects. |
| Standard Output Fields |
| Ack | AckCodeType | Always |
A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for Ack.
Applicable values: • CustomCode (out) Reserved for internal or future use. • Failure (out) Request processing failed • Success (out) Request processing succeeded • Warning (out) Request processing completed with warning information being included in the response message (Not all values in AckCodeType apply to this field.) |
| Build | string | Always | This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues. |
| CorrelationID | string | Conditionally |
Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned. Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable. |
| Errors | ErrorType | Conditionally,
repeatable: [0..*] |
A list of application-level errors (if any) that occurred when eBay processed the request.
See Error Handling. |
| Errors.ErrorClassification | ErrorClassificationCodeType | Conditionally |
API errors are divided between two classes: system errors and request errors.
Applicable values: • CustomCode (out) Reserved for internal or future use. • RequestError (out) An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data. • SystemError (out) Indicates that an error has occurred on the eBay system side, such as a database or server down. 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. |
| Errors.ErrorCode | token | Conditionally | 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. See the "Errors by Number" document. |
| Errors.ErrorParameters | ErrorParameterType | Conditionally,
repeatable: [0..*] |
This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned. |
| Errors.ErrorParameters [ attribute ParamID ] |
string | Conditionally | The index of the parameter in the list of parameter types returned within the error type. |
| Errors.ErrorParameters.Value | string | Conditionally | The value of the variable (e.g., the attribute set ID) |
| Errors.LongMessage | string | Conditionally | A more detailed description of the condition that raised the error. |
| Errors.SeverityCode | SeverityCodeType | 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.
Applicable values: • CustomCode (out) Reserved for internal or future use • Error (out) Application-level error • Warning (out) Warning or informational error |
| Errors.ShortMessage | string | Conditionally | A brief description of the condition that raised the error. |
| HardExpirationWarning | string | Conditionally | Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token. |
| Timestamp | dateTime | Always |
This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone. Note: GetCategories and other Trading API calls are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed. |
| Version | string | Always | The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See "Standard Data for All Calls" in the eBay Web Services Guide for information on using the response version when troubleshooting "CustomCode" values that appear in the response. |
| Input Output Samples Change History Top Errors for GetCategory2CS User Notes |
The DetailLevel input field influences which call-specific fields may be returned. (All standard output fields are returned regardless of DetailLevel.)
The none column indicates the fields that are returned when you do not specify a DetailLevel.
| Detail Level value | Summary of Effects |
|---|---|
| none (no detail level specified) | Returns the attribute system version (with no mappings). Use this level when you only want to check whether to refresh your locally stored attribute meta-data. If the version hasn't changed, you don't need to refresh your local meta-data. |
| ReturnAll | Returns the attribute system version and all mappings of categories to characteristic sets. (The exact data returned also depends on other filters specified in the request.) |
| Y | The field is always returned. |
| (Y) | The field is conditionally returned. See the field documentation for clarification of conditions. |
| - | The field is not returned. |
| Input Output Detail Controls Change History Top Errors for GetCategory2CS User Notes |
New to making API calls? Please see Routing the Request.
Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.
Retrieves the category mapping for the Books - Fiction and Literature category (CategoryID=377).
Description
Input
XML format (HTTP POST). Also available is the .txt version of this XML. <?xml version="1.0" encoding="utf-8"?> <GetCategory2CSRequest xmlns="urn:ebay:apis:eBLBaseComponents"> <RequesterCredentials> <eBayAuthToken>ABC...123</eBayAuthToken> </RequesterCredentials> <CategoryID>377</CategoryID> <DetailLevel>ReturnAll</DetailLevel> </GetCategory2CSRequest>
Output
XML format. Also available is the .txt version of this XML. <GetCategory2CSResponse xmlns="urn:ebay:apis:eBLBaseComponents"> <Timestamp>2010-01-28T01:58:09.896Z</Timestamp> <Ack>Success</Ack> <Version>643</Version> <Build>E643_CORE_BUNDLED_10284414_R1</Build> <MappedCategoryArray> <Category> <CategoryID>377</CategoryID> <ProductFinderIDs> <ProductFinderID>2087</ProductFinderID> <ProductFinderBuySide>true</ProductFinderBuySide> </ProductFinderIDs> <CharacteristicsSets> <Name>Fiction & Literature Books</Name> <AttributeSetID>2178</AttributeSetID> <AttributeSetVersion>95984</AttributeSetVersion> </CharacteristicsSets> </Category> </MappedCategoryArray> <AttributeSystemVersion>6272</AttributeSystemVersion> <SiteWideCharacteristicSets> <CharacteristicsSet> <Name>Return Policy</Name> <AttributeSetID>2135</AttributeSetID> <AttributeSetVersion>95091</AttributeSetVersion> </CharacteristicsSet> <ExcludeCategoryID>45088</ExcludeCategoryID> <ExcludeCategoryID>15825</ExcludeCategoryID> <ExcludeCategoryID>15841</ExcludeCategoryID> <ExcludeCategoryID>94825</ExcludeCategoryID> <ExcludeCategoryID>12605</ExcludeCategoryID> <ExcludeCategoryID>15897</ExcludeCategoryID> <ExcludeCategoryID>1607</ExcludeCategoryID> <ExcludeCategoryID>50338</ExcludeCategoryID> <ExcludeCategoryID>50339</ExcludeCategoryID> <ExcludeCategoryID>50340</ExcludeCategoryID> <ExcludeCategoryID>50341</ExcludeCategoryID> <ExcludeCategoryID>47127</ExcludeCategoryID> <ExcludeCategoryID>50342</ExcludeCategoryID> <ExcludeCategoryID>47128</ExcludeCategoryID> <ExcludeCategoryID>47129</ExcludeCategoryID> <ExcludeCategoryID>165993</ExcludeCategoryID> <ExcludeCategoryID>45208</ExcludeCategoryID> <ExcludeCategoryID>50348</ExcludeCategoryID> <ExcludeCategoryID>50344</ExcludeCategoryID> <ExcludeCategoryID>50345</ExcludeCategoryID> <ExcludeCategoryID>50346</ExcludeCategoryID> <ExcludeCategoryID>50347</ExcludeCategoryID> <ExcludeCategoryID>47130</ExcludeCategoryID> <ExcludeCategoryID>50350</ExcludeCategoryID> <ExcludeCategoryID>152950</ExcludeCategoryID> <ExcludeCategoryID>50351</ExcludeCategoryID> <ExcludeCategoryID>50352</ExcludeCategoryID> <ExcludeCategoryID>50353</ExcludeCategoryID> <ExcludeCategoryID>50354</ExcludeCategoryID> <ExcludeCategoryID>47131</ExcludeCategoryID> <ExcludeCategoryID>170049</ExcludeCategoryID> <ExcludeCategoryID>170050</ExcludeCategoryID> <ExcludeCategoryID>170051</ExcludeCategoryID> <ExcludeCategoryID>170052</ExcludeCategoryID> <ExcludeCategoryID>170053</ExcludeCategoryID> <ExcludeCategoryID>170054</ExcludeCategoryID> <ExcludeCategoryID>170055</ExcludeCategoryID> <ExcludeCategoryID>170056</ExcludeCategoryID> <ExcludeCategoryID>170057</ExcludeCategoryID> <ExcludeCategoryID>170058</ExcludeCategoryID> <ExcludeCategoryID>170059</ExcludeCategoryID> <ExcludeCategoryID>170060</ExcludeCategoryID> <ExcludeCategoryID>50356</ExcludeCategoryID> <ExcludeCategoryID>50357</ExcludeCategoryID> <ExcludeCategoryID>50358</ExcludeCategoryID> <ExcludeCategoryID>47107</ExcludeCategoryID> <ExcludeCategoryID>20944</ExcludeCategoryID> <ExcludeCategoryID>47112</ExcludeCategoryID> <ExcludeCategoryID>20945</ExcludeCategoryID> <ExcludeCategoryID>50335</ExcludeCategoryID> <ExcludeCategoryID>47113</ExcludeCategoryID> <ExcludeCategoryID>47114</ExcludeCategoryID> <ExcludeCategoryID>20946</ExcludeCategoryID> <ExcludeCategoryID>47118</ExcludeCategoryID> <ExcludeCategoryID>47117</ExcludeCategoryID> <ExcludeCategoryID>20947</ExcludeCategoryID> <ExcludeCategoryID>50336</ExcludeCategoryID> <ExcludeCategoryID>47121</ExcludeCategoryID> <ExcludeCategoryID>50422</ExcludeCategoryID> <ExcludeCategoryID>47123</ExcludeCategoryID> <ExcludeCategoryID>47122</ExcludeCategoryID> <ExcludeCategoryID>47125</ExcludeCategoryID> <ExcludeCategoryID>45210</ExcludeCategoryID> <ExcludeCategoryID>50333</ExcludeCategoryID> <ExcludeCategoryID>50334</ExcludeCategoryID> <ExcludeCategoryID>47105</ExcludeCategoryID> <ExcludeCategoryID>47106</ExcludeCategoryID> <ExcludeCategoryID>45209</ExcludeCategoryID> <ExcludeCategoryID>317</ExcludeCategoryID> <ExcludeCategoryID>28183</ExcludeCategoryID> <ExcludeCategoryID>28211</ExcludeCategoryID> <ExcludeCategoryID>28212</ExcludeCategoryID> <ExcludeCategoryID>28213</ExcludeCategoryID> <ExcludeCategoryID>28214</ExcludeCategoryID> <ExcludeCategoryID>28215</ExcludeCategoryID> <ExcludeCategoryID>28203</ExcludeCategoryID> <ExcludeCategoryID>28216</ExcludeCategoryID> <ExcludeCategoryID>28284</ExcludeCategoryID> <ExcludeCategoryID>28217</ExcludeCategoryID> <ExcludeCategoryID>28218</ExcludeCategoryID> <ExcludeCategoryID>28219</ExcludeCategoryID> <ExcludeCategoryID>28220</ExcludeCategoryID> <ExcludeCategoryID>28221</ExcludeCategoryID> <ExcludeCategoryID>28239</ExcludeCategoryID> <ExcludeCategoryID>28240</ExcludeCategoryID> <ExcludeCategoryID>28241</ExcludeCategoryID> <ExcludeCategoryID>28242</ExcludeCategoryID> <ExcludeCategoryID>28243</ExcludeCategoryID> <ExcludeCategoryID>28244</ExcludeCategoryID> <ExcludeCategoryID>28245</ExcludeCategoryID> <ExcludeCategoryID>28246</ExcludeCategoryID> <ExcludeCategoryID>28247</ExcludeCategoryID> <ExcludeCategoryID>28193</ExcludeCategoryID> <ExcludeCategoryID>28194</ExcludeCategoryID> <ExcludeCategoryID>28195</ExcludeCategoryID> <ExcludeCategoryID>28199</ExcludeCategoryID> <ExcludeCategoryID>28200</ExcludeCategoryID> <ExcludeCategoryID>28201</ExcludeCategoryID> <ExcludeCategoryID>28202</ExcludeCategoryID> <ExcludeCategoryID>28204</ExcludeCategoryID> <ExcludeCategoryID>52615</ExcludeCategoryID> <ExcludeCategoryID>52643</ExcludeCategoryID> <ExcludeCategoryID>52645</ExcludeCategoryID> <ExcludeCategoryID>52647</ExcludeCategoryID> <ExcludeCategoryID>52834</ExcludeCategoryID> <ExcludeCategoryID>52840</ExcludeCategoryID> <ExcludeCategoryID>28306</ExcludeCategoryID> <ExcludeCategoryID>52838</ExcludeCategoryID> <ExcludeCategoryID>52919</ExcludeCategoryID> <ExcludeCategoryID>52921</ExcludeCategoryID> <ExcludeCategoryID>52923</ExcludeCategoryID> <ExcludeCategoryID>52925</ExcludeCategoryID> <ExcludeCategoryID>28308</ExcludeCategoryID> <ExcludeCategoryID>52928</ExcludeCategoryID> <ExcludeCategoryID>142504</ExcludeCategoryID> <ExcludeCategoryID>52618</ExcludeCategoryID> <ExcludeCategoryID>52620</ExcludeCategoryID> <ExcludeCategoryID>52622</ExcludeCategoryID> <ExcludeCategoryID>28292</ExcludeCategoryID> <ExcludeCategoryID>28263</ExcludeCategoryID> <ExcludeCategoryID>28264</ExcludeCategoryID> <ExcludeCategoryID>28265</ExcludeCategoryID> <ExcludeCategoryID>28266</ExcludeCategoryID> <ExcludeCategoryID>28267</ExcludeCategoryID> <ExcludeCategoryID>28268</ExcludeCategoryID> <ExcludeCategoryID>28295</ExcludeCategoryID> <ExcludeCategoryID>28296</ExcludeCategoryID> <ExcludeCategoryID>28271</ExcludeCategoryID> <ExcludeCategoryID>28272</ExcludeCategoryID> <ExcludeCategoryID>28233</ExcludeCategoryID> <ExcludeCategoryID>28234</ExcludeCategoryID> <ExcludeCategoryID>28235</ExcludeCategoryID> <ExcludeCategoryID>52931</ExcludeCategoryID> <ExcludeCategoryID>52933</ExcludeCategoryID> <ExcludeCategoryID>52935</ExcludeCategoryID> <ExcludeCategoryID>28269</ExcludeCategoryID> <ExcludeCategoryID>28257</ExcludeCategoryID> <ExcludeCategoryID>28258</ExcludeCategoryID> <ExcludeCategoryID>28259</ExcludeCategoryID> <ExcludeCategoryID>28309</ExcludeCategoryID> <ExcludeCategoryID>52982</ExcludeCategoryID> <ExcludeCategoryID>52984</ExcludeCategoryID> <ExcludeCategoryID>28270</ExcludeCategoryID> <ExcludeCategoryID>52998</ExcludeCategoryID> <ExcludeCategoryID>28313</ExcludeCategoryID> <ExcludeCategoryID>28314</ExcludeCategoryID> <ExcludeCategoryID>28315</ExcludeCategoryID> <ExcludeCategoryID>28316</ExcludeCategoryID> <ExcludeCategoryID>28317</ExcludeCategoryID> <ExcludeCategoryID>28318</ExcludeCategoryID> <ExcludeCategoryID>28319</ExcludeCategoryID> <ExcludeCategoryID>28291</ExcludeCategoryID> <ExcludeCategoryID>10160</ExcludeCategoryID> <ExcludeCategoryID>10161</ExcludeCategoryID> <ExcludeCategoryID>10162</ExcludeCategoryID> <ExcludeCategoryID>140151</ExcludeCategoryID> </SiteWideCharacteristicSets> </GetCategory2CSResponse>
| Input Output Detail Controls Samples Top Errors for GetCategory2CS User Notes |
| Version | Description |
|---|---|
| 499 2007-02-07 |
|
| Input Output Detail Controls Samples Change History Top Errors for GetCategory2CS User Notes |
Copyright © 2005–2013 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.