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
| 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 | 
| ProductWarehouseStock | 
                             The total aggregated warehouse stock for the product of this rule  | 
                        decimal number | 
| RuleName | 
                             Listing rule name  | 
                        string | 
| IsAutoListingEnabled | 
                             Whether auto listing is enabled  | 
                        boolean | 
| AutoListingPriority | 
                             Auto listing priority  | 
                        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 | 
| CategoryNumber | 
                             Trade Me category ID - e.g.: 3600  | 
                        string | 
| CategoryText | 
                             Trade Me listing category  | 
                        string | 
| CategoryOptions | 
                             Trade Me listing category attributes - e.g.: brand=Sony  | 
                        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 | 
| IsProductSuperFeature | 
                             Whether listing is done with Super 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 days  | 
                        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 to base the Fixed Price Offer on  | 
                        integer | 
| FixedPriceOfferAbsoluteValue | 
                             If IsFixedPriceOfferAbsolute is set to true, this is the fixed monetary value to make the FPO for  | 
                        decimal number | 
| 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 | 
| 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 | 
| IsPaymentViaAfterpay | 
                             Whether Afterpay 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. 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 | 
| 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 | 
| LastTradeMeListingExternalID | 
                             The most recent Trade Me listing ID associated with this rule  | 
                        integer | 
| 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 | 
| 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 | 
| ShippingTemplateName | 
                             The name of the shipping template to use  | 
                        string | 
| 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 | 
| YouTubeVideoKey | 
                             The identifier of a YouTube video to display on listings.  | 
                        string | 
| WasPrice | 
                             The price used to compare against the Buy Price if seller is able to list clearance items.  | 
                        decimal number | 
| GroupSku | 
                             The user-supplied grouping SKU if this rule is to be a variant in a multi-variant listing group  | 
                        string | 
| TradeMeListingRuleVariantGroupID | 
                             The internal Tradevine ID of the variant group that this rule belongs to  | 
                        integer | 
| OptionValue1 | 
                             The value of the first Multi-variant field e.g. if OptionName1 was Colour, then this variant might have OptionValue1 of Red  | 
                        string | 
| 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 | 
| OptionValue3 | 
                             The value of the third Multi-variant field (if applicable)  | 
                        string | 
| OptionValue4 | 
                             The value of the fourth Multi-variant field (if applicable)  | 
                        string | 
| OptionValue5 | 
                             The value of the fifth Multi-variant field (if applicable)  | 
                        string | 
| TradeMeCourierIsBox | 
                             If Book a Courier shipping option is used, if the package type if Box (true) or Bag (false)  | 
                        boolean | 
| TradeMeCourierBagSize | 
                             If Book a Courier shipping option is used and package type is Bag then the bag size  | 
                        integer | 
| TradeMeCourierNoRestrictedItems | 
                             If Book a Courier shipping option is used, declare that the packahe does not contain restricted items  | 
                        boolean | 
| 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 | 
| 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 | 
| VariantGroup | 
                             The group level settings that this rule belongs to (if applicable, otherwise null)  | 
                        TradeMeListingRuleVariantGroup | 
| 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,
  "ProductWarehouseStock": null,
  "RuleName": null,
  "IsAutoListingEnabled": null,
  "AutoListingPriority": null,
  "HasListingFailure": null,
  "Title": null,
  "SubTitle": null,
  "IsSellMultipleQty": null,
  "SellMultipleQuantity": null,
  "StartPrice": null,
  "ReservePrice": null,
  "BuyNowPrice": 50.0,
  "CategoryNumber": null,
  "CategoryText": null,
  "CategoryOptions": null,
  "Description": "My Product 1",
  "IsLegalNoticeRead": null,
  "IsClassified": null,
  "IsProductDisplayedBold": null,
  "IsProductUseSubTitles": null,
  "IsProductGallery": null,
  "IsProductGalleryPlus": null,
  "IsProductFeature": null,
  "IsProductSuperFeature": 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,
  "IsPaymentViaAfterpay": 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,
  "LastTradeMeListingExternalID": null,
  "QuantityInStock": null,
  "IsClearanceItem": null,
  "ShippingTemplateID": null,
  "ShippingTemplateName": null,
  "PhotoIdentifier": null,
  "YouTubeVideoKey": null,
  "WasPrice": null,
  "GroupSku": null,
  "TradeMeListingRuleVariantGroupID": null,
  "OptionValue1": null,
  "OptionValue2": null,
  "OptionValue3": null,
  "OptionValue4": null,
  "OptionValue5": null,
  "TradeMeCourierIsBox": null,
  "TradeMeCourierBagSize": null,
  "TradeMeCourierNoRestrictedItems": null,
  "TradeMeCourierSelectedCourier": null,
  "TradeMeCourierServiceLevel": null,
  "VariantGroup": null,
  "Photos": null
}