Function   /seller/auction/cancel

  1. Home
  2. API functions
  3. Selling on auctions
  4. Function /seller/auction/cancel
  5. Demo

Function invocation

https://json.aftermarket.pl/seller/auction/cancel

Function description

Cancel an active auction. Auction cancellation is payable if there are some bids in auction, otherwise it is free.

Input parameters

This function takes the following input parameters:

ParameterTypeRequiredDefault valueDescription
auctionId integer YES Auction identifier
check boolean false Only check for parameter correctness and price for auction cancellation

Return value

Auction cancellation result (structure with the following fields):

Field nameTypeDescription
canceledAuctionInfoId integer Auction identifier (deprecated and unused)
amount float Optional amount
currency string Currency of optional amount
fee float Currency of optional amount (deprecated, this value is given in amount)
myAmount float Amount in member currency of optional amount
myCurrency string Member's currency
name string Domain name (in Punycode)
nameIDN string Domain name (internationalized)
utfname string Domain name (internationalized) (deprecated, this value is given in 'nameIDN' field)