C# Class TradeMe.Api.Client.Client

A Wrapper for calling the Trade Me API.
Afficher le fichier Open project: TradeMe/trade-me-api-wrapper Class Usage Examples

Méthodes publiques

Méthode Description
AddDeliveryAddress ( DeliveryAddress request ) : System.Xml.Linq.XDocument

Adds a delivery address to the authenticated user’s profile. POST

REQUIRES AUTHENTICATION.

AddFeedback ( FeedbackRequest request ) : System.Xml.Linq.XDocument

Adds feedback to a listing. POST

REQUIRES AUTHENTICATION.

AddMemberToBlackList ( BlacklistRequest request ) : System.Xml.Linq.XDocument

Adds a member to the authenticated user’s blacklist. POST

REQUIRES AUTHENTICATION.

AddNote ( SaveNoteRequest request ) : System.Xml.Linq.XDocument

Performs the My Trade Me Method: Creates or updates the note on a listing. POST

REQUIRES AUTHENTICATION.

AddPhotoToListing ( string photoId, string listingId ) : System.Xml.Linq.XDocument

Performs the Photo Method: Adds a photo to an auction. The currently authenticated user must be the seller.Remove a photo.

REQUIRES AUTHENTICATION.

AnswerSpecificQuestion ( ListingAnswerQuestion answerQuestion, string listingId, string questionId ) : System.Xml.Linq.XDocument

Performs the Listing Method: Provide an answer for a specific question.

Serializes the given ListingAnswerQuestion into xml. Creates a query string using the parameters provided.

All the parameters are required.

REQUIRES AUTHENTICATION.

AuthenticateWithVerificationCode ( string code ) : void

This is the second and final step in the authorisation process. It uses the verification code (retrieved in public string GetVerificationCode()).

It exchanges the verification code for an access token.

Once this step has been performed the user will be enabled to perform authenticated requests.

AuthenticatedQuery ( string query ) : IConsumerRequest

Performs the query specified in the "query" string to perform a request that requires authorization.

This method requires that either an accessToken has been set manually or that the GetVerificationCode() and AuthenticateWithVerificationCode(string code) methods have been called previously.

It returns the IConsumerRequest fully enabled to make the request specified in the "query" string.

BidRequest ( BidRequest request ) : System.Xml.Linq.XDocument

Performs the Bidding Method: Place a bid request.

Serializes the given BidRequest into xml and sends the message.

REQUIRES AUTHENTICATION.

BuyNowRequest ( BuyNowRequest request ) : System.Xml.Linq.XDocument

Performs the Bidding Method: Place a Buy Now request.

Serializes the given BuyNowRequest into xml and sends the message.

REQUIRES AUTHENTICATION.

Client ( ) : System

Initializes a new instance of the Client class.

Client ( string consumerKey, string consumerSecret ) : System

Initializes a new instance of the Client class.

Client ( string consumerKey, string consumerSecret, IToken accessToken ) : System

Initializes a new instance of the Client class.

Client ( string consumerKey, string consumerSecret, string scopeOfRequest ) : System

Initializes a new instance of the Client class.

CommentOnListing ( ListingAddComment addComment, string listingId ) : System.Xml.Linq.XDocument

Performs the Listing Method: Post a comment on a listing.

Serializes the given ListingAddComment into xml. Creates a query string using the listingId provided .

All the parameters are required.

REQUIRES AUTHENTICATION.

DeleteDeliveryAddress ( string deliveryId ) : System.Xml.Linq.XDocument

Removes a delivery address from the authenticated user’s profile. (DELETE).

REQUIRES AUTHENTICATION.

DeleteListingFromWatchlist ( string listingId ) : System.Xml.Linq.XDocument

Performs the My Trade Me Method: Save a listing to a member’s watchlist (DELETE).

Will remove the listing with the listingId provided from the members watchlist. Creates a query string using the listingId provided.

REQUIRES AUTHENTICATION.

DeleteListingStatus ( string purchaseId ) : System.Xml.Linq.XDocument

Performs the My Trade Me Method: Deletes the status from a listing in the authenticated user’s Sold Items list. (DELETE).

REQUIRES AUTHENTICATION.

DeleteListingStatus ( string listingId, string offerId ) : System.Xml.Linq.XDocument

Performs the My Trade Me Method: Deletes the status from a listing in the authenticated user’s Sold Items list. (DELETE).

REQUIRES AUTHENTICATION.

DeleteNote ( string listingId, string noteId, string offerId ) : System.Xml.Linq.XDocument

Performs the My Trade Me Method: Removes the note from a listing. DELETE

REQUIRES AUTHENTICATION.

EditListedItem ( EditListingRequest request ) : System.Xml.Linq.XDocument

Edit an auction or classified that you have created.

You will need to resubmit the complete sell form as used when you created the listing but with the fields you wish to edit modified. Request format will error if fields are locked and cannot be edited.

REQUIRES AUTHENTICATION.

EmailFriend ( EmailFriendRequest email, string listingId ) : System.Xml.Linq.XDocument

Performs the Listing Method: Send an email regarding an auction to a friend.

Serializes the given EmailFriendRequest into xml. Creates a query string using the listingId provided .

All the parameters are required.

REQUIRES AUTHENTICATION.

EmailSellerOfClassified ( EmailRequest emailRequest, string listingId ) : System.Xml.Linq.XDocument

Performs the Listing Method: Send an email to the seller of a classified.

Serializes the given EmailRequest into xml. Creates a query string using the listingId provided .

All the parameters are required.

REQUIRES AUTHENTICATION.

FixedPriceOffers ( ) : FixedPriceOffers

Performs the My Trade Me Method: Retrieve a list of Fixed Price Offers.

Creates a query string and performs the request.

REQUIRES AUTHENTICATION.

FixedPriceOffers ( string query ) : FixedPriceOffers

Performs the Fixed Price Offer Method: Retrieve a list of Fixed Price Offers

using the "query" string provided - should be the "MyTradeMe/FixedPriceOffers.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

REQUIRES AUTHENTICATION.

FixedPriceOffersByMember ( ) : FixedPriceOffers

Performs the Fixed Price Offer Method: Retrieve the fixed price offers offered by a member. GET

Creates a query string and performs the request.

REQUIRES AUTHENTICATION.

FixedPriceOffersToMember ( ) : FixedPriceOffers

Performs the Fixed Price Offer Method: Retrieve a list of Fixed Price Offers.

Creates a query string and performs the request.

REQUIRES AUTHENTICATION.

GetBlacklistedMembers ( ) : Blacklist

Retrieves a list of all the members on the authenticated user’s blacklist. GET

REQUIRES AUTHENTICATION.

GetClosingSoonListings ( ) : ClosingSoonListings

Performs the Listing Method: Retrieves the items closing soon for the whole country or for a single region. GET

DOES NOT REQUIRE AUTHENTICATION.

GetComplaintSubjects ( ) : ComplaintSubjectCollection

Performs the category method: Retrieves a list of possible complaint subjects. This is used in conjunction with the send a complaint API. GET

DOES NOT REQUIRE AUTHENTICATION.

GetEmailPreferences ( ) : EmailOptions

Retrieves the authenticated user’s email preferences. GET

REQUIRES AUTHENTICATION.

GetFeaturedListings ( ) : FeaturedListings

Performs the Listing Method: Retrieves the featured listings for the whole country or for a single region. GET

DOES NOT REQUIRE AUTHENTICATION.

GetFeesForListingItems ( ListingRequest request ) : System.Xml.Linq.XDocument

Returns the fees that will be charged for a listing once the auction or classified has been created.

There are several endpoints that should be used to get information needed to list an item. Check Category information, Legal Notice information, attributes, fees and listing duration options.

REQUIRES AUTHENTICATION.

GetHotListings ( ) : HotListings

Performs the Listing Method: Retrieves the hot items for the whole country or for a single region. GET

DOES NOT REQUIRE AUTHENTICATION.

GetJobAgentReport ( ) : JobAgentReport

Retrieves the Job Agent report for the authenticated user.

REQUIRES AUTHENTICATION.

GetLatestListings ( ) : LatestListings

Performs the Listing Method: Retrieves the latest listed items for the whole country or for a single region. GET

DOES NOT REQUIRE AUTHENTICATION.

GetLisingFees ( string listingId ) : SellingFee

Retrieves information about fees for a single listing.

REQUIRES AUTHENTICATION.

GetListOfDeliveryAddresses ( ) : Address

Retrieves a list of delivery addresses for the authenticated user. (GET)

REQUIRES AUTHENTICATION.

GetMotorbikeMakes ( ) : MotorbikeMakeCollection

Performs the category method: Retrieves a list of all motorbike makes. Can be used when searching. GET

DOES NOT REQUIRE AUTHENTICATION.

GetNote ( string listingId ) : NoteResponse

Retrieves the note for a listing, if there is one. GET

REQUIRES AUTHENTICATION.

GetOneDollarListings ( ) : OneDollarListings

Performs the Listing Method: Retrieves the items with one dollar reserves for the whole country or for a single region. GET

DOES NOT REQUIRE AUTHENTICATION.

GetPayNowLedgerBySettlement ( string batchId ) : PayNowLedger

Returns Pay Now ledger entries for a settlement into the authenticated user’s bank account.

REQUIRES AUTHENTICATION.

GetProductMappings ( ) : ProductMappings

Retrieves a list of product codes and stock levels associated with the authenticated user’s active listings. The results will return data from feeds and My Products.

REQUIRES AUTHENTICATION.

GetPropertyAgentReport ( ) : PropertyAgentReport

Retrieves the Property Agent report for the authenticated user.

REQUIRES AUTHENTICATION.

GetVerificationCode ( ) : string

Performs the first step in the authorisation handshake. It requests a verification code from the TradeMeApi.

GetWeeklySalesStats ( ) : WeeklySales

Retrieve sales statistics for the authenticated user.

REQUIRES AUTHENTICATION.

ListItem ( ListingRequest request ) : System.Xml.Linq.XDocument

Starts a new auction or classified.

There are several endpoints that should be used to get information needed to list an item. Check Category information, Legal Notice information, attributes, fees and listing duration options.

REQUIRES AUTHENTICATION.

ListingDetail ( string query ) : ListedItemDetail

Performs the Listing Method: Retrieve the details of a single listing

using the "query" string provided - should be the "Listings/{listing_id}.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.

ListingDetailById ( string id ) : ListedItemDetail

Performs the Listing Method: Retrieve the details of a single listing.

Creates a query string using the listing id parameter provided.

DOES NOT REQUIRE AUTHENTICATION.

LostItems ( LostItemsCriteria criteria, string page, string rows ) : Listings

Performs the My Trade Me Method: Retrieve a list of lost items.

Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

REQUIRES AUTHENTICATION.

LostItems ( string query ) : Listings

Performs the My Trade Me Method: Retrieve a list of lost items

using the "query" string provided - should be the "MyTradeMe/Lost.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

REQUIRES AUTHENTICATION.

MakeFixedPriceOffer ( FixedPriceOfferToMembersRequest request ) : System.Xml.Linq.XDocument

Performs the Fixed Price Offer Method: Makes a fixed price offer for an auction to the specified members. POST

REQUIRES AUTHENTICATION.

MemberFeedbackById ( string id, MemberFeedbackCriteria criteria ) : Feedback

Performs the Membership Method: Retrieve feedback for a member.

Creates a query string using the parameters provided - the criteria parameter can be null if it is not required for the request.

DOES NOT REQUIRE AUTHENTICATION.

MemberFeedbackByQueryString ( string query ) : Feedback

Performs the Membership Method: Retrieve feedback for a member

using the "query" string provided - should be the "Search/Member/{member_id}/Feedback.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.

MemberFeedbackCountById ( string id ) : FeedbackCount

Performs the membership method: Retrieve member feedback summary (counts).

Creates a query string using the member id provided.

DOES NOT REQUIRE AUTHENTICATION.

MemberFeedbackCountByQueryString ( string query ) : FeedbackCount

Performs the membership method: Retrieve member feedback summary (counts) using the "query" string provided - should be the "Search/Member/{member_id}/FeedbackCount.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.

MemberId ( string query ) : MemberId

Performs the Membership Method: Retrieve member ID

using the "query" string provided - should be the "Member/{member_nickname}.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.

MemberIdByNickname ( string nickname ) : MemberId

Performs the Membership Method: Retrieve member ID.

Creates a query string using the nickname parameter provided

DOES NOT REQUIRE AUTHENTICATION.

MemberLedger ( MemberLedgerCriteria criteria, string page, string rows ) : MemberLedger

Performs the My Trade Me method: Retrieve a member’s ledger.

Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

REQUIRES AUTHENTICATION.

MemberLedger ( string query ) : MemberLedger

Performs the My Trade Me method: Retrieve a member’s ledger

using the "query" string provided - should be the "MyTradeMe/MemberLedger/All.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

REQUIRES AUTHENTICATION.

MemberListings ( string query ) : Listings

Performs the Membership Method: Retrieve a member’s listings

using the "query" string provided - should be the "Member/{member_id}/Listings.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.

MemberListingsById ( string id ) : Listings

Performs the Membership Method: Retrieve a member’s listings.

Creates a query string using the parameters provided.

DOES NOT REQUIRE AUTHENTICATION.

MemberPhotos ( ) : MemberPhotos

Performs the Photo Method: Retrieve a list of member photos.

Creates a query string and performs the request.

REQUIRES AUTHENTICATION.

MemberPhotos ( string query ) : MemberPhotos

Performs the Photo Method: Retrieve a list of member photos

using the "query" string provided - should be the "Photos.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

REQUIRES AUTHENTICATION.

MemberProfileById ( string id ) : MemberProfile

Performs the membership method: Retrieve a member’s profile data. Creates a query string using the member id provided.

DOES NOT REQUIRE AUTHENTICATION.

MemberProfileByQueryString ( string query ) : MemberProfile

Performs the membership method: Retrieve a member’s profile data using the "query" string provided - should be the "Member/{member_id}/Profile.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.

PayNowLedger ( string query ) : PayNowLedger

Performs the My Trade Me Method: Retrieve a member’s Pay Now ledger

using the "query" string provided - should be the "MyTradeMe/PayNowLedger/{criteria}.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

REQUIRES AUTHENTICATION.

PayNowLedgerWithCriteria ( PayNowLedgerCriteria criteria ) : PayNowLedger

Performs the My Trade Me Method: Retrieve a member’s Pay Now ledger.

Creates a query string using the parameter provided - parameter can be null if it is not required for the request.

REQUIRES AUTHENTICATION.

Post ( object toSend, string to ) : System.Xml.Linq.XDocument

It serializes the toSend object into xml and sends the post message specified in the "to" string using an authorized connection. It returns the response from the server as an XDocument.

REQUIRES AUTHENTICATION.

Post ( object toSend, string to, bool delete ) : System.Xml.Linq.XDocument

It serializes the toSend object into xml and sends the post message specified in the "to" string using an authorized connection. It returns the response from the server as an XDocument.

REQUIRES AUTHENTICATION.

RefundPayNowPayment ( PayNowRefundRequest request ) : System.Xml.Linq.XDocument

Refunds a Pay Now payment where the authenticated user is the seller. POST

REQUIRES AUTHENTICATION.

RelistItem ( RelistListingRequest request ) : System.Xml.Linq.XDocument

Relist an item that has expired. Relists an item without modifying editable fields.

Relist copies all data from original listing and applies them to the new listing. The only exceptions are where there are default durations that are applied on relisted items.

REQUIRES AUTHENTICATION.

RemoveFeedback ( string feedbackId ) : System.Xml.Linq.XDocument

Removes feedback the authenticated user has posted against a listing. DELETE

REQUIRES AUTHENTICATION.

RemoveMemberFromBlacklist ( string memberId ) : System.Xml.Linq.XDocument

Removes a member from the authenticated user’s blacklist. DELETE

REQUIRES AUTHENTICATION.

RemovePhoto ( string photoId ) : string

Performs the Photo Method: Remove a photo.

Creates a query string using the photo id provided.

REQUIRES AUTHENTICATION.

RemoveSavedFavorite ( string favoriteId, string type ) : System.Xml.Linq.XDocument

Performs the Favourites method: Deletes a saved search, category or seller from the currently authenticated user’s favourites. DELETE

REQUIRES AUTHENTICATION.

RespondToFeedback ( FeedbackReplyRequest request ) : System.Xml.Linq.XDocument

Replies to feedback placed against a listing where the authenticated user was the seller. POST

REQUIRES AUTHENTICATION.

RespondToFixedPriceOffer ( FixedPriceOfferRequest request ) : System.Xml.Linq.XDocument

Performs the Fixed Price Offer Method: Accepts or rejects a fixed price offer. POST

REQUIRES AUTHENTICATION.

RetrieveAttributesForCategory ( string categoryNumber ) : Attributes

Performs the category method: Retrieves the list of attributes which are applicable to a specific category.

DOES NOT REQUIRE AUTHENTICATION.

RetrieveBluRayIds ( ) : BluRayValidations

Performs the category method: Returns a the list of Blu-ray catalogue ID numbers. You can use this list to validate the catalogue ID before listing a Blu-ray. GET

DOES NOT REQUIRE AUTHENTICATION.

RetrieveCategories ( ) : Category

Performs the category methods: Retrieve a list of all or part of our category tree.

DOES NOT REQUIRE AUTHENTICATION.

RetrieveCategoriesById ( string id ) : Category

Performs the category methods: Retrieve a list of all or part of our category tree. Does this by using the id string provided - should be the id of the category you wish to retrieve.

DOES NOT REQUIRE AUTHENTICATION.

RetrieveCategoriesByQueryString ( string query ) : Category

Performs the category methods: Retrieve a list of all or part of our category tree, Retrieve a list of Trade Me Motors used car categories, Retrieve a list of Trade Me Motors motorbike categories, using the "query" string provided - should be the "Categories/UsedCars.xml" part of the url it shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.

RetrieveDurationOptionsForCategory ( string categoryNumber ) : ListingDurations

Performs the category method: Retrieves the default duration and the duration options that are available for listings in a specific category. GET

DOES NOT REQUIRE AUTHENTICATION.

RetrieveDvdIds ( ) : DvdValidations

Performs the category method: Returns a list of DVD catalogue ID numbers. You can use this list to validate the catalogue ID before listing a DVD. GET

DOES NOT REQUIRE AUTHENTICATION.

RetrieveFavouriteCategories ( ) : SavedCategories

Performs the Favourites Method: Retrieve Favourite Categories.

REQUIRES AUTHENTICATION.

RetrieveFavouriteSearches ( SavedSearchType filter ) : SavedSearches

Performs the Favourites Method: Retrieve Favourite Searches.

REQURIES AUTHENTICATION.

RetrieveFavouriteSellers ( ) : SavedSellers

Performs the Favourites method: Retrieve Favourite Sellers.

REQUIRES AUTHENTICATION.

RetrieveFeesForCategory ( string categoryNumber ) : ListingFees

Performs the category method: Retrieves a list of fees for a specific category. GET

DOES NOT REQUIRE AUTHENTICATION.

RetrieveJobCategories ( ) : JobCategories

Performs the category method: Retrieve a list of Trade Me Jobs categories.

DOES NOT REQUIRE AUTHENTICATION.

RetrieveLegalNoticeForCategory ( string categoryNumber ) : LegalNotice

Performs the category method: Retrieves the legal notice that the user is required to agree to before listing. GET

DOES NOT REQUIRE AUTHENTICATION.

RetrieveListOfMembersForFixedPriceOffer ( string listingId, string filter ) : FixedPriceOfferMembersResponse

Performs the Fixed Price Offer method: Returns a list of members you can make a fixed price offer to for a particular auction. GET

REQUIRE AUTHENTICATION.

RetrieveLocalities ( string query ) : LocalityCollection

Performs the Localities methods: three-tier locality dataset, two-tier locality dataset,

using the "query" string provided - should be the "Localities.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.

RetrieveLocalitiesThreeTier ( ) : LocalityCollection

Performs the Localities methods: three-tier locality dataset

Returns three-tier locality hierarchy of regions, districts and their respective suburbs. These values are used in Trade Me Property, Trade Me Jobs and Services.

DOES NOT REQUIRE AUTHENTICATION.

RetrieveLocalitiesTwoTier ( ) : LocalityCollection

Performs the Localities method: two-tier locality dataset.

Returns list of towns used in member registration. This information is displayed on member profile as “suburb” and also on listings where the approximate location of goods is important, such as in Trade Me Motors.

DOES NOT REQUIRE AUTHENTICATION.

RetrieveMotorBikeCategories ( ) : Category

Performs the category methods: Retrieve a list of Trade Me Motors motorbike categories.

DOES NOT REQUIRE AUTHENTICATION.

RetrieveTravelLocalities ( ) : LocalityCollection

Performs the category method: Returns a list of districts and suburbs as used by TradeMe travel. GET

DOES NOT REQUIRE AUTHENTICATION.

RetrieveUsedCarCategories ( ) : Category

Performs the category methods: Retrieve a list of Trade Me Motors used car categories.

DOES NOT REQUIRE AUTHENTICATION.

SaveCategory ( SaveCategoryRequest saveCategory ) : System.Xml.Linq.XDocument

Performs the Favourites method: Save Category.

Serializes the given SaveCategoryRequest into xml.

REQUIRES AUTHENTICATION.

SaveListingToWatchlist ( SaveToWatchlistRequest request ) : System.Xml.Linq.XDocument

Performs the My Trade Me Method: Adds a listing to the authenticated user’s watchlist with the option to control when and if an email is sent to the member warning that the auction is closing soon.

REQUIRES AUTHENTICATION.

SaveOrUpdateListingStatus ( string purchaseId, string stat ) : StatusResponse

Saves a status to a listing in the authenticated user’s Sold Items list. (POST)

REQUIRES AUTHENTICATION.

SaveOrUpdateListingStatus ( string listingId, string offerId, string stat ) : StatusResponse

Saves a status to a listing in the authenticated user’s Sold Items list. (POST)

REQUIRES AUTHENTICATION.

SaveSearch ( SaveSearchRequest saveSearch ) : System.Xml.Linq.XDocument

Performs the Favourites method: Save Search.

Serializes the given SaveSearchRequest into xml.

REQUIRES AUTHENTICATION.

SaveSeller ( SaveSellerRequest saveSeller ) : System.Xml.Linq.XDocument

Performs the Favourites method: Save Seller.

Serializes the given SaveSellerRequest into xml.

REQUIRES AUTHENTICATION.

SearchBluRayCatalog ( String search = "" ) : MovieTitles

Performs the category method: Searches the Trade Me Blu-ray catalogue for movie titles. GET

DOES NOT REQUIRE AUTHENTICATION.

SearchCommercialLeaseProperties ( string searchString, PropertySortOrder sortOrder, int page, int rows, int region, int district, int suburb, System.DateTime dateFrom, int priceMin, int priceMax, int areaMax, int areaMin, int landAreaMin, int landAreaMax, bool adjacentSuburbs, PropertyUsage usage ) : global::Properties

Performs the search method: Search Commercial Lease Property. Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

DOES NOT REQUIRE AUTHENTICATION.

SearchCommercialSaleProperties ( string searchString, PropertySortOrder sortOrder, int page, int rows, int region, int district, int suburb, System.DateTime dateFrom, int priceMin, int priceMax, int bathroomsMin, int bathroomsMax, int bedroomsMin, int bedroomsMax, int areaMax, int areaMin, int landAreaMin, int landAreaMax, bool adjacentSuburbs, PropertyUsage usage ) : global::Properties

Performs the search method: Search Commercial Property. Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

DOES NOT REQUIRE AUTHENTICATION.

SearchDvdCatalog ( String search = "" ) : MovieTitles

Performs the category method: Searches the Trade Me DVD catalogue for movie titles. GET

DOES NOT REQUIRE AUTHENTICATION.

SearchFlatmates ( string query ) : Flatmates

Performs the Search Method: Search for Flatmate using the "query" string provided - should be the "Search/Flatmates.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.

SearchFlatmates ( string searchString, PropertySortOrder sortOrder, int page, int rows, int region, int district, int suburb, System.DateTime dateFrom, int priceMin, int priceMax ) : Flatmates

Performs the Search Method: Search for Flatmate Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

DOES NOT REQUIRE AUTHENTICATION.

SearchGeneral ( string query ) : SearchResults

Performs Search method: Search General using the "query" string provided - should be the "Search/General.xml?search_string=Playstation" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.

SearchGeneral ( string category, string searchString, int userRegion, SortOrder sortOrder, bool buy, bool pay, System.Condition condition, System.DateTime dateFrom, int page, int rows, int memberListing ) : SearchResults

Performs Search method: Search General using the query paramaters provided it will construct a query string for you - can use null if the parameter is not required for your request.

DOES NOT REQUIRE AUTHENTICATION.

SearchJobs ( string query ) : Jobs

Performs the search method: Search Jobs

using the "query" string provided - should be the "Search/Jobs.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.

SearchJobs ( string searchString, SortOrder sortOrder, decimal salaryMin, decimal salaryMax, string region, string district, JobType type, string category, string subcategory, int page, int rows ) : Jobs

Performs the search method: Search Jobs.

Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

DOES NOT REQUIRE AUTHENTICATION.

SearchLifestyleProperties ( string searchString, PropertySortOrder sortOrder, int page, int rows, int region, int district, int suburb, System.DateTime dateFrom, int priceMin, int priceMax, int bathroomsMin, int bathroomsMax, int bedroomsMin, int bedroomsMax, int areaMax, int areaMin, int landAreaMin, int landAreaMax, bool adjacentSuburbs, LifestylePropertyUsage usage, LifestylePropertyType propertyType ) : global::Properties

Performs the search method: Search Lifestyle Property. Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

DOES NOT REQUIRE AUTHENTICATION.

SearchMotorBikes ( string query ) : MotorBikes

Performs the Search Method: Search Motor Bikes using the "query" string provided - should be the "Search/Motors/Bikes.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.

SearchMotorBikes ( string searchString, SortOrder sortOrder, decimal priceMin, decimal priceMax, string make, BikeType type, int yearMin, int yearMax, int energySizeMin, int energySizeMax, DateTime dateFrom, int page, int rows ) : MotorBikes

Performs the Search Method: Search Motor Bikes. It creates the query string using the paramaters - can be null if the parameter is not required for the request.

DOES NOT REQUIRE AUTHENTICATION.

SearchMotorBoats ( string query ) : MotorBoats

Performs the Search Method: Search Motor Boats

using the "query" string provided - should be the "Search/Motors/Boats.xml?length_max=5000&type=inflatable" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.

SearchMotorBoats ( string searchString, SortOrder sortOrder, decimal priceMin, decimal priceMax, BoatType type, int lengthMin, int lengthMax, DateTime dateFrom, int page, int rows ) : MotorBoats

Performs the Search Method: Search Motor Boats using the parameters provided - can use null if the parameter is not required.

DOES NOT REQUIRE AUTHENTICATION.

SearchOpenHomeProperties ( string searchString, PropertySortOrder sortOrder, int page, int rows, int region, int district, int suburb, DateTime dateFrom, int priceMin, int priceMax, int bathroomsMin, int bathroomsMax, int bedroomsMin, int bedroomsMax, int areaMax, int areaMin, int landAreaMin, int landAreaMax, PropertyType propertyType, bool adjacentSuburbs ) : global::Properties

Performs the Search method: Search Residential Open Homes. Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

DOES NOT REQUIRE AUTHENTICATION.

SearchProperties ( string query ) : global::Properties

Performs the Search Methods: Search Residential Property, Search Residential Rental Property, Residential Open Homes, Search Commercial Property, Search Commercial Lease Property, Search Rural Property, Search Lifestyle Property, Search Retirement Villages,

using the "query" string provided - should be the "Search/Property/Retirement.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.

SearchResidentialProperties ( string searchString, PropertySortOrder sortOrder, int page, int rows, int region, int district, int suburb, DateTime dateFrom, int priceMin, int priceMax, int bathroomsMin, int bathroomsMax, int bedroomsMin, int bedroomsMax, int areaMax, int areaMin, int landAreaMin, int landAreaMax, PropertyType propertyType, bool adjacentSuburbs ) : global::Properties

Performs the search method: Search Residential Property.

Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

SearchResidentialRentalProperties ( string searchString, PropertySortOrder sortOrder, int page, int rows, int region, int district, int suburb, DateTime dateFrom, int priceMin, int priceMax, int bathroomsMin, int bathroomsMax, int bedroomsMin, int bedroomsMax, int areaMax, int areaMin, int landAreaMin, int landAreaMax, PropertyType propertyType, bool adjacentSuburbs ) : global::Properties

Performs the Search Method: Search Residential Rental Property. Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

DOES NOT REQUIRE AUTHENTICATION.

SearchRetirementVillages ( string query ) : RetirementVillages

Performs the search method: Search Retirement Villages using the "query" string provided - should be the "Search/Retirement.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.

SearchRetirementVillages ( string searchString, PropertySortOrder sortOrder, int page, int rows, int region, int district, int suburb, DateTime dateFrom, int priceMin, int priceMax, int bathroomsMin, int bathroomsMax, int areaMin, int areaMax, int landAreaMin, int landAreaMax, RetirementVillagePropertyType propertyType, int bedroomsMin, int bedroomsMax ) : RetirementVillages

Performs the search method: Search Retirement Villages. Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

DOES NOT REQUIRE AUTHENTICATION.

SearchRuralProperties ( string searchString, PropertySortOrder sortOrder, int page, int rows, int region, int district, int suburb, DateTime dateFrom, int priceMin, int priceMax, int landAreaMin, int landAreaMax, RuralPropertyUsage usage ) : global::Properties

Performs the search method: Search Rural Property. Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

DOES NOT REQUIRE AUTHENTICATION.

SearchStores ( string searchString = "", int page = 1, string category = "", StoreType storeType = StoreType.Normal ) : Stores

Performs the membership method: Retrieve a member’s profile data using the "query" string provided - should be the "Member/{member_id}/Profile.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.

SearchUsedMotors ( string query ) : Cars

Performs the Search Method: Search Used Motors using the "query" string provided - should be the "Search/Motors/Used.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.

SearchUsedMotors ( string searchString, int userRegion, SortOrder sortOrder, decimal priceMin, decimal priceMax, string make, string model, BodyStyle bodyStyle, int doorsMin, int doorsMax, Transmission transmission, int yearMax, int yearMin, int energySizeMin, int energySizeMax, int odometerMin, int odometerMax, ListingType listingType, DateTime dateFrom, int page, int rows ) : Cars

Performs the Search Method: Search Used Motors. Creates a query string based on the parameters provided, can be null if the parameter is not required for the request.

DOES NOT REQUIRE AUTHENTICATION.

SellBluRayFromCatalogue ( SellCatalogueRequest request ) : XDocument

List a Blu-ray disc using listing details that are sourced from the Trade Me Blu-ray catalogue.

REQUIRES AUTHENTICATION.

SellDvdFromCatalogue ( SellCatalogueRequest request ) : XDocument

List a DVD using listing details that are sourced from the Trade Me DVD catalogue.

REQUIRES AUTHENTICATION.

SellSimilarItem ( SellSimilarListingRequest request ) : XDocument

Sell similar from an existing or expired auction or classified. Creates a new listing without modifying editable fields.Relist an item that has expired. Relists an item without modifying editable fields.

Sell similar from an existing or expired auction or classified. Creates a new listing without modifying editable fields.

REQUIRES AUTHENTICATION.

SellingItems ( string query ) : Items

Performs the MyTradeMe method: Retrieve a list of items currently for sale

using the "query" string provided - should be the "MyTradeMe/SellingItems/All.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

REQUIRES AUTHENTICATION.

SellingItemsWithCriteria ( SellingItemsCriteria criteria ) : Items

Performs the MyTradeMe method: Retrieve a list of items currently for sale.

Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

REQUIRES AUTHENTICATION.

SetEmailPreferences ( EmailOptions request ) : XDocument

Sets the authenticated user’s email preferences. POST

REQUIRES AUTHENTICATION.

SoldItems ( SoldItemsCriteria criteria, string page, string rows ) : SoldItems

Performs the My Trade Me Method: Retrieve a list of sold items.

Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

REQUIRES AUTHENTICATION.

SoldItems ( string query ) : SoldItems

Performs the My Trade Me Method: Retrieve a list of sold items

using the "query" string provided - should be the "MyTradeMe/SoldItems/{criteria}.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

REQUIRES AUTHENTICATION.

UnansweredQuestionsAll ( ) : Questions

Performs the Listing Method: Retrieves a list of all the unanswered questions for all live auctions of the authenticated user. GET

REQUIRES AUTHENTICATION.

UnansweredQuestionsById ( string listingId ) : Questions

Performs the Listing Method: Retrieve a list of unanswered questions for all listings belonging to a member, Retrieve a list of unanswered questions on a single listing.

Creates a query string using the id parameter provided - the parameter should be null if the request is for all listings belonging to a member.

REQUIRES AUTHENTICATION.

UnansweredQuestionsByQueryString ( string query ) : Questions

Performs the Listing Method: Retrieve a list of unanswered questions for all listings belonging to a member, Retrieve a list of unanswered questions on a single listing,

using the "query" string provided - should be the "Listings/questions/unansweredquestions.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

REQUIRES AUTHENTICATION.

UnsoldItems ( UnsoldItemsCriteria criteria, string page, string rows ) : UnsoldItems

Performs the My Trade Me Method: Retrieve a list of unsold items.

Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

REQUIRES AUTHENTICATION.

UnsoldItems ( string query ) : UnsoldItems

Performs the My Trade Me Method: Retrieve a list of unsold items

using the "query" string provided - should be the "MyTradeMe/UnsoldItems.xml" part of the url it shouldn't include "http://api.trademe.co.nz/v1/".

REQUIRES AUTHENTICATION.

UpdateDeliveryAddress ( DeliveryAddress request ) : XDocument

Modifies a delivery addresses in the authenticated user’s profile. POST

REQUIRES AUTHENTICATION.

UpdateFeedback ( FeedbackUpdateRequest request ) : XDocument

Modifies feedback the authenticated user has posted against a listing. POST

REQUIRES AUTHENTICATION.

UpdateSavedFavorite ( string favoriteId, string type, string frequency ) : XDocument

Performs the Favourites method: Modifies the email frequency for a saved favourite. POST

REQUIRES AUTHENTICATION.

UploadPhoto ( PhotoUploadRequest up ) : XDocument

Performs the Photo Method: Upload a photo.

Serializes the given PhotoUploadRequest into xml and sends the message.

UploadPhotoFormat ( PhotoUploadRequest up ) : XDocument

Performs the Photo Method: Upload a photo.

Serializes the given PhotoUploadRequest into xml and sends the message. Loads the file and converts it to the appropriate data format for the request - it does not require the "PhotoData" field of the PhotoUploadRequest object to have anything in it.

Watchlist ( WatchlistCriteria criteria, string page, string rows ) : Watchlist

Performs the My Trade Me Method: Retrieve a member’s watchlist.

Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

REQUIRES AUTHENTICATION.

Watchlist ( string query ) : Watchlist

Performs the My Trade Me Method: Retrieve a member’s watchlist

using the "query" string provided - should be the "MyTradeMe/Watchlist.xml part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

REQUIRES AUTHENTICATION.

WithdrawFixedPriceOffer ( FixedPriceOfferWithdrawalRequest request ) : XDocument

Performs the Fixed Price Offer Method: Withdraws an offer that is current and not expired, accepted or rejected by all users. POST

REQUIRES AUTHENTICATION.

WithdrawListedItem ( WithdrawRequest request ) : XDocument

Withdraw a listing from Trade Me for either being sold or unsold.

REQUIRES AUTHENTICATION.

WonItems ( WonItemsCriteria criteria, string page, string rows ) : WonItems

Performs the My Trade Me Method: Retrieve a list of won items.

Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

REQUIRES AUTHENTICATION.

WonItems ( string query ) : WonItems

Performs the My Trade Me Method: Retrieve a list of won items

using the "query" string provided - should be the "MyTradeMe/Won.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

REQUIRES AUTHENTICATION.

Private Methods

Méthode Description
AddAndHelper ( bool extra, string toAdd ) : string

A helper method for determinging if the & symbol needs to be added to the query string based on the boolean "extra".

DateToStringConverter ( System.DateTime dateFrom ) : string

A helper function to convert a DateTime into the correct string format.

Method Details

AddDeliveryAddress() public méthode

Adds a delivery address to the authenticated user’s profile. POST

REQUIRES AUTHENTICATION.
public AddDeliveryAddress ( DeliveryAddress request ) : System.Xml.Linq.XDocument
request DeliveryAddress DeliveryAddress
Résultat System.Xml.Linq.XDocument

AddFeedback() public méthode

Adds feedback to a listing. POST

REQUIRES AUTHENTICATION.
public AddFeedback ( FeedbackRequest request ) : System.Xml.Linq.XDocument
request FeedbackRequest FeedbackRequest
Résultat System.Xml.Linq.XDocument

AddMemberToBlackList() public méthode

Adds a member to the authenticated user’s blacklist. POST

REQUIRES AUTHENTICATION.
public AddMemberToBlackList ( BlacklistRequest request ) : System.Xml.Linq.XDocument
request BlacklistRequest BlacklistRequest
Résultat System.Xml.Linq.XDocument

AddNote() public méthode

Performs the My Trade Me Method: Creates or updates the note on a listing. POST

REQUIRES AUTHENTICATION.
public AddNote ( SaveNoteRequest request ) : System.Xml.Linq.XDocument
request SaveNoteRequest SaveNoteRequest.
Résultat System.Xml.Linq.XDocument

AddPhotoToListing() public méthode

Performs the Photo Method: Adds a photo to an auction. The currently authenticated user must be the seller.Remove a photo.

REQUIRES AUTHENTICATION.
public AddPhotoToListing ( string photoId, string listingId ) : System.Xml.Linq.XDocument
photoId string The id of the photo to add.
listingId string The ID of the listing to add the photo to.
Résultat System.Xml.Linq.XDocument

AnswerSpecificQuestion() public méthode

Performs the Listing Method: Provide an answer for a specific question.

Serializes the given ListingAnswerQuestion into xml. Creates a query string using the parameters provided.

All the parameters are required.

REQUIRES AUTHENTICATION.
public AnswerSpecificQuestion ( ListingAnswerQuestion answerQuestion, string listingId, string questionId ) : System.Xml.Linq.XDocument
answerQuestion ListingAnswerQuestion The object that will be serialized into xml and then sent in a POST message.
listingId string The id of the listing that has the question being answered.
questionId string The id of the question being answered.
Résultat System.Xml.Linq.XDocument

AuthenticateWithVerificationCode() public méthode

This is the second and final step in the authorisation process. It uses the verification code (retrieved in public string GetVerificationCode()).

It exchanges the verification code for an access token.

Once this step has been performed the user will be enabled to perform authenticated requests.

public AuthenticateWithVerificationCode ( string code ) : void
code string The verification code.
Résultat void

AuthenticatedQuery() public méthode

Performs the query specified in the "query" string to perform a request that requires authorization.

This method requires that either an accessToken has been set manually or that the GetVerificationCode() and AuthenticateWithVerificationCode(string code) methods have been called previously.

It returns the IConsumerRequest fully enabled to make the request specified in the "query" string.

public AuthenticatedQuery ( string query ) : IConsumerRequest
query string The query string that will be added to the url and used to connect to the API with.
Résultat IConsumerRequest

BidRequest() public méthode

Performs the Bidding Method: Place a bid request.

Serializes the given BidRequest into xml and sends the message.

REQUIRES AUTHENTICATION.
public BidRequest ( BidRequest request ) : System.Xml.Linq.XDocument
request BidRequest The object that will be serialized into xml and then sent in a POST message.
Résultat System.Xml.Linq.XDocument

BuyNowRequest() public méthode

Performs the Bidding Method: Place a Buy Now request.

Serializes the given BuyNowRequest into xml and sends the message.

REQUIRES AUTHENTICATION.
public BuyNowRequest ( BuyNowRequest request ) : System.Xml.Linq.XDocument
request BuyNowRequest The object that will be serialized into xml and then sent in a POST message.
Résultat System.Xml.Linq.XDocument

Client() public méthode

Initializes a new instance of the Client class.
public Client ( ) : System
Résultat System

Client() public méthode

Initializes a new instance of the Client class.
public Client ( string consumerKey, string consumerSecret ) : System
consumerKey string The consumer key.
consumerSecret string The consumer secret.
Résultat System

Client() public méthode

Initializes a new instance of the Client class.
public Client ( string consumerKey, string consumerSecret, IToken accessToken ) : System
consumerKey string The consumer key.
consumerSecret string The consumer secret.
accessToken IToken The access token.
Résultat System

Client() public méthode

Initializes a new instance of the Client class.
public Client ( string consumerKey, string consumerSecret, string scopeOfRequest ) : System
consumerKey string The consumer key.
consumerSecret string The consumer secret.
scopeOfRequest string The scope of the requests that can be made.
Résultat System

CommentOnListing() public méthode

Performs the Listing Method: Post a comment on a listing.

Serializes the given ListingAddComment into xml. Creates a query string using the listingId provided .

All the parameters are required.

REQUIRES AUTHENTICATION.
public CommentOnListing ( ListingAddComment addComment, string listingId ) : System.Xml.Linq.XDocument
addComment ListingAddComment The object that will be serialized into xml and then sent in a POST message.
listingId string The id of the listing the comment should be added to.
Résultat System.Xml.Linq.XDocument

DeleteDeliveryAddress() public méthode

Removes a delivery address from the authenticated user’s profile. (DELETE).

REQUIRES AUTHENTICATION.
public DeleteDeliveryAddress ( string deliveryId ) : System.Xml.Linq.XDocument
deliveryId string deliveryId
Résultat System.Xml.Linq.XDocument

DeleteListingFromWatchlist() public méthode

Performs the My Trade Me Method: Save a listing to a member’s watchlist (DELETE).

Will remove the listing with the listingId provided from the members watchlist. Creates a query string using the listingId provided.

REQUIRES AUTHENTICATION.
public DeleteListingFromWatchlist ( string listingId ) : System.Xml.Linq.XDocument
listingId string The id of the listing that will be removed from the watchlist.
Résultat System.Xml.Linq.XDocument

DeleteListingStatus() public méthode

Performs the My Trade Me Method: Deletes the status from a listing in the authenticated user’s Sold Items list. (DELETE).

REQUIRES AUTHENTICATION.
public DeleteListingStatus ( string purchaseId ) : System.Xml.Linq.XDocument
purchaseId string The ID of the purchase to modify.
Résultat System.Xml.Linq.XDocument

DeleteListingStatus() public méthode

Performs the My Trade Me Method: Deletes the status from a listing in the authenticated user’s Sold Items list. (DELETE).

REQUIRES AUTHENTICATION.
public DeleteListingStatus ( string listingId, string offerId ) : System.Xml.Linq.XDocument
listingId string The id of the listing that will be removed from the watchlist.
offerId string The ID of the note.
Résultat System.Xml.Linq.XDocument

DeleteNote() public méthode

Performs the My Trade Me Method: Removes the note from a listing. DELETE

REQUIRES AUTHENTICATION.
public DeleteNote ( string listingId, string noteId, string offerId ) : System.Xml.Linq.XDocument
listingId string The id of the listing that will be removed from the watchlist.
noteId string The ID of the note.
offerId string The ID of the offer the note is associated with. Should be 0 if the note is not associated with a fixed price offer.
Résultat System.Xml.Linq.XDocument

EditListedItem() public méthode

Edit an auction or classified that you have created.

You will need to resubmit the complete sell form as used when you created the listing but with the fields you wish to edit modified. Request format will error if fields are locked and cannot be edited.

REQUIRES AUTHENTICATION.
public EditListedItem ( EditListingRequest request ) : System.Xml.Linq.XDocument
request EditListingRequest The object that will be serialized into xml and then sent in a POST message.
Résultat System.Xml.Linq.XDocument

EmailFriend() public méthode

Performs the Listing Method: Send an email regarding an auction to a friend.

Serializes the given EmailFriendRequest into xml. Creates a query string using the listingId provided .

All the parameters are required.

REQUIRES AUTHENTICATION.
public EmailFriend ( EmailFriendRequest email, string listingId ) : System.Xml.Linq.XDocument
email EmailFriendRequest The object that will be serialized into xml and then sent in a POST message.
listingId string The id of the listing you want to email about.
Résultat System.Xml.Linq.XDocument

EmailSellerOfClassified() public méthode

Performs the Listing Method: Send an email to the seller of a classified.

Serializes the given EmailRequest into xml. Creates a query string using the listingId provided .

All the parameters are required.

REQUIRES AUTHENTICATION.
public EmailSellerOfClassified ( EmailRequest emailRequest, string listingId ) : System.Xml.Linq.XDocument
emailRequest EmailRequest The object that will be serialized into xml and then sent in a POST message.
listingId string The id of the listing that youwant to email about.
Résultat System.Xml.Linq.XDocument

FixedPriceOffers() public méthode

Performs the My Trade Me Method: Retrieve a list of Fixed Price Offers.

Creates a query string and performs the request.

REQUIRES AUTHENTICATION.
public FixedPriceOffers ( ) : FixedPriceOffers
Résultat FixedPriceOffers

FixedPriceOffers() public méthode

Performs the Fixed Price Offer Method: Retrieve a list of Fixed Price Offers

using the "query" string provided - should be the "MyTradeMe/FixedPriceOffers.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

REQUIRES AUTHENTICATION.
public FixedPriceOffers ( string query ) : FixedPriceOffers
query string The query string that will be added to the base url and used to connect to the API.
Résultat FixedPriceOffers

FixedPriceOffersByMember() public méthode

Performs the Fixed Price Offer Method: Retrieve the fixed price offers offered by a member. GET

Creates a query string and performs the request.

REQUIRES AUTHENTICATION.
public FixedPriceOffersByMember ( ) : FixedPriceOffers
Résultat FixedPriceOffers

FixedPriceOffersToMember() public méthode

Performs the Fixed Price Offer Method: Retrieve a list of Fixed Price Offers.

Creates a query string and performs the request.

REQUIRES AUTHENTICATION.
public FixedPriceOffersToMember ( ) : FixedPriceOffers
Résultat FixedPriceOffers

GetBlacklistedMembers() public méthode

Retrieves a list of all the members on the authenticated user’s blacklist. GET

REQUIRES AUTHENTICATION.
public GetBlacklistedMembers ( ) : Blacklist
Résultat Blacklist

GetClosingSoonListings() public méthode

Performs the Listing Method: Retrieves the items closing soon for the whole country or for a single region. GET

DOES NOT REQUIRE AUTHENTICATION.
public GetClosingSoonListings ( ) : ClosingSoonListings
Résultat ClosingSoonListings

GetComplaintSubjects() public méthode

Performs the category method: Retrieves a list of possible complaint subjects. This is used in conjunction with the send a complaint API. GET

DOES NOT REQUIRE AUTHENTICATION.
public GetComplaintSubjects ( ) : ComplaintSubjectCollection
Résultat ComplaintSubjectCollection

GetEmailPreferences() public méthode

Retrieves the authenticated user’s email preferences. GET

REQUIRES AUTHENTICATION.
public GetEmailPreferences ( ) : EmailOptions
Résultat EmailOptions

GetFeaturedListings() public méthode

Performs the Listing Method: Retrieves the featured listings for the whole country or for a single region. GET

DOES NOT REQUIRE AUTHENTICATION.
public GetFeaturedListings ( ) : FeaturedListings
Résultat FeaturedListings

GetFeesForListingItems() public méthode

Returns the fees that will be charged for a listing once the auction or classified has been created.

There are several endpoints that should be used to get information needed to list an item. Check Category information, Legal Notice information, attributes, fees and listing duration options.

REQUIRES AUTHENTICATION.
public GetFeesForListingItems ( ListingRequest request ) : System.Xml.Linq.XDocument
request ListingRequest The object that will be serialized into xml and then sent in a POST message.
Résultat System.Xml.Linq.XDocument

GetHotListings() public méthode

Performs the Listing Method: Retrieves the hot items for the whole country or for a single region. GET

DOES NOT REQUIRE AUTHENTICATION.
public GetHotListings ( ) : HotListings
Résultat HotListings

GetJobAgentReport() public méthode

Retrieves the Job Agent report for the authenticated user.

REQUIRES AUTHENTICATION.
public GetJobAgentReport ( ) : JobAgentReport
Résultat JobAgentReport

GetLatestListings() public méthode

Performs the Listing Method: Retrieves the latest listed items for the whole country or for a single region. GET

DOES NOT REQUIRE AUTHENTICATION.
public GetLatestListings ( ) : LatestListings
Résultat LatestListings

GetLisingFees() public méthode

Retrieves information about fees for a single listing.

REQUIRES AUTHENTICATION.
public GetLisingFees ( string listingId ) : SellingFee
listingId string The ID of listing
Résultat SellingFee

GetListOfDeliveryAddresses() public méthode

Retrieves a list of delivery addresses for the authenticated user. (GET)

REQUIRES AUTHENTICATION.
public GetListOfDeliveryAddresses ( ) : Address
Résultat Address

GetMotorbikeMakes() public méthode

Performs the category method: Retrieves a list of all motorbike makes. Can be used when searching. GET

DOES NOT REQUIRE AUTHENTICATION.
public GetMotorbikeMakes ( ) : MotorbikeMakeCollection
Résultat MotorbikeMakeCollection

GetNote() public méthode

Retrieves the note for a listing, if there is one. GET

REQUIRES AUTHENTICATION.
public GetNote ( string listingId ) : NoteResponse
listingId string The ID of the listing to retrieve the note for.
Résultat NoteResponse

GetOneDollarListings() public méthode

Performs the Listing Method: Retrieves the items with one dollar reserves for the whole country or for a single region. GET

DOES NOT REQUIRE AUTHENTICATION.
public GetOneDollarListings ( ) : OneDollarListings
Résultat OneDollarListings

GetPayNowLedgerBySettlement() public méthode

Returns Pay Now ledger entries for a settlement into the authenticated user’s bank account.

REQUIRES AUTHENTICATION.
public GetPayNowLedgerBySettlement ( string batchId ) : PayNowLedger
batchId string The ID of the settlement. This can be retrieved from the Pay Now ledger API.
Résultat PayNowLedger

GetProductMappings() public méthode

Retrieves a list of product codes and stock levels associated with the authenticated user’s active listings. The results will return data from feeds and My Products.

REQUIRES AUTHENTICATION.
public GetProductMappings ( ) : ProductMappings
Résultat ProductMappings

GetPropertyAgentReport() public méthode

Retrieves the Property Agent report for the authenticated user.

REQUIRES AUTHENTICATION.
public GetPropertyAgentReport ( ) : PropertyAgentReport
Résultat PropertyAgentReport

GetVerificationCode() public méthode

Performs the first step in the authorisation handshake. It requests a verification code from the TradeMeApi.
public GetVerificationCode ( ) : string
Résultat string

GetWeeklySalesStats() public méthode

Retrieve sales statistics for the authenticated user.

REQUIRES AUTHENTICATION.
public GetWeeklySalesStats ( ) : WeeklySales
Résultat WeeklySales

ListItem() public méthode

Starts a new auction or classified.

There are several endpoints that should be used to get information needed to list an item. Check Category information, Legal Notice information, attributes, fees and listing duration options.

REQUIRES AUTHENTICATION.
public ListItem ( ListingRequest request ) : System.Xml.Linq.XDocument
request ListingRequest The object that will be serialized into xml and then sent in a POST message.
Résultat System.Xml.Linq.XDocument

ListingDetail() public méthode

Performs the Listing Method: Retrieve the details of a single listing

using the "query" string provided - should be the "Listings/{listing_id}.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.
public ListingDetail ( string query ) : ListedItemDetail
query string The query string that will be added to the base url and used to connect to the API with.
Résultat ListedItemDetail

ListingDetailById() public méthode

Performs the Listing Method: Retrieve the details of a single listing.

Creates a query string using the listing id parameter provided.

DOES NOT REQUIRE AUTHENTICATION.
public ListingDetailById ( string id ) : ListedItemDetail
id string The listing id.
Résultat ListedItemDetail

LostItems() public méthode

Performs the My Trade Me Method: Retrieve a list of lost items.

Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

REQUIRES AUTHENTICATION.
public LostItems ( LostItemsCriteria criteria, string page, string rows ) : Listings
criteria LostItemsCriteria The criteria.
page string Page number.
rows string Number of rows per page.
Résultat Listings

LostItems() public méthode

Performs the My Trade Me Method: Retrieve a list of lost items

using the "query" string provided - should be the "MyTradeMe/Lost.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

REQUIRES AUTHENTICATION.
public LostItems ( string query ) : Listings
query string The query string that will be added to the base url and used to connect to the API with.
Résultat Listings

MakeFixedPriceOffer() public méthode

Performs the Fixed Price Offer Method: Makes a fixed price offer for an auction to the specified members. POST

REQUIRES AUTHENTICATION.
public MakeFixedPriceOffer ( FixedPriceOfferToMembersRequest request ) : System.Xml.Linq.XDocument
request FixedPriceOfferToMembersRequest The object that will be serialized into xml and then sent in a POST message.
Résultat System.Xml.Linq.XDocument

MemberFeedbackById() public méthode

Performs the Membership Method: Retrieve feedback for a member.

Creates a query string using the parameters provided - the criteria parameter can be null if it is not required for the request.

DOES NOT REQUIRE AUTHENTICATION.
public MemberFeedbackById ( string id, MemberFeedbackCriteria criteria ) : Feedback
id string The members id.
criteria MemberFeedbackCriteria The criteria.
Résultat Feedback

MemberFeedbackByQueryString() public méthode

Performs the Membership Method: Retrieve feedback for a member

using the "query" string provided - should be the "Search/Member/{member_id}/Feedback.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.
public MemberFeedbackByQueryString ( string query ) : Feedback
query string The query string that will be added to the base url and used to connect to the API with.
Résultat Feedback

MemberFeedbackCountById() public méthode

Performs the membership method: Retrieve member feedback summary (counts).

Creates a query string using the member id provided.

DOES NOT REQUIRE AUTHENTICATION.
public MemberFeedbackCountById ( string id ) : FeedbackCount
id string The members id.
Résultat FeedbackCount

MemberFeedbackCountByQueryString() public méthode

Performs the membership method: Retrieve member feedback summary (counts) using the "query" string provided - should be the "Search/Member/{member_id}/FeedbackCount.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.
public MemberFeedbackCountByQueryString ( string query ) : FeedbackCount
query string The query string that will be added to the base url and used to connect to the API with.
Résultat FeedbackCount

MemberId() public méthode

Performs the Membership Method: Retrieve member ID

using the "query" string provided - should be the "Member/{member_nickname}.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.
public MemberId ( string query ) : MemberId
query string The query string that will be added to the base url and used to connect to the API with.
Résultat MemberId

MemberIdByNickname() public méthode

Performs the Membership Method: Retrieve member ID.

Creates a query string using the nickname parameter provided

DOES NOT REQUIRE AUTHENTICATION.
public MemberIdByNickname ( string nickname ) : MemberId
nickname string The members nickname.
Résultat MemberId

MemberLedger() public méthode

Performs the My Trade Me method: Retrieve a member’s ledger.

Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

REQUIRES AUTHENTICATION.
public MemberLedger ( MemberLedgerCriteria criteria, string page, string rows ) : MemberLedger
criteria MemberLedgerCriteria The criteria.
page string Page number.
rows string Number of rows per page.
Résultat MemberLedger

MemberLedger() public méthode

Performs the My Trade Me method: Retrieve a member’s ledger

using the "query" string provided - should be the "MyTradeMe/MemberLedger/All.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

REQUIRES AUTHENTICATION.
public MemberLedger ( string query ) : MemberLedger
query string The query string that will be added to the base url and used to connect to the API.
Résultat MemberLedger

MemberListings() public méthode

Performs the Membership Method: Retrieve a member’s listings

using the "query" string provided - should be the "Member/{member_id}/Listings.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.
public MemberListings ( string query ) : Listings
query string The query string that will be added to the base url and used to connect to the API with.
Résultat Listings

MemberListingsById() public méthode

Performs the Membership Method: Retrieve a member’s listings.

Creates a query string using the parameters provided.

DOES NOT REQUIRE AUTHENTICATION.
public MemberListingsById ( string id ) : Listings
id string The members id.
Résultat Listings

MemberPhotos() public méthode

Performs the Photo Method: Retrieve a list of member photos.

Creates a query string and performs the request.

REQUIRES AUTHENTICATION.

public MemberPhotos ( ) : MemberPhotos
Résultat MemberPhotos

MemberPhotos() public méthode

Performs the Photo Method: Retrieve a list of member photos

using the "query" string provided - should be the "Photos.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

REQUIRES AUTHENTICATION.
public MemberPhotos ( string query ) : MemberPhotos
query string The query string that will be added to the base url and used to connect to the API.
Résultat MemberPhotos

MemberProfileById() public méthode

Performs the membership method: Retrieve a member’s profile data. Creates a query string using the member id provided.

DOES NOT REQUIRE AUTHENTICATION.
public MemberProfileById ( string id ) : MemberProfile
id string The members id.
Résultat MemberProfile

MemberProfileByQueryString() public méthode

Performs the membership method: Retrieve a member’s profile data using the "query" string provided - should be the "Member/{member_id}/Profile.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.
public MemberProfileByQueryString ( string query ) : MemberProfile
query string The query string that will be added to the base url and used to connect to the API with.
Résultat MemberProfile

PayNowLedger() public méthode

Performs the My Trade Me Method: Retrieve a member’s Pay Now ledger

using the "query" string provided - should be the "MyTradeMe/PayNowLedger/{criteria}.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

REQUIRES AUTHENTICATION.
public PayNowLedger ( string query ) : PayNowLedger
query string The query string that will be added to the base url and used to connect to the API.
Résultat PayNowLedger

PayNowLedgerWithCriteria() public méthode

Performs the My Trade Me Method: Retrieve a member’s Pay Now ledger.

Creates a query string using the parameter provided - parameter can be null if it is not required for the request.

REQUIRES AUTHENTICATION.
public PayNowLedgerWithCriteria ( PayNowLedgerCriteria criteria ) : PayNowLedger
criteria PayNowLedgerCriteria The criteria.
Résultat PayNowLedger

Post() public méthode

It serializes the toSend object into xml and sends the post message specified in the "to" string using an authorized connection. It returns the response from the server as an XDocument.

REQUIRES AUTHENTICATION.
public Post ( object toSend, string to ) : System.Xml.Linq.XDocument
toSend object The object that will be serialized into xml and sent.
to string The url the post message will be sent to.
Résultat System.Xml.Linq.XDocument

Post() public méthode

It serializes the toSend object into xml and sends the post message specified in the "to" string using an authorized connection. It returns the response from the server as an XDocument.

REQUIRES AUTHENTICATION.
public Post ( object toSend, string to, bool delete ) : System.Xml.Linq.XDocument
toSend object The object that will be serialized into xml and then sent in the post message.
to string The query string that will be added to the base url and used to connect to the API.
delete bool True if you want the request to be of the method DELETE instead of POST.
Résultat System.Xml.Linq.XDocument

RefundPayNowPayment() public méthode

Refunds a Pay Now payment where the authenticated user is the seller. POST

REQUIRES AUTHENTICATION.
public RefundPayNowPayment ( PayNowRefundRequest request ) : System.Xml.Linq.XDocument
request PayNowRefundRequest PayNowRefundRequest
Résultat System.Xml.Linq.XDocument

RelistItem() public méthode

Relist an item that has expired. Relists an item without modifying editable fields.

Relist copies all data from original listing and applies them to the new listing. The only exceptions are where there are default durations that are applied on relisted items.

REQUIRES AUTHENTICATION.
public RelistItem ( RelistListingRequest request ) : System.Xml.Linq.XDocument
request RelistListingRequest The object that will be serialized into xml and then sent in a POST message.
Résultat System.Xml.Linq.XDocument

RemoveFeedback() public méthode

Removes feedback the authenticated user has posted against a listing. DELETE

REQUIRES AUTHENTICATION.
public RemoveFeedback ( string feedbackId ) : System.Xml.Linq.XDocument
feedbackId string The ID of the feedback to remove.
Résultat System.Xml.Linq.XDocument

RemoveMemberFromBlacklist() public méthode

Removes a member from the authenticated user’s blacklist. DELETE

REQUIRES AUTHENTICATION.
public RemoveMemberFromBlacklist ( string memberId ) : System.Xml.Linq.XDocument
memberId string memberId
Résultat System.Xml.Linq.XDocument

RemovePhoto() public méthode

Performs the Photo Method: Remove a photo.

Creates a query string using the photo id provided.

REQUIRES AUTHENTICATION.
public RemovePhoto ( string photoId ) : string
photoId string The id of the photo to be removed.
Résultat string

RemoveSavedFavorite() public méthode

Performs the Favourites method: Deletes a saved search, category or seller from the currently authenticated user’s favourites. DELETE

REQUIRES AUTHENTICATION.
public RemoveSavedFavorite ( string favoriteId, string type ) : System.Xml.Linq.XDocument
favoriteId string The ID of the favourite.
type string The type of favourite (must be “Category”, “Search”, “AttributeSearch” or “Seller”).
Résultat System.Xml.Linq.XDocument

RespondToFeedback() public méthode

Replies to feedback placed against a listing where the authenticated user was the seller. POST

REQUIRES AUTHENTICATION.
public RespondToFeedback ( FeedbackReplyRequest request ) : System.Xml.Linq.XDocument
request FeedbackReplyRequest FeedbackReplyRequest
Résultat System.Xml.Linq.XDocument

RespondToFixedPriceOffer() public méthode

Performs the Fixed Price Offer Method: Accepts or rejects a fixed price offer. POST

REQUIRES AUTHENTICATION.
public RespondToFixedPriceOffer ( FixedPriceOfferRequest request ) : System.Xml.Linq.XDocument
request FixedPriceOfferRequest The object that will be serialized into xml and then sent in a POST message.
Résultat System.Xml.Linq.XDocument

RetrieveAttributesForCategory() public méthode

Performs the category method: Retrieves the list of attributes which are applicable to a specific category.

DOES NOT REQUIRE AUTHENTICATION.
public RetrieveAttributesForCategory ( string categoryNumber ) : Attributes
categoryNumber string The category number for which you wish to see the attributes for. /// This must be a leaf category (for example, you cannot view the attributes for Computers > Desktops, /// but you can for Computers > Desktops > CRT monitors).
Résultat Attributes

RetrieveBluRayIds() public méthode

Performs the category method: Returns a the list of Blu-ray catalogue ID numbers. You can use this list to validate the catalogue ID before listing a Blu-ray. GET

DOES NOT REQUIRE AUTHENTICATION.
public RetrieveBluRayIds ( ) : BluRayValidations
Résultat BluRayValidations

RetrieveCategories() public méthode

Performs the category methods: Retrieve a list of all or part of our category tree.

DOES NOT REQUIRE AUTHENTICATION.
public RetrieveCategories ( ) : Category
Résultat Category

RetrieveCategoriesById() public méthode

Performs the category methods: Retrieve a list of all or part of our category tree. Does this by using the id string provided - should be the id of the category you wish to retrieve.

DOES NOT REQUIRE AUTHENTICATION.
public RetrieveCategoriesById ( string id ) : Category
id string The id of the category you wish to retrieve.
Résultat Category

RetrieveCategoriesByQueryString() public méthode

Performs the category methods: Retrieve a list of all or part of our category tree, Retrieve a list of Trade Me Motors used car categories, Retrieve a list of Trade Me Motors motorbike categories, using the "query" string provided - should be the "Categories/UsedCars.xml" part of the url it shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.
public RetrieveCategoriesByQueryString ( string query ) : Category
query string The query string that will be added to the base url and used to connect to the API with.
Résultat Category

RetrieveDurationOptionsForCategory() public méthode

Performs the category method: Retrieves the default duration and the duration options that are available for listings in a specific category. GET

DOES NOT REQUIRE AUTHENTICATION.
public RetrieveDurationOptionsForCategory ( string categoryNumber ) : ListingDurations
categoryNumber string The number of the category to retrieve durations for.
Résultat ListingDurations

RetrieveDvdIds() public méthode

Performs the category method: Returns a list of DVD catalogue ID numbers. You can use this list to validate the catalogue ID before listing a DVD. GET

DOES NOT REQUIRE AUTHENTICATION.
public RetrieveDvdIds ( ) : DvdValidations
Résultat DvdValidations

RetrieveFavouriteCategories() public méthode

Performs the Favourites Method: Retrieve Favourite Categories.

REQUIRES AUTHENTICATION.
public RetrieveFavouriteCategories ( ) : SavedCategories
Résultat SavedCategories

RetrieveFavouriteSearches() public méthode

Performs the Favourites Method: Retrieve Favourite Searches.

REQURIES AUTHENTICATION.
public RetrieveFavouriteSearches ( SavedSearchType filter ) : SavedSearches
filter SavedSearchType The filter for the favourite searches.
Résultat SavedSearches

RetrieveFavouriteSellers() public méthode

Performs the Favourites method: Retrieve Favourite Sellers.

REQUIRES AUTHENTICATION.
public RetrieveFavouriteSellers ( ) : SavedSellers
Résultat SavedSellers

RetrieveFeesForCategory() public méthode

Performs the category method: Retrieves a list of fees for a specific category. GET

DOES NOT REQUIRE AUTHENTICATION.
public RetrieveFeesForCategory ( string categoryNumber ) : ListingFees
categoryNumber string The number of the category to retrieve fees for.
Résultat ListingFees

RetrieveJobCategories() public méthode

Performs the category method: Retrieve a list of Trade Me Jobs categories.

DOES NOT REQUIRE AUTHENTICATION.
public RetrieveJobCategories ( ) : JobCategories
Résultat JobCategories

RetrieveLegalNoticeForCategory() public méthode

Performs the category method: Retrieves the legal notice that the user is required to agree to before listing. GET

DOES NOT REQUIRE AUTHENTICATION.
public RetrieveLegalNoticeForCategory ( string categoryNumber ) : LegalNotice
categoryNumber string The category number for which you wish to see the legal notice for. /// The number of the category to retrieve the legal notice for. This must be a leaf category /// (for example, you cannot view the legal notice for Business, Farming and Industry, but you can /// for Business, Farming and Industry > Carbon credits).
Résultat LegalNotice

RetrieveListOfMembersForFixedPriceOffer() public méthode

Performs the Fixed Price Offer method: Returns a list of members you can make a fixed price offer to for a particular auction. GET

REQUIRE AUTHENTICATION.
public RetrieveListOfMembersForFixedPriceOffer ( string listingId, string filter ) : FixedPriceOfferMembersResponse
listingId string The listing ID of the auction you wish to make a fixed price offer for. The listing must be closed.
filter string Filters the returned list to a subset of possible members /// (“All”, “Bidders” – only return bidders, “Watchers” – only return watchers).
Résultat FixedPriceOfferMembersResponse

RetrieveLocalities() public méthode

Performs the Localities methods: three-tier locality dataset, two-tier locality dataset,

using the "query" string provided - should be the "Localities.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.
public RetrieveLocalities ( string query ) : LocalityCollection
query string The query string that will be added to the base url and used to connect to the API with.
Résultat LocalityCollection

RetrieveLocalitiesThreeTier() public méthode

Performs the Localities methods: three-tier locality dataset

Returns three-tier locality hierarchy of regions, districts and their respective suburbs. These values are used in Trade Me Property, Trade Me Jobs and Services.

DOES NOT REQUIRE AUTHENTICATION.
public RetrieveLocalitiesThreeTier ( ) : LocalityCollection
Résultat LocalityCollection

RetrieveLocalitiesTwoTier() public méthode

Performs the Localities method: two-tier locality dataset.

Returns list of towns used in member registration. This information is displayed on member profile as “suburb” and also on listings where the approximate location of goods is important, such as in Trade Me Motors.

DOES NOT REQUIRE AUTHENTICATION.
public RetrieveLocalitiesTwoTier ( ) : LocalityCollection
Résultat LocalityCollection

RetrieveMotorBikeCategories() public méthode

Performs the category methods: Retrieve a list of Trade Me Motors motorbike categories.

DOES NOT REQUIRE AUTHENTICATION.
public RetrieveMotorBikeCategories ( ) : Category
Résultat Category

RetrieveTravelLocalities() public méthode

Performs the category method: Returns a list of districts and suburbs as used by TradeMe travel. GET

DOES NOT REQUIRE AUTHENTICATION.
public RetrieveTravelLocalities ( ) : LocalityCollection
Résultat LocalityCollection

RetrieveUsedCarCategories() public méthode

Performs the category methods: Retrieve a list of Trade Me Motors used car categories.

DOES NOT REQUIRE AUTHENTICATION.
public RetrieveUsedCarCategories ( ) : Category
Résultat Category

SaveCategory() public méthode

Performs the Favourites method: Save Category.

Serializes the given SaveCategoryRequest into xml.

REQUIRES AUTHENTICATION.
public SaveCategory ( SaveCategoryRequest saveCategory ) : System.Xml.Linq.XDocument
saveCategory SaveCategoryRequest The object that will be serialized into xml and then sent in a POST message.
Résultat System.Xml.Linq.XDocument

SaveListingToWatchlist() public méthode

Performs the My Trade Me Method: Adds a listing to the authenticated user’s watchlist with the option to control when and if an email is sent to the member warning that the auction is closing soon.

REQUIRES AUTHENTICATION.
public SaveListingToWatchlist ( SaveToWatchlistRequest request ) : System.Xml.Linq.XDocument
request SaveToWatchlistRequest SaveToWatchlistRequest.
Résultat System.Xml.Linq.XDocument

SaveOrUpdateListingStatus() public méthode

Saves a status to a listing in the authenticated user’s Sold Items list. (POST)

REQUIRES AUTHENTICATION.
public SaveOrUpdateListingStatus ( string purchaseId, string stat ) : StatusResponse
purchaseId string The ID of the purchase.
stat string The status you want to save, should be one of the following: EmailSent, PaymentReceived, GoodsShipped, SaleCompleted.
Résultat StatusResponse

SaveOrUpdateListingStatus() public méthode

Saves a status to a listing in the authenticated user’s Sold Items list. (POST)

REQUIRES AUTHENTICATION.
public SaveOrUpdateListingStatus ( string listingId, string offerId, string stat ) : StatusResponse
listingId string The id of the listing that will be removed from the watchlist.
offerId string The ID of the note.
stat string The status you want to save, should be one of the following: EmailSent, PaymentReceived, GoodsShipped, SaleCompleted.
Résultat StatusResponse

SaveSearch() public méthode

Performs the Favourites method: Save Search.

Serializes the given SaveSearchRequest into xml.

REQUIRES AUTHENTICATION.
public SaveSearch ( SaveSearchRequest saveSearch ) : System.Xml.Linq.XDocument
saveSearch SaveSearchRequest The object that will be serialized into xml and then sent in a POST message.
Résultat System.Xml.Linq.XDocument

SaveSeller() public méthode

Performs the Favourites method: Save Seller.

Serializes the given SaveSellerRequest into xml.

REQUIRES AUTHENTICATION.
public SaveSeller ( SaveSellerRequest saveSeller ) : System.Xml.Linq.XDocument
saveSeller SaveSellerRequest The object that will be serialized into xml and then sent in a POST message.
Résultat System.Xml.Linq.XDocument

SearchBluRayCatalog() public méthode

Performs the category method: Searches the Trade Me Blu-ray catalogue for movie titles. GET

DOES NOT REQUIRE AUTHENTICATION.
public SearchBluRayCatalog ( String search = "" ) : MovieTitles
search String The partial title to search for.
Résultat MovieTitles

SearchCommercialLeaseProperties() public méthode

Performs the search method: Search Commercial Lease Property. Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

DOES NOT REQUIRE AUTHENTICATION.
public SearchCommercialLeaseProperties ( string searchString, PropertySortOrder sortOrder, int page, int rows, int region, int district, int suburb, System.DateTime dateFrom, int priceMin, int priceMax, int areaMax, int areaMin, int landAreaMin, int landAreaMax, bool adjacentSuburbs, PropertyUsage usage ) : global::Properties
searchString string One or more keywords to use in a search query.
sortOrder PropertySortOrder Sort the returned record-set by a single specified sort order.
page int Page number.
rows int Number of rows per page.
region int Specifies the search region ID.
district int Specifies the search district ID.
suburb int Specifies the search suburb ID.
dateFrom System.DateTime Specifies minimum start date for returned listings.
priceMin int Minimum property price.
priceMax int Maximum property price.
areaMax int Maximum floor area in square meters.
areaMin int Minimum floor area in square meters.
landAreaMin int Minimum land area in square meters.
landAreaMax int Maximum land area in square meters.
adjacentSuburbs bool Indicates whether the search should include listings in adjacent suburbs.
usage PropertyUsage The usage of the property.
Résultat global::Properties

SearchCommercialSaleProperties() public méthode

Performs the search method: Search Commercial Property. Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

DOES NOT REQUIRE AUTHENTICATION.
public SearchCommercialSaleProperties ( string searchString, PropertySortOrder sortOrder, int page, int rows, int region, int district, int suburb, System.DateTime dateFrom, int priceMin, int priceMax, int bathroomsMin, int bathroomsMax, int bedroomsMin, int bedroomsMax, int areaMax, int areaMin, int landAreaMin, int landAreaMax, bool adjacentSuburbs, PropertyUsage usage ) : global::Properties
searchString string One or more keywords to use in a search query.
sortOrder PropertySortOrder Sort the returned record-set by a single specified sort order.
page int Page number.
rows int Number of rows per page.
region int Specifies the search region ID.
district int Specifies the search district ID.
suburb int Specifies the search suburb ID.
dateFrom System.DateTime Specifies minimum start date for returned listings.
priceMin int Minimum property price.
priceMax int Maximum property price.
bathroomsMin int Minimum number of bathrooms.
bathroomsMax int Maximum number of bathrooms.
bedroomsMin int Minimum number of bedrooms.
bedroomsMax int Maximum number of bedrooms.
areaMax int Maximum floor area in square meters.
areaMin int Minimum floor area in square meters.
landAreaMin int Minimum land area in square meters.
landAreaMax int Maximum land area in square meters.
adjacentSuburbs bool Indicates whether the search should include listings in adjacent suburbs.
usage PropertyUsage The usage of the property.
Résultat global::Properties

SearchDvdCatalog() public méthode

Performs the category method: Searches the Trade Me DVD catalogue for movie titles. GET

DOES NOT REQUIRE AUTHENTICATION.
public SearchDvdCatalog ( String search = "" ) : MovieTitles
search String The partial title to search for.
Résultat MovieTitles

SearchFlatmates() public méthode

Performs the Search Method: Search for Flatmate using the "query" string provided - should be the "Search/Flatmates.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.
public SearchFlatmates ( string query ) : Flatmates
query string The query string that will be added to the base url and used to connect to the API.
Résultat Flatmates

SearchFlatmates() public méthode

Performs the Search Method: Search for Flatmate Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

DOES NOT REQUIRE AUTHENTICATION.
public SearchFlatmates ( string searchString, PropertySortOrder sortOrder, int page, int rows, int region, int district, int suburb, System.DateTime dateFrom, int priceMin, int priceMax ) : Flatmates
searchString string One or more keywords to use in a search query.
sortOrder PropertySortOrder Sort the returned record-set by a single specified sort order.
page int Page number.
rows int Number of rows per page.
region int Specifies the search region ID.
district int Specifies the search district ID.
suburb int Specifies the search suburb ID.
dateFrom System.DateTime Specifies minimum start date for returned listings.
priceMin int Minimum property price.
priceMax int Maximum property price.
Résultat Flatmates

SearchGeneral() public méthode

Performs Search method: Search General using the "query" string provided - should be the "Search/General.xml?search_string=Playstation" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.
public SearchGeneral ( string query ) : SearchResults
query string The query string that will be added to the base url and used to connect to the API with.
Résultat SearchResults

SearchGeneral() public méthode

Performs Search method: Search General using the query paramaters provided it will construct a query string for you - can use null if the parameter is not required for your request.

DOES NOT REQUIRE AUTHENTICATION.
public SearchGeneral ( string category, string searchString, int userRegion, SortOrder sortOrder, bool buy, bool pay, System.Condition condition, System.DateTime dateFrom, int page, int rows, int memberListing ) : SearchResults
category string Specifies the category in which you want to perform the search.
searchString string One or more keywords to use in a search query.
userRegion int Restricts search results to items from sellers located in the specified region.
sortOrder SortOrder Sort the returned record-set by a single specified sort order.
buy bool Return only listings with BuyNow price.
pay bool Return only listings with PayNow.
condition System.Condition Filter listings by condition.
dateFrom System.DateTime Return only listings started from this date.
page int Page number.
rows int Number of rows per page.
memberListing int Returns only listing from specified member ID.
Résultat SearchResults

SearchJobs() public méthode

Performs the search method: Search Jobs

using the "query" string provided - should be the "Search/Jobs.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.
public SearchJobs ( string query ) : Jobs
query string The query string that will be added to the base url and used to connect to the API with.
Résultat Jobs

SearchJobs() public méthode

Performs the search method: Search Jobs.

Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

DOES NOT REQUIRE AUTHENTICATION.
public SearchJobs ( string searchString, SortOrder sortOrder, decimal salaryMin, decimal salaryMax, string region, string district, JobType type, string category, string subcategory, int page, int rows ) : Jobs
searchString string One or more keywords to use in a search query.
sortOrder SortOrder Sort the returned record-set by a single specified sort order.
salaryMin decimal Minimum salary.
salaryMax decimal Maximum salary.
region string Job offer region.
district string Job offer district.
type JobType Type of position.
category string Category.
subcategory string Subcategory.
page int Page number.
rows int Number of rows per page.
Résultat Jobs

SearchLifestyleProperties() public méthode

Performs the search method: Search Lifestyle Property. Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

DOES NOT REQUIRE AUTHENTICATION.
public SearchLifestyleProperties ( string searchString, PropertySortOrder sortOrder, int page, int rows, int region, int district, int suburb, System.DateTime dateFrom, int priceMin, int priceMax, int bathroomsMin, int bathroomsMax, int bedroomsMin, int bedroomsMax, int areaMax, int areaMin, int landAreaMin, int landAreaMax, bool adjacentSuburbs, LifestylePropertyUsage usage, LifestylePropertyType propertyType ) : global::Properties
searchString string One or more keywords to use in a search query.
sortOrder PropertySortOrder Sort the returned record-set by a single specified sort order.
page int Page number.
rows int Number of rows per page.
region int Specifies the search region ID.
district int Specifies the search district ID.
suburb int Specifies the search suburb ID.
dateFrom System.DateTime Specifies minimum start date for returned listings.
priceMin int Minimum property price.
priceMax int Maximum property price.
bathroomsMin int Minimum number of bathrooms.
bathroomsMax int Maximum number of bathrooms.
bedroomsMin int Minimum number of bedrooms.
bedroomsMax int Maximum number of bedrooms.
areaMax int Maximum floor area in square meters.
areaMin int Minimum floor area in square meters.
landAreaMin int Minimum land area in square meters.
landAreaMax int Maximum land area in square meters.
adjacentSuburbs bool Indicates whether the search should include listings in adjacent suburbs.
usage LifestylePropertyUsage The usage of the property.
propertyType LifestylePropertyType The type of the property.
Résultat global::Properties

SearchMotorBikes() public méthode

Performs the Search Method: Search Motor Bikes using the "query" string provided - should be the "Search/Motors/Bikes.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.
public SearchMotorBikes ( string query ) : MotorBikes
query string The query string that will be added to the base url and used to connect to the API.
Résultat MotorBikes

SearchMotorBikes() public méthode

Performs the Search Method: Search Motor Bikes. It creates the query string using the paramaters - can be null if the parameter is not required for the request.

DOES NOT REQUIRE AUTHENTICATION.
public SearchMotorBikes ( string searchString, SortOrder sortOrder, decimal priceMin, decimal priceMax, string make, BikeType type, int yearMin, int yearMax, int energySizeMin, int energySizeMax, DateTime dateFrom, int page, int rows ) : MotorBikes
searchString string One or more keywords to use in a search query.
sortOrder SortOrder Sort the returned record-set by a single specified sort order.
priceMin decimal Minimum price.
priceMax decimal Maximum price.
make string Motorbike make.
type BikeType Type of the Motor Bike.
yearMin int Minimum year of manufacture.
yearMax int Maximum year of manufacture.
energySizeMin int Minimum engine size in cubic centimetres (e.g. 2000 for 2 litre engine).
energySizeMax int Maximum engine size.
dateFrom DateTime Return only listings started from this date.
page int Page number.
rows int Number of rows per page.
Résultat MotorBikes

SearchMotorBoats() public méthode

Performs the Search Method: Search Motor Boats

using the "query" string provided - should be the "Search/Motors/Boats.xml?length_max=5000&type=inflatable" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.
public SearchMotorBoats ( string query ) : MotorBoats
query string The query string that will be added to the base url and used to connect to the API with.
Résultat MotorBoats

SearchMotorBoats() public méthode

Performs the Search Method: Search Motor Boats using the parameters provided - can use null if the parameter is not required.

DOES NOT REQUIRE AUTHENTICATION.
public SearchMotorBoats ( string searchString, SortOrder sortOrder, decimal priceMin, decimal priceMax, BoatType type, int lengthMin, int lengthMax, DateTime dateFrom, int page, int rows ) : MotorBoats
searchString string One or more keywords to use in a search query.
sortOrder SortOrder Sort the returned record-set by a single specified sort order.
priceMin decimal Minimum price.
priceMax decimal Maximum price.
type BoatType Type of the Motor Boat.
lengthMin int Minimum length of a boat in metres.
lengthMax int Maximum length of a boat in metres.
dateFrom DateTime Return only listings started from this date.
page int Page number.
rows int Number of rows per page.
Résultat MotorBoats

SearchOpenHomeProperties() public méthode

Performs the Search method: Search Residential Open Homes. Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

DOES NOT REQUIRE AUTHENTICATION.
public SearchOpenHomeProperties ( string searchString, PropertySortOrder sortOrder, int page, int rows, int region, int district, int suburb, DateTime dateFrom, int priceMin, int priceMax, int bathroomsMin, int bathroomsMax, int bedroomsMin, int bedroomsMax, int areaMax, int areaMin, int landAreaMin, int landAreaMax, PropertyType propertyType, bool adjacentSuburbs ) : global::Properties
searchString string One or more keywords to use in a search query.
sortOrder PropertySortOrder Sort the returned record-set by a single specified sort order.
page int Page number.
rows int Number of rows per page.
region int Specifies the search region ID.
district int Specifies the search district ID.
suburb int Specifies the search suburb ID.
dateFrom DateTime Specifies minimum start date for returned listings.
priceMin int Minimum property price.
priceMax int Maximum property price.
bathroomsMin int Minimum number of bedrooms.
bathroomsMax int Maximum number of bedrooms.
bedroomsMin int Minimum number of bathrooms.
bedroomsMax int Maximum number of bathrooms.
areaMax int Maximum square area in square meters.
areaMin int Minimum floor area in square meters.
landAreaMin int Minimum land area in square meters.
landAreaMax int Maximum land area in square meters.
propertyType PropertyType The type of the property.
adjacentSuburbs bool Indicates whether the search should include listings in adjacent suburbs.
Résultat global::Properties

SearchProperties() public méthode

Performs the Search Methods: Search Residential Property, Search Residential Rental Property, Residential Open Homes, Search Commercial Property, Search Commercial Lease Property, Search Rural Property, Search Lifestyle Property, Search Retirement Villages,

using the "query" string provided - should be the "Search/Property/Retirement.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.
public SearchProperties ( string query ) : global::Properties
query string The query string that will be added to the base url and used to connect to the API with.
Résultat global::Properties

SearchResidentialProperties() public méthode

Performs the search method: Search Residential Property.

Creates a query string using the parameters provided - parameters can be null if they are not required for the request.
public SearchResidentialProperties ( string searchString, PropertySortOrder sortOrder, int page, int rows, int region, int district, int suburb, DateTime dateFrom, int priceMin, int priceMax, int bathroomsMin, int bathroomsMax, int bedroomsMin, int bedroomsMax, int areaMax, int areaMin, int landAreaMin, int landAreaMax, PropertyType propertyType, bool adjacentSuburbs ) : global::Properties
searchString string One or more keywords to use in a search query.
sortOrder PropertySortOrder Sort the returned record-set by a single specified sort order.
page int Page number.
rows int Number of rows per page.
region int Specifies the search region ID.
district int Specifies the search district ID.
suburb int Specifies the search suburb ID.
dateFrom DateTime Specifies minimum start date for returned listings.
priceMin int Minimum property price.
priceMax int Maximum property price.
bathroomsMin int Minimum number of bathrooms.
bathroomsMax int Maximum number of bathrooms.
bedroomsMin int Minimum number of bedrooms.
bedroomsMax int Maximum number of bedrooms.
areaMax int Maximum square area in square meters.
areaMin int Minimum floor area in square meters.
landAreaMin int Minimum land area in square meters.
landAreaMax int Maximum land area in square meters.
propertyType PropertyType The type of the property.
adjacentSuburbs bool Indicates whether the search should include listings in adjacent suburbs.
Résultat global::Properties

SearchResidentialRentalProperties() public méthode

Performs the Search Method: Search Residential Rental Property. Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

DOES NOT REQUIRE AUTHENTICATION.
public SearchResidentialRentalProperties ( string searchString, PropertySortOrder sortOrder, int page, int rows, int region, int district, int suburb, DateTime dateFrom, int priceMin, int priceMax, int bathroomsMin, int bathroomsMax, int bedroomsMin, int bedroomsMax, int areaMax, int areaMin, int landAreaMin, int landAreaMax, PropertyType propertyType, bool adjacentSuburbs ) : global::Properties
searchString string One or more keywords to use in a search query.
sortOrder PropertySortOrder Sort the returned record-set by a single specified sort order.
page int Page number.
rows int Number of rows per page.
region int Specifies the search region ID.
district int Specifies the search district ID.
suburb int Specifies the search suburb ID.
dateFrom DateTime Specifies minimum start date for returned listings.
priceMin int Minimum property price.
priceMax int Maximum property price.
bathroomsMin int Minimum number of bathrooms.
bathroomsMax int Maximum number of bathrooms.
bedroomsMin int Minimum number of bedrooms.
bedroomsMax int Maximum number of bedrooms.
areaMax int Maximum square area in square meters.
areaMin int Minimum floor area in square meters.
landAreaMin int Minimum land area in square meters.
landAreaMax int Maximum land area in square meters.
propertyType PropertyType The type of the property.
adjacentSuburbs bool Indicates whether the search should include listings in adjacent suburbs.
Résultat global::Properties

SearchRetirementVillages() public méthode

Performs the search method: Search Retirement Villages using the "query" string provided - should be the "Search/Retirement.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.
public SearchRetirementVillages ( string query ) : RetirementVillages
query string The query string that will be added to the base url and used to connect to the API.
Résultat RetirementVillages

SearchRetirementVillages() public méthode

Performs the search method: Search Retirement Villages. Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

DOES NOT REQUIRE AUTHENTICATION.
public SearchRetirementVillages ( string searchString, PropertySortOrder sortOrder, int page, int rows, int region, int district, int suburb, DateTime dateFrom, int priceMin, int priceMax, int bathroomsMin, int bathroomsMax, int areaMin, int areaMax, int landAreaMin, int landAreaMax, RetirementVillagePropertyType propertyType, int bedroomsMin, int bedroomsMax ) : RetirementVillages
searchString string One or more keywords to use in a search query.
sortOrder PropertySortOrder Sort the returned record-set by a single specified sort order.
page int Page number.
rows int Number of rows per page.
region int Specifies the search region ID.
district int Specifies the search district ID.
suburb int Specifies the search suburb ID.
dateFrom DateTime Specifies minimum start date for returned listings.
priceMin int Minimum property price.
priceMax int Maximum property price.
bathroomsMin int Minimum number of bathrooms..
bathroomsMax int Maximum number of bathrooms.
areaMin int Minimum floor area in square meters.
areaMax int Maximum square area in square meters.
landAreaMin int Minimum land area in square meters.
landAreaMax int Maximum land area in square meters.
propertyType RetirementVillagePropertyType The property type.
bedroomsMin int Minimum number of bedrooms.
bedroomsMax int Maximum number of bedrooms.
Résultat RetirementVillages

SearchRuralProperties() public méthode

Performs the search method: Search Rural Property. Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

DOES NOT REQUIRE AUTHENTICATION.
public SearchRuralProperties ( string searchString, PropertySortOrder sortOrder, int page, int rows, int region, int district, int suburb, DateTime dateFrom, int priceMin, int priceMax, int landAreaMin, int landAreaMax, RuralPropertyUsage usage ) : global::Properties
searchString string One or more keywords to use in a search query.
sortOrder PropertySortOrder Sort the returned record-set by a single specified sort order.
page int Page number.
rows int Number of rows per page.
region int Specifies the search region ID.
district int Specifies the search district ID.
suburb int Specifies the search suburb ID.
dateFrom DateTime Specifies minimum start date for returned listings.
priceMin int Minimum property price.
priceMax int Maximum property price.
landAreaMin int Minimum land area in square meters.
landAreaMax int Maximum land area in square meters.
usage RuralPropertyUsage The usage of the property.
Résultat global::Properties

SearchStores() public méthode

Performs the membership method: Retrieve a member’s profile data using the "query" string provided - should be the "Member/{member_id}/Profile.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.
public SearchStores ( string searchString = "", int page = 1, string category = "", StoreType storeType = StoreType.Normal ) : Stores
searchString string The string to search for.
page int The page number you would like to retrieve.
category string The category the search is in.
storeType StoreType The type of store.
Résultat Stores

SearchUsedMotors() public méthode

Performs the Search Method: Search Used Motors using the "query" string provided - should be the "Search/Motors/Used.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.
public SearchUsedMotors ( string query ) : Cars
query string The query string that will be added to the base url and used to connect to the API with.
Résultat Cars

SearchUsedMotors() public méthode

Performs the Search Method: Search Used Motors. Creates a query string based on the parameters provided, can be null if the parameter is not required for the request.

DOES NOT REQUIRE AUTHENTICATION.
public SearchUsedMotors ( string searchString, int userRegion, SortOrder sortOrder, decimal priceMin, decimal priceMax, string make, string model, BodyStyle bodyStyle, int doorsMin, int doorsMax, Transmission transmission, int yearMax, int yearMin, int energySizeMin, int energySizeMax, int odometerMin, int odometerMax, ListingType listingType, DateTime dateFrom, int page, int rows ) : Cars
searchString string One or more keywords to use in a search query.
userRegion int Restricts search results to items from sellers located in the specified region.
sortOrder SortOrder Sort the returned record-set by a single specified sort order.
priceMin decimal Minimum price.
priceMax decimal Maximum price.
make string Car make.
model string Car model.
bodyStyle BodyStyle Car body style.
doorsMin int Minimum number of doors (range from 2 to 5).
doorsMax int Maximum number of doors.
transmission Transmission Transmission type.
yearMax int Maximum year of manufacture.
yearMin int Minimum year of manufacture.
energySizeMin int Minimum engine size in cubic centimetres (e.g. 2000 for 2 litre engine).
energySizeMax int Maximum engine size.
odometerMin int Minimum odometer value in kilometres.
odometerMax int Maximum odometer value.
listingType ListingType Type of listing.
dateFrom DateTime Return only listings started from this date.
page int Page number.
rows int Number of rows per page.
Résultat Cars

SellBluRayFromCatalogue() public méthode

List a Blu-ray disc using listing details that are sourced from the Trade Me Blu-ray catalogue.

REQUIRES AUTHENTICATION.
public SellBluRayFromCatalogue ( SellCatalogueRequest request ) : XDocument
request SellCatalogueRequest The object that will be serialized into xml and then sent in a POST message.
Résultat XDocument

SellDvdFromCatalogue() public méthode

List a DVD using listing details that are sourced from the Trade Me DVD catalogue.

REQUIRES AUTHENTICATION.
public SellDvdFromCatalogue ( SellCatalogueRequest request ) : XDocument
request SellCatalogueRequest The object that will be serialized into xml and then sent in a POST message.
Résultat XDocument

SellSimilarItem() public méthode

Sell similar from an existing or expired auction or classified. Creates a new listing without modifying editable fields.Relist an item that has expired. Relists an item without modifying editable fields.

Sell similar from an existing or expired auction or classified. Creates a new listing without modifying editable fields.

REQUIRES AUTHENTICATION.
public SellSimilarItem ( SellSimilarListingRequest request ) : XDocument
request SellSimilarListingRequest The object that will be serialized into xml and then sent in a POST message.
Résultat XDocument

SellingItems() public méthode

Performs the MyTradeMe method: Retrieve a list of items currently for sale

using the "query" string provided - should be the "MyTradeMe/SellingItems/All.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

REQUIRES AUTHENTICATION.
public SellingItems ( string query ) : Items
query string The query string that will be added to the base url and used to connect to the API.
Résultat Items

SellingItemsWithCriteria() public méthode

Performs the MyTradeMe method: Retrieve a list of items currently for sale.

Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

REQUIRES AUTHENTICATION.
public SellingItemsWithCriteria ( SellingItemsCriteria criteria ) : Items
criteria SellingItemsCriteria The criteria.
Résultat Items

SetEmailPreferences() public méthode

Sets the authenticated user’s email preferences. POST

REQUIRES AUTHENTICATION.
public SetEmailPreferences ( EmailOptions request ) : XDocument
request EmailOptions EmailOptions
Résultat XDocument

SoldItems() public méthode

Performs the My Trade Me Method: Retrieve a list of sold items.

Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

REQUIRES AUTHENTICATION.
public SoldItems ( SoldItemsCriteria criteria, string page, string rows ) : SoldItems
criteria SoldItemsCriteria The criteria.
page string Page number.
rows string Number of rows per page.
Résultat SoldItems

SoldItems() public méthode

Performs the My Trade Me Method: Retrieve a list of sold items

using the "query" string provided - should be the "MyTradeMe/SoldItems/{criteria}.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

REQUIRES AUTHENTICATION.
public SoldItems ( string query ) : SoldItems
query string The query string that will be added to the base url and used to connect to the API.
Résultat SoldItems

UnansweredQuestionsAll() public méthode

Performs the Listing Method: Retrieves a list of all the unanswered questions for all live auctions of the authenticated user. GET

REQUIRES AUTHENTICATION.
public UnansweredQuestionsAll ( ) : Questions
Résultat Questions

UnansweredQuestionsById() public méthode

Performs the Listing Method: Retrieve a list of unanswered questions for all listings belonging to a member, Retrieve a list of unanswered questions on a single listing.

Creates a query string using the id parameter provided - the parameter should be null if the request is for all listings belonging to a member.

REQUIRES AUTHENTICATION.
public UnansweredQuestionsById ( string listingId ) : Questions
listingId string The listing id.
Résultat Questions

UnansweredQuestionsByQueryString() public méthode

Performs the Listing Method: Retrieve a list of unanswered questions for all listings belonging to a member, Retrieve a list of unanswered questions on a single listing,

using the "query" string provided - should be the "Listings/questions/unansweredquestions.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

REQUIRES AUTHENTICATION.
public UnansweredQuestionsByQueryString ( string query ) : Questions
query string The query string that will be added to the base url and used to connect to the API.
Résultat Questions

UnsoldItems() public méthode

Performs the My Trade Me Method: Retrieve a list of unsold items.

Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

REQUIRES AUTHENTICATION.
public UnsoldItems ( UnsoldItemsCriteria criteria, string page, string rows ) : UnsoldItems
criteria UnsoldItemsCriteria The criteria.
page string Page number.
rows string Number of rows per page.
Résultat UnsoldItems

UnsoldItems() public méthode

Performs the My Trade Me Method: Retrieve a list of unsold items

using the "query" string provided - should be the "MyTradeMe/UnsoldItems.xml" part of the url it shouldn't include "http://api.trademe.co.nz/v1/".

REQUIRES AUTHENTICATION.
public UnsoldItems ( string query ) : UnsoldItems
query string The query string that will be added to the base url and used to connect to the API.
Résultat UnsoldItems

UpdateDeliveryAddress() public méthode

Modifies a delivery addresses in the authenticated user’s profile. POST

REQUIRES AUTHENTICATION.
public UpdateDeliveryAddress ( DeliveryAddress request ) : XDocument
request DeliveryAddress DeliveryAddress
Résultat XDocument

UpdateFeedback() public méthode

Modifies feedback the authenticated user has posted against a listing. POST

REQUIRES AUTHENTICATION.
public UpdateFeedback ( FeedbackUpdateRequest request ) : XDocument
request FeedbackUpdateRequest FeedbackUpdateRequest
Résultat XDocument

UpdateSavedFavorite() public méthode

Performs the Favourites method: Modifies the email frequency for a saved favourite. POST

REQUIRES AUTHENTICATION.
public UpdateSavedFavorite ( string favoriteId, string type, string frequency ) : XDocument
favoriteId string The ID of the favourite.
type string The type of favourite (must be “Category”, “Search”, “AttributeSearch” or “Seller”).
frequency string The frequency that emails should be sent (must be “None”, “Daily”, “Every3Days” or “Weekly”).
Résultat XDocument

UploadPhoto() public méthode

Performs the Photo Method: Upload a photo.

Serializes the given PhotoUploadRequest into xml and sends the message.
public UploadPhoto ( PhotoUploadRequest up ) : XDocument
up PhotoUploadRequest The object that will be serialized into xml and then sent in a POST message.
Résultat XDocument

UploadPhotoFormat() public méthode

Performs the Photo Method: Upload a photo.

Serializes the given PhotoUploadRequest into xml and sends the message. Loads the file and converts it to the appropriate data format for the request - it does not require the "PhotoData" field of the PhotoUploadRequest object to have anything in it.

public UploadPhotoFormat ( PhotoUploadRequest up ) : XDocument
up PhotoUploadRequest The object that will be serialized into xml and then sent in a POST message.
Résultat XDocument

Watchlist() public méthode

Performs the My Trade Me Method: Retrieve a member’s watchlist.

Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

REQUIRES AUTHENTICATION.
public Watchlist ( WatchlistCriteria criteria, string page, string rows ) : Watchlist
criteria WatchlistCriteria The criteria.
page string Page number.
rows string Number of rows per page.
Résultat Watchlist

Watchlist() public méthode

Performs the My Trade Me Method: Retrieve a member’s watchlist

using the "query" string provided - should be the "MyTradeMe/Watchlist.xml part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

REQUIRES AUTHENTICATION.
public Watchlist ( string query ) : Watchlist
query string The query string that will be added to the base url and used to connect to the API.
Résultat Watchlist

WithdrawFixedPriceOffer() public méthode

Performs the Fixed Price Offer Method: Withdraws an offer that is current and not expired, accepted or rejected by all users. POST

REQUIRES AUTHENTICATION.
public WithdrawFixedPriceOffer ( FixedPriceOfferWithdrawalRequest request ) : XDocument
request FixedPriceOfferWithdrawalRequest The object that will be serialized into xml and then sent in a POST message.
Résultat XDocument

WithdrawListedItem() public méthode

Withdraw a listing from Trade Me for either being sold or unsold.

REQUIRES AUTHENTICATION.
public WithdrawListedItem ( WithdrawRequest request ) : XDocument
request WithdrawRequest The object that will be serialized into xml and then sent in a POST message.
Résultat XDocument

WonItems() public méthode

Performs the My Trade Me Method: Retrieve a list of won items.

Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

REQUIRES AUTHENTICATION.
public WonItems ( WonItemsCriteria criteria, string page, string rows ) : WonItems
criteria WonItemsCriteria The criteria.
page string Page number.
rows string Number of rows per page.
Résultat WonItems

WonItems() public méthode

Performs the My Trade Me Method: Retrieve a list of won items

using the "query" string provided - should be the "MyTradeMe/Won.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

REQUIRES AUTHENTICATION.
public WonItems ( string query ) : WonItems
query string The query string that will be added to the base url and used to connect to the API.
Résultat WonItems