> For the complete documentation index, see [llms.txt](https://docs.auctionplusapp.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.auctionplusapp.com/admin-api/auction-items/cancel-an-auction-listing.md).

# Cancel an auction listing

Cancels a listing without assigning a winner.

```json
{"openapi":"3.1.0","info":{"title":"Auction Plus API Documentation","version":"1.0.0"},"tags":[{"name":"Auction Items","description":"An auction item represents a single listing in an auction. Each item has a **status** of `scheduled`, `active`, or `completed`. Canceled auctions are indicated by a non-null **canceledAt** timestamp.\n\nPrice attributes such as **startPrice**, **reservePrice**, **minimumBid**, **currentIncrement**, and **highBidAmount** are returned as a price object containing **value** (minor units), **major**, **display**, and **currency** fields.\n\nThe **bidIncrementStrategy** describes the increment type — `fixed_amount`, `percentage`, or `tier` — along with a **value** object containing the increment details.\n\nThe **softClose** object indicates whether soft close is enabled. When active, **extendFrom** specifies how many seconds before the end time a bid triggers an extension, and **extendDuration** specifies how many seconds the auction is extended by.\n\nThe **processed** attribute indicates whether the auction listing has been finalized, including assigning a winner. Listings are typically processed within a minute after the end time."}],"servers":[{"url":"https://api.auctionplusapp.com/v1"}],"security":[{"http":[]}],"components":{"securitySchemes":{"http":{"type":"http","description":"You can retrieve your token by visiting Settings > API and clicking <b>Generate API token</b>.","scheme":"bearer"}},"schemas":{"AuctionItemResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"auction-items"},"attributes":{"type":"object","properties":{"startPrice":{"$ref":"#/components/schemas/Money"},"reservePrice":{"$ref":"#/components/schemas/Money"},"bidIncrementStrategy":{"$ref":"#/components/schemas/BidIncrementStrategy"},"automaticBidding":{"type":"object","properties":{"enabled":{"type":"boolean"}},"required":["enabled"]},"softClose":{"type":"object","properties":{"enabled":{"type":"boolean"},"extendFrom":{"type":["integer","null"]},"extendDuration":{"type":["integer","null"]}},"required":["enabled","extendFrom","extendDuration"]},"totalBids":{"type":"integer"},"highBidAmount":{"$ref":"#/components/schemas/Money"},"minimumBid":{"$ref":"#/components/schemas/Money"},"currentIncrement":{"$ref":"#/components/schemas/Money"},"startsAt":{"type":"string","format":"date-time"},"endsAt":{"type":"string","format":"date-time"},"status":{"type":"string"},"reserveMet":{"type":"string"},"canceledAt":{"type":["string","null"],"format":"date-time"},"archivedAt":{"type":["string","null"],"format":"date-time"},"processed":{"type":"boolean"},"createdAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":["string","null"],"format":"date-time"}}}},"required":["id","type"],"title":"AuctionItemResource"},"Money":{"type":"object","properties":{"value":{"type":"integer"},"major":{"type":"string"},"display":{"type":"string"},"currency":{"type":"string"}},"required":["value","major","display","currency"],"title":"Money"},"BidIncrementStrategy":{"type":"object","properties":{"strategy":{"type":"string"},"value":{"anyOf":[{"$ref":"#/components/schemas/FixedAmountBidIncrement"},{"$ref":"#/components/schemas/PercentageBidIncrement"},{"$ref":"#/components/schemas/TierBidIncrement"}]}},"required":["strategy","value"],"title":"BidIncrementStrategy"},"FixedAmountBidIncrement":{"type":"object","properties":{"amount":{"type":"object","properties":{"value":{"type":"integer"},"major":{"type":"string"},"display":{"type":"string"},"currency":{"type":"string"}},"required":["value","major","display","currency"]}},"required":["amount"],"title":"FixedAmountBidIncrement"},"PercentageBidIncrement":{"type":"object","properties":{"percentage":{"type":"number"}},"required":["percentage"],"title":"PercentageBidIncrement"},"TierBidIncrement":{"type":"object","properties":{"tier":{"type":"string"}},"required":["tier"],"title":"TierBidIncrement"},"BidResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"bids"},"attributes":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/Money"},"placedAt":{"type":["string","null"],"format":"date-time"},"automatic":{"type":["boolean","null"]}}}},"required":["id","type"],"title":"BidResource"},"CustomerResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"customers"},"attributes":{"type":"object","properties":{"name":{"type":"string"},"email":{"type":"string"},"registeredAt":{"type":["string","null"],"format":"date-time"},"approvedAt":{"type":["string","null"],"format":"date-time"},"bannedAt":{"type":["string","null"],"format":"date-time"},"createdAt":{"type":["string","null"],"format":"date-time"}}}},"required":["id","type"],"title":"CustomerResource"}},"responses":{"AuthenticationException":{"description":"Unauthenticated","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"The HTTP status code applicable to this problem, expressed as a string."},"code":{"type":"string","description":"An application-specific error code."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"id":{"type":"string","description":"A unique identifier for this particular occurrence of the problem."},"title":{"type":"string","description":"A short, human-readable summary of the problem."},"source":{"type":"object","description":"An object containing references to the source of the error.","properties":{"pointer":{"type":"string"},"parameter":{"type":"string"},"header":{"type":"string"}}},"meta":{"type":"object","description":"A meta object containing additional information about the error."}},"required":["status","code","detail"]}}},"required":["errors"]}}}}}},"paths":{"/auction-items/{id}/cancel":{"patch":{"operationId":"cancelAuctionItem","description":"Cancels a listing without assigning a winner.","summary":"Cancel an auction listing","tags":["Auction Items"],"parameters":[{"name":"fields[auction-items]","in":"query","description":"Available values are `startPrice`, `reservePrice`, `bidIncrementStrategy`, `automaticBidding`, `softClose`, `totalBids`, `highBidAmount`, `minimumBid`, `currentIncrement`, `startsAt`, `endsAt`, `status`, `reserveMet`, `canceledAt`, `archivedAt`, `processed`, `createdAt`, `updatedAt`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[bids]","in":"query","description":"Available values are `amount`, `placedAt`, `automatic`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"fields[customers]","in":"query","description":"Available values are `name`, `email`, `registeredAt`, `approvedAt`, `bannedAt`, `createdAt`. You can include multiple values by separating them with a comma.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"The auction item UID.","schema":{"type":"string"}},{"name":"include","in":"query","description":"Comma-separated list of related resources to include in the response. Available values: `highBid`, `highBid.customer`.","schema":{"type":"string"}}],"responses":{"200":{"description":"`AuctionItemResource`","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/AuctionItemResource"},{"type":"object","properties":{"relationships":{"type":"object","properties":{"highBid":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["bids"]},"id":{"type":"string"}},"required":["type","id"]}}}}}}}]},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/BidResource"},{"$ref":"#/components/schemas/CustomerResource"}]}}},"required":["data"]}}}},"401":{"$ref":"#/components/responses/AuthenticationException"},"422":{"description":"Unprocessable entity","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"The HTTP status code applicable to this problem, expressed as a string."},"code":{"type":"string","description":"An application-specific error code."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"id":{"type":"string","description":"A unique identifier for this particular occurrence of the problem."},"title":{"type":"string","description":"A short, human-readable summary of the problem."},"source":{"type":"object","description":"An object containing references to the source of the error.","properties":{"pointer":{"type":"string"},"parameter":{"type":"string"},"header":{"type":"string"}}},"meta":{"type":"object","description":"A meta object containing additional information about the error."}},"required":["status","code","detail"]}}},"required":["errors"]}}}}}}}}}
```