LotUnWithdrawn
v0.0.1

Holds information about lots unwithdrawn during an online auction.
When firing this event make sure you set the `correlationId` in the headers. Our schemas have standard metadata make sure you read and follow it.

Details

This event indicates a lot has been unwithdrawn. It only occurs after the sale has started, the sale has not closed.

Consumer / Producer Diagram

LotUnWithdrawn Schema (json)
{
  "$id": "https://example.com/LotUnWithdrawn.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "LotUnWithdrawn",
  "description": "An event raised when a lot is unwithdrawn in an online auction",
  "type": "object",
  "properties": {
    "metadata": {
      "type": "object",
      "properties": {
        "occurredAtUtc": {
          "type": "string",
          "description": "The date and time when event occurred in UTC. Date should be represented in ISO 8601 format e.g 2023-09-08T12:00:00Z"
        },
        "typeName": {
          "type": "string",
          "description": "The name of the event. E.g LotUnWithdrawn"
        },
        "source": {
          "type": "string",
          "description": "The source channel of the original bid. Valid values - Web > Online, Admin > Online, WeChat > Online, iOS > Online, Web > Live, Admin > Live, WeChat > Live, iOS > Live"
        },
        "sourceTimeZone": {
          "type": "string",
          "description": "Timezone of the client source when followed and unfollowed auction/lot"
        },       
        "version": {
          "type": "string",
          "description": "Version number in format of V{n} for e.g V1, V2"
        },  
        "sentAtUtc": {
            "type": "string",
            "description":  "When was the event sent by the publishers. (in ISO 8601 format)"
        }       
      },
      "required": [ "occurredAtUtc", "typeName", "sentAtUtc", "version"]
    }
  },
    "data": {
      "type": "object",
      "properties": {
        "lotId": {
          "type": "string",
          "description": "Required. Unique id of the object the sale is extended. This is the sale number and lot number and lot suffix e.g. 21231.5a"
        },
        "winningBidId": {
          "type": "string",
          "description": "Required if any bids have been made which are still valid. The bid id of the original which is now the current winning bid. This is only optional because it is possible it is the first bid being cancelled."
        },
        "winningClientNumber": {
          "type": "string",
          "description": "Required if any bids have been made which are still valid. COS number of the client that currently has the winning bid"
        },
        "winningAccountNumber": {
          "type": "string",
          "description": "Required if any bids have been made which are still valid. The account number used to make the bid by the winningClientNumber"
        },
        "winningBidSource": {
          "type": "string",
          "description": "required if any bids have been made which are still valid. The source of the current winningBid. Valid values - Web > Online, Admin > Online, WeChat > Online, iOS > Online, Web > Live, Admin > Live, WeChat > Live, iOS > Live"
        },
        "bidCount": {
          "type": "number",
          "description": "Required if any bids have been made which are still valid. Current number of bids for the lot"
        },
        "winningBid": {
          "type": "number",
          "description": "required if any bids have been made which are still valid. The current winning bid value"
        },
        "winningBidCurrency": {
          "type": "string",
          "description": "Required if any bids have been made which are still valid. The 3 character currency code of the currentWinningBid."
        },
        "winningBidType": {
          "type": "string",
          "description": "Required if any bids have been made which are still valid. The bid type of the current winningBid"
        },
        "startingBid": {
          "type": "number",
          "description": "The starting bid value of the lot if there is no current winning bid and the lot is unwithdrawn. e.g. 15000.00"
        },
        "biddingExtended": {
          "type": "boolean",
          "description": "Required if the time to bid has been extended or not. e.g. True or False"
        },
        "biddingEndTimeUtc": {
          "type": "string",
          "description": "The date and time bidding on the lot was meant to end if the “Subject” = “LotUnwithdrawn” e.g. 2022-02-10T14:30:00Z"
        }
      }
    }
}
Edit this pageLast updated on 2026/1/30