Returns a breakdown of the fees that will be charged for a listing, without actually creating the listing.
| Category |
String (optional) |
The ID of the category to list the item in. For example, specify "6853" to list an oil heater. This field also accepts the MCAT category format (e.g. "0004-0370-0560-6853-"). Ignored when listing from the DVD/Blu-ray catalogue.
|
| Title |
String (optional) |
The title of the listing. Maximum of 80 characters for Marketplace categories, 50 for the other businesses. Mandatory for most categories. In some categories (e.g. used cars, motorbikes, flatmates wanted) the title is based on one or more attributes. In these categories the title is optional, and is ignored if it is supplied. Not required when listing from the DVD/Blu-ray catalogue.
|
| Subtitle |
String (optional) |
The subtitle of the listing. Optional. Maximum of 50 characters.
|
| Description |
Collection of String (optional) |
A plain text description of the listing. Use CRLF to insert a new line. Mandatory for all auction types except DVD and Blu-ray catalogue listings. Maximum length of 5100 characters for job listings, 5200 characters for property listings and 2048 characters for all others.
|
| StartPrice |
Number (optional) |
The start price of the listing. Mandatory for auctions. Must be a minimum of 50c and must be less than or equal to the ReservePrice. For most classifieds this value is optional: if specified it is the value that is displayed as the ‘Asking price’. A notable exception to this rule are business for sale classifieds. Not used for property listings (subcategories of category 350); use the PropertyPricePrice attribute instead.
|
| ReservePrice |
Number (optional) |
The reserve price of the listing. Optional. If supplied, it must be a minimum of 50c and it must be greater than or equal to the StartPrice. Only applicable to auctions, ignored for classifieds.
|
| BuyNowPrice |
Number (optional) |
The Buy Now price of the listing. Optional. Must be a minimum of 50c, must be greater than or equal to the StartPrice. For Buy Now Only auctions quantity and shipping information must be specified. See Quantity and IsFlatShippingCharge. Only applicable to auctions, ignored for classifieds.
|
| Duration |
Enumeration (required) |
The duration of the listing. Mandatory. Must be one of the durations available as per the category details API. Can be a fixed duration or a specified end time.
|
|
| 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)
|
|
| EndDateTime |
DateTime (optional) |
The date and time the listing should close. Ignored unless Duration is set to EndDate.
|
| Pickup |
Enumeration (optional) |
Indicates whether the buyer can (or is required to) pick-up the item. For auctions any value other than Demand implies that at least one shipping option must be provided. For classifieds this value is ignored.
|
|
| None |
0 |
The listing allows pick up, but does not require it.
|
| Allow |
1 |
The buyer can pickup if they so choose.
|
| Demand |
2 |
The buyer must pickup the item.
|
| Forbid |
3 |
The buyer cannot pickup the item (delivery only).
|
|
| PickupSuburbId |
Integer (optional) |
If the buyer can (or is required to) pick-up the item then this field can be used to specify the pick-up suburb id. It uses the three-tier region/district/suburb system. Optional. Only applicable to auctions, ignored for classifieds.
|
| IsBrandNew |
Boolean (optional) |
Indicates whether the listing is for a brand new item. Optional, defaults to false. Only applicable to auctions, ignored for classifieds.
|
| AuthenticatedMembersOnly |
Boolean (optional) |
Determines if only authenticated members can bid on the listing. Only applicable to auctions, ignored for classifieds.
|
| IsClassified |
Boolean (optional) |
Determines if this listing is a classified or an auction. Optional, defaults to false. Some categories support auctions, some support classifieds and some accept both types. Use the category details API to check which types a category supports.
|
| OpenHomes |
Collection of <OpenHome> (optional) |
A list of upcoming open home times. Currently only applies to residential for sale (category 3399) and lifestyle (category 9120) listings.
|
| Start |
DateTime (required) |
The date and time the open home is open for viewing. The date must be in the future and it must be less than 56 days from the current date. Specify dates in the UTC time zone.
|
| End |
DateTime (required) |
The date and time the open home is no longer open for viewing. Must be the same day as Start.
|
|
| SendPaymentInstructions |
Boolean (optional) |
Determines if only the payment instructions are sent at the end of the listing Specifies if automatic payment instructions email will be sent to the winner of the auction. Optional, defaults to false.
|
| OtherPaymentMethod |
String (optional) |
If the list of payment methods includes Other then this field can be used to specify the name of the payment method. Optional. Only applicable to auctions that have the Other payment method.
|
| IsOrNearOffer |
Boolean (optional) |
Specifies if ‘ONO’ should be displayed with price on listing. Optional. Applicable only to classified listings.
|
| IsPriceOnApplication |
Boolean (optional) |
Specifies that the price should be displayed as "Price on Application". Optional. Applicable only to businesses for sale listings (subcategories of category 36).
|
| IsBold |
Boolean (optional) |
Applies the bold promotion onto the listing. Only permitted in categories that support bold. Whether or not it’s available in a category can be confirmed using the Fees API endpoint. Note that a discount may be applicable if all the feature combo promotions are specified (feature, bold, highlight and gallery). Also note that promotions cannot be removed from a listing.
|
| IsFeatured |
Boolean (optional) |
Applies the feature promotion onto the listing. Only permitted in categories that support this promotion. Whether or not it’s available in a category can be confirmed using the Fees API endpoint. Note that a discount may be applicable if all the feature combo promotions are specified (feature, bold, highlight and gallery). Also note that promotions cannot be removed from a listing.
|
| IsHomepageFeatured |
Boolean (optional) |
*deprecated*
|
| HasGallery |
Boolean (optional) |
Applies the gallery promotion onto the listing. Only permitted in categories that support this promotion. Whether or not it’s available in a category can be confirmed using the Fees API endpoint. Note that a discount may be applicable if all the feature combo promotions are specified (feature, bold, highlight and gallery). Also note that promotions cannot be removed from a listing.
|
| HasGalleryPlus |
Boolean (optional) |
Applies the gallery plus promotion onto the listing. Only permitted in categories that support this promotion. Whether or not it’s available in a category can be confirmed using the Fees API endpoint. This promotion cannot be applied to a listing that already has the gallery promotion. Note that promotions cannot be removed from a listing.
|
| Quantity |
Integer (optional) |
For Buy Now Only auctions this is the quantity of items that are available for sale. Optional. Can be between 1 and 1000. Setting the quantity (even to 1) will prevent bidding and make a listing only purchasable via Buy Now. Note that when editing, the value must be less than or equal to 1000 - (quantity sold). The quantity sold for a listing can be calculated by adding up all the QuantitySold values from the listing details response.
|
| IsFlatShippingCharge |
Boolean (optional) |
For Buy Now Only auctions this specifies if the shipping is one rate for multiple quantities. If false is specified the winning bidder will be charged the shipping rate multiplied by the quantity of items purchased. If true is specified one flat shipping rate is charged. Only applicable for auctions, ignored for classifieds.
|
| HasAgreedWithLegalNotice |
Boolean (optional) |
Specifies if the user has read and agreed with the legal notice relevant to the category the listing is being created in. The category details API can be used to retrieve the legal notice for a specific category (only applies to certain categories, such as the category 6327 - Carbon Credits).
|
| AutoRelistLimit |
Integer (optional) |
This field is deprecated and should not be used.
|
| HomePhoneNumber |
String (optional) |
Home phone number to be displayed on listing. Optional. Only applicable in categories where the user has paid a listing fee. Must be 9 digits long and use a valid area code. Can be specified but will only be displayed when category permits.
|
| MobilePhoneNumber |
String (optional) |
Mobile phone number to be displayed on listing. Optional. Only applicable in categories where the user has paid a listing fee. Must be 8 or 9 digits long. Can be specified but will only be displayed when category permits.
|
| IsHighlighted |
Boolean (optional) |
Applies the “highlight” promotion onto the listing. Only permitted in categories that support this promotion. Whether or not it’s available in a category can be confirmed using the Fees API endpoint. Note that a discount may be applicable if all the feature combo promotions are specified (feature, bold, highlight and gallery). Also note that promotions cannot be removed from a listing.
|
| HasSuperFeature |
Boolean (optional) |
Applies the “super feature” promotion onto the listing. Only permitted in categories that support this promotion. Whether or not it’s available in a category can be confirmed using the Fees API endpoint. Note that when creating a new listing with the super feature promotion, the feature, bold, highlight and gallery promotions will automatically be applied. Also note that promotions cannot be removed from a listing.
|
| PhotoIds |
Collection of Integer (optional) |
Photo IDs for images that have already been uploaded that you want to display on the listing. For all general items categories all photos are free (up to 20 max). Check the category details API for exact details. Note that photos may be deleted if they are unused for too long. It is up to you to ensure that your photo IDs are valid. See our photo retention policy for more information.
|
| ShippingOptions |
Collection of <ShippingOption> (optional) |
The shipping options to be displayed on the listing. Can contain up to ten shipping options. Mandatory for auctions, ignored for classifieds.
|
| Type |
Enumeration (optional) |
The type of delivery.
|
|
| None |
0 |
The type of the "None of the options apply to me" shipping option. Do not use when listing an item.
|
| Unknown |
0 |
Obsolete. Do not use.
|
| Undecided |
1 |
Indicates that the seller will confirm the shipping details with the buyer directly. This shipping option cannot be used when Pay Now is specified as a payment option. When listing an item, this option cannot be used in combination with other shipping options.
|
| Pickup |
2 |
Indicates the item can be picked up. Do not use when listing an item (use the Pickup field instead).
|
| Free |
3 |
Indicates the item can be shipped for free within New Zealand. When listing an item, this option cannot be used in combination with other shipping options.
|
| Custom |
4 |
Custom shipping option. Allows the seller to specify the price and description. Multiple custom shipping options are allowed (up to ten).
|
| TradeMe |
5 |
Trademe shipping option. Allows the seller to calculate the quotes from couriers, all calculated quotes will be saved in custom shipping options.
|
|
| Price |
Number (optional) |
The price of the delivery option. Only applicable if ShippingType is Custom. Rounded up to the nearest 2 decimal places.
|
| Method |
String (optional) |
The name of the delivery method (e.g. "NZ Courier", "Rural Delivery"). Only applicable if ShippingType is Custom.
|
| ShippingId |
Integer (optional) |
The ID of the shipping option (used when bidding or for Buy Now). Not required when listing an item.
|
| TaxesIncluded |
Collection of <TaxRateOnPrice> (optional) |
Indicates if taxes (and what type) are included in the Shipping Price
|
| Type |
Enumeration (optional) |
The type of tax that is included
|
|
| NZ_GST_Overseas_Supplies |
1 |
New Zealand GST on overseas supplies
|
|
| Country |
String (optional) |
The country that is levying the tax e.g. NZ
|
| Name |
String (optional) |
The name of the tax e.g. GST
|
| FlatRate |
Number (optional) |
The rate at which the tax is charged (as a decimal e.g 0.15)
|
| Description |
String (optional) |
A string that can be used as a caption where necessary
|
| IsSellRestrictionsEffective |
Boolean (optional) |
Whether certain features like auction, unspecified shipping, pickups, non hosted payment methods should be restricted
|
| IsTaxEffective |
Boolean (optional) |
Whether the effective date for the tax has been reached e.g. 1st Dec for NZ GST
|
| IsApplied |
Boolean (optional) |
Whether the price has had the tax applied (i.e. are inclusive prices)
|
| TaxAmount |
Number (optional) |
The amount of tax that was added to the price if applied
|
| WasPriceTaxAmount |
Number (optional) |
The amount of tax that was added to the was/now price if applied
|
|
|
| PaymentMethods |
Collection of Enumeration (optional) |
The acceptable payment methods to be displayed on the listing. Mandatory for auctions, ignored for classifieds.
- Payments up to $25,000 can be processed via Ping - For transactions exceeding $25,000, Ping is not a valid payment option. These must be processed via Cash (direct arrangement between buyer and seller).
For InTrade sellers, the following payment method rules apply: Required: Ping must be enabled. Optional: Cash and Afterpay may be enabled in addition to Ping.
|
|
| 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.
|
|
| Attributes |
Collection of <Attribute> (optional) |
The attribute values for a listing. The attributes for a category can be found using the category details API. Additionally, some API clients may supply any number of dynamic attributes i.e. name-value pairs as defined by the client Some well-known attribute names will also help users find your listings: Google Shopping Feed We include attributes that are named and correctly formatted in a feed that goes to Google Shopping. These are on the ProductSpecification section so include this data if you have it.
|
| Name |
String (required) |
A name which uniquely identifies the attribute. Required when selling or editing.
|
| DisplayName |
String (optional) |
The name of the attribute, in a form suitable for displaying to users. Not required when selling or editing.
|
| Value |
String (required) |
The string value of the attribute. When listing, the valid values for the attribute can be determined using the "Retrieve attributes for a category" API. Use "false" or "true" for boolean attributes. Required when selling or editing.
|
| Type |
Enumeration (optional) |
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> (optional) |
The allowed range of the attribute. Only applies to numeric attributes. Not required when selling or editing.
|
| Lower |
String (required) |
The lowest allowed value of the attribute.
|
| Upper |
String (required) |
The highest allowed value of the attribute.
|
|
| MaxStringLength |
Integer (optional) |
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> (optional) |
A list of options, if the attribute is restricted to a fixed set of values. Not required when selling or editing.
|
| Value |
String (required) |
The value of the item as a string.
|
| Display |
String (optional) |
What should be displayed for this value (often the same).
|
| Count |
Integer (optional) |
How many child elements are available.
|
|
| Units |
Collection of <AttributeUnit> (optional) |
A list of units that apply (MHz, hectares, etc). Only applies to numeric attributes. Not required when selling or editing.
|
| Display |
String (optional) |
The unit name, in a format suitable for displaying to a user (e.g. "MHz").
|
| Multiplier |
Number (optional) |
The multiplier to apply to the value the user entered to get a value suitable for passing to the sell API.
|
|
| Unit |
String (optional) |
The selected unit. Only applicable to attributes that have at least one associated unit. This field is optional, but if supplied, will be saved along with the value. The list of valid units can be retrieved from the category details API.
|
| IsRequiredForSell |
Boolean (optional) |
Indicates whether the attribute must be present when selling an item.
|
| GroupName |
String (optional) |
Suggests the category name for the attribute grouping on the UI level.
|
| DisplayValue |
String (optional) |
The value of the attribute as it needs to be displayed to the end users
|
|
| IsClearance |
Boolean (optional) |
Indicates that the listing is a clearance item. Only applicable on auctions for members who have a Trade Me store. Ignored for classifieds.
|
| ExternalReferenceId |
String (optional) |
Allows the API client to associate an identifier (or any short string) against the listing. This value can be searched on but is otherwise only accessible via the API. Not used by Trade Me. Optional. Max 50 characters.
|
| Contacts |
Collection of <Contact> (optional) |
A list of contact details. Optional. Currently only applicable for property categories and property agents that have billing methods covering the type of category. For example to add contact details in the residential for rent category the agent must have residential for rent billing enabled.
|
| FullName |
String (required) |
The full name of the contact person or agent. Mandatory.
|
| PhoneNumber |
String (optional) |
The phone number of the contact. Can be either a mobile or landline number. Optional.
|
| AlternatePhoneNumber |
String (optional) |
The phone number of the contact. Can be either a mobile or landline number. This is the primary contact number on the Trade Me Apps. Optional.
|
| EMail |
String (optional) |
The email address of the contact to be used for email enquiries. Optional.
|
| BrandingImageId |
Integer (optional) |
The ID of the branding image to display an agent photo on this listing. See the upload branding image API. Optional.
|
| AgentId |
String (optional) |
The REAA number of the agent, used to connect this listing to an agent
|
| AgencyName |
String (optional) |
The agency name for the contact
|
| ShouldContact |
Enumeration (optional) |
This shows whether the agent detail comes from I am an agent or contact my agent section
|
|
| None |
0 |
None
|
| Me |
1 |
Me
|
| MyAgent |
2 |
MyAgent
|
|
|
| ReturnListingDetails |
Boolean (optional) |
Indicates whether full listing details should be returned in the Listing field. Not supported by the fee APIs.
|
| DonationRecipient |
Enumeration (optional) |
Indicates the user would like to round up their success fees to the nearest dollar and donate the difference to the selected 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
|
|
| CatalogueId |
String (optional) |
Used for listing catalogue items and is the catalogue ID of the DVD or Blu-ray that is being listed. There is a separate API for finding the catalogue ID using the name of the movie. Catalogue items (category 9232 or category 365) can change their catalogue id but cannot be changed from a catalogue listing to a non-catalogue listing.
|
| RemainingGalleryPlusRelists |
Integer (optional) |
The number of times the item can be relisted and get the gallery promotion for free. Ignored when creating or editing a listing.
|
| PromotionId |
Integer (optional) |
Indicates the promotion to apply to this listing. This ID can be retrieved using the category details API. When editing, promotions can only be upgraded, they cannot be downgraded.
|
| ExcludeFromShippingPromotion |
Boolean (optional) |
Exclude this listing from participating in the sellers shipping promotions.
|
| SKU |
String (optional) |
SKU or Stock Keeping Unit. Used to uniquely identify an auction's product line. Maximum of 50 characters.
|
| AvailablePromotions |
Collection of <Promotion> (optional) |
The list of available promotional options for this listing. Only one promotional option can be selected. These are only available in categories where Super Grid has been enabled.
|
| Id |
Integer (optional) |
The unique identifier of the promotion.
|
| Name |
String (optional) |
The name of the promotion.
|
| Description |
String (optional) |
A short description of the promotion.
|
| LongDescription |
String (optional) |
A long description of the promotion.
|
| Price |
Number (optional) |
The current price of the promotion. This price should include any discounts currently applied.
|
| OriginalPrice |
Number (optional) |
The price of the promotion before any discounts have been applied.
|
| Recommended |
Boolean (optional) |
Whether this promotion is currently being recommended.
|
| MinimumPhotoCount |
Integer (optional) |
The minimum number of photos required for the promotion.
|
| DiscountDescription |
String (optional) |
A short description of any discount applied to this promotion.
|
| DiscountStartDate |
String (optional) |
The start date of any discount applied to this promotion.
|
| DiscountEndDate |
String (optional) |
The end date of any discount applied to this promotion.
|
| DiscountDisclaimer |
String (optional) |
The legal disclaimer of any discount applied to this promotion.
|
| GoodFor2RelistsFee |
Number (optional) |
The value of the GoodFor2Relists fee if eligible for this promotion.
|
|
| ImmutableFields |
Collection of String (optional) |
A collection of the names of various fields and attributes which cannot be changed under various conditions e.g. a bid has been placed on an Auction, or 7 days has passed after a classified was created.
|
| GeographicLocation |
<SimpleGeographicLocation> (optional) |
A custom geographic location
|
| Latitude |
Number (optional) |
The latitude of the location, in degrees (WGS84).
|
| Longitude |
Number (optional) |
The longitude of the location, in degrees (WGS84).
|
| Accuracy |
Enumeration (optional) |
The accuracy of the geographic location (address, street or suburb).
|
|
| None |
0 |
The accuracy of the geographic location is not known.
|
| Address |
1 |
The geographic location is accurate to the address level.
|
| Street |
3 |
The geographic location is accurate to the street level.
|
| Suburb |
2 |
The geographic location is accurate to the suburb level.
|
| AdminPinpoint |
4 |
The geographic location is accurate to the AdminPinPoint level.
|
|
|
| WasPrice |
Number (optional) |
The usual price that a product is sold at, or the price before it was marked down. This is always more than the Buy Now price for Auctions, or more than the asking price for Classifieds.
|
| EmbeddedContent |
<EmbeddedContent> (optional) |
The content keys that are embedded in the listing page (e.g. YouTube Video Key).Use the category details API to check which content types a category supports.
|
| YouTubeVideoKey |
String (optional) |
The YouTube video key for the listing.
|
| MatterportKey |
String (optional) |
The Matterport video key for the listing's InsideView content.
|
| IStagingKey |
String (optional) |
The IStaging video key for the listing's InsideView content.
|
| VimeoVideoKey |
String (optional) |
The Vimeo video key for the listing.
|
| DiakritFurnishKey |
String (optional) |
The Diakrit Furnish key for the listing.
|
| DiakritStylerKey |
String (optional) |
The Diakrit Styler key for the listing.
|
| DiakritPanoramaKey |
String (optional) |
The Diakrit Panorama key for the listing.
|
| VirtualToursCreatorKey |
String (optional) |
The Virtual Tours Creator key for the listing.
|
| Approved3DTourUrl |
String (optional) |
The Approved 3d tour url for the listing.
|
|
| IsBranded |
Boolean (optional) |
A flag indicating the listing should be branded. Only applicable to the Jobs category.
|
| ShortDescription |
String (optional) |
Summary of the listing. Mandatory for Job listings Maximum of 150 characters.
|
| ShippingCalculatorInputs |
<TmShippingCalculatorInputs> (optional) |
The criteria used within the Trade Me Shipping calculator to determine rates.
|
| IsBoxType |
Boolean (optional) |
Indicator if package type is bag or box
|
| Width |
Number (optional) |
Width value for box package type
|
| Height |
Number (optional) |
Height value for box package type
|
| Depth |
Number (optional) |
Depth value for box package type
|
| IsSignatureRequired |
Boolean (optional) |
Inidicator if shipping requires signature
|
| PickupLocalityId |
Integer (optional) |
Pickup location id
|
| IsRural |
Boolean (optional) |
Indicator on if pickup location is rural area
|
| PackagingOption |
Enumeration (optional) |
Packaging type indicating bag sizes or box
|
|
| Box |
1 |
Box
|
| DLE |
2 |
Satchel:DLE
|
| A4 |
3 |
Satchel:A4
|
| A3 |
4 |
Satchel:A3
|
| A5 |
5 |
Satchel:A5
|
|
| WeightOption |
Enumeration (optional) |
Weight range option for calculation
|
|
| Kg0To3 |
1 |
0 - 3kg
|
| Kg3To5 |
2 |
3 - 5kg
|
| Kg5To10 |
3 |
5 - 10kg
|
| Kg10To15 |
4 |
10 - 15kg
|
| Kg15To20 |
5 |
15 - 20kg
|
| Kg20To25 |
6 |
20 - 25kg
|
|
| FilterOption |
Enumeration (optional) |
Courier filter for calculation
|
|
| BestPrice |
0 |
Best price
|
| NZPost |
1 |
NZ Post
|
| Fastway |
2 |
Aramex
|
|
|
| AdditionalData |
<AdditionalData> (optional) |
Structured information for Listing Additional Data. Currently only used by featured Job listings.
|
| BulletPoints |
Collection of String (optional) |
The bullet points for display in the search results
|
| Tags |
Collection of <Tag> (optional) |
The tags for display in the search results
|
| Name |
String (optional) |
The name of the tag
|
|
|
| VariantDefinition |
<VariantDefinition> (optional) |
When specified, turns the listing request into a multi-variant listing that creates several child listings. The variants definition is used to describe the variant options that are available and the combinations of variants that make up the multi-variant listing.
|
| OptionSets |
Collection of <OptionSet> (required) |
A collection of variant options.
|
| Name |
String (required) |
The name used to identify the group of option values, e.g. "size" or "colour".
|
| Values |
Collection of String (required) |
The choices available for this option set, e.g. "red", "blue". The sequence in which values are supplied is reflected in the sequence of user-interface elements on listings.
|
|
| Variants |
Collection of <Variant> (required) |
A collection of variants.
|
| SKU |
String (required) |
SKU or Stock Keeping Unit. Used to uniquely identify an auction's product line. Maximum of 50 characters.
|
| Price |
Number (required) |
The Buy Now price of the variant. Must be a minimum of 50c.
|
| IsClearance |
Boolean (optional) |
This indicates that the listing is a clearance item. Clearance listings include listings with was/now pricing and general clearance stock.
|
| WasPrice |
Number (optional) |
The Was price of the variant. Must be a minimum of 50c.
|
| Quantity |
Integer (required) |
This is the quantity of items that are available for sale. Can be between 1 and 1000. Note that when editing, the value must be less than or equal to 1000 - (quantity sold). The quantity sold for a listing can be calculated by adding up all the QuantitySold values from the listing details response.
|
| PhotoIds |
Collection of Integer (optional) |
Photo IDs for images that have already been uploaded that you want to display on the listing variant. For all general items categories all photos are free (up to 20 max). Check the category details API for exact details. Note that photos may be deleted if they are unused for too long. It is up to you to ensure that your photo IDs are valid. See our photo retention policy for more information.
|
| Photos |
Collection of <Photo> (optional) |
A collection of photo URLs for the listing. Ignored when creating or editing a listing.
|
| Key |
Integer (optional) |
|
| Value |
<PhotoUrl> (optional) |
|
| Thumbnail |
String (optional) |
The URL for the thumbnail sized photo (always 85x64, with white borders).
|
| List |
String (optional) |
The URL for the list view sized photo (scaled down to fit 160x120).
|
| Medium |
String (optional) |
The URL for the medium sized photo (scaled down to fit 175x175).
|
| Gallery |
String (optional) |
The URL for the gallery sized photo (scaled down to fit 233x176).
|
| Large |
String (optional) |
The URL for the large sized photo (scaled down to fit 352x264).
|
| FullSize |
String (optional) |
The URL for the full sized photo (scaled down to fit 670x502).
|
| PlusSize |
String (optional) |
The URL for the plus sized photo (scaled down to fit).
|
| PhotoId |
Integer (optional) |
The ID of the photo.
|
| OriginalWidth |
Integer (optional) |
The original width of the photo.
|
| OriginalHeight |
Integer (optional) |
The original height of the photo.
|
|
|
| Options |
Collection of <Option> (optional) |
The combination of variant options that this variant represents.
|
| Name |
String (required) |
The name used to identify the group of option values, e.g. "size" or "colour". This name must match an entry in the option set collection.
|
| Value |
String (required) |
The choice that this variant has for the option, e.g. "red", "blue". This name must match an entry in the option set.
|
|
| Attributes |
Collection of <Attribute> (optional) |
A collection of dynamic attributes that relate to this variant specifically. These can be any number of name-value pairs. Some well-known attribute names will also help users find your listings: Google Shopping Feed We include attributes that are named and correctly formatted in a feed that goes to Google Shopping. These are Brand, GTIN and Manufacturer Code so include this data if you have it.
|
|
(This type has already been defined)
|
| ListingId |
Integer (optional) |
The identifier of the listing that this variant represents.
|
| ExternalReferenceId |
String (optional) |
Allows the API client to associate an identifier (or any short string) against the listing. This value can be searched on but is otherwise only accessible via the API. Not used by Trade Me. Optional. Max 50 characters.
|
| ProductSpecification |
<ProductSpecification> (optional) |
The specifications of the product if the variant relates to a product
|
| GTIN |
String (optional) |
The GTIN of the product e.g. 027242896505
|
| Brand |
String (optional) |
The brand name of the product e.g. Sony
|
| ManufacturerCode |
String (optional) |
The product code used by the manufacturer e.g. KDL32W600D
|
|
|
|
| SecondCategory |
String (optional) |
The ID of the second category to list the item in. For example, specify "6853" to list an oil heater. This field also accepts the MCAT category format (e.g. "0004-0370-0560-6853-"). Not all categories can be used as a second category and not all primary categories can be paired with a second category.
|
| PremiumPackageCode |
String (optional) |
The code of the premium package to apply to the listing. This will be null if a package is not applied to the listing or a package was previously applied but has since completed.
|
| ProductSpecification |
<ProductSpecification> (optional) |
The specifications of the product if the listing relates to a product. If this is a multi-variant product, specify these in the Variants section.
|
|
(This type has already been defined)
|
| ListingExtras |
Collection of <ListingExtras> (optional) |
A collection of extras to apply to the listing. This is an input field. We require Name, & Variant for each ListingExtra.
|
| Id |
Integer (optional) |
The ID of the extra; informational only. This is assigned when an extra is applied to a listing.
|
| Name |
String (required) |
The name of the extra.
|
| Variant |
String (optional) |
The variation of the extra. For example this could determine the duration, delay, or configuration of the listing extra.
|
| StartDate |
DateTime (optional) |
The start date and time of the extra. If not provided then the extra will be queued up to start after the last stacked extra of the same type. If no extra of this type currently exists then the extra will start immediately.
|
| EndDate |
DateTime (optional) |
The end date and time of the extra.
|
| Description |
String (optional) |
The description of the extra; informational only.
|
| Duration |
Integer (optional) |
The number of days the extra will be active; informational only.
|
| Delay |
Integer (optional) |
The number of days before the extra will become active after purchase; informational only.
|
| DaysRemaining |
Integer (optional) |
The number of days before it expires.
|
|
| ListingExtrasLedger |
Collection of <ListingExtras> (optional) |
A collection of extras that have been applied to the listing. This is an output field. We will provide Id, Name, Variant, StartDate, & EndDate. Any changes to this collection is ignored when creating or editing a listing.
|
|
(This type has already been defined)
|
| HasGoodFor2Relists |
Boolean (optional) |
Indicates if Good For 2 Relists is included with the premium package.
|
| IsCounterOffersAllowed |
Boolean (optional) |
Indicates if Make an Offer is enabled or not. true is enabled, false is disabled and null means it hasn't set yet.
|
| MaximumOffers |
Integer (optional) |
The maximum number of Buyer offers the listing accepts if the listing has Counter Offers enabled.
|
| ShippingTemplateId |
Integer (optional) |
The identifier of the shipping template containing the shipping options. For the shipping template to be successfully applied to the listing, there are some requirements to be met with the api request:
The listing must be a Buy Now Only listing:
Must have: - A quantity > 0 - A buy now price - Shipping field = 0 (or the field not supplied)
Must not have: - A reserve price - A starting price - Any custom shipping options supplied - Pickup only
The primary and/or secondary category supplied must be Marketplace categories.
When the above requirements are not met when specifying a ShippingTemplateId, then the listing request will fail.
Identifying marketplace categories
You can identify these categories by using the following endpoint: Category Details When AreaOfBusiness = 1 (marketplace category)
|
| Photos |
Collection of <Photo> (optional) |
A collection of photo URLs for the listing. Ignored when creating or editing a listing.
|
| Key |
Integer (optional) |
|
| Value |
<PhotoUrl> (optional) |
|
|
(This type has already been defined)
|
|
| Files |
Collection of <ListingFile> (optional) |
A list of files on the listing
|
| Url |
String (optional) |
Url of the file
|
| Name |
String (optional) |
Name of the file
|
|
A list of fees.
{
"Category": "ABC",
"Title": "ABC",
"Subtitle": "ABC",
"Description": [
"ABC",
"ABC"
],
"StartPrice": 123.0,
"ReservePrice": 123.0,
"BuyNowPrice": 123.0,
"Duration": 0,
"EndDateTime": "\/Date(1514764800)\/",
"Pickup": 0,
"PickupSuburbId": 123,
"IsBrandNew": false,
"AuthenticatedMembersOnly": false,
"IsClassified": false,
"OpenHomes": [
{
"Start": "\/Date(1514764800)\/",
"End": "\/Date(1514764800)\/"
},
{
"Start": "\/Date(1514764800)\/",
"End": "\/Date(1514764800)\/"
}
],
"SendPaymentInstructions": false,
"OtherPaymentMethod": "ABC",
"IsOrNearOffer": false,
"IsPriceOnApplication": false,
"IsBold": false,
"IsFeatured": false,
"IsHomepageFeatured": false,
"HasGallery": false,
"HasGalleryPlus": false,
"Quantity": 123,
"IsFlatShippingCharge": false,
"HasAgreedWithLegalNotice": false,
"AutoRelistLimit": 123,
"HomePhoneNumber": "ABC",
"MobilePhoneNumber": "ABC",
"IsHighlighted": false,
"HasSuperFeature": false,
"PhotoIds": [
123,
123
],
"ShippingOptions": [
{
"Type": 0,
"Price": 123.0,
"Method": "ABC",
"ShippingId": 123,
"TaxesIncluded": [
{
"Type": 1,
"Country": "ABC",
"Name": "ABC",
"FlatRate": 123.0,
"Description": "ABC",
"IsSellRestrictionsEffective": false,
"IsTaxEffective": false,
"IsApplied": false,
"TaxAmount": 123.0,
"WasPriceTaxAmount": 123.0
},
{
"Type": 1,
"Country": "ABC",
"Name": "ABC",
"FlatRate": 123.0,
"Description": "ABC",
"IsSellRestrictionsEffective": false,
"IsTaxEffective": false,
"IsApplied": false,
"TaxAmount": 123.0,
"WasPriceTaxAmount": 123.0
}
]
},
{
"Type": 0,
"Price": 123.0,
"Method": "ABC",
"ShippingId": 123,
"TaxesIncluded": [
{
"Type": 1,
"Country": "ABC",
"Name": "ABC",
"FlatRate": 123.0,
"Description": "ABC",
"IsSellRestrictionsEffective": false,
"IsTaxEffective": false,
"IsApplied": false,
"TaxAmount": 123.0,
"WasPriceTaxAmount": 123.0
},
{
"Type": 1,
"Country": "ABC",
"Name": "ABC",
"FlatRate": 123.0,
"Description": "ABC",
"IsSellRestrictionsEffective": false,
"IsTaxEffective": false,
"IsApplied": false,
"TaxAmount": 123.0,
"WasPriceTaxAmount": 123.0
}
]
}
],
"PaymentMethods": [
0,
0
],
"Attributes": [
{
"Name": "ABC",
"DisplayName": "ABC",
"Value": "ABC",
"Type": 0,
"Range": {
"Lower": "ABC",
"Upper": "ABC"
},
"MaxStringLength": 123,
"Options": [
{
"Value": "ABC",
"Display": "ABC",
"Count": 123
},
{
"Value": "ABC",
"Display": "ABC",
"Count": 123
}
],
"Units": [
{
"Display": "ABC",
"Multiplier": 123.0
},
{
"Display": "ABC",
"Multiplier": 123.0
}
],
"Unit": "ABC",
"IsRequiredForSell": false,
"GroupName": "ABC",
"DisplayValue": "ABC"
},
{
"Name": "ABC",
"DisplayName": "ABC",
"Value": "ABC",
"Type": 0,
"Range": {
"Lower": "ABC",
"Upper": "ABC"
},
"MaxStringLength": 123,
"Options": [
{
"Value": "ABC",
"Display": "ABC",
"Count": 123
},
{
"Value": "ABC",
"Display": "ABC",
"Count": 123
}
],
"Units": [
{
"Display": "ABC",
"Multiplier": 123.0
},
{
"Display": "ABC",
"Multiplier": 123.0
}
],
"Unit": "ABC",
"IsRequiredForSell": false,
"GroupName": "ABC",
"DisplayValue": "ABC"
}
],
"IsClearance": false,
"ExternalReferenceId": "ABC",
"Contacts": [
{
"FullName": "ABC",
"PhoneNumber": "ABC",
"AlternatePhoneNumber": "ABC",
"EMail": "ABC",
"BrandingImageId": 123,
"AgentId": "ABC",
"AgencyName": "ABC",
"ShouldContact": 0
},
{
"FullName": "ABC",
"PhoneNumber": "ABC",
"AlternatePhoneNumber": "ABC",
"EMail": "ABC",
"BrandingImageId": 123,
"AgentId": "ABC",
"AgencyName": "ABC",
"ShouldContact": 0
}
],
"ReturnListingDetails": false,
"DonationRecipient": 0,
"CatalogueId": "ABC",
"RemainingGalleryPlusRelists": 123,
"PromotionId": 123,
"ExcludeFromShippingPromotion": false,
"SKU": "ABC",
"AvailablePromotions": [
{
"Id": 123,
"Name": "ABC",
"Description": "ABC",
"LongDescription": "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",
"LongDescription": "ABC",
"Price": 123.0,
"OriginalPrice": 123.0,
"Recommended": false,
"MinimumPhotoCount": 123,
"DiscountDescription": "ABC",
"DiscountStartDate": "ABC",
"DiscountEndDate": "ABC",
"DiscountDisclaimer": "ABC",
"GoodFor2RelistsFee": 123.0
}
],
"ImmutableFields": [
"ABC",
"ABC"
],
"GeographicLocation": {
"Latitude": 123.0,
"Longitude": 123.0,
"Accuracy": 0
},
"WasPrice": 123.0,
"EmbeddedContent": {
"YouTubeVideoKey": "ABC",
"MatterportKey": "ABC",
"IStagingKey": "ABC",
"VimeoVideoKey": "ABC",
"DiakritFurnishKey": "ABC",
"DiakritStylerKey": "ABC",
"DiakritPanoramaKey": "ABC",
"VirtualToursCreatorKey": "ABC",
"Approved3DTourUrl": "ABC"
},
"IsBranded": false,
"ShortDescription": "ABC",
"ShippingCalculatorInputs": {
"IsBoxType": false,
"Width": 123.0,
"Height": 123.0,
"Depth": 123.0,
"IsSignatureRequired": false,
"PickupLocalityId": 123,
"IsRural": false,
"PackagingOption": 1,
"WeightOption": 1,
"FilterOption": 0
},
"AdditionalData": {
"BulletPoints": [
"ABC",
"ABC"
],
"Tags": [
{
"Name": "ABC"
},
{
"Name": "ABC"
}
]
},
"VariantDefinition": {
"OptionSets": [
{
"Name": "ABC",
"Values": [
"ABC",
"ABC"
]
},
{
"Name": "ABC",
"Values": [
"ABC",
"ABC"
]
}
],
"Variants": [
{
"SKU": "ABC",
"Price": 123.0,
"IsClearance": false,
"WasPrice": 123.0,
"Quantity": 123,
"PhotoIds": [
123,
123
],
"Photos": [
{
"Key": 123,
"Value": {
"Thumbnail": "ABC",
"List": "ABC",
"Medium": "ABC",
"Gallery": "ABC",
"Large": "ABC",
"FullSize": "ABC",
"PlusSize": "ABC",
"PhotoId": 123,
"OriginalWidth": 123,
"OriginalHeight": 123
}
},
{
"Key": 123,
"Value": {
"Thumbnail": "ABC",
"List": "ABC",
"Medium": "ABC",
"Gallery": "ABC",
"Large": "ABC",
"FullSize": "ABC",
"PlusSize": "ABC",
"PhotoId": 123,
"OriginalWidth": 123,
"OriginalHeight": 123
}
}
],
"Options": [
{
"Name": "ABC",
"Value": "ABC"
},
{
"Name": "ABC",
"Value": "ABC"
}
],
"Attributes": [
{
},
{
}
],
"ListingId": 123,
"ExternalReferenceId": "ABC",
"ProductSpecification": {
"GTIN": "ABC",
"Brand": "ABC",
"ManufacturerCode": "ABC"
}
},
{
"SKU": "ABC",
"Price": 123.0,
"IsClearance": false,
"WasPrice": 123.0,
"Quantity": 123,
"PhotoIds": [
123,
123
],
"Photos": [
{
"Key": 123,
"Value": {
"Thumbnail": "ABC",
"List": "ABC",
"Medium": "ABC",
"Gallery": "ABC",
"Large": "ABC",
"FullSize": "ABC",
"PlusSize": "ABC",
"PhotoId": 123,
"OriginalWidth": 123,
"OriginalHeight": 123
}
},
{
"Key": 123,
"Value": {
"Thumbnail": "ABC",
"List": "ABC",
"Medium": "ABC",
"Gallery": "ABC",
"Large": "ABC",
"FullSize": "ABC",
"PlusSize": "ABC",
"PhotoId": 123,
"OriginalWidth": 123,
"OriginalHeight": 123
}
}
],
"Options": [
{
"Name": "ABC",
"Value": "ABC"
},
{
"Name": "ABC",
"Value": "ABC"
}
],
"Attributes": [
{
},
{
}
],
"ListingId": 123,
"ExternalReferenceId": "ABC",
"ProductSpecification": {
"GTIN": "ABC",
"Brand": "ABC",
"ManufacturerCode": "ABC"
}
}
]
},
"SecondCategory": "ABC",
"PremiumPackageCode": "ABC",
"ProductSpecification": {
},
"ListingExtras": [
{
"Id": 123,
"Name": "ABC",
"Variant": "ABC",
"StartDate": "\/Date(1514764800)\/",
"EndDate": "\/Date(1514764800)\/",
"Description": "ABC",
"Duration": 123,
"Delay": 123,
"DaysRemaining": 123
},
{
"Id": 123,
"Name": "ABC",
"Variant": "ABC",
"StartDate": "\/Date(1514764800)\/",
"EndDate": "\/Date(1514764800)\/",
"Description": "ABC",
"Duration": 123,
"Delay": 123,
"DaysRemaining": 123
}
],
"ListingExtrasLedger": [
{
},
{
}
],
"HasGoodFor2Relists": false,
"IsCounterOffersAllowed": false,
"MaximumOffers": 123,
"ShippingTemplateId": 123,
"Photos": [
{
"Key": 123,
"Value": {
}
},
{
"Key": 123,
"Value": {
}
}
],
"Files": [
{
"Url": "ABC",
"Name": "ABC"
},
{
"Url": "ABC",
"Name": "ABC"
}
]
}