Website logo

Retrieve fees for withdrawing a listing

Returns the fees that will be charged for withdrawing a listing. An error is reported if the listing cannot be withdrawn.

URL: https://api.trademe.co.nz/v1/Selling/WithdrawFees.{file_format}
HTTP Method: POST
Requires Authentication? Yes
Permission Required: MyTradeMeWrite: Maintain your watchlist, answer questions and post comments.
Supported Formats: XML, JSON
Rate Limited? Yes

URL parameters

file_format Enumeration (required) The format of the response.
xml Serialize responses into XML.
json Serialize responses into JSON.

POST Data

<WithdrawRequest>

ListingId Long Integer (required)

The ID of the listing that is being withdrawn, relisted or extended.

ReturnListingDetails Boolean (optional)

Indicates whether full listing details should be returned in the Listing field.

Type Enumeration (required)

Indicates whether this withdrawl request is for a listing that sold or not.

ListingWasSold 1

The item was sold.

ListingWasNotSold 2

The item didn't sell.

Reason String (optional)

The reason for withdrawing the listing, if the listing has not sold. Max 255 characters.

SalePrice Number (optional)

The amount the listing sold for, if the listing has sold.

Returns

<FeeResponse>

A list of fees.

Success Boolean

Indicates whether the operation was successful.

Description String or null

The description of the error, if the operation failed.

TotalCost Number or null

The total price for the listing.

InsufficientBalance Boolean

Indicates the member has insufficient funds to pay the total price for the listing.

FeeItems <MemberLedger> or null

A collection of member ledger items.

TotalCount Integer

The total number of results in the collection. Can be larger than the number of returned results.

Page Integer

The index of the current page of results (starts at 1).

PageSize Integer

The number of results in the current page.

List Collection of <MemberLedgerItem> or null

A list of the results in the current page.

Date DateTime

The transaction date.

Type Enumeration

The transaction type.

Other 0

An unknown ledger item.

ListingFee 1

The fee for a listing an item (applies to classifieds and auctions in certain categories).

HighVolumeFee 2

The fee for exceeding the free listing allowance.

SuccessFeeBid 3

The fee for a successful auction (won via a bid).

SuccessFeeOffer 4

The fee for a successful auction (won via a fixed price offer).

SuccessFeeBuyNow 5

The fee for a successful auction (won via Buy Now).

GalleryPromotion 100

The fee for listing an item with the gallery promotion.

GalleryPlusPromotion 101

The fee for listing an item with the gallery plus promotion.

BoldPromotion 102

The fee for listing an item with the bold title promotion.

SubtitlePromotion 103

The fee for listing an item with a subtitle.

HighlightPromotion 104

The fee for listing an item with a highlight.

FeaturePromotion 105

The fee for listing an item with the feature promotion.

FeatureComboPromotion 106

The fee for listing an item with the feature combo promotion.

HomepageFeaturePromotion 107

The fee for listing an item with the homepage feature promotion.

SuperFeaturePromotion 108

The fee for listing an item with the super feature promotion.

SuperFeatureComboPromotion 109

The fee for listing an item with the super feature combo promotion.

TenDayAuctionFee 110

The fee for listing an item with a duration of ten days.

MultiPhotoFee 111

The fee for listing an item with additional photos.

ScheduledEndDateFee 112

The fee for listing an item with a scheduled end date/time.

ReserveFee 113

The fee for listing an item with a reserve price.

SecondaryCategoryPromotion 114

The fee for listing an item with a reserve price.

JobPack5 200

The purchase of a five listing job pack.

JobPack10 201

The purchase of a ten listing job pack.

JobPack20 202

The purchase of a twenty listing job pack.

JobPack30 204

The purchase of a thirty listing job pack.

JobPack50 203

The purchase of a fifty listing job pack.

JobPack100 205

The purchase of a hundred listing job pack.

WithdrawalFee 300

The fee for withdrawing an auction over an hour after it started.

QuotableValueReportFee 301

The fee for purchasing a QV report.

MonthlyStoreFee 302

The monthly fee for having a Trade Me store.

CreditViaCreditCard 400

The member credited their account with a credit card.

CreditViaBankTransfer 401

The member credited their account using internet banking.

CreditViaCheque 402

The member credited their account with a cheque.

RebateForListingFee 500

The rebate for listing an item.

RebateForHighVolumeFee 501

The rebate for exceeding the free listing allowance.

RebateForSuccessFeeBid 502

The rebate for a successful auction (won via a bid).

RebateForSuccessFeeOffer 503

The rebate for a successful auction (won via a fixed price offer).

RebateForSuccessFeeBuyNow 504

The rebate for a successful auction (won via Buy Now).

RebateForGalleryPromotion 505

The rebate for listing an item with the gallery promotion.

RebateForGalleryPlusPromotion 506

The rebate for listing an item with the gallery plus promotion.

RebateForBoldPromotion 507

The rebate for listing an item with the bold title promotion.

RebateForSubtitlePromotion 508

The rebate for listing an item with a subtitle.

RebateForHighlightPromotion 509

The rebate for listing an item with a highlight.

RebateForFeaturePromotion 510

The rebate for listing an item with the feature promotion.

RebateForFeatureComboPromotion 511

The rebate for listing an item with the feature combo promotion.

RebateForHomepageFeaturePromotion 512

The rebate for listing an item with the homepage feature promotion.

RebateForSuperFeaturePromotion 513

The rebate for listing an item with the super feature promotion.

RebateForSuperFeatureComboPromotion 514

The rebate for listing an item with the super feature combo promotion.

RebateForTenDayAuctionFee 515

The rebate for listing an item with a duration of ten days.

RebateForMultiPhotoFee 516

The rebate for listing an item with additional photos.

RebateForScheduledEndDateFee 517

The rebate for listing an item with a scheduled end date/time.

RebateForReserveFee 518

The rebate for listing an item with a reserve price.

RebateForSecondaryCategoryPromotion 519

The rebate for listing an item with a secondary category.

RefundOfListingFee 600

A refund for listing an item.

RefundOfSuccessFee 601

Refund of auction success fees.

RefundOfGalleryPromotion 602

The refund for listing an item with the gallery promotion.

RefundOfGalleryPlusPromotion 603

The refund for listing an item with the gallery plus promotion.

RefundOfBoldPromotion 604

The refund for listing an item with the bold title promotion.

RefundOfSubtitlePromotion 605

The refund for listing an item with a subtitle.

RefundOfHighlightPromotion 606

The refund for listing an item with a highlight.

RefundOfFeaturePromotion 607

The refund for listing an item with the feature promotion.

RefundOfFeatureComboPromotion 608

The refund for listing an item with the feature combo promotion.

RefundOfHomepageFeaturePromotion 609

The refund for listing an item with the homepage feature promotion.

RefundOfSuperFeaturePromotion 610

The refund for listing an item with the super feature promotion.

RefundOfSuperFeatureComboPromotion 611

The refund for listing an item with the super feature combo promotion.

RefundOfTenDayAuctionFee 612

The refund for listing an item with a duration of ten days.

RefundOfMultiPhotoFee 613

The refund for listing an item with additional photos.

RefundOfScheduledEndDateFee 614

The refund for listing an item with a scheduled end date/time.

RefundOfReserveFee 615

The refund for listing an item with a reserve price.

RefundOfSecondaryCategoryPromotion 616

The refund for listing an item with a secondary category.

DiscountOfListingFee 617

Discount of listing fee

DiscountOfSuperfeature 618

Discount of superfeature fee

DiscountOfHighlight 619

Discount of highlight fee

DiscountOfFeature 620

Discount of feature fee

DiscountOfBoldTitle 621

Discount of boldTitle fee

DiscountOfFeatureCombo 622

Discount of feature combo fee

DiscountOfSubtitle 623

Discount of subtitle fee

RebateForGoldTradeSuccessFee 624

The rebate for providing timely shipping information.

MotorsFeatureBundleUpgrade 625

For upgrading Motors Feature Bundle

Description String or null

A description of the transaction.

Credit Number

The amount to credit to the member's account.

Debit Number

The amount to debit from the member's account.

WillBeInvoiced Boolean

Indicates whether this ledger item will be invoiced, rather than deducted from the member's trade me balance.

InvoicedValue Number

The amount that will be invoiced to the member

Example XML Request (switch to JSON)

<WithdrawRequest xmlns="http://api.trademe.co.nz/v1">
  <ListingId>123</ListingId>
  <ReturnListingDetails>false</ReturnListingDetails>
  <Type>ListingWasSold</Type>
  <Reason>ABC</Reason>
  <SalePrice>123.0</SalePrice>
</WithdrawRequest>

Example JSON Request (switch to XML)

{
  "ListingId": 123,
  "ReturnListingDetails": false,
  "Type": 1,
  "Reason": "ABC",
  "SalePrice": 123.0
}

Example XML Response (switch to JSON)

<FeeResponse xmlns="http://api.trademe.co.nz/v1">
  <Success>false</Success>
  <Description>ABC</Description>
  <TotalCost>123.0</TotalCost>
  <InsufficientBalance>false</InsufficientBalance>
  <FeeItems>
    <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>
        <WillBeInvoiced>false</WillBeInvoiced>
        <InvoicedValue>123.0</InvoicedValue>
      </MemberLedgerItem>
      <MemberLedgerItem>
        <Date>2018-01-01T00:00:00Z</Date>
        <Type>Other</Type>
        <Description>ABC</Description>
        <Credit>123.0</Credit>
        <Debit>123.0</Debit>
        <WillBeInvoiced>false</WillBeInvoiced>
        <InvoicedValue>123.0</InvoicedValue>
      </MemberLedgerItem>
    </List>
  </FeeItems>
</FeeResponse>

Example JSON Response (switch to XML)

{
  "Success": false,
  "Description": "ABC",
  "TotalCost": 123.0,
  "InsufficientBalance": false,
  "FeeItems": {
    "TotalCount": 123,
    "Page": 123,
    "PageSize": 123,
    "List": [
      {
        "Date": "\/Date(1514764800)\/",
        "Type": 0,
        "Description": "ABC",
        "Credit": 123.0,
        "Debit": 123.0,
        "WillBeInvoiced": false,
        "InvoicedValue": 123.0
      },
      {
        "Date": "\/Date(1514764800)\/",
        "Type": 0,
        "Description": "ABC",
        "Credit": 123.0,
        "Debit": 123.0,
        "WillBeInvoiced": false,
        "InvoicedValue": 123.0
      }
    ]
  }
}