Name | Description | Type | Additional information |
---|---|---|---|
TradeMeListingRuleID |
The unique internal identifier of each listing rule in Tradevine e.g. 3451582911247567682 |
integer |
Optional |
TradeMeOrganisationID |
The internal identifier of the Trade Me channel in Tradevine e.g. 3451460443781171981 |
integer |
Optional |
ExternalTradeMeOrganisationName |
Name of the Trade Me selling channel |
string |
Optional |
OrganisationID |
The internal identifier of this organisation in Tradevine e.g. 3451460443781171981 |
integer |
Optional |
ProductID |
The unique internal identifier of each product in Tradevine e.g. 3451582911247567682 |
integer |
Optional |
ProductCode |
The product code e.g. PR432 |
string |
Optional |
ProductWarehouseStock |
The total aggregated warehouse stock for the product of this rule |
decimal number |
Optional |
RuleName |
Listing rule name |
string |
Optional |
IsAutoListingEnabled |
Whether auto listing is enabled |
boolean |
Optional |
AutoListingPriority |
Auto listing priority |
integer |
Optional |
HasListingFailure |
Whether currently has a listing failure |
boolean |
Optional |
Title |
Listing Title |
string |
Optional |
SubTitle |
Listing subtitle |
string |
Optional |
IsSellMultipleQty |
Whether this is a multi-quantity listing |
boolean |
Optional |
SellMultipleQuantity |
The quantity to allocate |
decimal number |
Optional |
StartPrice |
Start price |
decimal number |
Optional |
ReservePrice |
Reserve Price |
decimal number |
Optional |
BuyNowPrice |
Buy Now Price |
decimal number |
Optional |
CategoryNumber |
Trade Me category ID - e.g.: 3600 |
string |
Optional |
CategoryText |
Trade Me listing category |
string |
Optional |
CategoryOptions |
Trade Me listing category attributes - e.g.: brand=Sony |
string |
Optional |
Description |
Product listing description |
string |
Optional |
IsLegalNoticeRead |
Whether legal notice was read |
boolean |
Optional |
IsClassified |
Whether this listing is a classified add |
boolean |
Optional |
IsProductDisplayedBold |
Whether to display product in bold |
boolean |
Optional |
IsProductUseSubTitles |
Whether listing includes a subtitle |
boolean |
Optional |
IsProductGallery |
Whether listing is done with Gallery |
boolean |
Optional |
IsProductGalleryPlus |
Whether listing is done with Gallery Plus |
boolean |
Optional |
IsProductFeature |
Whether listing is done with Feature |
boolean |
Optional |
IsProductSuperFeature |
Whether listing is done with Super Feature |
boolean |
Optional |
IsProductHomePageCombo |
Whether listing is done with Home Page Combo |
boolean |
Optional |
ListingDurationType |
Listing duration type |
integer |
Optional |
ListingFixedLengthDuration |
Listing duration value (if fixed length) |
integer |
Optional |
ListingDurationEndTime |
The target listing end time |
date |
Optional |
ListingDurationEndDay |
The target listing end days |
integer |
Optional |
IsListingNew |
Whether this product is new |
boolean |
Optional |
IsUseBuyNow |
Whether this listing has a Buy Now |
boolean |
Optional |
FixedPriceOfferAutoEnabled |
Whether to automatically make a Fixed Price Offer |
boolean |
Optional |
FixedPriceOfferBiddersAndWatchers |
Whether to make Fixed Price Offer to watchers as well |
boolean |
Optional |
FixedPriceOfferDuration |
Fixed Price Offer duration |
integer |
Optional |
FixedPriceOfferBaseField |
What to base the Fixed Price Offer on |
integer |
Optional |
FixedPriceOfferAbsoluteValue |
If IsFixedPriceOfferAbsolute is set to true, this is the fixed monetary value to make the FPO for |
decimal number |
Optional |
IsFixedPriceOfferAbsolute |
Whether to use a fixed value for the FPO rather than base it off another rule or product price (Cannot use it with a multi-variant listing rule) |
boolean |
Optional |
FixedPriceOfferDelta |
The fixed price mark-up from the base price |
decimal number |
Optional |
FixedPriceOfferDeltaType |
The mark-up type |
integer |
Optional |
FixedPriceOfferIgnoreIfFeedbackRatingLessThan |
Whether to avoid offering fixed price to buyers with low rating |
boolean |
Optional |
FixedPriceOfferFeedbackLessThanPercent |
Cut-off rating for making a Fixed Price Offer |
decimal number |
Optional |
IsAllowBidsAuthBiddersOnly |
Whether to allow bids from authenticated members only |
boolean |
Optional |
IsPaymentViaBankDeposit |
Whether bank deposit payment is accepted |
boolean |
Optional |
IsPaymentViaCreditCard |
Whether credit card payment is accepted |
boolean |
Optional |
IsPaymentViaCash |
Whether cash payment is accepted |
boolean |
Optional |
IsPaymentViaAfterpay |
Whether Afterpay payment is accepted |
boolean |
Optional |
IsPaymentOther |
Whether 'Other' payment is accepted |
boolean |
Optional |
PaymentOther |
Description of the 'Other' payment accepted |
string |
Optional |
PickupOptions |
Listing pickup options |
integer |
Optional |
ShippingOptions |
Listing shipping options |
integer |
Optional |
CustomShippingLines |
List of shipping costs if 'Specify shipping costs' selected. Either use JSON e.g. [{"Cost": 3.99, "Name":"South Island", "Type":25003}] or use our custom format e.g. "Cost=3.50","Name=Auckland 1-day","Type=Courier";"Cost=5.99","Name=South Island, 2-day","Type=Post" |
string |
Optional |
IsShippingPricePerQuantity |
Whether shipping price is per quantity |
boolean |
Optional |
IsOverrideFloatingPricing |
Whether to override default pricing type |
boolean |
Optional |
IsOverrideListingOptions |
Whether to override default listing options |
boolean |
Optional |
IsOverrideExtras |
Whether to override default listing Extras |
boolean |
Optional |
IsOverrideOfferOptions |
Whether to override default Fixed Price Offer options |
boolean |
Optional |
IsOverridePaymentMethods |
Whether to override default payment methods |
boolean |
Optional |
IsOverrideShippingOptions |
Whether to override default shipping options |
boolean |
Optional |
IsListingFooterEnabled |
Whether listing footer is enabled |
boolean |
Optional |
CreatedDate |
The date and time (in UTC) that the listing rule was created |
date |
Optional |
CreatedBy |
The internal Tradevine ID of the user that created the listing rule |
integer |
Optional |
ModifiedDate |
The date and time (in UTC) that the listing rule was last modified |
date |
Optional |
ModifiedBy |
The internal Tradevine ID of the user that last modified the listing rule |
integer |
Optional |
IsAutoFeedbackDisabled |
Whether to disable auto feedback |
boolean |
Optional |
IgnoreFeedback |
Whether to automatically ignore feedback |
boolean |
Optional |
ListingFailureText |
Text of last listing failure (cleared on successful listing creation) |
string |
Optional |
CountOpenListings |
Number of open listings |
integer |
Optional |
HasOpenListings |
Whether has open listings |
boolean |
Optional |
LastTradeMeListingExternalID |
The most recent Trade Me listing ID associated with this rule |
integer |
Optional |
QuantityInStock |
The current Stock on Hand (SOH) value for this product if it is inventory tracked e.g. 10 if I physically hold 10 at the moment. This is just populated on GET - to adjust inventory use the dedicated endpoint |
decimal number |
Optional |
IsClearanceItem |
Whether to mark this item as 'Clearance Item' |
boolean |
Optional |
ShippingTemplateID |
The unique internal identifier of in Tradevine of the shipping template to use |
integer |
Optional |
ShippingTemplateName |
The name of the shipping template to use |
string |
Optional |
PhotoIdentifier |
The semi-colon delimited list of photo identifiers to use on the listing rule e.g. 'PR-765a.jpg;PR765b.jpg'. These photos must already exist in the system (i.e. have been previously uploaded). |
string |
Optional |
YouTubeVideoKey |
The identifier of a YouTube video to display on listings. |
string |
Optional |
WasPrice |
The price used to compare against the Buy Price if seller is able to list clearance items. |
decimal number |
Optional |
GroupSku |
The user-supplied grouping SKU if this rule is to be a variant in a multi-variant listing group |
string |
Optional |
TradeMeListingRuleVariantGroupID |
The internal Tradevine ID of the variant group that this rule belongs to |
integer |
Optional |
OptionValue1 |
The value of the first Multi-variant field e.g. if OptionName1 was Colour, then this variant might have OptionValue1 of Red |
string |
Optional |
OptionValue2 |
The value of the second Multi-variant field (if applicable) e.g. if OptionName2 was Size, then this variant might have OptionValue2 of XL |
string |
Optional |
OptionValue3 |
The value of the third Multi-variant field (if applicable) |
string |
Optional |
OptionValue4 |
The value of the fourth Multi-variant field (if applicable) |
string |
Optional |
OptionValue5 |
The value of the fifth Multi-variant field (if applicable) |
string |
Optional |
TradeMeCourierIsBox |
If Book a Courier shipping option is used, if the package type if Box (true) or Bag (false) |
boolean |
Optional |
TradeMeCourierBagSize |
If Book a Courier shipping option is used and package type is Bag then the bag size |
integer |
Optional |
TradeMeCourierNoRestrictedItems |
If Book a Courier shipping option is used, declare that the packahe does not contain restricted items |
boolean |
Optional |
TradeMeCourierSelectedCourier |
If Book a Courier shipping option is used, whether a particular courier company should be used or just the one with the best price |
integer |
Optional |
TradeMeCourierServiceLevel |
If Book a Courier shipping option is used, whether a particular service level (Signature, Non-Signature) should be used or just the one with the best price |
integer |
Optional |
VariantGroup |
The group level settings that this rule belongs to (if applicable, otherwise null) |
TradeMeListingRuleVariantGroup |
Optional |
Photos |
The list of photos of the listing-rule |
Collection of Photo |
Optional |