GET v1/TradeMeListingRule/{id}

This method gets an individual Trade Me listing rule

Request Information

URI Parameters

Name Description Type Additional information
id

The unique identifier of the Trade Me listing rule

integer

Required

Body Parameters

None.

Response Information

Resource Description

The listing rule data from the Tradevine database

TradeMeListingRule

Name Description Type
TradeMeListingRuleID

The unique internal identifier of each listing rule in Tradevine e.g. 3451582911247567682

integer
TradeMeOrganisationID

The internal identifier of the Trade Me channel in Tradevine e.g. 3451460443781171981

integer
ExternalTradeMeOrganisationName

Name of the Trade Me selling channel

string
OrganisationID

The internal identifier of this organisation in Tradevine e.g. 3451460443781171981

integer
ProductID

The unique internal identifier of each product in Tradevine e.g. 3451582911247567682

integer
ProductCode

The product code e.g. PR432

string
RuleName

Listing rule name

string
IsAutoListingEnabled

Whether auto listing is enabled

boolean
AutoListingPriority

Auto listing prioriy

integer
HasListingFailure

Whether currently has a listing failure

boolean
Title

Listing Title

string
SubTitle

Listing subtitle

string
IsSellMultipleQty

Whether this is a multi-quantity listing

boolean
SellMultipleQuantity

The quantity to allocate

decimal number
StartPrice

Start price

decimal number
ReservePrice

Reserve Price

decimal number
BuyNowPrice

Buy Now Price

decimal number
IsPricingFloating

Whether price is fixed or based on cost/sell price

boolean
FloatingPriceBaseField

Whether the floating price is calculated from Cost or Sell price

integer
StartPriceBasePlusPercent

Start price percentage mark-up

decimal number
ReservePriceBasePlusPercent

Reserve price percentage mark-up

decimal number
BuyNowPriceBasePlusPercent

Buy Now price percentage mark-up

decimal number
CategoryNumber

Trade Me category ID - e.g.: 3600

string
CategoryText

Trade Me listing category

string
CategoryOptions

Trade Me listing category attributes - e.g.: colour=black

string
Description

Product listing description

string
IsLegalNoticeRead

Whether legal notice was read

boolean
IsClassified

Whether this listing is a classified add

boolean
IsProductDisplayedBold

Whether to display product in bold

boolean
IsProductUseSubTitles

Whether listing includes a subtitle

boolean
IsProductGallery

Whether listing is done with Gallery

boolean
IsProductGalleryPlus

Whether listing is done with Gallery Plus

boolean
IsProductFeature

Whether listing is done with Feature

boolean
IsProductHomePageCombo

Whether listing is done with Home Page Combo

boolean
ListingDurationType

Listing duration type

integer
ListingFixedLengthDuration

Listing duration value (if fixed length)

integer
ListingDurationEndTime

The target listing end time

date
ListingDurationEndDay

The target listing end day

integer
IsListingNew

Whether this product is new

boolean
IsUseBuyNow

Whether this listing has a Buy Now

boolean
FixedPriceOfferAutoEnabled

Whether to automatically make a Fixed Price Offer

boolean
FixedPriceOfferBiddersAndWatchers

Whether to make Fixed Price Offer to watchers as well

boolean
FixedPriceOfferDuration

Fixed Price Offer duration

integer
FixedPriceOfferBaseField

What field to base the Fixed Price Offer on

integer
FixedPriceOfferAbsoluteValue

decimal number
IsFixedPriceOfferAbsolute

boolean
FixedPriceOfferDelta

The fixed price mark-up from the base price

decimal number
FixedPriceOfferDeltaType

The mark-up type

integer
FixedPriceOfferIgnoreIfFeedbackRatingLessThan

Whether to avoid offering fixed price to buyers with low rating

boolean
FixedPriceOfferFeedbackLessThanPercent

Cut-off rating for making a Fixed Price Offer

decimal number
IsAllowBidsAuthBiddersOnly

Whether to allow bids from authenticated members only

boolean
IsPaymentViaBankDeposit

Whether bank deposit payment is accepted

boolean
IsPaymentViaCreditCard

Whether credit card payment is accepted

boolean
IsPaymentViaCash

Whether cash payment is accepted

boolean
IsPaymentViaSafeTrader

Whether SafeTrader payment is accepted

boolean
IsPaymentOther

Whether 'Other' payment is accepted

boolean
PaymentOther

Description of the 'Other' payment accepted

string
PickupOptions

Listing pickup options

integer
ShippingOptions

Listing shipping options

integer
CustomShippingLines

List of shipping costs if 'Specify shipping costs' selected

string
IsShippingPricePerQuantity

Whether shipping price is per quantity

boolean
IsOverrideFloatingPricing

Whether to override default pricing type

boolean
IsOverrideListingOptions

Whether to override default listing options

boolean
IsOverrideExtras

Whether to override default listing Extras

boolean
IsOverrideOfferOptions

Whether to override default Fixed Price Offer options

boolean
IsOverridePaymentMethods

Whether to override default payment methods

boolean
IsOverrideShippingOptions

Whether to override default shipping options

boolean
IsListingFooterEnabled

Whether listing footer is enabled

boolean
CreatedDate

The date and time (in UTC) that the listing rule was created

date
CreatedBy

The internal Tradevine ID of the user that created the listing rule

integer
ModifiedDate

The date and time (in UTC) that the listing rule was last modified

date
ModifiedBy

The internal Tradevine ID of the user that last modified the listing rule

integer
IsAutoFeedbackDisabled

Whether to disable auto feedback

boolean
IgnoreFeedback

Whether to automatically ignore feedback

boolean
ListingFailureText

Text of last listing failure (cleared on successful listing creation)

string
CountOpenListings

Number of open listings

integer
HasOpenListings

Whether has open listings

boolean
IsClearanceItem

Whether to mark this item as 'Clearance Item'

boolean
ShippingTemplateID

The unique internal identifier of in Tradevine of the shipping template to use

integer
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
WasPrice

The price used to compare against the Buy Price if seller is able to list clearance items.

decimal number
Photos

The list of photos of the listing-rule

Collection of Photo

Response Formats

application/json

Sample:

{
  "TradeMeListingRuleID": null,
  "TradeMeOrganisationID": null,
  "ExternalTradeMeOrganisationName": null,
  "OrganisationID": null,
  "ProductID": null,
  "ProductCode": null,
  "RuleName": null,
  "IsAutoListingEnabled": null,
  "AutoListingPriority": null,
  "HasListingFailure": null,
  "Title": null,
  "SubTitle": null,
  "IsSellMultipleQty": null,
  "SellMultipleQuantity": null,
  "StartPrice": null,
  "ReservePrice": null,
  "BuyNowPrice": 50.0,
  "IsPricingFloating": null,
  "FloatingPriceBaseField": null,
  "StartPriceBasePlusPercent": null,
  "ReservePriceBasePlusPercent": null,
  "BuyNowPriceBasePlusPercent": null,
  "CategoryNumber": null,
  "CategoryText": null,
  "CategoryOptions": null,
  "Description": "My Product 1",
  "IsLegalNoticeRead": null,
  "IsClassified": null,
  "IsProductDisplayedBold": null,
  "IsProductUseSubTitles": null,
  "IsProductGallery": null,
  "IsProductGalleryPlus": null,
  "IsProductFeature": null,
  "IsProductHomePageCombo": null,
  "ListingDurationType": null,
  "ListingFixedLengthDuration": null,
  "ListingDurationEndTime": null,
  "ListingDurationEndDay": null,
  "IsListingNew": null,
  "IsUseBuyNow": null,
  "FixedPriceOfferAutoEnabled": null,
  "FixedPriceOfferBiddersAndWatchers": null,
  "FixedPriceOfferDuration": null,
  "FixedPriceOfferBaseField": null,
  "FixedPriceOfferAbsoluteValue": null,
  "IsFixedPriceOfferAbsolute": null,
  "FixedPriceOfferDelta": null,
  "FixedPriceOfferDeltaType": null,
  "FixedPriceOfferIgnoreIfFeedbackRatingLessThan": null,
  "FixedPriceOfferFeedbackLessThanPercent": null,
  "IsAllowBidsAuthBiddersOnly": null,
  "IsPaymentViaBankDeposit": null,
  "IsPaymentViaCreditCard": null,
  "IsPaymentViaCash": null,
  "IsPaymentViaSafeTrader": null,
  "IsPaymentOther": null,
  "PaymentOther": null,
  "PickupOptions": null,
  "ShippingOptions": null,
  "CustomShippingLines": null,
  "IsShippingPricePerQuantity": null,
  "IsOverrideFloatingPricing": null,
  "IsOverrideListingOptions": null,
  "IsOverrideExtras": null,
  "IsOverrideOfferOptions": null,
  "IsOverridePaymentMethods": null,
  "IsOverrideShippingOptions": null,
  "IsListingFooterEnabled": null,
  "CreatedDate": null,
  "CreatedBy": null,
  "ModifiedDate": null,
  "ModifiedBy": null,
  "IsAutoFeedbackDisabled": null,
  "IgnoreFeedback": null,
  "ListingFailureText": null,
  "CountOpenListings": null,
  "HasOpenListings": null,
  "IsClearanceItem": null,
  "ShippingTemplateID": null,
  "PhotoIdentifier": null,
  "WasPrice": null,
  "Photos": null
}