This Choreo returns information that describes the feature and value settings that apply to the set of eBay categories. The documentation for this eBay method can be found here.
Here is an example of acceptable inputs to retrieve a list of the top-level categories for the specified eBay site:
UserToken: {YOUR EBAY USER TOKEN}
DetailLevel: ReturnAll
AllFeaturesForCategory: true
SandboxMode: 1
The following is a sample of the JSON information returned by this Choreo using the inputs above:
{
"@xmlns": "urn:ebay:apis:eBLBaseComponents",
"Timestamp": "2013-08-23T19:16:37.753Z",
"Ack": "Success",
"Version": "837",
"Build": "E837_CORE_API_16303061_R1",
"CategoryArray": {
"Category": [
{
"BestOfferEnabled": "true",
"AutoPayEnabled": "true",
"CategoryID": "20081",
"CategoryLevel": "1",
"CategoryName": "Antiques",
"CategoryParentID": "20081"
},
{
"BestOfferEnabled": "true",
"AutoPayEnabled": "true",
"CategoryID": "550",
"CategoryLevel": "1",
"CategoryName": "Art",
"CategoryParentID": "550"
},
{
"BestOfferEnabled": "true",
"AutoPayEnabled": "true",
"CategoryID": "2984",
"CategoryLevel": "1",
"CategoryName": "Baby",
"CategoryParentID": "2984"
},
{
"BestOfferEnabled": "true",
"AutoPayEnabled": "true",
"CategoryID": "267",
"CategoryLevel": "1",
"CategoryName": "Books",
"CategoryParentID": "267"
},
{
"BestOfferEnabled": "true",
"AutoPayEnabled": "true",
"CategoryID": "12576",
"CategoryLevel": "1",
"CategoryName": "Business & Industrial",
"CategoryParentID": "12576"
},
{
"BestOfferEnabled": "true",
"AutoPayEnabled": "true",
"CategoryID": "625",
"CategoryLevel": "1",
"CategoryName": "Cameras & Photo",
"CategoryParentID": "625"
},
{
"BestOfferEnabled": "true",
"AutoPayEnabled": "true",
"CategoryID": "1249",
"CategoryLevel": "1",
"CategoryName": "Video Games & Consoles",
"CategoryParentID": "1249"
},
{
"BestOfferEnabled": "true",
"AutoPayEnabled": "true",
"CategoryID": "99",
"CategoryLevel": "1",
"CategoryName": "Everything Else",
"CategoryParentID": "99"
},
{
"BestOfferEnabled": "true",
"CategoryID": "10159",
"CategoryLevel": "1",
"CategoryName": "Partner",
"CategoryParentID": "10159",
"Expired": "true"
}
]
},
"CategoryCount": "35",
"UpdateTime": "2013-08-09T02:13:20.000Z",
"CategoryVersion": "106",
"ReservePriceAllowed": "true",
"MinimumReservePrice": "0.0"
}
Here is an example of acceptable inputs to retrieve the details on the specified category:
UserToken: {YOUR EBAY USER TOKEN}
CategoryParent: 267
DetailLevel: ReturnAll
LevelLimit: 2
SandboxMode: 1
The following is a sample of the JSON information returned by this Choreo using the inputs above:
{
"@xmlns": "urn:ebay:apis:eBLBaseComponents",
"Timestamp": "2013-08-23T21:34:55.014Z",
"Ack": "Success",
"Version": "837",
"Build": "E837_CORE_API_16303061_R1",
"CategoryVersion": "6615",
"UpdateTime": "2013-08-23T10:11:14.000Z",
"SiteDefaults": {
"ShippingTermsRequired": "true",
"BestOfferEnabled": "false",
"DutchBINEnabled": "false",
"UserConsentRequired": "false",
"HomePageFeaturedEnabled": "true",
"ProPackEnabled": "false",
"BasicUpgradePackEnabled": "false",
"ValuePackEnabled": "true",
"ProPackPlusEnabled": "true",
"AdFormatEnabled": "Disabled",
"BestOfferCounterEnabled": "false",
"BestOfferAutoDeclineEnabled": "false",
"LocalMarketSpecialitySubscription": "false",
"LocalMarketRegularSubscription": "false",
"LocalMarketPremiumSubscription": "false",
"LocalMarketNonSubscription": "false",
"ExpressEnabled": "true",
"ExpressPicturesRequired": "true",
"ExpressConditionRequired": "false",
"MinimumReservePrice": "0.0",
"SellerContactDetailsEnabled": "false",
"TransactionConfirmationRequestEnabled": "false",
"StoreInventoryEnabled": "false",
"SkypeMeTransactionalEnabled": "true",
"SkypeMeNonTransactionalEnabled": "true",
"ClassifiedAdPaymentMethodEnabled": "NotSupported",
"ClassifiedAdShippingMethodEnabled": "false",
"ClassifiedAdBestOfferEnabled": "Disabled",
"ClassifiedAdCounterOfferEnabled": "false",
"ClassifiedAdAutoDeclineEnabled": "false",
"ClassifiedAdContactByPhoneEnabled": "false",
"ClassifiedAdContactByEmailEnabled": "false",
"SafePaymentRequired": "true",
"ItemSpecificsEnabled": "Enabled",
"ClassifiedAdAutoAcceptEnabled": "false",
"BestOfferAutoAcceptEnabled": "false",
"CrossBorderTradeNorthAmericaEnabled": "false",
"CrossBorderTradeGBEnabled": "true",
"CrossBorderTradeAustraliaEnabled": "false",
"PayPalBuyerProtectionEnabled": "false",
"BuyerGuaranteeEnabled": "true",
"CombinedFixedPriceTreatmentEnabled": "true",
"GalleryFeaturedDurations": {
"Duration": [
"Days_7",
"Lifetime"
]
},
"PayPalRequired": "false",
"eBayMotorsProAdFormatEnabled": "Disabled",
"eBayMotorsProContactByPhoneEnabled": "false",
"eBayMotorsProContactByAddressEnabled": "false",
"eBayMotorsProCompanyNameEnabled": "false",
"eBayMotorsProContactByEmailEnabled": "false",
"eBayMotorsProBestOfferEnabled": "Disabled",
"eBayMotorsProAutoAcceptEnabled": "false",
"eBayMotorsProAutoDeclineEnabled": "false",
"eBayMotorsProPaymentMethodCheckOutEnabled": "NotSupported",
"eBayMotorsProShippingMethodEnabled": "false",
"eBayMotorsProCounterOfferEnabled": "false",
"eBayMotorsProSellerContactDetailsEnabled": "false",
"LocalMarketAdFormatEnabled": "Disabled",
"LocalMarketContactByPhoneEnabled": "false",
"LocalMarketContactByAddressEnabled": "false",
"LocalMarketCompanyNameEnabled": "false",
"LocalMarketContactByEmailEnabled": "false",
"LocalMarketBestOfferEnabled": "Disabled",
"LocalMarketAutoAcceptEnabled": "false",
"LocalMarketAutoDeclineEnabled": "false",
"LocalMarketPaymentMethodCheckOutEnabled": "NotSupported",
"LocalMarketShippingMethodEnabled": "false",
"LocalMarketCounterOfferEnabled": "false",
"LocalMarketSellerContactDetailsEnabled": "false",
"ClassifiedAdContactByAddressEnabled": "false",
"ClassifiedAdCompanyNameEnabled": "false",
"SpecialitySubscription": "National",
"RegularSubscription": "National",
"PremiumSubscription": "National",
"NonSubscription": "National",
"IntangibleEnabled": "false",
"PayPalRequiredForStoreOwner": "false",
"ReviseQuantityAllowed": "true",
"RevisePriceAllowed": "true",
"StoreOwnerExtendedListingDurationsEnabled": "false",
"ReturnPolicyEnabled": "true",
"HandlingTimeEnabled": "false",
"MaxFlatShippingCostCBTExempt": "false",
"PaymentMethod": [
"PayPal",
"ProPay",
"Moneybookers",
"VisaMC",
"Discover",
"AmEx",
"IntegratedMerchantCreditCard",
"CashOnPickup"
],
"ZeroInsertionFeeEligible": "false",
"VariationsEnabled": "false",
"AttributeConversionEnabled": "Enabled",
"FreeGalleryPlusEnabled": "false",
"FreePicturePackEnabled": "false",
"ItemCompatibilityEnabled": "Disabled",
"MinItemCompatibility": "0",
"MaxItemCompatibility": "0",
"ConditionEnabled": "Disabled",
"ValueCategory": "false",
"ProductCreationEnabled": "Disabled",
"FixedPriceFormatDisabled": "false",
"MaxItemSpecificsInClassified": "0",
"MaxGranularFitmentCount": "0",
"ShippingProfileCategoryGroup": "ALL",
"PaymentProfileCategoryGroup": "ALL",
"ReturnPolicyProfileCategoryGroup": "ALL",
"VINSupported": "false",
"VRMSupported": "false",
"SellerProvidedTitleSupported": "false",
"DepositSupported": "false",
"GlobalShippingEnabled": "true",
"AdditionalCompatibilityEnabled": "false"
},
"FeatureDefinitions": {
"ListingDurations": {
"@Version": "7"
},
"ShippingTermsRequired": null,
"BestOfferEnabled": null,
"DutchBINEnabled": null,
"UserConsentRequired": null,
"HomePageFeaturedEnabled": null,
"ProPackEnabled": null,
"BasicUpgradePackEnabled": null,
"ValuePackEnabled": null,
"ProPackPlusEnabled": null,
"AdFormatEnabled": null,
"BestOfferCounterEnabled": null,
"BestOfferAutoDeclineEnabled": null,
"LocalMarketSpecialitySubscription": null,
"LocalMarketRegularSubscription": null,
"LocalMarketPremiumSubscription": null,
"LocalMarketNonSubscription": null,
"ExpressEnabled": null,
"ExpressPicturesRequired": null,
"ExpressConditionRequired": null,
"MinimumReservePrice": null,
"TransactionConfirmationRequestEnabled": null,
"SellerContactDetailsEnabled": null,
"StoreInventoryEnabled": null,
"SkypeMeTransactionalEnabled": null,
"SkypeMeNonTransactionalEnabled": null,
"ClassifiedAdPaymentMethodEnabled": null,
"ClassifiedAdShippingMethodEnabled": null,
"ClassifiedAdBestOfferEnabled": null,
"ClassifiedAdCounterOfferEnabled": null,
"ClassifiedAdAutoDeclineEnabled": null,
"ClassifiedAdContactByPhoneEnabled": null,
"ClassifiedAdContactByEmailEnabled": null,
"SafePaymentRequired": null,
"ItemSpecificsEnabled": null,
"BestOfferAutoAcceptEnabled": null,
"ClassifiedAdAutoAcceptEnabled": null,
"CrossBorderTradeNorthAmericaEnabled": null,
"CrossBorderTradeGBEnabled": null,
"CrossBorderTradeAustraliaEnabled": null,
"PayPalBuyerProtectionEnabled": null,
"BuyerGuaranteeEnabled": null,
"CombinedFixedPriceTreatmentEnabled": null,
"GalleryFeaturedDurations": null,
"PayPalRequired": null,
"eBayMotorsProAdFormatEnabled": null,
"eBayMotorsProContactByPhoneEnabled": null,
"eBayMotorsProPhoneCount": null,
"eBayMotorsProContactByAddressEnabled": null,
"eBayMotorsProStreetCount": null,
"eBayMotorsProCompanyNameEnabled": null,
"eBayMotorsProContactByEmailEnabled": null,
"eBayMotorsProBestOfferEnabled": null,
"eBayMotorsProAutoAcceptEnabled": null,
"eBayMotorsProAutoDeclineEnabled": null,
"eBayMotorsProPaymentMethodCheckOutEnabled": null,
"eBayMotorsProShippingMethodEnabled": null,
"eBayMotorsProCounterOfferEnabled": null,
"eBayMotorsProSellerContactDetailsEnabled": null,
"LocalMarketAdFormatEnabled": null,
"LocalMarketContactByPhoneEnabled": null,
"LocalMarketPhoneCount": null,
"LocalMarketContactByAddressEnabled": null,
"LocalMarketStreetCount": null,
"LocalMarketCompanyNameEnabled": null,
"LocalMarketContactByEmailEnabled": null,
"LocalMarketBestOfferEnabled": null,
"LocalMarketAutoAcceptEnabled": null,
"LocalMarketAutoDeclineEnabled": null,
"LocalMarketPaymentMethodCheckOutEnabled": null,
"LocalMarketShippingMethodEnabled": null,
"LocalMarketCounterOfferEnabled": null,
"LocalMarketSellerContactDetailsEnabled": null,
"ClassifiedAdPhoneCount": null,
"ClassifiedAdContactByAddressEnabled": null,
"ClassifiedAdStreetCount": null,
"ClassifiedAdCompanyNameEnabled": null,
"SpecialitySubscription": null,
"RegularSubscription": null,
"PremiumSubscription": null,
"NonSubscription": null,
"IntangibleEnabled": null,
"ReturnPolicyEnabled": null,
"HandlingTimeEnabled": null,
"PayPalRequiredForStoreOwner": null,
"ReviseQuantityAllowed": null,
"RevisePriceAllowed": null,
"StoreOwnerExtendedListingDurationsEnabled": null,
"PaymentMethod": null,
"Group1MaxFlatShippingCost": null,
"Group2MaxFlatShippingCost": null,
"Group3MaxFlatShippingCost": null,
"MaxFlatShippingCostCBTExempt": null,
"MaxFlatShippingCost": null,
"ZeroInsertionFeeEligible": null,
"VariationsEnabled": null,
"AttributeConversionEnabled": null,
"FreeGalleryPlusEnabled": null,
"FreePicturePackEnabled": null,
"ItemCompatibilityEnabled": null,
"MaxItemCompatibility": null,
"MinItemCompatibility": null,
"ConditionEnabled": null,
"ConditionValues": null,
"ValueCategory": null,
"ProductCreationEnabled": null,
"FixedPriceFormatDisabled": null,
"MaxItemSpecificsInClassified": null,
"CompatibleVehicleType": null,
"MaxGranularFitmentCount": null,
"ShippingProfileCategoryGroup": null,
"PaymentProfileCategoryGroup": null,
"ReturnPolicyProfileCategoryGroup": null,
"VINSupported": null,
"VRMSupported": null,
"SellerProvidedTitleSupported": null,
"DepositSupported": null,
"GlobalShippingEnabled": null,
"AdditionalCompatibilityEnabled": null
}
}