Website logo

Retrieve your account statement

Gets the member ledger for the authenticated user.

URL: https://api.trademe.co.nz/v1/mytrademe/memberledger/{filter}.{file_format}
HTTP Method: GET
Requires Authentication? Yes
Permission Required: MyTradeMeRead: Read your membership & listing data.
Supported Formats: XML, JSON
Rate Limited? Yes

URL parameters

filter String (required)

A time-based filter on the results.

AllReturn member ledger records from the last 365 days.
Last60DaysReturn member ledger records from the last 60 days.
Last45DaysReturn member ledger records from the last 45 days.
Last28DaysReturn member ledger records from the last 28 days.
Last14DaysReturn member ledger records from the last 14 days.
Last7DaysReturn member ledger records from the last 7 days.
Last24HoursReturn member ledger records from the last 24 hours.
file_format Enumeration (required) The format of the response.
xml Serialize responses into XML.
json Serialize responses into JSON.

Query String parameters

page Integer (optional)

The page number of the set of results to return, starting from 1. Defaults to 1.
rows Integer (optional)

The number of results per page; also the maximum number of results to return. Defaults to 50.
type Enumeration (optional)

A filter on the type of results returned.
All All
AllDebits AllDebits
AllCredits AllCredits
AccountCredits AccountCredits
Refunds Refunds
TopSellerDiscounts TopSellerDiscounts
GoldTradeRebates GoldTradeRebates

Returns

<MemberLedger>

The member ledger for the authenticated user.

TotalCount Integer TotalCount
Page Integer Page
PageSize Integer PageSize
List Collection of <MemberLedgerItem> or null InnerList
Date DateTime Date
Type Enumeration Type
Other 0 Other
ListingFee 1 listing_fee_fixed
HighVolumeFee 2 hvl_fee
SuccessFeeBid 3 auction_success_fee_reserve
SuccessFeeOffer 4 auction_success_fee_offer
SuccessFeeBuyNow 5 auction_success_fee_buynow
GalleryPromotion 100 listing_fee_gallery
GalleryPlusPromotion 101 listing_fee_gallery_plus
BoldPromotion 102 listing_fee_bold
SubtitlePromotion 103 listing_fee_subtitle
HighlightPromotion 104 listing_fee_highlight
FeaturePromotion 105 listing_fee_feature
FeatureComboPromotion 106 listing_fee_bundle
HomepageFeaturePromotion 107 listing_fee_feature_homepage
SuperFeaturePromotion 108 listing_fee_super_feature
SuperFeatureComboPromotion 109 listing_fee_super_feature_combo
TenDayAuctionFee 110 listing_fee_10_day
MultiPhotoFee 111 listing_fee_multiphoto
ScheduledEndDateFee 112 listing_fee_scheduled_end
ReserveFee 113 listing_fee_reserve
SecondaryCategoryPromotion 114 listing_fee_secondary_category
JobPack5 200 05JobPack
JobPack10 201 10JobPack
JobPack20 202 20JobPack
JobPack30 204 30JobPack
JobPack50 203 50JobPack
JobPack100 205 100JobPack
WithdrawalFee 300 auction_withdrawal_fee
QuotableValueReportFee 301 qv_report
MonthlyStoreFee 302 monthly_store_fee
CreditViaCreditCard 400 credit_by_cc
CreditViaBankTransfer 401 credit_by_billpay
CreditViaCheque 402 credit_by_cheque
CreditViaPing 403 credit_by_ping
RebateForListingFee 500 rebate_listing_fee_fixed
RebateForHighVolumeFee 501 rebate_hvl_fee
RebateForSuccessFeeBid 502 rebate_auction_success_fee_reserve
RebateForSuccessFeeOffer 503 rebate_auction_success_fee_offer
RebateForSuccessFeeBuyNow 504 rebate_auction_success_fee_buynow
RebateForGalleryPromotion 505 rebate_listing_fee_gallery
RebateForGalleryPlusPromotion 506 rebate_listing_fee_gallery_plus
RebateForBoldPromotion 507 rebate_listing_fee_bold
RebateForSubtitlePromotion 508 rebate_listing_fee_subtitle
RebateForHighlightPromotion 509 rebate_listing_fee_highlight
RebateForFeaturePromotion 510 rebate_listing_fee_feature
RebateForFeatureComboPromotion 511 rebate_listing_fee_bundle
RebateForHomepageFeaturePromotion 512 rebate_listing_fee_feature_homepage
RebateForSuperFeaturePromotion 513 rebate_listing_fee_super_feature
RebateForSuperFeatureComboPromotion 514 rebate_listing_fee_super_feature_combo
RebateForTenDayAuctionFee 515 rebate_listing_fee_10_day
RebateForMultiPhotoFee 516 rebate_listing_fee_multiphoto
RebateForScheduledEndDateFee 517 rebate_listing_fee_scheduled_end
RebateForReserveFee 518 rebate_listing_fee_reserve
RebateForSecondaryCategoryPromotion 519 rebate_listing_fee_secondary_category
RefundOfListingFee 600 refund_of_listing_fee
RefundOfSuccessFee 601 refund_of_success_fee
RefundOfGalleryPromotion 602 refund_of_fee_gallery
RefundOfGalleryPlusPromotion 603 refund_of_fee_gallery_plus
RefundOfBoldPromotion 604 refund_of_fee_bold
RefundOfSubtitlePromotion 605 refund_of_fee_subtitle
RefundOfHighlightPromotion 606 refund_of_fee_highlight
RefundOfFeaturePromotion 607 refund_of_fee_feature
RefundOfFeatureComboPromotion 608 refund_of_fee_bundle
RefundOfHomepageFeaturePromotion 609 refund_of_fee_feature_homepage
RefundOfSuperFeaturePromotion 610 refund_of_fee_super_feature
RefundOfSuperFeatureComboPromotion 611 refund_of_fee_super_feature_combo
RefundOfTenDayAuctionFee 612 refund_of_fee_10_day
RefundOfMultiPhotoFee 613 refund_of_fee_multiphoto
RefundOfScheduledEndDateFee 614 refund_of_fee_scheduledenddate
RefundOfReserveFee 615 refund_of_fee_reserve
RefundOfSecondaryCategoryPromotion 616 refund_of_fee_secondary_category
DiscountOfListingFee 617 discount_of_listing_fee
DiscountOfSuperfeature 618 discount_of_superfeature_combo
DiscountOfHighlight 619 discount_of_highlight
DiscountOfFeature 620 discount_of_feature
DiscountOfBoldTitle 621 discount_of_bold_title
DiscountOfFeatureCombo 622 discount_of_feature_combo
DiscountOfSubtitle 623 discount_of_subtitle
RebateForGoldTradeSuccessFee 624 rebate_gold_trade_success_fee
MotorsFeatureBundleUpgrade 625 listing_fee_motors_feature_bundle_
Description String or null Description
Credit Number Credit
Debit Number Debit
Balance Number Balance
ReferenceId Integer ReferenceId
PurchaseId Integer PurchaseId
Sku String or null Sku
LedgerId Integer LedgerId

Example XML Response (switch to JSON) 

<MemberLedger xmlns="http://api.trademe.co.nz/v1">
  <TotalCount>123</TotalCount>
  <Page>123</Page>
  <PageSize>123</PageSize>
  <List>
    <MemberLedgerItem>
      <Date>2018-01-01T00:00:00Z</Date>
      <Type>Other</Type>
      <Description>ABC</Description>
      <Credit>123.0</Credit>
      <Debit>123.0</Debit>
      <Balance>123.0</Balance>
      <ReferenceId>123</ReferenceId>
      <PurchaseId>123</PurchaseId>
      <Sku>ABC</Sku>
      <LedgerId>123</LedgerId>
    </MemberLedgerItem>
    <MemberLedgerItem>
      <Date>2018-01-01T00:00:00Z</Date>
      <Type>Other</Type>
      <Description>ABC</Description>
      <Credit>123.0</Credit>
      <Debit>123.0</Debit>
      <Balance>123.0</Balance>
      <ReferenceId>123</ReferenceId>
      <PurchaseId>123</PurchaseId>
      <Sku>ABC</Sku>
      <LedgerId>123</LedgerId>
    </MemberLedgerItem>
  </List>
</MemberLedger>

Example JSON Response (switch to XML) 

{
  "TotalCount": 123,
  "Page": 123,
  "PageSize": 123,
  "List": [
    {
      "Date": "\/Date(1514764800)\/",
      "Type": 0,
      "Description": "ABC",
      "Credit": 123.0,
      "Debit": 123.0,
      "Balance": 123.0,
      "ReferenceId": 123,
      "PurchaseId": 123,
      "Sku": "ABC",
      "LedgerId": 123
    },
    {
      "Date": "\/Date(1514764800)\/",
      "Type": 0,
      "Description": "ABC",
      "Credit": 123.0,
      "Debit": 123.0,
      "Balance": 123.0,
      "ReferenceId": 123,
      "PurchaseId": 123,
      "Sku": "ABC",
      "LedgerId": 123
    }
  ]
}