Retrieves detailed information about a single category. This includes applicable attributes, a legal notice (for categories that have one), available listing durations, listing fees and information about whether classifieds and/or auctions are allowed to be sold within the category.
Note: this API does not require authentication, but without authentication the information returned from this API is less accurate. It is highly recommended that you authenticate when calling this API.
CategoryId |
Integer |
CategoryId
|
Name |
String or null |
Name
|
Path |
String or null |
Path
|
IsRestricted |
Boolean |
IsRestricted
|
IsWine |
Boolean |
IsWine
|
CanListAuctions |
Boolean |
CanListAuctions
|
CanListClassifieds |
Boolean |
CanListClassifieds
|
CanRelist |
Boolean |
CanRelist
|
AuthenticatedBidsOnly |
Boolean |
AuthenticatedBidsOnly
|
LegalNotice |
String or null |
LegalNotice
|
DefaultDuration |
Enumeration |
DefaultDuration
|
|
EndDate |
0 |
EndDate
|
Two |
2 |
Two
|
Three |
3 |
Three
|
Four |
4 |
Four
|
Five |
5 |
Five
|
Six |
6 |
Six
|
Seven |
7 |
Seven
|
Ten |
10 |
Ten
|
Fourteen |
14 |
Fourteen
|
TwentyOne |
21 |
TwentyOne
|
TwentyEight |
28 |
TwentyEight
|
Thirty |
30 |
Thirty
|
FortyTwo |
42 |
FortyTwo
|
FiftySix |
56 |
FiftySix
|
EightyFour |
84 |
EightyFour
|
Ninety |
90 |
Ninety
|
HundredSixtyEight |
168 |
HundredSixtyEight
|
UntilWithdrawn |
-1 |
UntilWithdrawn
|
|
AllowedDurations |
Collection of Enumeration or null |
AllowedDurations
|
|
EndDate |
0 |
EndDate
|
Two |
2 |
Two
|
Three |
3 |
Three
|
Four |
4 |
Four
|
Five |
5 |
Five
|
Six |
6 |
Six
|
Seven |
7 |
Seven
|
Ten |
10 |
Ten
|
Fourteen |
14 |
Fourteen
|
TwentyOne |
21 |
TwentyOne
|
TwentyEight |
28 |
TwentyEight
|
Thirty |
30 |
Thirty
|
FortyTwo |
42 |
FortyTwo
|
FiftySix |
56 |
FiftySix
|
EightyFour |
84 |
EightyFour
|
Ninety |
90 |
Ninety
|
HundredSixtyEight |
168 |
HundredSixtyEight
|
UntilWithdrawn |
-1 |
UntilWithdrawn
|
|
Fees |
<ListingFees> or null |
Fees
|
Bold |
Number or null |
Bold
|
Bundle |
Number or null |
Bundle
|
EndDate |
Number or null |
EndDate
|
Feature |
Number or null |
Feature
|
Gallery |
Number or null |
Gallery
|
GalleryPlus |
Number or null |
GalleryPlus
|
Highlight |
Number or null |
Highlight
|
Homepage |
Number or null |
Homepage
|
Listing |
Number or null |
Listing
|
MultiPhoto |
Number or null |
MultiPhoto
|
Reserve |
Number or null |
Reserve
|
Subtitle |
Number or null |
Subtitle
|
TenDays |
Number or null |
TenDays
|
Withdrawal |
Number or null |
Withdrawal
|
SuperFeature |
Number or null |
SuperFeature
|
SuperFeatureBundle |
Number or null |
SuperFeatureBundle
|
HighVolume |
Number or null |
HighVolume
|
ListingFeeTiers |
Collection of <FeeTier> or null |
ListingFeeTiers
|
MinimumTierPrice |
Number |
MinimumTierPrice
|
FixedFee |
Number |
FixedFee
|
PercentageFee |
Number |
PercentageFee
|
|
MinimumSuccessFee |
Number |
MinimumSuccessFee
|
MaximumSuccessFee |
Number |
MaximumSuccessFee
|
SuccessFeeTiers |
Collection of <FeeTier> or null |
SuccessFeeTiers
|
(This type has already been defined)
|
Branding |
Number |
Branding
|
SecondCategory |
Number |
SecondCategory
|
Discounts |
Collection of <FeeDiscount> or null |
Discounts
|
Type |
Enumeration |
Type
|
|
NotSpecified |
0 |
NotSpecified
|
SuccessFee |
1 |
SuccessFee
|
Gallery |
2 |
Gallery
|
Feature |
3 |
Feature
|
FeatureCombo |
4 |
FeatureCombo
|
SuperFeature |
5 |
SuperFeature
|
Subtitle |
6 |
Subtitle
|
Reserve |
7 |
Reserve
|
TenDays |
8 |
TenDays
|
EndDate |
9 |
EndDate
|
|
Message |
String or null |
Message
|
|
|
FreePhotoCount |
Integer or null |
FreePhotoCount
|
MaximumPhotoCount |
Integer or null |
MaximumPhotoCount
|
IsFreeToRelist |
Boolean |
IsFreeToRelist
|
Attributes |
Collection of <Attribute> or null |
Attributes
|
Name |
String or null |
Name
|
DisplayName |
String or null |
DisplayName
|
Type |
Enumeration |
AttributeType
|
|
None |
0 |
None
|
Boolean |
1 |
Boolean
|
Integer |
2 |
Integer
|
Decimal |
3 |
Decimal
|
String |
4 |
String
|
DateTime |
5 |
DateTime
|
|
Range |
<AttributeRange> or null |
Range
|
Lower |
String or null |
Lower
|
Upper |
String or null |
Upper
|
|
MaxStringLength |
Integer |
MaxStringLength
|
Options |
Collection of <AttributeOption> or null |
Options
|
Value |
String or null |
Value
|
Display |
String or null |
Display
|
|
Units |
Collection of <AttributeUnit> or null |
Units
|
Display |
String or null |
Display
|
Multiplier |
Number |
Multiplier
|
|
IsRequiredForSell |
Boolean |
IsRequiredForSell
|
GroupName |
String or null |
GroupName
|
|
Charities |
Collection of <Charity> or null |
Charities
|
CharityType |
Enumeration |
CharityType
|
|
None |
0 |
None
|
ForestAndBird |
1 |
ForestAndBird
|
Plunket |
2 |
Plunket
|
StJohn |
3 |
StJohn
|
OurPeopleOurCityFund |
4 |
OurPeopleOurCityFund
|
WomensRefuge |
5 |
WomensRefuge
|
KidsCan |
6 |
KidsCan
|
|
ImageSource |
String or null |
ImageSource
|
DarkModeImageSource |
String or null |
DarkModeImageSource
|
Description |
String or null |
Description
|
Tagline |
String or null |
Tagline
|
|
IsMemberRestrictedFromListing |
Boolean or null |
IsMemberRestrictedFromListing
|
HasCatalogue |
Boolean |
HasCatalogue
|
Promotions |
Collection of <Promotion> or null |
Promotions
|
Id |
Integer |
Id
|
Name |
String or null |
Name
|
Description |
String or null |
Description
|
Price |
Number |
Price
|
OriginalPrice |
Number |
OriginalPrice
|
Recommended |
Boolean |
Recommended
|
MinimumPhotoCount |
Integer |
MinimumPhotoCount
|
DiscountDescription |
String or null |
DiscountDescription
|
DiscountStartDate |
String or null |
DiscountStartDate
|
DiscountEndDate |
String or null |
DiscountEndDate
|
DiscountDisclaimer |
String or null |
DiscountDisclaimer
|
GoodFor2RelistsFee |
Number |
GoodFor2RelistsFee
|
|
EmbeddedContentOptions |
Collection of <EmbeddedContentOption> or null |
EmbeddedContentOptions
|
Value |
String or null |
Value
|
|
HasAutomaticallyCreatedTitle |
Boolean |
HasAutomaticallyCreatedTitle
|
CanUseTradeMeShipping |
Boolean |
CanUseTradeMeShipping
|
PaymentMethods |
Collection of <PaymentMethodDetail> or null |
PaymentMethods
|
Id |
Enumeration |
Id
|
|
None |
0 |
None
|
BankDeposit |
1 |
NZ Bank Deposit
|
CreditCard |
2 |
Credit Card
|
Cash |
4 |
Cash
|
SafeTrader |
8 |
SafeTrader
|
Other |
16 |
Other
|
Ping |
32 |
Ping
|
Afterpay |
64 |
Afterpay
|
|
Name |
String or null |
Name
|
DefaultsToOn |
Boolean |
DefaultsToOn
|
LogoUrl |
String or null |
LogoUrl
|
SellerFeePercentage |
Number |
SellerFeePercentage
|
|
MaximumTitleLength |
Integer |
MaximumTitleLength
|
AreaOfBusiness |
Enumeration |
AreaOfBusiness
|
|
NotSpecified |
0 |
NotSpecified
|
All |
0 |
All
|
Marketplace |
1 |
Marketplace
|
Property |
2 |
Property
|
Motors |
3 |
Motors
|
Jobs |
4 |
Jobs
|
Services |
5 |
Services
|
|
ExtensionPeriod |
Integer |
ExtensionPeriod
|
DefaultRelistDuration |
Integer |
DefaultRelistDuration
|
CanHaveSecondCategory |
Boolean |
CanHaveSecondCategory
|
CanBeSecondCategory |
Boolean |
CanBeSecondCategory
|
PremiumPackages |
Collection of <PremiumPackage> or null |
PremiumPackages
|
Code |
String or null |
Code
|
Name |
String or null |
Name
|
|
ListingExtras |
Collection of <ListingExtras> or null |
ListingExtras
|
Name |
String or null |
Name
|
Variant |
String or null |
Variant
|
Description |
String or null |
Description
|
Duration |
Integer or null |
Duration
|
Delay |
Integer or null |
Delay
|
|
Blurb |
String or null |
Blurb
|
CanUseCounterOffers |
Boolean |
CanUseCounterOffers
|
PartnershipAgreementContents |
<PartnershipAgreementContentsCollection> or null |
PartnershipAgreementContents
|
ListingExtras |
Collection of <ListingExtras> or null |
ListingExtras
|
(This type has already been defined)
|
PremiumPackages |
Collection of <PremiumPackage> or null |
PremiumPackages
|
(This type has already been defined)
|
|
IsFirearms |
Boolean |
IsFirearms
|
{
"CategoryId": 123,
"Name": "ABC",
"Path": "ABC",
"IsRestricted": false,
"IsWine": false,
"CanListAuctions": false,
"CanListClassifieds": false,
"CanRelist": false,
"AuthenticatedBidsOnly": false,
"LegalNotice": "ABC",
"DefaultDuration": 0,
"AllowedDurations": [
0,
0
],
"Fees": {
"Bold": 123.0,
"Bundle": 123.0,
"EndDate": 123.0,
"Feature": 123.0,
"Gallery": 123.0,
"GalleryPlus": 123.0,
"Highlight": 123.0,
"Homepage": 123.0,
"Listing": 123.0,
"MultiPhoto": 123.0,
"Reserve": 123.0,
"Subtitle": 123.0,
"TenDays": 123.0,
"Withdrawal": 123.0,
"SuperFeature": 123.0,
"SuperFeatureBundle": 123.0,
"HighVolume": 123.0,
"ListingFeeTiers": [
{
"MinimumTierPrice": 123.0,
"FixedFee": 123.0,
"PercentageFee": 123.0
},
{
"MinimumTierPrice": 123.0,
"FixedFee": 123.0,
"PercentageFee": 123.0
}
],
"MinimumSuccessFee": 123.0,
"MaximumSuccessFee": 123.0,
"SuccessFeeTiers": [
{
},
{
}
],
"Branding": 123.0,
"SecondCategory": 123.0,
"Discounts": [
{
"Type": 0,
"Message": "ABC"
},
{
"Type": 0,
"Message": "ABC"
}
]
},
"FreePhotoCount": 123,
"MaximumPhotoCount": 123,
"IsFreeToRelist": false,
"Attributes": [
{
"Name": "ABC",
"DisplayName": "ABC",
"Type": 0,
"Range": {
"Lower": "ABC",
"Upper": "ABC"
},
"MaxStringLength": 123,
"Options": [
{
"Value": "ABC",
"Display": "ABC"
},
{
"Value": "ABC",
"Display": "ABC"
}
],
"Units": [
{
"Display": "ABC",
"Multiplier": 123.0
},
{
"Display": "ABC",
"Multiplier": 123.0
}
],
"IsRequiredForSell": false,
"GroupName": "ABC"
},
{
"Name": "ABC",
"DisplayName": "ABC",
"Type": 0,
"Range": {
"Lower": "ABC",
"Upper": "ABC"
},
"MaxStringLength": 123,
"Options": [
{
"Value": "ABC",
"Display": "ABC"
},
{
"Value": "ABC",
"Display": "ABC"
}
],
"Units": [
{
"Display": "ABC",
"Multiplier": 123.0
},
{
"Display": "ABC",
"Multiplier": 123.0
}
],
"IsRequiredForSell": false,
"GroupName": "ABC"
}
],
"Charities": [
{
"CharityType": 0,
"ImageSource": "ABC",
"DarkModeImageSource": "ABC",
"Description": "ABC",
"Tagline": "ABC"
},
{
"CharityType": 0,
"ImageSource": "ABC",
"DarkModeImageSource": "ABC",
"Description": "ABC",
"Tagline": "ABC"
}
],
"IsMemberRestrictedFromListing": false,
"HasCatalogue": false,
"Promotions": [
{
"Id": 123,
"Name": "ABC",
"Description": "ABC",
"Price": 123.0,
"OriginalPrice": 123.0,
"Recommended": false,
"MinimumPhotoCount": 123,
"DiscountDescription": "ABC",
"DiscountStartDate": "ABC",
"DiscountEndDate": "ABC",
"DiscountDisclaimer": "ABC",
"GoodFor2RelistsFee": 123.0
},
{
"Id": 123,
"Name": "ABC",
"Description": "ABC",
"Price": 123.0,
"OriginalPrice": 123.0,
"Recommended": false,
"MinimumPhotoCount": 123,
"DiscountDescription": "ABC",
"DiscountStartDate": "ABC",
"DiscountEndDate": "ABC",
"DiscountDisclaimer": "ABC",
"GoodFor2RelistsFee": 123.0
}
],
"EmbeddedContentOptions": [
{
"Value": "ABC"
},
{
"Value": "ABC"
}
],
"HasAutomaticallyCreatedTitle": false,
"CanUseTradeMeShipping": false,
"PaymentMethods": [
{
"Id": 0,
"Name": "ABC",
"DefaultsToOn": false,
"LogoUrl": "ABC",
"SellerFeePercentage": 123.0
},
{
"Id": 0,
"Name": "ABC",
"DefaultsToOn": false,
"LogoUrl": "ABC",
"SellerFeePercentage": 123.0
}
],
"MaximumTitleLength": 123,
"AreaOfBusiness": 0,
"ExtensionPeriod": 123,
"DefaultRelistDuration": 123,
"CanHaveSecondCategory": false,
"CanBeSecondCategory": false,
"PremiumPackages": [
{
"Code": "ABC",
"Name": "ABC"
},
{
"Code": "ABC",
"Name": "ABC"
}
],
"ListingExtras": [
{
"Name": "ABC",
"Variant": "ABC",
"Description": "ABC",
"Duration": 123,
"Delay": 123
},
{
"Name": "ABC",
"Variant": "ABC",
"Description": "ABC",
"Duration": 123,
"Delay": 123
}
],
"Blurb": "ABC",
"CanUseCounterOffers": false,
"PartnershipAgreementContents": {
"ListingExtras": [
{
},
{
}
],
"PremiumPackages": [
{
},
{
}
]
},
"IsFirearms": false
}