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 |
An integer ID that identifies the category.
|
Name |
String or null |
The name of the category.
|
Path |
String or null |
The full URL path of this category e.g. "/Home-living/Beds-bedroom-furniture/Bedside-tables".
|
IsRestricted |
Boolean |
Indicates whether the category is restricted to adults only (i.e. the category is R18).
|
IsWine |
Boolean |
Indicates whether this category is a wine category, which means only registered wine sellers are allowed to sell in this category.
|
CanListAuctions |
Boolean |
Indicates whether auctions can be listed in this category using the API.
|
CanListClassifieds |
Boolean |
Indicates whether classifieds can be listed in this category using the API.
|
CanRelist |
Boolean |
Indicates whether listings in this category can be relisted using the API.
|
AuthenticatedBidsOnly |
Boolean |
Indicates whether bids on listings in this category are only accepted from authenticated members. If this is true, the AuthenticatedMembersOnly field in the sell API request is ignored.
|
LegalNotice |
String or null |
The text of a legal notice, if any. Users must be shown the legal notice before being allowed to list in this category. An example of a category that requires a legal notice is the carbon credits category (because carbon credits must be certified and registered before they can be sold).
|
DefaultDuration |
Enumeration |
The default duration for a listing that is listed in this category.
|
|
EndDate |
0 |
An end date will be used to set the duration.
|
Two |
2 |
Two days.
|
Three |
3 |
Three days.
|
Four |
4 |
Four days.
|
Five |
5 |
Five days.
|
Six |
6 |
Six days.
|
Seven |
7 |
A week.
|
Ten |
10 |
Ten days.
|
Fourteen |
14 |
14 days.
|
TwentyOne |
21 |
21 days.
|
TwentyEight |
28 |
28 days.
|
Thirty |
30 |
30 days.
|
FortyTwo |
42 |
42 days.
|
FiftySix |
56 |
56 days.
|
EightyFour |
84 |
84 days (Commercial for Sale, Commercial for Lease, New Homes only).
|
Ninety |
90 |
90 days (Retirement Villages only).
|
HundredSixtyEight |
168 |
168 days (Commercial for Sale, Commercial for Lease only).
|
UntilWithdrawn |
-1 |
until withdrawn (only available for agents outside of the services category)
|
|
AllowedDurations |
Collection of Enumeration or null |
A list of durations that are allowed when listing in this category.
|
|
EndDate |
0 |
An end date will be used to set the duration.
|
Two |
2 |
Two days.
|
Three |
3 |
Three days.
|
Four |
4 |
Four days.
|
Five |
5 |
Five days.
|
Six |
6 |
Six days.
|
Seven |
7 |
A week.
|
Ten |
10 |
Ten days.
|
Fourteen |
14 |
14 days.
|
TwentyOne |
21 |
21 days.
|
TwentyEight |
28 |
28 days.
|
Thirty |
30 |
30 days.
|
FortyTwo |
42 |
42 days.
|
FiftySix |
56 |
56 days.
|
EightyFour |
84 |
84 days (Commercial for Sale, Commercial for Lease, New Homes only).
|
Ninety |
90 |
90 days (Retirement Villages only).
|
HundredSixtyEight |
168 |
168 days (Commercial for Sale, Commercial for Lease only).
|
UntilWithdrawn |
-1 |
until withdrawn (only available for agents outside of the services category)
|
|
Fees |
<ListingFees> or null |
An estimate of the various fees for this category. If the API call is authenticated then these values will reflect any member-specific discounts. Fees may differ due to the user selecting certain combinations of promotions, or other reasons. For promotional fees specifically, if a fee is missing it means the associated promotion is not available, whereas if a fee is $0 it means the promotion is available for free. (This is a rather nebulous distinction - most clients should not make any distinction between the two).
|
Bold |
Number or null |
The price of the bold title promotion. Listings with this promotion have a bold title in search results. If the property is not present, then this promotion is not available.
|
Bundle |
Number or null |
The price of having the feature, bold and gallery promotions. If the property is not present, then this promotion is not available. Note that some categories do not allow certain promotions - in this case only the supported promotions are included in the price.
|
EndDate |
Number or null |
The price of the scheduled end time promotion. If the property is not present, then this promotion is not available.
|
Feature |
Number or null |
The price of the feature promotion. Listings with this promotion are shown higher in search results. If the property is not present, then this promotion is not available.
|
Gallery |
Number or null |
The price of the gallery promotion. Listings with this promotion show photos in search results. If the property is not present, then this promotion is not available.
|
GalleryPlus |
Number or null |
The price of the gallery plus promotion. Listings with this promotion get the gallery promotion, plus the next two relists also get the gallery promotion if the item doesn't sell. If the property is not present, then this promotion is not available.
|
Highlight |
Number or null |
The price of the highlight promotion. Listings with this promotion have a bright yellow border. If the property is not present, then this promotion is not available.
|
Homepage |
Number or null |
The price of featuring the listing on the homepage. If the property is not present, then this promotion is not available.
|
Listing |
Number or null |
The base price of listing an item. Applies to classifieds and auctions in some categories. Note that in some categories the fee for listing a classified depends on the asking price (or the rateable value/rent per week for properties) - for these categories this property will contain the price at the lowest tier. If this property is not present, then there is no listing fee for this category. For Motors the field is only applicable to Auctions
|
MultiPhoto |
Number or null |
The price for additional photos. If the property is not present, then this promotion is not available.
|
Reserve |
Number or null |
The price for having a reserve. If the property is not present, then this promotion is not available.
|
Subtitle |
Number or null |
The cost of the subtitle promotion. Listings with this promotion have a subtitle in search results and listing pages. If the property is not present, then this promotion is not available.
|
TenDays |
Number or null |
The price to extend the listing to a duration of 10 days. If the property is not present, then this promotion is not available.
|
Withdrawal |
Number or null |
The minimum withdrawal fee for a listing. For some categories, including Motors, the withdrawal fee is calculated based on the sale price of the item at the time of the withdrawal. Withdrawing the item in the first hour is fee. Retrieve fees for withdrawing a listing endpoint is used to calculate the correct value.
|
SuperFeature |
Number or null |
The price for the super feature promotion. Listings with the super feature promotion are listed on the landing page for certain verticals, such as Trade Me Motors. This price is irrelevant for general marketplace listings. This is the price for super feature only - it does not include the feature combo extras. It is only available when adding the super feature promotion to a listing which had it already, but where the super feature period has expired. If the property is not present, then this promotion is not available.
|
SuperFeatureBundle |
Number or null |
The price for the super feature promotion. Listings with the super feature promotion are listed on the landing page for categories in general marketplace and verticals, such as Trade Me Motors. This price includes feature, bold, highlight and gallery, where applicable. If the property is not present, then this promotion is not available.
|
HighVolume |
Number or null |
The price for listing more than a set number of listings concurrently. The maximum number of listings you can run without incurring a fee starts at 50, but increases based on the number of items you have sold. See our help page for more information. This fee does not apply to classifieds. This fee is the same for all categories (i.e. it is not category-specific).
|
ListingFeeTiers |
Collection of <FeeTier> or null |
If this category supports classifieds and the listing fee is dependent on the asking price, then this field will contain a list of pricing tiers. Only applies to classifieds.
|
MinimumTierPrice |
Number |
The minimum price (may be the sale price, asking price, rateable value or rent per week, depending on the category and the type of fee) for this tier. The maximum price for this tier is defined by the minimum price for the next tier (if this is the last tier, then the maximum price is unlimited).
|
FixedFee |
Number |
The fixed fee that applies to listings within this tier. If the PercentageFee property is also present, then this fee applies in addition to that one.
|
PercentageFee |
Number |
The fee that applies to listings within this tier, as a percentage of the price increase over the minimum tier price. For example, if this fee applies to a sale price of $250, the MinimumTierPrice is $200, and the PercentageFee is 4.9, then this fee is 4.9% of the $50 which amounts to $2.45. If the FixedFee property is present, then this fee applies in addition to that one.
|
|
MinimumSuccessFee |
Number |
The minimum success fee. Success fees only apply to auctions. If the property is not present, then the minimum success fee is zero.
|
MaximumSuccessFee |
Number |
The maximum success fee. Success fees only apply to auctions. If the property is not present, then success fees do not apply to this category.
|
SuccessFeeTiers |
Collection of <FeeTier> or null |
A list of success fee tiers. Only applies to auctions. If the property is not present, then success fees do not apply to this category.
|
(This type has already been defined)
|
Branding |
Number |
The price of the branding promotion. Listings with this promotion can have logo and/or banner. If the property is not present, then this promotion is not available.
|
SecondCategory |
Number |
The price of the second category promotion. Listings with this promotion will also appear in the second category selected.
|
Discounts |
Collection of <FeeDiscount> or null |
Additional information regarding member specific discounts for this category. The discount values are already applied to the Fees.
|
Type |
Enumeration |
Fee discount type.
|
|
NotSpecified |
0 |
No fee discount specified.
|
SuccessFee |
1 |
The fee for a successful auction.
|
Gallery |
2 |
The fee of the gallery promotion.
|
Feature |
3 |
The fee of the feature promotion.
|
FeatureCombo |
4 |
The fee of the feature combo promotion.
|
SuperFeature |
5 |
The fee of the super feature promotion.
|
Subtitle |
6 |
The fee of the subtitle promotion.
|
Reserve |
7 |
The fee for having a reserve price.
|
TenDays |
8 |
The fee for extending the listing to a duration of 10 days.
|
EndDate |
9 |
The fee of the scheduled end time promotion.
|
|
Message |
String or null |
A short description of the fee discount.
|
|
|
FreePhotoCount |
Integer or null |
The number of photos that are allowed on a listing without a fee being incurred. After this limit is exceeded, a fee is charged per photo.
|
MaximumPhotoCount |
Integer or null |
The maximum number of photos allowed on a single listing in this category.
|
IsFreeToRelist |
Boolean |
If this value is true, then the fees that are normally charged are waived when relisting a listing in this category. You may still be charged if the relist adds additional extras that were not present in the original listing.
|
Attributes |
Collection of <Attribute> or null |
A list of the attributes that apply to this category.
|
Name |
String or null |
A name which uniquely identifies the attribute. Required when selling or editing.
|
DisplayName |
String or null |
The name of the attribute, in a form suitable for displaying to users. Not required when selling or editing.
|
Type |
Enumeration |
The type of the attribute, which determines the range of acceptable values. Not required when selling or editing.
|
|
None |
0 |
Not used.
|
Boolean |
1 |
The attribute value is a boolean (true/false).
|
Integer |
2 |
The attribute value is an integer.
|
Decimal |
3 |
The attribute value is a floating point number.
|
String |
4 |
The attribute value can be arbitrary text.
|
DateTime |
5 |
The attribute value is a date & time (in UTC).
|
|
Range |
<AttributeRange> or null |
The allowed range of the attribute. Only applies to numeric attributes. Not required when selling or editing.
|
Lower |
String or null |
The lowest allowed value of the attribute.
|
Upper |
String or null |
The highest allowed value of the attribute.
|
|
MaxStringLength |
Integer |
The maximum allowed length of the attribute value, in characters. Only applies to string attributes. Some string attributes do not have a maximum length because they are restricted to a fixed list of options, or because any length is acceptable. Not required when selling or editing.
|
Options |
Collection of <AttributeOption> or null |
A list of options, if the attribute is restricted to a fixed set of values. Not required when selling or editing.
|
Value |
String or null |
The value of the item as a string.
|
Display |
String or null |
What should be displayed for this value (often the same).
|
|
Units |
Collection of <AttributeUnit> or null |
A list of units that apply (MHz, hectares, etc). Only applies to numeric attributes. Not required when selling or editing.
|
Display |
String or null |
The unit name, in a format suitable for displaying to a user (e.g. "MHz").
|
Multiplier |
Number |
The multiplier to apply to the value the user entered to get a value suitable for passing to the sell API.
|
|
IsRequiredForSell |
Boolean |
Indicates whether the attribute must be present when selling an item.
|
GroupName |
String or null |
Suggests the category name for the attribute grouping on the UI level.
|
|
Charities |
Collection of <Charity> or null |
Returns the list of available charity options which are available to donate to when listing.
|
CharityType |
Enumeration |
The unique identifier of the charity.
|
|
None |
0 |
The default charity identifier. Used if the user chose not to donate to a charity at all.
|
ForestAndBird |
1 |
Donate to Forest and Bird's kiwis for kiwis program.
|
Plunket |
2 |
Donate to Plunket.
|
StJohn |
3 |
Donate to St John.
|
OurPeopleOurCityFund |
4 |
Donate to Our People, Our City Fund.
|
WomensRefuge |
5 |
Donate to Women's Refuge
|
KidsCan |
6 |
Donate to KidsCan
|
|
ImageSource |
String or null |
The URL for this charity's brand image (designed for a light background).
|
DarkModeImageSource |
String or null |
The URL for this charity's brand image (designed for a dark background).
|
Description |
String or null |
The name of the charity e.g. "Plunket", "Kiwis for kiwi".
|
Tagline |
String or null |
A short description of what the charity does.
|
|
IsMemberRestrictedFromListing |
Boolean or null |
Specifies whether the current member has been restricted from listing in this category.
|
HasCatalogue |
Boolean |
Returns true if the catagory supports listing via a catalogue.
|
Promotions |
Collection of <Promotion> or null |
The list of available promotional options. Only one promotional option can be selected. These are only available in categories where Super Grid has been enabled.
|
Id |
Integer |
The unique identifier of the promotion.
|
Name |
String or null |
The name of the promotion.
|
Description |
String or null |
A short description of the promotion.
|
Price |
Number |
The current price of the promotion. This price should include any discounts currently applied.
|
OriginalPrice |
Number |
The price of the promotion before any discounts have been applied.
|
Recommended |
Boolean |
Whether this promotion is currently being recommended.
|
MinimumPhotoCount |
Integer |
The minimum number of photos required for the promotion.
|
DiscountDescription |
String or null |
A short description of any discount applied to this promotion.
|
DiscountStartDate |
String or null |
The start date of any discount applied to this promotion.
|
DiscountEndDate |
String or null |
The end date of any discount applied to this promotion.
|
DiscountDisclaimer |
String or null |
The legal disclaimer of any discount applied to this promotion.
|
GoodFor2RelistsFee |
Number |
The value of the GoodFor2Relists fee if eligible for this promotion.
|
|
EmbeddedContentOptions |
Collection of <EmbeddedContentOption> or null |
A list of the embedded content options that apply to this category.
|
Value |
String or null |
The value of the item as a string.
|
|
HasAutomaticallyCreatedTitle |
Boolean |
This flag indicates if this category has automatically generated listing titles. For example car auctions have automatically generated listings titles and any title provided during creation or edit will be ignored.
|
CanUseTradeMeShipping |
Boolean |
Returns true if the authenticated member and category can use Trade Me shipping. If the call is unathenticated returns false.
|
PaymentMethods |
Collection of <PaymentMethodDetail> or null |
A list of the supported payment methods.
|
Id |
Enumeration |
The unique identifier for the payment method.
|
|
None |
0 |
No payment methods provided.
|
BankDeposit |
1 |
NZ bank deposit.
|
CreditCard |
2 |
Credit card. (Processed via Pay Now if the seller uses Pay Now, otherwise Buy Now)
|
Cash |
4 |
Cash.
|
SafeTrader |
8 |
Safe Trader (Now obsolete).
|
Other |
16 |
Other (needs to be specified).
|
Ping |
32 |
Ping.
|
Afterpay |
64 |
Afterpay.
|
|
Name |
String or null |
The text to display to the user.
|
DefaultsToOn |
Boolean |
Indicates whether the option should be selected by default when the user is creating a new listing.
|
LogoUrl |
String or null |
A url for the payment methods logo.
|
SellerFeePercentage |
Number |
The percentage fee of this payment method for the logged in member.
|
|
MaximumTitleLength |
Integer |
The maximum length of listing titles.
|
AreaOfBusiness |
Enumeration |
Area of business this category is related to
|
|
NotSpecified |
0 |
None specified.
|
All |
0 |
All
|
Marketplace |
1 |
Marketplace
|
Property |
2 |
Property
|
Motors |
3 |
Motors
|
Jobs |
4 |
Jobs
|
Services |
5 |
Services
|
|
ExtensionPeriod |
Integer |
The number of days that a listed item can be extended for
|
DefaultRelistDuration |
Integer |
The default number of days to relist an expired item
|
CanHaveSecondCategory |
Boolean |
Indicates whether this category can be paired with a second category.
|
CanBeSecondCategory |
Boolean |
Indicates whether this category can be selected as a second category.
|
PremiumPackages |
Collection of <PremiumPackage> or null |
A list of all available premium packages.
|
Code |
String or null |
The package code.
|
Name |
String or null |
The display name of this package.
|
|
ListingExtras |
Collection of <ListingExtras> or null |
A collection of extras that are allowed when listing in this category. We require Name, & Variant for each ListingExtra when creating or editing a listing.
|
Name |
String or null |
The name of the extra.
|
Variant |
String or null |
The variation of the extra. For example this could determine the duration, delay, or configuration of the listing extra.
|
Description |
String or null |
The description of the extra; informational only.
|
Duration |
Integer or null |
The number of days the extra will be active; informational only.
|
Delay |
Integer or null |
The number of days before the extra will become active after purchase; informational only.
|
|
Blurb |
String or null |
A blurb content used for displaying on category landing pages for SEO
|
CanUseCounterOffers |
Boolean |
Indicates whether listings in this category can use MakeAnOffer(CounterOffers) feature.
|
PartnershipAgreementContents |
<PartnershipAgreementContentsCollection> or null |
The contents of the commitment contract for the member. Includes listing extras or packages for specified category
|
ListingExtras |
Collection of <ListingExtras> or null |
Listing Extras provided in commitment contract or partnership agreement
|
(This type has already been defined)
|
PremiumPackages |
Collection of <PremiumPackage> or null |
Packages provided in commitment contract or partnership agreement
|
(This type has already been defined)
|
|
IsFirearms |
Boolean |
Indicates whether this category is a firearms category, which means only users having a Firearms licence are allowed to sell or buy in this category.
|
{
"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
}