BidCancelled

v0.0.1

{
  "$id": "https://example.com/BidCancelled.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "BidCancelled",
  "description": "An event raised when a bid is cancelled 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 BidCancelled"
        },
        "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 bid was cancelled"
        },
        "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"
          }       
      },
      "required": [ "occurredAtUtc", "typeName", "sentAtUtc", "version"]
    }
  },
    "data": {
      "type": "object",
      "properties": {
        "lotId": {
          "type": "string",
          "description": "Unique id of the lot the bid is being cancelled for. This is the sale number and lot number and lot suffix e.g. 21231.5a"
        },
        "cancelledBidId": {
          "type": "string",
          "description": "The ID of the originally placed bid that has now been cancelled."
        },
        "winningBidId": {
          "type": "string",
          "description": "The bid id of the current winning bid. This is only optional because it is possible it is the first bid being cancelled."
        },
        "winningClientNumber": {
          "type": "string",
          "description": "COS number of the client that currently has the winning bid."
        },
        "winningAccountNumber": {
          "type": "string",
          "description": "The account number of the originally placed bid that is now the winningAccountNumber."
        },
        "bidCount": {
          "type": "number",
          "description": "Current number of bids for the lot."
        },
        "startingBid": {
          "type": "number",
          "description": "The starting bid value of the lot if there is no current winning bid and all bids have been cancelled on the lot. e.g. 15000.00"
        },
        "winningBid": {
          "type": "number",
          "description": "The current winning bid value. e.g. 15000.00"
        },
        "winningBidCurrency": {
          "type": "string",
          "description": "The 3 character currency code of the original bid which is now the current winning bid. e.g. GBP"
        },
        "winningBidType": {
          "type": "string",
          "description": "The bid type of original bid which is now the current winningBid. e.g. Automatic"
        },
        "biddingExtended": {
          "type": "boolean",
          "description": "If the time to bid has been extended or not. e.g. True or False"
        },
        "biddingEndTimeUtc": {
          "type": "string",
          "description": "Date and time bidding ends on the lot e.g. 2022-02-10T14:30:00Z. (ISO8601 format in Zulu/UTC time)"
        },
        "lotTitle": {
          "type": "string",
          "description": "The english title of the lot the bid was originally placed for."
        }
      }
    }
}