MaxBidCancelled
v0.0.1

Holds information about max bids cancelled by a client in 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 can be triggered multiple times per client, for a particular auction and lot. When a client cancels a bid in an online auction, it will trigger this event.

Consumer / Producer Diagram

MaxBidCancelled Schema (json)
{
  "$id": "https://example.com/MaxBidCancelled.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "MaxBidCancelled",
  "description": "An event raised when a max 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 MaxBidCancelled"
        },
        "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": "Unique id of the lot for which the bid is being cancelled. This is the sale number and lot number and lot suffix e.g. 21231.5a"
        },
        "cancelledMaxBidId": {
          "type": "string",
          "description": "The ID of the original max-bid that has now been cancelled."
        },
        "maxBidCancellationType": {
          "type": "string",
          "description": "Indicates the source which cancelled the max bid; user, system or automatic"
        }
      }
    }
}
Edit this pageLast updated on 2026/1/30