eBay Trading API
|
Returns information about certain features that are only applicable to certain categories on the site.
Be sure to specify ViewAllNodes as true so that you get useful results.
GetCategoryFeatures is not designed to return settings for every leaf and parent category that exists in the category tree. It only returns settings for nodes (sub-hierarchies) that are different from the SiteDefault, or different from a given parent category's settings. In other words, we use a "toggling" model to reduce the size of the response. For example, if the SiteDefault setting for BestOfferEnabled is false, it would mean most categories on the site don't support Best Offer, and GetCategoryFeatures would only return the few categories where the setting for BestOfferEnabled is true (if any).
Furthermore, if all of the leaf categories under a given parent category have the same settings (such as BestOfferEnabled=true), then GetCategoryFeatures only returns the highest-level parent category with those same settings. This means the settings of that parent category are inherited for all lower-level child categories down to the leaf categories. (In theory, it is possible for this toggling behavior to occur more than once as you drill down into lower levels of the tree. So you would need to check whether any children that override the parent's settings are also returned.)
Use GetCategories to retrieve information about the category hierarchy (such as parent/child relationships) plus additional feature settings.
See Categories.
Related calls:
| Output Detail Controls Samples Change History Top Errors for GetCategoryFeatures 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 may be missing some XML fields and attributes. This is a documentation limitation only (see Limitations of This Document).
<?xml version="1.0" encoding="utf-8"?> <GetCategoryFeaturesRequest xmlns="urn:ebay:apis:eBLBaseComponents"> <!-- Standard Input Fields --> <DetailLevel> DetailLevelCodeType </DetailLevel> <!-- ... more DetailLevel nodes here ... --> <ErrorLanguage> string </ErrorLanguage> <MessageID> string </MessageID> <OutputSelector> string </OutputSelector> <!-- ... more OutputSelector nodes here ... --> <Version> string </Version> <WarningLevel> WarningLevelCodeType </WarningLevel> <!-- Call-specific Input Fields --> <CategoryID> string </CategoryID> <FeatureID> FeatureIDCodeType </FeatureID> <!-- ... more FeatureID nodes here ... --> <LevelLimit> int </LevelLimit> <ViewAllNodes> boolean </ViewAllNodes> </GetCategoryFeaturesRequest>
| Argument | Type | Reqd? | Meaning |
|---|---|---|---|
| Standard Input Fields [Jump to call-specific fields] | |||
| DetailLevel | DetailLevelCodeType (repeatable) |
Optional |
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. • ReturnSummary (in) Returns the summary data. For GetMyMessages, this detail level returns the same data whether or not you include MessageIDs or AlertIDs in the request. Returns up to 10 FolderID and FolderName values. Currently, this detail level is the only way to retrieve FolderID and FolderName values. See "GetMyMessages" in the eBay Web Services Guide for a code sample that demonstrates this. (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 See Tags for the Identification of Languages. |
| MessageID | string | Optional |
In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage 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, 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. |
| OutputSelector | string (repeatable) |
Optional |
You can use the OutputSelector field to restrict the data returned by this call. When you make a call such as GetItem that retrieves data from eBay, the OutputSelector field is useful for restricting the data returned. This field makes the call response easier to use, especially when a large payload would be returned. If you use the OutputSelector field, the output data will include only the fields you specified in the request. For example, if you are using GetItem and you want the item data in the response to be restricted to the ViewItemURL (the URL where a user can view the listing) and BuyItNowPrice, then within the GetItem request, specify those output fields. To use this field, see the information at the following link.
See Selecting Fields to Retrieve. |
| 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: HTTP Headers (XML API Only) eBay Schema Versioning Strategy Lowest Supported Version |
| 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. |
| Call-specific Input Fields | |||
| CategoryID | string | Optional |
Defines one category for which you want feature settings. If not specified, returns feature settings for all categories on the site (assuming you set the DetailLevel to ReturnAll and ViewAllNodes to true). Max length: 10. |
| FeatureID | FeatureIDCodeType (repeatable) |
Optional |
Retrieves data related to the specified feature setting only. If no feature IDs are specified, the call retrieves data for all feature settings.
Applicable values: See FeatureID. |
| LevelLimit | int | Optional | A level of depth in the category hierarchy. Retrieves all category nodes with a CategoryLevel less than or equal to the LevelLimit value. |
| ViewAllNodes | boolean | Conditional |
Set this value to true to retrieve useful results. If true, retrieves all categories that override the site default settings. (If false or not specified, only retrieves data about leaf categories. If the details about overridden settings are only defined on a category's ancestor, the call does not return those settings if you only retrieve leaf categories.) Default: false. |
| Input Detail Controls Samples Change History Top Errors for GetCategoryFeatures User Notes |
The box below lists all fields that might be returned in the call 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).
The XML prototype may be missing some XML fields and attributes. This is a documentation limitation only (see Limitations of This Document).
<?xml version="1.0" encoding="utf-8"?>
<GetCategoryFeaturesResponse xmlns="urn:ebay:apis:eBLBaseComponents">
<!-- 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 here ... -->
<LongMessage> string </LongMessage>
<SeverityCode> SeverityCodeType </SeverityCode>
<ShortMessage> string </ShortMessage>
</Errors>
<!-- ... more Errors nodes here ... -->
<HardExpirationWarning> string </HardExpirationWarning>
<Timestamp> dateTime </Timestamp>
<Version> string </Version>
<!-- Call-specific Output Fields -->
<Category> CategoryFeatureType
<AdFormatEnabled> AdFormatEnabledCodeType </AdFormatEnabled>
<BasicUpgradePackEnabled> boolean </BasicUpgradePackEnabled>
<BestOfferAutoAcceptEnabled> boolean </BestOfferAutoAcceptEnabled>
<BestOfferAutoDeclineEnabled> boolean </BestOfferAutoDeclineEnabled>
<BestOfferCounterEnabled> boolean </BestOfferCounterEnabled>
<BestOfferEnabled> boolean </BestOfferEnabled>
<BuyerGuaranteeEnabled> boolean </BuyerGuaranteeEnabled>
<CategoryID> string </CategoryID>
<ClassifiedAdAutoAcceptEnabled> boolean </ClassifiedAdAutoAcceptEnabled>
<ClassifiedAdAutoDeclineEnabled> boolean </ClassifiedAdAutoDeclineEnabled>
<ClassifiedAdBestOfferEnabled> ClassifiedAdBestOfferEnabledCodeType </ClassifiedAdBestOfferEnabled>
<ClassifiedAdCompanyNameEnabled> boolean </ClassifiedAdCompanyNameEnabled>
<ClassifiedAdContactByAddressEnabled> boolean </ClassifiedAdContactByAddressEnabled>
<ClassifiedAdContactByEmailEnabled> boolean </ClassifiedAdContactByEmailEnabled>
<ClassifiedAdContactByPhoneEnabled> boolean </ClassifiedAdContactByPhoneEnabled>
<ClassifiedAdCounterOfferEnabled> boolean </ClassifiedAdCounterOfferEnabled>
<ClassifiedAdPaymentMethodEnabled> ClassifiedAdPaymentMethodEnabledCodeType </ClassifiedAdPaymentMethodEnabled>
<ClassifiedAdPayPerLeadEnabled> boolean </ClassifiedAdPayPerLeadEnabled>
<ClassifiedAdPhoneCount> int </ClassifiedAdPhoneCount>
<ClassifiedAdShippingMethodEnabled> boolean </ClassifiedAdShippingMethodEnabled>
<ClassifiedAdStreetCount> int </ClassifiedAdStreetCount>
<CombinedFixedPriceTreatmentEnabled> boolean </CombinedFixedPriceTreatmentEnabled>
<CrossBorderTradeAustraliaEnabled> boolean </CrossBorderTradeAustraliaEnabled>
<CrossBorderTradeGBEnabled> boolean </CrossBorderTradeGBEnabled>
<CrossBorderTradeNorthAmericaEnabled> boolean </CrossBorderTradeNorthAmericaEnabled>
<DutchBINEnabled> boolean </DutchBINEnabled>
<eBayMotorsProAdFormatEnabled> AdFormatEnabledCodeType </eBayMotorsProAdFormatEnabled>
<eBayMotorsProAutoAcceptEnabled> boolean </eBayMotorsProAutoAcceptEnabled>
<eBayMotorsProAutoDeclineEnabled> boolean </eBayMotorsProAutoDeclineEnabled>
<eBayMotorsProBestOfferEnabled> ClassifiedAdBestOfferEnabledCodeType </eBayMotorsProBestOfferEnabled>
<eBayMotorsProCompanyNameEnabled> boolean </eBayMotorsProCompanyNameEnabled>
<eBayMotorsProContactByAddressEnabled> boolean </eBayMotorsProContactByAddressEnabled>
<eBayMotorsProContactByEmailEnabled> boolean </eBayMotorsProContactByEmailEnabled>
<eBayMotorsProContactByPhoneEnabled> boolean </eBayMotorsProContactByPhoneEnabled>
<eBayMotorsProCounterOfferEnabled> boolean </eBayMotorsProCounterOfferEnabled>
<eBayMotorsProPaymentMethodCheckOutEnabled> ClassifiedAdPaymentMethodEnabledCodeType </eBayMotorsProPaymentMethodCheckOutEnabled>
<eBayMotorsProPhoneCount> int </eBayMotorsProPhoneCount>
<eBayMotorsProSellerContactDetailsEnabled> boolean </eBayMotorsProSellerContactDetailsEnabled>
<eBayMotorsProShippingMethodEnabled> boolean </eBayMotorsProShippingMethodEnabled>
<eBayMotorsProStreetCount> int </eBayMotorsProStreetCount>
<ExpressConditionRequired> boolean </ExpressConditionRequired>
<ExpressEnabled> boolean </ExpressEnabled>
<ExpressPicturesRequired> boolean </ExpressPicturesRequired>
<GalleryFeaturedDurations> ListingEnhancementDurationReferenceType
<Duration> token </Duration>
<!-- ... more Duration nodes here ... -->
</GalleryFeaturedDurations>
<HomePageFeaturedEnabled> boolean </HomePageFeaturedEnabled>
<INEscrowWorkflowTimeline> INEscrowWorkflowTimelineCodeType </INEscrowWorkflowTimeline>
<ItemSpecificsEnabled> ItemSpecificsEnabledCodeType </ItemSpecificsEnabled>
<ListingDuration type="ListingTypeCodeType"> ListingDurationReferenceType (int) </ListingDuration>
<!-- ... more ListingDuration nodes here ... -->
<LocalMarketAdFormatEnabled> AdFormatEnabledCodeType </LocalMarketAdFormatEnabled>
<LocalMarketAutoAcceptEnabled> boolean </LocalMarketAutoAcceptEnabled>
<LocalMarketAutoDeclineEnabled> boolean </LocalMarketAutoDeclineEnabled>
<LocalMarketBestOfferEnabled> ClassifiedAdBestOfferEnabledCodeType </LocalMarketBestOfferEnabled>
<LocalMarketCompanyNameEnabled> boolean </LocalMarketCompanyNameEnabled>
<LocalMarketContactByAddressEnabled> boolean </LocalMarketContactByAddressEnabled>
<LocalMarketContactByEmailEnabled> boolean </LocalMarketContactByEmailEnabled>
<LocalMarketContactByPhoneEnabled> boolean </LocalMarketContactByPhoneEnabled>
<LocalMarketCounterOfferEnabled> boolean </LocalMarketCounterOfferEnabled>
<LocalMarketNonSubscription> boolean </LocalMarketNonSubscription>
<LocalMarketPaymentMethodCheckOutEnabled> ClassifiedAdPaymentMethodEnabledCodeType </LocalMarketPaymentMethodCheckOutEnabled>
<LocalMarketPhoneCount> int </LocalMarketPhoneCount>
<LocalMarketPremiumSubscription> boolean </LocalMarketPremiumSubscription>
<LocalMarketRegularSubscription> boolean </LocalMarketRegularSubscription>
<LocalMarketSellerContactDetailsEnabled> boolean </LocalMarketSellerContactDetailsEnabled>
<LocalMarketShippingMethodEnabled> boolean </LocalMarketShippingMethodEnabled>
<LocalMarketSpecialitySubscription> boolean </LocalMarketSpecialitySubscription>
<LocalMarketStreetCount> int </LocalMarketStreetCount>
<MinimumReservePrice> double </MinimumReservePrice>
<NonSubscription> GeographicExposureCodeType </NonSubscription>
<PaisaPayFullEscrowEnabled> boolean </PaisaPayFullEscrowEnabled>
<PayPalBuyerProtectionEnabled> boolean </PayPalBuyerProtectionEnabled>
<PayPalRequired> boolean </PayPalRequired>
<PremiumSubscription> GeographicExposureCodeType </PremiumSubscription>
<ProPackEnabled> boolean </ProPackEnabled>
<ProPackPlusEnabled> boolean </ProPackPlusEnabled>
<RegularSubscription> GeographicExposureCodeType </RegularSubscription>
<SafePaymentRequired> boolean </SafePaymentRequired>
<SellerContactDetailsEnabled> boolean </SellerContactDetailsEnabled>
<ShippingTermsRequired> boolean </ShippingTermsRequired>
<SkypeMeNonTransactionalEnabled> boolean </SkypeMeNonTransactionalEnabled>
<SkypeMeTransactionalEnabled> boolean </SkypeMeTransactionalEnabled>
<SpecialitySubscription> GeographicExposureCodeType </SpecialitySubscription>
<StoreInventoryEnabled> boolean </StoreInventoryEnabled>
<TransactionConfirmationRequestEnabled> boolean </TransactionConfirmationRequestEnabled>
<UserConsentRequired> boolean </UserConsentRequired>
<ValuePackEnabled> boolean </ValuePackEnabled>
</Category>
<!-- ... more Category nodes here ... -->
<CategoryVersion> string </CategoryVersion>
<FeatureDefinitions> FeatureDefinitionsType
<AdFormatEnabled> AdFormatEnabledDefinitionType
</AdFormatEnabled>
<BasicUpgradePackEnabled> BasicUpgradePackEnabledDefinitionType
</BasicUpgradePackEnabled>
<BestOfferAutoAcceptEnabled> BestOfferAutoAcceptEnabledDefinitionType
</BestOfferAutoAcceptEnabled>
<BestOfferAutoDeclineEnabled> BestOfferAutoDeclineEnabledDefinitionType
</BestOfferAutoDeclineEnabled>
<BestOfferCounterEnabled> BestOfferCounterEnabledDefinitionType
</BestOfferCounterEnabled>
<BestOfferEnabled> BestOfferEnabledDefinitionType
</BestOfferEnabled>
<BuyerGuaranteeEnabled> BuyerGuaranteeEnabledDefinitionType
</BuyerGuaranteeEnabled>
<ClassifiedAdAutoAcceptEnabled> ClassifiedAdAutoAcceptEnabledDefinitionType
</ClassifiedAdAutoAcceptEnabled>
<ClassifiedAdAutoDeclineEnabled> ClassifiedAdAutoDeclineEnabledDefinitionType
</ClassifiedAdAutoDeclineEnabled>
<ClassifiedAdBestOfferEnabled> ClassifiedAdBestOfferEnabledDefinitionType
</ClassifiedAdBestOfferEnabled>
<ClassifiedAdCompanyNameEnabled> ClassifiedAdCompanyNameEnabledDefinitionType
</ClassifiedAdCompanyNameEnabled>
<ClassifiedAdContactByAddressEnabled> ClassifiedAdContactByAddressEnabledDefinitionType
</ClassifiedAdContactByAddressEnabled>
<ClassifiedAdContactByEmailEnabled> ClassifiedAdContactByEmailEnabledDefintionType
</ClassifiedAdContactByEmailEnabled>
<ClassifiedAdContactByPhoneEnabled> ClassifiedAdContactByPhoneEnabledDefinitionType
</ClassifiedAdContactByPhoneEnabled>
<ClassifiedAdCounterOfferEnabled> ClassifiedAdCounterOfferEnabledDefinitionType
</ClassifiedAdCounterOfferEnabled>
<ClassifiedAdPaymentMethodEnabled> ClassifiedAdPaymentMethodEnabledDefinitionType
</ClassifiedAdPaymentMethodEnabled>
<ClassifiedAdPayPerLeadEnabled> ClassifiedAdPayPerLeadEnabledDefinitionType
</ClassifiedAdPayPerLeadEnabled>
<ClassifiedAdPhoneCount> ClassifiedAdPhoneCountDefinitionType
</ClassifiedAdPhoneCount>
<ClassifiedAdShippingMethodEnabled> ClassifiedAdShippingMethodEnabledDefinitionType
</ClassifiedAdShippingMethodEnabled>
<ClassifiedAdStreetCount> ClassifiedAdStreetCountDefinitionType
</ClassifiedAdStreetCount>
<CombinedFixedPriceTreatmentEnabled> CombinedFixedPriceTreatmentEnabledDefinitionType
</CombinedFixedPriceTreatmentEnabled>
<CrossBorderTradeAustraliaEnabled> CrossBorderTradeAustraliaEnabledDefinitionType
</CrossBorderTradeAustraliaEnabled>
<CrossBorderTradeGBEnabled> CrossBorderTradeGBEnabledDefinitionType
</CrossBorderTradeGBEnabled>
<CrossBorderTradeNorthAmericaEnabled> CrossBorderTradeNorthAmericaEnabledDefinitionType
</CrossBorderTradeNorthAmericaEnabled>
<DutchBINEnabled> DutchBINEnabledDefinitionType
</DutchBINEnabled>
<eBayMotorsProAdFormatEnabled> eBayMotorsProAdFormatEnabledDefinitionType
</eBayMotorsProAdFormatEnabled>
<eBayMotorsProAutoAcceptEnabled> eBayMotorsProAutoAcceptEnabledDefinitionType
</eBayMotorsProAutoAcceptEnabled>
<eBayMotorsProAutoDeclineEnabled> eBayMotorsProAutoDeclineEnabledDefinitionType
</eBayMotorsProAutoDeclineEnabled>
<eBayMotorsProBestOfferEnabled> eBayMotorsProBestOfferEnabledDefinitionType
</eBayMotorsProBestOfferEnabled>
<eBayMotorsProCompanyNameEnabled> eBayMotorsProCompanyNameEnabledDefinitionType
</eBayMotorsProCompanyNameEnabled>
<eBayMotorsProContactByAddressEnabled> eBayMotorsProContactByAddressEnabledDefinitionType
</eBayMotorsProContactByAddressEnabled>
<eBayMotorsProContactByEmailEnabled> eBayMotorsProContactByEmailEnabledDefinitionType
</eBayMotorsProContactByEmailEnabled>
<eBayMotorsProContactByPhoneEnabled> eBayMotorsProContactByPhoneEnabledDefinitionType
</eBayMotorsProContactByPhoneEnabled>
<eBayMotorsProCounterOfferEnabled> eBayMotorsProCounterOfferEnabledDefinitionType
</eBayMotorsProCounterOfferEnabled>
<eBayMotorsProPaymentMethodCheckOutEnabled> eBayMotorsProPaymentMethodCheckOutEnabledDefinitionType
</eBayMotorsProPaymentMethodCheckOutEnabled>
<eBayMotorsProPhoneCount> eBayMotorsProPhoneCountDefinitionType
</eBayMotorsProPhoneCount>
<eBayMotorsProSellerContactDetailsEnabled> eBayMotorsProSellerContactDetailsEnabledDefinitionType
</eBayMotorsProSellerContactDetailsEnabled>
<eBayMotorsProShippingMethodEnabled> eBayMotorsProShippingMethodEnabledDefinitionType
</eBayMotorsProShippingMethodEnabled>
<eBayMotorsProStreetCount> eBayMotorsProStreetCountDefinitionType
</eBayMotorsProStreetCount>
<ExpressConditionRequired> ExpressConditionRequiredDefinitionType
</ExpressConditionRequired>
<ExpressEnabled> ExpressEnabledDefinitionType
</ExpressEnabled>
<ExpressPicturesRequired> ExpressPicturesRequiredDefinitionType
</ExpressPicturesRequired>
<GalleryFeaturedDurations> ListingEnhancementDurationDefinitionType
</GalleryFeaturedDurations>
<HomePageFeaturedEnabled> HomePageFeaturedEnabledDefinitionType
</HomePageFeaturedEnabled>
<INEscrowWorkflowTimeline> INEscrowWorkflowTimelineDefinitionType
</INEscrowWorkflowTimeline>
<ItemSpecificsEnabled> ItemSpecificsEnabledDefinitionType
</ItemSpecificsEnabled>
<ListingDurations Version="int"> ListingDurationDefinitionsType
<ListingDuration durationSetID="int"> ListingDurationDefinitionType
<Duration> token </Duration>
<!-- ... more Duration nodes here ... -->
</ListingDuration>
<!-- ... more ListingDuration nodes here ... -->
</ListingDurations>
<LocalListingDistancesNonSubscription> LocalListingDistancesNonSubscriptionDefinitionType
</LocalListingDistancesNonSubscription>
<LocalListingDistancesRegular> LocalListingDistancesRegularDefinitionType
</LocalListingDistancesRegular>
<LocalListingDistancesSpecialty> LocalListingDistancesSpecialtyDefinitionType
</LocalListingDistancesSpecialty>
<LocalMarketAdFormatEnabled> LocalMarketAdFormatEnabledDefinitionType
</LocalMarketAdFormatEnabled>
<LocalMarketAutoAcceptEnabled> LocalMarketAutoAcceptEnabledDefinitionType
</LocalMarketAutoAcceptEnabled>
<LocalMarketAutoDeclineEnabled> LocalMarketAutoDeclineEnabledDefinitionType
</LocalMarketAutoDeclineEnabled>
<LocalMarketBestOfferEnabled> LocalMarketBestOfferEnabledDefinitionType
</LocalMarketBestOfferEnabled>
<LocalMarketCompanyNameEnabled> LocalMarketCompanyNameEnabledDefinitionType
</LocalMarketCompanyNameEnabled>
<LocalMarketContactByAddressEnabled> LocalMarketContactByAddressEnabledDefinitionType
</LocalMarketContactByAddressEnabled>
<LocalMarketContactByEmailEnabled> LocalMarketContactByEmailEnabledDefinitionType
</LocalMarketContactByEmailEnabled>
<LocalMarketContactByPhoneEnabled> LocalMarketContactByPhoneEnabledDefinitionType
</LocalMarketContactByPhoneEnabled>
<LocalMarketCounterOfferEnabled> LocalMarketCounterOfferEnabledDefinitionType
</LocalMarketCounterOfferEnabled>
<LocalMarketNonSubscription> LocalMarketNonSubscriptionDefinitionType
</LocalMarketNonSubscription>
<LocalMarketPaymentMethodCheckOutEnabled> LocalMarketPaymentMethodCheckOutEnabledDefinitionType
</LocalMarketPaymentMethodCheckOutEnabled>
<LocalMarketPhoneCount> LocalMarketPhoneCountDefinitionType
</LocalMarketPhoneCount>
<LocalMarketPremiumSubscription> LocalMarketPremiumSubscriptionDefinitionType
</LocalMarketPremiumSubscription>
<LocalMarketRegularSubscription> LocalMarketRegularSubscriptionDefinitionType
</LocalMarketRegularSubscription>
<LocalMarketSellerContactDetailsEnabled> LocalMarketSellerContactDetailsEnabledDefinitionType
</LocalMarketSellerContactDetailsEnabled>
<LocalMarketShippingMethodEnabled> LocalMarketShippingMethodEnabledDefinitionType
</LocalMarketShippingMethodEnabled>
<LocalMarketSpecialitySubscription> LocalMarketSpecialitySubscriptionDefinitionType
</LocalMarketSpecialitySubscription>
<LocalMarketStreetCount> LocalMarketStreetCountDefinitionType
</LocalMarketStreetCount>
<MinimumReservePrice> MinimumReservePriceDefinitionType
</MinimumReservePrice>
<NonSubscription> NonSubscriptionDefinitionType
</NonSubscription>
<PaisaPayFullEscrowEnabled> PaisaPayFullEscrowEnabledDefinitionType
</PaisaPayFullEscrowEnabled>
<PayPalBuyerProtectionEnabled> PayPalBuyerProtectionEnabledDefinitionType
</PayPalBuyerProtectionEnabled>
<PayPalRequired> PayPalRequiredDefinitionType
</PayPalRequired>
<PremiumSubscription> PremiumSubscriptionDefinitionType
</PremiumSubscription>
<ProPackEnabled> ProPackEnabledDefinitionType
</ProPackEnabled>
<ProPackPlusEnabled> ProPackPlusEnabledDefinitionType
</ProPackPlusEnabled>
<RegularSubscription> RegularSubscriptionDefinitionType
</RegularSubscription>
<SafePaymentRequired> SafePaymentRequiredDefinitionType
</SafePaymentRequired>
<SellerContactDetailsEnabled> SellerContactDetailsEnabledDefinitionType
</SellerContactDetailsEnabled>
<ShippingTermsRequired> ShippingTermRequiredDefinitionType
</ShippingTermsRequired>
<SkypeMeNonTransactionalEnabled> SkypeMeNonTransactionalEnabledDefinitionType
</SkypeMeNonTransactionalEnabled>
<SkypeMeTransactionalEnabled> SkypeMeTransactionalEnabledDefinitionType
</SkypeMeTransactionalEnabled>
<SpecialitySubscription> SpecialitySubscriptionDefinitionType
</SpecialitySubscription>
<StoreInventoryEnabled> StoreInventoryEnabledDefinitionType
</StoreInventoryEnabled>
<TransactionConfirmationRequestEnabled> TCREnabledDefinitionType
</TransactionConfirmationRequestEnabled>
<UserConsentRequired> UserConsentRequiredDefinitionType
</UserConsentRequired>
<ValuePackEnabled> ValuePackEnabledDefinitionType
</ValuePackEnabled>
</FeatureDefinitions>
<SiteDefaults> SiteDefaultsType
<AdFormatEnabled> AdFormatEnabledCodeType </AdFormatEnabled>
<BasicUpgradePackEnabled> boolean </BasicUpgradePackEnabled>
<BestOfferAutoAcceptEnabled> boolean </BestOfferAutoAcceptEnabled>
<BestOfferAutoDeclineEnabled> boolean </BestOfferAutoDeclineEnabled>
<BestOfferCounterEnabled> boolean </BestOfferCounterEnabled>
<BestOfferEnabled> boolean </BestOfferEnabled>
<BuyerGuaranteeEnabled> boolean </BuyerGuaranteeEnabled>
<ClassifiedAdAutoAcceptEnabled> boolean </ClassifiedAdAutoAcceptEnabled>
<ClassifiedAdAutoDeclineEnabled> boolean </ClassifiedAdAutoDeclineEnabled>
<ClassifiedAdBestOfferEnabled> ClassifiedAdBestOfferEnabledCodeType </ClassifiedAdBestOfferEnabled>
<ClassifiedAdCompanyNameEnabled> boolean </ClassifiedAdCompanyNameEnabled>
<ClassifiedAdContactByAddressEnabled> boolean </ClassifiedAdContactByAddressEnabled>
<ClassifiedAdContactByEmailEnabled> boolean </ClassifiedAdContactByEmailEnabled>
<ClassifiedAdContactByPhoneEnabled> boolean </ClassifiedAdContactByPhoneEnabled>
<ClassifiedAdCounterOfferEnabled> boolean </ClassifiedAdCounterOfferEnabled>
<ClassifiedAdPaymentMethodEnabled> ClassifiedAdPaymentMethodEnabledCodeType </ClassifiedAdPaymentMethodEnabled>
<ClassifiedAdPayPerLeadEnabled> boolean </ClassifiedAdPayPerLeadEnabled>
<ClassifiedAdPhoneCount> int </ClassifiedAdPhoneCount>
<ClassifiedAdShippingMethodEnabled> boolean </ClassifiedAdShippingMethodEnabled>
<ClassifiedAdStreetCount> int </ClassifiedAdStreetCount>
<CombinedFixedPriceTreatmentEnabled> boolean </CombinedFixedPriceTreatmentEnabled>
<CrossBorderTradeAustraliaEnabled> boolean </CrossBorderTradeAustraliaEnabled>
<CrossBorderTradeGBEnabled> boolean </CrossBorderTradeGBEnabled>
<CrossBorderTradeNorthAmericaEnabled> boolean </CrossBorderTradeNorthAmericaEnabled>
<DutchBINEnabled> boolean </DutchBINEnabled>
<eBayMotorsProAdFormatEnabled> AdFormatEnabledCodeType </eBayMotorsProAdFormatEnabled>
<eBayMotorsProAutoAcceptEnabled> boolean </eBayMotorsProAutoAcceptEnabled>
<eBayMotorsProAutoDeclineEnabled> boolean </eBayMotorsProAutoDeclineEnabled>
<eBayMotorsProBestOfferEnabled> ClassifiedAdBestOfferEnabledCodeType </eBayMotorsProBestOfferEnabled>
<eBayMotorsProCompanyNameEnabled> boolean </eBayMotorsProCompanyNameEnabled>
<eBayMotorsProContactByAddressEnabled> boolean </eBayMotorsProContactByAddressEnabled>
<eBayMotorsProContactByEmailEnabled> boolean </eBayMotorsProContactByEmailEnabled>
<eBayMotorsProContactByPhoneEnabled> boolean </eBayMotorsProContactByPhoneEnabled>
<eBayMotorsProCounterOfferEnabled> boolean </eBayMotorsProCounterOfferEnabled>
<eBayMotorsProPaymentMethodCheckOutEnabled> ClassifiedAdPaymentMethodEnabledCodeType </eBayMotorsProPaymentMethodCheckOutEnabled>
<eBayMotorsProPhoneCount> int </eBayMotorsProPhoneCount>
<eBayMotorsProSellerContactDetailsEnabled> boolean </eBayMotorsProSellerContactDetailsEnabled>
<eBayMotorsProShippingMethodEnabled> boolean </eBayMotorsProShippingMethodEnabled>
<eBayMotorsProStreetCount> int </eBayMotorsProStreetCount>
<ExpressConditionRequired> boolean </ExpressConditionRequired>
<ExpressEnabled> boolean </ExpressEnabled>
<ExpressPicturesRequired> boolean </ExpressPicturesRequired>
<GalleryFeaturedDurations> ListingEnhancementDurationReferenceType
<Duration> token </Duration>
<!-- ... more Duration nodes here ... -->
</GalleryFeaturedDurations>
<HomePageFeaturedEnabled> boolean </HomePageFeaturedEnabled>
<INEscrowWorkflowTimeline> INEscrowWorkflowTimelineCodeType </INEscrowWorkflowTimeline>
<ItemSpecificsEnabled> ItemSpecificsEnabledCodeType </ItemSpecificsEnabled>
<ListingDuration type="ListingTypeCodeType"> ListingDurationReferenceType (int) </ListingDuration>
<!-- ... more ListingDuration nodes here ... -->
<LocalListingDistancesNonSubscription> string </LocalListingDistancesNonSubscription>
<LocalListingDistancesRegular> string </LocalListingDistancesRegular>
<LocalListingDistancesSpecialty> string </LocalListingDistancesSpecialty>
<LocalMarketAdFormatEnabled> AdFormatEnabledCodeType </LocalMarketAdFormatEnabled>
<LocalMarketAutoAcceptEnabled> boolean </LocalMarketAutoAcceptEnabled>
<LocalMarketAutoDeclineEnabled> boolean </LocalMarketAutoDeclineEnabled>
<LocalMarketBestOfferEnabled> ClassifiedAdBestOfferEnabledCodeType </LocalMarketBestOfferEnabled>
<LocalMarketCompanyNameEnabled> boolean </LocalMarketCompanyNameEnabled>
<LocalMarketContactByAddressEnabled> boolean </LocalMarketContactByAddressEnabled>
<LocalMarketContactByEmailEnabled> boolean </LocalMarketContactByEmailEnabled>
<LocalMarketContactByPhoneEnabled> boolean </LocalMarketContactByPhoneEnabled>
<LocalMarketCounterOfferEnabled> boolean </LocalMarketCounterOfferEnabled>
<LocalMarketNonSubscription> boolean </LocalMarketNonSubscription>
<LocalMarketPaymentMethodCheckOutEnabled> ClassifiedAdPaymentMethodEnabledCodeType </LocalMarketPaymentMethodCheckOutEnabled>
<LocalMarketPhoneCount> int </LocalMarketPhoneCount>
<LocalMarketPremiumSubscription> boolean </LocalMarketPremiumSubscription>
<LocalMarketRegularSubscription> boolean </LocalMarketRegularSubscription>
<LocalMarketSellerContactDetailsEnabled> boolean </LocalMarketSellerContactDetailsEnabled>
<LocalMarketShippingMethodEnabled> boolean </LocalMarketShippingMethodEnabled>
<LocalMarketSpecialitySubscription> boolean </LocalMarketSpecialitySubscription>
<LocalMarketStreetCount> int </LocalMarketStreetCount>
<MinimumReservePrice> double </MinimumReservePrice>
<NonSubscription> GeographicExposureCodeType </NonSubscription>
<PaisaPayFullEscrowEnabled> boolean </PaisaPayFullEscrowEnabled>
<PayPalBuyerProtectionEnabled> boolean </PayPalBuyerProtectionEnabled>
<PayPalRequired> boolean </PayPalRequired>
<PremiumSubscription> GeographicExposureCodeType </PremiumSubscription>
<ProPackEnabled> boolean </ProPackEnabled>
<ProPackPlusEnabled> boolean </ProPackPlusEnabled>
<RegularSubscription> GeographicExposureCodeType </RegularSubscription>
<SafePaymentRequired> boolean </SafePaymentRequired>
<SellerContactDetailsEnabled> boolean </SellerContactDetailsEnabled>
<ShippingTermsRequired> boolean </ShippingTermsRequired>
<SkypeMeNonTransactionalEnabled> boolean </SkypeMeNonTransactionalEnabled>
<SkypeMeTransactionalEnabled> boolean </SkypeMeTransactionalEnabled>
<SpecialitySubscription> GeographicExposureCodeType </SpecialitySubscription>
<StoreInventoryEnabled> boolean </StoreInventoryEnabled>
<TransactionConfirmationRequestEnabled> boolean </TransactionConfirmationRequestEnabled>
<UserConsentRequired> boolean </UserConsentRequired>
<ValuePackEnabled> boolean </ValuePackEnabled>
</SiteDefaults>
<UpdateTime> dateTime </UpdateTime>
</GetCategoryFeaturesResponse>
| Return Value | Type | Returned? | Meaning |
|---|---|---|---|
| Standard Output Fields [Jump to call-specific 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 |
In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage 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, 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 (repeatable) |
Conditionally |
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 applic |